square_connect 2.20180712.2.237 → 2.20180918.0.244

data/docs/InventoryChange.md

@@ -0,0 +1,15 @@
+# SquareConnect::InventoryChange
+
+### Description
+
+Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for all possible values. | [optional] 
+**physical_count** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | Contains details about the physical count when `type` is `PHYSICAL_COUNT` and unset for all other types. | [optional] 
+**adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | Contains details about the inventory adjustment when `type` is `ADJUSTMENT` and unset for all other types. | [optional] 
+**transfer** | [**InventoryTransfer**](InventoryTransfer.md) | Contains details about the inventory transfer when `type` is `TRANSFER` and unset for all other types. | [optional] 
+
+

data/docs/InventoryChangeType.md

@@ -0,0 +1,14 @@
+# SquareConnect::InventoryChangeType
+
+### Description
+
+Indicates how the inventory change was applied to a tracked quantity of items.
+
+## Properties
+Name | Type
+------------ | -------------
+**PHYSICAL_COUNT** | string
+**ADJUSTMENT** | string
+**TRANSFER** | string
+
+

data/docs/InventoryCount.md

@@ -0,0 +1,17 @@
+# SquareConnect::InventoryCount
+
+### Description
+
+Represents the estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. | [optional] 
+**location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
+**quantity** | **String** | The number of items in the count as a decimal string. Fractional quantities are not supported. | [optional] 
+**calculated_at** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count. | [optional] 
+
+

data/docs/InventoryPhysicalCount.md

