square_connect 2.2.0.110 → 2.2.1.145

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 140134240931adbda11d86b180088dac5ee6311b
-  data.tar.gz: 5e5b72bd452c1db6d42186491c6a7e3baae2a3ab
+  metadata.gz: 9038d98c2435e21087034dafbf4ca72823a5c0b2
+  data.tar.gz: dad26f39a28e8946f76a3bf668829dbf86cec1ca
 SHA512:
-  metadata.gz: fa5a49a639d4e459a1c41f5821f7eed72fba37e7f67d39a125a6e68d9da661480ead976bd10685354c0335890052a07adf24970d837be1145f34d7ff4fd53a6a
-  data.tar.gz: 44ac429748a38aa469937c9eb48800af4ac25202ceb2eeb8b784ff5abe1a03bef4f3d5a6b11ea9351478065a7ff330142c9990d379b22b390196961872bf546e
+  metadata.gz: ef90f1bdd16f4093358dbdb3feb3bad30fbecde9ce441443a93e09731954c23e1094917237bd05788ec5b7a202659fd49baa4ac305ac346d84212e61496ff43b
+  data.tar.gz: 26b270f7e070cc4596ad6bc027ac4567b14d3447655dbb00ef1c04622dddf5a1e0c9bb32f4e74f37be242839dd53a304ca7c3a799291089d61525956a357efc1

data/CHANGES.md

@@ -1,5 +1,11 @@
 # 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
+
 ## Version 2.0.0 (2016-03-30)
 
 * Initial release of the SDK

data/README.md

@@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 2.2.0
+- Package version: 2.2.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -348,7 +348,7 @@ Class | Method | HTTP request | Description
 
 - **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&#39;s business and location entities. Almost all Connect API applications need this permission in order to obtain a merchant&#39;s location IDs
   - PAYMENTS_READ: GET endpoints related to transactions and refunds
@@ -367,6 +367,51 @@ Class | Method | HTTP request | Description
   - 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 follow
+the following steps:
+
+1. Use the full information endpoint methods of each API to get the response HTTP
+Headers. They are named as their simple counterpart with a `with_http_info` suffix.
+Hence `listEmployeeRoles` would be called `list_employee_roles_with_http_info`. This
+method returns an array with 3 parameters: `response`, `http_status`, and
+`http_headers`.
+2. Use `batch_token = api_client.get_v1_batch_token_from_headers(http_headers)`
+to extract the token and proceed to get the following page if a token is present.
+
+### Example
+
+```ruby
+# load the gem
+require 'square_connect'
+# setup authorization
+SquareConnect.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = SquareConnect::V1EmployeesApi.new
+api_client = api_instance.api_client
+
+opts = {
+  order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field.Default value: ASC
+  limit: 56 # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+}
+
+roles = []
+begin
+  result, status, headers = api_instance.list_employee_roles_with_http_info(opts)
+  roles = roles + result
+  opts[:batch_token] = api_client.get_v1_batch_token_from_headers(headers)
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling V1EmployeesApi#list_employee_roles_with_http_info: #{e}"
+end while opts[:batch_token]
+
+p roles
+```
+
 Contributing
 ------------
 

data/docs/SearchCatalogObjectsRequest.md

