com.squareup.square.api

Interface LocationCustomAttributesApi

All Known Implementing Classes:

DefaultLocationCustomAttributesApi

public interface LocationCustomAttributesApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
BulkDeleteLocationCustomAttributesResponse	bulkDeleteLocationCustomAttributes(BulkDeleteLocationCustomAttributesRequest body) Deletes [custom attributes]($m/CustomAttribute) for locations as a bulk operation.
CompletableFuture<BulkDeleteLocationCustomAttributesResponse>	bulkDeleteLocationCustomAttributesAsync(BulkDeleteLocationCustomAttributesRequest body) Deletes [custom attributes]($m/CustomAttribute) for locations as a bulk operation.
BulkUpsertLocationCustomAttributesResponse	bulkUpsertLocationCustomAttributes(BulkUpsertLocationCustomAttributesRequest body) Creates or updates [custom attributes]($m/CustomAttribute) for locations as a bulk operation.
CompletableFuture<BulkUpsertLocationCustomAttributesResponse>	bulkUpsertLocationCustomAttributesAsync(BulkUpsertLocationCustomAttributesRequest body) Creates or updates [custom attributes]($m/CustomAttribute) for locations as a bulk operation.
CreateLocationCustomAttributeDefinitionResponse	createLocationCustomAttributeDefinition(CreateLocationCustomAttributeDefinitionRequest body) Creates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
CompletableFuture<CreateLocationCustomAttributeDefinitionResponse>	createLocationCustomAttributeDefinitionAsync(CreateLocationCustomAttributeDefinitionRequest body) Creates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
DeleteLocationCustomAttributeResponse	deleteLocationCustomAttribute(String locationId, String key) Deletes a [custom attribute]($m/CustomAttribute) associated with a location.
CompletableFuture<DeleteLocationCustomAttributeResponse>	deleteLocationCustomAttributeAsync(String locationId, String key) Deletes a [custom attribute]($m/CustomAttribute) associated with a location.
DeleteLocationCustomAttributeDefinitionResponse	deleteLocationCustomAttributeDefinition(String key) Deletes a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<DeleteLocationCustomAttributeDefinitionResponse>	deleteLocationCustomAttributeDefinitionAsync(String key) Deletes a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
ListLocationCustomAttributeDefinitionsResponse	listLocationCustomAttributeDefinitions(String visibilityFilter, Integer limit, String cursor) Lists the location-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
CompletableFuture<ListLocationCustomAttributeDefinitionsResponse>	listLocationCustomAttributeDefinitionsAsync(String visibilityFilter, Integer limit, String cursor) Lists the location-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
ListLocationCustomAttributesResponse	listLocationCustomAttributes(String locationId, String visibilityFilter, Integer limit, String cursor, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with a location.
CompletableFuture<ListLocationCustomAttributesResponse>	listLocationCustomAttributesAsync(String locationId, String visibilityFilter, Integer limit, String cursor, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with a location.
RetrieveLocationCustomAttributeResponse	retrieveLocationCustomAttribute(String locationId, String key, Boolean withDefinition, Integer version) Retrieves a [custom attribute]($m/CustomAttribute) associated with a location.
CompletableFuture<RetrieveLocationCustomAttributeResponse>	retrieveLocationCustomAttributeAsync(String locationId, String key, Boolean withDefinition, Integer version) Retrieves a [custom attribute]($m/CustomAttribute) associated with a location.
RetrieveLocationCustomAttributeDefinitionResponse	retrieveLocationCustomAttributeDefinition(String key, Integer version) Retrieves a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<RetrieveLocationCustomAttributeDefinitionResponse>	retrieveLocationCustomAttributeDefinitionAsync(String key, Integer version) Retrieves a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
UpdateLocationCustomAttributeDefinitionResponse	updateLocationCustomAttributeDefinition(String key, UpdateLocationCustomAttributeDefinitionRequest body) Updates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
CompletableFuture<UpdateLocationCustomAttributeDefinitionResponse>	updateLocationCustomAttributeDefinitionAsync(String key, UpdateLocationCustomAttributeDefinitionRequest body) Updates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
UpsertLocationCustomAttributeResponse	upsertLocationCustomAttribute(String locationId, String key, UpsertLocationCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for a location.
CompletableFuture<UpsertLocationCustomAttributeResponse>	upsertLocationCustomAttributeAsync(String locationId, String key, UpsertLocationCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for a location.

Method Detail

listLocationCustomAttributeDefinitions

ListLocationCustomAttributeDefinitionsResponse listLocationCustomAttributeDefinitions(String visibilityFilter,
                                                                                      Integer limit,
                                                                                      String cursor)
                                                                               throws ApiException,
                                                                                      IOException

Lists the location-related [custom attribute definitions]($m/CustomAttributeDefinition) 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`.

Parameters:

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListLocationCustomAttributeDefinitionsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listLocationCustomAttributeDefinitionsAsync

CompletableFuture<ListLocationCustomAttributeDefinitionsResponse> listLocationCustomAttributeDefinitionsAsync(String visibilityFilter,
                                                                                                              Integer limit,
                                                                                                              String cursor)

Lists the location-related [custom attribute definitions]($m/CustomAttributeDefinition) 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`.

Parameters:

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListLocationCustomAttributeDefinitionsResponse response from the API call

createLocationCustomAttributeDefinition

CreateLocationCustomAttributeDefinitionResponse createLocationCustomAttributeDefinition(CreateLocationCustomAttributeDefinitionRequest body)
                                                                                 throws ApiException,
                                                                                        IOException

Creates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with locations. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertLocationCustomAttribute]($e/LocationCustomAttributes/UpsertLocationCustomAttribute) or [BulkUpsertLocationCustomAttributes]($e/LocationCustomAttributes/BulkUpsertLocationCustomAttributes) to set the custom attribute for locations.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateLocationCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createLocationCustomAttributeDefinitionAsync

CompletableFuture<CreateLocationCustomAttributeDefinitionResponse> createLocationCustomAttributeDefinitionAsync(CreateLocationCustomAttributeDefinitionRequest body)

Creates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with locations. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertLocationCustomAttribute]($e/LocationCustomAttributes/UpsertLocationCustomAttribute) or [BulkUpsertLocationCustomAttributes]($e/LocationCustomAttributes/BulkUpsertLocationCustomAttributes) to set the custom attribute for locations.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateLocationCustomAttributeDefinitionResponse response from the API call

deleteLocationCustomAttributeDefinition

DeleteLocationCustomAttributeDefinitionResponse deleteLocationCustomAttributeDefinition(String key)
                                                                                 throws ApiException,
                                                                                        IOException

Deletes a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all locations. Only the definition owner can delete a custom attribute definition.

Parameters:

key - Required parameter: The key of the custom attribute definition to delete.

Returns:

Returns the DeleteLocationCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteLocationCustomAttributeDefinitionAsync

CompletableFuture<DeleteLocationCustomAttributeDefinitionResponse> deleteLocationCustomAttributeDefinitionAsync(String key)

Deletes a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all locations. Only the definition owner can delete a custom attribute definition.

Parameters:

key - Required parameter: The key of the custom attribute definition to delete.

Returns:

Returns the DeleteLocationCustomAttributeDefinitionResponse response from the API call

retrieveLocationCustomAttributeDefinition

RetrieveLocationCustomAttributeDefinitionResponse retrieveLocationCustomAttributeDefinition(String key,
                                                                                            Integer version)
                                                                                     throws ApiException,
                                                                                            IOException

Retrieves a location-related [custom attribute definition]($m/CustomAttributeDefinition) 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`.

Parameters:

key - Required parameter: The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key.

version - Optional parameter: The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.

Returns:

Returns the RetrieveLocationCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveLocationCustomAttributeDefinitionAsync

CompletableFuture<RetrieveLocationCustomAttributeDefinitionResponse> retrieveLocationCustomAttributeDefinitionAsync(String key,
                                                                                                                    Integer version)

Retrieves a location-related [custom attribute definition]($m/CustomAttributeDefinition) 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`.

Parameters:

key - Required parameter: The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key.

version - Optional parameter: The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.

Returns:

Returns the RetrieveLocationCustomAttributeDefinitionResponse response from the API call

updateLocationCustomAttributeDefinition

UpdateLocationCustomAttributeDefinitionResponse updateLocationCustomAttributeDefinition(String key,
                                                                                        UpdateLocationCustomAttributeDefinitionRequest body)
                                                                                 throws ApiException,
                                                                                        IOException

Updates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the `schema` for a `Selection` data type. Only the definition owner can update a custom attribute definition.

Parameters:

key - Required parameter: The key of the custom attribute definition to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateLocationCustomAttributeDefinitionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateLocationCustomAttributeDefinitionAsync

CompletableFuture<UpdateLocationCustomAttributeDefinitionResponse> updateLocationCustomAttributeDefinitionAsync(String key,
                                                                                                                UpdateLocationCustomAttributeDefinitionRequest body)

Updates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the `schema` for a `Selection` data type. Only the definition owner can update a custom attribute definition.

Parameters:

key - Required parameter: The key of the custom attribute definition to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateLocationCustomAttributeDefinitionResponse response from the API call

bulkDeleteLocationCustomAttributes

BulkDeleteLocationCustomAttributesResponse bulkDeleteLocationCustomAttributes(BulkDeleteLocationCustomAttributesRequest body)
                                                                       throws ApiException,
                                                                              IOException

Deletes [custom attributes]($m/CustomAttribute) for locations as a bulk operation. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkDeleteLocationCustomAttributesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkDeleteLocationCustomAttributesAsync

CompletableFuture<BulkDeleteLocationCustomAttributesResponse> bulkDeleteLocationCustomAttributesAsync(BulkDeleteLocationCustomAttributesRequest body)

Deletes [custom attributes]($m/CustomAttribute) for locations as a bulk operation. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkDeleteLocationCustomAttributesResponse response from the API call

bulkUpsertLocationCustomAttributes

BulkUpsertLocationCustomAttributesResponse bulkUpsertLocationCustomAttributes(BulkUpsertLocationCustomAttributesRequest body)
                                                                       throws ApiException,
                                                                              IOException

Creates or updates [custom attributes]($m/CustomAttribute) for locations as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more locations. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/CreateLocationCustomAttributeDefinition) endpoint. This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides a location ID and custom attribute. Each upsert response is returned with the ID of the corresponding request. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpsertLocationCustomAttributesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

bulkUpsertLocationCustomAttributesAsync

CompletableFuture<BulkUpsertLocationCustomAttributesResponse> bulkUpsertLocationCustomAttributesAsync(BulkUpsertLocationCustomAttributesRequest body)

Creates or updates [custom attributes]($m/CustomAttribute) for locations as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more locations. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/CreateLocationCustomAttributeDefinition) endpoint. This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides a location ID and custom attribute. Each upsert response is returned with the ID of the corresponding request. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the BulkUpsertLocationCustomAttributesResponse response from the API call

