Release 2.20190313.0 (#45)

square · Mar 13, 2019 · decfb03 · decfb03
1 parent 94d844a
commit decfb03
Show file tree

Hide file tree

Showing 814 changed files with 25,168 additions and 691 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,29 @@
 # Change Log
 
+## Version 2.20190313.0 (2019-03-13)
+
+## New API: Labor API
+
+The Labor API now includes functionality
+that gives a Square account the ability to track and retrieve employee labor hours 
+including multiple hourly wage rates per employee, work shift break tracking, and 
+standardized break templates.
+
+See the Connect v2 Technical Reference.
+
+## New API: Employees API
+
+The Employees API includes the ability to list employees for a Square 
+account and retrieve a single employee by ID.
+
+See the Connect v2 Technical Reference.
+
+## Improvement: Simplified OAuth access token renewal
+
+The RenewToken endpoint is now deprecated and replaced with new functionality in ObtainToken.
+ObtainToken now returns a refresh token along with an access token. Refresh
+tokens are used to renew expired OAuth access tokens.
+
 ## Version 2.20190213.0 (2019-02-13)
 
 ## New feature: Order fulfillment BETA

diff --git a/README.md b/README.md
diff --git a/docs/AdditionalRecipient.md b/docs/AdditionalRecipient.md
@@ -1,5 +1,9 @@
 # SquareConnect.AdditionalRecipient
 
+### Description
+
+Represents an additional recipient (other than the merchant) receiving a portion of this tender.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/AdditionalRecipientReceivable.md b/docs/AdditionalRecipientReceivable.md
@@ -1,5 +1,9 @@
 # SquareConnect.AdditionalRecipientReceivable
 
+### Description
+
+Represents a monetary distribution of part of a [Transaction](#type-transaction)'s amount for Transactions which included additional recipients. The location of this receivable is that same as the one specified in the [AdditionalRecipient](#type-additionalrecipient).
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/AdditionalRecipientReceivableRefund.md b/docs/AdditionalRecipientReceivableRefund.md
@@ -1,5 +1,9 @@
 # SquareConnect.AdditionalRecipientReceivableRefund
 
+### Description
+
+A refund of an [AdditionalRecipientReceivable](#type-additionalrecipientreceivable). This includes the ID of the additional recipient receivable associated to this object, as well as a reference to the [Refund](#type-refund) that created this receivable refund.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/Address.md b/docs/Address.md
@@ -1,5 +1,9 @@
 # SquareConnect.Address
 
+### Description
+
+Represents a physical address.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchChangeInventoryRequest.md b/docs/BatchChangeInventoryRequest.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchChangeInventoryRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchChangeInventoryResponse.md b/docs/BatchChangeInventoryResponse.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchChangeInventoryResponse
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchDeleteCatalogObjectsRequest.md b/docs/BatchDeleteCatalogObjectsRequest.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchDeleteCatalogObjectsRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchDeleteCatalogObjectsResponse.md b/docs/BatchDeleteCatalogObjectsResponse.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchDeleteCatalogObjectsResponse
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchRetrieveCatalogObjectsRequest.md b/docs/BatchRetrieveCatalogObjectsRequest.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchRetrieveCatalogObjectsRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchRetrieveCatalogObjectsResponse.md b/docs/BatchRetrieveCatalogObjectsResponse.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchRetrieveCatalogObjectsResponse
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchRetrieveInventoryChangesRequest.md b/docs/BatchRetrieveInventoryChangesRequest.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchRetrieveInventoryChangesRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
@@ -9,7 +13,7 @@ Name | Type | Description | Notes
 **states** | **[String]** | Filters &#x60;ADJUSTMENT&#x60; 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 &#x60;created_at&#x60; or &#x60;calculated_at&#x60; value is after the given time. Default: UNIX epoch (&#x60;1970-01-01T00:00:00Z&#x60;). | [optional] 
 **updated_before** | **String** | Provided as an RFC 3339 timestamp. Returns results whose &#x60;created_at&#x60; or &#x60;calculated_at&#x60; value is strictly before the given time. Default: UNIX epoch (&#x60;1970-01-01T00:00:00Z&#x60;). | [optional] 
-**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
 
 
 <a name="[TypesEnum]"></a>

diff --git a/docs/BatchRetrieveInventoryChangesResponse.md b/docs/BatchRetrieveInventoryChangesResponse.md
@@ -1,10 +1,14 @@
 # SquareConnect.BatchRetrieveInventoryChangesResponse
 
+### Description
+
+
+
 ## 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] 
+**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] 
 
 
diff --git a/docs/BatchRetrieveInventoryCountsRequest.md b/docs/BatchRetrieveInventoryCountsRequest.md
@@ -1,11 +1,15 @@
 # SquareConnect.BatchRetrieveInventoryCountsRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **catalog_object_ids** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] 
 **location_ids** | **[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 &#x60;calculated_at&#x60; value is after the given time. Default: UNIX epoch (&#x60;1970-01-01T00:00:00Z&#x60;). | [optional] 
-**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
+**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
 
 
diff --git a/docs/BatchRetrieveInventoryCountsResponse.md b/docs/BatchRetrieveInventoryCountsResponse.md
@@ -1,10 +1,14 @@
 # SquareConnect.BatchRetrieveInventoryCountsResponse
 
+### Description
+
+
+
 ## 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] 
+**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response.  See [Pagination](/basics/api101/pagination) for more information. | [optional] 
 
 
diff --git a/docs/BatchRetrieveOrdersRequest.md b/docs/BatchRetrieveOrdersRequest.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchRetrieveOrdersRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/BatchRetrieveOrdersResponse.md b/docs/BatchRetrieveOrdersResponse.md
@@ -1,5 +1,9 @@
 # SquareConnect.BatchRetrieveOrdersResponse
 
+### Description
+
+Defines the fields that are included in the response body of a request to the [BatchRetrieveOrders](#endpoint-batchretrieveorders) endpoint.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

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

diff --git a/docs/BreakType.md b/docs/BreakType.md
@@ -0,0 +1,19 @@
+# SquareConnect.BreakType
+
+### Description
+
+A defined break template that sets an expectation for possible `Break`  instances on a `Shift`.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | UUID for this object. | [optional] 
+**location_id** | **String** | The ID of the business location this type of break applies to. | 
+**break_name** | **String** | A human-readable name for this type of break. Will be displayed to employees in Square products. | 
+**expected_duration** | **String** | Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision below minutes is truncated. | 
+**is_paid** | **Boolean** | Whether this break counts towards time worked for compensation purposes. | 
+**version** | **Number** | Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square&#39;s servers execute a \&quot;blind\&quot; write; potentially  overwriting another writer&#39;s data. | [optional] 
+**created_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] 
+**updated_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] 
+
+
diff --git a/docs/CaptureTransactionRequest.md b/docs/CaptureTransactionRequest.md
@@ -1,5 +1,9 @@
 # SquareConnect.CaptureTransactionRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CaptureTransactionResponse.md b/docs/CaptureTransactionResponse.md
@@ -1,5 +1,9 @@
 # SquareConnect.CaptureTransactionResponse
 
+### Description
+
+Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/Card.md b/docs/Card.md
@@ -1,5 +1,9 @@
 # SquareConnect.Card
 
+### Description
+
+Represents the payment details of a card to be used for payments. These details are determined by the `card_nonce` generated by `SqPaymentForm`.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
@@ -10,7 +14,7 @@ Name | Type | Description | Notes
 **exp_year** | **Number** | The four-digit year of the card&#39;s expiration date. | [optional] 
 **cardholder_name** | **String** | The name of the cardholder. | [optional] 
 **billing_address** | [**Address**](Address.md) | The billing address for this card. | [optional] 
-**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based  on the card number, to identify the card across multiple locations within a single application. | [optional] 
+**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. | [optional] 
 
 
 <a name="CardBrandEnum"></a>

diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md
@@ -271,7 +271,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
 var apiInstance = new SquareConnect.CatalogApi();
 
 var opts = { 
-  'cursor': "cursor_example", // String | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information.
+  'cursor': "cursor_example", // String | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.
   'types': "types_example" // String | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`.  The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`.
 };
 apiInstance.listCatalog(opts).then(function(data) {
@@ -286,7 +286,7 @@ apiInstance.listCatalog(opts).then(function(data) {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional] 
+ **cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. | [optional] 
  **types** | **String**| An optional case-insensitive, comma-separated list of object types to retrieve, for example &#x60;ITEM,ITEM_VARIATION,CATEGORY&#x60;.  The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely &#x60;\&quot;ITEM\&quot;&#x60;, &#x60;\&quot;ITEM_VARIATION\&quot;&#x60;, &#x60;\&quot;CATEGORY\&quot;&#x60;, &#x60;\&quot;DISCOUNT\&quot;&#x60;, &#x60;\&quot;TAX\&quot;&#x60;, &#x60;\&quot;MODIFIER\&quot;&#x60;, or &#x60;\&quot;MODIFIER_LIST\&quot;&#x60;. | [optional] 
 
 ### Return type

diff --git a/docs/CatalogCategory.md b/docs/CatalogCategory.md
@@ -1,5 +1,9 @@
 # SquareConnect.CatalogCategory
 
+### Description
+
+A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CatalogDiscount.md b/docs/CatalogDiscount.md
@@ -1,5 +1,9 @@
 # SquareConnect.CatalogDiscount
 
+### Description
+
+A discount in the Catalog object model.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CatalogIdMapping.md b/docs/CatalogIdMapping.md
@@ -1,5 +1,9 @@
 # SquareConnect.CatalogIdMapping
 
+### Description
+
+A mapping between a client-supplied temporary ID and a permanent server ID.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CatalogInfoRequest.md b/docs/CatalogInfoRequest.md
@@ -1,5 +1,9 @@
 # SquareConnect.CatalogInfoRequest
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CatalogInfoResponse.md b/docs/CatalogInfoResponse.md
@@ -1,5 +1,9 @@
 # SquareConnect.CatalogInfoResponse
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CatalogInfoResponseLimits.md b/docs/CatalogInfoResponseLimits.md
@@ -1,5 +1,9 @@
 # SquareConnect.CatalogInfoResponseLimits
 
+### Description
+
+
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md
@@ -1,11 +1,15 @@
 # SquareConnect.CatalogItem
 
+### Description
+
+An item (i.e., product family) in the Catalog object model.
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The item&#39;s name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. | [optional] 
 **description** | **String** | The item&#39;s description. Searchable. This field has max length of 4096 Unicode code points. | [optional] 
-**abbreviation** | **String** | The text of the item&#39;s display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points. | [optional] 
+**abbreviation** | **String** | The text of the item&#39;s display label in the Square Point of Sale app. Only up to the first five characters of the string are used.  Searchable. This field has max length of 24 Unicode code points. | [optional] 
 **label_color** | **String** | The color of the item&#39;s display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] 
 **available_online** | **Boolean** | If &#x60;true&#x60;, the item can be added to shipping orders from the merchant&#39;s online store. | [optional] 
 **available_for_pickup** | **Boolean** | If &#x60;true&#x60;, the item can be added to pickup orders from the merchant&#39;s online store. | [optional]