Merge pull request #120 from square/release/31.0.0.20230925

Generated PR for Release: 31.0.0.20230925

Author: dotspencer

doc/api/booking-custom-attributes.md

@@ -261,12 +261,12 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 body = {
     'values': {
         'key0': {
-            'booking_id': 'booking_id8',
-            'key': 'key4'
+            'booking_id': 'booking_id4',
+            'key': 'key0'
         },
         'key1': {
-            'booking_id': 'booking_id9',
-            'key': 'key5'
+            'booking_id': 'booking_id4',
+            'key': 'key0'
         }
     }
 }
@@ -312,11 +312,11 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 body = {
     'values': {
         'key0': {
-            'booking_id': 'booking_id8',
+            'booking_id': 'booking_id4',
             'custom_attribute': {}
         },
         'key1': {
-            'booking_id': 'booking_id9',
+            'booking_id': 'booking_id4',
             'custom_attribute': {}
         }
     }
@@ -369,7 +369,7 @@ with_definitions = False
 
 result = booking_custom_attributes_api.list_booking_custom_attributes(
     booking_id,
-    with_definitions
+    with_definitions=with_definitions
 )
 print(result)
 
@@ -467,7 +467,7 @@ with_definition = False
 result = booking_custom_attributes_api.retrieve_booking_custom_attribute(
     booking_id,
     key,
-    with_definition
+    with_definition=with_definition
 )
 print(result)
 

doc/api/bookings.md

@@ -16,6 +16,7 @@ bookings_api = client.bookings
 * [Bulk Retrieve Bookings](../../doc/api/bookings.md#bulk-retrieve-bookings)
 * [Retrieve Business Booking Profile](../../doc/api/bookings.md#retrieve-business-booking-profile)
 * [List Team Member Booking Profiles](../../doc/api/bookings.md#list-team-member-booking-profiles)
+* [Bulk Retrieve Team Member Booking Profiles](../../doc/api/bookings.md#bulk-retrieve-team-member-booking-profiles)
 * [Retrieve Team Member Booking Profile](../../doc/api/bookings.md#retrieve-team-member-booking-profile)
 * [Retrieve Booking](../../doc/api/bookings.md#retrieve-booking)
 * [Update Booking](../../doc/api/bookings.md#update-booking)
@@ -261,7 +262,7 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 bookable_only = False
 
 result = bookings_api.list_team_member_booking_profiles(
-    bookable_only
+    bookable_only=bookable_only
 )
 print(result)
 
@@ -272,6 +273,46 @@ elif result.is_error():
 ```
 
 
+# Bulk Retrieve Team Member Booking Profiles
+
+Retrieves one or more team members' booking profiles.
+
+```python
+def bulk_retrieve_team_member_booking_profiles(self,
+                                              body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `body` | [`Bulk Retrieve Team Member Booking Profiles Request`](../../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. |
+
+## Response Type
+
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Bulk Retrieve Team Member Booking Profiles Response`](../../doc/models/bulk-retrieve-team-member-booking-profiles-response.md).
+
+## Example Usage
+
+```python
+body = {
+    'team_member_ids': [
+        'team_member_ids3',
+        'team_member_ids4',
+        'team_member_ids5'
+    ]
+}
+
+result = bookings_api.bulk_retrieve_team_member_booking_profiles(body)
+print(result)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+
+
 # Retrieve Team Member Booking Profile
 
 Retrieves a team member's booking profile.

doc/api/cards.md

@@ -50,7 +50,7 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 include_disabled = False
 
 result = cards_api.list_cards(
-    include_disabled
+    include_disabled=include_disabled
 )
 print(result)
 

doc/api/catalog.md

@@ -312,7 +312,7 @@ request = {
 }
 
 result = catalog_api.create_catalog_image(
-    request
+    request=request
 )
 print(result)
 
@@ -360,7 +360,7 @@ request = {
 
 result = catalog_api.update_catalog_image(
     image_id,
-    request
+    request=request
 )
 print(result)
 
@@ -594,7 +594,7 @@ include_related_objects = False
 
 result = catalog_api.retrieve_catalog_object(
     object_id,
-    include_related_objects
+    include_related_objects=include_related_objects
 )
 print(result)
 

doc/api/checkout.md

@@ -28,8 +28,6 @@ payment processing workflow hosted on connect.squareup.com.
 
 NOTE: The Checkout API has been updated with new features.
 For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights).
-We recommend that you use the new [CreatePaymentLink](api-endpoint:Checkout-CreatePaymentLink) 
-endpoint in place of this previously released endpoint.
 
 ```python
 def create_checkout(self,

doc/api/customer-custom-attributes.md

@@ -281,11 +281,11 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 body = {
     'values': {
         'key0': {
-            'customer_id': 'customer_id2',
+            'customer_id': 'customer_id8',
             'custom_attribute': {}
         },
         'key1': {
-            'customer_id': 'customer_id3',
+            'customer_id': 'customer_id8',
             'custom_attribute': {}
         }
     }
@@ -342,7 +342,7 @@ with_definitions = False
 
 result = customer_custom_attributes_api.list_customer_custom_attributes(
     customer_id,
-    with_definitions
+    with_definitions=with_definitions
 )
 print(result)
 
@@ -442,7 +442,7 @@ with_definition = False
 result = customer_custom_attributes_api.retrieve_customer_custom_attribute(
     customer_id,
     key,
-    with_definition
+    with_definition=with_definition
 )
 print(result)
 

doc/api/customers.md

@@ -59,7 +59,7 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 count = False
 
 result = customers_api.list_customers(
-    count
+    count=count
 )
 print(result)
 
@@ -169,8 +169,8 @@ body = {
                 'rule': 'INCLUDE'
             },
             'created_at': {
-                'start_at': '2018-01-01T00:00:00+00:00',
-                'end_at': '2018-02-01T00:00:00+00:00'
+                'start_at': '2018-01-01T00:00:00-00:00',
+                'end_at': '2018-02-01T00:00:00-00:00'
             },
             'email_address': {
                 'fuzzy': 'example.com'

doc/api/devices.md

@@ -10,9 +10,50 @@ devices_api = client.devices
 
 ## Methods
 
+* [List Devices](../../doc/api/devices.md#list-devices)
 * [List Device Codes](../../doc/api/devices.md#list-device-codes)
 * [Create Device Code](../../doc/api/devices.md#create-device-code)
 * [Get Device Code](../../doc/api/devices.md#get-device-code)
+* [Get Device](../../doc/api/devices.md#get-device)
+
+
+# List Devices
+
+List devices associated with the merchant. Currently, only Terminal API
+devices are supported.
+
+```python
+def list_devices(self,
+                cursor=None,
+                sort_order=None,
+                limit=None,
+                location_id=None)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `cursor` | `str` | 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. |
+| `sort_order` | [`str (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). |
+| `limit` | `int` | Query, Optional | The number of results to return in a single page. |
+| `location_id` | `str` | Query, Optional | If present, only returns devices at the target location. |
+
+## Response Type
+
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`List Devices Response`](../../doc/models/list-devices-response.md).
+
+## Example Usage
+
+```python
+result = devices_api.list_devices()
+print(result)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
 
 
 # List Device Codes
@@ -128,3 +169,37 @@ elif result.is_error():
     print(result.errors)
 ```
 
+
+# Get Device
+
+Retrieves Device with the associated `device_id`.
+
+```python
+def get_device(self,
+              device_id)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `device_id` | `str` | Template, Required | The unique ID for the desired `Device`. |
+
+## Response Type
+
+This method returns a `ApiResponse` instance. The `body` property of this instance returns the response data which is of type [`Get Device Response`](../../doc/models/get-device-response.md).
+
+## Example Usage
+
+```python
+device_id = 'device_id6'
+
+result = devices_api.get_device(device_id)
+print(result)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+

doc/api/inventory.md

@@ -189,8 +189,8 @@ body = {
     'states': [
         'IN_STOCK'
     ],
-    'updated_after': '2016-11-01T00:00:00Z',
-    'updated_before': '2016-12-01T00:00:00Z'
+    'updated_after': '2016-11-01T00:00:00.000Z',
+    'updated_before': '2016-12-01T00:00:00.000Z'
 }
 
 result = inventory_api.deprecated_batch_retrieve_inventory_changes(body)
@@ -235,7 +235,7 @@ body = {
     'location_ids': [
         '59TNP9SA8VGDA'
     ],
-    'updated_after': '2016-11-16T00:00:00Z'
+    'updated_after': '2016-11-16T00:00:00.000Z'
 }
 
 result = inventory_api.deprecated_batch_retrieve_inventory_counts(body)
@@ -345,8 +345,8 @@ body = {
     'states': [
         'IN_STOCK'
     ],
-    'updated_after': '2016-11-01T00:00:00Z',
-    'updated_before': '2016-12-01T00:00:00Z'
+    'updated_after': '2016-11-01T00:00:00.000Z',
+    'updated_before': '2016-12-01T00:00:00.000Z'
 }
 
 result = inventory_api.batch_retrieve_inventory_changes(body)
@@ -398,7 +398,7 @@ body = {
     'location_ids': [
         '59TNP9SA8VGDA'
     ],
-    'updated_after': '2016-11-16T00:00:00Z'
+    'updated_after': '2016-11-16T00:00:00.000Z'
 }
 
 result = inventory_api.batch_retrieve_inventory_counts(body)

doc/api/labor.md

@@ -354,9 +354,9 @@ This method returns a `ApiResponse` instance. The `body` property of this instan
 ```python
 body = {
     'shift': {
-        'start_at': '2019-01-25T08:11:00+00:00',
+        'start_at': '2019-01-25T03:11:00-05:00',
         'location_id': 'PAA1RJZZKXBFG',
-        'end_at': '2019-01-25T18:11:00+00:00',
+        'end_at': '2019-01-25T13:11:00-05:00',
         'wage': {
             'title': 'Barista',
             'hourly_rate': {
@@ -366,12 +366,12 @@ body = {
         },
         'breaks': [
             {
-                'start_at': '2019-01-25T11:11:00+00:00',
+                'start_at': '2019-01-25T06:11:00-05:00',
                 'break_type_id': 'REGS1EQR1TPZ5',
                 'name': 'Tea Break',
                 'expected_duration': 'PT5M',
                 'is_paid': True,
-                'end_at': '2019-01-25T11:16:00+00:00'
+                'end_at': '2019-01-25T06:16:00-05:00'
             }
         ],
         'team_member_id': 'ormj0jJJZ5OZIzxrZYJI'
@@ -554,9 +554,9 @@ id = 'id0'
 
 body = {
     'shift': {
-        'start_at': '2019-01-25T08:11:00+00:00',
+        'start_at': '2019-01-25T03:11:00-05:00',
         'location_id': 'PAA1RJZZKXBFG',
-        'end_at': '2019-01-25T18:11:00+00:00',
+        'end_at': '2019-01-25T13:11:00-05:00',
         'wage': {
             'title': 'Bartender',
             'hourly_rate': {
@@ -566,13 +566,13 @@ body = {
         },
         'breaks': [
             {
-                'start_at': '2019-01-25T11:11:00+00:00',
+                'start_at': '2019-01-25T06:11:00-05:00',
                 'break_type_id': 'REGS1EQR1TPZ5',
                 'name': 'Tea Break',
                 'expected_duration': 'PT5M',
                 'is_paid': True,
                 'id': 'X7GAQYVVRRG6P',
-                'end_at': '2019-01-25T11:16:00+00:00'
+                'end_at': '2019-01-25T06:16:00-05:00'
             }
         ],
         'version': 1,