Skip to content

Commit c405000

Browse files
author
Xiao Hu
authored
Merge pull request #85 from square/release/17.3.0.20220316
Generated PR for Release: 17.3.0.20220316
2 parents a04a48e + 2b01c0f commit c405000

656 files changed

Lines changed: 4128 additions & 2514 deletions

File tree

Some content is hidden

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

‎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
```python
2525
def register_domain(self,
@@ -30,11 +30,11 @@ def register_domain(self,
3030

3131
| Parameter | Type | Tags | Description |
3232
| --- | --- | --- | --- |
33-
| `body` | [`Register Domain Request`](/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` | [`Register Domain Request`](../../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-
[`Register Domain Response`](/doc/models/register-domain-response.md)
37+
[`Register Domain Response`](../../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 @@ bank_accounts_api = client.bank_accounts
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
```python
2323
def list_bank_accounts(self,
@@ -30,13 +30,13 @@ def list_bank_accounts(self,
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` | `int` | 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
| `location_id` | `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-
[`List Bank Accounts Response`](/doc/models/list-bank-accounts-response.md)
39+
[`List Bank Accounts Response`](../../doc/models/list-bank-accounts-response.md)
4040

4141
## Example Usage
4242

@@ -56,7 +56,7 @@ elif result.is_error():
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
```python
6262
def get_bank_account_by_v1_id(self,
@@ -67,11 +67,11 @@ def get_bank_account_by_v1_id(self,
6767

6868
| Parameter | Type | Tags | Description |
6969
| --- | --- | --- | --- |
70-
| `v1_bank_account_id` | `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+
| `v1_bank_account_id` | `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-
[`Get Bank Account by V1 Id Response`](/doc/models/get-bank-account-by-v1-id-response.md)
74+
[`Get Bank Account by V1 Id Response`](../../doc/models/get-bank-account-by-v1-id-response.md)
7575

7676
## Example Usage
7777

@@ -89,7 +89,7 @@ elif result.is_error():
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
```python
@@ -105,7 +105,7 @@ def get_bank_account(self,
105105

106106
## Response Type
107107

108-
[`Get Bank Account Response`](/doc/models/get-bank-account-response.md)
108+
[`Get Bank Account Response`](../../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 @@ bookings_api = client.bookings
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
```python
@@ -51,7 +51,7 @@ def list_bookings(self,
5151

5252
## Response Type
5353

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

5656
## Example Usage
5757

@@ -76,7 +76,7 @@ elif result.is_error():
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
```python
@@ -88,11 +88,11 @@ def create_booking(self,
8888

8989
| Parameter | Type | Tags | Description |
9090
| --- | --- | --- | --- |
91-
| `body` | [`Create Booking Request`](/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` | [`Create Booking Request`](../../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-
[`Create Booking Response`](/doc/models/create-booking-response.md)
95+
[`Create Booking Response`](../../doc/models/create-booking-response.md)
9696

9797
## Example Usage
9898

@@ -119,7 +119,7 @@ elif result.is_error():
119119

120120
Searches for availabilities for booking.
121121

122-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
122+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
123123
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
124124

125125
```python
@@ -131,11 +131,11 @@ def search_availability(self,
131131

132132
| Parameter | Type | Tags | Description |
133133
| --- | --- | --- | --- |
134-
| `body` | [`Search Availability Request`](/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. |
134+
| `body` | [`Search Availability Request`](../../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. |
135135

136136
## Response Type
137137

138-
[`Search Availability Response`](/doc/models/search-availability-response.md)
138+
[`Search Availability Response`](../../doc/models/search-availability-response.md)
139139

140140
## Example Usage
141141

@@ -184,7 +184,7 @@ def retrieve_business_booking_profile(self)
184184

185185
## Response Type
186186

187-
[`Retrieve Business Booking Profile Response`](/doc/models/retrieve-business-booking-profile-response.md)
187+
[`Retrieve Business Booking Profile Response`](../../doc/models/retrieve-business-booking-profile-response.md)
188188

189189
## Example Usage
190190

@@ -221,7 +221,7 @@ def list_team_member_booking_profiles(self,
221221

222222
## Response Type
223223

224-
[`List Team Member Booking Profiles Response`](/doc/models/list-team-member-booking-profiles-response.md)
224+
[`List Team Member Booking Profiles Response`](../../doc/models/list-team-member-booking-profiles-response.md)
225225

226226
## Example Usage
227227

@@ -257,7 +257,7 @@ def retrieve_team_member_booking_profile(self,
257257

258258
## Response Type
259259

260-
[`Retrieve Team Member Booking Profile Response`](/doc/models/retrieve-team-member-booking-profile-response.md)
260+
[`Retrieve Team Member Booking Profile Response`](../../doc/models/retrieve-team-member-booking-profile-response.md)
261261

262262
## Example Usage
263263

@@ -277,7 +277,7 @@ elif result.is_error():
277277

278278
Retrieves a booking.
279279

280-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
280+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
281281
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
282282

283283
```python
@@ -289,11 +289,11 @@ def retrieve_booking(self,
289289

290290
| Parameter | Type | Tags | Description |
291291
| --- | --- | --- | --- |
292-
| `booking_id` | `string` | Template, Required | The ID of the [Booking](/doc/models/booking.md) object representing the to-be-retrieved booking. |
292+
| `booking_id` | `string` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-retrieved booking. |
293293

294294
## Response Type
295295

296-
[`Retrieve Booking Response`](/doc/models/retrieve-booking-response.md)
296+
[`Retrieve Booking Response`](../../doc/models/retrieve-booking-response.md)
297297

298298
## Example Usage
299299

@@ -313,7 +313,7 @@ elif result.is_error():
313313

314314
Updates a booking.
315315

316-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
316+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
317317
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
318318

319319
```python
@@ -326,12 +326,12 @@ def update_booking(self,
326326

327327
| Parameter | Type | Tags | Description |
328328
| --- | --- | --- | --- |
329-
| `booking_id` | `string` | Template, Required | The ID of the [Booking](/doc/models/booking.md) object representing the to-be-updated booking. |
330-
| `body` | [`Update Booking Request`](/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. |
329+
| `booking_id` | `string` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-updated booking. |
330+
| `body` | [`Update Booking Request`](../../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. |
331331

332332
## Response Type
333333

334-
[`Update Booking Response`](/doc/models/update-booking-response.md)
334+
[`Update Booking Response`](../../doc/models/update-booking-response.md)
335335

336336
## Example Usage
337337

@@ -359,7 +359,7 @@ elif result.is_error():
359359

360360
Cancels an existing booking.
361361

362-
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
362+
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
363363
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
364364

365365
```python
@@ -372,12 +372,12 @@ def cancel_booking(self,
372372

373373
| Parameter | Type | Tags | Description |
374374
| --- | --- | --- | --- |
375-
| `booking_id` | `string` | Template, Required | The ID of the [Booking](/doc/models/booking.md) object representing the to-be-cancelled booking. |
376-
| `body` | [`Cancel Booking Request`](/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. |
375+
| `booking_id` | `string` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-cancelled booking. |
376+
| `body` | [`Cancel Booking Request`](../../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. |
377377

378378
## Response Type
379379

380-
[`Cancel Booking Response`](/doc/models/cancel-booking-response.md)
380+
[`Cancel Booking Response`](../../doc/models/cancel-booking-response.md)
381381

382382
## Example Usage
383383

‎doc/api/cards.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ cards_api = client.cards
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 @@ def list_cards(self,
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
| `customer_id` | `string` | Query, Optional | Limit results to cards associated with the customer supplied.<br>By default, all cards owned by the merchant are returned. |
3939
| `include_disabled` | `bool` | Query, Optional | Includes disabled cards.<br>By default, all enabled cards owned by the merchant are returned.<br>**Default**: `False` |
4040
| `reference_id` | `string` | Query, Optional | Limit results to cards associated with the reference_id supplied. |
41-
| `sort_order` | [`str (Sort Order)`](/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+
| `sort_order` | [`str (Sort Order)`](../../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-
[`List Cards Response`](/doc/models/list-cards-response.md)
45+
[`List Cards Response`](../../doc/models/list-cards-response.md)
4646

4747
## Example Usage
4848

@@ -75,11 +75,11 @@ def create_card(self,
7575

7676
| Parameter | Type | Tags | Description |
7777
| --- | --- | --- | --- |
78-
| `body` | [`Create Card Request`](/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` | [`Create Card Request`](../../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-
[`Create Card Response`](/doc/models/create-card-response.md)
82+
[`Create Card Response`](../../doc/models/create-card-response.md)
8383

8484
## Example Usage
8585

@@ -133,7 +133,7 @@ def retrieve_card(self,
133133

134134
## Response Type
135135

136-
[`Retrieve Card Response`](/doc/models/retrieve-card-response.md)
136+
[`Retrieve Card Response`](../../doc/models/retrieve-card-response.md)
137137

138138
## Example Usage
139139

@@ -167,7 +167,7 @@ def disable_card(self,
167167

168168
## Response Type
169169

170-
[`Disable Card Response`](/doc/models/disable-card-response.md)
170+
[`Disable Card Response`](../../doc/models/disable-card-response.md)
171171

172172
## Example Usage
173173

0 commit comments

Comments
 (0)