Merge pull request #85 from square/release/2.20191120.0

Release 2.20191120.0

CHANGES.md

@@ -1,7 +1,20 @@
 # Change Log
 
+## Version 2.20191120.0 (2019-11-20)
+!!!important
+Square has begun the retirement process for Connect v1 APIs. See the [Connect v1 Retirement](/migrate-from-v1) information page for details.
+!!!
+
+* __GA releases:__ SDKs now support the new `modify_tax_basis` field to Discounts and v2 Sandbox
+* __BETA releases:__ SDKs now support the Shifts API webhooks for Labor shift created, updated, deleted, CreateLocation endpoint, and the ability to customize statement description in Payments API.
+* **Deprecated**: Support for v1Items API and v1Locations API is fully deprecated.
+
+
+
+
 ## Version 2.20191023.0 (2019-10-23)
 * **GA release**: Merchants.ListMerchant is GA for all SDKs.
+* **Beta release**: All SDKs support new Locations API endpoint, CreateLocation.
 * **Beta release**: All SDKs support exclusion strategies for pricing rules.
 
 

README.md

@@ -26,7 +26,7 @@ Add this dependency to your project's POM:
 <dependency>
     <groupId>com.squareup</groupId>
     <artifactId>connect</artifactId>
-    <version>2.20191023.0</version>
+    <version>2.20191120.0</version>
     <scope>compile</scope>
 </dependency>
 ```
@@ -36,7 +36,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "com.squareup:connect:2.20191023.0"
+compile "com.squareup:connect:2.20191120.0"
 ```
 
 ### Option 3: Build and Install locally
@@ -78,7 +78,7 @@ At first generate the JAR by executing:
 
 Then manually install the following JARs:
 
