com.squareup.square.api

Interface CustomerCustomAttributesApi

All Known Implementing Classes:

DefaultCustomerCustomAttributesApi

public interface CustomerCustomAttributesApi

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
BulkUpsertCustomerCustomAttributesResponse	bulkUpsertCustomerCustomAttributes(BulkUpsertCustomerCustomAttributesRequest body) Creates or updates [custom attributes]($m/CustomAttribute) for customer profiles as a bulk operation.
CompletableFuture<BulkUpsertCustomerCustomAttributesResponse>	bulkUpsertCustomerCustomAttributesAsync(BulkUpsertCustomerCustomAttributesRequest body) Creates or updates [custom attributes]($m/CustomAttribute) for customer profiles as a bulk operation.
CreateCustomerCustomAttributeDefinitionResponse	createCustomerCustomAttributeDefinition(CreateCustomerCustomAttributeDefinitionRequest body) Creates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
CompletableFuture<CreateCustomerCustomAttributeDefinitionResponse>	createCustomerCustomAttributeDefinitionAsync(CreateCustomerCustomAttributeDefinitionRequest body) Creates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
DeleteCustomerCustomAttributeResponse	deleteCustomerCustomAttribute(String customerId, String key) Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
CompletableFuture<DeleteCustomerCustomAttributeResponse>	deleteCustomerCustomAttributeAsync(String customerId, String key) Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
DeleteCustomerCustomAttributeDefinitionResponse	deleteCustomerCustomAttributeDefinition(String key) Deletes a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<DeleteCustomerCustomAttributeDefinitionResponse>	deleteCustomerCustomAttributeDefinitionAsync(String key) Deletes a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
ListCustomerCustomAttributeDefinitionsResponse	listCustomerCustomAttributeDefinitions(Integer limit, String cursor) Lists the customer-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
CompletableFuture<ListCustomerCustomAttributeDefinitionsResponse>	listCustomerCustomAttributeDefinitionsAsync(Integer limit, String cursor) Lists the customer-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
ListCustomerCustomAttributesResponse	listCustomerCustomAttributes(String customerId, Integer limit, String cursor, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with a customer profile.
CompletableFuture<ListCustomerCustomAttributesResponse>	listCustomerCustomAttributesAsync(String customerId, Integer limit, String cursor, Boolean withDefinitions) Lists the [custom attributes]($m/CustomAttribute) associated with a customer profile.
RetrieveCustomerCustomAttributeResponse	retrieveCustomerCustomAttribute(String customerId, String key, Boolean withDefinition, Integer version) Retrieves a [custom attribute]($m/CustomAttribute) associated with a customer profile.
CompletableFuture<RetrieveCustomerCustomAttributeResponse>	retrieveCustomerCustomAttributeAsync(String customerId, String key, Boolean withDefinition, Integer version) Retrieves a [custom attribute]($m/CustomAttribute) associated with a customer profile.
RetrieveCustomerCustomAttributeDefinitionResponse	retrieveCustomerCustomAttributeDefinition(String key, Integer version) Retrieves a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
CompletableFuture<RetrieveCustomerCustomAttributeDefinitionResponse>	retrieveCustomerCustomAttributeDefinitionAsync(String key, Integer version) Retrieves a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
UpdateCustomerCustomAttributeDefinitionResponse	updateCustomerCustomAttributeDefinition(String key, UpdateCustomerCustomAttributeDefinitionRequest body) Updates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
CompletableFuture<UpdateCustomerCustomAttributeDefinitionResponse>	updateCustomerCustomAttributeDefinitionAsync(String key, UpdateCustomerCustomAttributeDefinitionRequest body) Updates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account.
UpsertCustomerCustomAttributeResponse	upsertCustomerCustomAttribute(String customerId, String key, UpsertCustomerCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for a customer profile.
CompletableFuture<UpsertCustomerCustomAttributeResponse>	upsertCustomerCustomAttributeAsync(String customerId, String key, UpsertCustomerCustomAttributeRequest body) Creates or updates a [custom attribute]($m/CustomAttribute) for a customer profile.

Method Detail

listCustomerCustomAttributeDefinitions

ListCustomerCustomAttributeDefinitionsResponse listCustomerCustomAttributeDefinitions(Integer limit,
                                                                                      String cursor)
                                                                               throws ApiException,
                                                                                      IOException

Lists the customer-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

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 ListCustomerCustomAttributeDefinitionsResponse 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.

listCustomerCustomAttributeDefinitionsAsync

CompletableFuture<ListCustomerCustomAttributeDefinitionsResponse> listCustomerCustomAttributeDefinitionsAsync(Integer limit,
                                                                                                              String cursor)

Lists the customer-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

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 ListCustomerCustomAttributeDefinitionsResponse response from the API call

createCustomerCustomAttributeDefinition

CreateCustomerCustomAttributeDefinitionResponse createCustomerCustomAttributeDefinition(CreateCustomerCustomAttributeDefinitionRequest body)
                                                                                 throws ApiException,
                                                                                        IOException

Creates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with customer profiles. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertCustomerCustomAttribute]($e/CustomerCustomAttributes/UpsertCustomerCustomAttribute) or [BulkUpsertCustomerCustomAttributes]($e/CustomerCustomAttributes/BulkUpsertCustomerCustomAttributes) to set the custom attribute for customer profiles in the seller's Customer Directory. Sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

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 CreateCustomerCustomAttributeDefinitionResponse 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.

createCustomerCustomAttributeDefinitionAsync

CompletableFuture<CreateCustomerCustomAttributeDefinitionResponse> createCustomerCustomAttributeDefinitionAsync(CreateCustomerCustomAttributeDefinitionRequest body)

Creates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with customer profiles. A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertCustomerCustomAttribute]($e/CustomerCustomAttributes/UpsertCustomerCustomAttribute) or [BulkUpsertCustomerCustomAttributes]($e/CustomerCustomAttributes/BulkUpsertCustomerCustomAttributes) to set the custom attribute for customer profiles in the seller's Customer Directory. Sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

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 CreateCustomerCustomAttributeDefinitionResponse response from the API call

