Merge pull request #95 from square/release/27.1.0.20230119

Generated PR for Release: 27.1.0.20230119

Author: jessdelacruzsantos

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 Square, Inc.
+Copyright 2023 Square, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

doc/api/location-custom-attributes.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-12-14"` |
+| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2023-01-19"` |
 | `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`** |
 | `httpClientConfig` | [`ReadonlyHttpClientConfiguration`](http-client-configuration.md) | Http Client Configuration instance. |
@@ -19,7 +19,7 @@ The API client can be initialized as follows:
 SquareClient client = new SquareClient.Builder()
     .httpClientConfig(configBuilder -> configBuilder
             .timeout(0))
-    .squareVersion("2022-12-14")
+    .squareVersion("2023-01-19")
     .accessToken("AccessToken")
     .environment(Environment.PRODUCTION)
     .customUrl("https://connect.squareup.com")
@@ -45,7 +45,7 @@ public class Program {
         SquareClient client = new SquareClient.Builder()
             .httpClientConfig(configBuilder -> configBuilder
                     .timeout(0))
-            .squareVersion("2022-12-14")
+            .squareVersion("2023-01-19")
             .accessToken("AccessToken")
             .build();
 
@@ -92,6 +92,7 @@ The gateway for the SDK. This class acts as a factory for the Apis and also hold
 | `getInvoicesApi()` | Provides access to Invoices controller. | `InvoicesApi` |
 | `getLaborApi()` | Provides access to Labor controller. | `LaborApi` |
 | `getLocationsApi()` | Provides access to Locations controller. | `LocationsApi` |
+| `getLocationCustomAttributesApi()` | Provides access to LocationCustomAttributes controller. | `LocationCustomAttributesApi` |
 | `getCheckoutApi()` | Provides access to Checkout controller. | `CheckoutApi` |
 | `getTransactionsApi()` | Provides access to Transactions controller. | `TransactionsApi` |
 | `getLoyaltyApi()` | Provides access to Loyalty controller. | `LoyaltyApi` |

doc/client.md

@@ -15,7 +15,7 @@ instances on a `Shift`.
 | `Id` | `String` | Optional | The UUID for this object.<br>**Constraints**: *Maximum Length*: `255` | String getId() |
 | `LocationId` | `String` | Required | The ID of the business location this type of break applies to.<br>**Constraints**: *Minimum Length*: `1` | String getLocationId() |
 | `BreakName` | `String` | Required | A human-readable name for this type of break. The name is displayed to<br>employees in Square products.<br>**Constraints**: *Minimum Length*: `1` | String getBreakName() |
-| `ExpectedDuration` | `String` | Required | Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of<br>this break. Precision less than minutes is truncated.<br>**Constraints**: *Minimum Length*: `1` | String getExpectedDuration() |
+| `ExpectedDuration` | `String` | Required | Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of<br>this break. Precision less than minutes is truncated.<br><br>Example for break expected duration of 15 minutes: T15M<br>**Constraints**: *Minimum Length*: `1` | String getExpectedDuration() |
 | `IsPaid` | `boolean` | Required | Whether this break counts towards time worked for compensation<br>purposes. | boolean getIsPaid() |
 | `Version` | `Integer` | Optional | Used for resolving concurrency issues. The request fails if the version<br>provided does not match the server version at the time of the request. If a value is not<br>provided, Square's servers execute a "blind" write; potentially<br>overwriting another writer's data. | Integer getVersion() |
 | `CreatedAt` | `String` | Optional | A read-only timestamp in RFC 3339 format. | String getCreatedAt() |

doc/models/break-type.md

@@ -0,0 +1,23 @@
+
+# Bulk Delete Location Custom Attributes Request Location Custom Attribute Delete Request
+
+Represents an individual delete request in a [BulkDeleteLocationCustomAttributes](../../doc/api/location-custom-attributes.md#bulk-delete-location-custom-attributes)
+request. An individual request contains an optional ID of the associated custom attribute definition
+and optional key of the associated custom attribute definition.
+
+## Structure
+
+`BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `Key` | `String` | Optional | The key of the associated custom attribute definition.<br>Represented as a qualified key if the requesting app is not the definition owner.<br>**Constraints**: *Pattern*: `^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$` | String getKey() |
+
+## Example (as JSON)
+
+```json
+{}
+```
+

doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md

@@ -0,0 +1,36 @@
+
+# Bulk Delete Location Custom Attributes Request
+
+Represents a [BulkDeleteLocationCustomAttributes](../../doc/api/location-custom-attributes.md#bulk-delete-location-custom-attributes) request.
+
+## Structure
+
+`BulkDeleteLocationCustomAttributesRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `Values` | [`Map<String, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest>`](../../doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md) | Required | The data used to update the `CustomAttribute` objects.<br>The keys must be unique and are used to map to the corresponding response. | Map<String, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest> getValues() |
+
+## Example (as JSON)
+
+```json
+{
+  "values": {
+    "id1": {
+      "key": "bestseller",
+      "location_id": "L0TBCBTB7P8RQ"
+    },
+    "id2": {
+      "key": "bestseller",
+      "location_id": "L9XMD04V3STJX"
+    },
+    "id3": {
+      "key": "phone-number",
+      "location_id": "L0TBCBTB7P8RQ"
+    }
+  }
+}
+```
+

doc/models/bulk-delete-location-custom-attributes-request.md

@@ -0,0 +1,26 @@
+
+# Bulk Delete Location Custom Attributes Response Location Custom Attribute Delete Response
+
+Represents an individual delete response in a [BulkDeleteLocationCustomAttributes](../../doc/api/location-custom-attributes.md#bulk-delete-location-custom-attributes)
+request.
+
+## Structure
+
+`BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `LocationId` | `String` | Optional | The ID of the location associated with the custom attribute. | String getLocationId() |
+| `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request | List<Error> getErrors() |
+
+## Example (as JSON)
+
+```json
+{
+  "errors": [],
+  "location_id": "L0TBCBTB7P8RQ"
+}
+```
+

doc/models/bulk-delete-location-custom-attributes-response-location-custom-attribute-delete-response.md

@@ -0,0 +1,38 @@
+
+# Bulk Delete Location Custom Attributes Response
+
+Represents a [BulkDeleteLocationCustomAttributes](../../doc/api/location-custom-attributes.md#bulk-delete-location-custom-attributes) response,
+which contains a map of responses that each corresponds to an individual delete request.
+
+## Structure
+
+`BulkDeleteLocationCustomAttributesResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `Values` | [`Map<String, BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse>`](../../doc/models/bulk-delete-location-custom-attributes-response-location-custom-attribute-delete-response.md) | Required | A map of responses that correspond to individual delete requests. Each response has the<br>same key as the corresponding request. | Map<String, BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse> getValues() |
+| `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | List<Error> getErrors() |
+
+## Example (as JSON)
+
+```json
+{
+  "values": {
+    "id1": {
+      "errors": [],
+      "location_id": "L0TBCBTB7P8RQ"
+    },
+    "id2": {
+      "errors": [],
+      "location_id": "L9XMD04V3STJX"
+    },
+    "id3": {
+      "errors": [],
+      "location_id": "L0TBCBTB7P8RQ"
+    }
+  }
+}
+```
+

doc/models/bulk-delete-location-custom-attributes-response.md

@@ -0,0 +1,35 @@
+
+# Bulk Upsert Location Custom Attributes Request Location Custom Attribute Upsert Request
+
+Represents an individual upsert request in a [BulkUpsertLocationCustomAttributes](../../doc/api/location-custom-attributes.md#bulk-upsert-location-custom-attributes)
+request. An individual request contains a location ID, the custom attribute to create or update,
+and an optional idempotency key.
+
+## Structure
+
+`BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `LocationId` | `String` | Required | The ID of the target [location](../../doc/models/location.md).<br>**Constraints**: *Minimum Length*: `1` | String getLocationId() |
+| `CustomAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding<br>`CustomAttributeDefinition` object. | CustomAttribute getCustomAttribute() |
+| `IdempotencyKey` | `String` | Optional | A unique identifier for this individual upsert request, used to ensure idempotency.<br>For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).<br>**Constraints**: *Maximum Length*: `45` | String getIdempotencyKey() |
+
+## Example (as JSON)
+
+```json
+{
+  "location_id": "location_id4",
+  "custom_attribute": {
+    "key": null,
+    "value": null,
+    "version": null,
+    "visibility": null,
+    "definition": null
+  },
+  "idempotency_key": null
+}
+```
+

doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md

@@ -0,0 +1,57 @@
+
+# Bulk Upsert Location Custom Attributes Request
+
+Represents a [BulkUpsertLocationCustomAttributes](../../doc/api/location-custom-attributes.md#bulk-upsert-location-custom-attributes) request.
+
+## Structure
+
+`BulkUpsertLocationCustomAttributesRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `Values` | [`Map<String, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest>`](../../doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md) | Required | A map containing 1 to 25 individual upsert requests. For each request, provide an<br>arbitrary ID that is unique for this `BulkUpsertLocationCustomAttributes` request and the<br>information needed to create or update a custom attribute. | Map<String, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest> getValues() |
+
+## Example (as JSON)
+
+```json
+{
+  "values": {
+    "key0": {
+      "location_id": "location_id4",
+      "custom_attribute": {
+        "key": null,
+        "value": null,
+        "version": null,
+        "visibility": null,
+        "definition": null
+      },
+      "idempotency_key": null
+    },
+    "key1": {
+      "location_id": "location_id5",
+      "custom_attribute": {
+        "key": null,
+        "value": null,
+        "version": null,
+        "visibility": null,
+        "definition": null
+      },
+      "idempotency_key": null
+    },
+    "key2": {
+      "location_id": "location_id6",
+      "custom_attribute": {
+        "key": null,
+        "value": null,
+        "version": null,
+        "visibility": null,
+        "definition": null
+      },
+      "idempotency_key": null
+    }
+  }
+}
+```
+