Merge pull request #103 from square/release/25.1.0.20230119

Generated PR for Release: 25.1.0.20230119

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

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "square/square",
     "description": "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.",
-    "version": "25.0.0.20221214",
+    "version": "25.1.0.20230119",
     "type": "library",
     "keywords": [
         "Square",

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-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`** |
 | `timeout` | `int` | Timeout for API calls in seconds.<br>*Default*: `60` |
@@ -26,7 +26,7 @@ The API client can be initialized as follows:
 ```php
 $client = Square\SquareClientBuilder::init()
     ->accessToken('AccessToken')
-    ->squareVersion('2022-12-14')
+    ->squareVersion('2023-01-19')
     ->environment('production')
     ->customUrl('https://connect.squareup.com')
     ->build();
@@ -49,7 +49,7 @@ require_once "vendor/autoload.php";
 
 $client = Square\SquareClientBuilder::init()
     ->accessToken('AccessToken')
-    ->squareVersion('2022-12-14')
+    ->squareVersion('2023-01-19')
     ->build();
 
 $locationsApi = $client->getLocationsApi();
@@ -98,6 +98,7 @@ The gateway for the SDK. This class acts as a factory for the Apis and also hold
 | getInvoicesApi() | Gets InvoicesApi |
 | getLaborApi() | Gets LaborApi |
 | getLocationsApi() | Gets LocationsApi |
+| getLocationCustomAttributesApi() | Gets LocationCustomAttributesApi |
 | getCheckoutApi() | Gets CheckoutApi |
 | getTransactionsApi() | Gets TransactionsApi |
 | getLoyaltyApi() | Gets LoyaltyApi |

doc/models/break-type.md

@@ -15,7 +15,7 @@ instances on a `Shift`.
 | `id` | `?string` | Optional | The UUID for this object.<br>**Constraints**: *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
 | `locationId` | `string` | Required | The ID of the business location this type of break applies to.<br>**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
 | `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` | getBreakName(): string | setBreakName(string breakName): void |
-| `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` | getExpectedDuration(): string | setExpectedDuration(string expectedDuration): void |
+| `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` | getExpectedDuration(): string | setExpectedDuration(string expectedDuration): void |
 | `isPaid` | `bool` | Required | Whether this break counts towards time worked for compensation<br>purposes. | getIsPaid(): bool | setIsPaid(bool isPaid): void |
 | `version` | `?int` | 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. | getVersion(): ?int | setVersion(?int version): void |
 | `createdAt` | `?string` | Optional | A read-only timestamp in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |

doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.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/apis/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 | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `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}$` | getKey(): ?string | setKey(?string key): void |
+
+## Example (as JSON)
+
+```json
+{}
+```
+

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

@@ -0,0 +1,36 @@
+
+# Bulk Delete Location Custom Attributes Request
+
+Represents a [BulkDeleteLocationCustomAttributes](../../doc/apis/location-custom-attributes.md#bulk-delete-location-custom-attributes) request.
+
+## Structure
+
+`BulkDeleteLocationCustomAttributesRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `values` | [`array<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. | getValues(): array | setValues(array values): void |
+
+## 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-response-location-custom-attribute-delete-response.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/apis/location-custom-attributes.md#bulk-delete-location-custom-attributes)
+request.
+
+## Structure
+
+`BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `locationId` | `?string` | Optional | The ID of the location associated with the custom attribute. | getLocationId(): ?string | setLocationId(?string locationId): void |
+| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred while processing the individual LocationCustomAttributeDeleteRequest request | getErrors(): ?array | setErrors(?array errors): void |
+
+## Example (as JSON)
+
+```json
+{
+  "errors": [],
+  "location_id": "L0TBCBTB7P8RQ"
+}
+```
+

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

@@ -0,0 +1,38 @@
+
+# Bulk Delete Location Custom Attributes Response
+
+Represents a [BulkDeleteLocationCustomAttributes](../../doc/apis/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 | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `values` | [`array<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. | getValues(): array | setValues(array values): void |
+| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
+
+## Example (as JSON)
+
+```json
+{
+  "values": {
+    "id1": {
+      "errors": [],
+      "location_id": "L0TBCBTB7P8RQ"
+    },
+    "id2": {
+      "errors": [],
+      "location_id": "L9XMD04V3STJX"
+    },
+    "id3": {
+      "errors": [],
+      "location_id": "L0TBCBTB7P8RQ"
+    }
+  }
+}
+```
+

doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.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/apis/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 | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `locationId` | `string` | Required | The ID of the target [location](../../doc/models/location.md).<br>**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
+| `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding<br>`CustomAttributeDefinition` object. | getCustomAttribute(): CustomAttribute | setCustomAttribute(CustomAttribute customAttribute): void |
+| `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` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
+
+## 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.md

@@ -0,0 +1,57 @@
+
+# Bulk Upsert Location Custom Attributes Request
+
+Represents a [BulkUpsertLocationCustomAttributes](../../doc/apis/location-custom-attributes.md#bulk-upsert-location-custom-attributes) request.
+
+## Structure
+
+`BulkUpsertLocationCustomAttributesRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `values` | [`array<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. | getValues(): array | setValues(array values): void |
+
+## 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
+    }
+  }
+}
+```
+

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

@@ -0,0 +1,27 @@
+
+# Bulk Upsert Location Custom Attributes Response Location Custom Attribute Upsert Response
+
+Represents a response for an individual upsert request in a [BulkUpsertLocationCustomAttributes](../../doc/apis/location-custom-attributes.md#bulk-upsert-location-custom-attributes) operation.
+
+## Structure
+
+`BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `locationId` | `?string` | Optional | The ID of the location associated with the custom attribute. | getLocationId(): ?string | setLocationId(?string locationId): void |
+| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding<br>`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
+| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred while processing the individual request. | getErrors(): ?array | setErrors(?array errors): void |
+
+## Example (as JSON)
+
+```json
+{
+  "location_id": null,
+  "custom_attribute": null,
+  "errors": null
+}
+```
+

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

@@ -0,0 +1,26 @@
+
+# Bulk Upsert Location Custom Attributes Response
+
+Represents a [BulkUpsertLocationCustomAttributes](../../doc/apis/location-custom-attributes.md#bulk-upsert-location-custom-attributes) response,
+which contains a map of responses that each corresponds to an individual upsert request.
+
+## Structure
+
+`BulkUpsertLocationCustomAttributesResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `values` | [`?array<string,BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse>`](../../doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md) | Optional | A map of responses that correspond to individual upsert requests. Each response has the<br>same ID as the corresponding request and contains either a `location_id` and `custom_attribute` or an `errors` field. | getValues(): ?array | setValues(?array values): void |
+| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
+
+## Example (as JSON)
+
+```json
+{
+  "values": null,
+  "errors": null
+}
+```
+

doc/models/create-location-custom-attribute-definition-request.md

@@ -0,0 +1,30 @@
+
+# Create Location Custom Attribute Definition Request
+
+Represents a [CreateLocationCustomAttributeDefinition](../../doc/apis/location-custom-attributes.md#create-location-custom-attribute-definition) request.
+
+## Structure
+
+`CreateLocationCustomAttributeDefinitionRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition<br>specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
+| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,<br>see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).<br>**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
+
+## Example (as JSON)
+
+```json
+{
+  "custom_attribute_definition": {
+    "description": "Bestselling item at location",
+    "key": "bestseller",
+    "name": "Bestseller",
+    "schema": null,
+    "visibility": "VISIBILITY_READ_WRITE_VALUES"
+  }
+}
+```
+