wip

Author: biglovisa

README.md

@@ -32,27 +32,24 @@ pip install patch
 
 ### Configuration
 
-After installing the gem, you'll have to configure it with your API key which is available from the API key page in the Patch dashboard:
+After installing the gem, you'll have to initialize it with your API key which is available from the API key page in the Patch dashboard:
 
 ```python
 import patch_api
 
-configuration = patch_api.Configuration(api_key=os.environ.get('SANDBOX_API_KEY'))
-api_client = patch_api.ApiClient(configuration)
+api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
 ```
 
 The `api_client` will be used to instantiate other API objects for Patch resources, for example the `OrdersApi`:
 
 ```
 import patch_api
-from patch_api.api.orders_api import OrdersApi
+from patch_api.api.orders_api import OrdersApi as Orders
 
-configuration = patch_api.Configuration(api_key=os.environ.get('SANDBOX_API_KEY'))
-api_client = patch_api.ApiClient(configuration)
-orders_api = OrdersApi(api_client=api_client)
+api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
+orders_api = Orders(api_client=api_client)
 ```
 
-
 ### Orders
 In Patch, orders represent a purchase of carbon offsets or negative emissions by mass. Place orders directly if you know the amount of carbon dioxide you would like to sequester. If you do not know how much to purchase, use an estimate.
 
@@ -69,45 +66,38 @@ fulfill the order for you.
 # Create an order - you can create an order
 # providing either mass_g or total_price_cents_usd, but not both
 
-from patch_api.models.create_order_request import CreateOrderRequest
+from patch_api.api.orders_api import OrdersApi as Orders
 
 # Create order with mass
-mass_g = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
-create_order_request = CreateOrderRequest(mass_g=mass_g)
-OrdersApi.create_order(create_order_request)
+Orders.create_order(opts={'mass_g': 1_000_000}) # Pass in the mass in grams (i.e. 1 metric tonne)
 
 # Create an order with maximum total price
 total_price_cents_usd = 5_00 # Pass in the total price in cents (i.e. 5 dollars)
-create_order_request = CreateOrderRequest(total_price_cents_usd=total_price_cents_usd)
-OrdersApi.create_order(create_order_request)
+Orders.create_order(opts={'total_price_cents_usd': total_price_cents_usd})
 
 ## You can also specify a project-id field (optional) to be used instead of the preferred one
 project_id = 'pro_test_1234' # Pass in the project's ID
-create_order_request = CreateOrderRequest(project_id=project_id, mass_g=mass_g)
-OrdersApi.create_order(create_order_request)
-
+Orders.create_order(opts={'project_id': project_id, 'mass_g': mass_g})
 
 ## Orders also accept a metadata field (optional)
 metadata = {user: "john doe"}
-create_order_request = CreateOrderRequest(metadata=metadata, mass_g=mass_g)
-OrdersApi.create_order(create_order_request)
-
+Orders.create_order(opts={'metadata': metadata, 'mass_g': mass_g})
 
 # Retrieve an order
 order_id = 'ord_test_1234' # Pass in the order's id
-OrdersApi.retrieve_order(id=order_id)
+Orders.retrieve_order(id=order_id)
 
 # Place an order
 order_id = 'ord_test_1234' # Pass in the order's id
-OrdersApi.place_order(id=order_id)
+Orders.place_order(id=order_id)
 
 # Cancel an order
 order_id = 'ord_test_1234' # Pass in the order's id
-OrdersApi.cancel_order(id=order_id)
+Orders.cancel_order(id=order_id)
 
 # Retrieve a list of orders
 page = 1 # Pass in which page of orders you'd like
-OrdersApi.retrieve_orders(page=page)
+Orders.retrieve_orders(page=page)
 ```
 
 ### Estimates
@@ -118,24 +108,22 @@ Estimates allow API users to get a quote for the cost of compensating a certain
 #### Examples
 ```python
 # Create an estimate
-from patch_api.models.create_estimate_request import CreateEstimateRequest
+from patch_api.api.estimates_api import EstimatesApi as Estimates
 
 mass_g = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
