@transreport/pauk-staff-api

Interfaces

Type Aliases

ApiClientConfig
BulkAssignRequests200
BulkAssignRequests200Assignee
BulkAssignRequests200Operation
BulkAssignRequestsBody
BulkAssignRequestsBodyActionOrigin
BulkAssignRequestsBodyValidationReminder
BulkAssignRequestsMutationBody
BulkAssignRequestsMutationError
BulkAssignRequestsMutationResult
BulkAssignRequestsMutationVariables
BulkSimilarJourneysResponse
BulkSimilarJourneysResponseItem
BulkSimilarJourneysResponseItemJourneysItem
BulkSimilarJourneysResponseItemJourneysItemDirection
BulkUnassignRequests200
BulkUnassignRequests200Operation
BulkUnassignRequestsBody
BulkUnassignRequestsBodyActionOrigin
BulkUnassignRequestsMutationBody
BulkUnassignRequestsMutationError
BulkUnassignRequestsMutationResult
BulkUnassignRequestsMutationVariables
CancelRarsBooking401
CancelRarsBooking404
CancelRarsBooking409
CancelRarsBookingMutationError
CancelRarsBookingMutationResult
CancelRarsBookingMutationVariables
CancelRarsBookingParams
CreateDashboardSearchPreset422
CreateDashboardSearchPresetBody
CreateDashboardSearchPresetMutationBody
CreateDashboardSearchPresetMutationError
CreateDashboardSearchPresetMutationResult
CreateDashboardSearchPresetMutationVariables
DeleteDashboardSearchPreset404
DeleteDashboardSearchPresetMutationError
DeleteDashboardSearchPresetMutationResult
DeleteDashboardSearchPresetMutationVariables
GetAssignmentConflictParams
GetAssignmentConflictQueryError
GetAssignmentConflictQueryResult
GetAvailableUsersToAssignParams
GetAvailableUsersToAssignQueryError
GetAvailableUsersToAssignQueryResult
GetBulkAssignmentConflictBody
GetBulkAssignmentConflictMutationBody
GetBulkAssignmentConflictMutationError
GetBulkAssignmentConflictMutationResult
GetBulkAssignmentConflictMutationVariables
GetBulkSimilarJourneys404
GetBulkSimilarJourneysBody
GetBulkSimilarJourneysMutationBody
GetBulkSimilarJourneysMutationError
GetBulkSimilarJourneysMutationResult
GetBulkSimilarJourneysMutationVariables
GetDashboardSearchPreset404
GetDashboardSearchPresetQueryError
GetDashboardSearchPresetQueryResult
GetDashboardSearchPresetsQueryError
GetDashboardSearchPresetsQueryResult
GetGroupedAvailableUsersToAssignParams
GetGroupedAvailableUsersToAssignQueryError
GetGroupedAvailableUsersToAssignQueryResult
GetJourneyCallingPoints200Item
GetJourneyCallingPoints200ItemCallingPointsItem
GetJourneyCallingPoints200ItemCallingPointsItemStation
GetJourneyCallingPointsParams
GetJourneyCallingPointsQueryError
GetJourneyCallingPointsQueryResult
GetJourneyLegsParams
GetJourneyLegsQueryError
GetJourneyLegsQueryResult
GetRarsAvailabilityV1201
GetRarsAvailabilityV1401
GetRarsAvailabilityV1404
GetRarsAvailabilityV1422
GetRarsAvailabilityV1500
GetRarsAvailabilityV1Body
GetRarsAvailabilityV1MutationBody
GetRarsAvailabilityV1MutationError
GetRarsAvailabilityV1MutationResult
GetRarsAvailabilityV1MutationVariables
GetRarsAvailabilityV2201
GetRarsAvailabilityV2401
GetRarsAvailabilityV2404
GetRarsAvailabilityV2422
GetRarsAvailabilityV2500
GetRarsAvailabilityV2Body
GetRarsAvailabilityV2MutationBody
GetRarsAvailabilityV2MutationError
GetRarsAvailabilityV2MutationResult
GetRarsAvailabilityV2MutationVariables
GetSimilarJourneys404
GetSimilarJourneysParams
GetSimilarJourneysQueryError
GetSimilarJourneysQueryResult
GetUnconfirmedBookingsParams
GetUnconfirmedBookingsQueryError
GetUnconfirmedBookingsQueryResult
HeaderResolver
JourneyLegIndexItemArrivalAssistancesItem
JourneyLegIndexItemAvailableEmailsToSendItem
JourneyLegIndexItemCustomer
JourneyLegIndexItemDepartureAssistancesItem
JourneyLegIndexItemJourney
JourneyLegIndexItemOnBoardAssistancesItem
JourneyLegIndexItemOperator
ListRarsCoaches200
ListRarsCoaches401
ListRarsCoaches404
ListRarsCoaches422
ListRarsCoaches500
ListRarsCoachesParams
ListRarsCoachesQueryError
ListRarsCoachesQueryResult
RarsAvailabilityV1BundlesItem
RarsAvailabilityV1BundlesItemProductsItem
RarsAvailabilityV2BundlesItem
RarsCoachesCoachesItem
RarsCoachesCoachesItemSeatsItem
RarsCoachesSeatPropertiesItem
StaffUserElectronicHandoverNotificationStationsItem
StaffUserElectronicHandoverNotificationStationsItemStation
StaffUserRole
StaffUserRoleOrganisation
StaffUserRoleOrganisationCategory
StaffUserStatus
UnconfirmedBookingCustomer
UnconfirmedBookingJourneysItem
UnconfirmedBookingJourneysItemLegsItem
UnconfirmedBookingJourneysItemLegsItemArrivalAssistancesItem
UnconfirmedBookingJourneysItemLegsItemDepartureAssistancesItem
UnconfirmedBookingJourneysItemLegsItemOnBoardAssistancesItem
ValidationErrorErrorsItem

