Skip to content

Latest commit

 

History

History
533 lines (407 loc) · 23.8 KB

location-custom-attributes.md

File metadata and controls

533 lines (407 loc) · 23.8 KB
Raw

Location Custom Attributes

LocationCustomAttributesApi locationCustomAttributesApi = client.getLocationCustomAttributesApi();

Class Name

LocationCustomAttributesApi

Methods

List Location Custom Attribute Definitions

Lists the location-related custom attribute definitions 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.

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

Parameters

Parameter Type Tags Description
visibilityFilter String Query, Optional Filters the CustomAttributeDefinition results by their visibility values.
limit Integer Query, Optional 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.
cursor String Query, Optional 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.

Response Type

ListLocationCustomAttributeDefinitionsResponse

Example Usage

locationCustomAttributesApi.listLocationCustomAttributeDefinitionsAsync(null, null, null).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Create Location Custom Attribute Definition

Creates a location-related custom attribute definition 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 or BulkUpsertLocationCustomAttributes to set the custom attribute for locations.

CompletableFuture<CreateLocationCustomAttributeDefinitionResponse> createLocationCustomAttributeDefinitionAsync(
    final CreateLocationCustomAttributeDefinitionRequest body)

Parameters

Parameter Type Tags Description
body CreateLocationCustomAttributeDefinitionRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

CreateLocationCustomAttributeDefinitionResponse

Example Usage

CreateLocationCustomAttributeDefinitionRequest body = new CreateLocationCustomAttributeDefinitionRequest.Builder(
    new CustomAttributeDefinition.Builder()
        .key("bestseller")
        .name("Bestseller")
        .description("Bestselling item at location")
        .visibility("VISIBILITY_READ_WRITE_VALUES")
        .build()
)
.build();

locationCustomAttributesApi.createLocationCustomAttributeDefinitionAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Delete Location Custom Attribute Definition

Deletes a location-related custom attribute definition 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.

CompletableFuture<DeleteLocationCustomAttributeDefinitionResponse> deleteLocationCustomAttributeDefinitionAsync(
    final String key)

Parameters

Parameter Type Tags Description
key String Template, Required The key of the custom attribute definition to delete.

Response Type

DeleteLocationCustomAttributeDefinitionResponse

Example Usage

String key = "key0";

locationCustomAttributesApi.deleteLocationCustomAttributeDefinitionAsync(key).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Retrieve Location Custom Attribute Definition

Retrieves a location-related custom attribute definition 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.

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

Parameters

Parameter Type Tags Description
key String Template, Required 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 Integer Query, Optional 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.

Response Type

RetrieveLocationCustomAttributeDefinitionResponse

Example Usage

String key = "key0";

locationCustomAttributesApi.retrieveLocationCustomAttributeDefinitionAsync(key, null).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Update Location Custom Attribute Definition

Updates a location-related custom attribute definition 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.

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

Parameters

Parameter Type Tags Description
key String Template, Required The key of the custom attribute definition to update.
body UpdateLocationCustomAttributeDefinitionRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

UpdateLocationCustomAttributeDefinitionResponse

Example Usage

String key = "key0";
UpdateLocationCustomAttributeDefinitionRequest body = new UpdateLocationCustomAttributeDefinitionRequest.Builder(
    new CustomAttributeDefinition.Builder()
        .description("Update the description as desired.")
        .visibility("VISIBILITY_READ_ONLY")
        .build()
)
.build();