deleteCustomerCustomAttributeDefinition

DeleteCustomerCustomAttributeDefinitionResponse deleteCustomerCustomAttributeDefinition(String key)
                                                                                 throws ApiException,
                                                                                        IOException

Deletes a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all customer profiles in the seller's Customer Directory. 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 DeleteCustomerCustomAttributeDefinitionResponse 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.

deleteCustomerCustomAttributeDefinitionAsync

CompletableFuture<DeleteCustomerCustomAttributeDefinitionResponse> deleteCustomerCustomAttributeDefinitionAsync(String key)

Deletes a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all customer profiles in the seller's Customer Directory. 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 DeleteCustomerCustomAttributeDefinitionResponse response from the API call

retrieveCustomerCustomAttributeDefinition

RetrieveCustomerCustomAttributeDefinitionResponse retrieveCustomerCustomAttributeDefinition(String key,
                                                                                            Integer version)
                                                                                     throws ApiException,
                                                                                            IOException

Retrieves a customer-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 RetrieveCustomerCustomAttributeDefinitionResponse 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.

retrieveCustomerCustomAttributeDefinitionAsync

CompletableFuture<RetrieveCustomerCustomAttributeDefinitionResponse> retrieveCustomerCustomAttributeDefinitionAsync(String key,
                                                                                                                    Integer version)

Retrieves a customer-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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 RetrieveCustomerCustomAttributeDefinitionResponse response from the API call

updateCustomerCustomAttributeDefinition

UpdateCustomerCustomAttributeDefinitionResponse updateCustomerCustomAttributeDefinition(String key,
                                                                                        UpdateCustomerCustomAttributeDefinitionRequest body)
                                                                                 throws ApiException,
                                                                                        IOException

Updates a customer-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. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

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 UpdateCustomerCustomAttributeDefinitionResponse 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.

updateCustomerCustomAttributeDefinitionAsync

CompletableFuture<UpdateCustomerCustomAttributeDefinitionResponse> updateCustomerCustomAttributeDefinitionAsync(String key,
                                                                                                                UpdateCustomerCustomAttributeDefinitionRequest body)

Updates a customer-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. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

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 UpdateCustomerCustomAttributeDefinitionResponse response from the API call

bulkUpsertCustomerCustomAttributes

BulkUpsertCustomerCustomAttributesResponse bulkUpsertCustomerCustomAttributes(BulkUpsertCustomerCustomAttributesRequest body)
                                                                       throws ApiException,
                                                                              IOException