@@ -8,7 +8,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional] 
-**object_types** | **Array<String>** | The desired set of object types to apper in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional] 
+**object_types** | **Array<String>** | The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional] 
 **include_deleted_objects** | **BOOLEAN** | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional] 
 **include_related_objects** | **BOOLEAN** | If `true`, the response will include additional objects that are related to the requested object, as follows:  If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response.  If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response. | [optional] 
 **begin_time** | **String** | Return only objects that have been modified after this [timestamp](#workingwithdates) (in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\"). The timestamp is exclusive - objects whose timestamp is equal to `begin_time` will not be included in the response. | [optional] 

data/docs/V1EmployeesApi.md

@@ -312,7 +312,7 @@ api_instance = SquareConnect::V1EmployeesApi.new
 opts = { 
   order: "order_example", # String | The order in which employees are listed in the response, based on their created_at field.Default value: ASC 
   limit: 56, # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-  cursor: "cursor_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -330,7 +330,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **order** | **String**| The order in which employees are listed in the response, based on their created_at field.Default value: ASC  | [optional] 
  **limit** | **Integer**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 
- **cursor** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 
@@ -374,7 +374,8 @@ opts = {
   end_created_at: "end_created_at_example", # String | If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
   status: "status_example", # String | If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
   external_id: "external_id_example", # String | If provided, the endpoint returns only employee entities with the specified external_id.
-  limit: 56 # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+  limit: 56, # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -398,6 +399,7 @@ Name | Type | Description  | Notes
  **status** | **String**| If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). | [optional] 
  **external_id** | **String**| If provided, the endpoint returns only employee entities with the specified external_id. | [optional] 
  **limit** | **Integer**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 
@@ -496,7 +498,7 @@ opts = {
   end_updated_at: "end_updated_at_example", # String | If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
   deleted: true, # BOOLEAN | 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.
   limit: 56, # Integer | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-  cursor: "cursor_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -522,7 +524,7 @@ Name | Type | Description  | Notes
  **end_updated_at** | **String**| If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] 
  **deleted** | **BOOLEAN**| 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. | [optional] 
  **limit** | **Integer**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] 
- **cursor** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 

data/docs/V1ItemsApi.md

@@ -1351,7 +1351,8 @@ api_instance = SquareConnect::V1ItemsApi.new
 location_id = "location_id_example" # String | The ID of the item's associated location.
 
 opts = { 
-  limit: 56 # Integer | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.
+  limit: 56, # Integer | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -1369,6 +1370,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **location_id** | **String**| The ID of the item's associated location. | 
  **limit** | **Integer**| The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 
@@ -1386,7 +1388,7 @@ Name | Type | Description  | Notes
 
 
 # **list_items**
-> Array<V1Item> list_items(location_id)
+> Array<V1Item> list_items(location_id, opts)
 
 Provides summary information for all of a location's items.
 
@@ -1406,10 +1408,13 @@ api_instance = SquareConnect::V1ItemsApi.new
 
 location_id = "location_id_example" # String | The ID of the location to list items for.
 
+opts = { 
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+}
 
 begin
   #Provides summary information for all of a location's items.
-  result = api_instance.list_items(location_id)
+  result = api_instance.list_items(location_id, opts)
   p result
 rescue SquareConnect::ApiError => e
   puts "Exception when calling V1ItemsApi->list_items: #{e}"
@@ -1421,6 +1426,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **location_id** | **String**| The ID of the location to list items for. | 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 

data/docs/V1PaymentItemDetail.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **category_name** | **String** | The name of the item's merchant-defined category, if any. | [optional] 
-**sku** | **Float** |  The item's merchant-defined SKU, if any. | [optional] 
+**sku** | **String** |  The item's merchant-defined SKU, if any. | [optional] 
 **item_id** | **String** | The unique ID of the item purchased, if any. | [optional] 
 **item_variation_id** | **String** | The unique ID of the item variation purchased, if any. | [optional] 
 

data/docs/V1Refund.md

@@ -8,6 +8,11 @@ Name | Type | Description | Notes
 **type** | **String** | The type of refund  | [optional] 
 **reason** | **String** | The merchant-specified reason for the refund. | [optional] 
 **refunded_money** | [**V1Money**](V1Money.md) | The amount of money refunded. This amount is always negative. | [optional] 
+**refunded_processing_fee_money** | [**V1Money**](V1Money.md) | The amount of processing fee money refunded. | [optional] 
+**refunded_additive_tax_money** | [**V1Money**](V1Money.md) | The amount of additive tax money refunded. | [optional] 
+**refunded_inclusive_tax_money** | [**V1Money**](V1Money.md) | The amount of inclusive tax money refunded. | [optional] 
+**refunded_tip_money** | [**V1Money**](V1Money.md) | The amount of tip money refunded. | [optional] 
+**refunded_discount_money** | [**V1Money**](V1Money.md) | The amount of discount money refunded. | [optional] 
 **created_at** | **String** | The time when the merchant initiated the refund for Square to process, in ISO 8601 format.. | [optional] 
 **processed_at** | **String** | The time when Square processed the refund on behalf of the merchant, in ISO 8601 format. | [optional] 
 **payment_id** | **String** | The Square-issued ID of the payment the refund is applied to. | [optional] 

data/docs/V1TransactionsApi.md

@@ -147,7 +147,8 @@ location_id = "location_id_example" # String | The ID of the location to list on
 
 opts = { 
   order: "order_example", # String | TThe order in which payments are listed in the response.
-  limit: 56 # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
+  limit: 56, # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -166,6 +167,7 @@ Name | Type | Description  | Notes
  **location_id** | **String**| The ID of the location to list online store orders for. | 
  **order** | **String**| TThe order in which payments are listed in the response. | [optional] 
  **limit** | **Integer**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 
@@ -207,7 +209,8 @@ opts = {
   order: "order_example", # String | The order in which payments are listed in the response.
   begin_time: "begin_time_example", # String | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
   end_time: "end_time_example", # String | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
-  limit: 56 # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
+  limit: 56, # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -228,6 +231,7 @@ Name | Type | Description  | Notes
  **begin_time** | **String**| The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. | [optional] 
  **end_time** | **String**| The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] 
  **limit** | **Integer**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 
@@ -269,7 +273,8 @@ opts = {
   order: "order_example", # String | TThe order in which payments are listed in the response.
   begin_time: "begin_time_example", # String | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
   end_time: "end_time_example", # String | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
-  limit: 56 # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
+  limit: 56, # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -290,6 +295,7 @@ Name | Type | Description  | Notes
  **begin_time** | **String**| The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. | [optional] 
  **end_time** | **String**| The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] 
  **limit** | **Integer**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 
@@ -332,7 +338,8 @@ opts = {
   begin_time: "begin_time_example", # String | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
   end_time: "end_time_example", # String | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
   limit: 56, # Integer | The maximum number of payments to return in a single response. This value cannot exceed 200.
-  status: "status_example" # String | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
+  status: "status_example", # String | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
+  batch_token: "batch_token_example" # String | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
 }
 
 begin
@@ -354,6 +361,7 @@ Name | Type | Description  | Notes
  **end_time** | **String**| The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] 
  **limit** | **Integer**| The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] 
  **status** | **String**| Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). | [optional] 