locationCustomAttributesApi.updateLocationCustomAttributeDefinitionAsync(key, body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Bulk Delete Location Custom Attributes

Deletes custom attributes for locations as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES.

CompletableFuture<BulkDeleteLocationCustomAttributesResponse> bulkDeleteLocationCustomAttributesAsync(
    final BulkDeleteLocationCustomAttributesRequest body)

Parameters

Parameter Type Tags Description
body BulkDeleteLocationCustomAttributesRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

BulkDeleteLocationCustomAttributesResponse

Example Usage

BulkDeleteLocationCustomAttributesRequest body = new BulkDeleteLocationCustomAttributesRequest.Builder(
    new LinkedHashMap<String, BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest>() {{
        put("id1", new BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest.Builder()
            .key("bestseller")
            .build());
        put("id2", new BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest.Builder()
            .key("bestseller")
            .build());
        put("id3", new BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest.Builder()
            .key("phone-number")
            .build());
    }}
)
.build();

locationCustomAttributesApi.bulkDeleteLocationCustomAttributesAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Bulk Upsert Location Custom Attributes

Creates or updates custom attributes 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 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.

CompletableFuture<BulkUpsertLocationCustomAttributesResponse> bulkUpsertLocationCustomAttributesAsync(
    final BulkUpsertLocationCustomAttributesRequest body)

Parameters

Parameter Type Tags Description
body BulkUpsertLocationCustomAttributesRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

BulkUpsertLocationCustomAttributesResponse

Example Usage

BulkUpsertLocationCustomAttributesRequest body = new BulkUpsertLocationCustomAttributesRequest.Builder(
    new LinkedHashMap<String, BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest>() {{
        put("key0", new BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.Builder(
            "location_id4",
            new CustomAttribute.Builder()
                .build()
        )
        .build());
        put("key1", new BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.Builder(
            "location_id4",
            new CustomAttribute.Builder()
                .build()
        )
        .build());
    }}
)
.build();

locationCustomAttributesApi.bulkUpsertLocationCustomAttributesAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

List Location Custom Attributes

Lists the custom attributes 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.

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

Parameters

Parameter Type Tags Description
locationId String Template, Required The ID of the target location.
visibilityFilter String Query, Optional Filters the CustomAttributeDefinition results by their visibility values.
limit Integer Query, Optional 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.
cursor String Query, Optional 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.
withDefinitions Boolean Query, Optional Indicates whether to return the custom attribute definition 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.
Default: false

Response Type

ListLocationCustomAttributesResponse

Example Usage

String locationId = "location_id4";
Boolean withDefinitions = false;

locationCustomAttributesApi.listLocationCustomAttributesAsync(locationId, null, null, null, withDefinitions).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Delete Location Custom Attribute

Deletes a custom attribute associated with a location. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES.

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

Parameters

Parameter Type Tags Description
locationId String Template, Required The ID of the target location.
key String Template, Required 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.

Response Type

DeleteLocationCustomAttributeResponse

Example Usage

String locationId = "location_id4";
String key = "key0";

locationCustomAttributesApi.deleteLocationCustomAttributeAsync(locationId, key).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Retrieve Location Custom Attribute

Retrieves a custom attribute 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.

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

Parameters

Parameter Type Tags Description
locationId String Template, Required The ID of the target location.
key String Template, Required 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 Boolean Query, Optional Indicates whether to return the custom attribute definition 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.
Default: false
version Integer Query, Optional 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.

Response Type

RetrieveLocationCustomAttributeResponse

Example Usage

String locationId = "location_id4";
String key = "key0";
Boolean withDefinition = false;

locationCustomAttributesApi.retrieveLocationCustomAttributeAsync(locationId, key, withDefinition, null).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Upsert Location Custom Attribute

Creates or updates a custom attribute 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 endpoint. To create or update a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES.

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

Parameters

Parameter Type Tags Description
locationId String Template, Required The ID of the target location.
key String Template, Required 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 UpsertLocationCustomAttributeRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

UpsertLocationCustomAttributeResponse

Example Usage

String locationId = "location_id4";
String key = "key0";
UpsertLocationCustomAttributeRequest body = new UpsertLocationCustomAttributeRequest.Builder(
    new CustomAttribute.Builder()
        .build()
)
.build();

locationCustomAttributesApi.upsertLocationCustomAttributeAsync(locationId, key, body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});