Skip to content

Commit 874a687

Browse files
author
autobot
committed
Generated PR for Release: 39.1.0.20240919
1 parent f725068 commit 874a687

File tree

93 files changed

+641
-628
lines changed

Some content is hidden

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

93 files changed

+641
-628
lines changed

doc/api/apple-pay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def register_domain(body:)
3838

3939
## Response Type
4040

41-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Register Domain Response Hash`](../../doc/models/register-domain-response.md).
41+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Register Domain Response Hash`](../../doc/models/register-domain-response.md).
4242

4343
## Example Usage
4444

doc/api/bank-accounts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def list_bank_accounts(cursor: nil,
3535

3636
## Response Type
3737

38-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bank Accounts Response Hash`](../../doc/models/list-bank-accounts-response.md).
38+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bank Accounts Response Hash`](../../doc/models/list-bank-accounts-response.md).
3939

4040
## Example Usage
4141

@@ -66,7 +66,7 @@ def get_bank_account_by_v1_id(v1_bank_account_id:)
6666

6767
## Response Type
6868

69-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account by V1 Id Response Hash`](../../doc/models/get-bank-account-by-v1-id-response.md).
69+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account by V1 Id Response Hash`](../../doc/models/get-bank-account-by-v1-id-response.md).
7070

7171
## Example Usage
7272

@@ -101,7 +101,7 @@ def get_bank_account(bank_account_id:)
101101

102102
## Response Type
103103

104-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account Response Hash`](../../doc/models/get-bank-account-response.md).
104+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account Response Hash`](../../doc/models/get-bank-account-response.md).
105105

106106
## Example Usage
107107

doc/api/booking-custom-attributes.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def list_booking_custom_attribute_definitions(limit: nil,
4444

4545
## Response Type
4646

47-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attribute Definitions Response Hash`](../../doc/models/list-booking-custom-attribute-definitions-response.md).
47+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attribute Definitions Response Hash`](../../doc/models/list-booking-custom-attribute-definitions-response.md).
4848

4949
## Example Usage
5050

@@ -81,7 +81,7 @@ def create_booking_custom_attribute_definition(body:)
8181

8282
## Response Type
8383

84-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Custom Attribute Definition Response Hash`](../../doc/models/create-booking-custom-attribute-definition-response.md).
84+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Custom Attribute Definition Response Hash`](../../doc/models/create-booking-custom-attribute-definition-response.md).
8585

8686
## Example Usage
8787

@@ -123,7 +123,7 @@ def delete_booking_custom_attribute_definition(key:)
123123

124124
## Response Type
125125

126-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Definition Response Hash`](../../doc/models/delete-booking-custom-attribute-definition-response.md).
126+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Definition Response Hash`](../../doc/models/delete-booking-custom-attribute-definition-response.md).
127127

128128
## Example Usage
129129

@@ -162,7 +162,7 @@ def retrieve_booking_custom_attribute_definition(key:,
162162

163163
## Response Type
164164

165-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Definition Response Hash`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md).
165+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Definition Response Hash`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md).
166166

167167
## Example Usage
168168

@@ -204,7 +204,7 @@ def update_booking_custom_attribute_definition(key:,
204204

205205
## Response Type
206206

207-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Custom Attribute Definition Response Hash`](../../doc/models/update-booking-custom-attribute-definition-response.md).
207+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Custom Attribute Definition Response Hash`](../../doc/models/update-booking-custom-attribute-definition-response.md).
208208

209209
## Example Usage
210210

@@ -251,7 +251,7 @@ def bulk_delete_booking_custom_attributes(body:)
251251

252252
## Response Type
253253

254-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Booking Custom Attributes Response Hash`](../../doc/models/bulk-delete-booking-custom-attributes-response.md).
254+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Booking Custom Attributes Response Hash`](../../doc/models/bulk-delete-booking-custom-attributes-response.md).
255255

256256
## Example Usage
257257

@@ -302,7 +302,7 @@ def bulk_upsert_booking_custom_attributes(body:)
302302

