Skip to content

Commit 4d75295

Browse files
authored
Merge pull request #138 from square/release/2024-11-20
Generated PR for Release: 2024-11-20
2 parents b6c6183 + c17693a commit 4d75295

File tree

374 files changed

+907
-849
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

374 files changed

+907
-849
lines changed

doc/api/location-custom-attributes.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -254,15 +254,9 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
254254
```python
255255
body = {
256256
'values': {
257-
'id1': {
258-
'key': 'bestseller'
259-
},
260-
'id2': {
261-
'key': 'bestseller'
262-
},
263-
'id3': {
264-
'key': 'phone-number'
265-
}
257+
'id1': {},
258+
'id2': {},
259+
'id3': {}
266260
}
267261
}
268262

doc/api/merchant-custom-attributes.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -254,12 +254,8 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
254254
```python
255255
body = {
256256
'values': {
257-
'id1': {
258-
'key': 'alternative_seller_name'
259-
},
260-
'id2': {
261-
'key': 'has_seen_tutorial'
262-
}
257+
'id1': {},
258+
'id2': {}
263259
}
264260
}
265261

doc/api/order-custom-attributes.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,12 +269,10 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
269269
body = {
270270
'values': {
271271
'cover-count': {
272-
'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
273-
'key': 'cover-count'
272+
'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F'
274273
},
275274
'table-number': {
276-
'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
277-
'key': 'table-number'
275+
'order_id': '7BbXGEIWNldxAzrtGf9GPVZTwZ4F'
278276
}
279277
}
280278
}

