Merge pull request #49 from square/release/7.0.0.20201118

Generated PR for Release: 7.0.0.20201118

Author: jessdelacruzsantos

CHANGELOG.md

@@ -1,5 +1,32 @@
 # Change Log
 
+## Version 7.0.0.20201118 (2020-11-18T00:00)
+## New API releases
+
+* **Bookings API** (beta). This API enables you, as an application developer, to create applications to set up and manage bookings for appointments of fixed duration in which  selected staff members of a Square seller provide specified services in supported locations for particular customers.   
+  * For an overview, see [Manage Bookings for Square Sellers](https://developer.squareup.com/docs/bookings-api/what-it-is).
+  * For technical reference, see [Bookings API](https://developer.squareup.com/reference/square_2020-11-18/bookings-api).
+    
+## Existing API updates
+
+*  **Payments API:** 
+   *  [Payment.](https://developer.squareup.com/reference/square_2020-11-18/objects/Payment) The object now includes the `risk_evaluation` field to identify the Square-assigned risk level associated with the payment. Sellers can use this information to provide the goods and services or refund the payment.
+
+## New SDK release
+* **New Square Node.js SDK (beta)**  
+
+  The new [Square Node.js SDK](https://github.com/square/square-nodejs-sdk) is available in beta and will eventually replace the deprecated Connect Node.js SDK. For migration information, see the [Connect SDK README.](https://github.com/square/connect-nodejs-sdk/blob/master/README.md) The following topics are updated to use the new SDK:
+   * [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough)
+   * [Verify the Buyer When Using a Nonce for an Online Payment](https://developer.squareup.com/docs/payment-form/cookbook/verify-buyer-on-card-charge)
+   * [Create a Gift Card Payment Endpoint](https://developer.squareup.com/docs/payment-form/gift-cards/part-2)
+
+
+## Documentation Updates
+
+* The **Testing** topics are moved from the end of the table of contents to the top, in the **Home** section under [Testing your App](https://developer.squareup.com/docs/testing-your-app). 
+* [Pay for orders.]](https://developer.squareup.com/docs/orders-api/pay-for-order) Topic revised to add clarity when to use Payments API and Orders API to pay for an order. The [Orders Integration]](https://developer.squareup.com/docs/payments-api/take-payments?preview=true#orders-integration) topic in Payments API simplified accordingly.
+
+
 ## Version 6.5.0.20201028 (2020-10-28T00:00)
 
 ## Existing API updates
@@ -23,7 +50,7 @@
 
 * **Locations API:** 
   * [Location](https://developer.squareup.com/reference/square_2020-10-28/objects/Location) object. Has a new read-only field,[full_format_logo_url](https://developer.squareup.com/reference/square_2020-10-28/objects/Location#definition__property-full_format_logo_url), which provides URL of a full-format logo image for the location. 
-  * [Webhooks.](https://developer.squareup.com/docs/webhooks-api/subscribe-to-events#locations) The Locations API now supports notifications for when a location is created and when a location is updated.
+  * [Webhooks](https://developer.squareup.com/docs/webhooks-api/subscribe-to-events#locations) The Locations API now supports notifications for when a location is created and when a location is updated.
 
 * **Orders API:** 
   * [RetrieveOrder](https://developer.squareup.com/reference/square_2020-10-28/orders-api/retrieve-order), new endpoint. For more information, see the [Retrieve Orders](https://developer.squareup.com/docs/orders-api/manage-orders#retrieve-orders) overview.
@@ -212,7 +239,7 @@ Bug fixes:
   * For technical reference, see [Customer Segments]( https://developer.squareup.com/reference/square/customer-segments-api).  
 
 
-* **New webhooks.** v2 Webhooks (beta) now supports webhooks for the following APIs:
+* **New webhooks** v2 Webhooks (beta) now supports webhooks for the following APIs:
   * Orders API. `order.created`, `order.updated`, and `order.fulfillment.updated`
   * Terminal API. `terminal.checkout.created` and `terminal.checkout.updated`
   * Devices API. `device.code.paired`
@@ -250,8 +277,8 @@ Bug fixes:
 
 ## Version 5.1.0.20200325 (2020-03-25)
 ## Existing API updates
-* **[Payments API](https://developer.squareup.com/reference/square/payments-api).** In support of the existing [Delayed capture](payments-api/take-payments) for payments, the following fields are added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type:
-   * `delay_duration`. In a [CreatePayment](https://developer.squareup.com/reference/square/payments-api/create-payment) request, you can set `autocomplete` to false to get  payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capture](payments-api/take-payments).
+* **[Payments API](https://developer.squareup.com/reference/square/payments-api).** In support of the existing [Delayed capture]](https://developer.squareup.com/docs/payments-api/take-payments) for payments, the following fields are added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type:
+   * `delay_duration`. In a [CreatePayment](https://developer.squareup.com/reference/square/payments-api/create-payment) request, you can set `autocomplete` to false to get  payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capture]](https://developer.squareup.com/docs/payments-api/take-payments).
    * `delay_action`. Defines the action that Square takes on the payment when the `delay_duration` elapses. In this release, the API supports only the cancel payment action.
    * `delayed_until`. Provides the date and time on Square servers when Square applies `delay_action` on the payment.
 

README.md

@@ -69,6 +69,9 @@ pip install -r test-requirements.txt
 ### Loyalty
 * [Loyalty]
 
+### Bookings
+* [Bookings]
+
 ### Business
 * [Merchants]
 * [Locations]
@@ -373,6 +376,7 @@ You can also use the Square API to create applications or services that work wit
 [Inventory]: doc/api/inventory.md
 [Labor]: doc/api/labor.md
 [Loyalty]: doc/api/loyalty.md
+[Bookings]: doc/api/bookings.md
 [Locations]: doc/api/locations.md
 [Merchants]: doc/api/merchants.md
 [Orders]: doc/api/orders.md

doc/api/apple-pay.md

@@ -19,7 +19,7 @@ This endpoint provides an easy way for platform developers to bulk activate
 Web Apple Pay with Square for merchants using their platform.
 
 To learn more about Apple Pay on Web see the Apple Pay section in the
-[Square Payment Form Walkthrough](https://developer.squareup.com/docs/docs/payment-form/payment-form-walkthrough).
+[Square Payment Form Walkthrough](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough).
 
 ```python
 def register_domain(self,

doc/api/bank-accounts.md

@@ -30,7 +30,7 @@ def list_bank_accounts(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `cursor` | `string` | Query, Optional | The pagination cursor returned by a previous call to this endpoint.<br>Use it in the next `ListBankAccounts` request to retrieve the next set<br>of results.<br><br>See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information. |
+| `cursor` | `string` | Query, Optional | The pagination cursor returned by a previous call to this endpoint.<br>Use it in the next `ListBankAccounts` request to retrieve the next set<br>of results.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |
 | `limit` | `int` | Query, Optional | Upper limit on the number of bank accounts to return in the response.<br>Currently, 1000 is the largest supported limit. You can specify a limit<br>of up to 1000 bank accounts. This is also the default limit. |
 | `location_id` | `string` | Query, Optional | Location ID. You can specify this optional filter<br>to retrieve only the linked bank accounts belonging to a specific location. |
 
@@ -67,7 +67,7 @@ def get_bank_account_by_v1_id(self,
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `v1_bank_account_id` | `string` | Template, Required | Connect V1 ID of the desired `BankAccount`. For more information, see<br>[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
+| `v1_bank_account_id` | `string` | Template, Required | Connect V1 ID of the desired `BankAccount`. For more information, see<br>[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
 
 ## Response Type
 

doc/api/bookings.md

@@ -0,0 +1,291 @@
+# Bookings
+
+```python
+bookings_api = client.bookings
+```
+
+## Class Name
+
+`BookingsApi`
+
+## Methods
+
+* [Create Booking](/doc/api/bookings.md#create-booking)
+* [Search Availability](/doc/api/bookings.md#search-availability)
+* [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)
+* [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)
+
+
+# Create Booking
+
+Creates a booking.
+
+```python
+def create_booking(self,
+                  body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `body` | [`Create Booking Request`](/doc/models/create-booking-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
+
+[`Create Booking Response`](/doc/models/create-booking-response.md)
+
+## Example Usage
+
+```python
+body = {}
+body['idempotency_key'] = 'idempotency_key2'
+body['booking'] = {}
+body['booking']['id'] = 'id8'
+body['booking']['version'] = 148
+body['booking']['status'] = 'ACCEPTED'
+body['booking']['created_at'] = 'created_at6'
+body['booking']['updated_at'] = 'updated_at4'
+
+result = bookings_api.create_booking(body)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+
+
+# Search Availability
+
+Searches for availabilities for booking.
+
+```python
+def search_availability(self,
+                       body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `body` | [`Search Availability Request`](/doc/models/search-availability-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
+
+[`Search Availability Response`](/doc/models/search-availability-response.md)
+
+## Example Usage
+
+```python
+body = {}
+body['query'] = {}
+body['query']['filter'] = {}
+body['query']['filter']['start_at_range'] = {}
+body['query']['filter']['start_at_range']['start_at'] = 'start_at8'
+body['query']['filter']['start_at_range']['end_at'] = 'end_at4'
+body['query']['filter']['location_id'] = 'location_id6'
+body['query']['filter']['segment_filters'] = []
+
+body['query']['filter']['segment_filters'].append({})
+body['query']['filter']['segment_filters'][0]['service_variation_id'] = 'service_variation_id8'
+body['query']['filter']['segment_filters'][0]['team_member_id_filter'] = {}
+body['query']['filter']['segment_filters'][0]['team_member_id_filter']['all'] = ['all7']
+body['query']['filter']['segment_filters'][0]['team_member_id_filter']['any'] = ['any0', 'any1']
+body['query']['filter']['segment_filters'][0]['team_member_id_filter']['none'] = ['none5']
+
+body['query']['filter']['segment_filters'].append({})
+body['query']['filter']['segment_filters'][1]['service_variation_id'] = 'service_variation_id7'
+body['query']['filter']['segment_filters'][1]['team_member_id_filter'] = {}
+body['query']['filter']['segment_filters'][1]['team_member_id_filter']['all'] = ['all6', 'all7', 'all8']
+body['query']['filter']['segment_filters'][1]['team_member_id_filter']['any'] = ['any1', 'any2', 'any3']
+body['query']['filter']['segment_filters'][1]['team_member_id_filter']['none'] = ['none6', 'none7']
+
+body['query']['filter']['booking_id'] = 'booking_id6'
+
+result = bookings_api.search_availability(body)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+
+
+# Retrieve Business Booking Profile
+
+Retrieves a seller's booking profile.
+
+```python
+def retrieve_business_booking_profile(self)
+```
+
+## Response Type
+
+[`Retrieve Business Booking Profile Response`](/doc/models/retrieve-business-booking-profile-response.md)
+
+## Example Usage
+
+```python
+result = bookings_api.retrieve_business_booking_profile()
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+
+
+# List Team Member Booking Profiles
+
+Lists booking profiles for team members.
+
+```python
+def list_team_member_booking_profiles(self,
+                                     bookable_only=False,
+                                     limit=None,
+                                     cursor=None,
+                                     location_id=None)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `bookable_only` | `bool` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). |
+| `limit` | `int` | Query, Optional | The maximum number of results to return. |
+| `cursor` | `string` | Query, Optional | The cursor for paginating through the results. |
+| `location_id` | `string` | Query, Optional | Indicates whether to include only team members enabled at the given location in the returned result. |
+
+## Response Type
+
+[`List Team Member Booking Profiles Response`](/doc/models/list-team-member-booking-profiles-response.md)
+
+## Example Usage
+
+```python
+bookable_only = False
+limit = 172
+cursor = 'cursor6'
+location_id = 'location_id4'
+
+result = bookings_api.list_team_member_booking_profiles(bookable_only, limit, cursor, location_id)
+
+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.
+
+```python
+def retrieve_team_member_booking_profile(self,
+                                        team_member_id)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `team_member_id` | `string` | Template, Required | The ID of the team member to retrieve. |
+
+## Response Type
+
+[`Retrieve Team Member Booking Profile Response`](/doc/models/retrieve-team-member-booking-profile-response.md)
+
+## Example Usage
+
+```python
+team_member_id = 'team_member_id0'
+
+result = bookings_api.retrieve_team_member_booking_profile(team_member_id)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+
+
+# Retrieve Booking
+
+Retrieves a booking.
+
+```python
+def retrieve_booking(self,
+                    booking_id)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `booking_id` | `string` | Template, Required | The ID of the [Booking](#type-booking) object representing the to-be-retrieved booking. |
+
+## Response Type
+
+[`Retrieve Booking Response`](/doc/models/retrieve-booking-response.md)
+
+## Example Usage
+
+```python
+booking_id = 'booking_id4'
+
+result = bookings_api.retrieve_booking(booking_id)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+
+
+# Update Booking
+
+Updates a booking.
+
+```python
+def update_booking(self,
+                  booking_id,
+                  body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `booking_id` | `string` | Template, Required | The ID of the [Booking](#type-booking) object representing the to-be-updated booking. |
+| `body` | [`Update Booking Request`](/doc/models/update-booking-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
+
+[`Update Booking Response`](/doc/models/update-booking-response.md)
+
+## Example Usage
+
+```python
+booking_id = 'booking_id4'
+body = {}
+body['idempotency_key'] = 'idempotency_key2'
+body['booking'] = {}
+body['booking']['id'] = 'id8'
+body['booking']['version'] = 148
+body['booking']['status'] = 'ACCEPTED'
+body['booking']['created_at'] = 'created_at6'
+body['booking']['updated_at'] = 'updated_at4'
+
+result = bookings_api.update_booking(booking_id, body)
+
+if result.is_success():
+    print(result.body)
+elif result.is_error():
+    print(result.errors)
+```
+