Merge pull request #100 from square/release/21.0.0

Generated PR for Release: 21.0.0

Author: daphnechiu

doc/api/checkout.md

@@ -20,6 +20,8 @@ const checkoutApi = client.checkoutApi;
 
 # Create Checkout
 
+**This endpoint is deprecated.**
+
 Links a `checkoutId` to a `checkout_page_url` that customers are
 directed to in order to provide their payment information using a
 payment processing workflow hosted on connect.squareup.com.
@@ -154,6 +156,8 @@ bodyPrePopulateShippingAddress.locality = 'San Francisco';
 bodyPrePopulateShippingAddress.administrativeDistrictLevel1 = 'CA';
 bodyPrePopulateShippingAddress.postalCode = '94103';
 bodyPrePopulateShippingAddress.country = 'US';
+bodyPrePopulateShippingAddress.firstName = 'Jane';
+bodyPrePopulateShippingAddress.lastName = 'Doe';
 
 const bodyAdditionalRecipients: ChargeRequestAdditionalRecipient[] = [];
 

doc/api/customer-custom-attributes.md

@@ -24,11 +24,12 @@ const customerCustomAttributesApi = client.customerCustomAttributesApi;
 
 # List Customer Custom Attribute Definitions
 
-Lists the customer-related custom attribute definitions that belong to a Square seller account.
+Lists the customer-related [custom attribute definitions](../../doc/models/custom-attribute-definition.md) that belong to a Square seller account.
 
 When all response pages are retrieved, the results include all custom attribute definitions
 that are visible to the requesting application, including those that are created by other
-applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that
+seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
 
 ```ts
 async listCustomerCustomAttributeDefinitions(
@@ -68,8 +69,8 @@ try {
 
 # Create Customer Custom Attribute Definition
 
-Creates a customer-related custom attribute definition for a Square seller account. Use this
-endpoint to define a custom attribute that can be associated with customer profiles.
+Creates a customer-related [custom attribute definition](../../doc/models/custom-attribute-definition.md) for a Square seller account.
+Use this endpoint to define a custom attribute that can be associated with customer profiles.
 
 A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties
 for a custom attribute. After the definition is created, you can call
@@ -127,7 +128,7 @@ try {
 
 # Delete Customer Custom Attribute Definition
 
-Deletes a customer-related custom attribute definition from a Square seller account.
+Deletes a customer-related [custom attribute definition](../../doc/models/custom-attribute-definition.md) from a Square seller account.
 
 Deleting a custom attribute definition also deletes the corresponding custom attribute from
 all customer profiles in the seller's Customer Directory.
@@ -171,10 +172,11 @@ try {
 
 # Retrieve Customer Custom Attribute Definition
 
-Retrieves a customer-related custom attribute definition from a Square seller account.
+Retrieves a customer-related [custom attribute definition](../../doc/models/custom-attribute-definition.md) from a Square seller account.
 
 To retrieve a custom attribute definition created by another application, the `visibility`
-setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
+(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
 
 ```ts
 async retrieveCustomerCustomAttributeDefinition(
@@ -215,7 +217,7 @@ try {
 
 # Update Customer Custom Attribute Definition
 
-Updates a customer-related custom attribute definition for a Square seller account.
+Updates a customer-related [custom attribute definition](../../doc/models/custom-attribute-definition.md) for a Square seller account.
 
 Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the
 `schema` for a `Selection` data type.
@@ -271,7 +273,7 @@ try {
 
 # Bulk Upsert Customer Custom Attributes
 
-Creates or updates custom attributes for customer profiles as a bulk operation.
+Creates or updates [custom attributes](../../doc/models/custom-attribute.md) for customer profiles as a bulk operation.
 
 Use this endpoint to set the value of one or more custom attributes for one or more customer profiles.
 A custom attribute is based on a custom attribute definition in a Square seller account, which is
@@ -283,7 +285,8 @@ and provides a customer ID and custom attribute. Each upsert response is returne
 of the corresponding request.
 
 To create or update a custom attribute owned by another application, the `visibility` setting
-must be `VISIBILITY_READ_WRITE_VALUES`.
+must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
+(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
 
 ```ts
 async bulkUpsertCustomerCustomAttributes(
@@ -327,7 +330,7 @@ try {
 
 # List Customer Custom Attributes
 
-Lists the custom attributes associated with a customer profile.
+Lists the [custom attributes](../../doc/models/custom-attribute.md) associated with a customer profile.
 
 You can use the `with_definitions` query parameter to also retrieve custom attribute definitions
 in the same call.
@@ -380,10 +383,11 @@ try {
 
 # Delete Customer Custom Attribute
 
-Deletes a custom attribute associated with a customer profile.
+Deletes a [custom attribute](../../doc/models/custom-attribute.md) associated with a customer profile.
 
 To delete a custom attribute owned by another application, the `visibility` setting must be
-`VISIBILITY_READ_WRITE_VALUES`.
+`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
+(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
 
 ```ts
 async deleteCustomerCustomAttribute(
@@ -425,13 +429,14 @@ try {
 
 # Retrieve Customer Custom Attribute
 
-Retrieves a custom attribute associated with a customer profile.
+Retrieves a [custom attribute](../../doc/models/custom-attribute.md) associated with a customer profile.
 
 You can use the `with_definition` query parameter to also retrieve the custom attribute definition
 in the same call.
 
 To retrieve a custom attribute owned by another application, the `visibility` setting must be
-`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
+(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
 
 ```ts
 async retrieveCustomerCustomAttribute(
@@ -478,14 +483,15 @@ try {
 
 # Upsert Customer Custom Attribute
 
-Creates or updates a custom attribute for a customer profile.
+Creates or updates a [custom attribute](../../doc/models/custom-attribute.md) for a customer profile.
 
 Use this endpoint to set the value of a custom attribute for a specified customer profile.
 A custom attribute is based on a custom attribute definition in a Square seller account, which
 is created using the [CreateCustomerCustomAttributeDefinition](../../doc/api/customer-custom-attributes.md#create-customer-custom-attribute-definition) endpoint.
 
 To create or update a custom attribute owned by another application, the `visibility` setting
-must be `VISIBILITY_READ_WRITE_VALUES`.
+must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
+(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
 
 ```ts
 async upsertCustomerCustomAttribute(

doc/api/customers.md

@@ -137,7 +137,7 @@ try {
 
 # Search Customers
 
-Searches the customer profiles associated with a Square account using a supported query filter.
+Searches the customer profiles associated with a Square account using one or more supported query filters.
 
 Calling `SearchCustomers` without any explicit query filter returns all
 customer profiles ordered alphabetically based on `given_name` and

doc/api/disputes.md

@@ -39,8 +39,8 @@ async listDisputes(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `string \| undefined` | 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>For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). |
-| `states` | [`string \| undefined`](../../doc/models/dispute-state.md) | Query, Optional | The dispute states to filter the result.<br>If not specified, the endpoint returns all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`,<br>or `LOST`). |
-| `locationId` | `string \| undefined` | Query, Optional | The ID of the location for which to return a list of disputes. If not specified, the endpoint returns<br>all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`) associated with all locations. |
+| `states` | [`string \| undefined`](../../doc/models/dispute-state.md) | Query, Optional | The dispute states used to filter the result. If not specified, the endpoint returns all disputes. |
+| `locationId` | `string \| undefined` | Query, Optional | The ID of the location for which to return a list of disputes.<br>If not specified, the endpoint returns disputes associated with all locations. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
 ## Response Type
@@ -162,7 +162,7 @@ async listDisputeEvidence(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `disputeId` | `string` | Template, Required | The ID of the dispute. |
-| `cursor` | `string \| undefined` | 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>For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). |
+| `cursor` | `string \| undefined` | 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>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
 ## Response Type
@@ -204,7 +204,7 @@ async createDisputeEvidenceFile(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `disputeId` | `string` | Template, Required | The ID of the dispute you want to upload evidence for. |
+| `disputeId` | `string` | Template, Required | The ID of the dispute for which you want to upload evidence. |
 | `request` | [`CreateDisputeEvidenceFileRequest \| undefined`](../../doc/models/create-dispute-evidence-file-request.md) | Form (JSON-Encoded), Optional | Defines the parameters for a `CreateDisputeEvidenceFile` request. |
 | `imageFile` | `FileWrapper \| undefined` | Form, Optional | - |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
@@ -246,7 +246,7 @@ async createDisputeEvidenceText(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `disputeId` | `string` | Template, Required | The ID of the dispute you want to upload evidence for. |
+| `disputeId` | `string` | Template, Required | The ID of the dispute for which you want to upload evidence. |
 | `body` | [`CreateDisputeEvidenceTextRequest`](../../doc/models/create-dispute-evidence-text-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
@@ -281,9 +281,7 @@ try {
 # Delete Dispute Evidence
 
 Removes specified evidence from a dispute.
-
-Square does not send the bank any evidence that is removed. Also, you cannot remove evidence after
-submitting it to the bank using [SubmitEvidence](../../doc/api/disputes.md#submit-evidence).
+Square does not send the bank any evidence that is removed.
 
 ```ts
 async deleteDisputeEvidence(
@@ -297,7 +295,7 @@ async deleteDisputeEvidence(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `disputeId` | `string` | Template, Required | The ID of the dispute you want to remove evidence from. |
+| `disputeId` | `string` | Template, Required | The ID of the dispute from which you want to remove evidence. |
 | `evidenceId` | `string` | Template, Required | The ID of the evidence you want to remove. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
@@ -325,10 +323,9 @@ try {
 
 # Retrieve Dispute Evidence
 
-Returns the evidence metadata specified by the evidence ID in the request URL path
+Returns the metadata for the evidence specified in the request URL path.
 
-You must maintain a copy of the evidence you upload if you want to reference it later. You cannot
-download the evidence after you upload it.
+You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it.
 
 ```ts
 async retrieveDisputeEvidence(
@@ -342,7 +339,7 @@ async retrieveDisputeEvidence(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `disputeId` | `string` | Template, Required | The ID of the dispute that you want to retrieve evidence from. |
+| `disputeId` | `string` | Template, Required | The ID of the dispute from which you want to retrieve evidence metadata. |
 | `evidenceId` | `string` | Template, Required | The ID of the evidence to retrieve. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
@@ -372,10 +369,11 @@ try {
 
 Submits evidence to the cardholder's bank.
 
-Before submitting evidence, Square compiles all available evidence. This includes evidence uploaded
+The evidence submitted by this endpoint includes evidence uploaded
 using the [CreateDisputeEvidenceFile](../../doc/api/disputes.md#create-dispute-evidence-file) and
 [CreateDisputeEvidenceText](../../doc/api/disputes.md#create-dispute-evidence-text) endpoints and
-evidence automatically provided by Square, when available.
+evidence automatically provided by Square, when available. Evidence cannot be removed from
+a dispute after submission.
 
 ```ts
 async submitEvidence(
@@ -388,7 +386,7 @@ async submitEvidence(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `disputeId` | `string` | Template, Required | The ID of the dispute that you want to submit evidence for. |
+| `disputeId` | `string` | Template, Required | The ID of the dispute for which you want to submit evidence. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
 ## Response Type

doc/api/invoices.md

@@ -359,6 +359,7 @@ bodyInvoicepaymentRequests0.tippingEnabled = false;
 bodyInvoicePaymentRequests[0] = bodyInvoicepaymentRequests0;
 
 const bodyInvoice: Invoice = {};
+bodyInvoice.version = 1;
 bodyInvoice.paymentRequests = bodyInvoicePaymentRequests;
 
 const bodyFieldsToClear: string[] = ['payments_requests[2da7964f-f3d2-4f43-81e8-5aa220bf3355].reminders'];