Skip to content

Commit 6dc2d67

Browse files
author
Xiao Hu
authored
Merge pull request #74 from square/release/18.3.0.20220316
Generated PR for Release: 18.3.0.20220316
2 parents 5c89899 + e64cb27 commit 6dc2d67

File tree

676 files changed

+7475
-2512
lines changed

Some content is hidden

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

676 files changed

+7475
-2512
lines changed

‎doc/api/apple-pay.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This endpoint provides an easy way for platform developers to bulk activate
1919
Apple Pay on the Web with Square for merchants using their platform.
2020

2121
To learn more about Web Apple Pay, see
22-
[Add the Apple Pay on the Web Button](https://developer.squareup.com/docs/payment-form/add-digital-wallets/apple-pay).
22+
[Add the Apple Pay on the Web Button](../../https://developer.squareup.com/docs/payment-form/add-digital-wallets/apple-pay).
2323

2424
```java
2525
CompletableFuture<RegisterDomainResponse> registerDomainAsync(
@@ -30,11 +30,11 @@ CompletableFuture<RegisterDomainResponse> registerDomainAsync(
3030

3131
| Parameter | Type | Tags | Description |
3232
| --- | --- | --- | --- |
33-
| `body` | [`RegisterDomainRequest`](/doc/models/register-domain-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
33+
| `body` | [`RegisterDomainRequest`](../../doc/models/register-domain-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
3434

3535
## Response Type
3636

37-
[`RegisterDomainResponse`](/doc/models/register-domain-response.md)
37+
[`RegisterDomainResponse`](../../doc/models/register-domain-response.md)
3838

3939
## Example Usage
4040

‎doc/api/bank-accounts.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ BankAccountsApi bankAccountsApi = client.getBankAccountsApi();
1010

1111
## Methods
1212

13-
* [List Bank Accounts](/doc/api/bank-accounts.md#list-bank-accounts)
14-
* [Get Bank Account by V1 Id](/doc/api/bank-accounts.md#get-bank-account-by-v1-id)
15-
* [Get Bank Account](/doc/api/bank-accounts.md#get-bank-account)
13+
* [List Bank Accounts](../../doc/api/bank-accounts.md#list-bank-accounts)
14+
* [Get Bank Account by V1 Id](../../doc/api/bank-accounts.md#get-bank-account-by-v1-id)
15+
* [Get Bank Account](../../doc/api/bank-accounts.md#get-bank-account)
1616

1717

1818
# List Bank Accounts
1919

20-
Returns a list of [BankAccount](/doc/models/bank-account.md) objects linked to a Square account.
20+
Returns a list of [BankAccount](../../doc/models/bank-account.md) objects linked to a Square account.
2121

2222
```java
2323
CompletableFuture<ListBankAccountsResponse> listBankAccountsAsync(
@@ -30,13 +30,13 @@ CompletableFuture<ListBankAccountsResponse> listBankAccountsAsync(
3030

3131
| Parameter | Type | Tags | Description |
3232
| --- | --- | --- | --- |
33-
| `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/working-with-apis/pagination) guide for more information. |
33+
| `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/working-with-apis/pagination) guide for more information. |
3434
| `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. |
3535
| `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. |
3636

3737
## Response Type
3838

39-
[`ListBankAccountsResponse`](/doc/models/list-bank-accounts-response.md)
39+
[`ListBankAccountsResponse`](../../doc/models/list-bank-accounts-response.md)
4040

4141
## Example Usage
4242

@@ -56,7 +56,7 @@ bankAccountsApi.listBankAccountsAsync(cursor, limit, locationId).thenAccept(resu
5656

5757
# Get Bank Account by V1 Id
5858

59-
Returns details of a [BankAccount](/doc/models/bank-account.md) identified by V1 bank account ID.
59+
Returns details of a [BankAccount](../../doc/models/bank-account.md) identified by V1 bank account ID.
6060

6161
```java
6262
CompletableFuture<GetBankAccountByV1IdResponse> getBankAccountByV1IdAsync(
@@ -67,11 +67,11 @@ CompletableFuture<GetBankAccountByV1IdResponse> getBankAccountByV1IdAsync(
6767

6868
| Parameter | Type | Tags | Description |
6969
| --- | --- | --- | --- |
70-
| `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/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
70+
| `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/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
7171

7272
## Response Type
7373

74-
[`GetBankAccountByV1IdResponse`](/doc/models/get-bank-account-by-v1-id-response.md)
74+
[`GetBankAccountByV1IdResponse`](../../doc/models/get-bank-account-by-v1-id-response.md)
7575

7676
## Example Usage
7777

@@ -89,7 +89,7 @@ bankAccountsApi.getBankAccountByV1IdAsync(v1BankAccountId).thenAccept(result ->
8989

9090
# Get Bank Account
9191

92-
Returns details of a [BankAccount](/doc/models/bank-account.md)
92+
Returns details of a [BankAccount](../../doc/models/bank-account.md)
9393
linked to a Square account.
9494

9595
```java
@@ -105,7 +105,7 @@ CompletableFuture<GetBankAccountResponse> getBankAccountAsync(
105105

106106
## Response Type
107107

108-
[`GetBankAccountResponse`](/doc/models/get-bank-account-response.md)
108+
[`GetBankAccountResponse`](../../doc/models/get-bank-account-response.md)
109109

110110
## Example Usage
111111

‎doc/api/bookings.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ BookingsApi bookingsApi = client.getBookingsApi();
1010

1111
## Methods
1212

13-
* [List Bookings](/doc/api/bookings.md#list-bookings)
14-
* [Create Booking](/doc/api/bookings.md#create-booking)
15-
* [Search Availability](/doc/api/bookings.md#search-availability)
16-
* [Retrieve Business Booking Profile](/doc/api/bookings.md#retrieve-business-booking-profile)
17-
* [List Team Member Booking Profiles](/doc/api/bookings.md#list-team-member-booking-profiles)
18-
* [Retrieve Team Member Booking Profile](/doc/api/bookings.md#retrieve-team-member-booking-profile)
19-
* [Retrieve Booking](/doc/api/bookings.md#retrieve-booking)
20-
* [Update Booking](/doc/api/bookings.md#update-booking)
21-
* [Cancel Booking](/doc/api/bookings.md#cancel-booking)
13+
* [List Bookings](../../doc/api/bookings.md#list-bookings)
14+
* [Create Booking](../../doc/api/bookings.md#create-booking)
15+
* [Search Availability](../../doc/api/bookings.md#search-availability)
16+
* [Retrieve Business Booking Profile](../../doc/api/bookings.md#retrieve-business-booking-profile)
17+
* [List Team Member Booking Profiles](../../doc/api/bookings.md#list-team-member-booking-profiles)
18+
* [Retrieve Team Member Booking Profile](../../doc/api/bookings.md#retrieve-team-member-booking-profile)
19+
* [Retrieve Booking](../../doc/api/bookings.md#retrieve-booking)
20+
* [Update Booking](../../doc/api/bookings.md#update-booking)
21+
* [Cancel Booking](../../doc/api/bookings.md#cancel-booking)
2222

2323

2424
# List Bookings
2525

2626
Retrieve a collection of bookings.
2727

28-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
28+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
2929
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
3030

3131
```java
@@ -51,7 +51,7 @@ CompletableFuture<ListBookingsResponse> listBookingsAsync(
5151

5252
## Response Type
5353

54-
[`ListBookingsResponse`](/doc/models/list-bookings-response.md)
54+
[`ListBookingsResponse`](../../doc/models/list-bookings-response.md)
5555

5656
## Example Usage
5757

@@ -76,7 +76,7 @@ bookingsApi.listBookingsAsync(limit, cursor, teamMemberId, locationId, startAtMi
7676

7777
Creates a booking.
7878

79-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
79+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
8080
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
8181

8282
```java
@@ -88,11 +88,11 @@ CompletableFuture<CreateBookingResponse> createBookingAsync(
8888

8989
| Parameter | Type | Tags | Description |
9090
| --- | --- | --- | --- |
91-
| `body` | [`CreateBookingRequest`](/doc/models/create-booking-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
91+
| `body` | [`CreateBookingRequest`](../../doc/models/create-booking-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
9292

9393
## Response Type
9494

95-
[`CreateBookingResponse`](/doc/models/create-booking-response.md)
95+
[`CreateBookingResponse`](../../doc/models/create-booking-response.md)
9696

9797
## Example Usage
9898

@@ -122,7 +122,7 @@ bookingsApi.createBookingAsync(body).thenAccept(result -> {
122122

123123
Searches for availabilities for booking.
124124

125-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
125+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
126126
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
127127

128128
```java
@@ -134,11 +134,11 @@ CompletableFuture<SearchAvailabilityResponse> searchAvailabilityAsync(
134134

135135
| Parameter | Type | Tags | Description |
136136
| --- | --- | --- | --- |
137-
| `body` | [`SearchAvailabilityRequest`](/doc/models/search-availability-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
137+
| `body` | [`SearchAvailabilityRequest`](../../doc/models/search-availability-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
138138

139139
## Response Type
140140

141-
[`SearchAvailabilityResponse`](/doc/models/search-availability-response.md)
141+
[`SearchAvailabilityResponse`](../../doc/models/search-availability-response.md)
142142

143143
## Example Usage
144144

@@ -221,7 +221,7 @@ CompletableFuture<RetrieveBusinessBookingProfileResponse> retrieveBusinessBookin
221221

222222
## Response Type
223223

224-
[`RetrieveBusinessBookingProfileResponse`](/doc/models/retrieve-business-booking-profile-response.md)
224+
[`RetrieveBusinessBookingProfileResponse`](../../doc/models/retrieve-business-booking-profile-response.md)
225225

226226
## Example Usage
227227

@@ -258,7 +258,7 @@ CompletableFuture<ListTeamMemberBookingProfilesResponse> listTeamMemberBookingPr
258258

259259
## Response Type
260260

261-
[`ListTeamMemberBookingProfilesResponse`](/doc/models/list-team-member-booking-profiles-response.md)
261+
[`ListTeamMemberBookingProfilesResponse`](../../doc/models/list-team-member-booking-profiles-response.md)
262262

263263
## Example Usage
264264

@@ -294,7 +294,7 @@ CompletableFuture<RetrieveTeamMemberBookingProfileResponse> retrieveTeamMemberBo
294294

295295
## Response Type
296296

297-
[`RetrieveTeamMemberBookingProfileResponse`](/doc/models/retrieve-team-member-booking-profile-response.md)
297+
[`RetrieveTeamMemberBookingProfileResponse`](../../doc/models/retrieve-team-member-booking-profile-response.md)
298298

299299
## Example Usage
300300

@@ -314,7 +314,7 @@ bookingsApi.retrieveTeamMemberBookingProfileAsync(teamMemberId).thenAccept(resul
314314

315315
Retrieves a booking.
316316

317-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
317+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
318318
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
319319

320320
```java
@@ -326,11 +326,11 @@ CompletableFuture<RetrieveBookingResponse> retrieveBookingAsync(
326326

327327
| Parameter | Type | Tags | Description |
328328
| --- | --- | --- | --- |
329-
| `bookingId` | `String` | Template, Required | The ID of the [Booking](/doc/models/booking.md) object representing the to-be-retrieved booking. |
329+
| `bookingId` | `String` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-retrieved booking. |
330330

331331
## Response Type
332332

333-
[`RetrieveBookingResponse`](/doc/models/retrieve-booking-response.md)
333+
[`RetrieveBookingResponse`](../../doc/models/retrieve-booking-response.md)
334334

335335
## Example Usage
336336

@@ -350,7 +350,7 @@ bookingsApi.retrieveBookingAsync(bookingId).thenAccept(result -> {
350350

351351
Updates a booking.
352352

353-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
353+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
354354
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
355355

356356
```java
@@ -363,12 +363,12 @@ CompletableFuture<UpdateBookingResponse> updateBookingAsync(
363363

364364
| Parameter | Type | Tags | Description |
365365
| --- | --- | --- | --- |
366-
| `bookingId` | `String` | Template, Required | The ID of the [Booking](/doc/models/booking.md) object representing the to-be-updated booking. |
367-
| `body` | [`UpdateBookingRequest`](/doc/models/update-booking-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
366+
| `bookingId` | `String` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-updated booking. |
367+
| `body` | [`UpdateBookingRequest`](../../doc/models/update-booking-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
368368

369369
## Response Type
370370

371-
[`UpdateBookingResponse`](/doc/models/update-booking-response.md)
371+
[`UpdateBookingResponse`](../../doc/models/update-booking-response.md)
372372

373373
## Example Usage
374374

@@ -399,7 +399,7 @@ bookingsApi.updateBookingAsync(bookingId, body).thenAccept(result -> {
399399

400400
Cancels an existing booking.
401401

402-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
402+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
403403
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
404404

405405
```java
@@ -412,12 +412,12 @@ CompletableFuture<CancelBookingResponse> cancelBookingAsync(
412412

413413
| Parameter | Type | Tags | Description |
414414
| --- | --- | --- | --- |
415-
| `bookingId` | `String` | Template, Required | The ID of the [Booking](/doc/models/booking.md) object representing the to-be-cancelled booking. |
416-
| `body` | [`CancelBookingRequest`](/doc/models/cancel-booking-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
415+
| `bookingId` | `String` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-cancelled booking. |
416+
| `body` | [`CancelBookingRequest`](../../doc/models/cancel-booking-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
417417

418418
## Response Type
419419

420-
[`CancelBookingResponse`](/doc/models/cancel-booking-response.md)
420+
[`CancelBookingResponse`](../../doc/models/cancel-booking-response.md)
421421

422422
## Example Usage
423423

‎doc/api/cards.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ CardsApi cardsApi = client.getCardsApi();
1010

1111
## Methods
1212

13-
* [List Cards](/doc/api/cards.md#list-cards)
14-
* [Create Card](/doc/api/cards.md#create-card)
15-
* [Retrieve Card](/doc/api/cards.md#retrieve-card)
16-
* [Disable Card](/doc/api/cards.md#disable-card)
13+
* [List Cards](../../doc/api/cards.md#list-cards)
14+
* [Create Card](../../doc/api/cards.md#create-card)
15+
* [Retrieve Card](../../doc/api/cards.md#retrieve-card)
16+
* [Disable Card](../../doc/api/cards.md#disable-card)
1717

1818

1919
# List Cards
@@ -34,15 +34,15 @@ CompletableFuture<ListCardsResponse> listCardsAsync(
3434

3535
| Parameter | Type | Tags | Description |
3636
| --- | --- | --- | --- |
37-
| `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for your original query.<br><br>See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. |
37+
| `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for your original query.<br><br>See [Pagination](../../https://developer.squareup.com/docs/basics/api101/pagination) for more information. |
3838
| `customerId` | `String` | Query, Optional | Limit results to cards associated with the customer supplied.<br>By default, all cards owned by the merchant are returned. |
3939
| `includeDisabled` | `Boolean` | Query, Optional | Includes disabled cards.<br>By default, all enabled cards owned by the merchant are returned.<br>**Default**: `false` |
4040
| `referenceId` | `String` | Query, Optional | Limit results to cards associated with the reference_id supplied. |
41-
| `sortOrder` | [`String`](/doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the card was created with the specified order.<br>This field defaults to ASC. |
41+
| `sortOrder` | [`String`](../../doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the card was created with the specified order.<br>This field defaults to ASC. |
4242

4343
## Response Type
4444

45-
[`ListCardsResponse`](/doc/models/list-cards-response.md)
45+
[`ListCardsResponse`](../../doc/models/list-cards-response.md)
4646

4747
## Example Usage
4848

@@ -75,11 +75,11 @@ CompletableFuture<CreateCardResponse> createCardAsync(
7575

7676
| Parameter | Type | Tags | Description |
7777
| --- | --- | --- | --- |
78-
| `body` | [`CreateCardRequest`](/doc/models/create-card-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
78+
| `body` | [`CreateCardRequest`](../../doc/models/create-card-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
7979

8080
## Response Type
8181

82-
[`CreateCardResponse`](/doc/models/create-card-response.md)
82+
[`CreateCardResponse`](../../doc/models/create-card-response.md)
8383

8484
## Example Usage
8585

@@ -138,7 +138,7 @@ CompletableFuture<RetrieveCardResponse> retrieveCardAsync(
138138

139139
## Response Type
140140

141-
[`RetrieveCardResponse`](/doc/models/retrieve-card-response.md)
141+
[`RetrieveCardResponse`](../../doc/models/retrieve-card-response.md)
142142

143143
## Example Usage
144144

@@ -172,7 +172,7 @@ CompletableFuture<DisableCardResponse> disableCardAsync(
172172

173173
## Response Type
174174

175-
[`DisableCardResponse`](/doc/models/disable-card-response.md)
175+
[`DisableCardResponse`](../../doc/models/disable-card-response.md)
176176

177177
## Example Usage
178178

0 commit comments

Comments
 (0)