+ **batch_token** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] 
 
 ### Return type
 

data/docs/V1Variation.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **id** | **String** | The item variation's unique ID. | [optional] 
 **name** | **String** | The item variation's name. | [optional] 
 **item_id** | **String** | The ID of the variation's associated item. | [optional] 
+**ordinal** | **Integer** | Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order | [optional] 
 **pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. | [optional] 
 **price_money** | [**V1Money**](V1Money.md) | The item variation's price, if any. | [optional] 
 **sku** | **String** | The item variation's SKU, if any. | [optional] 

data/lib/square_connect/api/v1_employees_api.rb

@@ -299,7 +299,7 @@ module SquareConnect
     # @param [Hash] opts the optional parameters
     # @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC 
     # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1EmployeeRole>]
     def list_employee_roles(opts = {})
       data, _status_code, _headers = list_employee_roles_with_http_info(opts)
@@ -311,7 +311,7 @@ module SquareConnect
     # @param [Hash] opts the optional parameters
     # @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC 
     # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1EmployeeRole>, Fixnum, Hash)>] Array<V1EmployeeRole> data, response status code and response headers
     def list_employee_roles_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -331,7 +331,7 @@ module SquareConnect
       query_params = {}
       query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
-      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}
@@ -370,6 +370,7 @@ module SquareConnect
     # @option opts [String] :status If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
     # @option opts [String] :external_id If provided, the endpoint returns only employee entities with the specified external_id.
     # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Employee>]
     def list_employees(opts = {})
       data, _status_code, _headers = list_employees_with_http_info(opts)
@@ -387,6 +388,7 @@ module SquareConnect
     # @option opts [String] :status If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
     # @option opts [String] :external_id If provided, the endpoint returns only employee entities with the specified external_id.
     # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Employee>, Fixnum, Hash)>] Array<V1Employee> data, response status code and response headers
     def list_employees_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -415,6 +417,7 @@ module SquareConnect
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
       query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}
@@ -508,7 +511,7 @@ module SquareConnect
     # @option opts [String] :end_updated_at If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
     # @option opts [BOOLEAN] :deleted If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don&#39;t provide this parameter, both valid and deleted timecards are returned.
     # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Timecard>]
     def list_timecards(opts = {})
       data, _status_code, _headers = list_timecards_with_http_info(opts)
@@ -528,7 +531,7 @@ module SquareConnect
     # @option opts [String] :end_updated_at If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
     # @option opts [BOOLEAN] :deleted If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don&#39;t provide this parameter, both valid and deleted timecards are returned.
     # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
