Skip to content

Commit acac5dd

Browse files
authored
Merge pull request #59 from square/release/13.0.0.20210721
Generated PR for Release: 13.0.0.20210721
2 parents 1a4b7f6 + 540dd19 commit acac5dd

File tree

328 files changed

+1003
-1441
lines changed

Some content is hidden

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

328 files changed

+1003
-1441
lines changed

CHANGELOG.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,25 @@
11
# Change Log
22

3-
## Version 14.0.0.20210818 (2021-08-18)
4-
## API updates
5-
6-
* **Customers API:**
7-
* [Customer](https://developer.squareup.com/reference/square_2021-08-18/objects/Customer) object. The `version` field has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. This field represents the current version of the customer profile and enables optimistic concurrency control. For more information, see [Customer profile versions and optimistic concurrency support.](https://developer.squareup.com/docs/customers-api/what-it-does#customer-profile-versions-and-optimistic-concurrency-support)
8-
* [ListCustomers](https://developer.squareup.com/reference/square_2021-08-18/customers-api/list-customers) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response.
3+
## Version 15.0.0.20210915 (2021-09-15)
4+
## API updates
95

10-
* **Customer Groups API:**
11-
* [ListCustomerGroups](https://developer.squareup.com/reference/square_2021-08-18/customer-groups-api/list-customer-groups) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response.
6+
* **Invoices API:**
7+
* [Invoice](https://developer.squareup.com/reference/square_2021-09-15/objects/Invoice) object. Added a new, optional `sale_or_service_date` field used to specify the date of the sale or the date that the service is rendered. If specified, this date is displayed on the invoice.
128

13-
* **Customer Segments API:**
14-
* [ListCustomerSegments](https://developer.squareup.com/reference/square_2021-08-18/customer-segments-api/list-customer-segments) endpoint. The new, optional `limit` query parameter can be used to specify the maximum number of results in a paginated response.
9+
* **Orders API:**
10+
* [CreateOrder](https://developer.squareup.com/reference/square_2021-09-15/orders-api/create-order). The endpoint now supports creating temporary, draft orders. For more information, see [Create a draft order.](https://developer.squareup.com/docs/orders-api/create-orders#create-a-draft-order)
11+
* [CloneOrder](https://developer.squareup.com/reference/square_2021-09-15/orders-api/clone-order). The Orders API supports this new endpoint to clone an existing order. For more information, see [Clone an order.](https://developer.squareup.com/docs/orders-api/create-orders#clone-an-order)
12+
* These fields have moved to the [general availability (GA)](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) state: [OrderLineItem.item_type](https://developer.squareup.com/reference/square_2021-09-15/objects/OrderLineItem#definition__property-item_type), [OrderServiceCharge.type](https://developer.squareup.com/reference/square_2021-09-15/objects/OrderServiceCharge#definition__property-type), and `catalog_version` field on every order type that contains this field.
1513

16-
* **Invoices API:**
17-
* Square Invoices Plus is a monthly subscription plan that allows access to premium invoice features. After Invoices Plus is launched in September 2021, a subscription will be required to create invoices with custom fields and installment payments. For more information, including how to handle new errors, see [Premium features available with Invoices Plus.](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription)
14+
* **Team API:**
15+
* [SearchTeamMembersFilter](https://developer.squareup.com/reference/square_2021-09-15/objects/SearchTeamMembersFilter) object now has an `is_owner` field that when set, causes a team member search to return only the seller who owns a Square account.
1816

19-
* **Loyalty API:**
20-
* [LoyaltyAccount](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccount) object. Added a new `expiring_point_deadlines` field that specifies when points in the account balance are scheduled to expire. This field contains a list of [LoyaltyAccountExpiringPointDeadline](https://developer.squareup.com/reference/square_2021-08-18/objects/LoyaltyAccountExpiringPointDeadline) objects. For more information, see [Expiring points.](https://developer.squareup.com/docs/loyalty-api/overview#expiring-points)
17+
* **Terminal API:**
18+
* [TerminalCheckout](https://developer.squareup.com/reference/square_2021-09-15/objects/TerminalCheckout) object. The `customer_id` field is now GA.
2119

2220
## Documentation updates
23-
24-
* [App Marketplace.](https://developer.squareup.com/docs/app-marketplace) Added the following topics:
25-
* [How to apply.](https://developer.squareup.com/docs/app-marketplace#how-to-apply) Documented the process to list an application on the Square App Marketplace.
26-
* [App Marketplace API Usage Requirements.](https://developer.squareup.com/docs/app-marketplace/requirements) Added a topic that describes a set of API usage requirements and recommendations for partner applications.
27-
28-
* [Automatic communications from Square about invoices.](https://developer.squareup.com/docs/invoices-api/overview#automatic-communication-from-square-to-customers) Documented the invoice-related communications sent from Square to customers and sellers.
29-
30-
* [Snippets best practices.](https://developer.squareup.com/docs/snippets-api/overview#best-practices) Documented best practices and additional requirements for snippets and applications that integrate with the Snippets API.
21+
* **OAuth API:**
22+
* Revised API descriptions for the ObtainToken and Authorize endpoints. Clarified that the Authorize endpoint is not a callable API but is used to direct the seller to the Square authorization page. For more information about the Authorize endpoint, see [Create the Redirect URL and Square Authorization Page URL.](https://developer.squareup.com/docs/oauth-api/create-urls-for-square-authorization)
3123

3224

3325
## Version 12.0.0.20210616 (2021-06-16)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Install the client dynamically by adding a dependency to the POM for your projec
3333
<dependency>
3434
<groupId>com.squareup</groupId>
3535
<artifactId>square</artifactId>
36-
<version>14.0.0.20210818</version>
36+
<version>13.0.0.20210721</version>
3737
</dependency>
3838
```
3939

@@ -42,7 +42,7 @@ Install the client dynamically by adding a dependency to the POM for your projec
4242
Install the client by adding the following dependency to the build file for your project:
4343

4444
```
45-
implementation "com.squareup:square:14.0.0.20210818"
45+
implementation "com.squareup:square:13.0.0.20210721"
4646
```
4747

4848
## API documentation

doc/api/customer-groups.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,14 @@ Retrieves the list of customer groups of a business.
2323

2424
```java
2525
CompletableFuture<ListCustomerGroupsResponse> listCustomerGroupsAsync(
26-
final String cursor,
27-
final Integer limit)
26+
final String cursor)
2827
```
2928

3029
## Parameters
3130

3231
| Parameter | Type | Tags | Description |
3332
| --- | --- | --- | --- |
3433
| `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for your original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
35-
| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 50. The default value is 50.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
3634

3735
## Response Type
3836

@@ -42,9 +40,8 @@ CompletableFuture<ListCustomerGroupsResponse> listCustomerGroupsAsync(
4240

4341
```java
4442
String cursor = "cursor6";
45-
Integer limit = 172;
4643

47-
customerGroupsApi.listCustomerGroupsAsync(cursor, limit).thenAccept(result -> {
44+
customerGroupsApi.listCustomerGroupsAsync(cursor).thenAccept(result -> {
4845
// TODO success callback handler
4946
}).exceptionally(exception -> {
5047
// TODO failure callback handler

doc/api/customer-segments.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,14 @@ Retrieves the list of customer segments of a business.
2020

2121
```java
2222
CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(
23-
final String cursor,
24-
final Integer limit)
23+
final String cursor)
2524
```
2625

2726
## Parameters
2827

2928
| Parameter | Type | Tags | Description |
3029
| --- | --- | --- | --- |
3130
| `cursor` | `String` | Query, Optional | A pagination cursor returned by previous calls to `ListCustomerSegments`.<br>This cursor is used to retrieve the next set of query results.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
32-
| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 50. The default value is 50.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
3331

3432
## Response Type
3533

@@ -39,9 +37,8 @@ CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(
3937

4038
```java
4139
String cursor = "cursor6";
42-
Integer limit = 172;
4340

44-
customerSegmentsApi.listCustomerSegmentsAsync(cursor, limit).thenAccept(result -> {
41+
customerSegmentsApi.listCustomerSegmentsAsync(cursor).thenAccept(result -> {
4542
// TODO success callback handler
4643
}).exceptionally(exception -> {
4744
// TODO failure callback handler

doc/api/customers.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ profiles can take closer to one minute or longer, especially during network inci
3333
```java
3434
CompletableFuture<ListCustomersResponse> listCustomersAsync(
3535
final String cursor,
36-
final Integer limit,
3736
final String sortField,
3837
final String sortOrder)
3938
```
@@ -43,9 +42,8 @@ CompletableFuture<ListCustomersResponse> listCustomersAsync(
4342
| Parameter | Type | Tags | Description |
4443
| --- | --- | --- | --- |
4544
| `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for your original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
46-
| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 100. The default value is 100.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
47-
| `sortField` | [`String`](/doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>The default value is `DEFAULT`. |
48-
| `sortOrder` | [`String`](/doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>The default value is `ASC`. |
45+
| `sortField` | [`String`](/doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>Default: `DEFAULT`. |
46+
| `sortOrder` | [`String`](/doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>Default: `ASC`. |
4947

5048
## Response Type
5149

@@ -55,11 +53,10 @@ CompletableFuture<ListCustomersResponse> listCustomersAsync(
5553

5654
```java
5755
String cursor = "cursor6";
58-
Integer limit = 172;
5956
String sortField = "DEFAULT";
6057
String sortOrder = "DESC";
6158

62-
customersApi.listCustomersAsync(cursor, limit, sortField, sortOrder).thenAccept(result -> {
59+
customersApi.listCustomersAsync(cursor, sortField, sortOrder).thenAccept(result -> {
6360
// TODO success callback handler
6461
}).exceptionally(exception -> {
6562
// TODO failure callback handler

doc/api/gift-cards.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ giftCardsApi.listGiftCardsAsync(type, state, limit, cursor, customerId).thenAcce
6767

6868
# Create Gift Card
6969

70-
Creates a digital gift card or registers a physical (plastic) gift card. You must activate the gift card before
71-
it can be used for payment. For more information, see
70+
Creates a digital gift card. You must activate the gift card before
71+
it can be used. For more information, see
7272
[Selling gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#selling-square-gift-cards).
7373

7474
```java

0 commit comments

Comments
 (0)