listLocationCustomAttributes

ListLocationCustomAttributesResponse listLocationCustomAttributes(String locationId,
                                                                  String visibilityFilter,
                                                                  Integer limit,
                                                                  String cursor,
                                                                  Boolean withDefinitions)
                                                           throws ApiException,
                                                                  IOException

Lists the [custom attributes]($m/CustomAttribute) associated with a location. You can use the `with_definitions` query parameter to also retrieve custom attribute definitions in the same call. When all response pages are retrieved, the results include all custom attributes that are visible to the requesting application, including those that are owned by other applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

withDefinitions - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.

Returns:

Returns the ListLocationCustomAttributesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listLocationCustomAttributesAsync

CompletableFuture<ListLocationCustomAttributesResponse> listLocationCustomAttributesAsync(String locationId,
                                                                                          String visibilityFilter,
                                                                                          Integer limit,
                                                                                          String cursor,
                                                                                          Boolean withDefinitions)

Lists the [custom attributes]($m/CustomAttribute) associated with a location. You can use the `with_definitions` query parameter to also retrieve custom attribute definitions in the same call. When all response pages are retrieved, the results include all custom attributes that are visible to the requesting application, including those that are owned by other applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

visibilityFilter - Optional parameter: Filters the `CustomAttributeDefinition` results by their `visibility` values.

