BookingsService class

URL: https://developer.squareup.com/reference/square/bookings-api Create and manage bookings for Square sellers.

The Bookings API allows you to create, retrieve, update, and delete appointments online. When used with other Square APIs (such as the Locations API, Team API, Catalog API, and Customers API), the Bookings API lets you create online-booking applications for users to book services provided by Square sellers.

Constructors

BookingsService({required String baseUrl, required AuthenticationService authenticationService})

Properties

authenticationService AuthenticationService
final
baseUrl String
final
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelBooking({required String bookingId, required CancelBookingRequest request, String? authToken}) Future<Booking>
Cancels an existing booking.
createBooking({required UpsertBookingRequest request, String? authToken}) Future<Booking>
Creates a booking.
listBookings({required ListBookingsRequest request, String? authToken}) Future<BookingsResponse>
Retrieve a collection of bookings.
listTeamMemberBookingProfile({required ReadTeamMemberBookingProfileRequest request, String? authToken}) Future<TeamMemberBookingProfileResponse>
Lists booking profiles for team members.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readBooking({required String bookingId, String? authToken}) Future<Booking>
Retrieves a booking.
readBusinessBooking({String? authToken}) Future<BusinessBookingProfile>
Retrieves a seller's booking profile.
readTeamMemberBookingProfile({required String teamMemberId, String? authToken}) Future<TeamMemberBookingProfile>
Retrieves a team member's booking profile.
searchBookingAvailability({required SearchAvailabilityQuery query, String? authToken}) Future<List<Availability>>
Searches for availabilities for booking.
toString() String
A string representation of this object.
inherited
updateBooking({required String bookingId, required UpsertBookingRequest request, String? authToken}) Future<Booking>
Updates a booking.

Operators

operator ==(Object other) bool
The equality operator.
inherited