Merge pull request #108 from square/release/24.0.0.20221019

Generated PR for Release: 24.0.0.20221019

Author: jessdelacruzsantos

doc/api/customers.md

@@ -104,7 +104,7 @@ body[:address][:locality] = 'New York'
 body[:address][:administrative_district_level_1] = 'NY'
 body[:address][:postal_code] = '10003'
 body[:address][:country] = 'US'
-body[:phone_number] = '1-212-555-4240'
+body[:phone_number] = '+1-212-555-4240'
 body[:reference_id] = 'YOUR_REFERENCE_ID'
 body[:note] = 'a customer'
 

doc/api/invoices.md

@@ -115,6 +115,7 @@ body[:invoice][:accepted_payment_methods] = {}
 body[:invoice][:accepted_payment_methods][:card] = true
 body[:invoice][:accepted_payment_methods][:square_gift_card] = false
 body[:invoice][:accepted_payment_methods][:bank_account] = false
+body[:invoice][:accepted_payment_methods][:buy_now_pay_later] = false
 body[:invoice][:custom_fields] = []
 
 

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-09-21'` |
+| `square_version` | `String` | Square Connect API versions<br>*Default*: `'2022-10-19'` |
 | `access_token` | `String` | The OAuth 2.0 Access Token to use for API requests. |
 | `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`** |
@@ -24,7 +24,7 @@ The API client can be initialized as follows:
 
 ```ruby
 client = Square::Client.new(
-  square_version: '2022-09-21',
+  square_version: '2022-10-19',
   access_token: 'AccessToken',
   environment: 'production',
   custom_url: 'https://connect.squareup.com',

doc/models/activity-type.md

@@ -43,4 +43,5 @@
 | `TAX_ON_FEE` | The tax paid on fee amounts. |
 | `THIRD_PARTY_FEE` | Fees collected by a third-party platform. |
 | `THIRD_PARTY_FEE_REFUND` | Refunded fees from a third-party platform. |
+| `PAYOUT` | Balance change due to money transfer. |
 

doc/models/cancel-invoice-response.md

@@ -22,6 +22,7 @@ The response returned by the `CancelInvoice` request.
   "invoice": {
     "accepted_payment_methods": {
       "bank_account": false,
+      "buy_now_pay_later": false,
       "card": true,
       "square_gift_card": false
     },

doc/models/create-customer-request.md

@@ -13,16 +13,16 @@ Defines the body parameters that can be included in a request to the
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `idempotency_key` | `String` | Optional | The idempotency key for the request.	For more information, see<br>[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). |
-| `given_name` | `String` | Optional | The given name (that is, the first name) associated with the customer profile. |
-| `family_name` | `String` | Optional | The family name (that is, the last name) associated with the customer profile. |
-| `company_name` | `String` | Optional | A business name associated with the customer profile. |
-| `nickname` | `String` | Optional | A nickname for the customer profile. |
-| `email_address` | `String` | Optional | The email address associated with the customer profile. |
+| `given_name` | `String` | Optional | The given name (that is, the first name) associated with the customer profile.<br><br>The maximum length for this value is 300 characters. |
+| `family_name` | `String` | Optional | The family name (that is, the last name) associated with the customer profile.<br><br>The maximum length for this value is 300 characters. |
+| `company_name` | `String` | Optional | A business name associated with the customer profile.<br><br>The maximum length for this value is 500 characters. |
+| `nickname` | `String` | Optional | A nickname for the customer profile.<br><br>The maximum length for this value is 100 characters. |
+| `email_address` | `String` | Optional | The email address associated with the customer profile.<br><br>The maximum length for this value is 254 characters. |
 | `address` | [`Address Hash`](../../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). |
-| `phone_number` | `String` | Optional | The phone number associated with the customer profile. A phone number can contain 9–16 digits, with an optional `+` prefix. |
-| `reference_id` | `String` | Optional | An optional second ID used to associate the customer profile with an<br>entity in another system. |
+| `phone_number` | `String` | Optional | The phone number associated with the customer profile. The phone number must be valid and can contain<br>9–16 digits, with an optional `+` prefix and country code. For more information, see<br>[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). |
+| `reference_id` | `String` | Optional | An optional second ID used to associate the customer profile with an<br>entity in another system.<br><br>The maximum length for this value is 100 characters. |
 | `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. |
+| `birthday` | `String` | Optional | The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example,<br>specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD`<br>format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. |
 | `tax_ids` | [`Customer Tax Ids Hash`](../../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)
@@ -41,7 +41,7 @@ Defines the body parameters that can be included in a request to the
   "family_name": "Earhart",
   "given_name": "Amelia",
   "note": "a customer",
-  "phone_number": "1-212-555-4240",
+  "phone_number": "+1-212-555-4240",
   "reference_id": "YOUR_REFERENCE_ID"
 }
 ```

doc/models/create-customer-response.md

@@ -37,7 +37,7 @@ Either `errors` or `customer` is present in a given response (never both).
     "given_name": "Amelia",
     "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
     "note": "a customer",
-    "phone_number": "1-212-555-4240",
+    "phone_number": "+1-212-555-4240",
     "preferences": {
       "email_unsubscribed": false
     },

doc/models/create-invoice-request.md

@@ -22,6 +22,7 @@ Describes a `CreateInvoice` request.
   "invoice": {
     "accepted_payment_methods": {
       "bank_account": false,
+      "buy_now_pay_later": false,
       "card": true,
       "square_gift_card": false
     },

doc/models/create-invoice-response.md

@@ -22,6 +22,7 @@ The response returned by the `CreateInvoice` request.
   "invoice": {
     "accepted_payment_methods": {
       "bank_account": false,
+      "buy_now_pay_later": false,
       "card": true,
       "square_gift_card": false
     },

doc/models/create-payment-request.md

@@ -22,7 +22,7 @@ Describes a request to create a payment using
 | `autocomplete` | `TrueClass\|FalseClass` | Optional | If set to `true`, this payment will be completed when possible. If<br>set to `false`, this payment is held in an approved state until either<br>explicitly completed (captured) or canceled (voided). For more information, see<br>[Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).<br><br>Default: true |
 | `order_id` | `String` | Optional | Associates a previously created order with this payment. |
 | `customer_id` | `String` | Optional | The [Customer](../../doc/models/customer.md) ID of the customer associated with the payment.<br><br>This is required if the `source_id` refers to a card on file created using the Customers API. |
-| `location_id` | `String` | Optional | The location ID to associate with the payment. If not specified, the default location is<br>used. |
+| `location_id` | `String` | Optional | The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is<br>used. |
 | `team_member_id` | `String` | Optional | An optional [TeamMember](../../doc/models/team-member.md) ID to associate with<br>this payment. |
 | `reference_id` | `String` | Optional | A user-defined ID to associate with the payment.<br><br>You can use this field to associate the payment to an entity in an external system<br>(for example, you might specify an order ID that is generated by a third-party shopping cart).<br>**Constraints**: *Maximum Length*: `40` |
 | `verification_token` | `String` | Optional | An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).<br>Verification tokens encapsulate customer device information and 3-D Secure<br>challenge results to indicate that Square has verified the buyer identity.<br><br>For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview). |