doc/api/team.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,6 @@ body = {
176176
'AFMwA08kR-MIF-3Vs0OE': {
177177
'team_member': {
178178
'reference_id': 'reference_id_2',
179-
'is_owner': False,
180179
'status': 'ACTIVE',
181180
'given_name': 'Jane',
182181
'family_name': 'Smith',
@@ -190,7 +189,6 @@ body = {
190189
'fpgteZNMaf0qOK-a4t6P': {
191190
'team_member': {
192191
'reference_id': 'reference_id_1',
193-
'is_owner': False,
194192
'status': 'ACTIVE',
195193
'given_name': 'Joe',
196194
'family_name': 'Doe',

doc/client.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
55

66
| Parameter | Type | Description |
77
| --- | --- | --- |
8-
| `square_version` | `str` | Square Connect API versions<br>*Default*: `'2024-10-17'` |
8+
| `square_version` | `str` | Square Connect API versions<br>*Default*: `'2024-11-20'` |
99
| `custom_url` | `str` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `'https://connect.squareup.com'` |
1010
| `environment` | `string` | The API environment. <br> **Default: `production`** |
1111
| `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:
2424

2525
```python
2626
client = Client(
27-
square_version='2024-10-17',
27+
square_version='2024-11-20',
2828
bearer_auth_credentials=BearerAuthCredentials(
2929
access_token='AccessToken'
3030
),
@@ -53,7 +53,7 @@ from square.http.auth.o_auth_2 import BearerAuthCredentials
5353
from square.client import Client
5454

5555
client = Client(
56-
square_version='2024-10-17',
56+
square_version='2024-11-20',
5757
bearer_auth_credentials=BearerAuthCredentials(
5858
access_token='AccessToken'
5959
),

doc/models/accept-dispute-response.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ Defines the fields in an `AcceptDispute` response.
4242
"errors": [
4343
{
4444
"category": "MERCHANT_SUBSCRIPTION_ERROR",
45-
"code": "MAP_KEY_LENGTH_TOO_LONG",
45+
"code": "INVALID_EXPIRATION",
4646
"detail": "detail6",
4747
"field": "field4"
4848
},
4949
{
5050
"category": "MERCHANT_SUBSCRIPTION_ERROR",
51-
"code": "MAP_KEY_LENGTH_TOO_LONG",
51+
"code": "INVALID_EXPIRATION",
5252
"detail": "detail6",
5353
"field": "field4"
5454
},
5555
{
5656
"category": "MERCHANT_SUBSCRIPTION_ERROR",
57-
"code": "MAP_KEY_LENGTH_TOO_LONG",
57+
"code": "INVALID_EXPIRATION",
5858
"detail": "detail6",
5959
"field": "field4"
6060
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Represents an [AccumulateLoyaltyPoints](../../doc/api/loyalty.md#accumulate-loya
5757
"errors": [
5858
{
5959
"category": "MERCHANT_SUBSCRIPTION_ERROR",
60-
"code": "MAP_KEY_LENGTH_TOO_LONG",
60+
"code": "INVALID_EXPIRATION",
6161
"detail": "detail6",
6262
"field": "field4"
6363
}

doc/models/activity-type.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
| `AUTOMATIC_SAVINGS` | An automatic transfer from the payment processing balance to the Square Savings account. These are generally proportional to the seller's sales. |
1616
| `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. |
1717
| `CHARGE` | A credit card payment capture. |
18-
| `DEPOSIT_FEE` | Any fees involved with deposits such as instant deposits. |
18+
| `DEPOSIT_FEE` | A fee assessed because of a deposit, such as an instant deposit. |
19+
| `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. |
1920
| `DISPUTE` | The balance change due to a dispute event. |
2021
| `ESCHEATMENT` | An escheatment entry for remittance. |
2122
| `FEE` | The cost plus adjustment fee. |
@@ -43,7 +44,7 @@
4344
| `TAX_ON_FEE` | The tax paid on fee amounts. |
4445
| `THIRD_PARTY_FEE` | Fees collected by a third-party platform. |
4546
| `THIRD_PARTY_FEE_REFUND` | Refunded fees from a third-party platform. |
46-
| `PAYOUT` | The balance change due to money transfer. |
47+
| `PAYOUT` | The balance change due to a money transfer. Note that this type is never returned by the Payouts API. |
4748
| `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. |
4849
| `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. |
4950
| `CREDIT_CARD_REPAYMENT` | Indicates that a repayment toward the outstanding balance on the seller's Square credit card was made. |
@@ -64,4 +65,6 @@
6465
| `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.' |
6566
| `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. |
6667
| `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. |
68+
| `SQUARE_PAYROLL_TRANSFER` | A payroll payment that was transferred to a team member’s bank account. |
69+
| `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. |
6770

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ a request to the [AddGroupToCustomer](../../doc/api/customers.md#add-group-to-cu
2121
"errors": [
2222
{
2323
"category": "MERCHANT_SUBSCRIPTION_ERROR",
24-
"code": "MAP_KEY_LENGTH_TOO_LONG",
24+
"code": "INVALID_EXPIRATION",
2525
"detail": "detail6",
2626
"field": "field4"
2727
}

doc/models/additional-recipient.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Represents an additional recipient (other than the merchant) receiving a portion
2424
"description": "description2",
2525
"amount_money": {
2626
"amount": 186,
27-
"currency": "TZS"
27+
"currency": "AUD"
2828
},
2929
"receivable_id": "receivable_id8"
3030
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Represents an [AdjustLoyaltyPoints](../../doc/api/loyalty.md#adjust-loyalty-poin
5353
"errors": [
5454
{
5555
"category": "MERCHANT_SUBSCRIPTION_ERROR",
56-
"code": "MAP_KEY_LENGTH_TOO_LONG",
56+
"code": "INVALID_EXPIRATION",
5757
"detail": "detail6",
5858
"field": "field4"
5959
}

doc/models/bank-account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ linking a bank account to a Square account, see
3838
"id": "id2",
3939
"account_number_suffix": "account_number_suffix6",
4040
"country": "TT",
41-
"currency": "SLL",
41+
"currency": "MVR",
4242
"account_type": "OTHER",
4343
"holder_name": "holder_name8",
4444
"primary_bank_identification_number": "primary_bank_identification_number0",

doc/models/batch-delete-catalog-objects-response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"errors": [
2626
{
2727
"category": "MERCHANT_SUBSCRIPTION_ERROR",
28-
"code": "MAP_KEY_LENGTH_TOO_LONG",
28+
"code": "INVALID_EXPIRATION",
2929
"detail": "detail6",
3030
"field": "field4"
3131
}

doc/models/batch-retrieve-catalog-objects-response.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,19 +254,19 @@
254254
"errors": [
255255
{
256256
"category": "MERCHANT_SUBSCRIPTION_ERROR",
257-
"code": "MAP_KEY_LENGTH_TOO_LONG",
257+
"code": "INVALID_EXPIRATION",
258258
"detail": "detail6",
259259
"field": "field4"
260260
},
261261
{
262262
"category": "MERCHANT_SUBSCRIPTION_ERROR",
263-
"code": "MAP_KEY_LENGTH_TOO_LONG",
263+
"code": "INVALID_EXPIRATION",
264264
"detail": "detail6",
265265
"field": "field4"
266266
},
267267
{
268268
"category": "MERCHANT_SUBSCRIPTION_ERROR",
269-
"code": "MAP_KEY_LENGTH_TOO_LONG",
269+
"code": "INVALID_EXPIRATION",
270270
"detail": "detail6",
271271
"field": "field4"
272272
}

doc/models/batch-retrieve-orders-response.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,19 +99,19 @@ a request to the `BatchRetrieveOrders` endpoint.
9999
"errors": [
100100
{
101101
"category": "MERCHANT_SUBSCRIPTION_ERROR",
102-
"code": "MAP_KEY_LENGTH_TOO_LONG",
102+
"code": "INVALID_EXPIRATION",
103103
"detail": "detail6",
104104
"field": "field4"
105105
},
106106
{
107107
"category": "MERCHANT_SUBSCRIPTION_ERROR",
108-
"code": "MAP_KEY_LENGTH_TOO_LONG",
108+
"code": "INVALID_EXPIRATION",
109109
"detail": "detail6",
110110
"field": "field4"
111111
},
112112
{
113113
"category": "MERCHANT_SUBSCRIPTION_ERROR",
114-
"code": "MAP_KEY_LENGTH_TOO_LONG",
114+
"code": "INVALID_EXPIRATION",
115115
"detail": "detail6",
116116
"field": "field4"
117117
}

doc/models/batch-upsert-catalog-objects-response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@
329329
"errors": [
330330
{
331331
"category": "MERCHANT_SUBSCRIPTION_ERROR",
332-
"code": "MAP_KEY_LENGTH_TOO_LONG",
332+
"code": "INVALID_EXPIRATION",
333333
"detail": "detail6",
334334
"field": "field4"
335335
}

doc/models/booking-custom-attribute-upsert-response.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ Represents a response for an individual upsert request in a [BulkUpsertBookingCu
4242
"errors": [
4343
{
4444
"category": "MERCHANT_SUBSCRIPTION_ERROR",
45-
"code": "MAP_KEY_LENGTH_TOO_LONG",
45+
"code": "INVALID_EXPIRATION",
4646
"detail": "detail6",
4747
"field": "field4"
4848
},
4949
{
5050
"category": "MERCHANT_SUBSCRIPTION_ERROR",
51-
"code": "MAP_KEY_LENGTH_TOO_LONG",
51+
"code": "INVALID_EXPIRATION",
5252
"detail": "detail6",
5353
"field": "field4"
5454
},
5555
{
5656
"category": "MERCHANT_SUBSCRIPTION_ERROR",
57-
"code": "MAP_KEY_LENGTH_TOO_LONG",
57+
"code": "INVALID_EXPIRATION",
5858
"detail": "detail6",
5959
"field": "field4"
6060
}

doc/models/bulk-create-customers-response.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,19 @@ Defines the fields included in the response body from the
5757
"errors": [
5858
{
5959
"category": "MERCHANT_SUBSCRIPTION_ERROR",
60-
"code": "MAP_KEY_LENGTH_TOO_LONG",
60+
"code": "INVALID_EXPIRATION",
6161
"detail": "detail6",
6262
"field": "field4"
6363
},
6464
{
6565
"category": "MERCHANT_SUBSCRIPTION_ERROR",
66-
"code": "MAP_KEY_LENGTH_TOO_LONG",
66+
"code": "INVALID_EXPIRATION",
6767
"detail": "detail6",
6868
"field": "field4"
6969
},
7070
{
7171
"category": "MERCHANT_SUBSCRIPTION_ERROR",
72-
"code": "MAP_KEY_LENGTH_TOO_LONG",
72+
"code": "INVALID_EXPIRATION",
7373
"detail": "detail6",
7474
"field": "field4"
7575
}
@@ -112,19 +112,19 @@ Defines the fields included in the response body from the
112112
"errors": [
113113
{
114114
"category": "MERCHANT_SUBSCRIPTION_ERROR",
115-
"code": "MAP_KEY_LENGTH_TOO_LONG",
115+
"code": "INVALID_EXPIRATION",
116116
"detail": "detail6",
117117
"field": "field4"
118118
},
119119
{
120120
"category": "MERCHANT_SUBSCRIPTION_ERROR",
121-
"code": "MAP_KEY_LENGTH_TOO_LONG",
121+
"code": "INVALID_EXPIRATION",
122122
"detail": "detail6",
123123
"field": "field4"
124124
},
125125
{
126126
"category": "MERCHANT_SUBSCRIPTION_ERROR",
127-
"code": "MAP_KEY_LENGTH_TOO_LONG",
127+
"code": "INVALID_EXPIRATION",
128128
"detail": "detail6",
129129
"field": "field4"
130130
}
@@ -134,13 +134,13 @@ Defines the fields included in the response body from the
134134
"errors": [
135135
{
136136
"category": "MERCHANT_SUBSCRIPTION_ERROR",
137-
"code": "MAP_KEY_LENGTH_TOO_LONG",
137+
"code": "INVALID_EXPIRATION",
138138
"detail": "detail6",
139139
"field": "field4"
140140
},
141141
{
142142
"category": "MERCHANT_SUBSCRIPTION_ERROR",
143-
"code": "MAP_KEY_LENGTH_TOO_LONG",
143+
"code": "INVALID_EXPIRATION",
144144
"detail": "detail6",
145145
"field": "field4"
146146
}

doc/models/bulk-create-team-members-response.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ Represents a response from a bulk create request containing the created `TeamMem
4040
"errors": [
4141
{
4242
"category": "MERCHANT_SUBSCRIPTION_ERROR",
43-
"code": "MAP_KEY_LENGTH_TOO_LONG",
43+
"code": "INVALID_EXPIRATION",
4444
"detail": "detail6",
4545
"field": "field4"
4646
},
4747
{
4848
"category": "MERCHANT_SUBSCRIPTION_ERROR",
49-
"code": "MAP_KEY_LENGTH_TOO_LONG",
49+
"code": "INVALID_EXPIRATION",
5050
"detail": "detail6",
5151
"field": "field4"
5252
}
@@ -69,13 +69,13 @@ Represents a response from a bulk create request containing the created `TeamMem
6969
"errors": [
7070
{
7171
"category": "MERCHANT_SUBSCRIPTION_ERROR",
72-
"code": "MAP_KEY_LENGTH_TOO_LONG",
72+
"code": "INVALID_EXPIRATION",
7373
"detail": "detail6",
7474
"field": "field4"
7575
},
7676
{
7777
"category": "MERCHANT_SUBSCRIPTION_ERROR",
78-
"code": "MAP_KEY_LENGTH_TOO_LONG",
78+
"code": "INVALID_EXPIRATION",
7979
"detail": "detail6",
8080
"field": "field4"
8181
}
@@ -85,7 +85,7 @@ Represents a response from a bulk create request containing the created `TeamMem
8585
"errors": [
8686
{
8787
"category": "MERCHANT_SUBSCRIPTION_ERROR",
88-
"code": "MAP_KEY_LENGTH_TOO_LONG",
88+
"code": "INVALID_EXPIRATION",
8989
"detail": "detail6",
9090
"field": "field4"
9191
}

doc/models/bulk-create-vendors-response.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@ Represents an output from a call to [BulkCreateVendors](../../doc/api/vendors.md
7272
"errors": [
7373
{
7474
"category": "MERCHANT_SUBSCRIPTION_ERROR",
75-
"code": "MAP_KEY_LENGTH_TOO_LONG",
75+
"code": "INVALID_EXPIRATION",
7676
"detail": "detail6",
7777
"field": "field4"
7878
},
7979
{
8080
"category": "MERCHANT_SUBSCRIPTION_ERROR",
81-
"code": "MAP_KEY_LENGTH_TOO_LONG",
81+
"code": "INVALID_EXPIRATION",
8282
"detail": "detail6",
8383
"field": "field4"
8484
},
8585
{
8686
"category": "MERCHANT_SUBSCRIPTION_ERROR",
87-
"code": "MAP_KEY_LENGTH_TOO_LONG",
87+
"code": "INVALID_EXPIRATION",
8888
"detail": "detail6",
8989
"field": "field4"
9090
}

0 commit comments

Comments
 (0)