com.squareup.square.api

Interface BookingCustomAttributesApi

All Known Implementing Classes:

DefaultBookingCustomAttributesApi

public interface BookingCustomAttributesApi

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
BulkDeleteBookingCustomAttributesResponse	bulkDeleteBookingCustomAttributes(BulkDeleteBookingCustomAttributesRequest body) Bulk deletes bookings custom attributes.
CompletableFuture<BulkDeleteBookingCustomAttributesResponse>	bulkDeleteBookingCustomAttributesAsync(BulkDeleteBookingCustomAttributesRequest body) Bulk deletes bookings custom attributes.
BulkUpsertBookingCustomAttributesResponse	bulkUpsertBookingCustomAttributes(BulkUpsertBookingCustomAttributesRequest body) Bulk upserts bookings custom attributes.
CompletableFuture<BulkUpsertBookingCustomAttributesResponse>	bulkUpsertBookingCustomAttributesAsync(BulkUpsertBookingCustomAttributesRequest body) Bulk upserts bookings custom attributes.
CreateBookingCustomAttributeDefinitionResponse	createBookingCustomAttributeDefinition(CreateBookingCustomAttributeDefinitionRequest body) Creates a bookings custom attribute definition.
CompletableFuture<CreateBookingCustomAttributeDefinitionResponse>	createBookingCustomAttributeDefinitionAsync(CreateBookingCustomAttributeDefinitionRequest body) Creates a bookings custom attribute definition.
DeleteBookingCustomAttributeResponse	deleteBookingCustomAttribute(String bookingId, String key) Deletes a bookings custom attribute.
CompletableFuture<DeleteBookingCustomAttributeResponse>	deleteBookingCustomAttributeAsync(String bookingId, String key) Deletes a bookings custom attribute.
DeleteBookingCustomAttributeDefinitionResponse	deleteBookingCustomAttributeDefinition(String key) Deletes a bookings custom attribute definition.
CompletableFuture<DeleteBookingCustomAttributeDefinitionResponse>	deleteBookingCustomAttributeDefinitionAsync(String key) Deletes a bookings custom attribute definition.
ListBookingCustomAttributeDefinitionsResponse	listBookingCustomAttributeDefinitions(Integer limit, String cursor) Get all bookings custom attribute definitions.
CompletableFuture<ListBookingCustomAttributeDefinitionsResponse>	listBookingCustomAttributeDefinitionsAsync(Integer limit, String cursor) Get all bookings custom attribute definitions.
ListBookingCustomAttributesResponse	listBookingCustomAttributes(String bookingId, Integer limit, String cursor, Boolean withDefinitions) Lists a booking's custom attributes.
CompletableFuture<ListBookingCustomAttributesResponse>	listBookingCustomAttributesAsync(String bookingId, Integer limit, String cursor, Boolean withDefinitions) Lists a booking's custom attributes.
RetrieveBookingCustomAttributeResponse	retrieveBookingCustomAttribute(String bookingId, String key, Boolean withDefinition, Integer version) Retrieves a bookings custom attribute.
CompletableFuture<RetrieveBookingCustomAttributeResponse>	retrieveBookingCustomAttributeAsync(String bookingId, String key, Boolean withDefinition, Integer version) Retrieves a bookings custom attribute.
RetrieveBookingCustomAttributeDefinitionResponse	retrieveBookingCustomAttributeDefinition(String key, Integer version) Retrieves a bookings custom attribute definition.
CompletableFuture<RetrieveBookingCustomAttributeDefinitionResponse>	retrieveBookingCustomAttributeDefinitionAsync(String key, Integer version) Retrieves a bookings custom attribute definition.
UpdateBookingCustomAttributeDefinitionResponse	updateBookingCustomAttributeDefinition(String key, UpdateBookingCustomAttributeDefinitionRequest body) Updates a bookings custom attribute definition.
CompletableFuture<UpdateBookingCustomAttributeDefinitionResponse>	updateBookingCustomAttributeDefinitionAsync(String key, UpdateBookingCustomAttributeDefinitionRequest body) Updates a bookings custom attribute definition.
UpsertBookingCustomAttributeResponse	upsertBookingCustomAttribute(String bookingId, String key, UpsertBookingCustomAttributeRequest body) Upserts a bookings custom attribute.
CompletableFuture<UpsertBookingCustomAttributeResponse>	upsertBookingCustomAttributeAsync(String bookingId, String key, UpsertBookingCustomAttributeRequest body) Upserts a bookings custom attribute.

Method Detail

listBookingCustomAttributeDefinitions

ListBookingCustomAttributeDefinitionsResponse listBookingCustomAttributeDefinitions(Integer limit,
                                                                                    String cursor)
                                                                             throws ApiException,
                                                                                    IOException

Get all bookings custom attribute definitions. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

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

listBookingCustomAttributeDefinitionsAsync

CompletableFuture<ListBookingCustomAttributeDefinitionsResponse> listBookingCustomAttributeDefinitionsAsync(Integer limit,
                                                                                                            String cursor)

Get all bookings custom attribute definitions. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

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

createBookingCustomAttributeDefinition

CreateBookingCustomAttributeDefinitionResponse createBookingCustomAttributeDefinition(CreateBookingCustomAttributeDefinitionRequest body)
                                                                               throws ApiException,
                                                                                      IOException

Creates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

createBookingCustomAttributeDefinitionAsync

