Merge pull request #84 from square/release/17.2.0.20220216

Generated PR for Release: 17.2.0.20220216

Author: Wolfgang Schuster

doc/api/inventory.md

@@ -134,7 +134,7 @@ body['changes'][0]['physical_count']['catalog_object_type'] = 'catalog_object_ty
 body['changes'][0]['physical_count']['state'] = 'IN_STOCK'
 body['changes'][0]['physical_count']['location_id'] = 'C6W5YS5QM06F5'
 body['changes'][0]['physical_count']['quantity'] = '53'
-body['changes'][0]['physical_count']['employee_id'] = 'LRK57NSQ5X7PUD05'
+body['changes'][0]['physical_count']['team_member_id'] = 'LRK57NSQ5X7PUD05'
 body['changes'][0]['physical_count']['occurred_at'] = '2016-11-16T22:25:24.878Z'
 body['changes'][0]['adjustment'] = {}
 body['changes'][0]['adjustment']['id'] = 'id6'
@@ -293,7 +293,7 @@ body['changes'][0]['physical_count']['catalog_object_type'] = 'catalog_object_ty
 body['changes'][0]['physical_count']['state'] = 'IN_STOCK'
 body['changes'][0]['physical_count']['location_id'] = 'C6W5YS5QM06F5'
 body['changes'][0]['physical_count']['quantity'] = '53'
-body['changes'][0]['physical_count']['employee_id'] = 'LRK57NSQ5X7PUD05'
+body['changes'][0]['physical_count']['team_member_id'] = 'LRK57NSQ5X7PUD05'
 body['changes'][0]['physical_count']['occurred_at'] = '2016-11-16T22:25:24.878Z'
 body['changes'][0]['adjustment'] = {}
 body['changes'][0]['adjustment']['id'] = 'id6'

doc/api/merchants.md

@@ -16,14 +16,16 @@ merchants_api = client.merchants
 
 # List Merchants
 
-Returns `Merchant` information for a given access token.
+Provides details about the merchant associated with a given access token.
 
-If you don't know a `Merchant` ID, you can use this endpoint to retrieve the merchant ID for an access token.
-You can specify your personal access token to get your own merchant information or specify an OAuth token
-to get the information for the  merchant that granted you access.
+The access token used to connect your application to a Square seller is associated
+with a single merchant. That means that `ListMerchants` returns a list
+with a single `Merchant` object. You can specify your personal access token
+to get your own merchant information or specify an OAuth token to get the
+information for the merchant that granted your application access.
 
 If you know the merchant ID, you can also use the [RetrieveMerchant](/doc/api/merchants.md#retrieve-merchant)
-endpoint to get the merchant information.
+endpoint to retrieve the merchant information.
 
 ```python
 def list_merchants(self,
@@ -56,7 +58,7 @@ elif result.is_error():
 
 # Retrieve Merchant
 
-Retrieve a `Merchant` object for the given `merchant_id`.
+Retrieves the `Merchant` object for the given `merchant_id`.
 
 ```python
 def retrieve_merchant(self,

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `square_version` | `string` | Square Connect API versions<br>*Default*: `'2022-01-20'` |
+| `square_version` | `string` | Square Connect API versions<br>*Default*: `'2022-02-16'` |
 | `custom_url` | `string` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `'https://connect.squareup.com'` |
 | `environment` | `string` | The API environment. <br> **Default: `production`** |
 | `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:
 from square.client import Client
 
 client = Client(
-    square_version='2022-01-20',
+    square_version='2022-02-16',
     environment='production',
     custom_url = 'https://connect.squareup.com',)
 ```
@@ -48,7 +48,7 @@ API calls return an `ApiResponse` object that includes the following fields:
 from square.client import Client
 
 client = Client(
-    square_version='2022-01-20',)
+    square_version='2022-02-16',)
 
 locations_api = client.locations
 result = locations_api.list_locations()

doc/models/afterpay-details.md

@@ -0,0 +1,23 @@
+
+# Afterpay Details
+
+Additional details about Afterpay payments.
+
+## Structure
+
+`Afterpay Details`
+
+## Fields
+
+| Name | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `email_address` | `string` | Optional | Email address on the buyer's Afterpay account.<br>**Constraints**: *Maximum Length*: `255` |
+
+## Example (as JSON)
+
+```json
+{
+  "email_address": "email_address2"
+}
+```
+

doc/models/batch-change-inventory-request.md

@@ -21,12 +21,12 @@
     {
       "physical_count": {
         "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
-        "employee_id": "LRK57NSQ5X7PUD05",
         "location_id": "C6W5YS5QM06F5",
         "occurred_at": "2016-11-16T22:25:24.878Z",
         "quantity": "53",
         "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92",
-        "state": "IN_STOCK"
+        "state": "IN_STOCK",
+        "team_member_id": "LRK57NSQ5X7PUD05"
       },
       "type": "PHYSICAL_COUNT"
     }

doc/models/batch-retrieve-inventory-changes-response.md

@@ -23,7 +23,6 @@
         "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
         "catalog_object_type": "ITEM_VARIATION",
         "created_at": "2016-11-16T22:25:24.878Z",
-        "employee_id": "LRK57NSQ5X7PUD05",
         "id": "46YDTW253DWGGK9HMAE6XCAO",
         "location_id": "C6W5YS5QM06F5",
         "occurred_at": "2016-11-16T22:24:49.028Z",
@@ -34,7 +33,8 @@
           "name": "Square Point of Sale 4.37",
           "product": "SQUARE_POS"
         },
