bookings library

The v4 bookings family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/bookings.dart' as bookings;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

Booking: The booking body.
BookingAccount: A Booking's account.
BookingBillingAddress: A Booking's billing_address.
BookingBillingPreferences: A Booking's billing_preferences.
BookingBillingPreferencesDetail: A BookingBillingPreferencesView's billing_preferences.
BookingBillingPreferencesDetailProformaProperties: A BookingBillingPreferencesDetail's proforma_properties.
BookingBillingPreferencesProformaProperties: A BookingBillingPreferences's proforma_properties.
BookingBillingPreferencesView: What getBookingBillingPreferences answers, under order.
BookingById: The booking by id body.
BookingByIdAccount: A BookingById's account.
BookingByIdBillingAddress: A BookingById's billing_address.
BookingByIdBillingPreferences: A BookingById's billing_preferences.
BookingByIdBillingPreferencesProformaProperties: A BookingByIdBillingPreferences's proforma_properties.
BookingByIdCommunicationPreference: One entry of a BookingById's communication_preferences.
BookingByIdCurrency: A BookingById's currency.
BookingByIdCustomAttribute: One entry of a BookingById's custom_attributes.
BookingByIdCustomForm: A BookingById's custom_form.
BookingByIdKpis: A BookingById's kpis.
BookingByIdLine: One entry of a BookingById's lines.
BookingByIdLineItem: A BookingByIdLine's item.
BookingByIdLineItemAccountingCode: A BookingByIdLine's item_accounting_code.
BookingByIdLineItemPriceSnapshot: A BookingByIdLine's item_price_snapshot.
BookingByIdLineItemPriceSnapshotPricingRule: A BookingByIdLineItemPriceSnapshot's pricing_rule.
BookingByIdLineItemPriceTax: A BookingByIdLine's item_price_tax.
BookingByIdLineItemProperties: A BookingByIdLine's item_properties.
BookingByIdLineItemSaleTaxConfiguration: A BookingByIdLine's item_sale_tax_configuration.
BookingByIdLineItemSaleTaxConfigurationTaxCode: A BookingByIdLineItemSaleTaxConfiguration's tax_code.
BookingByIdLinePreOrderStockDetails: A BookingByIdLine's pre_order_stock_details.
BookingByIdManager: A BookingById's manager.
BookingByIdTimeZone: A BookingById's time_zone.
BookingCommunicationPreference: One entry of a Booking's communication_preferences.
BookingContractProperties: A Booking's contract_properties.
BookingCurrency: A Booking's currency.
BookingCustomForm: A Booking's custom_form.
BookingCustomObject: One custom object with the booking's instances of it, under custom_object.
BookingCustomObjectEntry: One entry of a BookingCustomObjectList's data.
BookingCustomObjectList: One page of the custom objects orders use, under data.
BookingDiscountProfile: A Booking's discount_profile.
BookingInvoice: One entry of a BookingInvoiceList's data.
BookingInvoiceAccount: A BookingInvoice's account.
BookingInvoiceCreatedBy: A BookingInvoice's created_by.
BookingInvoiceCurrency: A BookingInvoice's currency.
BookingInvoiceCustomForm: A BookingInvoice's custom_form.
BookingInvoiceList: One page of a booking's invoices, under data.
BookingInvoiceOrder: A BookingInvoice's order.
BookingItemFulfillment: What getBookingItemFulfillment answers, under item_fulfillment.
BookingItemFulfillmentAccount: A BookingItemFulfillment's account.
BookingItemFulfillmentCreatedBy: A BookingItemFulfillment's created_by.
BookingItemFulfillmentFulfillment: One entry of a BookingItemFulfillment's fulfillments.
BookingItemFulfillmentFulfillmentItem: A BookingItemFulfillmentFulfillment's item.
BookingItemFulfillmentInvoice: A BookingItemFulfillment's invoice.
BookingItemFulfillmentLastUpdatedBy: A BookingItemFulfillment's last_updated_by.
BookingKpis: What getBookingKpis answers, under order_kpis.
BookingLine: What getBookingLine answers, under order_line.
BookingLineItem: A BookingLine's item.
BookingLineItemAccountingCode: A BookingLine's item_accounting_code.
BookingLineItemPriceSnapshot: A BookingLine's item_price_snapshot.
BookingLineItemPriceSnapshotPricingRule: A BookingLineItemPriceSnapshot's pricing_rule.
BookingLineItemPriceTax: A BookingLine's item_price_tax.
BookingLineItemProperties: A BookingLine's item_properties.
BookingLineItemSaleTaxConfiguration: A BookingLine's item_sale_tax_configuration.
BookingLineItemSaleTaxConfigurationTaxCode: A BookingLineItemSaleTaxConfiguration's tax_code.
BookingLinePreOrderStockDetails: A BookingLine's pre_order_stock_details.
BookingList: A page of Booking records.
BookingManager: A Booking's manager.
BookingNote: One entry of a BookingNoteList's data.
BookingNoteAttachment: One entry of a BookingNote's attachments.
BookingNoteCreatedBy: A BookingNote's created_by.
BookingNoteLastUpdatedBy: A BookingNote's last_updated_by.
BookingNoteList: One page of every order's notes, under data.
BookingNoteWatcher: One entry of a BookingNote's watchers.
BookingPayment: One entry of a BookingPaymentList's data.
BookingPaymentAccount: A BookingPayment's account.
BookingPaymentCreatedBy: A BookingPayment's created_by.
BookingPaymentInvoice: One entry of a BookingPayment's invoices.
BookingPaymentList: One page of a booking's payments, under data.
BookingPaymentMethod: What getBookingPaymentMethod answers, under order.
BookingPaymentMethodPaymentMethod: A BookingPaymentMethod's payment_method.
BookingPaymentMethodPaymentMethodProcessor: A BookingPaymentMethodPaymentMethod's processor.
BookingPaymentMethods: What getBookingPaymentMethods answers, under order.
BookingPaymentMethodsPaymentMethod: One entry of a BookingPaymentMethods's payment_methods.
BookingPaymentMethodsPaymentMethodProcessor: A BookingPaymentMethodsPaymentMethod's processor.
BookingPaymentPaymentApplied: One entry of a BookingPayment's payment_applied.
BookingPaymentView: What getBookingPayment answers, under payment.
BookingPaymentViewAccount: A BookingPaymentView's account.
BookingPaymentViewCreatedBy: A BookingPaymentView's created_by.
BookingPaymentViewInvoice: One entry of a BookingPaymentView's invoices.
BookingPaymentViewPaymentApplied: One entry of a BookingPaymentView's payment_applied.
BookingPdf: What getBookingPdf answers, under order.
BookingPdfPdf: A BookingPdf's pdf.
BookingQuotePartialInvoices: What getBookingQuotePartialInvoices answers, under order.
BookingReferralAccount: A Booking's referral_account.
BookingSalesRep: A Booking's sales_rep.
BookingShippingAddress: A Booking's shipping_address.
BookingShippingProfile: A Booking's shipping_profile.
BookingsResource: The bookings endpoints with client already applied.
BookingsUrls
BookingTimeZone: A Booking's time_zone.

