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

Commit 3662b11

Browse files
ssung88ssung88
authored
Release 2.15.0 (#106)
1 parent 30f1817 commit 3662b11

File tree

843 files changed

+44969
-1474
lines changed

Some content is hidden

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

843 files changed

+44969
-1474
lines changed

‎.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ install:
1212

1313
script:
1414
- export frameworkVersion=netstandard2.0
15-
- export releaseVersion="2.14.0"
15+
- export releaseVersion="2.15.0"
1616
- /bin/sh ./mono_nunit_test.sh
1717

1818
after_success:

‎CHANGES.md

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

3+
## Version 2.15.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.14.0 (2019-02-13)
428

529
## New feature: Order fulfillment BETA

‎README.md

+142
Large diffs are not rendered by default.

‎docs/AdditionalRecipient.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.AdditionalRecipient
2+
3+
### Description
4+
5+
Represents an additional recipient (other than the merchant) receiving a portion of this tender.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/AdditionalRecipientReceivable.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.AdditionalRecipientReceivable
2+
3+
### Description
4+
5+
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).
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/AdditionalRecipientReceivableRefund.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.AdditionalRecipientReceivableRefund
2+
3+
### Description
4+
5+
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.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/Address.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.Address
2+
3+
### Description
4+
5+
Represents a physical address.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchChangeInventoryRequest.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchChangeInventoryRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchChangeInventoryResponse.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchChangeInventoryResponse
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchDeleteCatalogObjectsRequest.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchDeleteCatalogObjectsRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchDeleteCatalogObjectsResponse.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchDeleteCatalogObjectsResponse
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchRetrieveCatalogObjectsRequest.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchRetrieveCatalogObjectsRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchRetrieveCatalogObjectsResponse.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchRetrieveCatalogObjectsResponse
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchRetrieveInventoryChangesRequest.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchRetrieveInventoryChangesRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes
@@ -9,7 +14,7 @@ Name | Type | Description | Notes
914
**States** | **List<StatesEnum>** | Filters &#x60;ADJUSTMENT&#x60; query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional]
1015
**UpdatedAfter** | **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]
1116
**UpdatedBefore** | **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]
12-
**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]
1318

1419

1520
## List<TypesEnum>

‎docs/BatchRetrieveInventoryChangesResponse.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# Square.Connect.Model.BatchRetrieveInventoryChangesResponse
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes
510
------------ | ------------- | ------------- | -------------
611
**Errors** | [**List&lt;Error&gt;**](Error.md) | Any errors that occurred during the request. | [optional]
712
**Changes** | [**List&lt;InventoryChange&gt;**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional]
8-
**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]
914

1015

1116

‎docs/BatchRetrieveInventoryCountsRequest.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# Square.Connect.Model.BatchRetrieveInventoryCountsRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes
510
------------ | ------------- | ------------- | -------------
611
**CatalogObjectIds** | **List<string>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
712
**LocationIds** | **List<string>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
813
**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]
9-
**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]
1015

1116

1217

‎docs/BatchRetrieveInventoryCountsResponse.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# Square.Connect.Model.BatchRetrieveInventoryCountsResponse
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes
510
------------ | ------------- | ------------- | -------------
611
**Errors** | [**List&lt;Error&gt;**](Error.md) | Any errors that occurred during the request. | [optional]
712
**Counts** | [**List&lt;InventoryCount&gt;**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional]
8-
**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]
914

1015

1116

‎docs/BatchRetrieveOrdersRequest.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchRetrieveOrdersRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchRetrieveOrdersResponse.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchRetrieveOrdersResponse
2+
3+
### Description
4+
5+
Defines the fields that are included in the response body of a request to the [BatchRetrieveOrders](#endpoint-batchretrieveorders) endpoint.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BatchUpsertCatalogObjectsRequest.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
# Square.Connect.Model.BatchUpsertCatalogObjectsRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes
510
------------ | ------------- | ------------- | -------------
6-
**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. |
712
**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]
813

914

‎docs/BatchUpsertCatalogObjectsResponse.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.BatchUpsertCatalogObjectsResponse
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/BreakType.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Square.Connect.Model.BreakType
2+
3+
### Description
4+
5+
A defined break template that sets an expectation for possible `Break` instances on a `Shift`.
6+
7+
## Properties
8+
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** | **bool?** | Whether this break counts towards time worked for compensation purposes. |
16+
**Version** | **int?** | 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+
22+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
23+

‎docs/CaptureTransactionRequest.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CaptureTransactionRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/CaptureTransactionResponse.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CaptureTransactionResponse
2+
3+
### Description
4+
5+
Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/Card.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.Card
2+
3+
### Description
4+
5+
Represents the payment details of a card to be used for payments. These details are determined by the `card_nonce` generated by `SqPaymentForm`.
6+
27
## Properties
38

49
Name | Type | Description | Notes
@@ -10,7 +15,7 @@ Name | Type | Description | Notes
1015
**ExpYear** | **long?** | The four-digit year of the card&#39;s expiration date. | [optional]
1116
**CardholderName** | **string** | The name of the cardholder. | [optional]
1217
**BillingAddress** | [**Address**](Address.md) | The billing address for this card. | [optional]
13-
**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]
1419

1520

1621
## CardBrandEnum

‎docs/CardBrand.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CardBrand
2+
3+
### Description
4+
5+
Indicates a card's brand, such as `VISA` or `MASTERCARD`.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/CatalogApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ namespace Example
365365
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
366366

367367
var apiInstance = new CatalogApi();
368-
var 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. (optional)
368+
var 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. (optional)
369369
var 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\"`. (optional)
370370
371371
try
@@ -387,7 +387,7 @@ namespace Example
387387

388388
Name | Type | Description | Notes
389389
------------- | ------------- | ------------- | -------------
390-
**cursor** | **string**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional]
390+
**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]
391391
**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]
392392

393393
### Return type

‎docs/CatalogCategory.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CatalogCategory
2+
3+
### Description
4+
5+
A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/CatalogDiscount.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CatalogDiscount
2+
3+
### Description
4+
5+
A discount in the Catalog object model.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/CatalogDiscountType.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CatalogDiscountType
2+
3+
### Description
4+
5+
How to apply a [CatalogDiscount](#type-catalogdiscount) to a [CatalogItem](#type-catalogitem).
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/CatalogIdMapping.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CatalogIdMapping
2+
3+
### Description
4+
5+
A mapping between a client-supplied temporary ID and a permanent server ID.
6+
27
## Properties
38

49
Name | Type | Description | Notes

‎docs/CatalogInfoRequest.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# Square.Connect.Model.CatalogInfoRequest
2+
3+
### Description
4+
5+
6+
27
## Properties
38

49
Name | Type | Description | Notes

0 commit comments

Comments
 (0)