-        "state": "IN_STOCK"
+        "state": "IN_STOCK",
+        "team_member_id": "LRK57NSQ5X7PUD05"
       },
       "type": "PHYSICAL_COUNT"
     }

doc/models/buy-now-pay-later-details.md

@@ -0,0 +1,27 @@
+
+# Buy Now Pay Later Details
+
+Additional details about a Buy Now Pay Later payment type.
+
+## Structure
+
+`Buy Now Pay Later Details`
+
+## Fields
+
+| Name | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `brand` | `string` | Optional | The brand used for the Buy Now Pay Later payment.<br>The brand can be `AFTERPAY` or `UNKNOWN`.<br>**Constraints**: *Maximum Length*: `50` |
+| `afterpay_details` | [`Afterpay Details`](/doc/models/afterpay-details.md) | Optional | Additional details about Afterpay payments. |
+
+## Example (as JSON)
+
+```json
+{
+  "brand": "brand4",
+  "afterpay_details": {
+    "email_address": "email_address4"
+  }
+}
+```
+

doc/models/card.md

@@ -20,7 +20,7 @@ details are determined by the payment token generated by Web Payments SDK.
 | `cardholder_name` | `string` | Optional | The name of the cardholder.<br>**Constraints**: *Maximum Length*: `96` |
 | `billing_address` | [`Address`](/doc/models/address.md) | Optional | Represents a postal address in a country.<br>For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). |
 | `fingerprint` | `string` | Optional | Intended as a Square-assigned identifier, based<br>on the card number, to identify the card across multiple locations within a<br>single application.<br>**Constraints**: *Maximum Length*: `255` |
-| `customer_id` | `string` | Optional | The ID of a customer created using the Customers API to be associated with the card. |
+| `customer_id` | `string` | Optional | **Required** The ID of a customer created using the Customers API to be associated with the card. |
 | `merchant_id` | `string` | Optional | The ID of the merchant associated with the card. |
 | `reference_id` | `string` | Optional | An optional user-defined reference ID that associates this card with<br>another entity in an external system. For example, a customer ID from an<br>external customer management system.<br>**Constraints**: *Maximum Length*: `128` |
 | `enabled` | `bool` | Optional | Indicates whether or not a card can be used for payments. |

doc/models/create-customer-request.md

@@ -23,7 +23,7 @@ Defines the body parameters that can be included in a request to the
 | `reference_id` | `string` | Optional | An optional second ID used to associate the customer profile with an<br>entity in another system. |
 | `note` | `string` | Optional | A custom note associated with the customer profile. |
 | `birthday` | `string` | Optional | The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed.<br>For example, `0000-09-21T00:00:00-00:00` represents a birthday on September 21 and `1998-09-21T00:00:00-00:00` represents a birthday on September 21, 1998.<br>You can also specify this value in `YYYY-MM-DD` format. |
-| `tax_ids` | [`Customer Tax Ids`](/doc/models/customer-tax-ids.md) | Optional | Represents the tax ID associated with a customer profile. The corresponding `tax_ids` field is available only for customers of sellers in France, Ireland, or the United Kingdom.<br>For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). |
+| `tax_ids` | [`Customer Tax Ids`](/doc/models/customer-tax-ids.md) | Optional | Represents the tax ID associated with a [customer profile](/doc/models/customer.md). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom.<br>For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). |
 
 ## Example (as JSON)
 

doc/models/create-loyalty-account-request.md

@@ -11,7 +11,7 @@ A request to create a new loyalty account.
 
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `loyalty_account` | [`Loyalty Account`](/doc/models/loyalty-account.md) | Required | Describes a loyalty account. For more information, see<br>[Manage Loyalty Accounts Using the Loyalty API](https://developer.squareup.com/docs/loyalty-api/overview). |
+| `loyalty_account` | [`Loyalty Account`](/doc/models/loyalty-account.md) | Required | Describes a loyalty account in a [loyalty program](/doc/models/loyalty-program.md). For more information, see<br>[Manage Loyalty Accounts Using the Loyalty API](https://developer.squareup.com/docs/loyalty-api/overview). |
 | `idempotency_key` | `string` | Required | A unique string that identifies this `CreateLoyaltyAccount` request.<br>Keys can be any valid string, but must be unique for every request.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` |
 
 ## Example (as JSON)