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

Generated PR for Release: 2024-11-20
square · Nov 20, 2024 · 5932fed · 5932fed
2 parents cbc322a + 021f97a
commit 5932fed
Show file tree

Hide file tree

Showing 374 changed files with 906 additions and 848 deletions.
diff --git a/doc/api/location-custom-attributes.md b/doc/api/location-custom-attributes.md
@@ -257,15 +257,9 @@ This method returns a `ApiResponse` instance. The `data` property in this instan
 ```ruby
 body = {
   :values => {
-    'id1' => {
-      :key => 'bestseller'
-    },
-    'id2' => {
-      :key => 'bestseller'
-    },
-    'id3' => {
-      :key => 'phone-number'
-    }
+    'id1' => {},
+    'id2' => {},
+    'id3' => {}
   }
 }
 

diff --git a/doc/api/merchant-custom-attributes.md b/doc/api/merchant-custom-attributes.md
@@ -257,12 +257,8 @@ This method returns a `ApiResponse` instance. The `data` property in this instan
 ```ruby
 body = {
   :values => {
-    'id1' => {
-      :key => 'alternative_seller_name'
-    },
-    'id2' => {
-      :key => 'has_seen_tutorial'
-    }
+    'id1' => {},
+    'id2' => {}
   }
 }
 

diff --git a/doc/api/order-custom-attributes.md b/doc/api/order-custom-attributes.md
@@ -272,12 +272,10 @@ This method returns a `ApiResponse` instance. The `data` property in 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'
     }
   }
 }

diff --git a/doc/api/team.md b/doc/api/team.md
@@ -177,7 +177,6 @@ body = {
     'AFMwA08kR-MIF-3Vs0OE' => {
       :team_member => {
         :reference_id => 'reference_id_2',
-        :is_owner => false,
         :status => 'ACTIVE',
         :given_name => 'Jane',
         :family_name => 'Smith',
@@ -191,7 +190,6 @@ body = {
     'fpgteZNMaf0qOK-a4t6P' => {
       :team_member => {
         :reference_id => 'reference_id_1',
-        :is_owner => false,
         :status => 'ACTIVE',
         :given_name => 'Joe',
         :family_name => 'Doe',

diff --git 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<br>*Default*: `'2024-10-17'` |
+| `square_version` | `String` | Square Connect API versions<br>*Default*: `'2024-11-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`** |
 | `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
@@ -25,7 +25,7 @@ The API client can be initialized as follows:
 
 ```ruby
 client = Square::Client.new(
-  square_version: '2024-10-17',
+  square_version: '2024-11-20',
   bearer_auth_credentials: BearerAuthCredentials.new(
     access_token: 'AccessToken'
   ),
@@ -55,7 +55,7 @@ require 'square'
 include Square
 
 client = Square::Client.new(
-  square_version: '2024-10-17',
+  square_version: '2024-11-20',
   bearer_auth_credentials: BearerAuthCredentials.new(
     access_token: 'AccessToken'
   ),

diff --git a/doc/models/accept-dispute-response.md b/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"
     }

diff --git a/doc/models/accumulate-loyalty-points-response.md b/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"
     }

diff --git a/doc/models/activity-type.md b/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. |
 
diff --git a/doc/models/add-group-to-customer-response.md b/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"
     }

diff --git a/doc/models/additional-recipient.md b/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"
 }

diff --git a/doc/models/adjust-loyalty-points-response.md b/doc/models/adjust-loyalty-points-response.md
@@ -53,7 +53,7 @@ Represents an [AdjustLoyaltyPoints](../../doc/api/loyalty.md#adjust-loyalty-poin
   "errors": [
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     }

diff --git a/doc/models/bank-account.md b/doc/models/bank-account.md
@@ -38,7 +38,7 @@ linking a bank account to a Square account, see
   "id": "id2",
   "account_number_suffix": "account_number_suffix6",
   "country": "TT",
-  "currency": "SLL",
+  "currency": "MVR",
   "account_type": "OTHER",
   "holder_name": "holder_name8",
   "primary_bank_identification_number": "primary_bank_identification_number0",

diff --git a/doc/models/batch-delete-catalog-objects-response.md b/doc/models/batch-delete-catalog-objects-response.md
@@ -25,7 +25,7 @@
   "errors": [
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     }

diff --git a/doc/models/batch-retrieve-catalog-objects-response.md b/doc/models/batch-retrieve-catalog-objects-response.md
@@ -254,19 +254,19 @@
   "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"
     }

diff --git a/doc/models/batch-retrieve-orders-response.md b/doc/models/batch-retrieve-orders-response.md
@@ -99,19 +99,19 @@ a request to the `BatchRetrieveOrders` endpoint.
   "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"
     }

diff --git a/doc/models/batch-upsert-catalog-objects-response.md b/doc/models/batch-upsert-catalog-objects-response.md
@@ -329,7 +329,7 @@
   "errors": [
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     }

diff --git a/doc/models/booking-custom-attribute-upsert-response.md b/doc/models/booking-custom-attribute-upsert-response.md
@@ -42,19 +42,19 @@ Represents a response for an individual upsert request in a [BulkUpsertBookingCu
   "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"
     }

diff --git a/doc/models/bulk-create-customers-response.md b/doc/models/bulk-create-customers-response.md
@@ -57,19 +57,19 @@ Defines the fields included in the response body from the
       "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"
         }
@@ -112,19 +112,19 @@ Defines the fields included in the response body from the
       "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"
         }
@@ -134,13 +134,13 @@ Defines the fields included in the response body from the
   "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"
     }

diff --git a/doc/models/bulk-create-team-members-response.md b/doc/models/bulk-create-team-members-response.md
@@ -40,13 +40,13 @@ Represents a response from a bulk create request containing the created `TeamMem
       "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"
         }
@@ -69,13 +69,13 @@ Represents a response from a bulk create request containing the created `TeamMem
       "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"
         }
@@ -85,7 +85,7 @@ Represents a response from a bulk create request containing the created `TeamMem
   "errors": [
     {
       "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
+      "code": "INVALID_EXPIRATION",
       "detail": "detail6",
       "field": "field4"
     }

diff --git a/doc/models/bulk-create-vendors-response.md b/doc/models/bulk-create-vendors-response.md
@@ -72,19 +72,19 @@ Represents an output from a call to [BulkCreateVendors](../../doc/api/vendors.md
       "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"
         }