limit - Optional parameter: The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

cursor - Optional parameter: The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

withDefinitions - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.

Returns:

Returns the ListLocationCustomAttributesResponse response from the API call

deleteLocationCustomAttribute

DeleteLocationCustomAttributeResponse deleteLocationCustomAttribute(String locationId,
                                                                    String key)
                                                             throws ApiException,
                                                                    IOException

Deletes a [custom attribute]($m/CustomAttribute) associated with a location. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

key - Required parameter: The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

Returns:

Returns the DeleteLocationCustomAttributeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteLocationCustomAttributeAsync

CompletableFuture<DeleteLocationCustomAttributeResponse> deleteLocationCustomAttributeAsync(String locationId,
                                                                                            String key)

Deletes a [custom attribute]($m/CustomAttribute) associated with a location. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

key - Required parameter: The key of the custom attribute to delete. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

Returns:

Returns the DeleteLocationCustomAttributeResponse response from the API call

retrieveLocationCustomAttribute

RetrieveLocationCustomAttributeResponse retrieveLocationCustomAttribute(String locationId,
                                                                        String key,
                                                                        Boolean withDefinition,
                                                                        Integer version)
                                                                 throws ApiException,
                                                                        IOException

Retrieves a [custom attribute]($m/CustomAttribute) associated with a location. 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`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

key - Required parameter: The key of the custom attribute to retrieve. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

withDefinition - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.

version - Optional parameter: The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.

Returns:

Returns the RetrieveLocationCustomAttributeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveLocationCustomAttributeAsync

CompletableFuture<RetrieveLocationCustomAttributeResponse> retrieveLocationCustomAttributeAsync(String locationId,
                                                                                                String key,
                                                                                                Boolean withDefinition,
                                                                                                Integer version)

Retrieves a [custom attribute]($m/CustomAttribute) associated with a location. 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`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