@@ -0,0 +1,22 @@
+# SquareConnect::InventoryPhysicalCount
+
+### Description
+
+Represents a verified (re)count of items in a given state at a specific location. For example, the quantity of items currently on hand at a physical store).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique ID generated by Square for the [InventoryPhysicalCount](#type-inventoryphysicalcount). | [optional] 
+**reference_id** | **String** | An optional ID provided by the application to tie the [InventoryPhysicalCount](#type-inventoryphysicalcount) to an external system. | [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] 
+**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. | [optional] 
+**location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional] 
+**quantity** | **String** | The number of items affected by the physical count as a decimal string. Fractional quantities are not supported. | [optional] 
+**source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that submitted the physical count. | [optional] 
+**employee_id** | **String** | The Square ID of the [Employee](#type-employee) responsible for the physical count. | [optional] 
+**occurred_at** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the physical count 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 physical count. | [optional] 
+
+

data/docs/InventoryState.md

@@ -0,0 +1,23 @@
+# SquareConnect::InventoryState
+
+### Description
+
+Indicates the state of a tracked item quantity in the lifecycle of goods.
+
+## Properties
+Name | Type
+------------ | -------------
+**CUSTOM** | string
+**IN_STOCK** | string
+**SOLD** | string
+**RETURNED_BY_CUSTOMER** | string
+**RESERVED_FOR_SALE** | string
+**SOLD_ONLINE** | string
+**ORDERED_FROM_VENDOR** | string
+**RECEIVED_FROM_VENDOR** | string
+**IN_TRANSIT_TO** | string
+**NONE** | string
+**WASTE** | string
+**UNLINKED_RETURN** | string
+
+

data/docs/InventoryTransfer.md

@@ -0,0 +1,23 @@
+# SquareConnect::InventoryTransfer
+
+### Description
+
+Represents the transfer of a quantity of product inventory at a particular time from one location to another.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique ID generated by Square for the [InventoryTransfer](#type-inventorytransfer). | [optional] 
+**reference_id** | **String** | An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system. | [optional] 
+**state** | **String** | The [InventoryState](#type-inventorystate) for the quantity of items being transfered. | [optional] 
+**from_location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer. | [optional] 
+**to_location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer. | [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 transfer as a decimal string. Fractional quantities are not supported. | [optional] 
+**occurred_at** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the transfer 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 transfer request. | [optional] 
+**source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that initiated the inventory transfer. | [optional] 
+**employee_id** | **String** | The Square ID of the [Employee](#type-employee) responsible for the inventory transfer. | [optional] 
+
+

data/docs/Product.md

@@ -0,0 +1,19 @@
+# SquareConnect::Product
+
+### Description
+
+Indicates the Square product used to generate an inventory change.
+
+## Properties
+Name | Type
+------------ | -------------
+**SQUARE_POS** | string
+**EXTERNAL_API** | string
+**BILLING** | string
+**APPOINTMENTS** | string
+**INVOICES** | string
+**ONLINE_STORE** | string
+**PAYROLL** | string
+**OTHER** | string
+
+

data/docs/RetrieveInventoryAdjustmentRequest.md

@@ -0,0 +1,11 @@
+# SquareConnect::RetrieveInventoryAdjustmentRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RetrieveInventoryAdjustmentResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::RetrieveInventoryAdjustmentResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**adjustment** | [**InventoryAdjustment**](InventoryAdjustment.md) | The requested [InventoryAdjustment](#type-inventoryadjustment). | [optional] 
+
+

data/docs/RetrieveInventoryChangesRequest.md

@@ -0,0 +1,13 @@
+# SquareConnect::RetrieveInventoryChangesRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+
+

data/docs/RetrieveInventoryChangesResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::RetrieveInventoryChangesResponse
+
+### 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 set of inventory changes for the requested object 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/RetrieveInventoryCountRequest.md

@@ -0,0 +1,13 @@
+# SquareConnect::RetrieveInventoryCountRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+
+

data/docs/RetrieveInventoryCountResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect::RetrieveInventoryCountResponse
+
+### 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 object 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/RetrieveInventoryPhysicalCountRequest.md

@@ -0,0 +1,11 @@
+# SquareConnect::RetrieveInventoryPhysicalCountRequest
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RetrieveInventoryPhysicalCountResponse.md

@@ -0,0 +1,13 @@
+# SquareConnect::RetrieveInventoryPhysicalCountResponse
+
+### Description
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional] 
+**count** | [**InventoryPhysicalCount**](InventoryPhysicalCount.md) | The requested [InventoryPhysicalCount](#type-inventoryphysicalcount). | [optional] 
+
+

data/docs/SourceApplication.md

@@ -0,0 +1,14 @@
+# SquareConnect::SourceApplication
+
+### Description
+
+Provides information about the application used to generate an inventory change.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product** | **String** | Read-only [Product](#type-product) type for the application. | [optional] 
+**application_id** | **String** | Read-only Square ID assigned to the application. Only used for [Product](#type-product) type `EXTERNAL_API`. | [optional] 
+**name** | **String** | Read-only display name assigned to the application (e.g. `\"Custom Application\"`, `\"Square POS 4.74 for Android\"`). | [optional] 
+
+

data/docs/TransactionsApi.md

@@ -128,7 +128,7 @@ Name | Type | Description  | Notes
 
 CreateRefund
 
-Initiates a refund for a previously charged tender.  You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior.  *NOTE**: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app).
+Initiates a refund for a previously charged tender.  You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior.  NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app).
 
 ### Example
 ```ruby

data/docs/UpdateCustomerRequest.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/V1Timecard.md

@@ -12,9 +12,12 @@ Name | Type | Description | Notes
 **deleted** | **BOOLEAN** | If true, the timecard was deleted by the merchant, and it is no longer valid. | [optional] 
 **clockin_time** | **String** | The clock-in time for the timecard, in ISO 8601 format. | [optional] 
 **clockout_time** | **String** | The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system. | [optional] 
-**clockin_location_id** | **String** | The ID of the location the employee clocked in from, if any. | [optional] 
+**clockin_location_id** | **String** | The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard’s timezone and overtime rules. | [optional] 
 **clockout_location_id** | **String** | The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system. | [optional] 
 **created_at** | **String** | The time when the timecard was created, in ISO 8601 format. | [optional] 
 **updated_at** | **String** | The time when the timecard was most recently updated, in ISO 8601 format. | [optional] 
+**regular_seconds_worked** | **Float** | The total number of regular (non-overtime) seconds worked in the timecard. | [optional] 
+**overtime_seconds_worked** | **Float** | The total number of overtime seconds worked in the timecard. | [optional] 
+**doubletime_seconds_worked** | **Float** | The total number of doubletime seconds worked in the timecard. | [optional] 
 
 

data/lib/square_connect.rb

@@ -18,10 +18,16 @@ require 'square_connect/models/additional_recipient'
 require 'square_connect/models/additional_recipient_receivable'
 require 'square_connect/models/additional_recipient_receivable_refund'
 require 'square_connect/models/address'
+require 'square_connect/models/batch_change_inventory_request'
+require 'square_connect/models/batch_change_inventory_response'
 require 'square_connect/models/batch_delete_catalog_objects_request'
 require 'square_connect/models/batch_delete_catalog_objects_response'
 require 'square_connect/models/batch_retrieve_catalog_objects_request'
 require 'square_connect/models/batch_retrieve_catalog_objects_response'
+require 'square_connect/models/batch_retrieve_inventory_changes_request'
+require 'square_connect/models/batch_retrieve_inventory_changes_response'
+require 'square_connect/models/batch_retrieve_inventory_counts_request'
+require 'square_connect/models/batch_retrieve_inventory_counts_response'
 require 'square_connect/models/batch_retrieve_orders_request'
 require 'square_connect/models/batch_retrieve_orders_response'
 require 'square_connect/models/batch_upsert_catalog_objects_request'
@@ -101,7 +107,14 @@ require 'square_connect/models/device'
 require 'square_connect/models/error'
 require 'square_connect/models/error_category'
 require 'square_connect/models/error_code'
+require 'square_connect/models/inventory_adjustment'
 require 'square_connect/models/inventory_alert_type'
+require 'square_connect/models/inventory_change'
+require 'square_connect/models/inventory_change_type'
+require 'square_connect/models/inventory_count'
+require 'square_connect/models/inventory_physical_count'
+require 'square_connect/models/inventory_state'
+require 'square_connect/models/inventory_transfer'
 require 'square_connect/models/item_variation_location_overrides'
 require 'square_connect/models/list_additional_recipient_receivable_refunds_request'
 require 'square_connect/models/list_additional_recipient_receivable_refunds_response'
@@ -132,6 +145,7 @@ require 'square_connect/models/order_line_item_discount_type'
 require 'square_connect/models/order_line_item_modifier'
 require 'square_connect/models/order_line_item_tax'
 require 'square_connect/models/order_line_item_tax_type'
+require 'square_connect/models/product'
 require 'square_connect/models/refund'
 require 'square_connect/models/refund_status'
 require 'square_connect/models/register_domain_request'
@@ -143,6 +157,14 @@ require 'square_connect/models/retrieve_catalog_object_request'
 require 'square_connect/models/retrieve_catalog_object_response'
 require 'square_connect/models/retrieve_customer_request'
 require 'square_connect/models/retrieve_customer_response'
+require 'square_connect/models/retrieve_inventory_adjustment_request'
+require 'square_connect/models/retrieve_inventory_adjustment_response'
+require 'square_connect/models/retrieve_inventory_changes_request'
+require 'square_connect/models/retrieve_inventory_changes_response'
+require 'square_connect/models/retrieve_inventory_count_request'
+require 'square_connect/models/retrieve_inventory_count_response'
+require 'square_connect/models/retrieve_inventory_physical_count_request'
+require 'square_connect/models/retrieve_inventory_physical_count_response'
 require 'square_connect/models/retrieve_transaction_request'
 require 'square_connect/models/retrieve_transaction_response'
 require 'square_connect/models/revoke_token_request'
@@ -152,6 +174,7 @@ require 'square_connect/models/search_catalog_objects_response'
 require 'square_connect/models/search_customers_request'
 require 'square_connect/models/search_customers_response'
 require 'square_connect/models/sort_order'
+require 'square_connect/models/source_application'
 require 'square_connect/models/tax_calculation_phase'
 require 'square_connect/models/tax_inclusion_type'
 require 'square_connect/models/tender'
@@ -218,6 +241,7 @@ require 'square_connect/api/apple_pay_api'
 require 'square_connect/api/catalog_api'
 require 'square_connect/api/checkout_api'
 require 'square_connect/api/customers_api'
+require 'square_connect/api/inventory_api'
 require 'square_connect/api/locations_api'
 require 'square_connect/api/mobile_authorization_api'
 require 'square_connect/api/o_auth_api'

data/lib/square_connect/api/apple_pay_api.rb

@@ -51,7 +51,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}

data/lib/square_connect/api/catalog_api.rb

@@ -51,7 +51,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -106,7 +106,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -161,7 +161,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -212,7 +212,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -267,7 +267,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -324,7 +324,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -382,7 +382,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -437,7 +437,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -492,7 +492,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -547,7 +547,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}
@@ -602,7 +602,7 @@ module SquareConnect
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       
-      header_params['Square-Version'] = "2018-07-12"
+      header_params['Square-Version'] = "2018-09-18"
 
       # form parameters
       form_params = {}