diff --git a/doc/api/booking-custom-attributes.md b/doc/api/booking-custom-attributes.md index 632896f..45df9e8 100644 --- a/doc/api/booking-custom-attributes.md +++ b/doc/api/booking-custom-attributes.md @@ -347,7 +347,7 @@ def list_booking_custom_attributes(self, | `booking_id` | `str` | Template, Required | The ID of the target [booking](entity:Booking). | | `limit` | `int` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `cursor` | `str` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | -| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | ## Response Type @@ -439,7 +439,7 @@ def retrieve_booking_custom_attribute(self, | --- | --- | --- | --- | | `booking_id` | `str` | Template, Required | The ID of the target [booking](entity:Booking). | | `key` | `str` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | | `version` | `int` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type diff --git a/doc/api/bookings.md b/doc/api/bookings.md index c37fa03..b3a28b1 100644 --- a/doc/api/bookings.md +++ b/doc/api/bookings.md @@ -310,7 +310,7 @@ def list_team_member_booking_profiles(self, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookable_only` | `bool` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). | +| `bookable_only` | `bool` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).
**Default**: `False` | | `limit` | `int` | Query, Optional | The maximum number of results to return in a paged response. | | `cursor` | `str` | 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. | | `location_id` | `str` | Query, Optional | Indicates whether to include only team members enabled at the given location in the returned result. | diff --git a/doc/api/cards.md b/doc/api/cards.md index 76b5f88..9da73b6 100644 --- a/doc/api/cards.md +++ b/doc/api/cards.md @@ -36,7 +36,7 @@ def list_cards(self, | --- | --- | --- | --- | | `cursor` | `str` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.

See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | | `customer_id` | `str` | Query, Optional | Limit results to cards associated with the customer supplied.
By default, all cards owned by the merchant are returned. | -| `include_disabled` | `bool` | Query, Optional | Includes disabled cards.
By default, all enabled cards owned by the merchant are returned. | +| `include_disabled` | `bool` | Query, Optional | Includes disabled cards.
By default, all enabled cards owned by the merchant are returned.
**Default**: `False` | | `reference_id` | `str` | Query, Optional | Limit results to cards associated with the reference_id supplied. | | `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.
This field defaults to ASC. | diff --git a/doc/api/catalog.md b/doc/api/catalog.md index ef472df..4f4beca 100644 --- a/doc/api/catalog.md +++ b/doc/api/catalog.md @@ -578,9 +578,9 @@ def retrieve_catalog_object(self, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `object_id` | `str` | Template, Required | The object ID of any type of catalog objects to be retrieved. | -| `include_related_objects` | `bool` | Query, Optional | If `true`, the response will include additional objects that are related to the
requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field
of the response. These objects are put in the `related_objects` field. Setting this to `true` is
helpful when the objects are needed for immediate display to a user.
This process only goes one level deep. Objects referenced by the related objects will not be included. For example,

if the `objects` field of the response contains a CatalogItem, its associated
CatalogCategory objects, CatalogTax objects, CatalogImage objects and
CatalogModifierLists will be returned in the `related_objects` field of the
response. If the `objects` field of the response contains a CatalogItemVariation,
its parent CatalogItem will be returned in the `related_objects` field of
the response.

Default value: `false` | +| `include_related_objects` | `bool` | Query, Optional | If `true`, the response will include additional objects that are related to the
requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field
of the response. These objects are put in the `related_objects` field. Setting this to `true` is
helpful when the objects are needed for immediate display to a user.
This process only goes one level deep. Objects referenced by the related objects will not be included. For example,

if the `objects` field of the response contains a CatalogItem, its associated
CatalogCategory objects, CatalogTax objects, CatalogImage objects and
CatalogModifierLists will be returned in the `related_objects` field of the
response. If the `objects` field of the response contains a CatalogItemVariation,
its parent CatalogItem will be returned in the `related_objects` field of
the response.

Default value: `false`
**Default**: `False` | | `catalog_version` | `long\|int` | Query, Optional | Requests objects as of a specific version of the catalog. This allows you to retrieve historical
versions of objects. The value to retrieve a specific version of an object can be found
in the version field of [CatalogObject](../../doc/models/catalog-object.md)s. If not included, results will
be from the current version of the catalog. | -| `include_category_path_to_root` | `bool` | Query, Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists
of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload. | +| `include_category_path_to_root` | `bool` | Query, Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists
of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload.
**Default**: `False` | ## Response Type diff --git a/doc/api/customer-custom-attributes.md b/doc/api/customer-custom-attributes.md index 900985e..d7e60bd 100644 --- a/doc/api/customer-custom-attributes.md +++ b/doc/api/customer-custom-attributes.md @@ -321,7 +321,7 @@ def list_customer_custom_attributes(self, | `customer_id` | `str` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `limit` | `int` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `cursor` | `str` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | -| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | ## Response Type @@ -415,7 +415,7 @@ def retrieve_customer_custom_attribute(self, | --- | --- | --- | --- | | `customer_id` | `str` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `key` | `str` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | | `version` | `int` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type diff --git a/doc/api/customers.md b/doc/api/customers.md index 5388879..da507c2 100644 --- a/doc/api/customers.md +++ b/doc/api/customers.md @@ -51,7 +51,7 @@ def list_customers(self, | `limit` | `int` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `sort_field` | [`str (Customer Sort Field)`](../../doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.

The default value is `DEFAULT`. | | `sort_order` | [`str (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or
descending (`DESC`) order.

The default value is `ASC`. | -| `count` | `bool` | Query, Optional | Indicates whether to return the total count of customers in the `count` field of the response.

The default value is `false`. | +| `count` | `bool` | Query, Optional | Indicates whether to return the total count of customers in the `count` field of the response.

The default value is `false`.
**Default**: `False` | ## Response Type diff --git a/doc/api/location-custom-attributes.md b/doc/api/location-custom-attributes.md index a08d093..97f0d7f 100644 --- a/doc/api/location-custom-attributes.md +++ b/doc/api/location-custom-attributes.md @@ -354,7 +354,7 @@ def list_location_custom_attributes(self, | `visibility_filter` | [`str (Visibility Filter)`](../../doc/models/visibility-filter.md) | Query, Optional | Filters the `CustomAttributeDefinition` results by their `visibility` values. | | `limit` | `int` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `cursor` | `str` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | -| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | ## Response Type @@ -443,7 +443,7 @@ def retrieve_location_custom_attribute(self, | --- | --- | --- | --- | | `location_id` | `str` | Template, Required | The ID of the target [location](entity:Location). | | `key` | `str` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | | `version` | `int` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type diff --git a/doc/api/merchant-custom-attributes.md b/doc/api/merchant-custom-attributes.md index ef617f5..052ea3d 100644 --- a/doc/api/merchant-custom-attributes.md +++ b/doc/api/merchant-custom-attributes.md @@ -351,7 +351,7 @@ def list_merchant_custom_attributes(self, | `visibility_filter` | [`str (Visibility Filter)`](../../doc/models/visibility-filter.md) | Query, Optional | Filters the `CustomAttributeDefinition` results by their `visibility` values. | | `limit` | `int` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `cursor` | `str` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | -| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | ## Response Type @@ -440,7 +440,7 @@ def retrieve_merchant_custom_attribute(self, | --- | --- | --- | --- | | `merchant_id` | `str` | Template, Required | The ID of the target [merchant](entity:Merchant). | | `key` | `str` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | +| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | | `version` | `int` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type diff --git a/doc/api/order-custom-attributes.md b/doc/api/order-custom-attributes.md index 4257fe8..1fcfabe 100644 --- a/doc/api/order-custom-attributes.md +++ b/doc/api/order-custom-attributes.md @@ -373,7 +373,7 @@ def list_order_custom_attributes(self, | `visibility_filter` | [`str (Visibility Filter)`](../../doc/models/visibility-filter.md) | Query, Optional | Requests that all of the custom attributes be returned, or only those that are read-only or read-write. | | `cursor` | `str` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | | `limit` | `int` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | -| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,
information about the data type, or other definition details. The default value is `false`. | +| `with_definitions` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,
information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | ## Response Type @@ -468,7 +468,7 @@ def retrieve_order_custom_attribute(self, | `order_id` | `str` | Template, Required | The ID of the target [order](entity:Order). | | `custom_attribute_key` | `str` | Template, Required | The key of the custom attribute to retrieve. This key must match the key of an
existing custom attribute definition. | | `version` | `int` | Query, Optional | To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)
control, include this optional field and specify the current version of the custom attribute. | -| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,
information about the data type, or other definition details. The default value is `false`. | +| `with_definition` | `bool` | Query, Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,
information about the data type, or other definition details. The default value is `false`.
**Default**: `False` | ## Response Type diff --git a/doc/api/payments.md b/doc/api/payments.md index 7ea6b4c..b3fa273 100644 --- a/doc/api/payments.md +++ b/doc/api/payments.md @@ -57,7 +57,7 @@ def list_payments(self, | `last_4` | `str` | Query, Optional | The last four digits of a payment card. | | `card_brand` | `str` | Query, Optional | The brand of the payment card (for example, VISA). | | `limit` | `int` | Query, Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.

The default value of 100 is also the maximum allowed value. If the provided value is
greater than 100, it is ignored and the default value is used instead.

Default: `100` | -| `is_offline_payment` | `bool` | Query, Optional | Whether the payment was taken offline or not. | +| `is_offline_payment` | `bool` | Query, Optional | Whether the payment was taken offline or not.
**Default**: `False` | | `offline_begin_time` | `str` | Query, Optional | Indicates the start of the time range for which to retrieve offline payments, in RFC 3339
format for timestamps. The range is determined using the
`offline_payment_details.client_created_at` field for each Payment. If set, payments without a
value set in `offline_payment_details.client_created_at` will not be returned.

Default: The current time. | | `offline_end_time` | `str` | Query, Optional | Indicates the end of the time range for which to retrieve offline payments, in RFC 3339
format for timestamps. The range is determined using the
`offline_payment_details.client_created_at` field for each Payment. If set, payments without a
value set in `offline_payment_details.client_created_at` will not be returned.

Default: The current time. | diff --git a/doc/api/webhook-subscriptions.md b/doc/api/webhook-subscriptions.md index 13e1574..0063649 100644 --- a/doc/api/webhook-subscriptions.md +++ b/doc/api/webhook-subscriptions.md @@ -68,7 +68,7 @@ def list_webhook_subscriptions(self, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `cursor` | `str` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | -| `include_disabled` | `bool` | Query, Optional | Includes disabled [Subscription](entity:WebhookSubscription)s.
By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. | +| `include_disabled` | `bool` | Query, Optional | Includes disabled [Subscription](entity:WebhookSubscription)s.
By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.
**Default**: `False` | | `sort_order` | [`str (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.
This field defaults to ASC. | | `limit` | `int` | Query, Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value.

Default: 100 | diff --git a/doc/client.md b/doc/client.md index 2754989..3f48821 100644 --- a/doc/client.md +++ b/doc/client.md @@ -5,7 +5,7 @@ The following parameters are configurable for the API Client: | Parameter | Type | Description | | --- | --- | --- | -| `square_version` | `str` | Square Connect API versions
*Default*: `'2024-08-21'` | +| `square_version` | `str` | Square Connect API versions
*Default*: `'2024-09-19'` | | `custom_url` | `str` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
*Default*: `'https://connect.squareup.com'` | | `environment` | `string` | The API environment.
**Default: `production`** | | `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests | @@ -24,10 +24,11 @@ The API client can be initialized as follows: ```python client = Client( - square_version='2024-08-21', + square_version='2024-09-19', bearer_auth_credentials=BearerAuthCredentials( access_token='AccessToken' ), + environment='production', custom_url='https://connect.squareup.com' ) ``` @@ -52,10 +53,12 @@ from square.http.auth.o_auth_2 import BearerAuthCredentials from square.client import Client client = Client( - square_version='2024-08-21', + square_version='2024-09-19', bearer_auth_credentials=BearerAuthCredentials( access_token='AccessToken' - ) + ), + environment='production', + custom_url='https://connect.squareup.com' ) locations_api = client.locations diff --git a/doc/models/booking.md b/doc/models/booking.md index ddb8436..137b0a3 100644 --- a/doc/models/booking.md +++ b/doc/models/booking.md @@ -28,6 +28,7 @@ at a given location to a requesting customer in one or more appointment segments | `location_type` | [`str (Business Appointment Settings Booking Location Type)`](../../doc/models/business-appointment-settings-booking-location-type.md) | Optional | Supported types of location where service is provided. | | `creator_details` | [`Booking Creator Details`](../../doc/models/booking-creator-details.md) | Optional | Information about a booking creator. | | `source` | [`str (Booking Booking Source)`](../../doc/models/booking-booking-source.md) | Optional | Supported sources a booking was created from. | +| `address` | [`Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | ## Example (as JSON) diff --git a/doc/models/customer.md b/doc/models/customer.md index 93445af..559e660 100644 --- a/doc/models/customer.md +++ b/doc/models/customer.md @@ -14,7 +14,7 @@ Represents a Square customer profile in the Customer Directory of a Square selle | `id` | `str` | Optional | A unique Square-assigned ID for the customer profile.

If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers)
or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint. | | `created_at` | `str` | Optional | The timestamp when the customer profile was created, in RFC 3339 format. | | `updated_at` | `str` | Optional | The timestamp when the customer profile was last updated, in RFC 3339 format. | -| `cards` | [`List Card`](../../doc/models/card.md) | Optional | Payment details of the credit, debit, and gift cards stored on file for the customer profile.

DEPRECATED at version 2021-06-16. Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit and debit cards on file)
or [ListGiftCards](api-endpoint:GiftCards-ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter.
For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards). | +| `cards` | [`List Card`](../../doc/models/card.md) | Optional | Payment details of the credit, debit, and gift cards stored on file for the customer profile.

DEPRECATED at version 2021-06-16 and will be RETIRED at version 2024-12-18. Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit and debit cards on file)
or [ListGiftCards](api-endpoint:GiftCards-ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter.
For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards). | | `given_name` | `str` | Optional | The given name (that is, the first name) associated with the customer profile. | | `family_name` | `str` | Optional | The family name (that is, the last name) associated with the customer profile. | | `nickname` | `str` | Optional | A nickname for the customer profile. | diff --git a/doc/models/payment.md b/doc/models/payment.md index f8c6569..d30c4f4 100644 --- a/doc/models/payment.md +++ b/doc/models/payment.md @@ -41,6 +41,7 @@ Represents a payment processed by the Square API. | `team_member_id` | `str` | Optional | An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | | `refund_ids` | `List[str]` | Optional | A list of `refund_id`s identifying refunds for the payment. | | `risk_evaluation` | [`Risk Evaluation`](../../doc/models/risk-evaluation.md) | Optional | Represents fraud risk information for the associated payment.

When you take a payment through Square's Payments API (using the `CreatePayment`
endpoint), Square evaluates it and assigns a risk level to the payment. Sellers
can use this information to determine the course of action (for example,
provide the goods/services or refund the payment). | +| `terminal_checkout_id` | `str` | Optional | An optional ID for a Terminal checkout that is associated with the payment. | | `buyer_email_address` | `str` | Optional | The buyer's email address.
**Constraints**: *Maximum Length*: `255` | | `billing_address` | [`Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | | `shipping_address` | [`Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | diff --git a/doc/models/update-booking-response.md b/doc/models/update-booking-response.md index cc9a563..06500d1 100644 --- a/doc/models/update-booking-response.md +++ b/doc/models/update-booking-response.md @@ -17,6 +17,13 @@ ```json { "booking": { + "address": { + "address_line_1": "1955 Broadway", + "address_line_2": "Suite 600", + "administrative_district_level_1": "CA", + "locality": "Oakland", + "postal_code": "94612" + }, "appointment_segments": [ { "duration_minutes": 60, @@ -30,6 +37,7 @@ "customer_note": "I would like to sit near the window please", "id": "zkras0xv0xwswx", "location_id": "LEQHH0YY8B42M", + "location_type": "CUSTOMER_LOCATION", "seller_note": "", "start_at": "2020-11-26T13:00:00Z", "status": "ACCEPTED", diff --git a/pyproject.toml b/pyproject.toml index c5131c0..f8c17fc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ requires = ["setuptools>=61.0"] [project] name = "squareup" description = "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management." -version = "38.0.0.20240821" +version = "38.1.0.20240919" readme = "README.md" requires-python = ">=3.7" authors = [{name = "Square Developer Platform", email = "developers@squareup.com"}] diff --git a/square/api/base_api.py b/square/api/base_api.py index 6aa0ab7..7816a7c 100644 --- a/square/api/base_api.py +++ b/square/api/base_api.py @@ -22,7 +22,7 @@ class BaseApi(object): @staticmethod def user_agent(): - return 'Square-Python-SDK/38.0.0.20240821 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}' + return 'Square-Python-SDK/38.1.0.20240919 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}' @staticmethod def user_agent_parameters(): diff --git a/square/client.py b/square/client.py index 2700913..c1a8ec4 100644 --- a/square/client.py +++ b/square/client.py @@ -55,11 +55,11 @@ class Client(object): @staticmethod def sdk_version(): - return '38.0.0.20240821' + return '38.1.0.20240919' @staticmethod def square_version(): - return '2024-08-21' + return '2024-09-19' def user_agent_detail(self): return self.config.user_agent_detail @@ -238,7 +238,7 @@ def __init__(self, http_client_instance=None, retry_statuses=None, retry_methods=None, environment='production', custom_url='https://connect.squareup.com', access_token=None, - bearer_auth_credentials=None, square_version='2024-08-21', + bearer_auth_credentials=None, square_version='2024-09-19', additional_headers={}, user_agent_detail='', config=None): self.config = config or Configuration( http_client_instance=http_client_instance, diff --git a/square/configuration.py b/square/configuration.py index 3a0843e..832fd3b 100644 --- a/square/configuration.py +++ b/square/configuration.py @@ -45,7 +45,7 @@ def __init__(self, http_client_instance=None, retry_statuses=None, retry_methods=None, environment='production', custom_url='https://connect.squareup.com', access_token=None, - bearer_auth_credentials=None, square_version='2024-08-21', + bearer_auth_credentials=None, square_version='2024-09-19', additional_headers={}, user_agent_detail=''): if retry_methods is None: retry_methods = ['GET', 'PUT']