CompletableFuture<CreateBookingCustomAttributeDefinitionResponse> createBookingCustomAttributeDefinitionAsync(CreateBookingCustomAttributeDefinitionRequest body)

Creates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

deleteBookingCustomAttributeDefinition

DeleteBookingCustomAttributeDefinitionResponse deleteBookingCustomAttributeDefinition(String key)
                                                                               throws ApiException,
                                                                                      IOException

Deletes a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

Parameters:

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

Returns:

Returns the DeleteBookingCustomAttributeDefinitionResponse 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.

deleteBookingCustomAttributeDefinitionAsync

CompletableFuture<DeleteBookingCustomAttributeDefinitionResponse> deleteBookingCustomAttributeDefinitionAsync(String key)

Deletes a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

Parameters:

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

Returns:

Returns the DeleteBookingCustomAttributeDefinitionResponse response from the API call

retrieveBookingCustomAttributeDefinition

RetrieveBookingCustomAttributeDefinitionResponse retrieveBookingCustomAttributeDefinition(String key,
                                                                                          Integer version)
                                                                                   throws ApiException,
                                                                                          IOException

Retrieves a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

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

retrieveBookingCustomAttributeDefinitionAsync

CompletableFuture<RetrieveBookingCustomAttributeDefinitionResponse> retrieveBookingCustomAttributeDefinitionAsync(String key,
                                                                                                                  Integer version)

Retrieves a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

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

updateBookingCustomAttributeDefinition

UpdateBookingCustomAttributeDefinitionResponse updateBookingCustomAttributeDefinition(String key,
                                                                                      UpdateBookingCustomAttributeDefinitionRequest body)
                                                                               throws ApiException,
                                                                                      IOException

Updates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

updateBookingCustomAttributeDefinitionAsync

CompletableFuture<UpdateBookingCustomAttributeDefinitionResponse> updateBookingCustomAttributeDefinitionAsync(String key,
                                                                                                              UpdateBookingCustomAttributeDefinitionRequest body)

Updates a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

bulkDeleteBookingCustomAttributes

BulkDeleteBookingCustomAttributesResponse bulkDeleteBookingCustomAttributes(BulkDeleteBookingCustomAttributesRequest body)
                                                                     throws ApiException,
                                                                            IOException

Bulk deletes bookings custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

bulkDeleteBookingCustomAttributesAsync

CompletableFuture<BulkDeleteBookingCustomAttributesResponse> bulkDeleteBookingCustomAttributesAsync(BulkDeleteBookingCustomAttributesRequest body)

Bulk deletes bookings custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

bulkUpsertBookingCustomAttributes

BulkUpsertBookingCustomAttributesResponse bulkUpsertBookingCustomAttributes(BulkUpsertBookingCustomAttributesRequest body)
                                                                     throws ApiException,
                                                                            IOException

Bulk upserts bookings custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

bulkUpsertBookingCustomAttributesAsync

CompletableFuture<BulkUpsertBookingCustomAttributesResponse> bulkUpsertBookingCustomAttributesAsync(BulkUpsertBookingCustomAttributesRequest body)

Bulk upserts bookings custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

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

listBookingCustomAttributes

ListBookingCustomAttributesResponse listBookingCustomAttributes(String bookingId,
                                                                Integer limit,
                                                                String cursor,
                                                                Boolean withDefinitions)
                                                         throws ApiException,
                                                                IOException

Lists a booking's custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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

listBookingCustomAttributesAsync

CompletableFuture<ListBookingCustomAttributesResponse> listBookingCustomAttributesAsync(String bookingId,
                                                                                        Integer limit,
                                                                                        String cursor,
                                                                                        Boolean withDefinitions)

Lists a booking's custom attributes. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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

deleteBookingCustomAttribute

DeleteBookingCustomAttributeResponse deleteBookingCustomAttribute(String bookingId,
                                                                  String key)
                                                           throws ApiException,
                                                                  IOException

Deletes a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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

deleteBookingCustomAttributeAsync

CompletableFuture<DeleteBookingCustomAttributeResponse> deleteBookingCustomAttributeAsync(String bookingId,
                                                                                          String key)

Deletes a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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

retrieveBookingCustomAttribute

RetrieveBookingCustomAttributeResponse retrieveBookingCustomAttribute(String bookingId,
                                                                      String key,
                                                                      Boolean withDefinition,
                                                                      Integer version)
                                                               throws ApiException,
                                                                      IOException

Retrieves a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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

retrieveBookingCustomAttributeAsync

CompletableFuture<RetrieveBookingCustomAttributeResponse> retrieveBookingCustomAttributeAsync(String bookingId,
                                                                                              String key,
                                                                                              Boolean withDefinition,
                                                                                              Integer version)

Retrieves a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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

upsertBookingCustomAttribute

UpsertBookingCustomAttributeResponse upsertBookingCustomAttribute(String bookingId,
                                                                  String key,
                                                                  UpsertBookingCustomAttributeRequest body)
                                                           throws ApiException,
                                                                  IOException

Upserts a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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

upsertBookingCustomAttributeAsync

CompletableFuture<UpsertBookingCustomAttributeResponse> upsertBookingCustomAttributeAsync(String bookingId,
                                                                                          String key,
                                                                                          UpsertBookingCustomAttributeRequest body)

Upserts a bookings custom attribute. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope. For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus* or *Appointments Premium*.

Parameters:

bookingId - Required parameter: The ID of the target [booking](entity:Booking).

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