com.squareup.square.api

Class DefaultBookingsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultBookingsApi

All Implemented Interfaces:

BookingsApi

public final class DefaultBookingsApi
extends BaseApi
implements BookingsApi

This class lists all the endpoints of the groups.

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

AUTHENTICATION_KEY, GLOBAL_ERROR_CASES

Constructor Summary

Constructors

Constructor and Description
DefaultBookingsApi(io.apimatic.core.GlobalConfiguration globalConfig) Initializes the controller.

Method Summary

Modifier and Type	Method and Description
BulkRetrieveBookingsResponse	bulkRetrieveBookings(BulkRetrieveBookingsRequest body) Bulk-Retrieves a list of bookings by booking IDs.
CompletableFuture<BulkRetrieveBookingsResponse>	bulkRetrieveBookingsAsync(BulkRetrieveBookingsRequest body) Bulk-Retrieves a list of bookings by booking IDs.
BulkRetrieveTeamMemberBookingProfilesResponse	bulkRetrieveTeamMemberBookingProfiles(BulkRetrieveTeamMemberBookingProfilesRequest body) Retrieves one or more team members' booking profiles.
CompletableFuture<BulkRetrieveTeamMemberBookingProfilesResponse>	bulkRetrieveTeamMemberBookingProfilesAsync(BulkRetrieveTeamMemberBookingProfilesRequest body) Retrieves one or more team members' booking profiles.
CancelBookingResponse	cancelBooking(String bookingId, CancelBookingRequest body) Cancels an existing booking.
CompletableFuture<CancelBookingResponse>	cancelBookingAsync(String bookingId, CancelBookingRequest body) Cancels an existing booking.
CreateBookingResponse	createBooking(CreateBookingRequest body) Creates a booking.
CompletableFuture<CreateBookingResponse>	createBookingAsync(CreateBookingRequest body) Creates a booking.
ListBookingsResponse	listBookings(Integer limit, String cursor, String customerId, String teamMemberId, String locationId, String startAtMin, String startAtMax) Retrieve a collection of bookings.
CompletableFuture<ListBookingsResponse>	listBookingsAsync(Integer limit, String cursor, String customerId, String teamMemberId, String locationId, String startAtMin, String startAtMax) Retrieve a collection of bookings.
ListLocationBookingProfilesResponse	listLocationBookingProfiles(Integer limit, String cursor) Lists location booking profiles of a seller.
CompletableFuture<ListLocationBookingProfilesResponse>	listLocationBookingProfilesAsync(Integer limit, String cursor) Lists location booking profiles of a seller.
ListTeamMemberBookingProfilesResponse	listTeamMemberBookingProfiles(Boolean bookableOnly, Integer limit, String cursor, String locationId) Lists booking profiles for team members.
CompletableFuture<ListTeamMemberBookingProfilesResponse>	listTeamMemberBookingProfilesAsync(Boolean bookableOnly, Integer limit, String cursor, String locationId) Lists booking profiles for team members.
RetrieveBookingResponse	retrieveBooking(String bookingId) Retrieves a booking.
CompletableFuture<RetrieveBookingResponse>	retrieveBookingAsync(String bookingId) Retrieves a booking.
RetrieveBusinessBookingProfileResponse	retrieveBusinessBookingProfile() Retrieves a seller's booking profile.
CompletableFuture<RetrieveBusinessBookingProfileResponse>	retrieveBusinessBookingProfileAsync() Retrieves a seller's booking profile.
RetrieveLocationBookingProfileResponse	retrieveLocationBookingProfile(String locationId) Retrieves a seller's location booking profile.
CompletableFuture<RetrieveLocationBookingProfileResponse>	retrieveLocationBookingProfileAsync(String locationId) Retrieves a seller's location booking profile.
RetrieveTeamMemberBookingProfileResponse	retrieveTeamMemberBookingProfile(String teamMemberId) Retrieves a team member's booking profile.
CompletableFuture<RetrieveTeamMemberBookingProfileResponse>	retrieveTeamMemberBookingProfileAsync(String teamMemberId) Retrieves a team member's booking profile.
SearchAvailabilityResponse	searchAvailability(SearchAvailabilityRequest body) Searches for availabilities for booking.
CompletableFuture<SearchAvailabilityResponse>	searchAvailabilityAsync(SearchAvailabilityRequest body) Searches for availabilities for booking.
UpdateBookingResponse	updateBooking(String bookingId, UpdateBookingRequest body) Updates a booking.
CompletableFuture<UpdateBookingResponse>	updateBookingAsync(String bookingId, UpdateBookingRequest body) Updates a booking.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getGlobalConfiguration, getHttpCallback

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultBookingsApi

