Skip to content

Commit f725068

Browse files
authored
Merge pull request #134 from square/release/39.0.0.20240821
Generated PR for Release: 39.0.0.20240821
2 parents 0b28dfb + 4ecd411 commit f725068

31 files changed

+132
-83
lines changed

doc/api/booking-custom-attributes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,11 +258,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
258258
```ruby
259259
body = {
260260
:values => {
261-
'key0': {
261+
'key0' => {
262262
:booking_id => 'booking_id4',
263263
:key => 'key0'
264264
},
265-
'key1': {
265+
'key1' => {
266266
:booking_id => 'booking_id4',
267267
:key => 'key0'
268268
}
@@ -309,11 +309,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
309309
```ruby
310310
body = {
311311
:values => {
312-
'key0': {
312+
'key0' => {
313313
:booking_id => 'booking_id4',
314314
:custom_attribute => {}
315315
},
316-
'key1': {
316+
'key1' => {
317317
:booking_id => 'booking_id4',
318318
:custom_attribute => {}
319319
}

doc/api/catalog.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ children.
3939
IDs can be deleted. The response will only include IDs that were
4040
actually deleted.
4141

42-
To ensure consistency, only one delete request is processed at a time per seller account.
42+
To ensure consistency, only one delete request is processed at a time per seller account.
4343
While one (batch or non-batch) delete request is being processed, other (batched and non-batched)
4444
delete requests are rejected with the `429` error code.
4545

@@ -135,7 +135,7 @@ batches will be processed in order as long as the total object count for the
135135
request (items, variations, modifier lists, discounts, and taxes) is no more
136136
than 10,000.
137137

138-
To ensure consistency, only one update request is processed at a time per seller account.
138+
To ensure consistency, only one update request is processed at a time per seller account.
139139
While one (batch or non-batch) update request is being processed, other (batched and non-batched)
140140
update requests are rejected with the `429` error code.
141141

@@ -449,7 +449,7 @@ end
449449

450450
Creates a new or updates the specified [CatalogObject](../../doc/models/catalog-object.md).
451451

452-
To ensure consistency, only one update request is processed at a time per seller account.
452+
To ensure consistency, only one update request is processed at a time per seller account.
453453
While one (batch or non-batch) update request is being processed, other (batched and non-batched)
454454
update requests are rejected with the `429` error code.
455455

@@ -527,7 +527,7 @@ are also deleted. For example, deleting a [CatalogItem](../../doc/models/catalog
527527
will also delete all of its
528528
[CatalogItemVariation](../../doc/models/catalog-item-variation.md) children.
529529

530-
To ensure consistency, only one delete request is processed at a time per seller account.
530+
To ensure consistency, only one delete request is processed at a time per seller account.
531531
While one (batch or non-batch) delete request is being processed, other (batched and non-batched)
532532
delete requests are rejected with the `429` error code.
533533

doc/api/customer-custom-attributes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,11 +278,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
278278
```ruby
279279
body = {
280280
:values => {
281-
'key0': {
281+
'key0' => {
282282
:customer_id => 'customer_id8',
283283
:custom_attribute => {}
284284
},
285-
'key1': {
285+
'key1' => {
286286
:customer_id => 'customer_id8',
287287
:custom_attribute => {}
288288
}

doc/api/customers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
163163
```ruby
164164
body = {
165165
:customers => {
166-
'8bb76c4f-e35d-4c5b-90de-1194cd9179f0': {
166+
'8bb76c4f-e35d-4c5b-90de-1194cd9179f0' => {
167167
:given_name => 'Amelia',
168168
:family_name => 'Earhart',
169169
:email_address => '[email protected]',
@@ -179,7 +179,7 @@ body = {
179179
:reference_id => 'YOUR_REFERENCE_ID',
180180
:note => 'a customer'
181181
},
182-
'd1689f23-b25d-4932-b2f0-aed00f5e2029': {
182+
'd1689f23-b25d-4932-b2f0-aed00f5e2029' => {
183183
:given_name => 'Marie',
184184
:family_name => 'Curie',
185185
:email_address => '[email protected]',
@@ -320,13 +320,13 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
320320
```ruby
321321
body = {
322322
:customers => {
323-
'8DDA5NZVBZFGAX0V3HPF81HHE0': {
323+
'8DDA5NZVBZFGAX0V3HPF81HHE0' => {
324324
:email_address => '[email protected]',
325325
:phone_number => 'phone_number2',
326326
:note => 'updated customer note',
327327
:version => 2
328328
},
329-
'N18CPRVXR5214XPBBA6BZQWF3C': {
329+
'N18CPRVXR5214XPBBA6BZQWF3C' => {
330330
:given_name => 'Marie',
331331
:family_name => 'Curie',
332332
:version => 0

doc/api/gift-card-activities.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,7 @@ end
6565
# Create Gift Card Activity
6666

6767
Creates a gift card activity to manage the balance or state of a [gift card](../../doc/models/gift-card.md).
68-
For example, you create an `ACTIVATE` activity to activate a gift card with an initial balance
69-
before the gift card can be used.
68+
For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use.
7069

7170
```ruby
7271
def create_gift_card_activity(body:)

doc/api/gift-cards.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,11 @@ end
6161

6262
# Create Gift Card
6363

64-
Creates a digital gift card or registers a physical (plastic) gift card. After the gift card
65-
is created, you must call [CreateGiftCardActivity](../../doc/api/gift-card-activities.md#create-gift-card-activity)
66-
to activate the card with an initial balance before it can be used for payment.
64+
Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card
65+
has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call
66+
[CreateGiftCardActivity](../../doc/api/gift-card-activities.md#create-gift-card-activity) and create an `ACTIVATE`
67+
activity with the initial balance. Alternatively, you can use [RefundPayment](../../doc/api/refunds.md#refund-payment)
68+
to refund a payment to the new gift card.
6769

6870
```ruby
6971
def create_gift_card(body:)

doc/api/location-custom-attributes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -257,13 +257,13 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
257257
```ruby
258258
body = {
259259
:values => {
260-
'id1': {
260+
'id1' => {
261261
:key => 'bestseller'
262262
},
263-
'id2': {
263+
'id2' => {
264264
:key => 'bestseller'
265265
},
266-
'id3': {
266+
'id3' => {
267267
:key => 'phone-number'
268268
}
269269
}
@@ -312,11 +312,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
312312
```ruby
313313
body = {
314314
:values => {
315-
'key0': {
315+
'key0' => {
316316
:location_id => 'location_id4',
317317
:custom_attribute => {}
318318
},
319-
'key1': {
319+
'key1' => {
320320
:location_id => 'location_id4',
321321
:custom_attribute => {}
322322
}

doc/api/merchant-custom-attributes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,10 +257,10 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
257257
```ruby
258258
body = {
259259
:values => {
260-
'id1': {
260+
'id1' => {
261261
:key => 'alternative_seller_name'
262262
},
263-
'id2': {
263+
'id2' => {
264264
:key => 'has_seen_tutorial'
265265
}
266266
}
@@ -309,11 +309,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
309309
```ruby
310310
body = {
311311
:values => {
312-
'key0': {
312+
'key0' => {
313313
:merchant_id => 'merchant_id0',
314314
:custom_attribute => {}
315315
},
316-
'key1': {
316+
'key1' => {
317317
:merchant_id => 'merchant_id0',
318318
:custom_attribute => {}
319319
}

doc/api/o-auth.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -148,29 +148,18 @@ where `ACCESS_TOKEN` is a
148148

149149
If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED` error.
150150

151-
:information_source: **Note** This endpoint does not require authentication.
152-
153151
```ruby
154-
def retrieve_token_status(authorization:)
152+
def retrieve_token_status
155153
```
156154

157-
## Parameters
158-
159-
| Parameter | Type | Tags | Description |
160-
| --- | --- | --- | --- |
161-
| `authorization` | `String` | Header, Required | Client APPLICATION_SECRET |
162-
163155
## Response Type
164156

165157
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Token Status Response Hash`](../../doc/models/retrieve-token-status-response.md).
166158

167159
## Example Usage
168160

169161
```ruby
170-
authorization = 'Client CLIENT_SECRET'
171-
172-
173-
result = o_auth_api.retrieve_token_status(authorization: authorization)
162+
result = o_auth_api.retrieve_token_status
174163

175164
if result.success?
176165
puts result.data

doc/api/order-custom-attributes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -271,11 +271,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
271271
```ruby
272272
body = {
273273
:values => {
274-
'cover-count': {
274+
'cover-count' => {
275275
:order_id => '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
276276
:key => 'cover-count'
277277
},
278-
'table-number': {
278+
'table-number' => {
279279
:order_id => '7BbXGEIWNldxAzrtGf9GPVZTwZ4F',
280280
:key => 'table-number'
281281
}
@@ -329,11 +329,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
329329
```ruby
330330
body = {
331331
:values => {
332-
'key0': {
332+
'key0' => {
333333
:custom_attribute => {},
334334
:order_id => 'order_id4'
335335
},
336-
'key1': {
336+
'key1' => {
337337
:custom_attribute => {},
338338
:order_id => 'order_id4'
339339
}

0 commit comments

Comments
 (0)