square_connect 2.20180712.2.237 → 2.20180918.0.244

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fd9e4618a2eb573bc5a2f90c06484f712edff424d0d4e0db65b5ad202bba934
-  data.tar.gz: 1957542f6fd3e07d4ad97eb8a527a64e85dd5b8f71724045bfb88de2a0a96d9c
+  metadata.gz: ee178c2811ad57f0fd692c6b253c0be29ff2df35c5c0fdd234af918833cc8c58
+  data.tar.gz: 1ff05aea12921bcb8694ff3f2b8770b56e0bfc6749c10b60cc7a9e14bafccdc3
 SHA512:
-  metadata.gz: b1b67173dda7bb4078c465c81eec01a7c9a5b1755ffc328065d9eaa83bc267cc118ce7091583549b2d93ceee0a1b80e894531fcf3f292bc8c11659c8c9263110
-  data.tar.gz: c8c6ba9110f351a1665c4b3d4cf269f6559ca99a47cf9553f9a6661cb5506c9cbd5ad231c305deca8ef490854a677886aa57749cded1e2dd841088ef8c9d004f
+  metadata.gz: 9f473942c9cb063b717568b4aa59741095b52da3fd6c480b01d90f7319d96ac8a613b7a4c2ec167ef787f8c154b242b8e549c12d3bd3d985c4233cfdb564ddc6
+  data.tar.gz: e5b68256f3feaca28287d9d10069fa60e1a39ee08add4c6bd78cafa6527935bcfb27e3fc57247ad09e4f7ba3f64516b0f243453e4a498589db985d70adbaf760

data/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.
 

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.20180712.2
+- Package version: 2.20180918.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
@@ -94,6 +94,13 @@ Class | Method | HTTP request | Description
 *SquareConnect::CustomersApi* | [**retrieve_customer**](docs/CustomersApi.md#retrieve_customer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer
 *SquareConnect::CustomersApi* | [**search_customers**](docs/CustomersApi.md#search_customers) | **POST** /v2/customers/search | SearchCustomers
 *SquareConnect::CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer
+*SquareConnect::InventoryApi* | [**batch_change_inventory**](docs/InventoryApi.md#batch_change_inventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory
+*SquareConnect::InventoryApi* | [**batch_retrieve_inventory_changes**](docs/InventoryApi.md#batch_retrieve_inventory_changes) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges
+*SquareConnect::InventoryApi* | [**batch_retrieve_inventory_counts**](docs/InventoryApi.md#batch_retrieve_inventory_counts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts
+*SquareConnect::InventoryApi* | [**retrieve_inventory_adjustment**](docs/InventoryApi.md#retrieve_inventory_adjustment) | **GET** /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment
+*SquareConnect::InventoryApi* | [**retrieve_inventory_changes**](docs/InventoryApi.md#retrieve_inventory_changes) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges
+*SquareConnect::InventoryApi* | [**retrieve_inventory_count**](docs/InventoryApi.md#retrieve_inventory_count) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount
+*SquareConnect::InventoryApi* | [**retrieve_inventory_physical_count**](docs/InventoryApi.md#retrieve_inventory_physical_count) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount
 *SquareConnect::LocationsApi* | [**list_locations**](docs/LocationsApi.md#list_locations) | **GET** /v2/locations | ListLocations
 *SquareConnect::MobileAuthorizationApi* | [**create_mobile_authorization_code**](docs/MobileAuthorizationApi.md#create_mobile_authorization_code) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode
 *SquareConnect::OAuthApi* | [**obtain_token**](docs/OAuthApi.md#obtain_token) | **POST** /oauth2/token | ObtainToken
@@ -187,10 +194,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)
@@ -270,7 +283,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)
@@ -301,6 +321,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)
@@ -312,6 +333,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)
@@ -321,6 +350,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)
@@ -409,6 +439,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
 

data/docs/BatchChangeInventoryRequest.md

@@ -0,0 +1,14 @@
+# SquareConnect::BatchChangeInventoryRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**idempotency_key** | **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** | [**Array<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] 
+**ignore_unchanged_counts** | **BOOLEAN** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional] 
+
+

data/docs/BatchChangeInventoryResponse.md

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

data/docs/BatchRetrieveInventoryChangesRequest.md

@@ -0,0 +1,18 @@
+# SquareConnect::BatchRetrieveInventoryChangesRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**catalog_object_ids** | **Array<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
+**location_ids** | **Array<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
+**types** | **Array<String>** | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional] 
+**states** | **Array<String>** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional] 
+**updated_after** | **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] 
+**updated_before** | **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] 
+
+

data/docs/BatchRetrieveInventoryChangesResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::BatchRetrieveInventoryChangesResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**changes** | [**Array<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] 
+
+

data/docs/BatchRetrieveInventoryCountsRequest.md

@@ -0,0 +1,15 @@
+# SquareConnect::BatchRetrieveInventoryCountsRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**catalog_object_ids** | **Array<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
+**location_ids** | **Array<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional] 
+**updated_after** | **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] 
+
+

data/docs/BatchRetrieveInventoryCountsResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::BatchRetrieveInventoryCountsResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**counts** | [**Array<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] 
+
+

data/docs/Card.md

@@ -14,6 +14,6 @@ Name | Type | Description | Notes
 **exp_year** | **Integer** | The four-digit year of the card's expiration date. | [optional] 
 **cardholder_name** | **String** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional] 
 **billing_address** | [**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] 
 
 

data/docs/CreateCustomerRequest.md

@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 **phone_number** | **String** | The customer's phone number. | [optional] 
 **reference_id** | **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] 
 
 

data/docs/Customer.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **email_address** | **String** | The customer's email address. | [optional] 
 **address** | [**Address**](Address.md) | The customer's physical address. | [optional] 
 **phone_number** | **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] 
 **reference_id** | **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] 

data/docs/CustomersApi.md

@@ -126,7 +126,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
 ```ruby
@@ -394,7 +394,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
 ```ruby

data/docs/ErrorCode.md

@@ -77,11 +77,13 @@ Name | Type
 **INVALID_EMAIL_ADDRESS** | string
 **INVALID_PHONE_NUMBER** | string
 **CHECKOUT_EXPIRED** | string
+**BAD_CERTIFICATE** | string
 **CARD_DECLINED** | string
 **VERIFY_CVV_FAILURE** | string
 **VERIFY_AVS_FAILURE** | string
 **CARD_DECLINED_CALL_ISSUER** | string
 **NOT_FOUND** | string
+**APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND** | string
 **METHOD_NOT_ALLOWED** | string
 **REQUEST_TIMEOUT** | string
 **CONFLICT** | string

data/docs/InventoryAdjustment.md