-create_estimate_request = CreateEstimateRequest(mass_g=mass_g)
-EstimatesApi.create_estimate(create_estimate_request)
+Estimates.create_estimate(opts={'mass_g': mass_g})
 
 ## You can also specify a project-id field (optional) to be used instead of the preferred one
 project_id = 'pro_test_1234' # Pass in the project's ID
-create_estimate_request = CreateEstimateRequest(mass_g=mass_g, project_id=project_id)
-EstimatesApi.create_estimate(create_estimate_request)
+Estimates.create_estimate(opts={'mass_g': mass_g, 'project_id': project_id})
 
 # Retrieve an estimate
 estimate_id = 'est_test_1234'
-EstimatesApi.retrieve_estimate(id=estimate_id)
+Estimates.retrieve_estimate(id=estimate_id)
 
 # Retrieve a list of estimates
 page = 1 # Pass in which page of estimates you'd like
-EstimatesApi.retrieve_estimates(page=page)
+Estimates.retrieve_estimates(page=page)
 ```
 
 ### Projects
@@ -145,13 +133,15 @@ Projects are the ways Patch takes CO2 out of the air. They can represent refores
 
 #### Examples
 ```python
+from patch_api.api.projects_api import ProjectsApi as Projects
+
 # Retrieve a project
 project_id = 'pro_test_1234' # Pass in the project's ID
-ProjectsApi.retrieve_project(id=project_id)
+Projects.retrieve_project(id=project_id)
 
 # Retrieve a list of projects
 page = 1 # Pass in which page of projects you'd like
-ProjectsApi.retrieve_projects(page=page)
+Projects.retrieve_projects(page=page)
 ```
 
 ### Preferences
@@ -162,23 +152,22 @@ Preferences are how you route your orders in Patch. If you don't have a preferen
 #### Examples
 ```python
 # Create a preference
-from patch_api.models.create_preference_request import CreatePreferenceRequest
+from patch_api.api.preferences_api import PreferencesApi as Preferences
 
 project_id = 'pro_test_1234' # Pass in the project_id for your preference
-create_preference_request = CreatePreferenceRequest(project_id=project_id)
-PreferencesApi.create_preference(create_preference_request)
+Preferences.create_preference(opts={'project_id': project_id})
 
 # Retrieve a preference
 preference_id = 'pre_test_1234' # Pass in the preferences's id
-PreferencesApi.retrieve_preference(preference_id=preference_id)
+Preferences.retrieve_preference(preference_id=preference_id)
 
 # Delete a preference
 preference_id = 'pre_test_1234' # Pass in the preferences's id
-PreferencesApi.delete_preference(preference_id=preference_id)
+Preferences.delete_preference(preference_id=preference_id)
 
 # Retrieve a list of preferences
 page = 1 # Pass in which page of preferences you'd like
