Merge pull request #103 from square/release/25.0.0.20221214

Generated PR for Release: 25.0.0.20221214

Author: daphnechiu

doc/api/o-auth.md

@@ -13,6 +13,7 @@ o_auth_api = client.o_auth
 * [Renew Token](../../doc/api/o-auth.md#renew-token)
 * [Revoke Token](../../doc/api/o-auth.md#revoke-token)
 * [Obtain Token](../../doc/api/o-auth.md#obtain-token)
+* [Retrieve Token Status](../../doc/api/o-auth.md#retrieve-token-status)
 
 
 # Renew Token
@@ -186,3 +187,51 @@ elif result.is_error():
     print(result.errors)
 ```
 
+
+# Retrieve Token Status
+
+Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https://developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).
+
+Add the access token to the Authorization header of the request.
+
+__Important:__ The `Authorization` header you provide to this endpoint must have the following format:
+
+```
+Authorization: Bearer ACCESS_TOKEN
+```
+
+where `ACCESS_TOKEN` is a
+[valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-tokens).
+
+If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error.
+
+:information_source: **Note** This endpoint does not require authentication.
+
+```python
+def retrieve_token_status(self,
+                         authorization)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `authorization` | `string` | Header, Required | Client APPLICATION_SECRET |
+
+## Response Type
+
+[`Retrieve Token Status Response`](../../doc/models/retrieve-token-status-response.md)
+
+## Example Usage
+
+```python
+authorization = 'Client CLIENT_SECRET'
+
+result = o_auth_api.retrieve_token_status(authorization)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+

doc/api/order-custom-attributes.md

@@ -91,6 +91,11 @@ def create_order_custom_attribute_definition(self,
 ```python
 body = {}
 body['custom_attribute_definition'] = {}
+body['custom_attribute_definition']['key'] = 'cover-count'
+body['custom_attribute_definition']['name'] = 'Cover count'
+body['custom_attribute_definition']['description'] = 'The number of people seated at a table'
+body['custom_attribute_definition']['visibility'] = 'VISIBILITY_READ_WRITE_VALUES'
+body['idempotency_key'] = 'IDEMPOTENCY_KEY'
 
 result = order_custom_attributes_api.create_order_custom_attribute_definition(body)
 
@@ -204,11 +209,10 @@ def update_order_custom_attribute_definition(self,
 key = 'key0'
 body = {}
 body['custom_attribute_definition'] = {}
-body['custom_attribute_definition']['key'] = 'wayne-test-15'
-body['custom_attribute_definition']['name'] = 'wayne-test-15'
-body['custom_attribute_definition']['description'] = 'updated'
-body['custom_attribute_definition']['visibility'] = 'VISIBILITY_READ_WRITE_VALUES'
-body['custom_attribute_definition']['version'] = 2
+body['custom_attribute_definition']['key'] = 'cover-count'
+body['custom_attribute_definition']['visibility'] = 'VISIBILITY_READ_ONLY'
+body['custom_attribute_definition']['version'] = 1
+body['idempotency_key'] = 'IDEMPOTENCY_KEY'
 
 result = order_custom_attributes_api.update_order_custom_attribute_definition(key, body)
 

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `square_version` | `string` | Square Connect API versions<br>*Default*: `'2022-11-16'` |
+| `square_version` | `string` | Square Connect API versions<br>*Default*: `'2022-12-14'` |
 | `custom_url` | `string` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `'https://connect.squareup.com'` |
 | `environment` | `string` | The API environment. <br> **Default: `production`** |
 | `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
@@ -26,7 +26,7 @@ The API client can be initialized as follows:
 from square.client import Client
 
 client = Client(
-    square_version='2022-11-16',
+    square_version='2022-12-14',
     access_token='AccessToken',
     environment='production',
     custom_url = 'https://connect.squareup.com',)
@@ -52,7 +52,7 @@ import jsonpickle
 from square.client import Client
 
 client = Client(
-    square_version='2022-11-16',
+    square_version='2022-12-14',
     access_token='AccessToken',)
 
 locations_api = client.locations

doc/models/bulk-delete-order-custom-attributes-request.md

@@ -18,17 +18,13 @@ Represents a bulk delete request for one or more order custom attributes.
 ```json
 {
   "values": {
-    "entry-1": {
-      "key": "wayne-test-15",
-      "order_id": "VilxhxZHuWEqDC6GQNgiLNshRMYZY"
+    "cover-count": {
+      "key": "cover-count",
+      "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F"
     },
-    "entry-2": {
-      "key": "wayne-test-13",
-      "order_id": "XNWR6zjcEXWQy6kbsIsQRTxS0wOZY"
-    },
-    "entry-3": {
-      "key": "ca-key5",
-      "order_id": "9QC9RohBVxfsaSOtYjY7KhmjqrLZY"
+    "table-number": {
+      "key": "table-number",
+      "order_id": "7BbXGEIWNldxAzrtGf9GPVZTwZ4F"
     }
   }
 }

doc/models/bulk-delete-order-custom-attributes-response.md

@@ -19,9 +19,8 @@ Represents a response from deleting one or more order custom attributes.
 ```json
 {
   "values": {
-    "entry-1": {},
-    "entry-2": {},
-    "entry-3": {}
+    "cover-count": {},
+    "table-number": {}
   }
 }
 ```

doc/models/create-order-custom-attribute-definition-request.md

@@ -19,14 +19,13 @@ Represents a create request for an order custom attribute definition.
 ```json
 {
   "custom_attribute_definition": {
-    "key": null,
+    "description": "The number of people seated at a table",
+    "key": "cover-count",
+    "name": "Cover count",
     "schema": null,
-    "name": null,
-    "description": null,
-    "visibility": null,
-    "version": null
+    "visibility": "VISIBILITY_READ_WRITE_VALUES"
   },
-  "idempotency_key": null
+  "idempotency_key": "IDEMPOTENCY_KEY"
 }
 ```
 

doc/models/create-order-custom-attribute-definition-response.md

@@ -19,12 +19,12 @@ Represents a response from creating an order custom attribute definition.
 ```json
 {
   "custom_attribute_definition": {
-    "created_at": "2022-11-10T18:04:57.039Z",
-    "description": "wayne test",
-    "key": "wayne-test-16",
-    "name": "wayne-test",
+    "created_at": "2022-10-06T16:53:23.141Z",
+    "description": "The number of people seated at a table",
+    "key": "cover-count",
+    "name": "Cover count",
     "schema": null,
-    "updated_at": "2022-11-10T18:04:57.039Z",
+    "updated_at": "2022-10-06T16:53:23.141Z",
     "version": 1,
     "visibility": "VISIBILITY_READ_WRITE_VALUES"
   }

doc/models/customer-filter.md

@@ -1,8 +1,8 @@
 
 # Customer Filter
 
-Represents a set of `CustomerQuery` filters used to limit the set of
-customers returned by the [SearchCustomers](../../doc/api/customers.md#search-customers) endpoint.
+Represents the filtering criteria in a [search query](../../doc/models/customer-query.md) that defines how to filter
+customer profiles returned in [SearchCustomers](../../doc/api/customers.md#search-customers) results.
 
 ## Structure
 
@@ -20,6 +20,7 @@ customers returned by the [SearchCustomers](../../doc/api/customers.md#search-cu
 | `reference_id` | [`Customer Text Filter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of<br>customer attributes against a specified query. Depending on the customer attributes,<br>the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. |
 | `group_ids` | [`Filter Value`](../../doc/models/filter-value.md) | Optional | A filter to select resources based on an exact field value. For any given<br>value, the value can only be in one property. Depending on the field, either<br>all properties can be set or only a subset will be available.<br><br>Refer to the documentation of the field. |
 | `custom_attribute` | [`Customer Custom Attribute Filters`](../../doc/models/customer-custom-attribute-filters.md) | Optional | The custom attribute filters in a set of [customer filters](../../doc/models/customer-filter.md) used in a search query. Use this filter<br>to search based on [custom attributes](../../doc/models/custom-attribute.md) that are assigned to customer profiles. For more information, see<br>[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). |
+| `segment_ids` | [`Filter Value`](../../doc/models/filter-value.md) | Optional | A filter to select resources based on an exact field value. For any given<br>value, the value can only be in one property. Depending on the field, either<br>all properties can be set or only a subset will be available.<br><br>Refer to the documentation of the field. |
 
 ## Example (as JSON)
 
@@ -32,7 +33,8 @@ customers returned by the [SearchCustomers](../../doc/api/customers.md#search-cu
   "phone_number": null,
   "reference_id": null,
   "group_ids": null,
-  "custom_attribute": null
+  "custom_attribute": null,
+  "segment_ids": null
 }
 ```
 

doc/models/customer-query.md

@@ -1,8 +1,7 @@
 
 # Customer Query
 
-Represents a query (including filtering criteria, sorting criteria, or both) used to search
-for customer profiles.
+Represents filtering and sorting criteria for a [SearchCustomers](../../doc/api/customers.md#search-customers) request.
 
 ## Structure
 
@@ -12,8 +11,8 @@ for customer profiles.
 
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `filter` | [`Customer Filter`](../../doc/models/customer-filter.md) | Optional | Represents a set of `CustomerQuery` filters used to limit the set of<br>customers returned by the [SearchCustomers](../../doc/api/customers.md#search-customers) endpoint. |
-| `sort` | [`Customer Sort`](../../doc/models/customer-sort.md) | Optional | Specifies how searched customers profiles are sorted, including the sort key and sort order. |
+| `filter` | [`Customer Filter`](../../doc/models/customer-filter.md) | Optional | Represents the filtering criteria in a [search query](../../doc/models/customer-query.md) that defines how to filter<br>customer profiles returned in [SearchCustomers](../../doc/api/customers.md#search-customers) results. |
+| `sort` | [`Customer Sort`](../../doc/models/customer-sort.md) | Optional | Represents the sorting criteria in a [search query](../../doc/models/customer-query.md) that defines how to sort<br>customer profiles returned in [SearchCustomers](../../doc/api/customers.md#search-customers) results. |
 
 ## Example (as JSON)
 

doc/models/customer-sort.md

@@ -1,7 +1,8 @@
 
 # Customer Sort
 
-Specifies how searched customers profiles are sorted, including the sort key and sort order.
+Represents the sorting criteria in a [search query](../../doc/models/customer-query.md) that defines how to sort
+customer profiles returned in [SearchCustomers](../../doc/api/customers.md#search-customers) results.
 
 ## Structure