-* target/connect-2.20191023.0.jar
+* target/connect-2.20191120.0.jar
 * target/lib/*.jar
 
 ## Getting Started
@@ -200,6 +200,7 @@ Class | Method | HTTP request | Description
 *LaborApi* | [**updateBreakType**](docs/LaborApi.md#updateBreakType) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType
 *LaborApi* | [**updateShift**](docs/LaborApi.md#updateShift) | **PUT** /v2/labor/shifts/{id} | UpdateShift
 *LaborApi* | [**updateWorkweekConfig**](docs/LaborApi.md#updateWorkweekConfig) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig
+*LocationsApi* | [**createLocation**](docs/LocationsApi.md#createLocation) | **POST** /v2/locations | CreateLocation
 *LocationsApi* | [**listLocations**](docs/LocationsApi.md#listLocations) | **GET** /v2/locations | ListLocations
 *LocationsApi* | [**retrieveLocation**](docs/LocationsApi.md#retrieveLocation) | **GET** /v2/locations/{location_id} | RetrieveLocation
 *LocationsApi* | [**updateLocation**](docs/LocationsApi.md#updateLocation) | **PUT** /v2/locations/{location_id} | UpdateLocation
@@ -336,8 +337,10 @@ Class | Method | HTTP request | Description
  - [Card](docs/Card.md)
  - [CardBrand](docs/CardBrand.md)
  - [CardPaymentDetails](docs/CardPaymentDetails.md)
+ - [CashPaymentDetails](docs/CashPaymentDetails.md)
  - [CatalogCategory](docs/CatalogCategory.md)
  - [CatalogDiscount](docs/CatalogDiscount.md)
+ - [CatalogDiscountModifyTaxBasis](docs/CatalogDiscountModifyTaxBasis.md)
  - [CatalogDiscountType](docs/CatalogDiscountType.md)
  - [CatalogIdMapping](docs/CatalogIdMapping.md)
  - [CatalogImage](docs/CatalogImage.md)
@@ -364,7 +367,13 @@ Class | Method | HTTP request | Description
  - [CatalogPricingType](docs/CatalogPricingType.md)
  - [CatalogProductSet](docs/CatalogProductSet.md)
  - [CatalogQuery](docs/CatalogQuery.md)
+ - [CatalogQueryCustomAttributeUsage](docs/CatalogQueryCustomAttributeUsage.md)
  - [CatalogQueryExact](docs/CatalogQueryExact.md)
+ - [CatalogQueryFilteredItems](docs/CatalogQueryFilteredItems.md)
+ - [CatalogQueryFilteredItemsCustomAttributeFilter](docs/CatalogQueryFilteredItemsCustomAttributeFilter.md)
+ - [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md)
+ - [CatalogQueryFilteredItemsNullableAttribute](docs/CatalogQueryFilteredItemsNullableAttribute.md)
+ - [CatalogQueryFilteredItemsStockLevel](docs/CatalogQueryFilteredItemsStockLevel.md)
  - [CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md)
  - [CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md)
  - [CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md)
@@ -386,12 +395,16 @@ Class | Method | HTTP request | Description
  - [Country](docs/Country.md)
  - [CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md)
  - [CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md)
+ - [CreateCatalogImageRequest](docs/CreateCatalogImageRequest.md)
+ - [CreateCatalogImageResponse](docs/CreateCatalogImageResponse.md)
  - [CreateCheckoutRequest](docs/CreateCheckoutRequest.md)
  - [CreateCheckoutResponse](docs/CreateCheckoutResponse.md)
  - [CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md)
  - [CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md)
  - [CreateCustomerRequest](docs/CreateCustomerRequest.md)
  - [CreateCustomerResponse](docs/CreateCustomerResponse.md)
+ - [CreateLocationRequest](docs/CreateLocationRequest.md)
+ - [CreateLocationResponse](docs/CreateLocationResponse.md)
  - [CreateMobileAuthorizationCodeRequest](docs/CreateMobileAuthorizationCodeRequest.md)
  - [CreateMobileAuthorizationCodeResponse](docs/CreateMobileAuthorizationCodeResponse.md)
  - [CreateOrderRequest](docs/CreateOrderRequest.md)
@@ -437,6 +450,7 @@ Class | Method | HTTP request | Description
  - [ErrorCategory](docs/ErrorCategory.md)
  - [ErrorCode](docs/ErrorCode.md)
  - [ExcludeStrategy](docs/ExcludeStrategy.md)
+ - [ExternalPaymentDetails](docs/ExternalPaymentDetails.md)
  - [GetBreakTypeRequest](docs/GetBreakTypeRequest.md)
  - [GetBreakTypeResponse](docs/GetBreakTypeResponse.md)
  - [GetEmployeeWageRequest](docs/GetEmployeeWageRequest.md)
@@ -794,7 +808,6 @@ Class | Method | HTTP request | Description
  - [V1VariationPricingType](docs/V1VariationPricingType.md)
  - [VoidTransactionRequest](docs/VoidTransactionRequest.md)
  - [VoidTransactionResponse](docs/VoidTransactionResponse.md)
- - [WebhookEvents](docs/WebhookEvents.md)
  - [Weekday](docs/Weekday.md)
  - [WorkweekConfig](docs/WorkweekConfig.md)
 
@@ -815,18 +828,18 @@ Authentication schemes defined for the API:
   - EMPLOYEES_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to employee profile information. For example, to create and modify employee profiles.
   - INVENTORY_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.
   - INVENTORY_WRITE: __HTTP Method__:  &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.
-  - ITEMS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to product catalog information. For example, to get an  item or a list of items.
+  - ITEMS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
   - ITEMS_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to product catalog information. For example, to modify or add to a product catalog.
   - MERCHANT_PROFILE_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.
   - ORDERS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.
   - ORDERS_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to order information. For example, to call the CreateCheckout endpoint.
   - PAYMENTS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.
-  - PAYMENTS_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to transaction and refunds information. For example, to process payments with the Transactions or Checkout API.
-  - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Transactions API.
-  - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to transaction and refunds information. For example, to process in-person payments.
+  - PAYMENTS_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API.
+  - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Payments API.
+  - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to payments and refunds information. For example, to process in-person payments.
   - SETTLEMENTS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.
-  - TIMECARDS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to employee timecard information. For example, to call the Connect v1 ListTimecards endpoint.
-  - TIMECARDS_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to employee timecard information. For example, to create and modify timecards.
+  - TIMECARDS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint.
+  - TIMECARDS_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to employee shift information. For example, to create and modify employee shifts.
   - TIMECARDS_SETTINGS_READ: __HTTP Method__: &#x60;GET&#x60;  Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.
   - TIMECARDS_SETTINGS_WRITE: __HTTP Method__: &#x60;POST&#x60;, &#x60;PUT&#x60;, &#x60;DELETE&#x60;  Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.
 

build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'com.squareup'
-version = '2.20191023.0'
+version = '2.20191120.0'
 
 buildscript {
     repositories {

docs/ApplePayApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 RegisterDomain
 
-Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain.  This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform.  To learn more about Apple Pay on Web see the Apple Pay section in the [Embedding the Square Payment Form](/payment-form/add-digital-wallets/apple-pay) guide.
+Activates a domain for use with Web Apple Pay and Square. A validation will be performed on this domain by Apple to ensure is it properly set up as an Apple Pay enabled domain.  This endpoint provides an easy way for platform developers to bulk activate Web Apple Pay with Square for merchants using their platform.  To learn more about Apple Pay on Web see the Apple Pay section in the [Square Payment Form Walkthrough](/docs/payment-form/payment-form-walkthrough).
 
 ### Example
 ```java

docs/BatchDeleteCatalogObjectsRequest.md

@@ -8,7 +8,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**objectIds** | **List<String>** | The IDs of the `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`. |  [optional]
+**objectIds** | **List<String>** | The IDs of the CatalogObjects 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 will delete its CatalogItemVariation. |  [optional]
 
 
 

docs/BatchDeleteCatalogObjectsResponse.md

@@ -8,9 +8,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**errors** | [**List<Error>**](Error.md) | The set of `Error`s encountered. |  [optional]
-**deletedObjectIds** | **List<String>** | The IDs of all `CatalogObject`s deleted by this request. |  [optional]
-**deletedAt** | **String** | The database [timestamp](#workingwithdates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". |  [optional]
+**errors** | [**List<Error>**](Error.md) | The set of Errors encountered. |  [optional]
+**deletedObjectIds** | **List<String>** | The IDs of all CatalogObjects deleted by this request. |  [optional]
+**deletedAt** | **String** | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this deletion in RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". |  [optional]
 
 
 

docs/BatchRetrieveCatalogObjectsRequest.md

@@ -8,8 +8,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**objectIds** | **List<String>** | The IDs of the `CatalogObject`s to be retrieved. | 
-**includeRelatedObjects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested objects, as follows:  If the `objects` field of the response contains a `CatalogItem`,  its associated `CatalogCategory](#type-catalogcategory), [CatalogTax`es, `CatalogImage](#type-catalogimage)s and [CatalogModifierList`s will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a `CatalogItemVariation`, its parent `CatalogItem` will be returned in the `related_objects` field of the response. |  [optional]
+**objectIds** | **List<String>** | The IDs of the CatalogObjects to be retrieved. | 
+**includeRelatedObjects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested objects, as follows:  If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. |  [optional]
 
 
 

docs/BatchRetrieveInventoryChangesRequest.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **states** | **List<String>** | Filters `ADJUSTMENT` query results by `InventoryState`. 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 `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). |  [optional]
 **updatedBefore** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). |  [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]
+**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 the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. |  [optional]
 
 
 

docs/BatchRetrieveInventoryChangesResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. |  [optional]
 **changes** | [**List<InventoryChange>**](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](https://developer.squareup.com/docs/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 the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. |  [optional]
 
 
 

docs/BatchRetrieveInventoryCountsRequest.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **catalogObjectIds** | **List<String>** | Filters results by `CatalogObject` ID. Only applied when set. Default: unset. |  [optional]
 **locationIds** | **List<String>** | Filters results by `Location` ID. Only applied when set. Default: unset. |  [optional]
 **updatedAfter** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). |  [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]
+**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 the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. |  [optional]
 
 
 

docs/BatchRetrieveInventoryCountsResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. |  [optional]
 **counts** | [**List<InventoryCount>**](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](https://developer.squareup.com/docs/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 the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. |  [optional]