-    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Timecard>, Fixnum, Hash)>] Array<V1Timecard> data, response status code and response headers
     def list_timecards_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -556,7 +559,7 @@ module SquareConnect
       query_params[:'end_updated_at'] = opts[:'end_updated_at'] if !opts[:'end_updated_at'].nil?
       query_params[:'deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
-      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}

data/lib/square_connect/api/v1_items_api.rb

@@ -1355,6 +1355,7 @@ module SquareConnect
     # @param location_id The ID of the item's associated location.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1InventoryEntry>]
     def list_inventory(location_id, opts = {})
       data, _status_code, _headers = list_inventory_with_http_info(location_id, opts)
@@ -1366,6 +1367,7 @@ module SquareConnect
     # @param location_id The ID of the item&#39;s associated location.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1InventoryEntry>, Fixnum, Hash)>] Array<V1InventoryEntry> data, response status code and response headers
     def list_inventory_with_http_info(location_id, opts = {})
       if @api_client.config.debugging
@@ -1383,6 +1385,7 @@ module SquareConnect
       # query parameters
       query_params = {}
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}
@@ -1414,6 +1417,7 @@ module SquareConnect
     # Provides summary information for all of a location's items.
     # @param location_id The ID of the location to list items for.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Item>]
     def list_items(location_id, opts = {})
       data, _status_code, _headers = list_items_with_http_info(location_id, opts)
@@ -1424,6 +1428,7 @@ module SquareConnect
     # Provides summary information for all of a location&#39;s items.
     # @param location_id The ID of the location to list items for.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Item>, Fixnum, Hash)>] Array<V1Item> data, response status code and response headers
     def list_items_with_http_info(location_id, opts = {})
       if @api_client.config.debugging
@@ -1436,6 +1441,7 @@ module SquareConnect
 
       # query parameters
       query_params = {}
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}

data/lib/square_connect/api/v1_transactions_api.rb

@@ -133,6 +133,7 @@ module SquareConnect
     # @param [Hash] opts the optional parameters
     # @option opts [String] :order TThe order in which payments are listed in the response.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Order>]
     def list_orders(location_id, opts = {})
       data, _status_code, _headers = list_orders_with_http_info(location_id, opts)
@@ -145,6 +146,7 @@ module SquareConnect
     # @param [Hash] opts the optional parameters
     # @option opts [String] :order TThe order in which payments are listed in the response.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Order>, Fixnum, Hash)>] Array<V1Order> data, response status code and response headers
     def list_orders_with_http_info(location_id, opts = {})
       if @api_client.config.debugging
@@ -166,6 +168,7 @@ module SquareConnect
       query_params = {}
       query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}
@@ -201,6 +204,7 @@ module SquareConnect
     # @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
     # @option opts [String] :end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Payment>]
     def list_payments(location_id, opts = {})
       data, _status_code, _headers = list_payments_with_http_info(location_id, opts)
@@ -215,6 +219,7 @@ module SquareConnect
     # @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
     # @option opts [String] :end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Payment>, Fixnum, Hash)>] Array<V1Payment> data, response status code and response headers
     def list_payments_with_http_info(location_id, opts = {})
       if @api_client.config.debugging
@@ -238,6 +243,7 @@ module SquareConnect
       query_params[:'begin_time'] = opts[:'begin_time'] if !opts[:'begin_time'].nil?
       query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}
@@ -273,6 +279,7 @@ module SquareConnect
     # @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
     # @option opts [String] :end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Refund>]
     def list_refunds(location_id, opts = {})
       data, _status_code, _headers = list_refunds_with_http_info(location_id, opts)
@@ -287,6 +294,7 @@ module SquareConnect
     # @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.
     # @option opts [String] :end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Refund>, Fixnum, Hash)>] Array<V1Refund> data, response status code and response headers
     def list_refunds_with_http_info(location_id, opts = {})
       if @api_client.config.debugging
@@ -310,6 +318,7 @@ module SquareConnect
       query_params[:'begin_time'] = opts[:'begin_time'] if !opts[:'begin_time'].nil?
       query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}
@@ -346,6 +355,7 @@ module SquareConnect
     # @option opts [String] :end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
     # @option opts [String] :status Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<V1Settlement>]
     def list_settlements(location_id, opts = {})
       data, _status_code, _headers = list_settlements_with_http_info(location_id, opts)
@@ -361,6 +371,7 @@ module SquareConnect
     # @option opts [String] :end_time The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.
     # @option opts [Integer] :limit The maximum number of payments to return in a single response. This value cannot exceed 200.
     # @option opts [String] :status Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
