Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Commit d2fe44a

Browse files
ssung88ssung88
authored
Release 2.20190313.0 (#56)
1 parent c04b18a commit d2fe44a

File tree

644 files changed

+24284
-826
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

644 files changed

+24284
-826
lines changed

‎CHANGES.md

+24
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Change Log
22

3+
## Version 2.20190313.0 (2019-03-13)
4+
5+
## New API: Labor API
6+
7+
The Labor API now includes functionality
8+
that gives a Square account the ability to track and retrieve employee labor hours
9+
including multiple hourly wage rates per employee, work shift break tracking, and
10+
standardized break templates.
11+
12+
See the Connect v2 Technical Reference.
13+
14+
## New API: Employees API
15+
16+
The Employees API includes the ability to list employees for a Square
17+
account and retrieve a single employee by ID.
18+
19+
See the Connect v2 Technical Reference.
20+
21+
## Improvement: Simplified OAuth access token renewal
22+
23+
The RenewToken endpoint is now deprecated and replaced with new functionality in ObtainToken.
24+
ObtainToken now returns a refresh token along with an access token. Refresh
25+
tokens are used to renew expired OAuth access tokens.
26+
327
## Version 2.20190213.0 (2019-02-13)
428

529
## New feature: Order fulfillment BETA

‎README.md

+258-72
Large diffs are not rendered by default.

‎build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'idea'
22
apply plugin: 'eclipse'
33

44
group = 'com.squareup'
5-
version = '2.20190213.0'
5+
version = '2.20190313.0'
66

77
buildscript {
88
repositories {

‎docs/AdditionalRecipient.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# AdditionalRecipient
33

4+
### Description
5+
6+
Represents an additional recipient (other than the merchant) receiving a portion of this tender.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/AdditionalRecipientReceivable.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# AdditionalRecipientReceivable
33

4+
### Description
5+
6+
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).
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/AdditionalRecipientReceivableRefund.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# AdditionalRecipientReceivableRefund
33

4+
### Description
5+
6+
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.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/Address.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# Address
33

4+
### Description
5+
6+
Represents a physical address.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchChangeInventoryRequest.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchChangeInventoryRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchChangeInventoryResponse.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchChangeInventoryResponse
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchDeleteCatalogObjectsRequest.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchDeleteCatalogObjectsRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchDeleteCatalogObjectsResponse.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchDeleteCatalogObjectsResponse
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchRetrieveCatalogObjectsRequest.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchRetrieveCatalogObjectsRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchRetrieveCatalogObjectsResponse.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchRetrieveCatalogObjectsResponse
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchRetrieveInventoryChangesRequest.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchRetrieveInventoryChangesRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------
@@ -10,7 +14,7 @@ Name | Type | Description | Notes
1014
**states** | [**List<StatesEnum>**](#List<StatesEnum>) | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional]
1115
**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]
1216
**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]
13-
**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]
17+
**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]
1418

1519

1620
<a name="List<TypesEnum>"></a>

‎docs/BatchRetrieveInventoryChangesResponse.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11

22
# BatchRetrieveInventoryChangesResponse
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------
711
**errors** | [**List&lt;Error&gt;**](Error.md) | Any errors that occurred during the request. | [optional]
812
**changes** | [**List&lt;InventoryChange&gt;**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional]
9-
**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]
13+
**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]
1014

1115

1216

‎docs/BatchRetrieveInventoryCountsRequest.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11

22
# BatchRetrieveInventoryCountsRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------
711
**catalogObjectIds** | **List&lt;String&gt;** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
812
**locationIds** | **List&lt;String&gt;** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
913
**updatedAfter** | **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]
10-
**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]
14+
**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]
1115

1216

1317

‎docs/BatchRetrieveInventoryCountsResponse.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11

22
# BatchRetrieveInventoryCountsResponse
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------
711
**errors** | [**List&lt;Error&gt;**](Error.md) | Any errors that occurred during the request. | [optional]
812
**counts** | [**List&lt;InventoryCount&gt;**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional]
9-
**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]
13+
**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]
1014

1115

1216

‎docs/BatchRetrieveOrdersRequest.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchRetrieveOrdersRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchRetrieveOrdersResponse.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchRetrieveOrdersResponse
33

4+
### Description
5+
6+
Defines the fields that are included in the response body of a request to the [BatchRetrieveOrders](#endpoint-batchretrieveorders) endpoint.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BatchUpsertCatalogObjectsRequest.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11

22
# BatchUpsertCatalogObjectsRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------
7-
**idempotencyKey** | **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. |
11+
**idempotencyKey** | **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. |
812
**batches** | [**List&lt;CatalogObjectBatch&gt;**](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]
913

1014

‎docs/BatchUpsertCatalogObjectsResponse.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# BatchUpsertCatalogObjectsResponse
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/BreakType.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
# BreakType
3+
4+
### Description
5+
6+
A defined break template that sets an expectation for possible `Break` instances on a `Shift`.
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**id** | **String** | UUID for this object. | [optional]
12+
**locationId** | **String** | The ID of the business location this type of break applies to. |
13+
**breakName** | **String** | A human-readable name for this type of break. Will be displayed to employees in Square products. |
14+
**expectedDuration** | **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. |
15+
**isPaid** | **Boolean** | Whether this break counts towards time worked for compensation purposes. |
16+
**version** | **Integer** | 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]
17+
**createdAt** | **String** | A read-only timestamp in RFC 3339 format. | [optional]
18+
**updatedAt** | **String** | A read-only timestamp in RFC 3339 format. | [optional]
19+
20+
21+

‎docs/CaptureTransactionRequest.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# CaptureTransactionRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/CaptureTransactionResponse.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# CaptureTransactionResponse
33

4+
### Description
5+
6+
Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/Card.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# Card
33

4+
### Description
5+
6+
Represents the payment details of a card to be used for payments. These details are determined by the `card_nonce` generated by `SqPaymentForm`.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------
@@ -11,7 +15,7 @@ Name | Type | Description | Notes
1115
**expYear** | **Long** | The four-digit year of the card&#39;s expiration date. | [optional]
1216
**cardholderName** | **String** | The name of the cardholder. | [optional]
1317
**billingAddress** | [**Address**](Address.md) | The billing address for this card. | [optional]
14-
**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]
18+
**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]
1519

1620

1721
<a name="CardBrandEnum"></a>

‎docs/CatalogApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
302302
oauth2.setAccessToken("YOUR ACCESS TOKEN");
303303

304304
CatalogApi apiInstance = new CatalogApi();
305-
String 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.
305+
String 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.
306306
String 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\"`.
307307
try {
308308
ListCatalogResponse result = apiInstance.listCatalog(cursor, types);
@@ -317,7 +317,7 @@ try {
317317

318318
Name | Type | Description | Notes
319319
------------- | ------------- | ------------- | -------------
320-
**cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional]
320+
**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]
321321
**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]
322322

323323
### Return type

‎docs/CatalogCategory.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# CatalogCategory
33

4+
### Description
5+
6+
A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/CatalogDiscount.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# CatalogDiscount
33

4+
### Description
5+
6+
A discount in the Catalog object model.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/CatalogIdMapping.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# CatalogIdMapping
33

4+
### Description
5+
6+
A mapping between a client-supplied temporary ID and a permanent server ID.
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

‎docs/CatalogInfoRequest.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

22
# CatalogInfoRequest
33

4+
### Description
5+
6+
7+
48
## Properties
59
Name | Type | Description | Notes
610
------------ | ------------- | ------------- | -------------

0 commit comments

Comments
 (0)