@@ -0,0 +1,28 @@
+# SquareConnect::InventoryAdjustment
+
+### Description
+
+Represents a change in state or quantity of product inventory at a particular time and location.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique ID generated by Square for the [InventoryAdjustment](#type-inventoryadjustment). | [optional] 
+**reference_id** | **String** | An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system. | [optional] 
+**from_state** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. | [optional] 
+**to_state** | **String** | The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. | [optional] 
+**location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
+**catalog_object_id** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional] 
+**catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] 
+**quantity** | **String** | The number of items affected by the adjustment as a decimal string. Fractional quantities are not supported. | [optional] 
+**total_price_money** | [**Money**](Money.md) | The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative. | [optional] 
+**occurred_at** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the adjustment took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional] 
+**created_at** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment. | [optional] 
+**source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that caused the inventory adjustment. | [optional] 
+**employee_id** | **String** | The Square ID of the [Employee](#type-employee) responsible for the inventory adjustment. | [optional] 
+**transaction_id** | **String** | The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions. | [optional] 
+**refund_id** | **String** | The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions. | [optional] 
+**purchase_order_id** | **String** | The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app. | [optional] 
+**goods_receipt_id** | **String** | The read-only Square ID of the Square goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app. | [optional] 
+
+

data/docs/InventoryApi.md

@@ -0,0 +1,391 @@
+# SquareConnect::InventoryApi
+
+All URIs are relative to *https://connect.squareup.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**batch_change_inventory**](InventoryApi.md#batch_change_inventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory
+[**batch_retrieve_inventory_changes**](InventoryApi.md#batch_retrieve_inventory_changes) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges
+[**batch_retrieve_inventory_counts**](InventoryApi.md#batch_retrieve_inventory_counts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts
+[**retrieve_inventory_adjustment**](InventoryApi.md#retrieve_inventory_adjustment) | **GET** /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment
+[**retrieve_inventory_changes**](InventoryApi.md#retrieve_inventory_changes) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges
+[**retrieve_inventory_count**](InventoryApi.md#retrieve_inventory_count) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount
+[**retrieve_inventory_physical_count**](InventoryApi.md#retrieve_inventory_physical_count) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount
+
+
+# **batch_change_inventory**
+> BatchChangeInventoryResponse batch_change_inventory(body)
+
+BatchChangeInventory
+
+Applies adjustments and counts to the provided item quantities.  On success: returns the current calculated counts for all objects referenced in the request. On failure: returns a list of related errors.
+
+### 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::InventoryApi.new
+
+body = SquareConnect::BatchChangeInventoryRequest.new # BatchChangeInventoryRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #BatchChangeInventory
+  result = api_instance.batch_change_inventory(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling InventoryApi->batch_change_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BatchChangeInventoryRequest**](BatchChangeInventoryRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**BatchChangeInventoryResponse**](BatchChangeInventoryResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **batch_retrieve_inventory_changes**
+> BatchRetrieveInventoryChangesResponse batch_retrieve_inventory_changes(body)
+
+BatchRetrieveInventoryChanges
+
+Returns historical physical counts and adjustments based on the provided filter criteria.  Results are paginated and sorted in ascending order according their `occurred_at` timestamp (oldest first).  BatchRetrieveInventoryChanges is a catch-all query endpoint for queries that cannot be handled by other, simpler endpoints.
+
+### 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::InventoryApi.new
+
+body = SquareConnect::BatchRetrieveInventoryChangesRequest.new # BatchRetrieveInventoryChangesRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #BatchRetrieveInventoryChanges
+  result = api_instance.batch_retrieve_inventory_changes(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling InventoryApi->batch_retrieve_inventory_changes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BatchRetrieveInventoryChangesRequest**](BatchRetrieveInventoryChangesRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**BatchRetrieveInventoryChangesResponse**](BatchRetrieveInventoryChangesResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **batch_retrieve_inventory_counts**
+> BatchRetrieveInventoryCountsResponse batch_retrieve_inventory_counts(body)
+
+BatchRetrieveInventoryCounts
+
+Returns current counts for the provided [CatalogObject](#type-catalogobject)s at the requested [Location](#type-location)s.  Results are paginated and sorted in descending order according to their `calculated_at` timestamp (newest first).  When `updated_at` is specified, only counts that have changed since that time (based on the server timestamp for the most recent change) are returned. This allows clients to perform a \"sync\" operation, for example in response to receiving a Webhook notification.
+
+### 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::InventoryApi.new
+
+body = SquareConnect::BatchRetrieveInventoryCountsRequest.new # BatchRetrieveInventoryCountsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+
+
+begin
+  #BatchRetrieveInventoryCounts
+  result = api_instance.batch_retrieve_inventory_counts(body)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling InventoryApi->batch_retrieve_inventory_counts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BatchRetrieveInventoryCountsRequest**](BatchRetrieveInventoryCountsRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. | 
+
+### Return type
+
+[**BatchRetrieveInventoryCountsResponse**](BatchRetrieveInventoryCountsResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_inventory_adjustment**
+> RetrieveInventoryAdjustmentResponse retrieve_inventory_adjustment(adjustment_id)
+
+RetrieveInventoryAdjustment
+
+Returns the [InventoryAdjustment](#type-inventoryadjustment) object with the provided `adjustment_id`.
+
+### 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::InventoryApi.new
+
+adjustment_id = "adjustment_id_example" # String | ID of the [InventoryAdjustment](#type-inventoryadjustment) to retrieve.
+
+
+begin
+  #RetrieveInventoryAdjustment
+  result = api_instance.retrieve_inventory_adjustment(adjustment_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling InventoryApi->retrieve_inventory_adjustment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **adjustment_id** | **String**| ID of the [InventoryAdjustment](#type-inventoryadjustment) to retrieve. | 
+
+### Return type
+
+[**RetrieveInventoryAdjustmentResponse**](RetrieveInventoryAdjustmentResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_inventory_changes**
+> RetrieveInventoryChangesResponse retrieve_inventory_changes(catalog_object_id, opts)
+
+RetrieveInventoryChanges
+
+Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s.  Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first).  There are no limits on how far back the caller can page. This endpoint is useful when displaying recent changes for a specific item. For more sophisticated queries, use a batch endpoint.
+
+### 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::InventoryApi.new
+
+catalog_object_id = "catalog_object_id_example" # String | ID of the [CatalogObject](#type-catalogobject) to retrieve.
+
+opts = { 
+  location_ids: "location_ids_example", # String | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations.
+  cursor: "cursor_example" # 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.
+}
+
+begin
+  #RetrieveInventoryChanges
+  result = api_instance.retrieve_inventory_changes(catalog_object_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling InventoryApi->retrieve_inventory_changes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_object_id** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. | 
+ **location_ids** | **String**| The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [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] 
+
+### Return type
+
+[**RetrieveInventoryChangesResponse**](RetrieveInventoryChangesResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_inventory_count**
+> RetrieveInventoryCountResponse retrieve_inventory_count(catalog_object_id, opts)
+
+RetrieveInventoryCount
+
+Retrieves the current calculated stock count for a given [CatalogObject](#type-catalogobject) at a given set of [Location](#type-location)s. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.
+
+### 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::InventoryApi.new
+
+catalog_object_id = "catalog_object_id_example" # String | ID of the [CatalogObject](#type-catalogobject) to retrieve.
+
+opts = { 
+  location_ids: "location_ids_example", # String | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations.
+  cursor: "cursor_example" # 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.
+}
+
+begin
+  #RetrieveInventoryCount
+  result = api_instance.retrieve_inventory_count(catalog_object_id, opts)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling InventoryApi->retrieve_inventory_count: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_object_id** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. | 
+ **location_ids** | **String**| The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [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] 
+
+### Return type
+
+[**RetrieveInventoryCountResponse**](RetrieveInventoryCountResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **retrieve_inventory_physical_count**
+> RetrieveInventoryPhysicalCountResponse retrieve_inventory_physical_count(physical_count_id)
+
+RetrieveInventoryPhysicalCount
+
+Returns the [InventoryPhysicalCount](#type-inventoryphysicalcount) object with the provided `physical_count_id`.
+
+### 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::InventoryApi.new
+
+physical_count_id = "physical_count_id_example" # String | ID of the [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve.
+
+
+begin
+  #RetrieveInventoryPhysicalCount
+  result = api_instance.retrieve_inventory_physical_count(physical_count_id)
+  p result
+rescue SquareConnect::ApiError => e
+  puts "Exception when calling InventoryApi->retrieve_inventory_physical_count: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **physical_count_id** | **String**| ID of the [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve. | 
+
+### Return type
+
+[**RetrieveInventoryPhysicalCountResponse**](RetrieveInventoryPhysicalCountResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+