update Readme

Author: biglovisa

README.md

@@ -32,22 +32,13 @@ pip install patch_api
 
 ### Configuration
 
-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:
+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. The `patch` object will be used to to make calls to the Patch API:
 
 ```python
 import patch_api
 
-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 as Orders
-
-api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
-orders_api = Orders(api_client=api_client)
+patch = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
+orders = patch.orders.retrieve_orders()
 ```
 
 ### Orders
@@ -64,44 +55,42 @@ fulfill the order for you.
 #### Examples
 ```python
 import patch_api
-from patch_api.api.orders_api import OrdersApi as Orders
 
-api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
-orders_api = Orders(api_client=api_client)
+patch = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
 
 # Create an order - you can create an order
 # providing either mass_g or total_price_cents_usd, but not both
 
 # Create order with mass
-orders_api.create_order(opts={'mass_g': 1_000_000}) # Pass in the mass in grams (i.e. 1 metric tonne)
+patch.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)
-orders_api.create_order(opts={'total_price_cents_usd': total_price_cents_usd})
+patch.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
-orders_api.create_order(opts={'project_id': project_id, 'mass_g': mass_g})
+patch.orders.create_order(opts={'project_id': project_id, 'mass_g': mass_g})
 
 ## Orders also accept a metadata field (optional)
 metadata = {user: "john doe"}
-orders_api.create_order(opts={'metadata': metadata, 'mass_g': mass_g})
+patch.orders.create_order(opts={'metadata': metadata, 'mass_g': mass_g})
 
 # Retrieve an order
 order_id = 'ord_test_1234' # Pass in the order's id
-orders_api.retrieve_order(id=order_id)
+patch.orders.retrieve_order(id=order_id)
 
 # Place an order
 order_id = 'ord_test_1234' # Pass in the order's id
-orders_api.place_order(id=order_id)
+patch.orders.place_order(id=order_id)
 
 # Cancel an order
 order_id = 'ord_test_1234' # Pass in the order's id
-orders_api.cancel_order(id=order_id)
+patch.orders.cancel_order(id=order_id)
 
 # Retrieve a list of orders
 page = 1 # Pass in which page of orders you'd like
-orders_api.retrieve_orders(page=page)
+patch.orders.retrieve_orders(page=page)
 ```
 
 ### Estimates
@@ -112,27 +101,25 @@ Estimates allow API users to get a quote for the cost of compensating a certain
 #### Examples
 ```python
 import patch_api
-from patch_api.api.estimates_api import EstimatesApi as Estimates
 
-api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
-estimates_api = Estimates(api_client=api_client)
+patch = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
 
 # Create an estimate
 
 mass_g = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
-estimates_api.create_estimate(opts={'mass_g': mass_g})
+patch.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
-estimates_api.create_estimate(opts={'mass_g': mass_g, 'project_id': project_id})
+patch.estimates.create_estimate(opts={'mass_g': mass_g, 'project_id': project_id})
 
 # Retrieve an estimate
 estimate_id = 'est_test_1234'
-estimates_api.retrieve_estimate(id=estimate_id)
+patch.estimates.retrieve_estimate(id=estimate_id)
 
 # Retrieve a list of estimates
 page = 1 # Pass in which page of estimates you'd like
-estimates_api.retrieve_estimates(page=page)
+patch.estimates.retrieve_estimates(page=page)
 ```
 
 ### Projects
@@ -143,18 +130,16 @@ Projects are the ways Patch takes CO2 out of the air. They can represent refores
 #### Examples
 ```python
 import patch_api
-from patch_api.api.projects_api import ProjectsApi as Projects
 
-api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
-projects_api = Projects(api_client=api_client)
+patch = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
 
 # Retrieve a project
 project_id = 'pro_test_1234' # Pass in the project's ID
-projects_api.retrieve_project(id=project_id)
+patch.projects.retrieve_project(id=project_id)
 
 # Retrieve a list of projects
 page = 1 # Pass in which page of projects you'd like
-projects_api.retrieve_projects(page=page)
+patch.projects.retrieve_projects(page=page)
 ```
 
 ### Preferences
@@ -165,27 +150,25 @@ Preferences are how you route your orders in Patch. If you don't have a preferen
 #### Examples
 ```python
 import patch_api
-from patch_api.api.preferences_api import PreferencesApi as Preferences
 
-api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
-preferences_api = Preferences(api_client=api_client)
+patch = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
 
 # Create a preference
 
 project_id = 'pro_test_1234' # Pass in the project_id for your preference
-preferences_api.create_preference(opts={'project_id': project_id})
+patch.preferences.create_preference(opts={'project_id': project_id})
 
 # Retrieve a preference
 preference_id = 'pre_test_1234' # Pass in the preferences's id
-preferences_api.retrieve_preference(preference_id=preference_id)
+patch.preferences.retrieve_preference(preference_id=preference_id)
 
 # Delete a preference
 preference_id = 'pre_test_1234' # Pass in the preferences's id
-preferences_api.delete_preference(preference_id=preference_id)
+patch.preferences.delete_preference(preference_id=preference_id)
 
 # Retrieve a list of preferences
 page = 1 # Pass in which page of preferences you'd like
-preferences_api.retrieve_preferences(page=page)
+patch.preferences.retrieve_preferences(page=page)
 ```
 
 ## Development
@@ -231,15 +214,8 @@ To test the package locally, create a python file in a sibling directory and add
 import os
 import patch_api
 
-# ..... your Patch API code goes here. See example below:
-
-from patch_api.api.orders_api import OrdersApi as Orders
-
-api_client = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
-orders = Orders(api_client=api_client)
-
-list_orders = orders.retrieve_orders(opts={'page': 1})
+patch = patch_api.ApiClient(api_key=os.environ.get('SANDBOX_API_KEY'))
+orders = patch.orders.retrieve_orders(opts={'page': 1})
 
-# Prints your organization's orders
-print(list_orders)
+print(orders)
 ```