Creates or updates [custom attributes]($m/CustomAttribute) for customer profiles as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/CreateCustomerCustomAttributeDefinition) endpoint. This `BulkUpsertCustomerCustomAttributes` 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 customer 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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 BulkUpsertCustomerCustomAttributesResponse 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.

bulkUpsertCustomerCustomAttributesAsync

CompletableFuture<BulkUpsertCustomerCustomAttributesResponse> bulkUpsertCustomerCustomAttributesAsync(BulkUpsertCustomerCustomAttributesRequest body)

Creates or updates [custom attributes]($m/CustomAttribute) for customer profiles as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/CreateCustomerCustomAttributeDefinition) endpoint. This `BulkUpsertCustomerCustomAttributes` 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 customer 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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `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 BulkUpsertCustomerCustomAttributesResponse response from the API call

listCustomerCustomAttributes

ListCustomerCustomAttributesResponse listCustomerCustomAttributes(String customerId,
                                                                  Integer limit,
                                                                  String cursor,
                                                                  Boolean withDefinitions)
                                                           throws ApiException,
                                                                  IOException

Lists the [custom attributes]($m/CustomAttribute) associated with a customer profile. 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:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 ListCustomerCustomAttributesResponse 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.

listCustomerCustomAttributesAsync

CompletableFuture<ListCustomerCustomAttributesResponse> listCustomerCustomAttributesAsync(String customerId,
                                                                                          Integer limit,
                                                                                          String cursor,
                                                                                          Boolean withDefinitions)

Lists the [custom attributes]($m/CustomAttribute) associated with a customer profile. 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:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 ListCustomerCustomAttributesResponse response from the API call

deleteCustomerCustomAttribute

DeleteCustomerCustomAttributeResponse deleteCustomerCustomAttribute(String customerId,
                                                                    String key)
                                                             throws ApiException,
                                                                    IOException

Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 DeleteCustomerCustomAttributeResponse 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.

deleteCustomerCustomAttributeAsync

CompletableFuture<DeleteCustomerCustomAttributeResponse> deleteCustomerCustomAttributeAsync(String customerId,
                                                                                            String key)

Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 DeleteCustomerCustomAttributeResponse response from the API call

retrieveCustomerCustomAttribute

RetrieveCustomerCustomAttributeResponse retrieveCustomerCustomAttribute(String customerId,
                                                                        String key,
                                                                        Boolean withDefinition,
                                                                        Integer version)
                                                                 throws ApiException,
                                                                        IOException

Retrieves a [custom attribute]($m/CustomAttribute) associated with a customer profile. 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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 RetrieveCustomerCustomAttributeResponse 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.

retrieveCustomerCustomAttributeAsync

CompletableFuture<RetrieveCustomerCustomAttributeResponse> retrieveCustomerCustomAttributeAsync(String customerId,
                                                                                                String key,
                                                                                                Boolean withDefinition,
                                                                                                Integer version)

Retrieves a [custom attribute]($m/CustomAttribute) associated with a customer profile. 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`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 RetrieveCustomerCustomAttributeResponse response from the API call

upsertCustomerCustomAttribute

UpsertCustomerCustomAttributeResponse upsertCustomerCustomAttribute(String customerId,
                                                                    String key,
                                                                    UpsertCustomerCustomAttributeRequest body)
                                                             throws ApiException,
                                                                    IOException

Creates or updates a [custom attribute]($m/CustomAttribute) for a customer profile. Use this endpoint to set the value of a custom attribute for a specified customer profile. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/CreateCustomerCustomAttributeDefinition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 UpsertCustomerCustomAttributeResponse 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.

upsertCustomerCustomAttributeAsync

CompletableFuture<UpsertCustomerCustomAttributeResponse> upsertCustomerCustomAttributeAsync(String customerId,
                                                                                            String key,
                                                                                            UpsertCustomerCustomAttributeRequest body)

Creates or updates a [custom attribute]($m/CustomAttribute) for a customer profile. Use this endpoint to set the value of a custom attribute for a specified customer profile. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/CreateCustomerCustomAttributeDefinition) endpoint. To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Parameters:

customerId - Required parameter: The ID of the target [customer profile](entity:Customer).

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 UpsertCustomerCustomAttributeResponse response from the API call