Merge pull request #160 from square/release/2024-11-20

Generated PR for Release: 2024-11-20

Author: mikekono

doc/api/location-custom-attributes.md

@@ -280,15 +280,9 @@ requestOptions?: RequestOptions): Promise<ApiResponse<BulkDeleteLocationCustomAt
 ```ts
 const body: BulkDeleteLocationCustomAttributesRequest = {
   values: {
-    'id1': {
-      key: 'bestseller',
-    },
-    'id2': {
-      key: 'bestseller',
-    },
-    'id3': {
-      key: 'phone-number',
-    }
+    'id1': {},
+    'id2': {},
+    'id3': {}
   },
 };
 

doc/api/merchant-custom-attributes.md

@@ -280,12 +280,8 @@ requestOptions?: RequestOptions): Promise<ApiResponse<BulkDeleteMerchantCustomAt
 ```ts
 const body: BulkDeleteMerchantCustomAttributesRequest = {
   values: {
-    'id1': {
-      key: 'alternative_seller_name',
-    },
-    'id2': {
-      key: 'has_seen_tutorial',
-    }
+    'id1': {},
+    'id2': {}
   },
 };
 

doc/api/order-custom-attributes.md

@@ -296,11 +296,9 @@ const body: BulkDeleteOrderCustomAttributesRequest = {
   values: {
     'cover-count': {
       orderId: '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
-      key: 'cover-count',
     },
     'table-number': {
       orderId: '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
-      key: 'table-number',
     }
   },
 };

doc/api/team.md

@@ -187,7 +187,6 @@ const body: BulkUpdateTeamMembersRequest = {
     'AFMwA08kR-MIF-3Vs0OE': {
       teamMember: {
         referenceId: 'reference_id_2',
-        isOwner: false,
         status: 'ACTIVE',
         givenName: 'Jane',
         familyName: 'Smith',
@@ -201,7 +200,6 @@ const body: BulkUpdateTeamMembersRequest = {
     'fpgteZNMaf0qOK-a4t6P': {
       teamMember: {
         referenceId: 'reference_id_1',
-        isOwner: false,
         status: 'ACTIVE',
         givenName: 'Joe',
         familyName: 'Doe',

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `squareVersion` | `string` | Square Connect API versions<br>*Default*: `'2024-10-17'` |
+| `squareVersion` | `string` | Square Connect API versions<br>*Default*: `'2024-11-20'` |
 | `customUrl` | `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`** |
 | `additionalHeaders` | `Readonly<Record<string, string>>` | Additional headers to add to each API call<br>*Default*: `{}` |
@@ -43,7 +43,7 @@ const client = new Client({
   bearerAuthCredentials: {
     accessToken: 'AccessToken'
   },
-  squareVersion: '2024-10-17',
+  squareVersion: '2024-11-20',
   timeout: 60000,
   additionalHeaders: {},
   userAgentDetail: '',
@@ -61,7 +61,7 @@ const client = new Client({
   bearerAuthCredentials: {
     accessToken: 'AccessToken'
   },
-  squareVersion: '2024-10-17',
+  squareVersion: '2024-11-20',
   timeout: 60000,
   additionalHeaders: {},
   userAgentDetail: '',

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"
 }