labours library

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

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

Classes

Labour
The labour body.
LabourAvailability
The labour availability body.
LabourAvailabilityLabourProfile
A LabourAvailability's labour_profile.
LabourAvailabilityList
A page of LabourAvailability records.
LabourAvailabilityScheduleList
One entry of a LabourAvailability's schedule_list.
LabourAvailabilitySessionList
One entry of a LabourAvailability's session_list.
LabourAvailabilitySessionListScheduleList
One entry of a LabourAvailabilitySessionList's schedule_list.
LabourCalendar
What getLabourCalendar answers, under labour_calendar: a LabourAvailability record for one labour.
LabourCreatedBy
A Labour's created_by.
LabourCustomForm
A Labour's custom_form.
LabourLabourContact
One entry of a Labour's labour_contacts.
LabourLabourContactFax
A LabourLabourContact's fax.
LabourLabourContactMobile
A LabourLabourContact's mobile.
LabourLabourContactPhone
A LabourLabourContact's phone.
LabourLabourCustomAvailability
One entry of a Labour's labour_custom_availability.
LabourLabourProfile
A Labour's labour_profile.
LabourLastUpdatedBy
A Labour's last_updated_by.
LabourList
A page of Labour records.
LabourOrder
One entry of a LabourOrderList's data.
LabourOrderAccount
A LabourOrder's account.
LabourOrderBillingPreferences
A LabourOrder's billing_preferences.
LabourOrderBillingPreferencesProformaProperties
A LabourOrderBillingPreferences's proforma_properties.
LabourOrderCommunicationPreference
One entry of a LabourOrder's communication_preferences.
LabourOrderCurrency
A LabourOrder's currency.
LabourOrderCustomForm
A LabourOrder's custom_form.
LabourOrderList
One page of what getLabourOrders lists, under data.
LabourOrderTimeZone
A LabourOrder's time_zone.
LabourProfile
The labour profile body.
LabourProfileCreatedBy
A LabourProfile's created_by.
LabourProfileCurrency
A LabourProfile's currency.
LabourProfileLabour
One entry of a LabourProfile's labours.
LabourProfileLastUpdatedBy
A LabourProfile's last_updated_by.
LabourProfileList
A page of LabourProfile records.
LabourProfileSession
One entry of a LabourProfile's sessions.
LabourProfileSessionAvailability
One entry of a LabourProfileSession's availability.
LabourProfileSessionList
One page of a labour profile's sessions, under data, each a LabourProfileViewSession.
LabourProfileSessionPrice
One entry of a LabourProfileSession's prices.
LabourProfileSessionPriceHour
One entry of a LabourProfileSessionPrice's hours.
LabourProfileSessionPricePricingLevel
A LabourProfileSessionPrice's pricing_level.
LabourProfileSessionView
What getLabourProfileSession answers, under labour_profile_session.
LabourProfileSessionWorkingHour
One entry of a LabourProfileSession's working_hours.
LabourProfileTax
A LabourProfile's tax.
LabourProfileView
What getLabourProfile answers, under labour_profile.
LabourProfileViewCreatedBy
A LabourProfileView's created_by.
LabourProfileViewCurrency
A LabourProfileView's currency.
LabourProfileViewLabour
One entry of a LabourProfileView's labours.
LabourProfileViewLastUpdatedBy
A LabourProfileView's last_updated_by.
LabourProfileViewSession
One entry of a LabourProfileView's sessions.
LabourProfileViewSessionAvailability
One entry of a LabourProfileViewSession's availability.
LabourProfileViewSessionPrice
One entry of a LabourProfileViewSession's prices.
LabourProfileViewSessionPriceHour
One entry of a LabourProfileViewSessionPrice's hours.
LabourProfileViewSessionPricePricingLevel
A LabourProfileViewSessionPrice's pricing_level.
LabourProfileViewSessionWorkingHour
One entry of a LabourProfileViewSession's working_hours.
LabourProfileViewTax
A LabourProfileView's tax.
LaboursResource
The labours endpoints with client already applied.
LaboursUrls

Functions

cancelLabour(ExsitedClient client, Object labourId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Labour>>
POST /api/{api_version}/labours/{labour_id}/cancel
createLabour(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Labour>>
POST /api/{api_version}/labours
createLabourProfile(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourProfileView>>
POST /api/{api_version}/labour_profiles
deleteLabour(ExsitedClient client, Object labourUuid, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/labours/{labour_uuid}
deleteLabourProfile(ExsitedClient client, Object labourProfileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/labour_profiles/{labour_profile_id}
getLabour(ExsitedClient client, Object labourUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Labour>>
GET /api/{api_version}/labours/{labour_uuid}
getLabourAvailability(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourAvailabilityList>>
GET /api/{api_version}/labour_availability
getLabourCalendar(ExsitedClient client, Object labourId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourCalendar>>
GET /api/{api_version}/labours/{labour_id}/availability
getLabourOrders(ExsitedClient client, Object labourUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourOrderList>>
GET /api/{api_version}/labours/{labour_uuid}/orders
getLabourProfile(ExsitedClient client, Object labourProfileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourProfileView>>
GET /api/{api_version}/labour_profiles/{labour_profile_id}
getLabourProfiles(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourProfileList>>
GET /api/{api_version}/labour_profiles
getLabourProfileSession(ExsitedClient client, Object labourProfileId, Object sessionId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourProfileSessionView>>
GET /api/{api_version}/labour_profiles/{labour_profile_id}/sessions/{session_id}
getLabourProfileSessions(ExsitedClient client, Object labourProfileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourProfileSessionList>>
GET /api/{api_version}/labour_profiles/{labour_profile_id}/sessions
getLabours(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourList>>
GET /api/{api_version}/labours
getLaboursAvailableForBooking(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<LabourList>>
GET /api/{api_version}/labours/available_for_booking
reactivateLabour(ExsitedClient client, Object labourId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Labour>>
POST /api/{api_version}/labours/{labour_id}/reactivate
updateLabour(ExsitedClient client, Object labourUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Labour>>
PATCH /api/{api_version}/labours/{labour_uuid}
updateLabourAvailability(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
PATCH /api/{api_version}/labour_availability
updateLabourProfile(ExsitedClient client, Object labourProfileId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
PATCH /api/{api_version}/labour_profiles/{labour_profile_id}