release sdk version 2.20180918.0 (#27)

* Release 2.20180918.0

CHANGES.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## Version 2.20180918.0 (2018-09-18)
+
+We have added Connect v2 Inventory API and birthdays in `Customer` entities.
+
+### New API: Inventory API (Connect V2)
+
+The Connect v2 Inventory API replaces the Connect v1 Inventory API
+and introduces new functionality:
+
+* Moving item variations quantities through predefined states
+  (e.g., from `IN_STOCK` to `WASTE`).
+* Viewing the inventory adjustment history for an item variation.
+* Batch inventory adjustments and information retrieval.
+
+### New feature: Customer Birthdays (Connect V2)
+
+* Customer profiles now include a `birthday` field.
+  Dates are recorded in RFC-3339 format and can be
+  set through the `CreateCustomer` and `UpdateCustomer` endpoints.
 ## Version 2.20180712.2 (2018-08-21)
 
 The Connect SDK now includes functionality for the OAuth API. The Square OAuth API lets applications request and obtain permission from a Square account to make API calls on behalf of that account. Applications can request individual permissions so that users do not need to grant full access to their Square accounts.
@@ -157,7 +176,7 @@ represent the value of returned goods in an exchange, rather than actual money m
 
 ### New features: Orders API
 
-* For Catalog-backed line items, setting `CreateOrderRequestLineItem.base_price_money` will now override 
+* For Catalog-backed line items, setting `CreateOrderRequestLineItem.base_price_money` will now override
   the catalog item variation's price.  
 * `CreateOrderRequestModifier`s may now be created ad hoc using the new `name` and `base_price_money` fields.
 

README.md

@@ -65,6 +65,13 @@ Class | Method | HTTP request | Description
 *SquareConnect.CustomersApi* | [**retrieveCustomer**](docs/CustomersApi.md#retrieveCustomer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
 *SquareConnect.CustomersApi* | [**searchCustomers**](docs/CustomersApi.md#searchCustomers) | **POST** /v2/customers/search | SearchCustomers
 *SquareConnect.CustomersApi* | [**updateCustomer**](docs/CustomersApi.md#updateCustomer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
+*SquareConnect.InventoryApi* | [**batchChangeInventory**](docs/InventoryApi.md#batchChangeInventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory
+*SquareConnect.InventoryApi* | [**batchRetrieveInventoryChanges**](docs/InventoryApi.md#batchRetrieveInventoryChanges) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges
+*SquareConnect.InventoryApi* | [**batchRetrieveInventoryCounts**](docs/InventoryApi.md#batchRetrieveInventoryCounts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts
+*SquareConnect.InventoryApi* | [**retrieveInventoryAdjustment**](docs/InventoryApi.md#retrieveInventoryAdjustment) | **GET** /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment
+*SquareConnect.InventoryApi* | [**retrieveInventoryChanges**](docs/InventoryApi.md#retrieveInventoryChanges) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges
+*SquareConnect.InventoryApi* | [**retrieveInventoryCount**](docs/InventoryApi.md#retrieveInventoryCount) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount
+*SquareConnect.InventoryApi* | [**retrieveInventoryPhysicalCount**](docs/InventoryApi.md#retrieveInventoryPhysicalCount) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount
 *SquareConnect.LocationsApi* | [**listLocations**](docs/LocationsApi.md#listLocations) | **GET** /v2/locations | ListLocations
 *SquareConnect.MobileAuthorizationApi* | [**createMobileAuthorizationCode**](docs/MobileAuthorizationApi.md#createMobileAuthorizationCode) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode
 *SquareConnect.OAuthApi* | [**obtainToken**](docs/OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken
@@ -158,10 +165,16 @@ Class | Method | HTTP request | Description
  - [SquareConnect.AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md)
  - [SquareConnect.AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md)
  - [SquareConnect.Address](docs/Address.md)
+ - [SquareConnect.BatchChangeInventoryRequest](docs/BatchChangeInventoryRequest.md)
+ - [SquareConnect.BatchChangeInventoryResponse](docs/BatchChangeInventoryResponse.md)
  - [SquareConnect.BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md)
  - [SquareConnect.BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md)
  - [SquareConnect.BatchRetrieveCatalogObjectsRequest](docs/BatchRetrieveCatalogObjectsRequest.md)
  - [SquareConnect.BatchRetrieveCatalogObjectsResponse](docs/BatchRetrieveCatalogObjectsResponse.md)
+ - [SquareConnect.BatchRetrieveInventoryChangesRequest](docs/BatchRetrieveInventoryChangesRequest.md)
+ - [SquareConnect.BatchRetrieveInventoryChangesResponse](docs/BatchRetrieveInventoryChangesResponse.md)
+ - [SquareConnect.BatchRetrieveInventoryCountsRequest](docs/BatchRetrieveInventoryCountsRequest.md)
+ - [SquareConnect.BatchRetrieveInventoryCountsResponse](docs/BatchRetrieveInventoryCountsResponse.md)
  - [SquareConnect.BatchRetrieveOrdersRequest](docs/BatchRetrieveOrdersRequest.md)
  - [SquareConnect.BatchRetrieveOrdersResponse](docs/BatchRetrieveOrdersResponse.md)
  - [SquareConnect.BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
@@ -241,7 +254,14 @@ Class | Method | HTTP request | Description
  - [SquareConnect.Error](docs/Error.md)
  - [SquareConnect.ErrorCategory](docs/ErrorCategory.md)
  - [SquareConnect.ErrorCode](docs/ErrorCode.md)
+ - [SquareConnect.InventoryAdjustment](docs/InventoryAdjustment.md)
  - [SquareConnect.InventoryAlertType](docs/InventoryAlertType.md)
+ - [SquareConnect.InventoryChange](docs/InventoryChange.md)
+ - [SquareConnect.InventoryChangeType](docs/InventoryChangeType.md)
+ - [SquareConnect.InventoryCount](docs/InventoryCount.md)
+ - [SquareConnect.InventoryPhysicalCount](docs/InventoryPhysicalCount.md)
+ - [SquareConnect.InventoryState](docs/InventoryState.md)
+ - [SquareConnect.InventoryTransfer](docs/InventoryTransfer.md)
  - [SquareConnect.ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md)
  - [SquareConnect.ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md)
  - [SquareConnect.ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md)
@@ -272,6 +292,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.OrderLineItemModifier](docs/OrderLineItemModifier.md)
  - [SquareConnect.OrderLineItemTax](docs/OrderLineItemTax.md)
  - [SquareConnect.OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
+ - [SquareConnect.Product](docs/Product.md)
  - [SquareConnect.Refund](docs/Refund.md)
  - [SquareConnect.RefundStatus](docs/RefundStatus.md)
  - [SquareConnect.RegisterDomainRequest](docs/RegisterDomainRequest.md)
@@ -283,6 +304,14 @@ Class | Method | HTTP request | Description
  - [SquareConnect.RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md)
  - [SquareConnect.RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md)
  - [SquareConnect.RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md)
+ - [SquareConnect.RetrieveInventoryAdjustmentRequest](docs/RetrieveInventoryAdjustmentRequest.md)
+ - [SquareConnect.RetrieveInventoryAdjustmentResponse](docs/RetrieveInventoryAdjustmentResponse.md)
+ - [SquareConnect.RetrieveInventoryChangesRequest](docs/RetrieveInventoryChangesRequest.md)
+ - [SquareConnect.RetrieveInventoryChangesResponse](docs/RetrieveInventoryChangesResponse.md)
+ - [SquareConnect.RetrieveInventoryCountRequest](docs/RetrieveInventoryCountRequest.md)
+ - [SquareConnect.RetrieveInventoryCountResponse](docs/RetrieveInventoryCountResponse.md)
+ - [SquareConnect.RetrieveInventoryPhysicalCountRequest](docs/RetrieveInventoryPhysicalCountRequest.md)
+ - [SquareConnect.RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md)
  - [SquareConnect.RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
  - [SquareConnect.RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md)
  - [SquareConnect.RevokeTokenRequest](docs/RevokeTokenRequest.md)
@@ -292,6 +321,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.SearchCustomersRequest](docs/SearchCustomersRequest.md)
  - [SquareConnect.SearchCustomersResponse](docs/SearchCustomersResponse.md)
  - [SquareConnect.SortOrder](docs/SortOrder.md)
+ - [SquareConnect.SourceApplication](docs/SourceApplication.md)
  - [SquareConnect.TaxCalculationPhase](docs/TaxCalculationPhase.md)
  - [SquareConnect.TaxInclusionType](docs/TaxInclusionType.md)
  - [SquareConnect.Tender](docs/Tender.md)
@@ -380,6 +410,8 @@ Class | Method | HTTP request | Description
   - TIMECARDS_WRITE: POST, PUT, and DELETE endpoints related to employee timecards
   - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: Allow third party applications to deduct a portion of each transaction amount.
   - PAYMENTS_WRITE_IN_PERSON: POST, PUT, and DELETE endpoints. Grants write access to transaction and refunds information.
+  - INVENTORY_READ: GET endpoints related to a merchant's inventory
+  - INVENTORY_WRITE: POST, PUT, and DELETE endpoints related to a merchant's inventory
 
 ### oauth2ClientSecret
 

docs/BatchChangeInventoryRequest.md

@@ -0,0 +1,10 @@
+# SquareConnect.BatchChangeInventoryRequest
+
+## Properties
+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] 
+**changes** | [**[InventoryChange]**](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** | **Boolean** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional] 
+
+

docs/BatchChangeInventoryResponse.md

@@ -0,0 +1,9 @@
+# SquareConnect.BatchChangeInventoryResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 
+**counts** | [**[InventoryCount]**](InventoryCount.md) | The current counts for all objects referenced in the request. | [optional] 
+
+

docs/BatchRetrieveInventoryChangesRequest.md

@@ -0,0 +1,58 @@
+# SquareConnect.BatchRetrieveInventoryChangesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**catalogObjectIds** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
+**locationIds** | **[String]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
+**types** | **[String]** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional] 
+**states** | **[String]** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [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 [Paginating results](#paginatingresults) for more information. | [optional] 
+
+
+<a name="[TypesEnum]"></a>
+## Enum: [TypesEnum]
+
+
+* `PHYSICAL_COUNT` (value: `"PHYSICAL_COUNT"`)
+
+* `ADJUSTMENT` (value: `"ADJUSTMENT"`)
+
+* `TRANSFER` (value: `"TRANSFER"`)
+
+
+
+
+<a name="[StatesEnum]"></a>
+## Enum: [StatesEnum]
+
+
+* `CUSTOM` (value: `"CUSTOM"`)
+
+* `IN_STOCK` (value: `"IN_STOCK"`)
+
+* `SOLD` (value: `"SOLD"`)
+
+* `RETURNED_BY_CUSTOMER` (value: `"RETURNED_BY_CUSTOMER"`)
+
+* `RESERVED_FOR_SALE` (value: `"RESERVED_FOR_SALE"`)
+
+* `SOLD_ONLINE` (value: `"SOLD_ONLINE"`)
+
+* `ORDERED_FROM_VENDOR` (value: `"ORDERED_FROM_VENDOR"`)
+
+* `RECEIVED_FROM_VENDOR` (value: `"RECEIVED_FROM_VENDOR"`)
+
+* `IN_TRANSIT_TO` (value: `"IN_TRANSIT_TO"`)
+
+* `NONE` (value: `"NONE"`)
+
+* `WASTE` (value: `"WASTE"`)
+
+* `UNLINKED_RETURN` (value: `"UNLINKED_RETURN"`)
+
+
+
+

docs/BatchRetrieveInventoryChangesResponse.md

@@ -0,0 +1,10 @@
+# SquareConnect.BatchRetrieveInventoryChangesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 
+**changes** | [**[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 [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

docs/BatchRetrieveInventoryCountsRequest.md

@@ -0,0 +1,11 @@
+# SquareConnect.BatchRetrieveInventoryCountsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**catalogObjectIds** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
+**locationIds** | **[String]** | Filters results by [Location](#type-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 [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

docs/BatchRetrieveInventoryCountsResponse.md

@@ -0,0 +1,10 @@
+# SquareConnect.BatchRetrieveInventoryCountsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] 
+**counts** | [**[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 [Paginating results](#paginatingresults) for more information. | [optional] 
+
+

docs/Card.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **expYear** | **Number** | The four-digit year of the card's expiration date. | [optional] 
 **cardholderName** | **String** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional] 
 **billingAddress** | [**Address**](Address.md) | The card's billing address. This value is present only if this object represents a customer's card on file. | [optional] 
-**fingerprint** | **String** | The unique string fingerprint for the card.  The fingerprint is based on the credit card number and is unique to the merchant.  If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional] 
+**fingerprint** | **String** | The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional] 
 
 
 <a name="CardBrandEnum"></a>

docs/CreateCustomerRequest.md

@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **phoneNumber** | **String** | The customer's phone number. | [optional] 
 **referenceId** | **String** | An optional second ID you can set to associate the customer with an entity in another system. | [optional] 
 **note** | **String** | An optional note to associate with the customer. | [optional] 
+**birthday** | **String** | The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] 
 
 

docs/Customer.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **emailAddress** | **String** | The customer's email address. | [optional] 
 **address** | [**Address**](Address.md) | The customer's physical address. | [optional] 
 **phoneNumber** | **String** | The customer's phone number. | [optional] 
+**birthday** | **String** | The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998. | [optional] 
 **referenceId** | **String** | A second ID you can set to associate the customer with an entity in another system. | [optional] 
 **note** | **String** | A note to associate with the customer. | [optional] 
 **preferences** | [**CustomerPreferences**](CustomerPreferences.md) | The customer's preferences. | [optional] 

docs/CustomersApi.md

@@ -119,7 +119,7 @@ Name | Type | Description  | Notes
 
 DeleteCustomer
 
-Deletes a customer from a business, along with any linked cards on file.
+Deletes a customer from a business, along with any linked cards on file. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to delete merged profiles.
 
 ### Example
 ```javascript
@@ -367,7 +367,7 @@ Name | Type | Description  | Notes
 
 UpdateCustomer
 
-Updates the details of an existing customer. The ID of the customer may change if the customer has been merged into another customer.  You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
+Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles.  You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
 
 ### Example
 ```javascript

docs/Error.md

@@ -172,6 +172,8 @@ Name | Type | Description | Notes
 
 * `CHECKOUT_EXPIRED` (value: `"CHECKOUT_EXPIRED"`)
 
+* `BAD_CERTIFICATE` (value: `"BAD_CERTIFICATE"`)
+
 * `CARD_DECLINED` (value: `"CARD_DECLINED"`)
 
 * `VERIFY_CVV_FAILURE` (value: `"VERIFY_CVV_FAILURE"`)
@@ -182,6 +184,8 @@ Name | Type | Description | Notes
 
 * `NOT_FOUND` (value: `"NOT_FOUND"`)
 
+* `APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND` (value: `"APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND"`)
+
 * `METHOD_NOT_ALLOWED` (value: `"METHOD_NOT_ALLOWED"`)
 
 * `REQUEST_TIMEOUT` (value: `"REQUEST_TIMEOUT"`)