You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
[`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).
[`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).
[`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).
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).
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).
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).
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).
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).
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).
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).
|`booking_id`|`String`| Template, Required | The ID of the target [booking](entity:Booking). |
353
353
|`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). |
354
354
|`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`.<br>**Default**: `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`|
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).
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).
|`booking_id`|`String`| Template, Required | The ID of the target [booking](entity:Booking). |
448
448
|`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`.<br>**Default**: `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`|
450
450
|`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. |
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).
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).
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).
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).
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).
[`Retrieve Business Booking Profile Response Hash`](../../doc/models/retrieve-business-booking-profile-response.md)
171
+
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).
|`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`|
201
+
|`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`|
202
202
|`limit`|`Integer`| Query, Optional | The maximum number of results to return in a paged response. |
203
203
|`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. |
204
204
|`location_id`|`String`| Query, Optional | Indicates whether to include only team members enabled at the given location in the returned result. |
205
205
206
206
## Response Type
207
207
208
-
[`List Team Member Booking Profiles Response Hash`](../../doc/models/list-team-member-booking-profiles-response.md)
208
+
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).
[`Retrieve Team Member Booking Profile Response Hash`](../../doc/models/retrieve-team-member-booking-profile-response.md)
242
+
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).
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).
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).
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).
Copy file name to clipboardExpand all lines: doc/api/cards.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,13 +35,13 @@ def list_cards(cursor: nil,
35
35
| --- | --- | --- | --- |
36
36
|`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/build-basics/common-api-patterns/pagination) for more information. |
37
37
|`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. |
38
-
|`include_disabled`|`TrueClass\|FalseClass`| Query, Optional | Includes disabled cards.<br>By default, all enabled cards owned by the merchant are returned.<br>**Default**: `false`|
38
+
|`include_disabled`|`TrueClass \| FalseClass`| Query, Optional | Includes disabled cards.<br>By default, all enabled cards owned by the merchant are returned.<br>**Default**: `false`|
39
39
|`reference_id`|`String`| Query, Optional | Limit results to cards associated with the reference_id supplied. |
40
40
|`sort_order`|[`String (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. |
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cards Response Hash`](../../doc/models/list-cards-response.md).
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Card Response Hash`](../../doc/models/create-card-response.md).
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Card Response Hash`](../../doc/models/retrieve-card-response.md).
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Disable Card Response Hash`](../../doc/models/disable-card-response.md).
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cash Drawer Shifts Response Hash`](../../doc/models/list-cash-drawer-shifts-response.md).
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Cash Drawer Shift Response Hash`](../../doc/models/retrieve-cash-drawer-shift-response.md).
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cash Drawer Shift Events Response Hash`](../../doc/models/list-cash-drawer-shift-events-response.md).
0 commit comments