You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 23, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: CHANGES.md
+19
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,24 @@
1
1
# Change Log
2
2
3
+
## Version 2.20180918.0 (2018-09-18)
4
+
5
+
We have added Connect v2 Inventory API and birthdays in `Customer` entities.
6
+
7
+
### New API: Inventory API (Connect V2)
8
+
9
+
The Connect v2 Inventory API replaces the Connect v1 Inventory API
10
+
and introduces new functionality:
11
+
12
+
* Moving item variations quantities through predefined states
13
+
(e.g., from `IN_STOCK` to `WASTE`).
14
+
* Viewing the inventory adjustment history for an item variation.
15
+
* Batch inventory adjustments and information retrieval.
16
+
17
+
### New feature: Customer Birthdays (Connect V2)
18
+
19
+
* Customer profiles now include a `birthday` field.
20
+
Dates are recorded in RFC-3339 format and can be
21
+
set through the `CreateCustomer` and `UpdateCustomer` endpoints.
3
22
## Version 2.20180712.2 (2018-08-21)
4
23
5
24
The Connect SDK now includes functionality for the OAuth API. The Square OAuth API lets applications request and obtain permission from a Square account to make API calls on behalf of that account. Applications can request individual permissions so that users do not need to grant full access to their Square accounts.
**idempotencyKey** | **String** | A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](/basics/api101/idempotency) in the [API Development 101](/basics/api101/overview) section for more information. | [optional]
8
+
**changes** | [**List<InventoryChange>**](InventoryChange.md) | The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. Max size is 100 changes. | [optional]
9
+
**ignoreUnchangedCounts** | **Boolean** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional]
**catalogObjectIds** | **List<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
8
+
**locationIds** | **List<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
9
+
**types** | [**List<TypesEnum>**](#List<TypesEnum>) | Filters results by [InventoryChangeType](#type-inventorychangetype). Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. | [optional]
10
+
**states** | [**List<StatesEnum>**](#List<StatesEnum>) | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [optional]
11
+
**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]
12
+
**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]
**errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
8
+
**changes** | [**List<InventoryChange>**](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]
**catalogObjectIds** | **List<String>** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional]
8
+
**locationIds** | **List<String>** | Filters results by [Location](#type-location) ID. Only applied when set. Default: unset. | [optional]
9
+
**updatedAfter** | **String** | 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]
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]
**errors** | [**List<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
8
+
**counts** | [**List<InventoryCount>**](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]
Copy file name to clipboardExpand all lines: docs/Card.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
**expYear** | **Long** | The four-digit year of the card's expiration date. | [optional]
12
12
**cardholderName** | **String** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional]
13
13
**billingAddress** | [**Address**](Address.md) | The card's billing address. This value is present only if this object represents a customer's card on file. | [optional]
14
-
**fingerprint** | **String** | The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional]
14
+
**fingerprint** | **String** | The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional]
Copy file name to clipboardExpand all lines: docs/CreateCustomerRequest.md
+1
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
**phoneNumber** | **String** | The customer's phone number. | [optional]
14
14
**referenceId** | **String** | An optional second ID you can set to associate the customer with an entity in another system. | [optional]
15
15
**note** | **String** | An optional note to associate with the customer. | [optional]
16
+
**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]
Copy file name to clipboardExpand all lines: docs/Customer.md
+1
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
15
15
**emailAddress** | **String** | The customer's email address. | [optional]
16
16
**address** | [**Address**](Address.md) | The customer's physical address. | [optional]
17
17
**phoneNumber** | **String** | The customer's phone number. | [optional]
18
+
**birthday** | **String** | The customer's 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]
18
19
**referenceId** | **String** | A second ID you can set to associate the customer with an entity in another system. | [optional]
19
20
**note** | **String** | A note to associate with the customer. | [optional]
20
21
**preferences** | [**CustomerPreferences**](CustomerPreferences.md) | The customer's preferences. | [optional]
Copy file name to clipboardExpand all lines: docs/CustomersApi.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -128,7 +128,7 @@ Name | Type | Description | Notes
128
128
129
129
DeleteCustomer
130
130
131
-
Deletes a customer from a business, along with any linked cards on file.
131
+
Deletes a customer from a business, along with any linked cards on file. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to delete merged profiles.
132
132
133
133
### Example
134
134
```java
@@ -399,7 +399,7 @@ Name | Type | Description | Notes
399
399
400
400
UpdateCustomer
401
401
402
-
Updates the details of an existing customer. The ID of the customer may change if the customer has been merged into another customer. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
402
+
Updates the details of an existing customer. When two profiles are merged into a single profile, that profile is assigned a new `customer_id`. You must use the new `customer_id` to update merged profiles. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
0 commit comments