Variables

apiClientMutator
bulkAssignRequests: Assign or reassign multiple assistance requests
BulkAssignRequests200Operation
BulkAssignRequestsBodyActionOrigin
BulkSimilarJourneysResponseItemJourneysItemDirection
bulkUnassignRequests: Unassign multiple assistance requests
BulkUnassignRequests200Operation
BulkUnassignRequestsBodyActionOrigin
cancelRarsBooking: Cancel a RARS booking
configureApiClient
createDashboardSearchPreset: Create a dashboard search preset
deleteDashboardSearchPreset: Delete a dashboard search preset
getAssignmentConflict: Check a staff member for a scheduling conflict
getAvailableUsersToAssign: List users available to assign
getBulkAssignmentConflict: Check a staff member for a scheduling conflict across several assistances
getBulkAssignRequestsMutationKey
getBulkAssignRequestsMutationOptions
getBulkAssignRequestsUrl
getBulkSimilarJourneys: Bulk similar journeys
getBulkUnassignRequestsMutationKey
getBulkUnassignRequestsMutationOptions
getBulkUnassignRequestsUrl
getCancelRarsBookingMutationKey
getCancelRarsBookingMutationOptions
getCancelRarsBookingUrl
getCreateDashboardSearchPresetMutationKey
getCreateDashboardSearchPresetMutationOptions
getCreateDashboardSearchPresetUrl
getDashboardSearchPreset: Show a dashboard search preset
getDashboardSearchPresets: List dashboard search presets
getDeleteDashboardSearchPresetMutationKey
getDeleteDashboardSearchPresetMutationOptions
getDeleteDashboardSearchPresetUrl
getGetAssignmentConflictQueryKey
getGetAssignmentConflictQueryOptions
getGetAssignmentConflictUrl
getGetAvailableUsersToAssignQueryKey
getGetAvailableUsersToAssignQueryOptions
getGetAvailableUsersToAssignUrl
getGetBulkAssignmentConflictMutationKey
getGetBulkAssignmentConflictMutationOptions
getGetBulkAssignmentConflictUrl
getGetBulkSimilarJourneysMutationKey
getGetBulkSimilarJourneysMutationOptions
getGetBulkSimilarJourneysUrl
getGetDashboardSearchPresetQueryKey
getGetDashboardSearchPresetQueryOptions
getGetDashboardSearchPresetsQueryKey
getGetDashboardSearchPresetsQueryOptions
getGetDashboardSearchPresetsUrl
getGetDashboardSearchPresetUrl
getGetGroupedAvailableUsersToAssignQueryKey
getGetGroupedAvailableUsersToAssignQueryOptions
getGetGroupedAvailableUsersToAssignUrl
getGetJourneyCallingPointsQueryKey
getGetJourneyCallingPointsQueryOptions
getGetJourneyCallingPointsUrl
getGetJourneyLegsQueryKey
getGetJourneyLegsQueryOptions
getGetJourneyLegsUrl
getGetRarsAvailabilityV1MutationKey
getGetRarsAvailabilityV1MutationOptions
getGetRarsAvailabilityV1Url
getGetRarsAvailabilityV2MutationKey
getGetRarsAvailabilityV2MutationOptions
getGetRarsAvailabilityV2Url
getGetSimilarJourneysQueryKey
getGetSimilarJourneysQueryOptions
getGetSimilarJourneysUrl
getGetUnconfirmedBookingsQueryKey
getGetUnconfirmedBookingsQueryOptions
getGetUnconfirmedBookingsUrl
getGroupedAvailableUsersToAssign: List grouped users available to assign
getJourneyCallingPoints: Retrieve journey calling points
getJourneyLegs: List journey legs
getListRarsCoachesQueryKey
getListRarsCoachesQueryOptions
getListRarsCoachesUrl
getRarsAvailabilityV1: Get seat reservation availability (staff v1)
getRarsAvailabilityV2: Get seat reservation availability (staff v2)
getSimilarJourneys: Similar journeys
getUnconfirmedBookings: List unconfirmed bookings
listRarsCoaches: List selectable coaches and bookable seats
resetApiClient
StaffUserRoleOrganisationCategory
StaffUserStatus
useBulkAssignRequests: Assign or reassign multiple assistance requests
useBulkUnassignRequests: Unassign multiple assistance requests
useCancelRarsBooking: Cancel a RARS booking
useCreateDashboardSearchPreset: Create a dashboard search preset
useDeleteDashboardSearchPreset: Delete a dashboard search preset
useGetBulkAssignmentConflict: Check a staff member for a scheduling conflict across several assistances
useGetBulkSimilarJourneys: Bulk similar journeys
useGetRarsAvailabilityV1: Get seat reservation availability (staff v1)
useGetRarsAvailabilityV2: Get seat reservation availability (staff v2)

Functions