BookingsResource class

The bookings endpoints with client already applied.

Constructors

BookingsResource(ExsitedClient client)

Bind the resource to a client; normally reached via client.bookings.

const

Properties

client → ExsitedClient

The client every call below is made through.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

changeBooking(Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/booking/{booking_id}/change

createBooking(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/booking

deleteBooking(Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/booking/{booking_id}

getBooking({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingList>>

GET /api/{api_version}/booking

getBookingBillingPreferences(Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingBillingPreferencesView>>

GET /api/{api_version}/booking/{booking_id}/billing_preferences

getBookingById(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>

GET /api/{api_version}/booking/{booking_id}

getBookingCustomObject(Object bookingId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingCustomObject>>

GET /api/{api_version}/booking/{booking_id}/custom_objects/{custom_object_id}

getBookingCustomObjectInstance(Object bookingId, Object customObjectId, Object instanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/booking/{booking_id}/custom_objects/{custom_object_id}/instances/{instance_id}

getBookingCustomObjects(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingCustomObjectList>>

GET /api/{api_version}/booking/{booking_id}/custom_objects

getBookingCustomObjectsInstance(Object bookingId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingCustomObject>>

GET /api/{api_version}/booking/{booking_id}/custom_objects_instances/{custom_object_id}

getBookingCustomObjectsInstanceInstance(Object bookingId, Object customObjectId, Object instanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/booking/{booking_id}/custom_objects_instances/{custom_object_id}/instances/{instance_id}

getBookingCustomObjectsInstances(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingCustomObjectList>>

GET /api/{api_version}/booking/{booking_id}/custom_objects_instances

getBookingInformation(Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>

GET /api/{api_version}/booking/{booking_id}/information

getBookingInvoices(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingInvoiceList>>

GET /api/{api_version}/booking/{booking_id}/invoices

getBookingItemFulfillment(Object bookingId, Object fulfillmentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingItemFulfillment>>

GET /api/{api_version}/booking/{booking_id}/item_fulfillments/{fulfillment_id}

getBookingItemFulfillments(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/booking/{booking_id}/item_fulfillments

getBookingKpis(Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingKpis>>

GET /api/{api_version}/booking/{booking_id}/kpis

getBookingLine(Object bookingId, Object lineUuid, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingLine>>

GET /api/{api_version}/booking/{booking_id}/lines/{line_uuid}

getBookingLines(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>

GET /api/{api_version}/booking/{booking_id}/lines

getBookingNotes({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingNoteList>>

GET /api/{api_version}/booking/notes

getBookingPayment(Object bookingId, Object paymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentView>>

GET /api/{api_version}/booking/{booking_id}/payments/{payment_id}

getBookingPaymentMethod(Object bookingId, Object paymentMethodRef, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentMethod>>

GET /api/{api_version}/booking/{booking_id}/payment_methods/{payment_method_ref}

getBookingPaymentMethods(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentMethods>>

GET /api/{api_version}/booking/{booking_id}/payment_methods

getBookingPayments(Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentList>>

GET /api/{api_version}/booking/{booking_id}/payments

getBookingPdf(Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPdf>>

GET /api/{api_version}/booking/{booking_id}/pdf

getBookingQuotePartialInvoices(Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingQuotePartialInvoices>>

GET /api/{api_version}/booking/{booking_id}/quote_partial_invoices

getBookingShippingPdf(Object bookingId, Object shippingLineId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/booking/{booking_id}/shipping_pdf/{shipping_line_id}

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

previewBooking(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/booking/preview

previewBookingChange(Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/booking/{booking_id}/change/preview

toString() → String

A string representation of this object.

inherited

updateBookingBillingPreferences(Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>

PATCH /api/{api_version}/booking/{booking_id}/billing_preferences

updateBookingInformation(Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>

PATCH /api/{api_version}/booking/{booking_id}/information

updateBookingLine(Object bookingId, Object lineUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>

PATCH /api/{api_version}/booking/{booking_id}/lines/{line_uuid}

updateBookingLineBillingPreferences(Object bookingId, Object lineUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>

PATCH /api/{api_version}/booking/{booking_id}/lines/{line_uuid}/billing_preferences

Operators

operator ==(Object other) → bool

The equality operator.

inherited