+    # @option opts [String] :batch_token A pagination cursor to retrieve the next set of results for your original query to the endpoint.
     # @return [Array<(Array<V1Settlement>, Fixnum, Hash)>] Array<V1Settlement> data, response status code and response headers
     def list_settlements_with_http_info(location_id, opts = {})
       if @api_client.config.debugging
@@ -388,6 +399,7 @@ module SquareConnect
       query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'batch_token'] = opts[:'batch_token'] if !opts[:'batch_token'].nil?
 
       # header parameters
       header_params = {}

data/lib/square_connect/api_client.rb

@@ -28,10 +28,10 @@ module SquareConnect
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      
+
       # Construct user agent string. Returns slightly different string for JRuby
-      @user_agent = "Square-Connect-Ruby/2.2.0"
-      
+      @user_agent = "Square-Connect-Ruby/2.2.1"
+
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent,
@@ -381,5 +381,19 @@ module SquareConnect
         fail "unknown collection format: #{collection_format.inspect}"
       end
     end
+
+    # Extract batch_token from Link header if present
+    # @param [Hash] headers hash with response headers
+    # @return [String] batch_token or nil if no token is present
+    def get_v1_batch_token_from_headers(headers)
+      if headers.is_a?(Hash) && headers.has_key?('Link')
+        match = /^<([^>]+)>;rel='next'$/.match(headers['Link'])
+        if match
+          uri = URI.parse(match[1])
+          params = CGI.parse(uri.query)
+          return params['batch_token'][0]
+        end
+      end
+    end
   end
 end

data/lib/square_connect/models/search_catalog_objects_request.rb

@@ -15,7 +15,7 @@ module SquareConnect
     # The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information.
     attr_accessor :cursor
 
-    # The desired set of object types to apper in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`.
+    # The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`.
     attr_accessor :object_types
 
     # If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.

data/lib/square_connect/models/v1_payment_item_detail.rb

@@ -39,7 +39,7 @@ module SquareConnect
     def self.swagger_types
       {
         :'category_name' => :'String',
-        :'sku' => :'Float',
+        :'sku' => :'String',
         :'item_id' => :'String',
         :'item_variation_id' => :'String'
       }

data/lib/square_connect/models/v1_refund.rb

@@ -21,6 +21,21 @@ module SquareConnect
     # The amount of money refunded. This amount is always negative.
     attr_accessor :refunded_money
 
+    # The amount of processing fee money refunded.
+    attr_accessor :refunded_processing_fee_money
+
+    # The amount of additive tax money refunded.
+    attr_accessor :refunded_additive_tax_money
+
+    # The amount of inclusive tax money refunded.
+    attr_accessor :refunded_inclusive_tax_money
+
+    # The amount of tip money refunded.
+    attr_accessor :refunded_tip_money
+
+    # The amount of discount money refunded.
+    attr_accessor :refunded_discount_money
+
     # The time when the merchant initiated the refund for Square to process, in ISO 8601 format..
     attr_accessor :created_at
 
@@ -61,6 +76,11 @@ module SquareConnect
         :'type' => :'type',
         :'reason' => :'reason',
         :'refunded_money' => :'refunded_money',
+        :'refunded_processing_fee_money' => :'refunded_processing_fee_money',
+        :'refunded_additive_tax_money' => :'refunded_additive_tax_money',
+        :'refunded_inclusive_tax_money' => :'refunded_inclusive_tax_money',
+        :'refunded_tip_money' => :'refunded_tip_money',
+        :'refunded_discount_money' => :'refunded_discount_money',
         :'created_at' => :'created_at',
         :'processed_at' => :'processed_at',
         :'payment_id' => :'payment_id',
@@ -74,6 +94,11 @@ module SquareConnect
         :'type' => :'String',
         :'reason' => :'String',
         :'refunded_money' => :'V1Money',
+        :'refunded_processing_fee_money' => :'V1Money',
+        :'refunded_additive_tax_money' => :'V1Money',
+        :'refunded_inclusive_tax_money' => :'V1Money',
+        :'refunded_tip_money' => :'V1Money',
+        :'refunded_discount_money' => :'V1Money',
         :'created_at' => :'String',
         :'processed_at' => :'String',
         :'payment_id' => :'String',
