Merge pull request #137 from square/release/2.23.0

Release 2.23.0
square · Sep 25, 2019 · 0d3f34c · 0d3f34c
2 parents a84bceb + 62e9cf2
commit 0d3f34c
Show file tree

Hide file tree

Showing 310 changed files with 4,154 additions and 1,516 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,20 @@
 # Change Log
 
+## Version 2.23.0 (2019-09-25)
+
+* **GA release**: All SDKs have been updated to support the new Merchants API.
+
+* **Beta release**: All SDKs have been updated to support the new endpoints (RetrieveLocation, UpdateLocation) added to the Locations API.
+
+* **Beta release**: All SDKs have been updated to support the new field (`mcc`) added to the `Location` type. 
+
+* **GA release**:  All SDKs have been updated to support the new field (`bin`) added to the `Card` type. 
+
+* **GA release**: All SDKs have been updated to support the new `CardPaymentDetails` fields  (`verification_results`, `statement_description`, and `verification_method`). 
+
+* **GA release**: All SDKs have been updated to support the new `Payment` field, (`employee_id`).
+
+
 ## Version 2.22.2 (2019-08-23)
 
 * **Bug fix**: Fixed path parameters for `UpdateOrder`

diff --git a/README.md b/README.md
@@ -178,6 +178,9 @@ Class | Method | HTTP request
 *LaborApi* | [**UpdateShift**](docs/LaborApi.md#updateshift) | **PUT** /v2/labor/shifts/{id}
 *LaborApi* | [**UpdateWorkweekConfig**](docs/LaborApi.md#updateworkweekconfig) | **PUT** /v2/labor/workweek-configs/{id}
 *LocationsApi* | [**ListLocations**](docs/LocationsApi.md#listlocations) | **GET** /v2/locations
+*LocationsApi* | [**RetrieveLocation**](docs/LocationsApi.md#retrievelocation) | **GET** /v2/locations/{location_id}
+*LocationsApi* | [**UpdateLocation**](docs/LocationsApi.md#updatelocation) | **PUT** /v2/locations/{location_id}
+*MerchantsApi* | [**RetrieveMerchant**](docs/MerchantsApi.md#retrievemerchant) | **GET** /v2/merchants/{merchant_id}
 *MobileAuthorizationApi* | [**CreateMobileAuthorizationCode**](docs/MobileAuthorizationApi.md#createmobileauthorizationcode) | **POST** /mobile/authorization-code
 *OAuthApi* | [**ObtainToken**](docs/OAuthApi.md#obtaintoken) | **POST** /oauth2/token
 *OAuthApi* | [**RenewToken**](docs/OAuthApi.md#renewtoken) | **POST** /oauth2/clients/{client_id}/access-token/renew
@@ -439,6 +442,7 @@ Class | Method | HTTP request
  - [Model.Location](docs/Location.md)
  - [Model.MeasurementUnit](docs/MeasurementUnit.md)
  - [Model.MeasurementUnitCustom](docs/MeasurementUnitCustom.md)
+ - [Model.Merchant](docs/Merchant.md)
  - [Model.ModelBreak](docs/ModelBreak.md)
  - [Model.Money](docs/Money.md)
  - [Model.ObtainTokenRequest](docs/ObtainTokenRequest.md)
@@ -494,6 +498,8 @@ Class | Method | HTTP request
  - [Model.RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md)
  - [Model.RetrieveLocationRequest](docs/RetrieveLocationRequest.md)
  - [Model.RetrieveLocationResponse](docs/RetrieveLocationResponse.md)
+ - [Model.RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md)
+ - [Model.RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md)
  - [Model.RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
  - [Model.RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
  - [Model.RevokeTokenRequest](docs/RevokeTokenRequest.md)
@@ -536,6 +542,8 @@ Class | Method | HTTP request
  - [Model.UpdateItemModifierListsResponse](docs/UpdateItemModifierListsResponse.md)
  - [Model.UpdateItemTaxesRequest](docs/UpdateItemTaxesRequest.md)
  - [Model.UpdateItemTaxesResponse](docs/UpdateItemTaxesResponse.md)
+ - [Model.UpdateLocationRequest](docs/UpdateLocationRequest.md)
+ - [Model.UpdateLocationResponse](docs/UpdateLocationResponse.md)
  - [Model.UpdateOrderRequest](docs/UpdateOrderRequest.md)
  - [Model.UpdateOrderResponse](docs/UpdateOrderResponse.md)
  - [Model.UpdateShiftRequest](docs/UpdateShiftRequest.md)

diff --git a/docs/AdditionalRecipient.md b/docs/AdditionalRecipient.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **LocationId** | **string** | The location ID for a recipient (other than the merchant) receiving a portion of this tender. | 
 **Description** | **string** | The description of the additional recipient. | 
 **AmountMoney** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 
-**ReceivableId** | **string** | The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. | [optional] 
+**ReceivableId** | **string** | The unique ID for this &#x60;AdditionalRecipientReceivable&#x60;, assigned by the server. | [optional] 
 
 
 

diff --git a/docs/BatchChangeInventoryRequest.md b/docs/BatchChangeInventoryRequest.md
@@ -8,7 +8,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**IdempotencyKey** | **string** | A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information. | [optional] 
+**IdempotencyKey** | **string** | A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more information. | [optional] 
 **Changes** | [**List&lt;InventoryChange&gt;**](InventoryChange.md) | The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. Max size is 100 changes. | [optional] 
 **IgnoreUnchangedCounts** | **bool?** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: &#x60;true&#x60;. | [optional] 
 

diff --git a/docs/BatchDeleteCatalogObjectsRequest.md b/docs/BatchDeleteCatalogObjectsRequest.md
@@ -8,7 +8,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ObjectIds** | **List<string>** | The IDs of the [CatalogObject](#type-catalogobject)s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a [CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation](#type-catalogitemvariation)s). | [optional] 
+**ObjectIds** | **List<string>** | The IDs of the &#x60;CatalogObject&#x60;s to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a &#x60;CatalogItem](#type-catalogitem) will delete its [CatalogItemVariation&#x60;. | [optional] 
 
 
 

diff --git a/docs/BatchDeleteCatalogObjectsResponse.md b/docs/BatchDeleteCatalogObjectsResponse.md
@@ -8,8 +8,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Errors** | [**List&lt;Error&gt;**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
-**DeletedObjectIds** | **List<string>** | The IDs of all [CatalogObject](#type-catalogobject)s deleted by this request. | [optional] 
+**Errors** | [**List&lt;Error&gt;**](Error.md) | The set of &#x60;Error&#x60;s encountered. | [optional] 
+**DeletedObjectIds** | **List<string>** | The IDs of all &#x60;CatalogObject&#x60;s deleted by this request. | [optional] 
 **DeletedAt** | **string** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \&quot;2016-09-04T23:59:33.123Z\&quot;. | [optional] 
 
 

diff --git a/docs/BatchRetrieveCatalogObjectsRequest.md b/docs/BatchRetrieveCatalogObjectsRequest.md
@@ -8,8 +8,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ObjectIds** | **List<string>** | The IDs of the [CatalogObject](#type-catalogobject)s to be retrieved. | 
-**IncludeRelatedObjects** | **bool?** | If &#x60;true&#x60;, the response will include additional objects that are related to the requested objects, as follows:  If the &#x60;objects&#x60; field of the response contains a [CatalogItem](#type-catalogitem),  its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, [CatalogImage](#type-catalogimage)s and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the &#x60;related_objects&#x60; field of the response. If the &#x60;objects&#x60; field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the &#x60;related_objects&#x60; field of the response. | [optional] 
+**ObjectIds** | **List<string>** | The IDs of the &#x60;CatalogObject&#x60;s to be retrieved. | 
+**IncludeRelatedObjects** | **bool?** | If &#x60;true&#x60;, the response will include additional objects that are related to the requested objects, as follows:  If the &#x60;objects&#x60; field of the response contains a &#x60;CatalogItem&#x60;,  its associated &#x60;CatalogCategory](#type-catalogcategory), [CatalogTax&#x60;es, &#x60;CatalogImage](#type-catalogimage)s and [CatalogModifierList&#x60;s will be returned in the &#x60;related_objects&#x60; field of the response. If the &#x60;objects&#x60; field of the response contains a &#x60;CatalogItemVariation&#x60;, its parent &#x60;CatalogItem&#x60; will be returned in the &#x60;related_objects&#x60; field of the response. | [optional] 
 
 
 

diff --git a/docs/BatchRetrieveCatalogObjectsResponse.md b/docs/BatchRetrieveCatalogObjectsResponse.md
@@ -8,9 +8,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Errors** | [**List&lt;Error&gt;**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] 
-**Objects** | [**List&lt;CatalogObject&gt;**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s returned. | [optional] 
-**RelatedObjects** | [**List&lt;CatalogObject&gt;**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the object in the &#x60;objects&#x60; field. | [optional] 
+**Errors** | [**List&lt;Error&gt;**](Error.md) | The set of &#x60;Error&#x60;s encountered. | [optional] 
+**Objects** | [**List&lt;CatalogObject&gt;**](CatalogObject.md) | A list of &#x60;CatalogObject&#x60;s returned. | [optional] 
+**RelatedObjects** | [**List&lt;CatalogObject&gt;**](CatalogObject.md) | A list of &#x60;CatalogObject&#x60;s referenced by the object in the &#x60;objects&#x60; field. | [optional] 
 
 
 

diff --git a/docs/BatchRetrieveInventoryChangesRequest.md b/docs/BatchRetrieveInventoryChangesRequest.md
@@ -8,13 +8,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**CatalogObjectIds** | **List<string>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
-**LocationIds** | **List<string>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
-**Types** | **List<string>** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [&#x60;PHYSICAL_COUNT&#x60;, &#x60;ADJUSTMENT&#x60;]. &#x60;TRANSFER&#x60; is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] 
-**States** | **List<string>** | Filters &#x60;ADJUSTMENT&#x60; query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] 
+**CatalogObjectIds** | **List<string>** | Filters results by &#x60;CatalogObject&#x60; ID. Only applied when set. Default: unset. | [optional] 
+**LocationIds** | **List<string>** | Filters results by &#x60;Location&#x60; ID. Only applied when set. Default: unset. | [optional] 
+**Types** | **List<string>** | Filters results by &#x60;InventoryChangeType&#x60;. Default: [&#x60;PHYSICAL_COUNT&#x60;, &#x60;ADJUSTMENT&#x60;]. &#x60;TRANSFER&#x60; is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] 
+**States** | **List<string>** | Filters &#x60;ADJUSTMENT&#x60; query results by &#x60;InventoryState&#x60;. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] 
 **UpdatedAfter** | **string** | Provided as an RFC 3339 timestamp. Returns results whose &#x60;created_at&#x60; or &#x60;calculated_at&#x60; value is after the given time. Default: UNIX epoch (&#x60;1970-01-01T00:00:00Z&#x60;). | [optional] 
 **UpdatedBefore** | **string** | Provided as an RFC 3339 timestamp. Returns results whose &#x60;created_at&#x60; or &#x60;calculated_at&#x60; value is strictly before the given time. Default: UNIX epoch (&#x60;1970-01-01T00:00:00Z&#x60;). | [optional] 
-**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
+**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 
 
 
 

diff --git a/docs/BatchRetrieveInventoryChangesResponse.md b/docs/BatchRetrieveInventoryChangesResponse.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Errors** | [**List&lt;Error&gt;**](Error.md) | Any errors that occurred during the request. | [optional] 
 **Changes** | [**List&lt;InventoryChange&gt;**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional] 
-**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] 
+**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 
 
 
 

diff --git a/docs/BatchRetrieveInventoryCountsRequest.md b/docs/BatchRetrieveInventoryCountsRequest.md
@@ -8,10 +8,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**CatalogObjectIds** | **List<string>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
-**LocationIds** | **List<string>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
+**CatalogObjectIds** | **List<string>** | Filters results by &#x60;CatalogObject&#x60; ID. Only applied when set. Default: unset. | [optional] 
+**LocationIds** | **List<string>** | Filters results by &#x60;Location&#x60; ID. Only applied when set. Default: unset. | [optional] 
 **UpdatedAfter** | **string** | Provided as an RFC 3339 timestamp. Returns results whose &#x60;calculated_at&#x60; value is after the given time. Default: UNIX epoch (&#x60;1970-01-01T00:00:00Z&#x60;). | [optional] 
-**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
+**Cursor** | **string** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 
 
 
 

diff --git a/docs/BatchRetrieveInventoryCountsResponse.md b/docs/BatchRetrieveInventoryCountsResponse.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Errors** | [**List&lt;Error&gt;**](Error.md) | Any errors that occurred during the request. | [optional] 
 **Counts** | [**List&lt;InventoryCount&gt;**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional] 
-**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
+**Cursor** | **string** | The pagination cursor to be used in a subsequent request. If unset, this is the final response.  See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] 
 
 
 

diff --git a/docs/BatchUpsertCatalogObjectsRequest.md b/docs/BatchUpsertCatalogObjectsRequest.md
@@ -8,8 +8,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**IdempotencyKey** | **string** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).  If you&#39;re unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects.  See [Idempotency](/basics/api101/idempotency) for more information. | 
-**Batches** | [**List&lt;CatalogObjectBatch&gt;**](CatalogObjectBatch.md) | A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request.  For each object, its &#x60;updated_at&#x60; field is ignored and replaced with a current [timestamp](#workingwithdates), and its &#x60;is_deleted&#x60; field must not be set to &#x60;true&#x60;.  To modify an existing object, supply its ID. To create a new object, use an ID starting with &#x60;#&#x60;. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a [CatalogItem](#type-catalogitem) with ID &#x60;#ABC&#x60; and a [CatalogItemVariation](#type-catalogitemvariation) with its &#x60;item_id&#x60; attribute set to &#x60;#ABC&#x60; in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem).  Any &#x60;#&#x60;-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.  Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. | [optional] 
+**IdempotencyKey** | **string** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).  If you&#39;re unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects.  See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | 
+**Batches** | [**List&lt;CatalogObjectBatch&gt;**](CatalogObjectBatch.md) | A batch of &#x60;CatalogObject&#x60;s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request.  For each object, its &#x60;updated_at&#x60; field is ignored and replaced with a current [timestamp](#workingwithdates), and its &#x60;is_deleted&#x60; field must not be set to &#x60;true&#x60;.  To modify an existing object, supply its ID. To create a new object, use an ID starting with &#x60;#&#x60;. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a &#x60;CatalogItem&#x60; with ID &#x60;#ABC&#x60; and a &#x60;CatalogItemVariation&#x60; with its &#x60;item_id&#x60; attribute set to &#x60;#ABC&#x60; in order to associate the &#x60;CatalogItemVariation&#x60; with its parent &#x60;CatalogItem&#x60;.  Any &#x60;#&#x60;-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.  Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. | [optional]