diff --git a/doc/api/catalog.md b/doc/api/catalog.md
index fa333323..f968deb1 100644
--- a/doc/api/catalog.md
+++ b/doc/api/catalog.md
@@ -100,6 +100,7 @@ body = {}
body['object_ids'] = ['W62UWFY35CWMYGVWK6TWJDNI', 'AA27W3M2GGTF3H6AVPNB77CK']
body['include_related_objects'] = True
body['catalog_version'] = 118
+body['include_deleted_objects'] = False
result = catalog_api.batch_retrieve_catalog_objects(body)
diff --git a/doc/api/locations.md b/doc/api/locations.md
index 423333e5..7130522c 100644
--- a/doc/api/locations.md
+++ b/doc/api/locations.md
@@ -45,10 +45,10 @@ elif result.is_error():
Creates a [location](https://developer.squareup.com/docs/locations-api).
Creating new locations allows for separate configuration of receipt layouts, item prices,
-and sales reports. Developers can use locations to separate sales activity via applications
+and sales reports. Developers can use locations to separate sales activity through applications
that integrate with Square from sales activity elsewhere in a seller's account.
-Locations created programmatically with the Locations API will last forever and
-are visible to the seller for their own management, so ensure that
+Locations created programmatically with the Locations API last forever and
+are visible to the seller for their own management. Therefore, ensure that
each location has a sensible and unique name.
```python
diff --git a/doc/api/orders.md b/doc/api/orders.md
index 89326c5e..d3f680b1 100644
--- a/doc/api/orders.md
+++ b/doc/api/orders.md
@@ -105,9 +105,7 @@ body['order']['line_items'][1]['modifiers'][0]['uid'] = 'uid1'
body['order']['line_items'][1]['modifiers'][0]['catalog_object_id'] = 'CHQX7Y4KY6N5KINJKZCFURPZ'
body['order']['line_items'][1]['modifiers'][0]['catalog_version'] = 69
body['order']['line_items'][1]['modifiers'][0]['name'] = 'name1'
-body['order']['line_items'][1]['modifiers'][0]['base_price_money'] = {}
-body['order']['line_items'][1]['modifiers'][0]['base_price_money']['amount'] = 53
-body['order']['line_items'][1]['modifiers'][0]['base_price_money']['currency'] = 'TTD'
+body['order']['line_items'][1]['modifiers'][0]['quantity'] = 'quantity7'
body['order']['line_items'][1]['applied_discounts'] = []
@@ -579,7 +577,7 @@ To be used with `PayOrder`, a payment must:
- Reference the order by specifying the `order_id` when [creating the payment](../../doc/api/payments.md#create-payment).
Any approved payments that reference the same `order_id` not specified in the
`payment_ids` is canceled.
-- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments#delayed-capture).
+- Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).
Using a delayed capture payment with `PayOrder` completes the approved payment.
```python
diff --git a/doc/api/payouts.md b/doc/api/payouts.md
new file mode 100644
index 00000000..548d05df
--- /dev/null
+++ b/doc/api/payouts.md
@@ -0,0 +1,146 @@
+# Payouts
+
+```python
+payouts_api = client.payouts
+```
+
+## Class Name
+
+`PayoutsApi`
+
+## Methods
+
+* [List Payouts](../../doc/api/payouts.md#list-payouts)
+* [Get Payout](../../doc/api/payouts.md#get-payout)
+* [List Payout Entries](../../doc/api/payouts.md#list-payout-entries)
+
+
+# List Payouts
+
+Retrieves a list of all payouts for the default location.
+You can filter payouts by location ID, status, time range, and order them in ascending or descending order.
+To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+
+```python
+def list_payouts(self,
+ location_id=None,
+ status=None,
+ begin_time=None,
+ end_time=None,
+ sort_order=None,
+ cursor=None,
+ limit=None)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `location_id` | `string` | Query, Optional | The ID of the location for which to list the payouts.
By default, payouts are returned for the default (main) location associated with the seller. |
+| `status` | [`str (Payout Status)`](../../doc/models/payout-status.md) | Query, Optional | If provided, only payouts with the given status are returned. |
+| `begin_time` | `string` | Query, Optional | The timestamp for the beginning of the payout creation time, in RFC 3339 format.
Inclusive. Default: The current time minus one year. |
+| `end_time` | `string` | Query, Optional | The timestamp for the end of the payout creation time, in RFC 3339 format.
Default: The current time. |
+| `sort_order` | [`str (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | The order in which payouts are listed. |
+| `cursor` | `string` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. |
+| `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` |
+
+## Response Type
+
+[`List Payouts Response`](../../doc/models/list-payouts-response.md)
+
+## Example Usage
+
+```python
+location_id = 'location_id4'
+status = 'PAID'
+begin_time = 'begin_time2'
+end_time = 'end_time2'
+sort_order = 'DESC'
+cursor = 'cursor6'
+limit = 172
+
+result = payouts_api.list_payouts(location_id, status, begin_time, end_time, sort_order, cursor, limit)
+
+if result.is_success():
+ print(result.body)
+elif result.is_error():
+ print(result.errors)
+```
+
+
+# Get Payout
+
+Retrieves details of a specific payout identified by a payout ID.
+To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+
+```python
+def get_payout(self,
+ payout_id)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payout_id` | `string` | Template, Required | The ID of the payout to retrieve the information for. |
+
+## Response Type
+
+[`Get Payout Response`](../../doc/models/get-payout-response.md)
+
+## Example Usage
+
+```python
+payout_id = 'payout_id6'
+
+result = payouts_api.get_payout(payout_id)
+
+if result.is_success():
+ print(result.body)
+elif result.is_error():
+ print(result.errors)
+```
+
+
+# List Payout Entries
+
+Retrieves a list of all payout entries for a specific payout.
+To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+
+```python
+def list_payout_entries(self,
+ payout_id,
+ sort_order=None,
+ cursor=None,
+ limit=None)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payout_id` | `string` | Template, Required | The ID of the payout to retrieve the information for. |
+| `sort_order` | [`str (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | The order in which payout entries are listed. |
+| `cursor` | `string` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. |
+| `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` |
+
+## Response Type
+
+[`List Payout Entries Response`](../../doc/models/list-payout-entries-response.md)
+
+## Example Usage
+
+```python
+payout_id = 'payout_id6'
+sort_order = 'DESC'
+cursor = 'cursor6'
+limit = 172
+
+result = payouts_api.list_payout_entries(payout_id, sort_order, cursor, limit)
+
+if result.is_success():
+ print(result.body)
+elif result.is_error():
+ print(result.errors)
+```
+
diff --git a/doc/api/subscriptions.md b/doc/api/subscriptions.md
index f3b1fa6a..9c895f14 100644
--- a/doc/api/subscriptions.md
+++ b/doc/api/subscriptions.md
@@ -289,7 +289,6 @@ elif result.is_error():
# List Subscription Events
Lists all events for a specific subscription.
-In the current implementation, only `START_SUBSCRIPTION` and `STOP_SUBSCRIPTION` (when the subscription was canceled) events are returned.
```python
def list_subscription_events(self,
diff --git a/doc/api/terminal.md b/doc/api/terminal.md
index e723ebda..0add0466 100644
--- a/doc/api/terminal.md
+++ b/doc/api/terminal.md
@@ -55,6 +55,7 @@ body['checkout']['note'] = 'A brief note'
body['checkout']['device_options'] = {}
body['checkout']['device_options']['device_id'] = 'dbb5d83a-7838-11ea-bc55-0242ac130003'
body['checkout']['device_options']['skip_receipt_screen'] = False
+body['checkout']['device_options']['collect_signature'] = False
body['checkout']['device_options']['tip_settings'] = {}
body['checkout']['device_options']['tip_settings']['allow_tipping'] = False
body['checkout']['device_options']['tip_settings']['separate_tip_screen'] = False
@@ -75,7 +76,7 @@ elif result.is_error():
# Search Terminal Checkouts
-Retrieves a filtered list of Terminal checkout requests created by the account making the request.
+Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.
```python
def search_terminal_checkouts(self,
@@ -119,7 +120,7 @@ elif result.is_error():
# Get Terminal Checkout
-Retrieves a Terminal checkout request by `checkout_id`.
+Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days.
```python
def get_terminal_checkout(self,
@@ -185,7 +186,7 @@ elif result.is_error():
# Create Terminal Refund
-Creates a request to refund an Interac payment completed on a Square Terminal.
+Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](../../doc/api/refunds.md).
```python
def create_terminal_refund(self,
@@ -217,6 +218,8 @@ body['refund']['amount_money']['amount'] = 111
body['refund']['amount_money']['currency'] = 'CAD'
body['refund']['reason'] = 'Returning items'
body['refund']['device_id'] = 'f72dfb8e-4d65-4e56-aade-ec3fb8d33291'
+body['refund']['deadline_duration'] = 'deadline_duration6'
+body['refund']['status'] = 'status6'
result = terminal_api.create_terminal_refund(body)
@@ -229,7 +232,7 @@ elif result.is_error():
# Search Terminal Refunds
-Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.
+Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days.
```python
def search_terminal_refunds(self,
@@ -273,7 +276,7 @@ elif result.is_error():
# Get Terminal Refund
-Retrieves an Interac Terminal refund object by ID.
+Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.
```python
def get_terminal_refund(self,
diff --git a/doc/client.md b/doc/client.md
index 5c4f63fc..f5f4f4b2 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` | `string` | Square Connect API versions
*Default*: `'2022-03-16'` |
+| `square_version` | `string` | Square Connect API versions
*Default*: `'2022-04-20'` |
| `custom_url` | `string` | 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 |
@@ -26,7 +26,7 @@ The API client can be initialized as follows:
from square.client import Client
client = Client(
- square_version='2022-03-16',
+ square_version='2022-04-20',
access_token='AccessToken',
environment='production',
custom_url = 'https://connect.squareup.com',)
@@ -51,7 +51,7 @@ API calls return an `ApiResponse` object that includes the following fields:
from square.client import Client
client = Client(
- square_version='2022-03-16',
+ square_version='2022-04-20',
access_token='AccessToken',)
locations_api = client.locations
@@ -98,6 +98,7 @@ The gateway for the SDK. This class acts as a factory for the Apis and also hold
| merchants | Gets MerchantsApi |
| orders | Gets OrdersApi |
| payments | Gets PaymentsApi |
+| payouts | Gets PayoutsApi |
| refunds | Gets RefundsApi |
| sites | Gets SitesApi |
| snippets | Gets SnippetsApi |
diff --git a/doc/models/activity-type.md b/doc/models/activity-type.md
new file mode 100644
index 00000000..a8d231a9
--- /dev/null
+++ b/doc/models/activity-type.md
@@ -0,0 +1,46 @@
+
+# Activity Type
+
+## Enumeration
+
+`Activity Type`
+
+## Fields
+
+| Name | Description |
+| --- | --- |
+| `ADJUSTMENT` | A manual adjustment applied to the seller's account by Square. |
+| `APP_FEE_REFUND` | A refund for an application fee on a payment. |
+| `APP_FEE_REVENUE` | Revenue generated from an application fee on a payment. |
+| `AUTOMATIC_SAVINGS` | An automatic transfer from the payment processing balance to the Square Savings account.
These are, generally, proportional to the seller's sales. |
+| `AUTOMATIC_SAVINGS_REVERSED` | An automatic transfer from the Square Savings account back to the processing balance.
These are, generally, proportional to the seller's refunds. |
+| `CHARGE` | A credit card payment capture. |
+| `DEPOSIT_FEE` | Any fees involved with deposits such as instant deposits. |
+| `DISPUTE` | The balance change due to a dispute event. |
+| `ESCHEATMENT` | An escheatment entry for remittance. |
+| `FEE` | The Square processing fee. |
+| `FREE_PROCESSING` | Square offers free payments processing for a variety of business scenarios, including seller
referrals or when Square wants to apologize (for example, for a bug, customer service, or repricing complication).
This entry represents a credit to the seller for the purposes of free processing. |
+| `HOLD_ADJUSTMENT` | An adjustment made by Square related to holding a payment. |
+| `INITIAL_BALANCE_CHANGE` | An external change to a seller's balance. Initial, in the sense that it
causes the creation of the other activity types, such as hold and refund. |
+| `MONEY_TRANSFER` | The balance change from a money transfer. |
+| `MONEY_TRANSFER_REVERSAL` | The reversal of a money transfer. |
+| `OPEN_DISPUTE` | The balance change for a chargeback that has been filed. |
+| `OTHER` | Any other type that does not belong in the rest of the types. |
+| `OTHER_ADJUSTMENT` | Any other type of adjustment that does not fall under existing types. |
+| `PAID_SERVICE_FEE` | A fee paid to a third-party merchant. |
+| `PAID_SERVICE_FEE_REFUND` | A fee paid to a third-party merchant. |
+| `REDEMPTION_CODE` | Repayment for a redemption code. |
+| `REFUND` | A refund for an existing card payment. |
+| `RELEASE_ADJUSTMENT` | An adjustment made by Square related to releasing a payment. |
+| `RESERVE_HOLD` | Fees paid for funding risk reserve. |
+| `RESERVE_RELEASE` | Fees released from risk reserve. |
+| `RETURNED_PAYOUT` | An entry created when Square receives a response for the ACH file that Square sent indicating that the
settlement of the original entry failed. |
+| `SQUARE_CAPITAL_PAYMENT` | A capital merchant cash advance (MCA) assessment. These are, generally,
proportional to the merchant's sales but can be issued for other reasons related to the MCA. |
+| `SQUARE_CAPITAL_REVERSED_PAYMENT` | A capital merchant cash advance (MCA) assessment refund. These are, generally,
proportional to the merchant's refunds but can be issued for other reasons related to the MCA. |
+| `SUBSCRIPTION_FEE` | A fee charged for subscription to a Square product. |
+| `SUBSCRIPTION_FEE_PAID_REFUND` | A Square subscription fee that has been refunded. |
+| `SUBSCRIPTION_FEE_REFUND` | The refund of a previously charged Square product subscription fee. |
+| `TAX_ON_FEE` | The tax paid on fee amounts. |
+| `THIRD_PARTY_FEE` | Fees collected by a third-party platform. |
+| `THIRD_PARTY_FEE_REFUND` | Refunded fees from a third-party platform. |
+
diff --git a/doc/models/batch-retrieve-catalog-objects-request.md b/doc/models/batch-retrieve-catalog-objects-request.md
index 60dc0923..77cfdfeb 100644
--- a/doc/models/batch-retrieve-catalog-objects-request.md
+++ b/doc/models/batch-retrieve-catalog-objects-request.md
@@ -12,6 +12,7 @@
| `object_ids` | `List of string` | Required | The IDs of the CatalogObjects to be retrieved. |
| `include_related_objects` | `bool` | 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` |
| `catalog_version` | `long\|int` | Optional | The specific version of the catalog objects to be included in the response.
This allows you to retrieve historical versions of objects. The specified version value is matched against
the [CatalogObject](../../doc/models/catalog-object.md)s' `version` attribute. If not included, results will
be from the current version of the catalog. |
+| `include_deleted_objects` | `bool` | Optional | Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`. |
## Example (as JSON)
diff --git a/doc/models/bulk-create-vendors-request.md b/doc/models/bulk-create-vendors-request.md
index 709e3a12..871d3a9d 100644
--- a/doc/models/bulk-create-vendors-request.md
+++ b/doc/models/bulk-create-vendors-request.md
@@ -1,7 +1,7 @@
# Bulk Create Vendors Request
-Represents an input to a call to [BulkCreateVendors.](../../doc/api/vendors.md#bulk-create-vendors)
+Represents an input to a call to [BulkCreateVendors](../../doc/api/vendors.md#bulk-create-vendors).
## Structure
@@ -11,7 +11,7 @@ Represents an input to a call to [BulkCreateVendors.](../../doc/api/vendors.md#b
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `vendors` | [`Dict`](../../doc/models/vendor.md) | Required | Specifies a set of new [Vendor](entity:Vendor] objects as represented by a collection of idempotency-key/`Vendor`-object pairs. |
+| `vendors` | [`Dict`](../../doc/models/vendor.md) | Required | Specifies a set of new [Vendor](../../doc/models/vendor.md) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. |
## Example (as JSON)
diff --git a/doc/models/bulk-create-vendors-response.md b/doc/models/bulk-create-vendors-response.md
index 296caa3c..31b1753a 100644
--- a/doc/models/bulk-create-vendors-response.md
+++ b/doc/models/bulk-create-vendors-response.md
@@ -1,7 +1,7 @@
# Bulk Create Vendors Response
-Represents an output from a call to [BulkCreateVendors.](../../doc/api/vendors.md#bulk-create-vendors)
+Represents an output from a call to [BulkCreateVendors](../../doc/api/vendors.md#bulk-create-vendors).
## Structure
@@ -12,7 +12,7 @@ Represents an output from a call to [BulkCreateVendors.](../../doc/api/vendors.m
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. |
-| `responses` | [`Dict`](../../doc/models/create-vendor-response.md) | Optional | A set of [CreateVendorResponse](../../doc/models/create-vendor-response.md) objects encapsulating successfully created [Vendor](../../doc/models/vendor.md)
objects or error responses for failed attempts. The set is represented by
a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The impotency keys correspond to those specified
in the input. |
+| `responses` | [`Dict`](../../doc/models/create-vendor-response.md) | Optional | A set of [CreateVendorResponse](../../doc/models/create-vendor-response.md) objects encapsulating successfully created [Vendor](../../doc/models/vendor.md)
objects or error responses for failed attempts. The set is represented by
a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified
in the input. |
## Example (as JSON)
diff --git a/doc/models/bulk-retrieve-vendors-request.md b/doc/models/bulk-retrieve-vendors-request.md
index df89ce6f..d78b88d6 100644
--- a/doc/models/bulk-retrieve-vendors-request.md
+++ b/doc/models/bulk-retrieve-vendors-request.md
@@ -1,7 +1,7 @@
# Bulk Retrieve Vendors Request
-Represents an input to a call to [BulkRetrieveVendors.](../../doc/api/vendors.md#bulk-retrieve-vendors)
+Represents an input to a call to [BulkRetrieveVendors](../../doc/api/vendors.md#bulk-retrieve-vendors).
## Structure
diff --git a/doc/models/bulk-retrieve-vendors-response.md b/doc/models/bulk-retrieve-vendors-response.md
index 9b887bce..77d906dc 100644
--- a/doc/models/bulk-retrieve-vendors-response.md
+++ b/doc/models/bulk-retrieve-vendors-response.md
@@ -1,7 +1,7 @@
# Bulk Retrieve Vendors Response
-Represents an output from a call to [BulkRetrieveVendors.](../../doc/api/vendors.md#bulk-retrieve-vendors)
+Represents an output from a call to [BulkRetrieveVendors](../../doc/api/vendors.md#bulk-retrieve-vendors).
## Structure
diff --git a/doc/models/bulk-update-vendors-request.md b/doc/models/bulk-update-vendors-request.md
index 1f56a680..191245bc 100644
--- a/doc/models/bulk-update-vendors-request.md
+++ b/doc/models/bulk-update-vendors-request.md
@@ -1,7 +1,7 @@
# Bulk Update Vendors Request
-Represents an input to a call to [BulkUpdateVendors.](../../doc/api/vendors.md#bulk-update-vendors)
+Represents an input to a call to [BulkUpdateVendors](../../doc/api/vendors.md#bulk-update-vendors).
## Structure
diff --git a/doc/models/bulk-update-vendors-response.md b/doc/models/bulk-update-vendors-response.md
index f750b19f..9a5031dc 100644
--- a/doc/models/bulk-update-vendors-response.md
+++ b/doc/models/bulk-update-vendors-response.md
@@ -1,7 +1,7 @@
# Bulk Update Vendors Response
-Represents an output from a call to [BulkUpdateVendors.](../../doc/api/vendors.md#bulk-update-vendors)
+Represents an output from a call to [BulkUpdateVendors](../../doc/api/vendors.md#bulk-update-vendors).
## Structure
diff --git a/doc/models/business-hours-period.md b/doc/models/business-hours-period.md
index bb7a6097..97270419 100644
--- a/doc/models/business-hours-period.md
+++ b/doc/models/business-hours-period.md
@@ -12,8 +12,8 @@ Represents a period of time during which a business location is open.
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `day_of_week` | [`str (Day of Week)`](../../doc/models/day-of-week.md) | Optional | Indicates the specific day of the week. |
-| `start_local_time` | `string` | Optional | The start time of a business hours period, specified in local time using partial-time
RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.
Note that the seconds value will always be :00, but it is appended for conformance to the RFC. |
-| `end_local_time` | `string` | Optional | The end time of a business hours period, specified in local time using partial-time
RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.
Note that the seconds value will always be :00, but it is appended for conformance to the RFC. |
+| `start_local_time` | `string` | Optional | The start time of a business hours period, specified in local time using partial-time
RFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.
Note that the seconds value is always :00, but it is appended for conformance to the RFC. |
+| `end_local_time` | `string` | Optional | The end time of a business hours period, specified in local time using partial-time
RFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.
Note that the seconds value is always :00, but it is appended for conformance to the RFC. |
## Example (as JSON)
diff --git a/doc/models/business-hours.md b/doc/models/business-hours.md
index 9682e53c..fa66b149 100644
--- a/doc/models/business-hours.md
+++ b/doc/models/business-hours.md
@@ -11,7 +11,7 @@ The hours of operation for a location.
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `periods` | [`List of Business Hours Period`](../../doc/models/business-hours-period.md) | Optional | The list of time periods during which the business is open. There may be at most 10
periods per day. |
+| `periods` | [`List of Business Hours Period`](../../doc/models/business-hours-period.md) | Optional | The list of time periods during which the business is open. There can be at most 10 periods per day. |
## Example (as JSON)
diff --git a/doc/models/cancel-terminal-checkout-response.md b/doc/models/cancel-terminal-checkout-response.md
index f8d940b4..61be0560 100644
--- a/doc/models/cancel-terminal-checkout-response.md
+++ b/doc/models/cancel-terminal-checkout-response.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
-| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Optional | - |
+| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Optional | Represents a checkout processed by the Square Terminal. |
## Example (as JSON)
diff --git a/doc/models/cancel-terminal-refund-response.md b/doc/models/cancel-terminal-refund-response.md
index cb731a2e..f3e19fa2 100644
--- a/doc/models/cancel-terminal-refund-response.md
+++ b/doc/models/cancel-terminal-refund-response.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
-| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | - |
+| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. |
## Example (as JSON)
diff --git a/doc/models/catalog-item-variation.md b/doc/models/catalog-item-variation.md
index 030dad77..2e9d45c8 100644
--- a/doc/models/catalog-item-variation.md
+++ b/doc/models/catalog-item-variation.md
@@ -28,7 +28,8 @@ may have a maximum of 250 item variations.
| `available_for_booking` | `bool` | Optional | If the `CatalogItem` that owns this item variation is of type
`APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking. |
| `item_option_values` | [`List of Catalog Item Option Value for Item Variation`](../../doc/models/catalog-item-option-value-for-item-variation.md) | Optional | List of item option values associated with this item variation. Listed
in the same order as the item options of the parent item. |
| `measurement_unit_id` | `string` | Optional | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity
sold of this item variation. If left unset, the item will be sold in
whole quantities. |
-| `stockable` | `bool` | Optional | Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE).
For backward compatibility missing values will be interpreted as TRUE. |
+| `sellable` | `bool` | Optional | Whether this variation can be sold. |
+| `stockable` | `bool` | Optional | Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE). |
| `image_ids` | `List of string` | Optional | The IDs of images associated with this `CatalogItemVariation` instance.
These images will be shown to customers in Square Online Store. |
| `team_member_ids` | `List of string` | Optional | Tokens of employees that can perform the service represented by this variation. Only valid for
variations of type `APPOINTMENTS_SERVICE`. |
| `stockable_conversion` | [`Catalog Stock Conversion`](../../doc/models/catalog-stock-conversion.md) | Optional | Represents the rule of conversion between a stockable [CatalogItemVariation](../../doc/models/catalog-item-variation.md)
and a non-stockable sell-by or receive-by `CatalogItemVariation` that
share the same underlying stock. |
diff --git a/doc/models/catalog-modifier.md b/doc/models/catalog-modifier.md
index 193a939a..0531d7d5 100644
--- a/doc/models/catalog-modifier.md
+++ b/doc/models/catalog-modifier.md
@@ -15,6 +15,7 @@ A modifier applicable to items at the time of sale.
| `price_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
| `ordinal` | `int` | Optional | Determines where this `CatalogModifier` appears in the `CatalogModifierList`. |
| `modifier_list_id` | `string` | Optional | The ID of the `CatalogModifierList` associated with this modifier. |
+| `image_ids` | `List of string` | Optional | The IDs of images associated with this `CatalogModifier` instance.
Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications. |
## Example (as JSON)
diff --git a/doc/models/catalog-object.md b/doc/models/catalog-object.md
index 37c3ed8d..1c0fc848 100644
--- a/doc/models/catalog-object.md
+++ b/doc/models/catalog-object.md
@@ -25,7 +25,7 @@ For a more detailed discussion of the Catalog data model, please see the
| `updated_at` | `string` | Optional | Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"`
would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. |
| `version` | `long\|int` | Optional | The version of the object. When updating an object, the version supplied
must match the version in the database, otherwise the write will be rejected as conflicting. |
| `is_deleted` | `bool` | Optional | If `true`, the object has been deleted from the database. Must be `false` for new objects
being inserted. When deleted, the `updated_at` field will equal the deletion time. |
-| `custom_attribute_values` | [`Dict`](../../doc/models/catalog-custom-attribute-value.md) | Optional | A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair
is a [CatalogCustomAttributeValue](../../doc/models/catalog-custom-attribute-value.md) object. The key is the `key` attribute
value defined in the associated [CatalogCustomAttributeDefinition](../../doc/models/catalog-custom-attribute-definition.md)
object defined by the application making the request.
If the `CatalogCustomAttributeDefinition` object is
defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by
the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of
`"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"`
if the application making the request is different from the application defining the custom attribute definition.
Otherwise, the key used in the map is simply `"cocoa_brand"`.
Application-defined custom attributes that are set at a global (location-independent) level.
Custom attribute values are intended to store additional information about a catalog object
or associations with an entity in another system. Do not use custom attributes
to store any sensitive information (personally identifiable information, card details, etc.). |
+| `custom_attribute_values` | [`Dict`](../../doc/models/catalog-custom-attribute-value.md) | Optional | A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair
is a [CatalogCustomAttributeValue](../../doc/models/catalog-custom-attribute-value.md) object. The key is the `key` attribute
value defined in the associated [CatalogCustomAttributeDefinition](../../doc/models/catalog-custom-attribute-definition.md)
object defined by the application making the request.
If the `CatalogCustomAttributeDefinition` object is
defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by
the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of
`"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"`
if the application making the request is different from the application defining the custom attribute definition.
Otherwise, the key used in the map is simply `"cocoa_brand"`.
Application-defined custom attributes are set at a global (location-independent) level.
Custom attribute values are intended to store additional information about a catalog object
or associations with an entity in another system. Do not use custom attributes
to store any sensitive information (personally identifiable information, card details, etc.). |
| `catalog_v1_ids` | [`List of Catalog V1 Id`](../../doc/models/catalog-v1-id.md) | Optional | The Connect v1 IDs for this object at each location where it is present, where they
differ from the object's Connect V2 ID. The field will only be present for objects that
have been created or modified by legacy APIs. |
| `present_at_all_locations` | `bool` | Optional | If `true`, this object is present at all locations (including future locations), except where specified in
the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations),
except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. |
| `present_at_location_ids` | `List of string` | Optional | A list of locations where the object is present, even if `present_at_all_locations` is `false`.
This can include locations that are deactivated. |
diff --git a/doc/models/create-location-request.md b/doc/models/create-location-request.md
index bf5ca56f..d20e87a0 100644
--- a/doc/models/create-location-request.md
+++ b/doc/models/create-location-request.md
@@ -1,7 +1,7 @@
# Create Location Request
-Request object for the [CreateLocation](../../doc/api/locations.md#create-location) endpoint.
+The request object for the [CreateLocation](../../doc/api/locations.md#create-location) endpoint.
## Structure
@@ -11,7 +11,7 @@ Request object for the [CreateLocation](../../doc/api/locations.md#create-locati
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business's [locations](https://developer.squareup.com/docs/locations-api). |
+| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). |
## Example (as JSON)
diff --git a/doc/models/create-location-response.md b/doc/models/create-location-response.md
index dfd1dba8..24b34f7f 100644
--- a/doc/models/create-location-response.md
+++ b/doc/models/create-location-response.md
@@ -1,7 +1,7 @@
# Create Location Response
-Response object returned by the [CreateLocation](../../doc/api/locations.md#create-location) endpoint.
+The response object returned by the [CreateLocation](../../doc/api/locations.md#create-location) endpoint.
## Structure
@@ -11,8 +11,8 @@ Response object returned by the [CreateLocation](../../doc/api/locations.md#crea
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information on [errors](https://developer.squareup.com/docs/build-basics/handling-errors) encountered during the request. |
-| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business's [locations](https://developer.squareup.com/docs/locations-api). |
+| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about [errors](https://developer.squareup.com/docs/build-basics/handling-errors) encountered during the request. |
+| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). |
## Example (as JSON)
diff --git a/doc/models/create-terminal-checkout-request.md b/doc/models/create-terminal-checkout-request.md
index 09cd29e7..d98dae64 100644
--- a/doc/models/create-terminal-checkout-request.md
+++ b/doc/models/create-terminal-checkout-request.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `idempotency_key` | `string` | Required | A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but
must be unique for every `CreateCheckout` request.
See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` |
-| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Required | - |
+| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Required | Represents a checkout processed by the Square Terminal. |
## Example (as JSON)
diff --git a/doc/models/create-terminal-checkout-response.md b/doc/models/create-terminal-checkout-response.md
index 216019c1..f1a21892 100644
--- a/doc/models/create-terminal-checkout-response.md
+++ b/doc/models/create-terminal-checkout-response.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
-| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Optional | - |
+| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Optional | Represents a checkout processed by the Square Terminal. |
## Example (as JSON)
diff --git a/doc/models/create-terminal-refund-request.md b/doc/models/create-terminal-refund-request.md
index 2153c054..1eb54bd5 100644
--- a/doc/models/create-terminal-refund-request.md
+++ b/doc/models/create-terminal-refund-request.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `idempotency_key` | `string` | Required | A unique string that identifies this `CreateRefund` request. Keys can be any valid string but
must be unique for every `CreateRefund` request.
See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` |
-| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | - |
+| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. |
## Example (as JSON)
diff --git a/doc/models/create-terminal-refund-response.md b/doc/models/create-terminal-refund-response.md
index 5b3215f2..6b542a8f 100644
--- a/doc/models/create-terminal-refund-response.md
+++ b/doc/models/create-terminal-refund-response.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
-| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | - |
+| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. |
## Example (as JSON)
diff --git a/doc/models/create-vendor-request.md b/doc/models/create-vendor-request.md
index 5e78ab9b..f3c59d6a 100644
--- a/doc/models/create-vendor-request.md
+++ b/doc/models/create-vendor-request.md
@@ -1,7 +1,7 @@
# Create Vendor Request
-Represents an input to a call to [CreateVendor.](../../doc/api/vendors.md#create-vendor)
+Represents an input to a call to [CreateVendor](../../doc/api/vendors.md#create-vendor).
## Structure
diff --git a/doc/models/create-vendor-response.md b/doc/models/create-vendor-response.md
index e948def5..77b0a627 100644
--- a/doc/models/create-vendor-response.md
+++ b/doc/models/create-vendor-response.md
@@ -1,7 +1,7 @@
# Create Vendor Response
-Represents an output from a call to [CreateVendor.](../../doc/api/vendors.md#create-vendor)
+Represents an output from a call to [CreateVendor](../../doc/api/vendors.md#create-vendor).
## Structure
@@ -21,19 +21,19 @@ Represents an output from a call to [CreateVendor.](../../doc/api/vendors.md#cre
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/destination-type.md b/doc/models/destination-type.md
new file mode 100644
index 00000000..cb5e55cc
--- /dev/null
+++ b/doc/models/destination-type.md
@@ -0,0 +1,18 @@
+
+# Destination Type
+
+List of possible destinations against which a payout can be made.
+
+## Enumeration
+
+`Destination Type`
+
+## Fields
+
+| Name | Description |
+| --- | --- |
+| `BANK_ACCOUNT` | An external bank account outside of Square. |
+| `CARD` | An external card outside of Square used for the transfer. |
+| `SQUARE_BALANCE` | |
+| `SQUARE_STORED_BALANCE` | Square Checking or Savings account (US), Square Card (CA), Square Current account (UK),
Square Compte Courant (FR), Cuenta Corriente Square (ES) |
+
diff --git a/doc/models/destination.md b/doc/models/destination.md
new file mode 100644
index 00000000..954f8f85
--- /dev/null
+++ b/doc/models/destination.md
@@ -0,0 +1,25 @@
+
+# Destination
+
+Information about the destination against which the payout was made.
+
+## Structure
+
+`Destination`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `type` | [`str (Destination Type)`](../../doc/models/destination-type.md) | Optional | List of possible destinations against which a payout can be made. |
+| `id` | `string` | Optional | Square issued unique ID (also known as the instrument ID) associated with this destination. |
+
+## Example (as JSON)
+
+```json
+{
+ "type": "SQUARE_BALANCE",
+ "id": "id0"
+}
+```
+
diff --git a/doc/models/device-checkout-options.md b/doc/models/device-checkout-options.md
index d61474b5..a3dc9855 100644
--- a/doc/models/device-checkout-options.md
+++ b/doc/models/device-checkout-options.md
@@ -11,6 +11,7 @@
| --- | --- | --- | --- |
| `device_id` | `string` | Required | The unique ID of the device intended for this `TerminalCheckout`.
A list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint.
Match a `DeviceCode.device_id` value with `device_id` to get the associated device code. |
| `skip_receipt_screen` | `bool` | Optional | Instructs the device to skip the receipt screen. Defaults to false. |
+| `collect_signature` | `bool` | Optional | Indicates that signature collection is desired during checkout. Defaults to false. |
| `tip_settings` | [`Tip Settings`](../../doc/models/tip-settings.md) | Optional | - |
## Example (as JSON)
@@ -19,6 +20,7 @@
{
"device_id": "device_id6",
"skip_receipt_screen": false,
+ "collect_signature": false,
"tip_settings": {
"allow_tipping": false,
"separate_tip_screen": false,
diff --git a/doc/models/error-code.md b/doc/models/error-code.md
index 103389e0..a9a75728 100644
--- a/doc/models/error-code.md
+++ b/doc/models/error-code.md
@@ -133,6 +133,7 @@ Square API.
| `CHIP_INSERTION_REQUIRED` | The card issuer requires that the card be read
using a chip reader. |
| `ALLOWABLE_PIN_TRIES_EXCEEDED` | The card has exhausted its available pin entry
retries set by the card issuer. Resolving the error typically requires the
card holder to contact the card issuer. |
| `RESERVATION_DECLINED` | The card issuer declined the refund. |
+| `UNKNOWN_BODY_PARAMETER` | The body parameter is not recognized by the requested endpoint. |
| `NOT_FOUND` | Not Found - a general error occurred. |
| `APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND` | Square could not find the associated Apple Pay certificate. |
| `METHOD_NOT_ALLOWED` | Method Not Allowed - a general error occurred. |
diff --git a/doc/models/error.md b/doc/models/error.md
index 29c2594e..bdc95adb 100644
--- a/doc/models/error.md
+++ b/doc/models/error.md
@@ -23,7 +23,7 @@ See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-
```json
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_EXPIRATION_DATE",
+ "code": "ACCESS_TOKEN_EXPIRED",
"detail": "detail6",
"field": "field6"
}
diff --git a/doc/models/get-payout-response.md b/doc/models/get-payout-response.md
new file mode 100644
index 00000000..c5848b3f
--- /dev/null
+++ b/doc/models/get-payout-response.md
@@ -0,0 +1,39 @@
+
+# Get Payout Response
+
+## Structure
+
+`Get Payout Response`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payout` | [`Payout`](../../doc/models/payout.md) | Optional | An accounting of the amount owed the seller and record of the actual transfer to their
external bank account or to the Square balance. |
+| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
+
+## Example (as JSON)
+
+```json
+{
+ "payout": {
+ "amount_money": {
+ "amount": -103,
+ "currency_code": "USD"
+ },
+ "arrival_date": "2022-03-24",
+ "created_at": "2022-03-24T03:07:09Z",
+ "destination": {
+ "id": "bact:ZPp3oedR3AeEUNd3z7",
+ "type": "BANK_ACCOUNT"
+ },
+ "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45",
+ "location_id": "L88917AVBK2S5",
+ "status": "PAID",
+ "type": "BATCH",
+ "updated_at": "2022-03-24T03:07:09Z",
+ "version": 1
+ }
+}
+```
+
diff --git a/doc/models/get-terminal-checkout-response.md b/doc/models/get-terminal-checkout-response.md
index bd74dd06..d4f1bf8e 100644
--- a/doc/models/get-terminal-checkout-response.md
+++ b/doc/models/get-terminal-checkout-response.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
-| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Optional | - |
+| `checkout` | [`Terminal Checkout`](../../doc/models/terminal-checkout.md) | Optional | Represents a checkout processed by the Square Terminal. |
## Example (as JSON)
diff --git a/doc/models/get-terminal-refund-response.md b/doc/models/get-terminal-refund-response.md
index 6ba57bc9..19d26b36 100644
--- a/doc/models/get-terminal-refund-response.md
+++ b/doc/models/get-terminal-refund-response.md
@@ -10,7 +10,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
-| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | - |
+| `refund` | [`Terminal Refund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. |
## Example (as JSON)
diff --git a/doc/models/inventory-adjustment.md b/doc/models/inventory-adjustment.md
index 38a58d6a..26262dad 100644
--- a/doc/models/inventory-adjustment.md
+++ b/doc/models/inventory-adjustment.md
@@ -26,8 +26,8 @@ particular time and location.
| `source` | [`Source Application`](../../doc/models/source-application.md) | Optional | Provides information about the application used to generate a change. |
| `employee_id` | `string` | Optional | The Square-generated ID of the [Employee](../../doc/models/employee.md) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` |
| `team_member_id` | `string` | Optional | The Square-generated ID of the [Team Member](../../doc/models/team-member.md) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` |
-| `transaction_id` | `string` | Optional | The Square-generated ID of the [Transaction][#type-transaction] that
caused the adjustment. Only relevant for payment-related state
transitions.
**Constraints**: *Maximum Length*: `255` |
-| `refund_id` | `string` | Optional | The Square-generated ID of the [Refund][#type-refund] that
caused the adjustment. Only relevant for refund-related state
transitions.
**Constraints**: *Maximum Length*: `255` |
+| `transaction_id` | `string` | Optional | The Square-generated ID of the [Transaction](../../doc/models/transaction.md) that
caused the adjustment. Only relevant for payment-related state
transitions.
**Constraints**: *Maximum Length*: `255` |
+| `refund_id` | `string` | Optional | The Square-generated ID of the [Refund](../../doc/models/refund.md) that
caused the adjustment. Only relevant for refund-related state
transitions.
**Constraints**: *Maximum Length*: `255` |
| `purchase_order_id` | `string` | Optional | The Square-generated ID of the purchase order that caused the
adjustment. Only relevant for state transitions from the Square for Retail
app.
**Constraints**: *Maximum Length*: `100` |
| `goods_receipt_id` | `string` | Optional | The Square-generated ID of the goods receipt that caused the
adjustment. Only relevant for state transitions from the Square for Retail
app.
**Constraints**: *Maximum Length*: `100` |
| `adjustment_group` | [`Inventory Adjustment Group`](../../doc/models/inventory-adjustment-group.md) | Optional | - |
diff --git a/doc/models/item-variation-location-overrides.md b/doc/models/item-variation-location-overrides.md
index de0b221e..537bc114 100644
--- a/doc/models/item-variation-location-overrides.md
+++ b/doc/models/item-variation-location-overrides.md
@@ -17,6 +17,8 @@ Price and inventory alerting overrides for a `CatalogItemVariation` at a specifi
| `track_inventory` | `bool` | Optional | If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. |
| `inventory_alert_type` | [`str (Inventory Alert Type)`](../../doc/models/inventory-alert-type.md) | Optional | Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low. |
| `inventory_alert_threshold` | `long\|int` | Optional | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type`
is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.
This value is always an integer. |
+| `sold_out` | `bool` | Optional | Indicates whether the overridden item variation is sold out at the specified location.
When inventory tracking is enabled on the item variation either globally or at the specified location,
the item variation is automatically marked as sold out when its inventory count reaches zero. The seller
can manually set the item variation as sold out even when the inventory count is greater than zero.
Attempts by an application to set this attribute are ignored. Regardless how the sold-out status is set,
applications should treat its inventory count as zero when this attribute value is `true`. |
+| `sold_out_valid_until` | `string` | Optional | The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation
becomes available again at the specified location. Attempts by an application to set this attribute are ignored.
When the current time is later than this attribute value, the affected item variation is no longer sold out. |
## Example (as JSON)
diff --git a/doc/models/list-employees-response.md b/doc/models/list-employees-response.md
index 1f72a34d..484a4f62 100644
--- a/doc/models/list-employees-response.md
+++ b/doc/models/list-employees-response.md
@@ -30,19 +30,19 @@
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/list-locations-response.md b/doc/models/list-locations-response.md
index f60e8cc4..16c5b539 100644
--- a/doc/models/list-locations-response.md
+++ b/doc/models/list-locations-response.md
@@ -4,7 +4,7 @@
Defines the fields that are included in the response body of a request
to the [ListLocations](../../doc/api/locations.md#list-locations) endpoint.
-One of `errors` or `locations` is present in a given response (never both).
+Either `errors` or `locations` is present in a given response (never both).
## Structure
diff --git a/doc/models/list-payout-entries-request.md b/doc/models/list-payout-entries-request.md
new file mode 100644
index 00000000..11562acd
--- /dev/null
+++ b/doc/models/list-payout-entries-request.md
@@ -0,0 +1,21 @@
+
+# List Payout Entries Request
+
+## Structure
+
+`List Payout Entries Request`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `sort_order` | [`str (Sort Order)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. |
+| `cursor` | `string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. |
+| `limit` | `int` | 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` |
+
+## Example (as JSON)
+
+```json
+{}
+```
+
diff --git a/doc/models/list-payout-entries-response.md b/doc/models/list-payout-entries-response.md
new file mode 100644
index 00000000..6fc4f518
--- /dev/null
+++ b/doc/models/list-payout-entries-response.md
@@ -0,0 +1,70 @@
+
+# List Payout Entries Response
+
+The response to retrieve payout records entries.
+
+## Structure
+
+`List Payout Entries Response`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payout_entries` | [`List of Payout Entry`](../../doc/models/payout-entry.md) | Optional | The requested list of payout entries, ordered with the given or default sort order. |
+| `cursor` | `string` | Optional | The pagination cursor to be used in a subsequent request. If empty, this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). |
+| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
+
+## Example (as JSON)
+
+```json
+{
+ "cursor": "TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO",
+ "payout_entries": [
+ {
+ "effective_at": "2021-12-14T23:31:49Z",
+ "fee_amount_money": {
+ "amount": -2,
+ "currency_code": "USD"
+ },
+ "gross_amount_money": {
+ "amount": -50,
+ "currency_code": "USD"
+ },
+ "id": "poe_ZQWcw41d0SGJS6IWd4cSi8mKHk",
+ "net_amount_money": {
+ "amount": -48,
+ "currency_code": "USD"
+ },
+ "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
+ "type": "REFUND",
+ "type_refund_details": {
+ "payment_id": "HVdG62HeMlti8YYf94oxrN",
+ "refund_id": "HVdG62HeMlti8YYf94oxrN_dR8Nztxg7umf94oxrN12Ji5r2KW14FAY"
+ }
+ },
+ {
+ "effective_at": "2021-12-14T23:31:49Z",
+ "fee_amount_money": {
+ "amount": 19,
+ "currency_code": "USD"
+ },
+ "gross_amount_money": {
+ "amount": 100,
+ "currency_code": "USD"
+ },
+ "id": "poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk",
+ "net_amount_money": {
+ "amount": 81,
+ "currency_code": "USD"
+ },
+ "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
+ "type": "CHARGE",
+ "type_charge_details": {
+ "payment_id": "HVdG62H5K3291d0SGJS6IWd4cSi8YY"
+ }
+ }
+ ]
+}
+```
+
diff --git a/doc/models/list-payouts-request.md b/doc/models/list-payouts-request.md
new file mode 100644
index 00000000..765d61c4
--- /dev/null
+++ b/doc/models/list-payouts-request.md
@@ -0,0 +1,27 @@
+
+# List Payouts Request
+
+A request to retrieve payout records.
+
+## Structure
+
+`List Payouts Request`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `location_id` | `string` | Optional | The ID of the location for which to list the payouts.
By default, payouts are returned for the default (main) location associated with the seller.
**Constraints**: *Maximum Length*: `255` |
+| `status` | [`str (Payout Status)`](../../doc/models/payout-status.md) | Optional | Payout status types |
+| `begin_time` | `string` | Optional | The timestamp for the beginning of the payout creation time, in RFC 3339 format.
Inclusive. Default: The current time minus one year. |
+| `end_time` | `string` | Optional | The timestamp for the end of the payout creation time, in RFC 3339 format.
Default: The current time. |
+| `sort_order` | [`str (Sort Order)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. |
+| `cursor` | `string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. |
+| `limit` | `int` | 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` |
+
+## Example (as JSON)
+
+```json
+{}
+```
+
diff --git a/doc/models/list-payouts-response.md b/doc/models/list-payouts-response.md
new file mode 100644
index 00000000..29a22bd6
--- /dev/null
+++ b/doc/models/list-payouts-response.md
@@ -0,0 +1,73 @@
+
+# List Payouts Response
+
+The response to retrieve payout records entries.
+
+## Structure
+
+`List Payouts Response`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payouts` | [`List of Payout`](../../doc/models/payout.md) | Optional | The requested list of payouts. |
+| `cursor` | `string` | Optional | The pagination cursor to be used in a subsequent request. If empty, this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). |
+| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
+
+## Example (as JSON)
+
+```json
+{
+ "cursor": "EMPCyStibo64hS8wLayZPp3oedR3AeEUNd3z7u6zphi72LQZFIEMbkKVvot9eefpU",
+ "payouts": [
+ {
+ "amount_money": {
+ "amount": 6259,
+ "currency_code": "USD"
+ },
+ "arrival_date": "2022-03-29",
+ "created_at": "2022-03-29T16:12:31Z",
+ "destination": {
+ "id": "ccof:ZPp3oedR3AeEUNd3z7",
+ "type": "CARD"
+ },
+ "id": "po_b345d2c7-90b3-4f0b-a2aa-df1def7f8afc",
+ "location_id": "L88917AVBK2S5",
+ "payout_fee": [
+ {
+ "amount_money": {
+ "amount": 95,
+ "currency_code": "USD"
+ },
+ "effective_at": "2022-03-29T16:12:31Z",
+ "type": "TRANSFER_FEE"
+ }
+ ],
+ "status": "PAID",
+ "type": "BATCH",
+ "updated_at": "2022-03-30T01:07:22.875Z",
+ "version": 2
+ },
+ {
+ "amount_money": {
+ "amount": -103,
+ "currency_code": "USD"
+ },
+ "arrival_date": "2022-03-24",
+ "created_at": "2022-03-24T03:07:09Z",
+ "destination": {
+ "id": "bact:ZPp3oedR3AeEUNd3z7",
+ "type": "BANK_ACCOUNT"
+ },
+ "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45",
+ "location_id": "L88917AVBK2S5",
+ "status": "PAID",
+ "type": "BATCH",
+ "updated_at": "2022-03-24T03:07:09Z",
+ "version": 1
+ }
+ ]
+}
+```
+
diff --git a/doc/models/list-subscription-events-response.md b/doc/models/list-subscription-events-response.md
index 1b31a285..7e15874f 100644
--- a/doc/models/list-subscription-events-response.md
+++ b/doc/models/list-subscription-events-response.md
@@ -27,6 +27,34 @@ Defines output parameters in a response from the
"plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
"subscription_event_type": "START_SUBSCRIPTION"
},
+ {
+ "effective_date": "2020-05-01",
+ "id": "f2736603-cd2e-47ec-8675-f815fff54f88",
+ "info": {
+ "code": "CUSTOMER_NO_NAME",
+ "detail": "The customer with ID `V74BMG0GPS2KNCWJE1BTYJ37Y0` does not have a name on record."
+ },
+ "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
+ "subscription_event_type": "DEACTIVATE_SUBSCRIPTION"
+ },
+ {
+ "effective_date": "2022-05-01",
+ "id": "b426fc85-6859-450b-b0d0-fe3a5d1b565f",
+ "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
+ "subscription_event_type": "RESUME_SUBSCRIPTION"
+ },
+ {
+ "effective_date": "2022-05-02",
+ "id": "09f14de1-2f53-4dae-9091-49aa53f83d01",
+ "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
+ "subscription_event_type": "PAUSE_SUBSCRIPTION"
+ },
+ {
+ "effective_date": "2020-05-02",
+ "id": "f28a73ac-1a1b-4b0f-8eeb-709a72945776",
+ "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
+ "subscription_event_type": "RESUME_SUBSCRIPTION"
+ },
{
"effective_date": "2020-05-06",
"id": "a0c08083-5db0-4800-85c7-d398de4fbb6e",
diff --git a/doc/models/location-capability.md b/doc/models/location-capability.md
index 11907ce4..ffded11c 100644
--- a/doc/models/location-capability.md
+++ b/doc/models/location-capability.md
@@ -1,7 +1,7 @@
# Location Capability
-The capabilities a location may have.
+The capabilities a location might have.
## Enumeration
diff --git a/doc/models/location.md b/doc/models/location.md
index e80db4b1..02f6718b 100644
--- a/doc/models/location.md
+++ b/doc/models/location.md
@@ -1,7 +1,7 @@
# Location
-Represents one of a business's [locations](https://developer.squareup.com/docs/locations-api).
+Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api).
## Structure
@@ -11,10 +11,10 @@ Represents one of a business's [locations](https://developer.squareup.com/docs/l
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `id` | `string` | Optional | A short, generated string of letters and numbers that uniquely identifies this location instance.
**Constraints**: *Maximum Length*: `32` |
-| `name` | `string` | Optional | The name of the location.
This information appears in the dashboard as the nickname.
A location name must be unique within a seller account.
**Constraints**: *Maximum Length*: `255` |
+| `id` | `string` | Optional | A short generated string of letters and numbers that uniquely identifies this location instance.
**Constraints**: *Maximum Length*: `32` |
+| `name` | `string` | Optional | The name of the location.
This information appears in the Seller Dashboard as the nickname.
A location name must be unique within a seller account.
**Constraints**: *Maximum Length*: `255` |
| `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). |
-| `timezone` | `string` | Optional | The [IANA Timezone](https://www.iana.org/time-zones) identifier for
the timezone of the location. For example, `America/Los_Angeles`.
**Constraints**: *Maximum Length*: `30` |
+| `timezone` | `string` | Optional | The [IANA time zone](https://www.iana.org/time-zones) identifier for
the time zone of the location. For example, `America/Los_Angeles`.
**Constraints**: *Maximum Length*: `30` |
| `capabilities` | [`List of str (Location Capability)`](../../doc/models/location-capability.md) | Optional | The Square features that are enabled for the location.
See [LocationCapability](../../doc/models/location-capability.md) for possible values.
See [LocationCapability](#type-locationcapability) for possible values |
| `status` | [`str (Location Status)`](../../doc/models/location-status.md) | Optional | A location's status. |
| `created_at` | `string` | Optional | The time when the location was created, in RFC 3339 format.
For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).
**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `25` |
@@ -27,16 +27,16 @@ Represents one of a business's [locations](https://developer.squareup.com/docs/l
| `type` | [`str (Location Type)`](../../doc/models/location-type.md) | Optional | A location's type. |
| `website_url` | `string` | Optional | The website URL of the location. For example, `https://squareup.com`.
**Constraints**: *Maximum Length*: `255` |
| `business_hours` | [`Business Hours`](../../doc/models/business-hours.md) | Optional | The hours of operation for a location. |
-| `business_email` | `string` | Optional | The email address of the location. This can be unique to the location, and is not always the email address for the business owner or admin.
**Constraints**: *Maximum Length*: `255` |
+| `business_email` | `string` | Optional | The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.
**Constraints**: *Maximum Length*: `255` |
| `description` | `string` | Optional | The description of the location. For example, `Main Street location`.
**Constraints**: *Maximum Length*: `1024` |
| `twitter_username` | `string` | Optional | The Twitter username of the location without the '@' symbol. For example, `Square`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `15` |
| `instagram_username` | `string` | Optional | The Instagram username of the location without the '@' symbol. For example, `square`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` |
| `facebook_url` | `string` | Optional | The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`.
**Constraints**: *Maximum Length*: `255` |
| `coordinates` | [`Coordinates`](../../doc/models/coordinates.md) | Optional | Latitude and longitude coordinates. |
-| `logo_url` | `string` | Optional | The URL of the logo image for the location. When configured in the Seller
dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices)
that Square generates on behalf of the Seller. This image should have a roughly square (1:1) aspect ratio
and is recommended to be at least 200x200 pixels.
**Constraints**: *Maximum Length*: `255` |
+| `logo_url` | `string` | Optional | The URL of the logo image for the location. When configured in the Seller
Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.
This image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels.
**Constraints**: *Maximum Length*: `255` |
| `pos_background_url` | `string` | Optional | The URL of the Point of Sale background image for the location.
**Constraints**: *Maximum Length*: `255` |
| `mcc` | `string` | Optional | A four-digit number that describes the kind of goods or services sold at the location.
The [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245.
For example, `5045`, for a location that sells computer goods and software.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4` |
-| `full_format_logo_url` | `string` | Optional | The URL of a full-format logo image for the location. When configured in the Seller
dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices)
that Square generates on behalf of the Seller. This image can be wider than it is tall,
and is recommended to be at least 1280x648 pixels. |
+| `full_format_logo_url` | `string` | Optional | The URL of a full-format logo image for the location. When configured in the Seller
Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.
This image can be wider than it is tall and should be at least 1280x648 pixels. |
| `tax_ids` | [`Tax Ids`](../../doc/models/tax-ids.md) | Optional | Identifiers for the location used by various governments for tax purposes. |
## Example (as JSON)
diff --git a/doc/models/order-line-item-modifier.md b/doc/models/order-line-item-modifier.md
index 8474ac61..8b4553e9 100644
--- a/doc/models/order-line-item-modifier.md
+++ b/doc/models/order-line-item-modifier.md
@@ -15,6 +15,7 @@ A [CatalogModifier](../../doc/models/catalog-modifier.md).
| `catalog_object_id` | `string` | Optional | The catalog object ID referencing [CatalogModifier](../../doc/models/catalog-modifier.md).
**Constraints**: *Maximum Length*: `192` |
| `catalog_version` | `long\|int` | Optional | The version of the catalog object that this modifier references. |
| `name` | `string` | Optional | The name of the item modifier.
**Constraints**: *Maximum Length*: `255` |
+| `quantity` | `string` | Optional | The quantity of the line item modifier. The modifier quantity can be 0 or more.
For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders
this item, the restaurant records the purchase by creating an `Order` object with a line item
for a burger. The line item includes a line item modifier: the name is cheese and the quantity
is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses
the extra cheese option, the modifier quantity increases to 2. If the buyer does not want
any cheese, the modifier quantity is set to 0. |
| `base_price_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
| `total_price_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
| `metadata` | `dict` | Optional | Application-defined data attached to this order. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). |
@@ -27,10 +28,7 @@ A [CatalogModifier](../../doc/models/catalog-modifier.md).
"catalog_object_id": "catalog_object_id6",
"catalog_version": 126,
"name": "name0",
- "base_price_money": {
- "amount": 114,
- "currency": "ALL"
- }
+ "quantity": "quantity6"
}
```
diff --git a/doc/models/payment-balance-activity-automatic-savings-detail.md b/doc/models/payment-balance-activity-automatic-savings-detail.md
new file mode 100644
index 00000000..012de44c
--- /dev/null
+++ b/doc/models/payment-balance-activity-automatic-savings-detail.md
@@ -0,0 +1,23 @@
+
+# Payment Balance Activity Automatic Savings Detail
+
+## Structure
+
+`Payment Balance Activity Automatic Savings Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+| `payout_id` | `string` | Optional | The ID of the payout associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0",
+ "payout_id": "payout_id6"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md b/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md
new file mode 100644
index 00000000..46a6f9ae
--- /dev/null
+++ b/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md
@@ -0,0 +1,23 @@
+
+# Payment Balance Activity Automatic Savings Reversed Detail
+
+## Structure
+
+`Payment Balance Activity Automatic Savings Reversed Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+| `payout_id` | `string` | Optional | The ID of the payout associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0",
+ "payout_id": "payout_id6"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-charge-detail.md b/doc/models/payment-balance-activity-charge-detail.md
new file mode 100644
index 00000000..b2148fd7
--- /dev/null
+++ b/doc/models/payment-balance-activity-charge-detail.md
@@ -0,0 +1,23 @@
+
+# Payment Balance Activity Charge Detail
+
+DESCRIPTION OF PaymentBalanceActivityChargeDetail
+
+## Structure
+
+`Payment Balance Activity Charge Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-deposit-fee-detail.md b/doc/models/payment-balance-activity-deposit-fee-detail.md
new file mode 100644
index 00000000..2e31b16d
--- /dev/null
+++ b/doc/models/payment-balance-activity-deposit-fee-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Deposit Fee Detail
+
+## Structure
+
+`Payment Balance Activity Deposit Fee Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payout_id` | `string` | Optional | The ID of the payout that triggered this deposit fee activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payout_id": "payout_id6"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-dispute-detail.md b/doc/models/payment-balance-activity-dispute-detail.md
new file mode 100644
index 00000000..ce181c58
--- /dev/null
+++ b/doc/models/payment-balance-activity-dispute-detail.md
@@ -0,0 +1,23 @@
+
+# Payment Balance Activity Dispute Detail
+
+## Structure
+
+`Payment Balance Activity Dispute Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+| `dispute_id` | `string` | Optional | The ID of the dispute associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0",
+ "dispute_id": "dispute_id2"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-fee-detail.md b/doc/models/payment-balance-activity-fee-detail.md
new file mode 100644
index 00000000..40d6166f
--- /dev/null
+++ b/doc/models/payment-balance-activity-fee-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Fee Detail
+
+## Structure
+
+`Payment Balance Activity Fee Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-free-processing-detail.md b/doc/models/payment-balance-activity-free-processing-detail.md
new file mode 100644
index 00000000..ed4c7e89
--- /dev/null
+++ b/doc/models/payment-balance-activity-free-processing-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Free Processing Detail
+
+## Structure
+
+`Payment Balance Activity Free Processing Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-hold-adjustment-detail.md b/doc/models/payment-balance-activity-hold-adjustment-detail.md
new file mode 100644
index 00000000..6a5a91e4
--- /dev/null
+++ b/doc/models/payment-balance-activity-hold-adjustment-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Hold Adjustment Detail
+
+## Structure
+
+`Payment Balance Activity Hold Adjustment Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-open-dispute-detail.md b/doc/models/payment-balance-activity-open-dispute-detail.md
new file mode 100644
index 00000000..bb31b722
--- /dev/null
+++ b/doc/models/payment-balance-activity-open-dispute-detail.md
@@ -0,0 +1,23 @@
+
+# Payment Balance Activity Open Dispute Detail
+
+## Structure
+
+`Payment Balance Activity Open Dispute Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+| `dispute_id` | `string` | Optional | The ID of the dispute associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0",
+ "dispute_id": "dispute_id2"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-other-adjustment-detail.md b/doc/models/payment-balance-activity-other-adjustment-detail.md
new file mode 100644
index 00000000..ccd826bf
--- /dev/null
+++ b/doc/models/payment-balance-activity-other-adjustment-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Other Adjustment Detail
+
+## Structure
+
+`Payment Balance Activity Other Adjustment Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-other-detail.md b/doc/models/payment-balance-activity-other-detail.md
new file mode 100644
index 00000000..3d836ba7
--- /dev/null
+++ b/doc/models/payment-balance-activity-other-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Other Detail
+
+## Structure
+
+`Payment Balance Activity Other Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-refund-detail.md b/doc/models/payment-balance-activity-refund-detail.md
new file mode 100644
index 00000000..1377eed0
--- /dev/null
+++ b/doc/models/payment-balance-activity-refund-detail.md
@@ -0,0 +1,23 @@
+
+# Payment Balance Activity Refund Detail
+
+## Structure
+
+`Payment Balance Activity Refund Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+| `refund_id` | `string` | Optional | The ID of the refund associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0",
+ "refund_id": "refund_id4"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-release-adjustment-detail.md b/doc/models/payment-balance-activity-release-adjustment-detail.md
new file mode 100644
index 00000000..5c8e2c64
--- /dev/null
+++ b/doc/models/payment-balance-activity-release-adjustment-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Release Adjustment Detail
+
+## Structure
+
+`Payment Balance Activity Release Adjustment Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-reserve-hold-detail.md b/doc/models/payment-balance-activity-reserve-hold-detail.md
new file mode 100644
index 00000000..4cdb10f4
--- /dev/null
+++ b/doc/models/payment-balance-activity-reserve-hold-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Reserve Hold Detail
+
+## Structure
+
+`Payment Balance Activity Reserve Hold Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-reserve-release-detail.md b/doc/models/payment-balance-activity-reserve-release-detail.md
new file mode 100644
index 00000000..75d1d0ee
--- /dev/null
+++ b/doc/models/payment-balance-activity-reserve-release-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Reserve Release Detail
+
+## Structure
+
+`Payment Balance Activity Reserve Release Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-square-capital-payment-detail.md b/doc/models/payment-balance-activity-square-capital-payment-detail.md
new file mode 100644
index 00000000..deafec77
--- /dev/null
+++ b/doc/models/payment-balance-activity-square-capital-payment-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Square Capital Payment Detail
+
+## Structure
+
+`Payment Balance Activity Square Capital Payment Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md b/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md
new file mode 100644
index 00000000..3afb58db
--- /dev/null
+++ b/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Square Capital Reversed Payment Detail
+
+## Structure
+
+`Payment Balance Activity Square Capital Reversed Payment Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-tax-on-fee-detail.md b/doc/models/payment-balance-activity-tax-on-fee-detail.md
new file mode 100644
index 00000000..b90fb13f
--- /dev/null
+++ b/doc/models/payment-balance-activity-tax-on-fee-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Tax on Fee Detail
+
+## Structure
+
+`Payment Balance Activity Tax on Fee Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-third-party-fee-detail.md b/doc/models/payment-balance-activity-third-party-fee-detail.md
new file mode 100644
index 00000000..a279bd75
--- /dev/null
+++ b/doc/models/payment-balance-activity-third-party-fee-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Third Party Fee Detail
+
+## Structure
+
+`Payment Balance Activity Third Party Fee Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-balance-activity-third-party-fee-refund-detail.md b/doc/models/payment-balance-activity-third-party-fee-refund-detail.md
new file mode 100644
index 00000000..5c659e2f
--- /dev/null
+++ b/doc/models/payment-balance-activity-third-party-fee-refund-detail.md
@@ -0,0 +1,21 @@
+
+# Payment Balance Activity Third Party Fee Refund Detail
+
+## Structure
+
+`Payment Balance Activity Third Party Fee Refund Detail`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `payment_id` | `string` | Optional | The ID of the payment associated with this activity. |
+
+## Example (as JSON)
+
+```json
+{
+ "payment_id": "payment_id0"
+}
+```
+
diff --git a/doc/models/payment-options.md b/doc/models/payment-options.md
deleted file mode 100644
index 0a493780..00000000
--- a/doc/models/payment-options.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Options
-
-## Structure
-
-`Payment Options`
-
-## Fields
-
-| Name | Type | Tags | Description |
-| --- | --- | --- | --- |
-| `autocomplete` | `bool` | Optional | Indicates whether the `Payment` objects created from this `TerminalCheckout` are automatically
`COMPLETED` or left in an `APPROVED` state for later modification. |
-
-## Example (as JSON)
-
-```json
-{
- "autocomplete": false
-}
-```
-
diff --git a/doc/models/payout-entry.md b/doc/models/payout-entry.md
new file mode 100644
index 00000000..126bc3d2
--- /dev/null
+++ b/doc/models/payout-entry.md
@@ -0,0 +1,65 @@
+
+# Payout Entry
+
+One or more PayoutEntries that make up a Payout. Each one has a date, amount, and type of activity.
+The total amount of the payout will equal the sum of the payout entries for a batch payout
+
+## Structure
+
+`Payout Entry`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `id` | `string` | Required | A unique ID for the payout entry.
**Constraints**: *Minimum Length*: `1` |
+| `payout_id` | `string` | Required | The ID of the payout entries’ associated payout.
**Constraints**: *Minimum Length*: `1` |
+| `effective_at` | `string` | Optional | The timestamp of when the payout entry affected the balance, in RFC 3339 format. |
+| `type` | [`str (Activity Type)`](../../doc/models/activity-type.md) | Optional | - |
+| `gross_amount_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
+| `fee_amount_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
+| `net_amount_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
+| `type_automatic_savings_details` | [`Payment Balance Activity Automatic Savings Detail`](../../doc/models/payment-balance-activity-automatic-savings-detail.md) | Optional | - |
+| `type_automatic_savings_reversed_details` | [`Payment Balance Activity Automatic Savings Reversed Detail`](../../doc/models/payment-balance-activity-automatic-savings-reversed-detail.md) | Optional | - |
+| `type_charge_details` | [`Payment Balance Activity Charge Detail`](../../doc/models/payment-balance-activity-charge-detail.md) | Optional | DESCRIPTION OF PaymentBalanceActivityChargeDetail |
+| `type_deposit_fee_details` | [`Payment Balance Activity Deposit Fee Detail`](../../doc/models/payment-balance-activity-deposit-fee-detail.md) | Optional | - |
+| `type_dispute_details` | [`Payment Balance Activity Dispute Detail`](../../doc/models/payment-balance-activity-dispute-detail.md) | Optional | - |
+| `type_fee_details` | [`Payment Balance Activity Fee Detail`](../../doc/models/payment-balance-activity-fee-detail.md) | Optional | - |
+| `type_free_processing_details` | [`Payment Balance Activity Free Processing Detail`](../../doc/models/payment-balance-activity-free-processing-detail.md) | Optional | - |
+| `type_hold_adjustment_details` | [`Payment Balance Activity Hold Adjustment Detail`](../../doc/models/payment-balance-activity-hold-adjustment-detail.md) | Optional | - |
+| `type_open_dispute_details` | [`Payment Balance Activity Open Dispute Detail`](../../doc/models/payment-balance-activity-open-dispute-detail.md) | Optional | - |
+| `type_other_details` | [`Payment Balance Activity Other Detail`](../../doc/models/payment-balance-activity-other-detail.md) | Optional | - |
+| `type_other_adjustment_details` | [`Payment Balance Activity Other Adjustment Detail`](../../doc/models/payment-balance-activity-other-adjustment-detail.md) | Optional | - |
+| `type_refund_details` | [`Payment Balance Activity Refund Detail`](../../doc/models/payment-balance-activity-refund-detail.md) | Optional | - |
+| `type_release_adjustment_details` | [`Payment Balance Activity Release Adjustment Detail`](../../doc/models/payment-balance-activity-release-adjustment-detail.md) | Optional | - |
+| `type_reserve_hold_details` | [`Payment Balance Activity Reserve Hold Detail`](../../doc/models/payment-balance-activity-reserve-hold-detail.md) | Optional | - |
+| `type_reserve_release_details` | [`Payment Balance Activity Reserve Release Detail`](../../doc/models/payment-balance-activity-reserve-release-detail.md) | Optional | - |
+| `type_square_capital_payment_details` | [`Payment Balance Activity Square Capital Payment Detail`](../../doc/models/payment-balance-activity-square-capital-payment-detail.md) | Optional | - |
+| `type_square_capital_reversed_payment_details` | [`Payment Balance Activity Square Capital Reversed Payment Detail`](../../doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md) | Optional | - |
+| `type_tax_on_fee_details` | [`Payment Balance Activity Tax on Fee Detail`](../../doc/models/payment-balance-activity-tax-on-fee-detail.md) | Optional | - |
+| `type_third_party_fee_details` | [`Payment Balance Activity Third Party Fee Detail`](../../doc/models/payment-balance-activity-third-party-fee-detail.md) | Optional | - |
+| `type_third_party_fee_refund_details` | [`Payment Balance Activity Third Party Fee Refund Detail`](../../doc/models/payment-balance-activity-third-party-fee-refund-detail.md) | Optional | - |
+
+## Example (as JSON)
+
+```json
+{
+ "id": "id0",
+ "payout_id": "payout_id6",
+ "effective_at": "effective_at6",
+ "type": "REDEMPTION_CODE",
+ "gross_amount_money": {
+ "amount": 186,
+ "currency": "SVC"
+ },
+ "fee_amount_money": {
+ "amount": 126,
+ "currency": "ANG"
+ },
+ "net_amount_money": {
+ "amount": 6,
+ "currency": "AOA"
+ }
+}
+```
+
diff --git a/doc/models/payout-fee-type.md b/doc/models/payout-fee-type.md
new file mode 100644
index 00000000..0f46b43b
--- /dev/null
+++ b/doc/models/payout-fee-type.md
@@ -0,0 +1,16 @@
+
+# Payout Fee Type
+
+Represents the type of payout fee that can incur as part of a payout.
+
+## Enumeration
+
+`Payout Fee Type`
+
+## Fields
+
+| Name | Description |
+| --- | --- |
+| `TRANSFER_FEE` | Fee type associated with transfers. |
+| `TAX_ON_TRANSFER_FEE` | Taxes associated with the transfer fee. |
+
diff --git a/doc/models/payout-fee.md b/doc/models/payout-fee.md
new file mode 100644
index 00000000..7572c727
--- /dev/null
+++ b/doc/models/payout-fee.md
@@ -0,0 +1,30 @@
+
+# Payout Fee
+
+Represents a payout fee that can incur as part of a payout.
+
+## Structure
+
+`Payout Fee`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `amount_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
+| `effective_at` | `string` | Optional | The timestamp of when the fee takes effect, in RFC 3339 format. |
+| `type` | [`str (Payout Fee Type)`](../../doc/models/payout-fee-type.md) | Optional | Represents the type of payout fee that can incur as part of a payout. |
+
+## Example (as JSON)
+
+```json
+{
+ "amount_money": {
+ "amount": 186,
+ "currency": "NGN"
+ },
+ "effective_at": "effective_at6",
+ "type": "TRANSFER_FEE"
+}
+```
+
diff --git a/doc/models/payout-status.md b/doc/models/payout-status.md
new file mode 100644
index 00000000..4936acdd
--- /dev/null
+++ b/doc/models/payout-status.md
@@ -0,0 +1,17 @@
+
+# Payout Status
+
+Payout status types
+
+## Enumeration
+
+`Payout Status`
+
+## Fields
+
+| Name | Description |
+| --- | --- |
+| `SENT` | Indicates that the payout was successfully sent to the banking destination. |
+| `FAILED` | Indicates that the payout was rejected by the banking destination. |
+| `PAID` | Indicates that the payout has successfully completed. |
+
diff --git a/doc/models/payout-type.md b/doc/models/payout-type.md
new file mode 100644
index 00000000..57525177
--- /dev/null
+++ b/doc/models/payout-type.md
@@ -0,0 +1,19 @@
+
+# Payout Type
+
+The type of payout: “BATCH” or “SIMPLE”.
+BATCH payouts include a list of payout entries that can be considered settled.
+SIMPLE payouts do not have any payout entries associated with them
+and will show up as one of the payout entries in a future BATCH payout.
+
+## Enumeration
+
+`Payout Type`
+
+## Fields
+
+| Name | Description |
+| --- | --- |
+| `BATCH` | Payouts that include a list of payout entries that can be considered settled. |
+| `SIMPLE` | Payouts that do not have any payout entries associated with them and will
show up as one of the payout entries in a future BATCH payout. |
+
diff --git a/doc/models/payout.md b/doc/models/payout.md
new file mode 100644
index 00000000..9f00262a
--- /dev/null
+++ b/doc/models/payout.md
@@ -0,0 +1,46 @@
+
+# Payout
+
+An accounting of the amount owed the seller and record of the actual transfer to their
+external bank account or to the Square balance.
+
+## Structure
+
+`Payout`
+
+## Fields
+
+| Name | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `id` | `string` | Required | A unique ID for the payout.
**Constraints**: *Minimum Length*: `1` |
+| `status` | [`str (Payout Status)`](../../doc/models/payout-status.md) | Optional | Payout status types |
+| `location_id` | `string` | Required | The ID of the location associated with the payout.
**Constraints**: *Minimum Length*: `1` |
+| `created_at` | `string` | Optional | The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format. |
+| `updated_at` | `string` | Optional | The timestamp of when the payout was last updated, in RFC 3339 format. |
+| `amount_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
+| `destination` | [`Destination`](../../doc/models/destination.md) | Optional | Information about the destination against which the payout was made. |
+| `version` | `int` | Optional | The version number, which is incremented each time an update is made to this payout record.
The version number helps developers receive event notifications or feeds out of order. |
+| `type` | [`str (Payout Type)`](../../doc/models/payout-type.md) | Optional | The type of payout: “BATCH” or “SIMPLE”.
BATCH payouts include a list of payout entries that can be considered settled.
SIMPLE payouts do not have any payout entries associated with them
and will show up as one of the payout entries in a future BATCH payout. |
+| `payout_fee` | [`List of Payout Fee`](../../doc/models/payout-fee.md) | Optional | A list of processing fees and any taxes on the fees assessed by Square for this payout. |
+| `arrival_date` | `string` | Optional | The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination. |
+
+## Example (as JSON)
+
+```json
+{
+ "id": "id0",
+ "status": "PAID",
+ "location_id": "location_id4",
+ "created_at": "created_at2",
+ "updated_at": "updated_at4",
+ "amount_money": {
+ "amount": 186,
+ "currency": "NGN"
+ },
+ "destination": {
+ "type": "BANK_ACCOUNT",
+ "id": "id4"
+ }
+}
+```
+
diff --git a/doc/models/refund.md b/doc/models/refund.md
index e11a1752..baac875c 100644
--- a/doc/models/refund.md
+++ b/doc/models/refund.md
@@ -13,7 +13,7 @@ Represents a refund processed for a Square transaction.
| --- | --- | --- | --- |
| `id` | `string` | Required | The refund's unique ID.
**Constraints**: *Maximum Length*: `255` |
| `location_id` | `string` | Required | The ID of the refund's associated location.
**Constraints**: *Maximum Length*: `50` |
-| `transaction_id` | `string` | Required | The ID of the transaction that the refunded tender is part of.
**Constraints**: *Maximum Length*: `192` |
+| `transaction_id` | `string` | Optional | The ID of the transaction that the refunded tender is part of.
**Constraints**: *Maximum Length*: `192` |
| `tender_id` | `string` | Required | The ID of the refunded tender.
**Constraints**: *Maximum Length*: `192` |
| `created_at` | `string` | Optional | The timestamp for when the refund was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` |
| `reason` | `string` | Required | The reason for the refund being issued.
**Constraints**: *Maximum Length*: `192` |
diff --git a/doc/models/retrieve-employee-response.md b/doc/models/retrieve-employee-response.md
index e9a2b7b3..6cb92953 100644
--- a/doc/models/retrieve-employee-response.md
+++ b/doc/models/retrieve-employee-response.md
@@ -26,19 +26,19 @@
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/retrieve-location-response.md b/doc/models/retrieve-location-response.md
index 22d34bf1..5d37e047 100644
--- a/doc/models/retrieve-location-response.md
+++ b/doc/models/retrieve-location-response.md
@@ -12,8 +12,8 @@ endpoint returns in a response.
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. |
-| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business's [locations](https://developer.squareup.com/docs/locations-api). |
+| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
+| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). |
## Example (as JSON)
diff --git a/doc/models/retrieve-vendor-response.md b/doc/models/retrieve-vendor-response.md
index a3d4421c..f061e71a 100644
--- a/doc/models/retrieve-vendor-response.md
+++ b/doc/models/retrieve-vendor-response.md
@@ -1,7 +1,7 @@
# Retrieve Vendor Response
-Represents an output from a call to [RetrieveVendor.](../../doc/api/vendors.md#retrieve-vendor)
+Represents an output from a call to [RetrieveVendor](../../doc/api/vendors.md#retrieve-vendor).
## Structure
@@ -21,19 +21,19 @@ Represents an output from a call to [RetrieveVendor.](../../doc/api/vendors.md#r
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/search-catalog-items-response.md b/doc/models/search-catalog-items-response.md
index dfe265b3..b7abb654 100644
--- a/doc/models/search-catalog-items-response.md
+++ b/doc/models/search-catalog-items-response.md
@@ -23,19 +23,19 @@ Defines the response body returned from the [SearchCatalogItems](../../doc/api/c
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/search-vendors-request.md b/doc/models/search-vendors-request.md
index a2bfbef8..30898ba0 100644
--- a/doc/models/search-vendors-request.md
+++ b/doc/models/search-vendors-request.md
@@ -1,7 +1,7 @@
# Search Vendors Request
-Represents an input into a call to [SearchVendors.](../../doc/api/vendors.md#search-vendors)
+Represents an input into a call to [SearchVendors](../../doc/api/vendors.md#search-vendors).
## Structure
diff --git a/doc/models/search-vendors-response.md b/doc/models/search-vendors-response.md
index f9006568..b482863e 100644
--- a/doc/models/search-vendors-response.md
+++ b/doc/models/search-vendors-response.md
@@ -1,7 +1,7 @@
# Search Vendors Response
-Represents an output from a call to [SearchVendors.](../../doc/api/vendors.md#search-vendors)
+Represents an output from a call to [SearchVendors](../../doc/api/vendors.md#search-vendors).
## Structure
@@ -22,19 +22,19 @@ Represents an output from a call to [SearchVendors.](../../doc/api/vendors.md#se
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/snippet-response.md b/doc/models/snippet-response.md
index cc931223..1cb39e62 100644
--- a/doc/models/snippet-response.md
+++ b/doc/models/snippet-response.md
@@ -19,19 +19,19 @@
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/subscription.md b/doc/models/subscription.md
index 27285c8d..3828cecc 100644
--- a/doc/models/subscription.md
+++ b/doc/models/subscription.md
@@ -23,7 +23,7 @@ For an overview of the `Subscription` type, see
| `charged_through_date` | `string` | Optional | The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the
subscription.
After the invoice is sent for a given billing period,
this date will be the last day of the billing period.
For example,
suppose for the month of May a subscriber gets an invoice
(or charged the card) on May 1. For the monthly billing scenario,
this date is then set to May 31. |
| `status` | [`str (Subscription Status)`](../../doc/models/subscription-status.md) | Optional | Supported subscription statuses. |
| `tax_percentage` | `string` | Optional | The tax amount applied when billing the subscription. The
percentage is expressed in decimal form, using a `'.'` as the decimal
separator and without a `'%'` sign. For example, a value of `7.5`
corresponds to 7.5%. |
-| `invoice_ids` | `List of string` | Optional | The IDs of the [invoices](../../doc/models/invoice.md) created for the
subscription, listed in order when the invoices were created
(oldest invoices appear first). |
+| `invoice_ids` | `List of string` | Optional | The IDs of the [invoices](../../doc/models/invoice.md) created for the
subscription, listed in order when the invoices were created
(newest invoices appear first). |
| `price_override_money` | [`Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
| `version` | `long\|int` | Optional | The version of the object. When updating an object, the version
supplied must match the version in the database, otherwise the write will
be rejected as conflicting. |
| `created_at` | `string` | Optional | The timestamp when the subscription was created, in RFC 3339 format. |
diff --git a/doc/models/tax-ids.md b/doc/models/tax-ids.md
index e660f704..bba43534 100644
--- a/doc/models/tax-ids.md
+++ b/doc/models/tax-ids.md
@@ -12,9 +12,9 @@ Identifiers for the location used by various governments for tax purposes.
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `eu_vat` | `string` | Optional | The EU VAT number for this location. For example, `IE3426675K`.
If the EU VAT number is present, it is well-formed and has been
validated with VIES, the VAT Information Exchange System. |
-| `fr_siret` | `string` | Optional | The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements)
number is a 14 digit code issued by the French INSEE. For example, `39922799000021`. |
+| `fr_siret` | `string` | Optional | The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements)
number is a 14-digit code issued by the French INSEE. For example, `39922799000021`. |
| `fr_naf` | `string` | Optional | The French government uses the NAF (Nomenclature des Activités Françaises) to display and
track economic statistical data. This is also called the APE (Activite Principale de l’Entreprise) code.
For example, `6910Z`. |
-| `es_nif` | `string` | Optional | The NIF (Numero de Identificacion Fiscal) number is a 9 character tax identifier used in Spain.
If it is present, it has been validated. For example, `73628495A`. |
+| `es_nif` | `string` | Optional | The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain.
If it is present, it has been validated. For example, `73628495A`. |
## Example (as JSON)
diff --git a/doc/models/tender.md b/doc/models/tender.md
index 378d71c5..0ad53806 100644
--- a/doc/models/tender.md
+++ b/doc/models/tender.md
@@ -11,7 +11,7 @@ Represents a tender (i.e., a method of payment) used in a Square transaction.
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `id` | `string` | Optional | The tender's unique ID.
**Constraints**: *Maximum Length*: `192` |
+| `id` | `string` | Optional | The tender's unique ID. It is the associated payment ID.
**Constraints**: *Maximum Length*: `192` |
| `location_id` | `string` | Optional | The ID of the transaction's associated location.
**Constraints**: *Maximum Length*: `50` |
| `transaction_id` | `string` | Optional | The ID of the tender's associated transaction.
**Constraints**: *Maximum Length*: `192` |
| `created_at` | `string` | Optional | The timestamp for when the tender was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` |
diff --git a/doc/models/terminal-checkout.md b/doc/models/terminal-checkout.md
index 29800f46..6abfa9f3 100644
--- a/doc/models/terminal-checkout.md
+++ b/doc/models/terminal-checkout.md
@@ -1,6 +1,8 @@
# Terminal Checkout
+Represents a checkout processed by the Square Terminal.
+
## Structure
`Terminal Checkout`
@@ -12,7 +14,7 @@
| `id` | `string` | Optional | A unique ID for this `TerminalCheckout`.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `255` |
| `amount_money` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
| `reference_id` | `string` | Optional | An optional user-defined reference ID that can be used to associate
this `TerminalCheckout` to another entity in an external system. For example, an order
ID generated by a third-party shopping cart. The ID is also associated with any payments
used to complete the checkout.
**Constraints**: *Maximum Length*: `40` |
-| `note` | `string` | Optional | An optional note to associate with the checkout, as well as with any payments used to complete the checkout.
**Constraints**: *Maximum Length*: `250` |
+| `note` | `string` | Optional | An optional note to associate with the checkout, as well as with any payments used to complete the checkout.
Note: maximum 500 characters
**Constraints**: *Maximum Length*: `500` |
| `device_options` | [`Device Checkout Options`](../../doc/models/device-checkout-options.md) | Required | - |
| `deadline_duration` | `string` | Optional | An RFC 3339 duration, after which the checkout is automatically canceled.
A `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason
of `TIMED_OUT`.
Default: 5 minutes from creation
Maximum: 5 minutes |
| `status` | `string` | Optional | The status of the `TerminalCheckout`.
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` |
@@ -39,6 +41,7 @@
"device_options": {
"device_id": "device_id6",
"skip_receipt_screen": false,
+ "collect_signature": false,
"tip_settings": {
"allow_tipping": false,
"separate_tip_screen": false,
diff --git a/doc/models/terminal-device-checkout-options.md b/doc/models/terminal-device-checkout-options.md
deleted file mode 100644
index d3af3418..00000000
--- a/doc/models/terminal-device-checkout-options.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Terminal Device Checkout Options
-
-## Structure
-
-`Terminal Device Checkout Options`
-
-## Fields
-
-| Name | Type | Tags | Description |
-| --- | --- | --- | --- |
-| `skip_receipt_screen` | `bool` | Optional | Instructs the device to skip the receipt screen. Defaults to false. |
-| `tip_settings` | [`Tip Settings`](../../doc/models/tip-settings.md) | Optional | - |
-
-## Example (as JSON)
-
-```json
-{
- "skip_receipt_screen": false,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- }
-}
-```
-
diff --git a/doc/models/terminal-refund.md b/doc/models/terminal-refund.md
index ac10a306..4f4cd9fd 100644
--- a/doc/models/terminal-refund.md
+++ b/doc/models/terminal-refund.md
@@ -1,6 +1,8 @@
# Terminal Refund
+Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.
+
## Structure
`Terminal Refund`
@@ -14,10 +16,10 @@
| `payment_id` | `string` | Required | The unique ID of the payment being refunded.
**Constraints**: *Minimum Length*: `1` |
| `order_id` | `string` | Optional | The reference to the Square order ID for the payment identified by the `payment_id`. |
| `amount_money` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. |
-| `reason` | `string` | Optional | A description of the reason for the refund.
Note: maximum 192 characters
**Constraints**: *Maximum Length*: `192` |
-| `device_id` | `string` | Optional | The unique ID of the device intended for this `TerminalRefund`.
The Id can be retrieved from /v2/devices api. |
+| `reason` | `string` | Required | A description of the reason for the refund.
**Constraints**: *Maximum Length*: `192` |
+| `device_id` | `string` | Required | The unique ID of the device intended for this `TerminalRefund`.
The Id can be retrieved from /v2/devices api. |
| `deadline_duration` | `string` | Optional | The RFC 3339 duration, after which the refund is automatically canceled.
A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason
of `TIMED_OUT`.
Default: 5 minutes from creation.
Maximum: 5 minutes |
-| `status` | `string` | Optional | The status of the `TerminalRefund`.
Options: `PENDING`, `IN_PROGRESS`, `CANCELED`, or `COMPLETED`. |
+| `status` | `string` | Optional | The status of the `TerminalRefund`.
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`. |
| `cancel_reason` | [`str (Action Cancel Reason)`](../../doc/models/action-cancel-reason.md) | Optional | - |
| `created_at` | `string` | Optional | The time when the `TerminalRefund` was created, as an RFC 3339 timestamp. |
| `updated_at` | `string` | Optional | The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp. |
@@ -37,7 +39,9 @@
"currency": "NGN"
},
"reason": "reason4",
- "device_id": "device_id6"
+ "device_id": "device_id6",
+ "deadline_duration": "deadline_duration8",
+ "status": "status8"
}
```
diff --git a/doc/models/update-location-request.md b/doc/models/update-location-request.md
index b8a4db1a..8e93b30b 100644
--- a/doc/models/update-location-request.md
+++ b/doc/models/update-location-request.md
@@ -1,7 +1,7 @@
# Update Location Request
-Request object for the [UpdateLocation](../../doc/api/locations.md#update-location) endpoint.
+The request object for the [UpdateLocation](../../doc/api/locations.md#update-location) endpoint.
## Structure
@@ -11,7 +11,7 @@ Request object for the [UpdateLocation](../../doc/api/locations.md#update-locati
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business's [locations](https://developer.squareup.com/docs/locations-api). |
+| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). |
## Example (as JSON)
diff --git a/doc/models/update-location-response.md b/doc/models/update-location-response.md
index b599bb1f..b9ffdaca 100644
--- a/doc/models/update-location-response.md
+++ b/doc/models/update-location-response.md
@@ -1,7 +1,7 @@
# Update Location Response
-Response object returned by the [UpdateLocation](../../doc/api/locations.md#update-location) endpoint.
+The response object returned by the [UpdateLocation](../../doc/api/locations.md#update-location) endpoint.
## Structure
@@ -11,8 +11,8 @@ Response object returned by the [UpdateLocation](../../doc/api/locations.md#upda
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
-| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. |
-| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business's [locations](https://developer.squareup.com/docs/locations-api). |
+| `errors` | [`List of Error`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. |
+| `location` | [`Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). |
## Example (as JSON)
diff --git a/doc/models/update-vendor-request.md b/doc/models/update-vendor-request.md
index 7909557a..a290e428 100644
--- a/doc/models/update-vendor-request.md
+++ b/doc/models/update-vendor-request.md
@@ -1,7 +1,7 @@
# Update Vendor Request
-Represents an input to a call to [UpdateVendor.](../../doc/api/vendors.md#update-vendor)
+Represents an input to a call to [UpdateVendor](../../doc/api/vendors.md#update-vendor).
## Structure
diff --git a/doc/models/update-vendor-response.md b/doc/models/update-vendor-response.md
index 9b7c127c..d3eef5ab 100644
--- a/doc/models/update-vendor-response.md
+++ b/doc/models/update-vendor-response.md
@@ -1,7 +1,7 @@
# Update Vendor Response
-Represents an output from a call to [UpdateVendor.](../../doc/api/vendors.md#update-vendor)
+Represents an output from a call to [UpdateVendor](../../doc/api/vendors.md#update-vendor).
## Structure
diff --git a/doc/models/v1-list-orders-response.md b/doc/models/v1-list-orders-response.md
index 861fae3a..61cfe681 100644
--- a/doc/models/v1-list-orders-response.md
+++ b/doc/models/v1-list-orders-response.md
@@ -20,19 +20,19 @@
"errors": [
{
"category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "UNSUPPORTED_ENTRY_METHOD",
+ "code": "INSUFFICIENT_PERMISSIONS",
"detail": "detail8",
"field": "field6"
},
{
"category": "API_ERROR",
- "code": "INVALID_ENCRYPTED_CARD",
+ "code": "CARDHOLDER_INSUFFICIENT_PERMISSIONS",
"detail": "detail9",
"field": "field7"
},
{
"category": "AUTHENTICATION_ERROR",
- "code": "INVALID_CARD",
+ "code": "INVALID_LOCATION",
"detail": "detail0",
"field": "field8"
}
@@ -46,7 +46,7 @@
"errors": [
{
"category": "API_ERROR",
- "code": "INVALID_ENCRYPTED_CARD",
+ "code": "CARDHOLDER_INSUFFICIENT_PERMISSIONS",
"detail": "detail9",
"field": "field7"
}
diff --git a/doc/models/v1-order.md b/doc/models/v1-order.md
index 87c1d8b7..278e01c5 100644
--- a/doc/models/v1-order.md
+++ b/doc/models/v1-order.md
@@ -44,19 +44,19 @@ V1Order
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/doc/models/v1-payment-tax.md b/doc/models/v1-payment-tax.md
index ffe412d2..46eba055 100644
--- a/doc/models/v1-payment-tax.md
+++ b/doc/models/v1-payment-tax.md
@@ -25,19 +25,19 @@ V1PaymentTax
"errors": [
{
"category": "AUTHENTICATION_ERROR",
- "code": "MISSING_PIN",
+ "code": "VERIFY_CVV_FAILURE",
"detail": "detail1",
"field": "field9"
},
{
"category": "INVALID_REQUEST_ERROR",
- "code": "MISSING_ACCOUNT_TYPE",
+ "code": "VERIFY_AVS_FAILURE",
"detail": "detail2",
"field": "field0"
},
{
"category": "RATE_LIMIT_ERROR",
- "code": "INVALID_POSTAL_CODE",
+ "code": "CARD_DECLINED_CALL_ISSUER",
"detail": "detail3",
"field": "field1"
}
diff --git a/setup.py b/setup.py
index b04d2973..a5968c7d 100644
--- a/setup.py
+++ b/setup.py
@@ -12,7 +12,7 @@
setup(
name='squareup',
- version='17.3.0.20220316',
+ version='18.0.0.20220420',
description='Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.',
long_description=long_description,
long_description_content_type="text/markdown",
diff --git a/square/api/__init__.py b/square/api/__init__.py
index af210bae..00ed4025 100644
--- a/square/api/__init__.py
+++ b/square/api/__init__.py
@@ -27,6 +27,7 @@
'merchants_api',
'orders_api',
'payments_api',
+ 'payouts_api',
'refunds_api',
'sites_api',
'snippets_api',
diff --git a/square/api/base_api.py b/square/api/base_api.py
index 5ff05b3b..9edf7590 100644
--- a/square/api/base_api.py
+++ b/square/api/base_api.py
@@ -55,13 +55,14 @@ def validate_parameters(self, **kwargs):
if value is None:
raise ValueError("Required parameter {} cannot be None.".format(name))
- def execute_request(self, request, binary=False):
+ def execute_request(self, request, binary=False, to_retry=None):
"""Executes an HttpRequest.
Args:
request (HttpRequest): The HttpRequest to execute.
binary (bool): A flag which should be set to True if
a binary response is expected.
+ to_retry (bool): whether to retry on a particular request
Returns:
HttpResponse: The HttpResponse received.
@@ -72,13 +73,14 @@ def execute_request(self, request, binary=False):
self.http_call_back.on_before_request(request)
# Add global headers to request
- request.headers = APIHelper.merge_dicts(self.global_headers(), request.headers)
+ prepared_headers = {key: str(value) for key, value in request.headers.items()}
+ request.headers = APIHelper.merge_dicts(self.global_headers(), prepared_headers)
if self.config.additional_headers is not None:
request.headers.update(self.config.additional_headers)
# Invoke the API call to fetch the response.
func = self.config.http_client.execute_as_binary if binary else self.config.http_client.execute_as_string
- response = func(request)
+ response = func(request, to_retry=to_retry)
# Invoke the on after response HttpCallBack if specified
if self.http_call_back is not None:
@@ -87,7 +89,7 @@ def execute_request(self, request, binary=False):
return response
def get_user_agent(self):
- user_agent = 'Square-Python-SDK/17.3.0.20220316 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+ user_agent = 'Square-Python-SDK/18.0.0.20220420 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
parameters = {
'engine': {'value': platform.python_implementation(), 'encode': False},
'engine-version': {'value': "", 'encode': False},
diff --git a/square/api/locations_api.py b/square/api/locations_api.py
index 2cecebc3..05258277 100644
--- a/square/api/locations_api.py
+++ b/square/api/locations_api.py
@@ -63,14 +63,15 @@ def create_location(self,
Creates a
[location](https://developer.squareup.com/docs/locations-api).
Creating new locations allows for separate configuration of receipt
- layouts, item prices,
+ layouts, item prices,
and sales reports. Developers can use locations to separate sales
- activity via applications
+ activity through applications
that integrate with Square from sales activity elsewhere in a seller's
- account.
- Locations created programmatically with the Locations API will last
- forever and
- are visible to the seller for their own management, so ensure that
+ account.
+ Locations created programmatically with the Locations API last forever
+ and
+ are visible to the seller for their own management. Therefore, ensure
+ that
each location has a sensible and unique name.
Args:
diff --git a/square/api/orders_api.py b/square/api/orders_api.py
index 0e77470a..a6325da4 100644
--- a/square/api/orders_api.py
+++ b/square/api/orders_api.py
@@ -439,7 +439,7 @@ def pay_order(self,
`payment_ids` is canceled.
- Be approved with [delayed
capture](https://developer.squareup.com/docs/payments-api/take-payments
- #delayed-capture).
+ /card-payments/delayed-capture).
Using a delayed capture payment with `PayOrder` completes the approved
payment.
diff --git a/square/api/payouts_api.py b/square/api/payouts_api.py
new file mode 100644
index 00000000..d605bfbe
--- /dev/null
+++ b/square/api/payouts_api.py
@@ -0,0 +1,237 @@
+# -*- coding: utf-8 -*-
+
+from square.api_helper import APIHelper
+from square.http.api_response import ApiResponse
+from square.api.base_api import BaseApi
+
+
+class PayoutsApi(BaseApi):
+
+ """A Controller to access Endpoints in the square API."""
+ def __init__(self, config, auth_managers):
+ super(PayoutsApi, self).__init__(config, auth_managers)
+
+ def list_payouts(self,
+ location_id=None,
+ status=None,
+ begin_time=None,
+ end_time=None,
+ sort_order=None,
+ cursor=None,
+ limit=None):
+ """Does a GET request to /v2/payouts.
+
+ Retrieves a list of all payouts for the default location.
+ You can filter payouts by location ID, status, time range, and order
+ them in ascending or descending order.
+ To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+
+ Args:
+ location_id (string, optional): The ID of the location for which
+ to list the payouts. By default, payouts are returned for the
+ default (main) location associated with the seller.
+ status (PayoutStatus, optional): If provided, only payouts with
+ the given status are returned.
+ begin_time (string, optional): The timestamp for the beginning of
+ the payout creation time, in RFC 3339 format. Inclusive.
+ Default: The current time minus one year.
+ end_time (string, optional): The timestamp for the end of the
+ payout creation time, in RFC 3339 format. Default: The current
+ time.
+ sort_order (SortOrder, optional): The order in which payouts are
+ listed.
+ cursor (string, optional): A pagination cursor returned by a
+ previous call to this endpoint. Provide this cursor to
+ retrieve the next set of results for the original query. For
+ more information, see
+ [Pagination](https://developer.squareup.com/docs/basics/api101/
+ pagination). If request parameters change between requests,
+ subsequent results may contain duplicates or missing records.
+ limit (int, 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`
+
+ Returns:
+ ApiResponse: An object with the response value as well as other
+ useful information such as status codes and headers. Success
+
+ Raises:
+ APIException: When an error occurs while fetching the data from
+ the remote API. This exception includes the HTTP Response
+ code, an error message, and the HTTP body that was received in
+ the request.
+
+ """
+
+ # Prepare query URL
+ _url_path = '/v2/payouts'
+ _query_builder = self.config.get_base_uri()
+ _query_builder += _url_path
+ _query_parameters = {
+ 'location_id': location_id,
+ 'status': status,
+ 'begin_time': begin_time,
+ 'end_time': end_time,
+ 'sort_order': sort_order,
+ 'cursor': cursor,
+ 'limit': limit
+ }
+ _query_builder = APIHelper.append_url_with_query_parameters(
+ _query_builder,
+ _query_parameters
+ )
+ _query_url = APIHelper.clean_url(_query_builder)
+
+ # Prepare headers
+ _headers = {
+ 'accept': 'application/json'
+ }
+
+ # Prepare and execute request
+ _request = self.config.http_client.get(_query_url, headers=_headers)
+ # Apply authentication scheme on request
+ self.apply_auth_schemes(_request, 'global')
+
+ _response = self.execute_request(_request)
+
+ decoded = APIHelper.json_deserialize(_response.text)
+ if type(decoded) is dict:
+ _errors = decoded.get('errors')
+ else:
+ _errors = None
+ _result = ApiResponse(_response, body=decoded, errors=_errors)
+ return _result
+
+ def get_payout(self,
+ payout_id):
+ """Does a GET request to /v2/payouts/{payout_id}.
+
+ Retrieves details of a specific payout identified by a payout ID.
+ To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+
+ Args:
+ payout_id (string): The ID of the payout to retrieve the
+ information for.
+
+ Returns:
+ ApiResponse: An object with the response value as well as other
+ useful information such as status codes and headers. Success
+
+ Raises:
+ APIException: When an error occurs while fetching the data from
+ the remote API. This exception includes the HTTP Response
+ code, an error message, and the HTTP body that was received in
+ the request.
+
+ """
+
+ # Prepare query URL
+ _url_path = '/v2/payouts/{payout_id}'
+ _url_path = APIHelper.append_url_with_template_parameters(_url_path, {
+ 'payout_id': {'value': payout_id, 'encode': True}
+ })
+ _query_builder = self.config.get_base_uri()
+ _query_builder += _url_path
+ _query_url = APIHelper.clean_url(_query_builder)
+
+ # Prepare headers
+ _headers = {
+ 'accept': 'application/json'
+ }
+
+ # Prepare and execute request
+ _request = self.config.http_client.get(_query_url, headers=_headers)
+ # Apply authentication scheme on request
+ self.apply_auth_schemes(_request, 'global')
+
+ _response = self.execute_request(_request)
+
+ decoded = APIHelper.json_deserialize(_response.text)
+ if type(decoded) is dict:
+ _errors = decoded.get('errors')
+ else:
+ _errors = None
+ _result = ApiResponse(_response, body=decoded, errors=_errors)
+ return _result
+
+ def list_payout_entries(self,
+ payout_id,
+ sort_order=None,
+ cursor=None,
+ limit=None):
+ """Does a GET request to /v2/payouts/{payout_id}/payout-entries.
+
+ Retrieves a list of all payout entries for a specific payout.
+ To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+
+ Args:
+ payout_id (string): The ID of the payout to retrieve the
+ information for.
+ sort_order (SortOrder, optional): The order in which payout
+ entries are listed.
+ cursor (string, optional): A pagination cursor returned by a
+ previous call to this endpoint. Provide this cursor to
+ retrieve the next set of results for the original query. For
+ more information, see
+ [Pagination](https://developer.squareup.com/docs/basics/api101/
+ pagination). If request parameters change between requests,
+ subsequent results may contain duplicates or missing records.
+ limit (int, 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`
+
+ Returns:
+ ApiResponse: An object with the response value as well as other
+ useful information such as status codes and headers. Success
+
+ Raises:
+ APIException: When an error occurs while fetching the data from
+ the remote API. This exception includes the HTTP Response
+ code, an error message, and the HTTP body that was received in
+ the request.
+
+ """
+
+ # Prepare query URL
+ _url_path = '/v2/payouts/{payout_id}/payout-entries'
+ _url_path = APIHelper.append_url_with_template_parameters(_url_path, {
+ 'payout_id': {'value': payout_id, 'encode': True}
+ })
+ _query_builder = self.config.get_base_uri()
+ _query_builder += _url_path
+ _query_parameters = {
+ 'sort_order': sort_order,
+ 'cursor': cursor,
+ 'limit': limit
+ }
+ _query_builder = APIHelper.append_url_with_query_parameters(
+ _query_builder,
+ _query_parameters
+ )
+ _query_url = APIHelper.clean_url(_query_builder)
+
+ # Prepare headers
+ _headers = {
+ 'accept': 'application/json'
+ }
+
+ # Prepare and execute request
+ _request = self.config.http_client.get(_query_url, headers=_headers)
+ # Apply authentication scheme on request
+ self.apply_auth_schemes(_request, 'global')
+
+ _response = self.execute_request(_request)
+
+ decoded = APIHelper.json_deserialize(_response.text)
+ if type(decoded) is dict:
+ _errors = decoded.get('errors')
+ else:
+ _errors = None
+ _result = ApiResponse(_response, body=decoded, errors=_errors)
+ return _result
diff --git a/square/api/subscriptions_api.py b/square/api/subscriptions_api.py
index 23090d88..026c5eba 100644
--- a/square/api/subscriptions_api.py
+++ b/square/api/subscriptions_api.py
@@ -368,9 +368,6 @@ def list_subscription_events(self,
"""Does a GET request to /v2/subscriptions/{subscription_id}/events.
Lists all events for a specific subscription.
- In the current implementation, only `START_SUBSCRIPTION` and
- `STOP_SUBSCRIPTION` (when the subscription was canceled) events are
- returned.
Args:
subscription_id (string): The ID of the subscription to retrieve
diff --git a/square/api/terminal_api.py b/square/api/terminal_api.py
index 33621521..cacfbe41 100644
--- a/square/api/terminal_api.py
+++ b/square/api/terminal_api.py
@@ -67,8 +67,10 @@ def search_terminal_checkouts(self,
body):
"""Does a POST request to /v2/terminals/checkouts/search.
- Retrieves a filtered list of Terminal checkout requests created by the
- account making the request.
+ Returns a filtered list of Terminal checkout requests created by the
+ application making the request. Only Terminal checkout requests
+ created for the merchant scoped to the OAuth token are returned.
+ Terminal checkout requests are available for 30 days.
Args:
body (SearchTerminalCheckoutsRequest): An object containing the
@@ -118,7 +120,8 @@ def get_terminal_checkout(self,
checkout_id):
"""Does a GET request to /v2/terminals/checkouts/{checkout_id}.
- Retrieves a Terminal checkout request by `checkout_id`.
+ Retrieves a Terminal checkout request by `checkout_id`. Terminal
+ checkout requests are available for 30 days.
Args:
checkout_id (string): The unique ID for the desired
@@ -222,7 +225,10 @@ def create_terminal_refund(self,
"""Does a POST request to /v2/terminals/refunds.
Creates a request to refund an Interac payment completed on a Square
- Terminal.
+ Terminal. Refunds for Interac payments on a Square Terminal are
+ supported only for Interac debit cards in Canada. Other refunds for
+ Terminal payments should use the Refunds API. For more information,
+ see [Refunds API]($e/Refunds).
Args:
body (CreateTerminalRefundRequest): An object containing the
@@ -273,7 +279,8 @@ def search_terminal_refunds(self,
"""Does a POST request to /v2/terminals/refunds/search.
Retrieves a filtered list of Interac Terminal refund requests created
- by the seller making the request.
+ by the seller making the request. Terminal refund requests are
+ available for 30 days.
Args:
body (SearchTerminalRefundsRequest): An object containing the
@@ -323,7 +330,8 @@ def get_terminal_refund(self,
terminal_refund_id):
"""Does a GET request to /v2/terminals/refunds/{terminal_refund_id}.
- Retrieves an Interac Terminal refund object by ID.
+ Retrieves an Interac Terminal refund object by ID. Terminal refund
+ objects are available for 30 days.
Args:
terminal_refund_id (string): The unique ID for the desired
diff --git a/square/client.py b/square/client.py
index 3e7efd57..c0cf352c 100644
--- a/square/client.py
+++ b/square/client.py
@@ -30,6 +30,7 @@
from square.api.merchants_api import MerchantsApi
from square.api.orders_api import OrdersApi
from square.api.payments_api import PaymentsApi
+from square.api.payouts_api import PayoutsApi
from square.api.refunds_api import RefundsApi
from square.api.sites_api import SitesApi
from square.api.snippets_api import SnippetsApi
@@ -43,11 +44,11 @@ class Client(object):
@staticmethod
def sdk_version():
- return '17.3.0.20220316'
+ return '18.0.0.20220420'
@staticmethod
def square_version():
- return '2022-03-16'
+ return '2022-04-20'
def user_agent_detail(self):
return self.config.user_agent_detail
@@ -162,6 +163,10 @@ def orders(self):
def payments(self):
return PaymentsApi(self.config, self.auth_managers)
+ @lazy_property
+ def payouts(self):
+ return PayoutsApi(self.config, self.auth_managers)
+
@lazy_property
def refunds(self):
return RefundsApi(self.config, self.auth_managers)
@@ -196,7 +201,7 @@ def __init__(self, http_client_instance=None,
retry_statuses=[408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
retry_methods=['GET', 'PUT'], environment='production',
custom_url='https://connect.squareup.com', access_token='',
- square_version='2022-03-16', additional_headers={},
+ square_version='2022-04-20', additional_headers={},
user_agent_detail='', config=None):
if config is None:
self.config = Configuration(
diff --git a/square/configuration.py b/square/configuration.py
index e2c0cdc1..dd536ba8 100644
--- a/square/configuration.py
+++ b/square/configuration.py
@@ -76,7 +76,7 @@ def __init__(
retry_statuses=[408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
retry_methods=['GET', 'PUT'], environment='production',
custom_url='https://connect.squareup.com', access_token='',
- square_version='2022-03-16', additional_headers={},
+ square_version='2022-04-20', additional_headers={},
user_agent_detail=''
):
# The Http Client passed from the sdk user for making requests
diff --git a/square/http/requests_client.py b/square/http/requests_client.py
index e2d94c65..a31d27f0 100644
--- a/square/http/requests_client.py
+++ b/square/http/requests_client.py
@@ -74,16 +74,36 @@ def create_default_http_cient(self,
self.session.verify = verify
- def execute_as_string(self, request):
+ def force_retries(self, request, to_retry=None):
+ """Reset retries according to each request
+
+ Args:
+ request (HttpRequest): The given HttpRequest to execute.
+ to_retry (boolean): whether to retry on a particular request
+
+ """
+ adapters = self.session.adapters
+ if to_retry is False:
+ for adapter in adapters.values():
+ adapter.max_retries = False
+ elif to_retry is True:
+ for adapter in adapters.values():
+ adapter.max_retries.allowed_methods = [request.http_method]
+
+ def execute_as_string(self, request, to_retry=None):
"""Execute a given HttpRequest to get a string response back
Args:
request (HttpRequest): The given HttpRequest to execute.
+ to_retry (boolean): whether to retry on a particular request
Returns:
HttpResponse: The response of the HttpRequest.
"""
+
+ old_adapters = self.session.adapters
+ self.force_retries(request, to_retry)
response = self.session.request(
HttpMethodEnum.to_string(request.http_method),
request.query_url,
@@ -94,19 +114,23 @@ def execute_as_string(self, request):
timeout=self.timeout
)
+ self.session.adapters = old_adapters
return self.convert_response(response, False, request)
- def execute_as_binary(self, request):
+ def execute_as_binary(self, request, to_retry=None):
"""Execute a given HttpRequest to get a binary response back
Args:
request (HttpRequest): The given HttpRequest to execute.
+ to_retry (boolean): whether to retry on a particular request
Returns:
HttpResponse: The response of the HttpRequest.
"""
+ old_adapters = self.session.adapters
+ self.force_retries(request, to_retry)
response = self.session.request(
HttpMethodEnum.to_string(request.http_method),
request.query_url,
@@ -116,7 +140,7 @@ def execute_as_binary(self, request):
files=request.files,
timeout=self.timeout
)
-
+ self.session.adapters = old_adapters
return self.convert_response(response, True, request)
def convert_response(self, response, binary, http_request):