-PreferencesApi.retrieve_preferences(page=page)
+Preferences.retrieve_preferences(page=page)
 ```
 
 ## Development

patch_api/__init__.py

@@ -17,13 +17,6 @@
 
 __version__ = "1.0.0"
 
-# import apis into sdk package
-from patch_api.api.estimates_api import EstimatesApi
-from patch_api.api.orders_api import OrdersApi
-from patch_api.api.photos_api import PhotosApi
-from patch_api.api.preferences_api import PreferencesApi
-from patch_api.api.projects_api import ProjectsApi
-
 # import ApiClient
 from patch_api.api_client import ApiClient
 from patch_api.configuration import Configuration
@@ -32,44 +25,3 @@
 from patch_api.exceptions import ApiValueError
 from patch_api.exceptions import ApiKeyError
 from patch_api.exceptions import ApiException
-
-# import models into sdk package
-from patch_api.models.allocation import Allocation
-from patch_api.models.create_mass_estimate_request import CreateMassEstimateRequest
-from patch_api.models.create_membership_request import CreateMembershipRequest
-from patch_api.models.create_offset_request import CreateOffsetRequest
-from patch_api.models.create_order_request import CreateOrderRequest
-from patch_api.models.create_organization_request import CreateOrganizationRequest
-from patch_api.models.create_photo_request import CreatePhotoRequest
-from patch_api.models.create_preference_request import CreatePreferenceRequest
-from patch_api.models.create_project_request import CreateProjectRequest
-from patch_api.models.error_response import ErrorResponse
-from patch_api.models.estimate import Estimate
-from patch_api.models.estimate_list_response import EstimateListResponse
-from patch_api.models.estimate_response import EstimateResponse
-from patch_api.models.fulfill_offset_request import FulfillOffsetRequest
-from patch_api.models.membership import Membership
-from patch_api.models.membership_response import MembershipResponse
-from patch_api.models.meta_index_object import MetaIndexObject
-from patch_api.models.offset import Offset
-from patch_api.models.offset_list_response import OffsetListResponse
-from patch_api.models.offset_response import OffsetResponse
-from patch_api.models.order import Order
-from patch_api.models.order_list_response import OrderListResponse
-from patch_api.models.order_response import OrderResponse
-from patch_api.models.organization import Organization
-from patch_api.models.organization_list_response import OrganizationListResponse
-from patch_api.models.organization_response import OrganizationResponse
-from patch_api.models.photo import Photo
-from patch_api.models.photo_response import PhotoResponse
-from patch_api.models.preference import Preference
-from patch_api.models.preference_list_response import PreferenceListResponse
-from patch_api.models.preference_response import PreferenceResponse
-from patch_api.models.project import Project
-from patch_api.models.project_list_response import ProjectListResponse
-from patch_api.models.project_response import ProjectResponse
-from patch_api.models.project_type_list_response import ProjectTypeListResponse
-from patch_api.models.standard import Standard
-from patch_api.models.standard_list_response import StandardListResponse
-from patch_api.models.update_offset_request import UpdateOffsetRequest
-from patch_api.models.update_project_request import UpdateProjectRequest

patch_api/api/__init__.py

@@ -1,10 +0,0 @@
-from __future__ import absolute_import
-
-# flake8: noqa
-
-# import apis into api package
-from patch_api.api.estimates_api import EstimatesApi
-from patch_api.api.orders_api import OrdersApi
-from patch_api.api.photos_api import PhotosApi
-from patch_api.api.preferences_api import PreferencesApi
-from patch_api.api.projects_api import ProjectsApi

patch_api/api/estimates_api.py

@@ -35,7 +35,7 @@ def __init__(self, api_client=None):
         self.api_client = api_client
 
     def create_mass_estimate(
-        self, create_mass_estimate_request, **kwargs
+        self, opts={}, create_mass_estimate_request={}, **kwargs
     ):  # noqa: E501
         """Create an estimate based on mass of CO2  # noqa: E501
 
@@ -47,6 +47,7 @@ def create_mass_estimate(
 
         :param async_req bool: execute request asynchronously
         :param CreateMassEstimateRequest create_mass_estimate_request: (required)
+        :param dict opts: dictionary holding the optional arguments for the query (optional)
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -60,11 +61,11 @@ def create_mass_estimate(
         """
         kwargs["_return_http_data_only"] = True
         return self.create_mass_estimate_with_http_info(
-            create_mass_estimate_request, **kwargs
+            opts, create_mass_estimate_request, **kwargs
         )  # noqa: E501
 
     def create_mass_estimate_with_http_info(
-        self, create_mass_estimate_request, **kwargs
+        self, opts, create_mass_estimate_request, **kwargs
     ):  # noqa: E501
         """Create an estimate based on mass of CO2  # noqa: E501
 
@@ -76,6 +77,7 @@ def create_mass_estimate_with_http_info(
 
         :param async_req bool: execute request asynchronously
         :param CreateMassEstimateRequest create_mass_estimate_request: (required)
+        :param dict opts: dictionary holding the optional arguments for the query (required)
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -120,6 +122,8 @@ def create_mass_estimate_with_http_info(
         path_params = {}
 
         query_params = []
+        for key in opts:
+            query_params.append([key, opts.get(key)])
 
         header_params = {}
 
@@ -164,7 +168,7 @@ def create_mass_estimate_with_http_info(
             collection_formats=collection_formats,
         )
 
-    def retrieve_estimate(self, id, **kwargs):  # noqa: E501
+    def retrieve_estimate(self, opts={}, id={}, **kwargs):  # noqa: E501
         """Retrieves an estimate  # noqa: E501
 
         Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for.   # noqa: E501
@@ -175,6 +179,7 @@ def retrieve_estimate(self, id, **kwargs):  # noqa: E501
 
         :param async_req bool: execute request asynchronously
         :param str id: (required)
+        :param dict opts: dictionary holding the optional arguments for the query (optional)
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -187,9 +192,9 @@ def retrieve_estimate(self, id, **kwargs):  # noqa: E501
                  returns the request thread.
         """
         kwargs["_return_http_data_only"] = True
-        return self.retrieve_estimate_with_http_info(id, **kwargs)  # noqa: E501
+        return self.retrieve_estimate_with_http_info(opts, id, **kwargs)  # noqa: E501
 
-    def retrieve_estimate_with_http_info(self, id, **kwargs):  # noqa: E501
+    def retrieve_estimate_with_http_info(self, opts, id, **kwargs):  # noqa: E501
         """Retrieves an estimate  # noqa: E501
 
         Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for.   # noqa: E501
@@ -200,6 +205,7 @@ def retrieve_estimate_with_http_info(self, id, **kwargs):  # noqa: E501
 
         :param async_req bool: execute request asynchronously
         :param str id: (required)
+        :param dict opts: dictionary holding the optional arguments for the query (required)
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -243,6 +249,8 @@ def retrieve_estimate_with_http_info(self, id, **kwargs):  # noqa: E501
             path_params["id"] = local_var_params["id"]  # noqa: E501
 
         query_params = []
+        for key in opts:
+            query_params.append([key, opts.get(key)])
 
         header_params = {}
 
@@ -278,7 +286,7 @@ def retrieve_estimate_with_http_info(self, id, **kwargs):  # noqa: E501
             collection_formats=collection_formats,
         )
 
-    def retrieve_estimates(self, **kwargs):  # noqa: E501
+    def retrieve_estimates(self, opts={}, **kwargs):  # noqa: E501
         """Retrieves a list of estimates  # noqa: E501
 
         Retrieves a list of estimates and their associated orders. You can only retrieve estimates associated with the organization you are querying for.   # noqa: E501
@@ -289,6 +297,7 @@ def retrieve_estimates(self, **kwargs):  # noqa: E501
 
         :param async_req bool: execute request asynchronously
         :param int page:
+        :param dict opts: dictionary holding the optional arguments for the query (optional)
         :param _preload_content: if False, the urllib3.HTTPResponse object will
                                  be returned without reading/decoding response
                                  data. Default is True.
@@ -301,9 +310,9 @@ def retrieve_estimates(self, **kwargs):  # noqa: E501
                  returns the request thread.
         """
         kwargs["_return_http_data_only"] = True
-        return self.retrieve_estimates_with_http_info(**kwargs)  # noqa: E501
+        return self.retrieve_estimates_with_http_info(opts, **kwargs)  # noqa: E501
 
-    def retrieve_estimates_with_http_info(self, **kwargs):  # noqa: E501
+    def retrieve_estimates_with_http_info(self, opts, **kwargs):  # noqa: E501
         """Retrieves a list of estimates  # noqa: E501
 
         Retrieves a list of estimates and their associated orders. You can only retrieve estimates associated with the organization you are querying for.   # noqa: E501
@@ -314,6 +323,7 @@ def retrieve_estimates_with_http_info(self, **kwargs):  # noqa: E501
 
         :param async_req bool: execute request asynchronously
         :param int page:
+        :param dict opts: dictionary holding the optional arguments for the query (required)
         :param _return_http_data_only: response data without head status code
                                        and headers
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -350,6 +360,8 @@ def retrieve_estimates_with_http_info(self, **kwargs):  # noqa: E501
         path_params = {}
 
         query_params = []
+        for key in opts:
+            query_params.append([key, opts.get(key)])
         if "page" in local_var_params:
             query_params.append(("page", local_var_params["page"]))  # noqa: E501