key - Required parameter: The key of the custom attribute to retrieve. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

withDefinition - Optional parameter: Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.

version - Optional parameter: The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.

Returns:

Returns the RetrieveLocationCustomAttributeResponse response from the API call

upsertLocationCustomAttribute

UpsertLocationCustomAttributeResponse upsertLocationCustomAttribute(String locationId,
                                                                    String key,
                                                                    UpsertLocationCustomAttributeRequest body)
                                                             throws ApiException,
                                                                    IOException

Creates or updates a [custom attribute]($m/CustomAttribute) for a location. Use this endpoint to set the value of a custom attribute for a specified location. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/CreateLocationCustomAttributeDefinition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

key - Required parameter: The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpsertLocationCustomAttributeResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

upsertLocationCustomAttributeAsync

CompletableFuture<UpsertLocationCustomAttributeResponse> upsertLocationCustomAttributeAsync(String locationId,
                                                                                            String key,
                                                                                            UpsertLocationCustomAttributeRequest body)

Creates or updates a [custom attribute]($m/CustomAttribute) for a location. Use this endpoint to set the value of a custom attribute for a specified location. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/CreateLocationCustomAttributeDefinition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

locationId - Required parameter: The ID of the target [location](entity:Location).

key - Required parameter: The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpsertLocationCustomAttributeResponse response from the API call