Merge pull request #116 from square/release/29.0.0.20230720

Generated PR for Release: 29.0.0.20230720

Author: jguze

doc/api/customers.md

@@ -35,7 +35,8 @@ def list_customers(self,
                   cursor=None,
                   limit=None,
                   sort_field=None,
-                  sort_order=None)
+                  sort_order=None,
+                  count=False)
 ```
 
 ## Parameters
@@ -46,6 +47,7 @@ def list_customers(self,
 | `limit` | `int` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 | `sort_field` | [`str (Customer Sort Field)`](../../doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>The default value is `DEFAULT`. |
 | `sort_order` | [`str (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>The default value is `ASC`. |
+| `count` | `bool` | Query, Optional | Indicates whether to return the total count of customers in the `count` field of the response.<br><br>The default value is `false`.<br>**Default**: `False` |
 
 ## Response Type
 
@@ -54,7 +56,11 @@ def list_customers(self,
 ## Example Usage
 
 ```python
-result = customers_api.list_customers()
+count = False
+
+result = customers_api.list_customers(
+    count
+)
 print(result)
 
 if result.is_success():

doc/api/invoices.md

@@ -116,7 +116,8 @@ body = {
             'card': True,
             'square_gift_card': False,
             'bank_account': False,
-            'buy_now_pay_later': False
+            'buy_now_pay_later': False,
+            'cash_app_pay': False
         },
         'custom_fields': [
             {

doc/api/refunds.md

@@ -40,7 +40,7 @@ def list_payment_refunds(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `begin_time` | `string` | Query, Optional | Indicates the start of the time range to retrieve each PaymentRefund`for, in RFC 3339 format. The range is determined using the`created_at`field for each`PaymentRefund`.<br><br>Default: The current time minus one year. |
+| `begin_time` | `string` | Query, Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time minus one year. |
 | `end_time` | `string` | Query, Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339<br>format.  The range is determined using the `created_at` field for each `PaymentRefund`.<br><br>Default: The current time. |
 | `sort_order` | `string` | Query, Optional | The order in which results are listed by `PaymentRefund.created_at`:<br><br>- `ASC` - Oldest to newest.<br>- `DESC` - Newest to oldest (default). |
 | `cursor` | `string` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for the original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |

doc/api/subscriptions.md

@@ -55,18 +55,19 @@ body = {
     'location_id': 'S8GWD5R9QB376',
     'customer_id': 'CHFGVKYY8RSV93M5KCYTG4PN0G',
     'idempotency_key': '8193148c-9586-11e6-99f9-28cfe92138cf',
-    'plan_id': '6JHXF3B2CW3YKHDV4XEM674H',
-    'start_date': '2021-10-20',
-    'tax_percentage': '5',
-    'price_override_money': {
-        'amount': 100,
-        'currency': 'USD'
-    },
+    'plan_variation_id': '6JHXF3B2CW3YKHDV4XEM674H',
+    'start_date': '2023-06-20',
     'card_id': 'ccof:qy5x8hHGYsgLrp4Q4GB',
     'timezone': 'America/Los_Angeles',
     'source': {
-        'name': 'My App'
-    }
+        'name': 'My Application'
+    },
+    'phases': [
+        {
+            'ordinal': 0,
+            'order_template_id': 'U2NaowWxzXwpsZU697x7ZHOAnCNZY'
+        }
+    ]
 }
 
 result = subscriptions_api.create_subscription(body)
@@ -444,7 +445,15 @@ def swap_plan(self,
 ```python
 subscription_id = 'subscription_id0'
 
-body = {}
+body = {
+    'new_plan_variation_id': 'FQ7CDXXWSLUJRPM3GFJSJGZ7',
+    'phases': [
+        {
+            'ordinal': 0,
+            'order_template_id': 'uhhnjH9osVv3shUADwaC0b3hNxQZY'
+        }
+    ]
+}
 
 result = subscriptions_api.swap_plan(
     subscription_id,

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `square_version` | `string` | Square Connect API versions<br>*Default*: `'2023-06-08'` |
+| `square_version` | `string` | Square Connect API versions<br>*Default*: `'2023-07-20'` |
 | `custom_url` | `string` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `'https://connect.squareup.com'` |
 | `environment` | `string` | The API environment. <br> **Default: `production`** |
 | `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
@@ -25,7 +25,7 @@ The API client can be initialized as follows:
 ```python
 from square.client import Client
 client = Client(
-    square_version='2023-06-08',
+    square_version='2023-07-20',
     access_token='AccessToken'
 )
 ```
@@ -48,7 +48,7 @@ API calls return an `ApiResponse` object that includes the following fields:
 ```python
 from square.client import Client
 client = Client(
-    square_version='2023-06-08',
+    square_version='2023-07-20',
     access_token='AccessToken'
 )
 

doc/models/accept-dispute-response.md

@@ -41,20 +41,20 @@ Defines the fields in an `AcceptDispute` response.
   },
   "errors": [
     {
-      "category": "AUTHENTICATION_ERROR",
-      "code": "REFUND_ALREADY_PENDING",
+      "category": "REFUND_ERROR",
+      "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
       "detail": "detail1",
       "field": "field9"
     },
     {
-      "category": "INVALID_REQUEST_ERROR",
-      "code": "PAYMENT_NOT_REFUNDABLE",
+      "category": "MERCHANT_SUBSCRIPTION_ERROR",
+      "code": "BAD_REQUEST",
       "detail": "detail2",
       "field": "field0"
     },
     {
-      "category": "RATE_LIMIT_ERROR",
-      "code": "REFUND_DECLINED",
+      "category": "EXTERNAL_VENDOR_ERROR",
+      "code": "MISSING_REQUIRED_PARAMETER",
       "detail": "detail3",
       "field": "field1"
     }

doc/models/accumulate-loyalty-points-response.md

@@ -56,20 +56,20 @@ Represents an [AccumulateLoyaltyPoints](../../doc/api/loyalty.md#accumulate-loya
   ],
   "errors": [
     {
-      "category": "AUTHENTICATION_ERROR",
-      "code": "REFUND_ALREADY_PENDING",
+      "category": "REFUND_ERROR",
+      "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
       "detail": "detail1",
       "field": "field9"
     },
     {
-      "category": "INVALID_REQUEST_ERROR",
-      "code": "PAYMENT_NOT_REFUNDABLE",
+      "category": "MERCHANT_SUBSCRIPTION_ERROR",
+      "code": "BAD_REQUEST",
       "detail": "detail2",
       "field": "field0"
     },
     {
-      "category": "RATE_LIMIT_ERROR",
-      "code": "REFUND_DECLINED",
+      "category": "EXTERNAL_VENDOR_ERROR",
+      "code": "MISSING_REQUIRED_PARAMETER",
       "detail": "detail3",
       "field": "field1"
     }

doc/models/add-group-to-customer-response.md

@@ -20,20 +20,20 @@ a request to the [AddGroupToCustomer](../../doc/api/customers.md#add-group-to-cu
 {
   "errors": [
     {
-      "category": "AUTHENTICATION_ERROR",
-      "code": "REFUND_ALREADY_PENDING",
+      "category": "REFUND_ERROR",
+      "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
       "detail": "detail1",
       "field": "field9"
     },
     {
-      "category": "INVALID_REQUEST_ERROR",
-      "code": "PAYMENT_NOT_REFUNDABLE",
+      "category": "MERCHANT_SUBSCRIPTION_ERROR",
+      "code": "BAD_REQUEST",
       "detail": "detail2",
       "field": "field0"
     },
     {
-      "category": "RATE_LIMIT_ERROR",
-      "code": "REFUND_DECLINED",
+      "category": "EXTERNAL_VENDOR_ERROR",
+      "code": "MISSING_REQUIRED_PARAMETER",
       "detail": "detail3",
       "field": "field1"
     }

doc/models/additional-recipient.md

@@ -24,7 +24,7 @@ Represents an additional recipient (other than the merchant) receiving a portion
   "description": "description0",
   "amount_money": {
     "amount": 186,
-    "currency": "NGN"
+    "currency": "TZS"
   },
   "receivable_id": "receivable_id0"
 }

doc/models/adjust-loyalty-points-response.md

@@ -52,20 +52,20 @@ Represents an [AdjustLoyaltyPoints](../../doc/api/loyalty.md#adjust-loyalty-poin
   },
   "errors": [
     {
-      "category": "AUTHENTICATION_ERROR",
-      "code": "REFUND_ALREADY_PENDING",
+      "category": "REFUND_ERROR",
+      "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
       "detail": "detail1",
       "field": "field9"
     },
     {
-      "category": "INVALID_REQUEST_ERROR",
-      "code": "PAYMENT_NOT_REFUNDABLE",
+      "category": "MERCHANT_SUBSCRIPTION_ERROR",
+      "code": "BAD_REQUEST",
       "detail": "detail2",
       "field": "field0"
     },
     {
-      "category": "RATE_LIMIT_ERROR",
-      "code": "REFUND_DECLINED",
+      "category": "EXTERNAL_VENDOR_ERROR",
+      "code": "MISSING_REQUIRED_PARAMETER",
       "detail": "detail3",
       "field": "field1"
     }