public DefaultBookingsApi(io.apimatic.core.GlobalConfiguration globalConfig)

Initializes the controller.

Parameters:

globalConfig - Configurations added in client.

Method Detail

listBookings

public ListBookingsResponse listBookings(Integer limit,
                                         String cursor,
                                         String customerId,
                                         String teamMemberId,
                                         String locationId,
                                         String startAtMin,
                                         String startAtMax)
                                  throws ApiException,
                                         IOException

Retrieve a collection of bookings. 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.

Specified by:

listBookings in interface BookingsApi

Parameters:

limit - Optional parameter: The maximum number of results per page to return in a paged response.

cursor - Optional parameter: The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.

customerId - Optional parameter: The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.

teamMemberId - Optional parameter: The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.

locationId - Optional parameter: The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.

startAtMin - Optional parameter: The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.

startAtMax - Optional parameter: The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used.

Returns:

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

listBookingsAsync

public CompletableFuture<ListBookingsResponse> listBookingsAsync(Integer limit,
                                                                 String cursor,
                                                                 String customerId,
                                                                 String teamMemberId,
                                                                 String locationId,
                                                                 String startAtMin,
                                                                 String startAtMax)

Retrieve a collection of bookings. 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.

Specified by:

listBookingsAsync in interface BookingsApi

Parameters:

limit - Optional parameter: The maximum number of results per page to return in a paged response.

cursor - Optional parameter: The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.

customerId - Optional parameter: The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.

teamMemberId - Optional parameter: The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.

locationId - Optional parameter: The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.

startAtMin - Optional parameter: The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.

startAtMax - Optional parameter: The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used.

Returns:

Returns the ListBookingsResponse response from the API call

createBooking

public CreateBookingResponse createBooking(CreateBookingRequest body)
                                    throws ApiException,
                                           IOException

Creates a booking. The required input must include the following: - `Booking.location_id` - `Booking.start_at` - `Booking.team_member_id` - `Booking.AppointmentSegment.service_variation_id` - `Booking.AppointmentSegment.service_variation_version` 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*.

Specified by:

createBooking in interface BookingsApi

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

createBookingAsync

public CompletableFuture<CreateBookingResponse> createBookingAsync(CreateBookingRequest body)

Creates a booking. The required input must include the following: - `Booking.location_id` - `Booking.start_at` - `Booking.team_member_id` - `Booking.AppointmentSegment.service_variation_id` - `Booking.AppointmentSegment.service_variation_version` 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*.

Specified by:

createBookingAsync in interface BookingsApi

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

searchAvailability

public SearchAvailabilityResponse searchAvailability(SearchAvailabilityRequest body)
                                              throws ApiException,
                                                     IOException

Searches for availabilities for booking. 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.

Specified by:

searchAvailability in interface BookingsApi

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

searchAvailabilityAsync

public CompletableFuture<SearchAvailabilityResponse> searchAvailabilityAsync(SearchAvailabilityRequest body)

Searches for availabilities for booking. 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.

Specified by:

searchAvailabilityAsync in interface BookingsApi

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

bulkRetrieveBookings

public BulkRetrieveBookingsResponse bulkRetrieveBookings(BulkRetrieveBookingsRequest body)
                                                  throws ApiException,
                                                         IOException

Bulk-Retrieves a list of bookings by booking IDs. 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.

Specified by:

bulkRetrieveBookings in interface BookingsApi

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

bulkRetrieveBookingsAsync

