Merge pull request #38 from square/release/2.2.1

Release/2.2.1

CHANGES.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## Version 2.2.1 (2017-08-11)
+
+* Documentation style and links fixes
+* Support for pagination on V1 endpoints
+* Include refund detail fields on V1 Refund model
+* Fix locations example on README
+
 ### Version 2.0.2 (2017-02-07)
 
 * Bug Fixes for List Locations endpoint

README.md

@@ -42,16 +42,16 @@ import squareconnect
 
 ### Retrieve your location IDs
 ```python
-from __future__ import print_function 
+from __future__ import print_function
 
 import squareconnect
 from squareconnect.rest import ApiException
-from squareconnect.apis.location_api import LocationApi
+from squareconnect.apis.locations_api import LocationsApi
 
 # setup authorization
 squareconnect.configuration.access_token = 'YOUR_ACCESS_TOKEN'
 # create an instance of the Location API class
-api_instance = LocationApi()
+api_instance = LocationsApi()
 
 try:
     # ListLocations
@@ -63,7 +63,7 @@ except ApiException as e:
 ```
 ### Charge the card nonce
 ```python
-from __future__ import print_function 
+from __future__ import print_function
 import uuid
 
 import squareconnect
@@ -74,8 +74,8 @@ from squareconnect.apis.transaction_api import TransactionApi
 squareconnect.configuration.access_token = 'YOUR_ACCESS_TOKEN'
 # create an instance of the Transaction API class
 api_instance = TransactionApi()
-location_id = 'YOUR_LOCATION_ID' 
-nonce = 'YOUR_NONCE' 
+location_id = 'YOUR_LOCATION_ID'
+nonce = 'YOUR_NONCE'
 
 try:
     # Charge
@@ -94,8 +94,8 @@ except ApiException as e:
 All URIs are relative to [Square Connect Documentation](https://docs.connect.squareup.com/)
 
 
-Class | Method | HTTP request 
------------- | ------------- | ------------- 
+Class | Method | HTTP request
+------------ | ------------- | -------------
 *CatalogApi* | [**batch_delete_catalog_objects**](docs/CatalogApi.md#batch_delete_catalog_objects) | **POST** /v2/catalog/batch-delete
 *CatalogApi* | [**batch_retrieve_catalog_objects**](docs/CatalogApi.md#batch_retrieve_catalog_objects) | **POST** /v2/catalog/batch-retrieve
 *CatalogApi* | [**batch_upsert_catalog_objects**](docs/CatalogApi.md#batch_upsert_catalog_objects) | **POST** /v2/catalog/batch-upsert
@@ -370,7 +370,7 @@ Class | Method | HTTP request
 
 - **Type**: OAuth
 - **Flow**: accessCode
-- **Authorization URL**: `https://connect.squareup.com/oauth2/authorize?<PARAMETERS>`
+- **Authorization URL**: `https://connect.squareup.com/oauth2/authorize`
 - **Scopes**: 
  - **MERCHANT_PROFILE_READ**: GET endpoints related to a merchant's business and location entities. Almost all Connect API applications need this permission in order to obtain a merchant's location IDs
  - **PAYMENTS_READ**: GET endpoints related to transactions and refunds
@@ -389,6 +389,40 @@ Class | Method | HTTP request
  - **TIMECARDS_WRITE**: POST, PUT, and DELETE endpoints related to employee timecards
 
 
