You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/client.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
5
5
6
6
| Parameter | Type | Description |
7
7
| --- | --- | --- |
8
-
|`squareVersion`|`String`| Square Connect API versions<br>*Default*: `"2022-09-21"`|
8
+
|`squareVersion`|`String`| Square Connect API versions<br>*Default*: `"2022-10-19"`|
9
9
|`customUrl`|`String`| Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `"https://connect.squareup.com"`|
10
10
|`environment`|`string`| The API environment. <br> **Default: `production`**|
Copy file name to clipboardExpand all lines: doc/models/create-customer-request.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,16 @@ Defines the body parameters that can be included in a request to the
13
13
| Name | Type | Tags | Description | Getter |
14
14
| --- | --- | --- | --- | --- |
15
15
|`IdempotencyKey`|`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). | String getIdempotencyKey() |
16
-
|`GivenName`|`String`| Optional | The given name (that is, the first name) associated with the customer profile. | String getGivenName() |
17
-
|`FamilyName`|`String`| Optional | The family name (that is, the last name) associated with the customer profile. | String getFamilyName() |
18
-
|`CompanyName`|`String`| Optional | A business name associated with the customer profile. | String getCompanyName() |
19
-
|`Nickname`|`String`| Optional | A nickname for the customer profile. | String getNickname() |
20
-
|`EmailAddress`|`String`| Optional | The email address associated with the customer profile. | String getEmailAddress() |
16
+
|`GivenName`|`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.| String getGivenName() |
17
+
|`FamilyName`|`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.| String getFamilyName() |
18
+
|`CompanyName`|`String`| Optional | A business name associated with the customer profile.<br><br>The maximum length for this value is 500 characters.| String getCompanyName() |
19
+
|`Nickname`|`String`| Optional | A nickname for the customer profile.<br><br>The maximum length for this value is 100 characters.| String getNickname() |
20
+
|`EmailAddress`|`String`| Optional | The email address associated with the customer profile.<br><br>The maximum length for this value is 254 characters.| String getEmailAddress() |
21
21
|`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). | Address getAddress() |
22
-
|`PhoneNumber`|`String`| Optional | The phone number associated with the customer profile. A phone number can contain9–16 digits, with an optional `+` prefix. | String getPhoneNumber() |
23
-
|`ReferenceId`|`String`| Optional | An optional second ID used to associate the customer profile with an<br>entity in another system. | String getReferenceId() |
22
+
|`PhoneNumber`|`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). | String getPhoneNumber() |
23
+
|`ReferenceId`|`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.| String getReferenceId() |
24
24
|`Note`|`String`| Optional | A custom note associated with the customer profile. | String getNote() |
25
-
|`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. | String getBirthday() |
25
+
|`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. | String getBirthday() |
26
26
|`TaxIds`|[`CustomerTaxIds`](../../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). | CustomerTaxIds getTaxIds() |
27
27
28
28
## Example (as JSON)
@@ -41,7 +41,7 @@ Defines the body parameters that can be included in a request to the
Copy file name to clipboardExpand all lines: doc/models/create-payment-request.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Describes a request to create a payment using
22
22
|`Autocomplete`|`Boolean`| 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 | Boolean getAutocomplete() |
23
23
|`OrderId`|`String`| Optional | Associates a previously created order with this payment. | String getOrderId() |
24
24
|`CustomerId`|`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. | String getCustomerId() |
25
-
|`LocationId`|`String`| Optional | The location ID to associate with the payment. If not specified, the default location is<br>used. | String getLocationId() |
25
+
|`LocationId`|`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. | String getLocationId() |
26
26
|`TeamMemberId`|`String`| Optional | An optional [TeamMember](../../doc/models/team-member.md) ID to associate with<br>this payment. | String getTeamMemberId() |
27
27
|`ReferenceId`|`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`| String getReferenceId() |
28
28
|`VerificationToken`|`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). | String getVerificationToken() |
0 commit comments