303303
## Response Type
304304

305-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Booking Custom Attributes Response Hash`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md).
305+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Booking Custom Attributes Response Hash`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md).
306306

307307
## Example Usage
308308

@@ -352,11 +352,11 @@ def list_booking_custom_attributes(booking_id:,
352352
| `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). |
353353
| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.<br>The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.<br>The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
354354
| `cursor` | `String` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.<br>Provide this cursor to retrieve the next page of results for your original request. For more<br>information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
355-
| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each<br>custom attribute. Set this parameter to `true` to get the name and description of each custom<br>attribute, information about the data type, or other definition details. The default value is `false`. |
355+
| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each<br>custom attribute. Set this parameter to `true` to get the name and description of each custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `false` |
356356

357357
## Response Type
358358

359-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attributes Response Hash`](../../doc/models/list-booking-custom-attributes-response.md).
359+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attributes Response Hash`](../../doc/models/list-booking-custom-attributes-response.md).
360360

361361
## Example Usage
362362

@@ -403,7 +403,7 @@ def delete_booking_custom_attribute(booking_id:,
403403

404404
## Response Type
405405

406-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Response Hash`](../../doc/models/delete-booking-custom-attribute-response.md).
406+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Response Hash`](../../doc/models/delete-booking-custom-attribute-response.md).
407407

408408
## Example Usage
409409

@@ -446,12 +446,12 @@ def retrieve_booking_custom_attribute(booking_id:,
446446
| --- | --- | --- | --- |
447447
| `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). |
448448
| `key` | `String` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom<br>attribute definition in the Square seller account. If the requesting application is not the<br>definition owner, you must use the qualified key. |
449-
| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of<br>the custom attribute. Set this parameter to `true` to get the name and description of the custom<br>attribute, information about the data type, or other definition details. The default value is `false`. |
449+
| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of<br>the custom attribute. Set this parameter to `true` to get the name and description of the custom<br>attribute, information about the data type, or other definition details. The default value is `false`.<br>**Default**: `false` |
450450
| `version` | `Integer` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to<br>guarantee that you receive the most up-to-date data. When included in the request, Square<br>returns the specified version or a higher version if one exists. If the specified version is<br>higher than the current version, Square returns a `BAD_REQUEST` error. |
451451

452452
## Response Type
453453

454-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Response Hash`](../../doc/models/retrieve-booking-custom-attribute-response.md).
454+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Response Hash`](../../doc/models/retrieve-booking-custom-attribute-response.md).
455455

456456
## Example Usage
457457

@@ -503,7 +503,7 @@ def upsert_booking_custom_attribute(booking_id:,
503503

504504
## Response Type
505505

506-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Booking Custom Attribute Response Hash`](../../doc/models/upsert-booking-custom-attribute-response.md).
506+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Booking Custom Attribute Response Hash`](../../doc/models/upsert-booking-custom-attribute-response.md).
507507

508508
## Example Usage
509509

doc/api/bookings.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def list_bookings(limit: nil,
5656

5757
## Response Type
5858

59-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bookings Response Hash`](../../doc/models/list-bookings-response.md).
59+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bookings Response Hash`](../../doc/models/list-bookings-response.md).
6060

6161
## Example Usage
6262

@@ -101,7 +101,7 @@ def create_booking(body:)
101101

102102
## Response Type
103103

104-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Response Hash`](../../doc/models/create-booking-response.md).
104+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Response Hash`](../../doc/models/create-booking-response.md).
105105

106106
## Example Usage
107107

@@ -140,7 +140,7 @@ def search_availability(body:)
140140

141141
## Response Type
142142

143-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Availability Response Hash`](../../doc/models/search-availability-response.md).
143+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Availability Response Hash`](../../doc/models/search-availability-response.md).
144144

145145
## Example Usage
146146

@@ -183,7 +183,7 @@ def bulk_retrieve_bookings(body:)
183183

184184
## Response Type
185185