public CompletableFuture<BulkRetrieveBookingsResponse> bulkRetrieveBookingsAsync(BulkRetrieveBookingsRequest body)

Bulk-Retrieves a list of bookings by booking IDs. 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.

Specified by:

bulkRetrieveBookingsAsync in interface BookingsApi

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

retrieveBusinessBookingProfile

public RetrieveBusinessBookingProfileResponse retrieveBusinessBookingProfile()
                                                                      throws ApiException,
                                                                             IOException

Retrieves a seller's booking profile.

Specified by:

retrieveBusinessBookingProfile in interface BookingsApi

Returns:

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

retrieveBusinessBookingProfileAsync

public CompletableFuture<RetrieveBusinessBookingProfileResponse> retrieveBusinessBookingProfileAsync()

Retrieves a seller's booking profile.

Specified by:

retrieveBusinessBookingProfileAsync in interface BookingsApi

Returns:

Returns the RetrieveBusinessBookingProfileResponse response from the API call

listLocationBookingProfiles

public ListLocationBookingProfilesResponse listLocationBookingProfiles(Integer limit,
                                                                       String cursor)
                                                                throws ApiException,
                                                                       IOException

Lists location booking profiles of a seller.

Specified by:

listLocationBookingProfiles in interface BookingsApi

Parameters:

limit - Optional parameter: The maximum number of results to return in a paged response.

cursor - Optional parameter: The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.

Returns:

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

listLocationBookingProfilesAsync

public CompletableFuture<ListLocationBookingProfilesResponse> listLocationBookingProfilesAsync(Integer limit,
                                                                                               String cursor)

Lists location booking profiles of a seller.

Specified by:

listLocationBookingProfilesAsync in interface BookingsApi

Parameters:

limit - Optional parameter: The maximum number of results to return in a paged response.

cursor - Optional parameter: The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.

Returns:

Returns the ListLocationBookingProfilesResponse response from the API call

retrieveLocationBookingProfile

public RetrieveLocationBookingProfileResponse retrieveLocationBookingProfile(String locationId)
                                                                      throws ApiException,
                                                                             IOException

Retrieves a seller's location booking profile.

Specified by:

retrieveLocationBookingProfile in interface BookingsApi

Parameters:

locationId - Required parameter: The ID of the location to retrieve the booking profile.

Returns:

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

retrieveLocationBookingProfileAsync

public CompletableFuture<RetrieveLocationBookingProfileResponse> retrieveLocationBookingProfileAsync(String locationId)

Retrieves a seller's location booking profile.

Specified by:

retrieveLocationBookingProfileAsync in interface BookingsApi

Parameters:

locationId - Required parameter: The ID of the location to retrieve the booking profile.

Returns:

Returns the RetrieveLocationBookingProfileResponse response from the API call

listTeamMemberBookingProfiles

public ListTeamMemberBookingProfilesResponse listTeamMemberBookingProfiles(Boolean bookableOnly,
                                                                           Integer limit,
                                                                           String cursor,
                                                                           String locationId)
                                                                    throws ApiException,
                                                                           IOException

Lists booking profiles for team members.

Specified by:

listTeamMemberBookingProfiles in interface BookingsApi

Parameters:

bookableOnly - Optional parameter: Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).

limit - Optional parameter: The maximum number of results to return in a paged response.

cursor - Optional parameter: The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.

locationId - Optional parameter: Indicates whether to include only team members enabled at the given location in the returned result.

Returns:

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

listTeamMemberBookingProfilesAsync

public CompletableFuture<ListTeamMemberBookingProfilesResponse> listTeamMemberBookingProfilesAsync(Boolean bookableOnly,
                                                                                                   Integer limit,
                                                                                                   String cursor,
                                                                                                   String locationId)

Lists booking profiles for team members.

Specified by:

listTeamMemberBookingProfilesAsync in interface BookingsApi

Parameters:

bookableOnly - Optional parameter: Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).

limit - Optional parameter: The maximum number of results to return in a paged response.

cursor - Optional parameter: The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.

locationId - Optional parameter: Indicates whether to include only team members enabled at the given location in the returned result.

