Skip to content

Commit d57e3fe

Browse files
authored
Merge pull request #122 from square/release/32.0.0.20230925
Generated PR for Release: 32.0.0.20230925
2 parents 267cf70 + 38b0b60 commit d57e3fe

File tree

786 files changed

+7410
-7988
lines changed

Some content is hidden

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

786 files changed

+7410
-7988
lines changed

doc/api/booking-custom-attributes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -259,12 +259,12 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
259259
body = {
260260
:values => {
261261
'key0': {
262-
:booking_id => 'booking_id8',
263-
:key => 'key4'
262+
:booking_id => 'booking_id4',
263+
:key => 'key0'
264264
},
265265
'key1': {
266-
:booking_id => 'booking_id9',
267-
:key => 'key5'
266+
:booking_id => 'booking_id4',
267+
:key => 'key0'
268268
}
269269
}
270270
}
@@ -310,11 +310,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
310310
body = {
311311
:values => {
312312
'key0': {
313-
:booking_id => 'booking_id8',
313+
:booking_id => 'booking_id4',
314314
:custom_attribute => {}
315315
},
316316
'key1': {
317-
:booking_id => 'booking_id9',
317+
:booking_id => 'booking_id4',
318318
:custom_attribute => {}
319319
}
320320
}

doc/api/bookings.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ bookings_api = client.bookings
1616
* [Bulk Retrieve Bookings](../../doc/api/bookings.md#bulk-retrieve-bookings)
1717
* [Retrieve Business Booking Profile](../../doc/api/bookings.md#retrieve-business-booking-profile)
1818
* [List Team Member Booking Profiles](../../doc/api/bookings.md#list-team-member-booking-profiles)
19+
* [Bulk Retrieve Team Member Booking Profiles](../../doc/api/bookings.md#bulk-retrieve-team-member-booking-profiles)
1920
* [Retrieve Team Member Booking Profile](../../doc/api/bookings.md#retrieve-team-member-booking-profile)
2021
* [Retrieve Booking](../../doc/api/bookings.md#retrieve-booking)
2122
* [Update Booking](../../doc/api/bookings.md#update-booking)
@@ -269,6 +270,46 @@ end
269270
```
270271

271272

273+
# Bulk Retrieve Team Member Booking Profiles
274+
275+
Retrieves one or more team members' booking profiles.
276+
277+
```ruby
278+
def bulk_retrieve_team_member_booking_profiles(body:)
279+
```
280+
281+
## Parameters
282+
283+
| Parameter | Type | Tags | Description |
284+
| --- | --- | --- | --- |
285+
| `body` | [`Bulk Retrieve Team Member Booking Profiles Request Hash`](../../doc/models/bulk-retrieve-team-member-booking-profiles-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
286+
287+
## Response Type
288+
289+
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Team Member Booking Profiles Response Hash`](../../doc/models/bulk-retrieve-team-member-booking-profiles-response.md).
290+
291+
## Example Usage
292+
293+
```ruby
294+
body = {
295+
:team_member_ids => [
296+
'team_member_ids3',
297+
'team_member_ids4',
298+
'team_member_ids5'
299+
]
300+
}
301+
302+
303+
result = bookings_api.bulk_retrieve_team_member_booking_profiles(body: body)
304+
305+
if result.success?
306+
puts result.data
307+
elsif result.error?
308+
warn result.errors
309+
end
310+
```
311+
312+
272313
# Retrieve Team Member Booking Profile
273314

274315
Retrieves a team member's booking profile.

doc/api/checkout.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ payment processing workflow hosted on connect.squareup.com.
2828

2929
NOTE: The Checkout API has been updated with new features.
3030
For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).
31-
We recommend that you use the new [CreatePaymentLink](api-endpoint:Checkout-CreatePaymentLink) 
32-
endpoint in place of this previously released endpoint.
3331

3432
```ruby
3533
def create_checkout(location_id:,

doc/api/customer-custom-attributes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,11 +279,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
279279
body = {
280280
:values => {
281281
'key0': {
282-
:customer_id => 'customer_id2',
282+
:customer_id => 'customer_id8',
283283
:custom_attribute => {}
284284
},
285285
'key1': {
286-
:customer_id => 'customer_id3',
286+
:customer_id => 'customer_id8',
287287
:custom_attribute => {}
288288
}
289289
}

doc/api/customers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,8 @@ body = {
166166
:rule => 'INCLUDE'
167167
},
168168
:created_at => {
169-
:start_at => '2018-01-01T00:00:00+00:00',
170-
:end_at => '2018-02-01T00:00:00+00:00'
169+
:start_at => '2018-01-01T00:00:00-00:00',
170+
:end_at => '2018-02-01T00:00:00-00:00'
171171
},
172172
:email_address => {
173173
:fuzzy => 'example.com'

doc/api/devices.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,49 @@ devices_api = client.devices
1010

1111
## Methods
1212

13+
* [List Devices](../../doc/api/devices.md#list-devices)
1314
* [List Device Codes](../../doc/api/devices.md#list-device-codes)
1415
* [Create Device Code](../../doc/api/devices.md#create-device-code)
1516
* [Get Device Code](../../doc/api/devices.md#get-device-code)
17+
* [Get Device](../../doc/api/devices.md#get-device)
18+
19+
20+
# List Devices
21+
22+
List devices associated with the merchant. Currently, only Terminal API
23+
devices are supported.
24+
25+
```ruby
26+
def list_devices(cursor: nil,
27+
sort_order: nil,
28+
limit: nil,
29+
location_id: nil)
30+
```
31+
32+
## Parameters
33+
34+
| Parameter | Type | Tags | Description |
35+
| --- | --- | --- | --- |
36+
| `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for the original query.<br>See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. |
37+
| `sort_order` | [`String (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | The order in which results are listed.<br><br>- `ASC` - Oldest to newest.<br>- `DESC` - Newest to oldest (default). |
38+
| `limit` | `Integer` | Query, Optional | The number of results to return in a single page. |
39+
| `location_id` | `String` | Query, Optional | If present, only returns devices at the target location. |
40+
41+
## Response Type
42+
43+
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Devices Response Hash`](../../doc/models/list-devices-response.md).
44+
45+
## Example Usage
46+
47+
```ruby
48+
result = devices_api.list_devices
49+
50+
if result.success?
51+
puts result.data
52+
elsif result.error?
53+
warn result.errors
54+
end
55+
```
1656

1757

1858
# List Device Codes
@@ -127,3 +167,37 @@ elsif result.error?
127167
end
128168
```
129169

170+
171+
# Get Device
172+
173+
Retrieves Device with the associated `device_id`.
174+
175+
```ruby
176+
def get_device(device_id:)
177+
```
178+
179+
## Parameters
180+
181+
| Parameter | Type | Tags | Description |
182+
| --- | --- | --- | --- |
183+
| `device_id` | `String` | Template, Required | The unique ID for the desired `Device`. |
184+
185+
## Response Type
186+
187+
This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Device Response Hash`](../../doc/models/get-device-response.md).
188+
189+
## Example Usage
190+
191+
```ruby
192+
device_id = 'device_id6'
193+
194+
195+
result = devices_api.get_device(device_id: device_id)
196+
197+
if result.success?
198+
puts result.data
199+
elsif result.error?
200+
warn result.errors
201+
end
202+
```
203+

doc/api/inventory.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,8 @@ body = {
188188
:states => [
189189
'IN_STOCK'
190190
],
191-
:updated_after => '2016-11-01T00:00:00Z',
192-
:updated_before => '2016-12-01T00:00:00Z'
191+
:updated_after => '2016-11-01T00:00:00.000Z',
192+
:updated_before => '2016-12-01T00:00:00.000Z'
193193
}
194194

195195

@@ -234,7 +234,7 @@ body = {
234234
:location_ids => [
235235
'59TNP9SA8VGDA'
236236
],
237-
:updated_after => '2016-11-16T00:00:00Z'
237+
:updated_after => '2016-11-16T00:00:00.000Z'
238238
}
239239

240240

@@ -344,8 +344,8 @@ body = {
344344
:states => [
345345
'IN_STOCK'
346346
],
347-
:updated_after => '2016-11-01T00:00:00Z',
348-
:updated_before => '2016-12-01T00:00:00Z'
347+
:updated_after => '2016-11-01T00:00:00.000Z',
348+
:updated_before => '2016-12-01T00:00:00.000Z'
349349
}
350350

351351

@@ -397,7 +397,7 @@ body = {
397397
:location_ids => [
398398
'59TNP9SA8VGDA'
399399
],
400-
:updated_after => '2016-11-16T00:00:00Z'
400+
:updated_after => '2016-11-16T00:00:00.000Z'
401401
}
402402

403403

doc/api/labor.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -351,9 +351,9 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
351351
```ruby
352352
body = {
353353
:shift => {
354-
:start_at => '2019-01-25T08:11:00+00:00',
354+
:start_at => '2019-01-25T03:11:00-05:00',
355355
:location_id => 'PAA1RJZZKXBFG',
356-
:end_at => '2019-01-25T18:11:00+00:00',
356+
:end_at => '2019-01-25T13:11:00-05:00',
357357
:wage => {
358358
:title => 'Barista',
359359
:hourly_rate => {
@@ -363,12 +363,12 @@ body = {
363363
},
364364
:breaks => [
365365
{
366-
:start_at => '2019-01-25T11:11:00+00:00',
366+
:start_at => '2019-01-25T06:11:00-05:00',
367367
:break_type_id => 'REGS1EQR1TPZ5',
368368
:name => 'Tea Break',
369369
:expected_duration => 'PT5M',
370370
:is_paid => true,
371-
:end_at => '2019-01-25T11:16:00+00:00'
371+
:end_at => '2019-01-25T06:16:00-05:00'
372372
}
373373
],
374374
:team_member_id => 'ormj0jJJZ5OZIzxrZYJI'
@@ -551,9 +551,9 @@ id = 'id0'
551551

552552
body = {
553553
:shift => {
554-
:start_at => '2019-01-25T08:11:00+00:00',
554+
:start_at => '2019-01-25T03:11:00-05:00',
555555
:location_id => 'PAA1RJZZKXBFG',
556-
:end_at => '2019-01-25T18:11:00+00:00',
556+
:end_at => '2019-01-25T13:11:00-05:00',
557557
:wage => {
558558
:title => 'Bartender',
559559
:hourly_rate => {
@@ -563,13 +563,13 @@ body = {
563563
},
564564
:breaks => [
565565
{
566-
:start_at => '2019-01-25T11:11:00+00:00',
566+
:start_at => '2019-01-25T06:11:00-05:00',
567567
:break_type_id => 'REGS1EQR1TPZ5',
568568
:name => 'Tea Break',
569569
:expected_duration => 'PT5M',
570570
:is_paid => true,
571571
:id => 'X7GAQYVVRRG6P',
572-
:end_at => '2019-01-25T11:16:00+00:00'
572+
:end_at => '2019-01-25T06:16:00-05:00'
573573
}
574574
],
575575
:version => 1,

doc/api/location-custom-attributes.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,15 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
257257
```ruby
258258
body = {
259259
:values => {
260-
'id1': {},
261-
'id2': {},
262-
'id3': {}
260+
'id1': {
261+
:key => 'bestseller'
262+
},
263+
'id2': {
264+
:key => 'bestseller'
265+
},
266+
'id3': {
267+
:key => 'phone-number'
268+
}
263269
}
264270
}
265271

@@ -307,11 +313,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
307313
body = {
308314
:values => {
309315
'key0': {
310-
:location_id => 'location_id8',
316+
:location_id => 'location_id4',
311317
:custom_attribute => {}
312318
},
313319
'key1': {
314-
:location_id => 'location_id9',
320+
:location_id => 'location_id4',
315321
:custom_attribute => {}
316322
}
317323
}

doc/api/merchant-custom-attributes.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,12 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
257257
```ruby
258258
body = {
259259
:values => {
260-
'id1': {},
261-
'id2': {}
260+
'id1': {
261+
:key => 'alternative_seller_name'
262+
},
263+
'id2': {
264+
:key => 'has_seen_tutorial'
265+
}
262266
}
263267
}
264268

@@ -306,11 +310,11 @@ This method returns a `\ApiResponse` instance. The `data` property in this insta
306310
body = {
307311
:values => {
308312
'key0': {
309-
:merchant_id => 'merchant_id4',
313+
:merchant_id => 'merchant_id0',
310314
:custom_attribute => {}
311315
},
312316
'key1': {
313-
:merchant_id => 'merchant_id5',
317+
:merchant_id => 'merchant_id0',
314318
:custom_attribute => {}
315319
}
316320
}

0 commit comments

Comments
 (0)