Skip to content

Commit e9c8ddf

Browse files
author
autobot
committed
Generated PR for Release: 20.1.0.20220616
1 parent fc8ae9d commit e9c8ddf

File tree

98 files changed

+1127
-417
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+1127
-417
lines changed

doc/api/catalog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ CompletableFuture<ListCatalogResponse> listCatalogAsync(
417417
| Parameter | Type | Tags | Description |
418418
| --- | --- | --- | --- |
419419
| `cursor` | `String` | 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. |
420-
| `types` | `String` | 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. |
420+
| `types` | `String` | 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. |
421421
| `catalogVersion` | `Long` | 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. |
422422

423423
## Response Type

doc/api/gift-cards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ GiftCardsApi giftCardsApi = client.getGiftCardsApi();
2222
# List Gift Cards
2323

2424
Lists all gift cards. You can specify optional filters to retrieve
25-
a subset of the gift cards.
25+
a subset of the gift cards. Results are sorted by `created_at` in ascending order.
2626

2727
```java
2828
CompletableFuture<ListGiftCardsResponse> listGiftCardsAsync(

doc/api/loyalty.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,15 +154,17 @@ loyaltyApi.retrieveLoyaltyAccountAsync(accountId).thenAccept(result -> {
154154

155155
# Accumulate Loyalty Points
156156

157-
Adds points to a loyalty account.
157+
Adds points earned from the base loyalty program to a loyalty account.
158158

159159
- If you are using the Orders API to manage orders, you only provide the `order_id`.
160160
The endpoint reads the order to compute points to add to the buyer's account.
161161
- If you are not using the Orders API to manage orders,
162162
you first perform a client-side computation to compute the points.
163163
For spend-based and visit-based programs, you can first call
164164
[CalculateLoyaltyPoints](../../doc/api/loyalty.md#calculate-loyalty-points) to compute the points
165-
that you provide to this endpoint.
165+
that you provide to this endpoint.
166+
167+
This endpoint excludes additional points earned from loyalty promotions.
166168

167169
```java
168170
CompletableFuture<AccumulateLoyaltyPointsResponse> accumulateLoyaltyPointsAsync(
@@ -368,7 +370,7 @@ loyaltyApi.retrieveLoyaltyProgramAsync(programId).thenAccept(result -> {
368370

369371
# Calculate Loyalty Points
370372

371-
Calculates the points a purchase earns.
373+
Calculates the points a purchase earns from the base loyalty program.
372374

373375
- If you are using the Orders API to manage orders, you provide the `order_id` in the request. The
374376
endpoint calculates the points by reading the order.

doc/api/terminal.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ TerminalApi terminalApi = client.getTerminalApi();
2626

2727
# Create Terminal Action
2828

29-
Creates a Terminal action request and sends it to the specified device to take a payment
30-
for the requested amount.
29+
Creates a Terminal action request and sends it to the specified device.
3130

3231
```java
3332
CompletableFuture<CreateTerminalActionResponse> createTerminalActionAsync(

doc/client.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
55

66
| Parameter | Type | Description |
77
| --- | --- | --- |
8-
| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2022-05-12"` |
8+
| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2022-06-16"` |
99
| `customUrl` | `String` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `"https://connect.squareup.com"` |
1010
| `environment` | `string` | The API environment. <br> **Default: `production`** |
1111
| `httpClientConfig` | `ReadonlyHttpClientConfiguration` | Http Client Configuration instance. |
@@ -19,7 +19,7 @@ The API client can be initialized as follows:
1919
SquareClient client = new SquareClient.Builder()
2020
.httpClientConfig(configBuilder -> configBuilder
2121
.timeout(0))
22-
.squareVersion("2022-05-12")
22+
.squareVersion("2022-06-16")
2323
.accessToken("AccessToken")
2424
.environment(Environment.PRODUCTION)
2525
.customUrl("https://connect.squareup.com")
@@ -45,7 +45,7 @@ public class Program {
4545
SquareClient client = new SquareClient.Builder()
4646
.httpClientConfig(configBuilder -> configBuilder
4747
.timeout(0))
48-
.squareVersion("2022-05-12")
48+
.squareVersion("2022-06-16")
4949
.accessToken("AccessToken")
5050
.build();
5151

doc/models/appointment-segment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Defines an appointment segment of a booking.
1212
| Name | Type | Tags | Description | Getter |
1313
| --- | --- | --- | --- | --- |
1414
| `DurationMinutes` | `Integer` | Optional | The time span in minutes of an appointment segment.<br>**Constraints**: `<= 1500` | Integer getDurationMinutes() |
15-
| `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` | String getServiceVariationId() |
15+
| `ServiceVariationId` | `String` | 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` | String getServiceVariationId() |
1616
| `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` | String getTeamMemberId() |
17-
| `ServiceVariationVersion` | `long` | Required | The current version of the item variation representing the service booked in this segment. | long getServiceVariationVersion() |
17+
| `ServiceVariationVersion` | `Long` | Optional | The current version of the item variation representing the service booked in this segment. | Long getServiceVariationVersion() |
1818
| `IntermissionMinutes` | `Integer` | Optional | Time between the end of this segment and the beginning of the subsequent segment. | Integer getIntermissionMinutes() |
1919
| `AnyTeamMember` | `Boolean` | Optional | Whether the customer accepts any team member, instead of a specific one, to serve this segment. | Boolean getAnyTeamMember() |
2020
| `ResourceIds` | `List<String>` | Optional | The IDs of the seller-accessible resources used for this appointment segment. | List<String> getResourceIds() |
@@ -24,9 +24,9 @@ Defines an appointment segment of a booking.
2424
```json
2525
{
2626
"duration_minutes": null,
27-
"service_variation_id": "service_variation_id6",
27+
"service_variation_id": null,
2828
"team_member_id": "team_member_id0",
29-
"service_variation_version": 56,
29+
"service_variation_version": null,
3030
"intermission_minutes": null,
3131
"any_team_member": null,
3232
"resource_ids": null

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@
1313
| `LocationIds` | `List<String>` | Optional | The filter to return results by `Location` ID.<br>The filter is only applicable when set. The default value is null. | List<String> getLocationIds() |
1414
| `Types` | [`List<String>`](../../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]`. | List<String> getTypes() |
1515
| `States` | [`List<String>`](../../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. | List<String> getStates() |
16-
| `UpdatedAfter` | `String` | 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`). | String getUpdatedAfter() |
17-
| `UpdatedBefore` | `String` | 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`). | String getUpdatedBefore() |
16+
| `UpdatedAfter` | `String` | 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`). | String getUpdatedAfter() |
17+
| `UpdatedBefore` | `String` | 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`). | String getUpdatedBefore() |
1818
| `Cursor` | `String` | 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. | String getCursor() |
19+
| `Limit` | `Integer` | Optional | **Constraints**: `>= 1`, `<= 1000` | Integer getLimit() |
1920

2021
## Example (as JSON)
2122

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
| `UpdatedAfter` | `String` | 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`). | String getUpdatedAfter() |
1515
| `Cursor` | `String` | 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. | String getCursor() |
1616
| `States` | [`List<String>`](../../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. | List<String> getStates() |
17+
| `Limit` | `Integer` | Optional | **Constraints**: `>= 1`, `<= 1000` | Integer getLimit() |
1718

1819
## Example (as JSON)
1920

doc/models/calculate-loyalty-points-response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ a specified purchase.
1313
| Name | Type | Tags | Description | Getter |
1414
| --- | --- | --- | --- | --- |
1515
| `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | List<Error> getErrors() |
16-
| `Points` | `Integer` | Optional | The points that the buyer can earn from a specified purchase. | Integer getPoints() |
16+
| `Points` | `Integer` | Optional | The points that the buyer can earn from a specified purchase.<br>This value does not include additional points earned from a loyalty promotion. | Integer getPoints() |
1717

1818
## Example (as JSON)
1919

doc/models/cancel-terminal-action-response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
| Name | Type | Tags | Description | Getter |
1111
| --- | --- | --- | --- | --- |
1212
| `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | List<Error> getErrors() |
13-
| `Action` | [`TerminalAction`](../../doc/models/terminal-action.md) | Optional | - | TerminalAction getAction() |
13+
| `Action` | [`TerminalAction`](../../doc/models/terminal-action.md) | Optional | Represents an action processed by the Square Terminal. | TerminalAction getAction() |
1414

1515
## Example (as JSON)
1616

0 commit comments

Comments
 (0)