Enhance general API usability #104
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request enhances the flexibility and usability of the Procore API access layer by adding an option to return raw
requests.Responseobjects from all HTTP request methods in theBaseclass. It also updates the documentation for these methods, improves parameter handling, and exposes theBaseAPI access class through the mainProcoreclass.API response flexibility and improvements:
return_request_objboolean parameter to all HTTP methods (get_request,post_request,patch_request,delete_request) inBase, allowing callers to receive either the parsed response (default) or the rawrequests.Responseobject. This change is reflected in both the method signatures and their docstrings. [1] [2] [3] [4] [5] [6] [7] [8] [9]Baseto clearly document the new parameter and return types. [1] [2] [3] [4]Codebase and interface enhancements:
BaseAPI access class asbase_apion the mainProcoreclass, making it accessible for generic API calls. [1] [2]Baseclass. [1] [2] [3] [4]These changes make the API client more versatile for advanced use cases, such as custom response handling, debugging, and integration with other tools without modifying any existing usage or functionality.