@@ -101,6 +126,26 @@ module SquareConnect
         self.refunded_money = attributes[:'refunded_money']
       end
 
+      if attributes.has_key?(:'refunded_processing_fee_money')
+        self.refunded_processing_fee_money = attributes[:'refunded_processing_fee_money']
+      end
+
+      if attributes.has_key?(:'refunded_additive_tax_money')
+        self.refunded_additive_tax_money = attributes[:'refunded_additive_tax_money']
+      end
+
+      if attributes.has_key?(:'refunded_inclusive_tax_money')
+        self.refunded_inclusive_tax_money = attributes[:'refunded_inclusive_tax_money']
+      end
+
+      if attributes.has_key?(:'refunded_tip_money')
+        self.refunded_tip_money = attributes[:'refunded_tip_money']
+      end
+
+      if attributes.has_key?(:'refunded_discount_money')
+        self.refunded_discount_money = attributes[:'refunded_discount_money']
+      end
+
       if attributes.has_key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -152,6 +197,11 @@ module SquareConnect
           type == o.type &&
           reason == o.reason &&
           refunded_money == o.refunded_money &&
+          refunded_processing_fee_money == o.refunded_processing_fee_money &&
+          refunded_additive_tax_money == o.refunded_additive_tax_money &&
+          refunded_inclusive_tax_money == o.refunded_inclusive_tax_money &&
+          refunded_tip_money == o.refunded_tip_money &&
+          refunded_discount_money == o.refunded_discount_money &&
           created_at == o.created_at &&
           processed_at == o.processed_at &&
           payment_id == o.payment_id &&
@@ -167,7 +217,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, reason, refunded_money, created_at, processed_at, payment_id, merchant_id].hash
+      [type, reason, refunded_money, refunded_processing_fee_money, refunded_additive_tax_money, refunded_inclusive_tax_money, refunded_tip_money, refunded_discount_money, created_at, processed_at, payment_id, merchant_id].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/v1_variation.rb

@@ -21,6 +21,9 @@ module SquareConnect
     # The ID of the variation's associated item.
     attr_accessor :item_id
 
+    # Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order
+    attr_accessor :ordinal
+
     # Indicates whether the item variation's price is fixed or determined at the time of sale.
     attr_accessor :pricing_type
 
@@ -70,6 +73,7 @@ module SquareConnect
         :'id' => :'id',
         :'name' => :'name',
         :'item_id' => :'item_id',
+        :'ordinal' => :'ordinal',
         :'pricing_type' => :'pricing_type',
         :'price_money' => :'price_money',
         :'sku' => :'sku',
@@ -86,6 +90,7 @@ module SquareConnect
         :'id' => :'String',
         :'name' => :'String',
         :'item_id' => :'String',
+        :'ordinal' => :'Integer',
         :'pricing_type' => :'String',
         :'price_money' => :'V1Money',
         :'sku' => :'String',
@@ -116,6 +121,10 @@ module SquareConnect
         self.item_id = attributes[:'item_id']
       end
 
+      if attributes.has_key?(:'ordinal')
+        self.ordinal = attributes[:'ordinal']
+      end
+
       if attributes.has_key?(:'pricing_type')
         self.pricing_type = attributes[:'pricing_type']
       end
@@ -191,6 +200,7 @@ module SquareConnect
           id == o.id &&
           name == o.name &&
           item_id == o.item_id &&
+          ordinal == o.ordinal &&
           pricing_type == o.pricing_type &&
           price_money == o.price_money &&
           sku == o.sku &&
@@ -209,7 +219,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, item_id, pricing_type, price_money, sku, track_inventory, inventory_alert_type, inventory_alert_threshold, user_data].hash
+      [id, name, item_id, ordinal, pricing_type, price_money, sku, track_inventory, inventory_alert_type, inventory_alert_threshold, user_data].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/version.rb

@@ -8,5 +8,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 module SquareConnect
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/spec/api/catalog_api_spec.rb

@@ -382,7 +382,7 @@ describe 'CatalogApi' do
               batch.objects.push({
                   type: SquareConnect::CatalogObjectType::ITEM,
                   id: item_id,
-                  itemData: {
+                  item_data: {
                       name: "Item-#{batch_num}-#{i}",
                       variations: [
                         {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square_connect
 version: !ruby/object:Gem::Version
-  version: 2.2.0.110
+  version: 2.2.1.145
 platform: ruby
 authors:
 - Square, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus