Skip to content

Commit d47ed05

Browse files
ssung88ssung88
authored
Merge pull request #5 from square/release/5.0.0.20200226
Release 5.0.0.20200226
2 parents 5e13150 + 3870bcb commit d47ed05

File tree

138 files changed

+7605
-1939
lines changed

Some content is hidden

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

138 files changed

+7605
-1939
lines changed

‎CHANGELOG.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11
# Change Log
22

3+
## Version 5.0.0.20200226 (2020-02-26)
4+
## API releases
5+
* **GA release**: All SDKs have been updated to support the new Bank Accounts and CashDrawerShifts APIs.
6+
7+
* **Beta release**: All SDKs have been updated to support the new Disputes API.
8+
9+
10+
## Existing API updates
11+
12+
All SDKs have been updated to support the following changes:
13+
14+
* **Catalog API**
15+
* Batch upsert catalog objects endpoint — The `batches` field is now required and the array must have at least one element.
16+
* CatalogModifier — Two fields added:
17+
* `ordinal` to support custom ordering in a modifier list
18+
* `modifier_list_id` to reference the parent modifier list
19+
* CatalogModifierList — New field added: `ordinal` to support custom ordering in a list of **CatalogModifierList** objects.
20+
21+
* **Customers API changes**
22+
* SearchCustomers endpoint — `limit` size reduced from 1000 to 100 to improve the endpoint performance.
23+
24+
* **Orders API changes**
25+
* CreateOrderRequest — Previously these request fields were deprecated: `line_items`, `taxes`, `discounts`. These fields are no longer available. Instead you now use the `Order` object in the request. For example, `Order.line_items`, `Order.taxes`, and `Order.discounts`.
26+
* OrderLineItem type — There are two changes:
27+
* The `taxes` field that was previously deprecated is no longer available. Instead, you now use the `OrderLineItem.applied_taxes` field. This also now requires that you set the `OrderLineItemTax.scope` field.
28+
* The `discounts` field that was previously deprecated is no longer available. Instead, you now use the `OrderLineItem.applied_discounts` field. This also now requires that you set the `OrderLineItemDiscount.scope` field.
29+
30+
* **Shared object updates**
31+
* **Card object** — New fields added: `card_type`, `prepaid_type`. Currently, only the Payments API responses populate these fields.
32+
333
## Version 4.1.0.20200122 (2020-01-22)
434
* New field: The **Employee** object now has an `is_owner` field.
535
* New enumeration: The **CardBrand** enumeration has a new `SQUARE_CAPITAL_CARD` enum value to support a Square one-time Installments payment.

‎doc/bank-accounts.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Bank Accounts
2+
3+
```java
4+
BankAccountsApi bankAccountsApi = client.getBankAccountsApi();
5+
```
6+
7+
## Class Name
8+
9+
`BankAccountsApi`
10+
11+
## Methods
12+
13+
* [List Bank Accounts](/doc/bank-accounts.md#list-bank-accounts)
14+
* [Get Bank Account by V1 Id](/doc/bank-accounts.md#get-bank-account-by-v1-id)
15+
* [Get Bank Account](/doc/bank-accounts.md#get-bank-account)
16+
17+
## List Bank Accounts
18+
19+
Returns a list of [BankAccount](#type-bankaccount) objects linked to a Square account.
20+
For more information, see
21+
[Bank Accounts API](https://developer.squareup.com/docs/docs/bank-accounts-api).
22+
23+
```java
24+
CompletableFuture<ListBankAccountsResponse> listBankAccountsAsync(
25+
final String cursor,
26+
final Integer limit,
27+
final String locationId)
28+
```
29+
30+
### Parameters
31+
32+
| Parameter | Type | Tags | Description |
33+
| --- | --- | --- | --- |
34+
| `cursor` | `String` | Query, Optional | The pagination cursor returned by a previous call to this endpoint.<br>Use it in the next `ListBankAccounts` request to retrieve the next set <br>of results.<br><br>See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. |
35+
| `limit` | `Integer` | Query, Optional | Upper limit on the number of bank accounts to return in the response. <br>Currently, 1000 is the largest supported limit. You can specify a limit <br>of up to 1000 bank accounts. This is also the default limit. |
36+
| `locationId` | `String` | Query, Optional | Location ID. You can specify this optional filter <br>to retrieve only the linked bank accounts belonging to a specific location. |
37+
38+
### Response Type
39+
40+
[`ListBankAccountsResponse`](/doc/models/list-bank-accounts-response.md)
41+
42+
### Example Usage
43+
44+
```java
45+
bankAccountsApi.listBankAccountsAsync(null, null, null).thenAccept(result -> {
46+
// TODO success callback handler
47+
}).exceptionally(exception -> {
48+
// TODO failure callback handler
49+
return null;
50+
});
51+
```
52+
53+
## Get Bank Account by V1 Id
54+
55+
Returns details of a [BankAccount](#type-bankaccount) identified by V1 bank account ID.
56+
For more information, see
57+
[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-the-v1-bank-accounts-api).
58+
59+
```java
60+
CompletableFuture<GetBankAccountByV1IdResponse> getBankAccountByV1IdAsync(
61+
final String v1BankAccountId)
62+
```
63+
64+
### Parameters
65+
66+
| Parameter | Type | Tags | Description |
67+
| --- | --- | --- | --- |
68+
| `v1BankAccountId` | `String` | Template, Required | Connect V1 ID of the desired `BankAccount`. For more information, see <br>[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
69+
70+
### Response Type
71+
72+
[`GetBankAccountByV1IdResponse`](/doc/models/get-bank-account-by-v1-id-response.md)
73+
74+
### Example Usage
75+
76+
```java
77+
String v1BankAccountId = "v1_bank_account_id8";
78+
79+
bankAccountsApi.getBankAccountByV1IdAsync(v1BankAccountId).thenAccept(result -> {
80+
// TODO success callback handler
81+
}).exceptionally(exception -> {
82+
// TODO failure callback handler
83+
return null;
84+
});
85+
```
86+
87+
## Get Bank Account
88+
89+
Returns details of a [BankAccount](#type-bankaccount)
90+
linked to a Square account. For more information, see
91+
[Bank Accounts API](https://developer.squareup.com/docs/docs/bank-accounts-api).
92+
93+
```java
94+
CompletableFuture<GetBankAccountResponse> getBankAccountAsync(
95+
final String bankAccountId)
96+
```
97+
98+
### Parameters
99+
100+
| Parameter | Type | Tags | Description |
101+
| --- | --- | --- | --- |
102+
| `bankAccountId` | `String` | Template, Required | Square-issued ID of the desired `BankAccount`. |
103+
104+
### Response Type
105+
106+
[`GetBankAccountResponse`](/doc/models/get-bank-account-response.md)
107+
108+
### Example Usage
109+
110+
```java
111+
String bankAccountId = "bank_account_id0";
112+
113+
bankAccountsApi.getBankAccountAsync(bankAccountId).thenAccept(result -> {
114+
// TODO success callback handler
115+
}).exceptionally(exception -> {
116+
// TODO failure callback handler
117+
return null;
118+
});
119+
```
120+

‎doc/catalog.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -250,14 +250,14 @@ CatalogObject bodyBatches0Objects3 = new CatalogObject.Builder(
250250
.build();
251251
bodyBatches0Objects.add(bodyBatches0Objects3);
252252

253-
CatalogObjectBatch bodyBatches0 = new CatalogObjectBatch.Builder()
254-
.objects(bodyBatches0Objects)
253+
CatalogObjectBatch bodyBatches0 = new CatalogObjectBatch.Builder(
254+
bodyBatches0Objects)
255255
.build();
256256
bodyBatches.add(bodyBatches0);
257257

258258
BatchUpsertCatalogObjectsRequest body = new BatchUpsertCatalogObjectsRequest.Builder(
259-
"789ff020-f723-43a9-b4b5-43b5dc1fa3dc")
260-
.batches(bodyBatches)
259+
"789ff020-f723-43a9-b4b5-43b5dc1fa3dc",
260+
bodyBatches)
261261
.build();
262262

263263
catalogApi.batchUpsertCatalogObjectsAsync(body).thenAccept(result -> {
@@ -312,15 +312,15 @@ Additional information and an example cURL request can be found in the [Create a
312312
```java
313313
CompletableFuture<CreateCatalogImageResponse> createCatalogImageAsync(
314314
final CreateCatalogImageRequest request,
315-
final File imageFile)
315+
final FileWrapper imageFile)
316316
```
317317

318318
### Parameters
319319

320320
| Parameter | Type | Tags | Description |
321321
| --- | --- | --- | --- |
322322
| `request` | [`CreateCatalogImageRequest`](/doc/models/create-catalog-image-request.md) | Form, Optional | - |
323-
| `imageFile` | `File` | Form, Optional | - |
323+
| `imageFile` | `FileWrapper` | Form, Optional | - |
324324

325325
### Response Type
326326

‎doc/checkout.md‎

Lines changed: 52 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -35,113 +35,92 @@ CompletableFuture<CreateCheckoutResponse> createCheckoutAsync(
3535

3636
```java
3737
String locationId = "location_id4";
38-
List<CreateOrderRequestLineItem> bodyOrderLineItems = new LinkedList<>();
38+
List<OrderLineItem> bodyOrderOrderLineItems = new LinkedList<>();
3939

40-
Money bodyOrderLineItems0BasePriceMoney = new Money.Builder()
41-
.amount(1500L)
42-
.currency("USD")
40+
List<OrderLineItemAppliedTax> bodyOrderOrderLineItems0AppliedTaxes = new LinkedList<>();
41+
42+
OrderLineItemAppliedTax bodyOrderOrderLineItems0AppliedTaxes0 = new OrderLineItemAppliedTax.Builder(
43+
"38ze1696-z1e3-5628-af6d-f1e04d947fg3")
4344
.build();
44-
List<CreateOrderRequestDiscount> bodyOrderLineItems0Discounts = new LinkedList<>();
45+
bodyOrderOrderLineItems0AppliedTaxes.add(bodyOrderOrderLineItems0AppliedTaxes0);
4546

46-
CreateOrderRequestDiscount bodyOrderLineItems0Discounts0 = new CreateOrderRequestDiscount.Builder()
47-
.name("7% off previous season item")
48-
.percentage("7")
47+
List<OrderLineItemAppliedDiscount> bodyOrderOrderLineItems0AppliedDiscounts = new LinkedList<>();
48+
49+
OrderLineItemAppliedDiscount bodyOrderOrderLineItems0AppliedDiscounts0 = new OrderLineItemAppliedDiscount.Builder(
50+
"56ae1696-z1e3-9328-af6d-f1e04d947gd4")
4951
.build();
50-
bodyOrderLineItems0Discounts.add(bodyOrderLineItems0Discounts0);
52+
bodyOrderOrderLineItems0AppliedDiscounts.add(bodyOrderOrderLineItems0AppliedDiscounts0);
5153

52-
Money bodyOrderLineItems0Discounts1AmountMoney = new Money.Builder()
53-
.amount(300L)
54+
Money bodyOrderOrderLineItems0BasePriceMoney = new Money.Builder()
55+
.amount(1500L)
5456
.currency("USD")
5557
.build();
56-
CreateOrderRequestDiscount bodyOrderLineItems0Discounts1 = new CreateOrderRequestDiscount.Builder()
57-
.name("$3 off Customer Discount")
58-
.amountMoney(bodyOrderLineItems0Discounts1AmountMoney)
59-
.build();
60-
bodyOrderLineItems0Discounts.add(bodyOrderLineItems0Discounts1);
61-
62-
CreateOrderRequestLineItem bodyOrderLineItems0 = new CreateOrderRequestLineItem.Builder(
58+
OrderLineItem bodyOrderOrderLineItems0 = new OrderLineItem.Builder(
6359
"2")
6460
.name("Printed T Shirt")
65-
.basePriceMoney(bodyOrderLineItems0BasePriceMoney)
66-
.discounts(bodyOrderLineItems0Discounts)
61+
.appliedTaxes(bodyOrderOrderLineItems0AppliedTaxes)
62+
.appliedDiscounts(bodyOrderOrderLineItems0AppliedDiscounts)
63+
.basePriceMoney(bodyOrderOrderLineItems0BasePriceMoney)
6764
.build();
68-
bodyOrderLineItems.add(bodyOrderLineItems0);
65+
bodyOrderOrderLineItems.add(bodyOrderOrderLineItems0);
6966

70-
Money bodyOrderLineItems1BasePriceMoney = new Money.Builder()
67+
Money bodyOrderOrderLineItems1BasePriceMoney = new Money.Builder()
7168
.amount(2500L)
7269
.currency("USD")
7370
.build();
74-
CreateOrderRequestLineItem bodyOrderLineItems1 = new CreateOrderRequestLineItem.Builder(
71+
OrderLineItem bodyOrderOrderLineItems1 = new OrderLineItem.Builder(
7572
"1")
7673
.name("Slim Jeans")
77-
.basePriceMoney(bodyOrderLineItems1BasePriceMoney)
74+
.basePriceMoney(bodyOrderOrderLineItems1BasePriceMoney)
7875
.build();
79-
bodyOrderLineItems.add(bodyOrderLineItems1);
76+
bodyOrderOrderLineItems.add(bodyOrderOrderLineItems1);
8077

81-
Money bodyOrderLineItems2BasePriceMoney = new Money.Builder()
78+
Money bodyOrderOrderLineItems2BasePriceMoney = new Money.Builder()
8279
.amount(3500L)
8380
.currency("USD")
8481
.build();
85-
List<CreateOrderRequestTax> bodyOrderLineItems2Taxes = new LinkedList<>();
86-
87-
CreateOrderRequestTax bodyOrderLineItems2Taxes0 = new CreateOrderRequestTax.Builder()
88-
.name("Fair Trade Tax")
89-
.percentage("5")
90-
.build();
91-
bodyOrderLineItems2Taxes.add(bodyOrderLineItems2Taxes0);
92-
93-
List<CreateOrderRequestDiscount> bodyOrderLineItems2Discounts = new LinkedList<>();
94-
95-
Money bodyOrderLineItems2Discounts0AmountMoney = new Money.Builder()
96-
.amount(1100L)
97-
.currency("USD")
98-
.build();
99-
CreateOrderRequestDiscount bodyOrderLineItems2Discounts0 = new CreateOrderRequestDiscount.Builder()
100-
.name("$11 off Customer Discount")
101-
.amountMoney(bodyOrderLineItems2Discounts0AmountMoney)
102-
.build();
103-
bodyOrderLineItems2Discounts.add(bodyOrderLineItems2Discounts0);
104-
105-
CreateOrderRequestLineItem bodyOrderLineItems2 = new CreateOrderRequestLineItem.Builder(
82+
OrderLineItem bodyOrderOrderLineItems2 = new OrderLineItem.Builder(
10683
"3")
10784
.name("Woven Sweater")
108-
.basePriceMoney(bodyOrderLineItems2BasePriceMoney)
109-
.taxes(bodyOrderLineItems2Taxes)
110-
.discounts(bodyOrderLineItems2Discounts)
85+
.basePriceMoney(bodyOrderOrderLineItems2BasePriceMoney)
11186
.build();
112-
bodyOrderLineItems.add(bodyOrderLineItems2);
87+
bodyOrderOrderLineItems.add(bodyOrderOrderLineItems2);
11388

114-
List<CreateOrderRequestTax> bodyOrderTaxes = new LinkedList<>();
89+
List<OrderLineItemTax> bodyOrderOrderTaxes = new LinkedList<>();
11590

116-
CreateOrderRequestTax bodyOrderTaxes0 = new CreateOrderRequestTax.Builder()
117-
.name("Sales Tax")
118-
.percentage("8.5")
91+
OrderLineItemTax bodyOrderOrderTaxes0 = new OrderLineItemTax.Builder()
92+
.uid("38ze1696-z1e3-5628-af6d-f1e04d947fg3")
93+
.type("INCLUSIVE")
94+
.percentage("7.75")
95+
.scope("LINE_ITEM")
11996
.build();
120-
bodyOrderTaxes.add(bodyOrderTaxes0);
97+
bodyOrderOrderTaxes.add(bodyOrderOrderTaxes0);
12198

122-
List<CreateOrderRequestDiscount> bodyOrderDiscounts = new LinkedList<>();
99+
List<OrderLineItemDiscount> bodyOrderOrderDiscounts = new LinkedList<>();
123100

124-
CreateOrderRequestDiscount bodyOrderDiscounts0 = new CreateOrderRequestDiscount.Builder()
125-
.name("Father's day 12% OFF")
126-
.percentage("12")
127-
.build();
128-
bodyOrderDiscounts.add(bodyOrderDiscounts0);
129-
130-
Money bodyOrderDiscounts1AmountMoney = new Money.Builder()
131-
.amount(5500L)
101+
Money bodyOrderOrderDiscounts0AmountMoney = new Money.Builder()
102+
.amount(100L)
132103
.currency("USD")
133104
.build();
134-
CreateOrderRequestDiscount bodyOrderDiscounts1 = new CreateOrderRequestDiscount.Builder()
135-
.name("Global Sales $55 OFF")
136-
.amountMoney(bodyOrderDiscounts1AmountMoney)
105+
OrderLineItemDiscount bodyOrderOrderDiscounts0 = new OrderLineItemDiscount.Builder()
106+
.uid("56ae1696-z1e3-9328-af6d-f1e04d947gd4")
107+
.type("FIXED_AMOUNT")
108+
.amountMoney(bodyOrderOrderDiscounts0AmountMoney)
109+
.scope("LINE_ITEM")
137110
.build();
138-
bodyOrderDiscounts.add(bodyOrderDiscounts1);
111+
bodyOrderOrderDiscounts.add(bodyOrderOrderDiscounts0);
139112

140-
CreateOrderRequest bodyOrder = new CreateOrderRequest.Builder()
113+
Order bodyOrderOrder = new Order.Builder(
114+
"location_id")
141115
.referenceId("reference_id")
142-
.lineItems(bodyOrderLineItems)
143-
.taxes(bodyOrderTaxes)
144-
.discounts(bodyOrderDiscounts)
116+
.customerId("customer_id")
117+
.lineItems(bodyOrderOrderLineItems)
118+
.taxes(bodyOrderOrderTaxes)
119+
.discounts(bodyOrderOrderDiscounts)
120+
.build();
121+
CreateOrderRequest bodyOrder = new CreateOrderRequest.Builder()
122+
.order(bodyOrderOrder)
123+
.idempotencyKey("12ae1696-z1e3-4328-af6d-f1e04d947gd4")
145124
.build();
146125
Address bodyPrePopulateShippingAddress = new Address.Builder()
147126
.addressLine1("1455 Market St.")

0 commit comments

Comments
 (0)