Skip to content

Commit 838c915

Browse files
ssung88ssung88
authored
Release 2.20190313.0 (square#87)
1 parent 7b2d1a9 commit 838c915

File tree

683 files changed

+35721
-455
lines changed

Some content is hidden

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

683 files changed

+35721
-455
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

+186
Large diffs are not rendered by default.

‎docs/BatchRetrieveInventoryChangesRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
1414
**states** | **list[str]** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional]
1515
**updated_after** | **str** | 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]
1616
**updated_before** | **str** | 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]
17-
**cursor** | **str** | 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** | **str** | 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]
1818

1919
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2020

‎docs/BatchRetrieveInventoryChangesResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
1111
**errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional]
1212
**changes** | [**list[InventoryChange]**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional]
13-
**cursor** | **str** | 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** | **str** | 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]
1414

1515
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1616

‎docs/BatchRetrieveInventoryCountsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**catalog_object_ids** | **list[str]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
1212
**location_ids** | **list[str]** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
1313
**updated_after** | **str** | 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]
14-
**cursor** | **str** | 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** | **str** | 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]
1515

1616
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1717

‎docs/BatchRetrieveInventoryCountsResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
1111
**errors** | [**list[Error]**](Error.md) | Any errors that occurred during the request. | [optional]
1212
**counts** | [**list[InventoryCount]**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional]
13-
**cursor** | **str** | 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** | **str** | 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]
1414

1515
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1616

‎docs/BatchUpsertCatalogObjectsRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
## Properties
99
Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
11-
**idempotency_key** | **str** | 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'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+
**idempotency_key** | **str** | 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'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. |
1212
**batches** | [**list[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 `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. 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 `#ABC` and a [CatalogItemVariation](#type-catalogitemvariation) with its `item_id` attribute set to `#ABC` in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem). Any `#`-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]
1313

1414
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/BreakType.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# BreakType
2+
> squareconnect.models.break_type
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** | **str** | UUID for this object. | [optional]
12+
**location_id** | **str** | The ID of the business location this type of break applies to. |
13+
**break_name** | **str** | A human-readable name for this type of break. Will be displayed to employees in Square products. |
14+
**expected_duration** | **str** | 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+
**is_paid** | **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's servers execute a \"blind\" write; potentially overwriting another writer's data. | [optional]
17+
**created_at** | **str** | A read-only timestamp in RFC 3339 format. | [optional]
18+
**updated_at** | **str** | A read-only timestamp in RFC 3339 format. | [optional]
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21+
22+

‎docs/Card.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
1515
**exp_year** | **int** | The four-digit year of the card's expiration date. | [optional]
1616
**cardholder_name** | **str** | The name of the cardholder. | [optional]
1717
**billing_address** | [**Address**](Address.md) | The billing address for this card. | [optional]
18-
**fingerprint** | **str** | __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** | **str** | __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]
1919

2020
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2121

‎docs/CatalogItem.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
1111
**name** | **str** | The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. | [optional]
1212
**description** | **str** | The item's description. Searchable. This field has max length of 4096 Unicode code points. | [optional]
13-
**abbreviation** | **str** | The text of the item'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]
13+
**abbreviation** | **str** | The text of the item'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]
1414
**label_color** | **str** | The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional]
1515
**available_online** | **bool** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional]
1616
**available_for_pickup** | **bool** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional]

‎docs/CatalogItemVariation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
1919
**track_inventory** | **bool** | If `true`, inventory tracking is active for the variation. | [optional]
2020
**inventory_alert_type** | **str** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional]
2121
**inventory_alert_threshold** | **int** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional]
22-
**user_data** | **str** | Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. | [optional]
22+
**user_data** | **str** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional]
2323
**service_duration** | **int** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional]
2424

2525
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/CatalogObject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**type** | **str** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for all possible values. |
1212
**id** | **str** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. |
1313
**updated_at** | **str** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional]
14-
**version** | **int** | The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. | [optional]
14+
**version** | **int** | The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. | [optional]
1515
**is_deleted** | **bool** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional]
1616
**catalog_v1_ids** | [**list[CatalogV1Id]**](CatalogV1Id.md) | The Connect V1 IDs for this object at each [location](#type-location) where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional]
1717
**present_at_all_locations** | **bool** | If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. | [optional]

‎docs/CatalogQuery.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
### Description
55

6-
A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.
6+
A query to be applied to a SearchCatalogObjects request. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`.
77

88
## Properties
99
Name | Type | Description | Notes

‎docs/ChargeRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Defines the parameters that can be included in the body of a request to the [Cha
88
## Properties
99
Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
11-
**idempotency_key** | **str** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. |
11+
**idempotency_key** | **str** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](/basics/api101/idempotency) for more information. |
1212
**amount_money** | [**Money**](Money.md) | The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. The value of `currency` must match the currency associated with the business that is charging the card. |
1313
**card_nonce** | **str** | A nonce generated from the `SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`. | [optional]
1414
**customer_card_id** | **str** | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you _must_ also provide a value for `customer_id`. | [optional]

‎docs/CreateBreakTypeRequest.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# CreateBreakTypeRequest
2+
> squareconnect.models.create_break_type_request
3+
4+
### Description
5+
6+
A request to create a new `BreakType`
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**idempotency_key** | **str** | Unique string value to insure idempotency of the operation | [optional]
12+
**break_type** | [**BreakType**](BreakType.md) | The `BreakType` to be created. |
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

0 commit comments

Comments
 (0)