Release 2024-11-20

Author: autobot

doc/api/location-custom-attributes.md

@@ -254,15 +254,9 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 ```python
 body = {
     'values': {
-        'id1': {
-            'key': 'bestseller'
-        },
-        'id2': {
-            'key': 'bestseller'
-        },
-        'id3': {
-            'key': 'phone-number'
-        }
+        'id1': {},
+        'id2': {},
+        'id3': {}
     }
 }
 

doc/api/merchant-custom-attributes.md

@@ -254,12 +254,8 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 ```python
 body = {
     'values': {
-        'id1': {
-            'key': 'alternative_seller_name'
-        },
-        'id2': {
-            'key': 'has_seen_tutorial'
-        }
+        'id1': {},
+        'id2': {}
     }
 }
 

doc/api/order-custom-attributes.md

@@ -269,12 +269,10 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 body = {
     'values': {
         'cover-count': {
-            'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
-            'key': 'cover-count'
+            'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F'
         },
         'table-number': {
-            'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
-            'key': 'table-number'
+            'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F'
         }
     }
 }

doc/api/team.md

@@ -176,7 +176,6 @@ body = {
         'AFMwA08kR-MIF-3Vs0OE': {
             'team_member': {
                 'reference_id': 'reference_id_2',
-                'is_owner': False,
                 'status': 'ACTIVE',
                 'given_name': 'Jane',
                 'family_name': 'Smith',
@@ -190,7 +189,6 @@ body = {
         'fpgteZNMaf0qOK-a4t6P': {
             'team_member': {
                 'reference_id': 'reference_id_1',
-                'is_owner': False,
                 'status': 'ACTIVE',
                 'given_name': 'Joe',
                 'family_name': 'Doe',

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `square_version` | `str` | Square Connect API versions<br>*Default*: `'2024-10-17'` |
+| `square_version` | `str` | Square Connect API versions<br>*Default*: `'2024-11-20'` |
 | `custom_url` | `str` | 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 |
@@ -24,7 +24,7 @@ The API client can be initialized as follows:
 
 ```python
 client = Client(
-    square_version='2024-10-17',
+    square_version='2024-11-20',
     bearer_auth_credentials=BearerAuthCredentials(
         access_token='AccessToken'
     ),
@@ -53,7 +53,7 @@ from square.http.auth.o_auth_2 import BearerAuthCredentials
 from square.client import Client
 
 client = Client(
-    square_version='2024-10-17',
+    square_version='2024-11-20',
     bearer_auth_credentials=BearerAuthCredentials(
         access_token='AccessToken'
     ),

doc/models/accept-dispute-response.md

@@ -42,19 +42,19 @@ Defines the fields in an `AcceptDispute` response.
   "errors": [
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     },
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     },
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     }

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

@@ -57,7 +57,7 @@ Represents an [AccumulateLoyaltyPoints](../../doc/api/loyalty.md#accumulate-loya
   "errors": [
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     }

doc/models/activity-type.md

@@ -15,7 +15,8 @@
 | `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. |
+| `DEPOSIT_FEE` | A fee assessed because of a deposit, such as an instant deposit. |
+| `DEPOSIT_FEE_REVERSED` | Indicates that Square returned a fee that was previously assessed because of a deposit, such as an instant deposit, back to the seller's account. |
 | `DISPUTE` | The balance change due to a dispute event. |
 | `ESCHEATMENT` | An escheatment entry for remittance. |
 | `FEE` | The cost plus adjustment fee. |
@@ -43,7 +44,7 @@
 | `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. |
-| `PAYOUT` | The balance change due to money transfer. |
+| `PAYOUT` | The balance change due to a money transfer. Note that this type is never returned by the Payouts API. |
 | `AUTOMATIC_BITCOIN_CONVERSIONS` | Indicates that the portion of each payment withheld by Square was automatically converted into bitcoin using Cash App. The seller manages their bitcoin in their Cash App account. |
 | `AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED` | Indicates that a withheld payment, which was scheduled to be converted into bitcoin using Cash App, was deposited back to the Square payments balance. |
 | `CREDIT_CARD_REPAYMENT` | Indicates that a repayment toward the outstanding balance on the seller's Square credit card was made. |
@@ -64,4 +65,6 @@
 | `BALANCE_FOLDERS_TRANSFER_REVERSED` | A reversal of transfer of funds from a banking folder. In the United States, the folder name is 'Checking Folder'; in Canada, it's 'Balance Folder.' |
 | `GIFT_CARD_POOL_TRANSFER` | A transfer of gift card funds to a central gift card pool account. In franchises, when gift cards are loaded or reloaded at any location, the money transfers to the franchisor's account. |
 | `GIFT_CARD_POOL_TRANSFER_REVERSED` | A reversal of transfer of gift card funds from a central gift card pool account. In franchises, when gift cards are loaded or reloaded at any location, the money transfers to the franchisor's account. |
+| `SQUARE_PAYROLL_TRANSFER` | A payroll payment that was transferred to a team member’s bank account. |
+| `SQUARE_PAYROLL_TRANSFER_REVERSED` | A payroll payment to a team member’s bank account that was deposited back to the seller’s account by Square. |
 

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

@@ -21,7 +21,7 @@ a request to the [AddGroupToCustomer](../../doc/api/customers.md#add-group-to-cu
   "errors": [
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     }

doc/models/additional-recipient.md

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