Functions

changeBooking(ExsitedClient client, Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/booking/{booking_id}/change
createBooking(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/booking
deleteBooking(ExsitedClient client, Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/booking/{booking_id}
getBooking(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingList>>: GET /api/{api_version}/booking
getBookingBillingPreferences(ExsitedClient client, Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingBillingPreferencesView>>: GET /api/{api_version}/booking/{booking_id}/billing_preferences
getBookingById(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>: GET /api/{api_version}/booking/{booking_id}
getBookingCustomObject(ExsitedClient client, Object bookingId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingCustomObject>>: GET /api/{api_version}/booking/{booking_id}/custom_objects/{custom_object_id}
getBookingCustomObjectInstance(ExsitedClient client, 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(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingCustomObjectList>>: GET /api/{api_version}/booking/{booking_id}/custom_objects
getBookingCustomObjectsInstance(ExsitedClient client, 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(ExsitedClient client, 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(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingCustomObjectList>>: GET /api/{api_version}/booking/{booking_id}/custom_objects_instances
getBookingInformation(ExsitedClient client, Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>: GET /api/{api_version}/booking/{booking_id}/information
getBookingInvoices(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingInvoiceList>>: GET /api/{api_version}/booking/{booking_id}/invoices
getBookingItemFulfillment(ExsitedClient client, Object bookingId, Object fulfillmentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingItemFulfillment>>: GET /api/{api_version}/booking/{booking_id}/item_fulfillments/{fulfillment_id}
getBookingItemFulfillments(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/booking/{booking_id}/item_fulfillments
getBookingKpis(ExsitedClient client, Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingKpis>>: GET /api/{api_version}/booking/{booking_id}/kpis
getBookingLine(ExsitedClient client, Object bookingId, Object lineUuid, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingLine>>: GET /api/{api_version}/booking/{booking_id}/lines/{line_uuid}
getBookingLines(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>: GET /api/{api_version}/booking/{booking_id}/lines
getBookingNotes(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingNoteList>>: GET /api/{api_version}/booking/notes
getBookingPayment(ExsitedClient client, Object bookingId, Object paymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentView>>: GET /api/{api_version}/booking/{booking_id}/payments/{payment_id}
getBookingPaymentMethod(ExsitedClient client, Object bookingId, Object paymentMethodRef, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentMethod>>: GET /api/{api_version}/booking/{booking_id}/payment_methods/{payment_method_ref}
getBookingPaymentMethods(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentMethods>>: GET /api/{api_version}/booking/{booking_id}/payment_methods
getBookingPayments(ExsitedClient client, Object bookingId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPaymentList>>: GET /api/{api_version}/booking/{booking_id}/payments
getBookingPdf(ExsitedClient client, Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingPdf>>: GET /api/{api_version}/booking/{booking_id}/pdf
getBookingQuotePartialInvoices(ExsitedClient client, Object bookingId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingQuotePartialInvoices>>: GET /api/{api_version}/booking/{booking_id}/quote_partial_invoices
getBookingShippingPdf(ExsitedClient client, Object bookingId, Object shippingLineId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/booking/{booking_id}/shipping_pdf/{shipping_line_id}
previewBooking(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/booking/preview
previewBookingChange(ExsitedClient client, Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/booking/{booking_id}/change/preview
updateBookingBillingPreferences(ExsitedClient client, Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>: PATCH /api/{api_version}/booking/{booking_id}/billing_preferences
updateBookingInformation(ExsitedClient client, Object bookingId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>: PATCH /api/{api_version}/booking/{booking_id}/information
updateBookingLine(ExsitedClient client, Object bookingId, Object lineUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<BookingById>>: PATCH /api/{api_version}/booking/{booking_id}/lines/{line_uuid}
updateBookingLineBillingPreferences(ExsitedClient client, 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

bookings library

Classes

Functions

exsited package

bookings library