Returns:

Returns the ListTeamMemberBookingProfilesResponse response from the API call

bulkRetrieveTeamMemberBookingProfiles

public BulkRetrieveTeamMemberBookingProfilesResponse bulkRetrieveTeamMemberBookingProfiles(BulkRetrieveTeamMemberBookingProfilesRequest body)
                                                                                    throws ApiException,
                                                                                           IOException

Retrieves one or more team members' booking profiles.

Specified by:

bulkRetrieveTeamMemberBookingProfiles in interface BookingsApi

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

bulkRetrieveTeamMemberBookingProfilesAsync

public CompletableFuture<BulkRetrieveTeamMemberBookingProfilesResponse> bulkRetrieveTeamMemberBookingProfilesAsync(BulkRetrieveTeamMemberBookingProfilesRequest body)

Retrieves one or more team members' booking profiles.

Specified by:

bulkRetrieveTeamMemberBookingProfilesAsync in interface BookingsApi

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

retrieveTeamMemberBookingProfile

public RetrieveTeamMemberBookingProfileResponse retrieveTeamMemberBookingProfile(String teamMemberId)
                                                                          throws ApiException,
                                                                                 IOException

Retrieves a team member's booking profile.

Specified by:

retrieveTeamMemberBookingProfile in interface BookingsApi

Parameters:

teamMemberId - Required parameter: The ID of the team member to retrieve.

Returns:

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

retrieveTeamMemberBookingProfileAsync

public CompletableFuture<RetrieveTeamMemberBookingProfileResponse> retrieveTeamMemberBookingProfileAsync(String teamMemberId)

Retrieves a team member's booking profile.

Specified by:

retrieveTeamMemberBookingProfileAsync in interface BookingsApi

Parameters:

teamMemberId - Required parameter: The ID of the team member to retrieve.

Returns:

Returns the RetrieveTeamMemberBookingProfileResponse response from the API call

retrieveBooking

public RetrieveBookingResponse retrieveBooking(String bookingId)
                                        throws ApiException,
                                               IOException

Retrieves a booking. 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.

Specified by:

retrieveBooking in interface BookingsApi

Parameters:

bookingId - Required parameter: The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking.

Returns:

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

retrieveBookingAsync

public CompletableFuture<RetrieveBookingResponse> retrieveBookingAsync(String bookingId)

Retrieves a booking. 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.

Specified by:

retrieveBookingAsync in interface BookingsApi

Parameters:

bookingId - Required parameter: The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking.

Returns:

Returns the RetrieveBookingResponse response from the API call

updateBooking

public UpdateBookingResponse updateBooking(String bookingId,
                                           UpdateBookingRequest body)
                                    throws ApiException,
                                           IOException

Updates a booking. 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*.

Specified by:

updateBooking in interface BookingsApi

Parameters:

bookingId - Required parameter: The ID of the [Booking](entity:Booking) object representing the to-be-updated booking.

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

Returns:

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

updateBookingAsync

public CompletableFuture<UpdateBookingResponse> updateBookingAsync(String bookingId,
                                                                   UpdateBookingRequest body)

Updates a booking. 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*.

Specified by:

updateBookingAsync in interface BookingsApi

Parameters:

bookingId - Required parameter: The ID of the [Booking](entity:Booking) object representing the to-be-updated booking.

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

Returns:

Returns the UpdateBookingResponse response from the API call

cancelBooking

public CancelBookingResponse cancelBooking(String bookingId,
                                           CancelBookingRequest body)
                                    throws ApiException,
                                           IOException

Cancels an existing booking. 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*.

Specified by:

cancelBooking in interface BookingsApi

Parameters:

bookingId - Required parameter: The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking.

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

Returns:

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

cancelBookingAsync

public CompletableFuture<CancelBookingResponse> cancelBookingAsync(String bookingId,
                                                                   CancelBookingRequest body)

Cancels an existing booking. 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*.

Specified by:

cancelBookingAsync in interface BookingsApi

Parameters:

bookingId - Required parameter: The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking.

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

Returns:

Returns the CancelBookingResponse response from the API call