Merge pull request #96 from square/release/19.1.0

Generated PR for Release: 19.1.0

Author: Wolfgang Schuster

.github/workflows/node.js.yml

@@ -19,7 +19,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [14.x, 16.x, 18.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

README.md

@@ -170,4 +170,4 @@ npm test
 [Cards]: doc/api/cards.md
 [Payouts]: doc/api/payouts.md
 [Gift Cards]: doc/api/gift-cards.md
-[Gift Card Activities]: doc/api/gift-card-activities.md
+[Gift Card Activities]: doc/api/gift-card-activities.md

doc/api/catalog.md

@@ -471,7 +471,7 @@ async listCatalog(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `string \| undefined` | Query, Optional | The pagination cursor returned in the previous response. Leave unset for an initial request.<br>The page size is currently set to be 100.<br>See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. |
-| `types` | `string \| undefined` | Query, Optional | An optional case-insensitive, comma-separated list of object types to retrieve.<br><br>The valid values are defined in the [CatalogObjectType](../../doc/models/catalog-object-type.md) enum, for example,<br>`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,<br>`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.<br><br>If this is unspecified, the operation returns objects of all the top level types at the version<br>of the Square API used to make the request. Object types that are nested onto other object types<br>are not included in the defaults.<br><br>At the current API version the default object types are:<br>ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION,<br>SERVICE_CHARGE, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,<br>SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. |
+| `types` | `string \| undefined` | Query, Optional | An optional case-insensitive, comma-separated list of object types to retrieve.<br><br>The valid values are defined in the [CatalogObjectType](../../doc/models/catalog-object-type.md) enum, for example,<br>`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,<br>`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.<br><br>If this is unspecified, the operation returns objects of all the top level types at the version<br>of the Square API used to make the request. Object types that are nested onto other object types<br>are not included in the defaults.<br><br>At the current API version the default object types are:<br>ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,<br>PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,<br>SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. |
 | `catalogVersion` | `bigint \| undefined` | Query, Optional | The specific version of the catalog objects to be included in the response.<br>This allows you to retrieve historical<br>versions of objects. The specified version value is matched against<br>the [CatalogObject](../../doc/models/catalog-object.md)s' `version` attribute.  If not included, results will<br>be from the current version of the catalog. |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 

doc/api/gift-cards.md

@@ -22,7 +22,7 @@ const giftCardsApi = client.giftCardsApi;
 # List Gift Cards
 
 Lists all gift cards. You can specify optional filters to retrieve
-a subset of the gift cards.
+a subset of the gift cards. Results are sorted by `created_at` in ascending order.
 
 ```ts
 async listGiftCards(

doc/api/loyalty.md

@@ -176,7 +176,7 @@ try {
 
 # Accumulate Loyalty Points
 
-Adds points to a loyalty account.
+Adds points earned from the base loyalty program to a loyalty account.
 
 - If you are using the Orders API to manage orders, you only provide the `order_id`.
   The endpoint reads the order to compute points to add to the buyer's account.
@@ -186,6 +186,8 @@ Adds points to a loyalty account.
   [CalculateLoyaltyPoints](../../doc/api/loyalty.md#calculate-loyalty-points) to compute the points  
   that you provide to this endpoint.
 
+This endpoint excludes additional points earned from loyalty promotions.
+
 ```ts
 async accumulateLoyaltyPoints(
   accountId: string,
@@ -433,7 +435,7 @@ try {
 
 # Calculate Loyalty Points
 
-Calculates the points a purchase earns.
+Calculates the points a purchase earns from the base loyalty program.
 
 - If you are using the Orders API to manage orders, you provide the `order_id` in the request. The
   endpoint calculates the points by reading the order.

doc/api/terminal.md

@@ -26,8 +26,7 @@ const terminalApi = client.terminalApi;
 
 # Create Terminal Action
 
-Creates a Terminal action request and sends it to the specified device to take a payment
-for the requested amount.
+Creates a Terminal action request and sends it to the specified device.
 
 ```ts
 async createTerminalAction(

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `squareVersion` | `string` | Square Connect API versions<br>*Default*: `'2022-05-12'` |
+| `squareVersion` | `string` | Square Connect API versions<br>*Default*: `'2022-06-16'` |
 | `customUrl` | `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`** |
 | `additionalHeaders` | `Readonly<Record<string, string>>` | Additional headers to add to each API call<br>*Default*: `{}` |
@@ -40,7 +40,7 @@ The API client can be initialized as follows:
 
 ```ts
 const client = new Client({
-  squareVersion: '2022-05-12',
+  squareVersion: '2022-06-16',
   timeout: 60000,
   additionalHeaders: {},
   userAgentDetail: '',
@@ -56,7 +56,7 @@ import fs from 'fs';
 import { ApiError, Client, FileWrapper, LocationsApi } from 'square';
 
 const client = new Client({
-  squareVersion: '2022-05-12',
+  squareVersion: '2022-06-16',
   timeout: 60000,
   additionalHeaders: {},
   userAgentDetail: '',

doc/models/appointment-segment.md

@@ -12,9 +12,9 @@ Defines an appointment segment of a booking.
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `durationMinutes` | `number \| undefined` | Optional | The time span in minutes of an appointment segment.<br>**Constraints**: `<= 1500` |
-| `serviceVariationId` | `string` | Required | The ID of the [CatalogItemVariation](../../doc/models/catalog-item-variation.md) object representing the service booked in this segment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
+| `serviceVariationId` | `string \| undefined` | Optional | The ID of the [CatalogItemVariation](../../doc/models/catalog-item-variation.md) object representing the service booked in this segment.<br>**Constraints**: *Maximum Length*: `36` |
 | `teamMemberId` | `string` | Required | The ID of the [TeamMember](../../doc/models/team-member.md) object representing the team member booked in this segment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32` |
-| `serviceVariationVersion` | `bigint` | Required | The current version of the item variation representing the service booked in this segment. |
+| `serviceVariationVersion` | `bigint \| undefined` | Optional | The current version of the item variation representing the service booked in this segment. |
 | `intermissionMinutes` | `number \| undefined` | Optional | Time between the end of this segment and the beginning of the subsequent segment. |
 | `anyTeamMember` | `boolean \| undefined` | Optional | Whether the customer accepts any team member, instead of a specific one, to serve this segment. |
 | `resourceIds` | `string[] \| undefined` | Optional | The IDs of the seller-accessible resources used for this appointment segment. |
@@ -24,9 +24,9 @@ Defines an appointment segment of a booking.
 ```json
 {
   "duration_minutes": null,
-  "service_variation_id": "service_variation_id6",
+  "service_variation_id": null,
   "team_member_id": "team_member_id0",
-  "service_variation_version": 56,
+  "service_variation_version": null,
   "intermission_minutes": null,
   "any_team_member": null,
   "resource_ids": null

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

@@ -13,9 +13,10 @@
 | `locationIds` | `string[] \| undefined` | Optional | The filter to return results by `Location` ID.<br>The filter is only applicable when set. The default value is null. |
 | `types` | [`string[] \| undefined`](../../doc/models/inventory-change-type.md) | Optional | The filter to return results by `InventoryChangeType` values other than `TRANSFER`.<br>The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. |
 | `states` | [`string[] \| undefined`](../../doc/models/inventory-state.md) | Optional | The filter to return `ADJUSTMENT` query results by<br>`InventoryState`. This filter is only applied when set.<br>The default value is null. |
-| `updatedAfter` | `string \| undefined` | Optional | The filter to return results with their `calculated_at` value  <br>after the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). |
-| `updatedBefore` | `string \| undefined` | Optional | The filter to return results with their `created_at` or `calculated_at` value  <br>strictly before the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). |
+| `updatedAfter` | `string \| undefined` | Optional | The filter to return results with their `calculated_at` value<br>after the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). |
+| `updatedBefore` | `string \| undefined` | Optional | The filter to return results with their `created_at` or `calculated_at` value<br>strictly before the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). |
 | `cursor` | `string \| undefined` | Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for the original query.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |
+| `limit` | `number \| undefined` | Optional | **Constraints**: `>= 1`, `<= 1000` |
 
 ## Example (as JSON)
 

doc/models/batch-retrieve-inventory-counts-request.md

@@ -14,6 +14,7 @@
 | `updatedAfter` | `string \| undefined` | Optional | The filter to return results with their `calculated_at` value<br>after the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). |
 | `cursor` | `string \| undefined` | Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for the original query.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |
 | `states` | [`string[] \| undefined`](../../doc/models/inventory-state.md) | Optional | The filter to return results by `InventoryState`. The filter is only applicable when set.<br>Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`.<br>The default is null. |
+| `limit` | `number \| undefined` | Optional | **Constraints**: `>= 1`, `<= 1000` |
 
 ## Example (as JSON)