186-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Bookings Response Hash`](../../doc/models/bulk-retrieve-bookings-response.md).
186+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Bookings Response Hash`](../../doc/models/bulk-retrieve-bookings-response.md).
187187

188188
## Example Usage
189189

@@ -217,7 +217,7 @@ def retrieve_business_booking_profile
217217

218218
## Response Type
219219

220-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Business Booking Profile Response Hash`](../../doc/models/retrieve-business-booking-profile-response.md).
220+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Business Booking Profile Response Hash`](../../doc/models/retrieve-business-booking-profile-response.md).
221221

222222
## Example Usage
223223

@@ -250,7 +250,7 @@ def list_location_booking_profiles(limit: nil,
250250

251251
## Response Type
252252

253-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Booking Profiles Response Hash`](../../doc/models/list-location-booking-profiles-response.md).
253+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Booking Profiles Response Hash`](../../doc/models/list-location-booking-profiles-response.md).
254254

255255
## Example Usage
256256

@@ -281,7 +281,7 @@ def retrieve_location_booking_profile(location_id:)
281281

282282
## Response Type
283283

284-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Booking Profile Response Hash`](../../doc/models/retrieve-location-booking-profile-response.md).
284+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Booking Profile Response Hash`](../../doc/models/retrieve-location-booking-profile-response.md).
285285

286286
## Example Usage
287287

@@ -314,14 +314,14 @@ def list_team_member_booking_profiles(bookable_only: false,
314314

315315
| Parameter | Type | Tags | Description |
316316
| --- | --- | --- | --- |
317-
| `bookable_only` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). |
317+
| `bookable_only` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).<br>**Default**: `false` |
318318
| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a paged response. |
319319
| `cursor` | `String` | Query, Optional | The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. |
320320
| `location_id` | `String` | Query, Optional | Indicates whether to include only team members enabled at the given location in the returned result. |
321321

322322
## Response Type
323323

324-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Team Member Booking Profiles Response Hash`](../../doc/models/list-team-member-booking-profiles-response.md).
324+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Team Member Booking Profiles Response Hash`](../../doc/models/list-team-member-booking-profiles-response.md).
325325

326326
## Example Usage
327327

@@ -355,7 +355,7 @@ def bulk_retrieve_team_member_booking_profiles(body:)
355355

356356
## Response Type
357357

358-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Team Member Booking Profiles Response Hash`](../../doc/models/bulk-retrieve-team-member-booking-profiles-response.md).
358+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Team Member Booking Profiles Response Hash`](../../doc/models/bulk-retrieve-team-member-booking-profiles-response.md).
359359

360360
## Example Usage
361361

@@ -395,7 +395,7 @@ def retrieve_team_member_booking_profile(team_member_id:)
395395

396396
## Response Type
397397

398-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Team Member Booking Profile Response Hash`](../../doc/models/retrieve-team-member-booking-profile-response.md).
398+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Team Member Booking Profile Response Hash`](../../doc/models/retrieve-team-member-booking-profile-response.md).
399399

400400
## Example Usage
401401

@@ -432,7 +432,7 @@ def retrieve_booking(booking_id:)
432432

433433
## Response Type
434434

435-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Response Hash`](../../doc/models/retrieve-booking-response.md).
435+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Response Hash`](../../doc/models/retrieve-booking-response.md).
436436

437437
## Example Usage
438438

@@ -474,7 +474,7 @@ def update_booking(booking_id:,
474474

475475
## Response Type
476476

477-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Response Hash`](../../doc/models/update-booking-response.md).
477+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Response Hash`](../../doc/models/update-booking-response.md).
478478

479479
## Example Usage
480480

@@ -523,7 +523,7 @@ def cancel_booking(booking_id:,
523523

524524
## Response Type
525525

526-
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Booking Response Hash`](../../doc/models/cancel-booking-response.md).
526+
This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Booking Response Hash`](../../doc/models/cancel-booking-response.md).
527527

528528
## Example Usage
529529

0 commit comments

Comments
 (0)