+## Pagination of V1 Endpoints
+
+V1 Endpoints return pagination information via HTTP headers. In order to obtain
+response headers and extract the `batch_token` parameter you will need to get it
+from the response object after each call as follows:
+
+### Example
+
+```python
+from __future__ import print_function
+
+import squareconnect
+from squareconnect.rest import ApiException
+from squareconnect.apis.v1_employees_api import V1EmployeesApi
+
+# setup authorization
+squareconnect.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+# create an instance of the V1 Employee API class
+api_instance = V1EmployeesApi()
+has_next_page = True
+token = None
+
+try:
+    while has_next_page:
+        # ListEmployeeRoles
+        api_response = api_instance.list_employee_roles(batch_token=token)
+        print (api_response.locations)
+
+        token = api_instance.api_client.last_response.getbatch_token()
+        has_next_page = token != None
+except ApiException as e:
+    print ('Exception when calling V1EmployeesApi->list_employee_roles: %s\n' % e)
+```
+
 ## Contributing
 
 Send bug reports, feature requests, and code contributions to the [API

docs/V1EmployeesApi.md

@@ -143,7 +143,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_employee_roles**
-> list[V1EmployeeRole] list_employee_roles(order=order, limit=limit, cursor=cursor)
+> list[V1EmployeeRole] list_employee_roles(order=order, limit=limit, batch_token=batch_token)
 
 ### Description
 
@@ -155,7 +155,7 @@ Name | Type | Notes | Default Value
 ------------- | ------------- | ------------- | -------------
  **order** | **str**| [optional] 
  **limit** | **int**| [optional] 
- **cursor** | **str**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 
@@ -168,7 +168,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_employees**
-> list[V1Employee] list_employees(order=order, begin_updated_at=begin_updated_at, end_updated_at=end_updated_at, begin_created_at=begin_created_at, end_created_at=end_created_at, status=status, external_id=external_id, limit=limit)
+> list[V1Employee] list_employees(order=order, begin_updated_at=begin_updated_at, end_updated_at=end_updated_at, begin_created_at=begin_created_at, end_created_at=end_created_at, status=status, external_id=external_id, limit=limit, batch_token=batch_token)
 
 ### Description
 
@@ -186,6 +186,7 @@ Name | Type | Notes | Default Value
  **status** | **str**| [optional] 
  **external_id** | **str**| [optional] 
  **limit** | **int**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 
@@ -221,7 +222,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_timecards**
-> list[V1Timecard] list_timecards(order=order, employee_id=employee_id, begin_clockin_time=begin_clockin_time, end_clockin_time=end_clockin_time, begin_clockout_time=begin_clockout_time, end_clockout_time=end_clockout_time, begin_updated_at=begin_updated_at, end_updated_at=end_updated_at, deleted=deleted, limit=limit, cursor=cursor)
+> list[V1Timecard] list_timecards(order=order, employee_id=employee_id, begin_clockin_time=begin_clockin_time, end_clockin_time=end_clockin_time, begin_clockout_time=begin_clockout_time, end_clockout_time=end_clockout_time, begin_updated_at=begin_updated_at, end_updated_at=end_updated_at, deleted=deleted, limit=limit, batch_token=batch_token)
 
 ### Description
 
@@ -241,7 +242,7 @@ Name | Type | Notes | Default Value
  **end_updated_at** | **str**| [optional] 
  **deleted** | **bool**| [optional] 
  **limit** | **int**| [optional] 
- **cursor** | **str**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 

docs/V1ItemsApi.md

@@ -607,7 +607,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_inventory**
-> list[V1InventoryEntry] list_inventory(location_id, limit=limit)
+> list[V1InventoryEntry] list_inventory(location_id, limit=limit, batch_token=batch_token)
 
 ### Description
 
@@ -619,6 +619,7 @@ Name | Type | Notes | Default Value
 ------------- | ------------- | ------------- | -------------
  **location_id** | **str**| 
  **limit** | **int**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 
@@ -631,7 +632,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_items**
-> list[V1Item] list_items(location_id)
+> list[V1Item] list_items(location_id, batch_token=batch_token)
 
 ### Description
 
@@ -642,6 +643,7 @@ Provides summary information for all of a location's items.
 Name | Type | Notes | Default Value
 ------------- | ------------- | ------------- | -------------
  **location_id** | **str**| 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 

docs/V1PaymentItemDetail.md

@@ -7,7 +7,7 @@
 Name | Type | Notes
 ------------ | ------------- | -------------
 **category_name** | **str** | [optional] 
-**sku** | **float** | [optional] 
+**sku** | **str** | [optional] 
 **item_id** | **str** | [optional] 
 **item_variation_id** | **str** | [optional] 
 

docs/V1Refund.md

@@ -9,6 +9,11 @@ Name | Type | Notes
 **type** | **str** | [optional] 
 **reason** | **str** | [optional] 
 **refunded_money** | [**V1Money**](V1Money.md) | [optional] 
+**refunded_processing_fee_money** | [**V1Money**](V1Money.md) | [optional] 
+**refunded_additive_tax_money** | [**V1Money**](V1Money.md) | [optional] 
+**refunded_inclusive_tax_money** | [**V1Money**](V1Money.md) | [optional] 
+**refunded_tip_money** | [**V1Money**](V1Money.md) | [optional] 
+**refunded_discount_money** | [**V1Money**](V1Money.md) | [optional] 
 **created_at** | **str** | [optional] 
 **processed_at** | **str** | [optional] 
 **payment_id** | **str** | [optional] 

docs/V1TransactionsApi.md

@@ -67,7 +67,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_orders**
-> list[V1Order] list_orders(location_id, order=order, limit=limit)
+> list[V1Order] list_orders(location_id, order=order, limit=limit, batch_token=batch_token)
 
 ### Description
 
@@ -80,6 +80,7 @@ Name | Type | Notes | Default Value
  **location_id** | **str**| 
  **order** | **str**| [optional] 
  **limit** | **int**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 
@@ -92,7 +93,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_payments**
-> list[V1Payment] list_payments(location_id, order=order, begin_time=begin_time, end_time=end_time, limit=limit)
+> list[V1Payment] list_payments(location_id, order=order, begin_time=begin_time, end_time=end_time, limit=limit, batch_token=batch_token)
 
 ### Description
 
@@ -107,6 +108,7 @@ Name | Type | Notes | Default Value
  **begin_time** | **str**| [optional] 
  **end_time** | **str**| [optional] 
  **limit** | **int**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 
@@ -119,7 +121,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_refunds**
-> list[V1Refund] list_refunds(location_id, order=order, begin_time=begin_time, end_time=end_time, limit=limit)
+> list[V1Refund] list_refunds(location_id, order=order, begin_time=begin_time, end_time=end_time, limit=limit, batch_token=batch_token)
 
 ### Description
 
@@ -134,6 +136,7 @@ Name | Type | Notes | Default Value
  **begin_time** | **str**| [optional] 
  **end_time** | **str**| [optional] 
  **limit** | **int**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 
@@ -146,7 +149,7 @@ Assign your **Access Token** from developer portal to the authorization paramete
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_settlements**
-> list[V1Settlement] list_settlements(location_id, order=order, begin_time=begin_time, end_time=end_time, limit=limit, status=status)
+> list[V1Settlement] list_settlements(location_id, order=order, begin_time=begin_time, end_time=end_time, limit=limit, status=status, batch_token=batch_token)
 
 ### Description
 
@@ -162,6 +165,7 @@ Name | Type | Notes | Default Value
  **end_time** | **str**| [optional] 
  **limit** | **int**| [optional] 
  **status** | **str**| [optional] 
+ **batch_token** | **str**| [optional] 
 
 ### Return type
 

docs/V1Variation.md

@@ -9,6 +9,7 @@ Name | Type | Notes
 **id** | **str** | [optional] 
 **name** | **str** | [optional] 
 **item_id** | **str** | [optional] 
+**ordinal** | **int** | [optional] 
 **pricing_type** | **str** | [optional] 
 **price_money** | [**V1Money**](V1Money.md) | [optional] 
 **sku** | **str** | [optional] 

setup.py

@@ -4,7 +4,7 @@
 from setuptools import setup, find_packages
 
 NAME = "squareconnect"
-VERSION = "2.2.0"
+VERSION = "2.2.1"
 
 
 

squareconnect/api_client.py

@@ -80,7 +80,7 @@ def __init__(self, host=None, header_name=None, header_value=None, cookie=None):
             self.host = host
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Square-Connect-Python/2.2.0'
+        self.user_agent = 'Square-Connect-Python/2.2.1'
 
     @property
     def user_agent(self):

squareconnect/apis/v1_employees_api.py

@@ -462,13 +462,13 @@ def list_employee_roles(self, **kwargs):
             for asynchronous request. (optional)
         :param str order: The order in which employees are listed in the response, based on their created_at field.Default value: ASC 
         :param int limit: The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-        :param str cursor: A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+        :param str batch_token: A pagination cursor to retrieve the next set of results for your original query to the endpoint.
         :return: list[V1EmployeeRole]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['order', 'limit', 'cursor']
+        all_params = ['order', 'limit', 'batch_token']
         all_params.append('callback')
 
         params = locals()
@@ -493,8 +493,8 @@ def list_employee_roles(self, **kwargs):
             query_params['order'] = params['order']
         if 'limit' in params and params['limit'] is not None:
             query_params['limit'] = params['limit']
-        if 'cursor' in params and params['cursor'] is not None:
-            query_params['cursor'] = params['cursor']
+        if 'batch_token' in params and params['batch_token'] is not None:
+            query_params['batch_token'] = params['batch_token']
 
         header_params = {}
 
@@ -551,12 +551,13 @@ def list_employees(self, **kwargs):
         :param str status: If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
         :param str external_id: If provided, the endpoint returns only employee entities with the specified external_id.
         :param int limit: The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+        :param str batch_token: A pagination cursor to retrieve the next set of results for your original query to the endpoint.
         :return: list[V1Employee]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['order', 'begin_updated_at', 'end_updated_at', 'begin_created_at', 'end_created_at', 'status', 'external_id', 'limit']
+        all_params = ['order', 'begin_updated_at', 'end_updated_at', 'begin_created_at', 'end_created_at', 'status', 'external_id', 'limit', 'batch_token']
         all_params.append('callback')
 
         params = locals()
@@ -593,6 +594,8 @@ def list_employees(self, **kwargs):
             query_params['external_id'] = params['external_id']
         if 'limit' in params and params['limit'] is not None:
             query_params['limit'] = params['limit']
+        if 'batch_token' in params and params['batch_token'] is not None:
+            query_params['batch_token'] = params['batch_token']
 
         header_params = {}
 
@@ -729,13 +732,13 @@ def list_timecards(self, **kwargs):
         :param str end_updated_at: If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
         :param bool deleted: If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.
         :param int limit: The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-        :param str cursor: A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+        :param str batch_token: A pagination cursor to retrieve the next set of results for your original query to the endpoint.
         :return: list[V1Timecard]
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['order', 'employee_id', 'begin_clockin_time', 'end_clockin_time', 'begin_clockout_time', 'end_clockout_time', 'begin_updated_at', 'end_updated_at', 'deleted', 'limit', 'cursor']
+        all_params = ['order', 'employee_id', 'begin_clockin_time', 'end_clockin_time', 'begin_clockout_time', 'end_clockout_time', 'begin_updated_at', 'end_updated_at', 'deleted', 'limit', 'batch_token']
         all_params.append('callback')
 
         params = locals()
@@ -776,8 +779,8 @@ def list_timecards(self, **kwargs):
             query_params['deleted'] = params['deleted']
         if 'limit' in params and params['limit'] is not None:
             query_params['limit'] = params['limit']
-        if 'cursor' in params and params['cursor'] is not None:
-            query_params['cursor'] = params['cursor']
+        if 'batch_token' in params and params['batch_token'] is not None:
+            query_params['batch_token'] = params['batch_token']
 
         header_params = {}