@chrt-inc/typescript-sdk 0.0.162-b → 0.1.0-beta0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +30 -24
- package/Client.js +55 -45
- package/README.md +10 -6
- package/api/resources/dev/client/Client.d.ts +7 -7
- package/api/resources/dev/client/Client.js +48 -48
- package/api/resources/directory/client/Client.js +1 -1
- package/api/resources/directory/client/requests/DbQueryParams.d.ts +2 -2
- package/api/resources/index.d.ts +16 -14
- package/api/resources/index.js +17 -15
- package/api/resources/{oortNotificationPreferences → messages}/client/Client.d.ts +20 -12
- package/api/resources/messages/client/Client.js +191 -0
- package/api/resources/messages/client/requests/ShipperToCourierCreate1.d.ts +27 -0
- package/api/resources/messages/client/requests/index.d.ts +1 -0
- package/api/resources/mirror/client/Client.d.ts +0 -25
- package/api/resources/mirror/client/Client.js +10 -119
- package/api/resources/oortCourierPayDriverRate/client/Client.d.ts +8 -38
- package/api/resources/oortCourierPayDriverRate/client/Client.js +24 -65
- package/api/resources/oortCourierPayDriverRate/client/index.d.ts +1 -1
- package/api/resources/oortCourierPayDriverRate/client/index.js +0 -15
- package/api/resources/oortDrivers/client/Client.d.ts +36 -48
- package/api/resources/oortDrivers/client/Client.js +93 -146
- package/api/resources/oortDrivers/client/requests/SetDriverActivationReq.d.ts +3 -3
- package/api/resources/oortDrivers/client/requests/UpdateDriverDetailsReq.d.ts +0 -2
- package/api/resources/oortDrivers/client/requests/index.d.ts +1 -2
- package/api/resources/{oortConnections → oortHandles}/client/Client.d.ts +22 -15
- package/api/resources/{oortConnections → oortHandles}/client/Client.js +40 -28
- package/api/resources/{oortOrgProfiles/client/requests/GetAvatarRequest.d.ts → oortHandles/client/requests/HandlesReq.d.ts} +1 -1
- package/api/resources/oortHandles/client/requests/index.d.ts +1 -0
- package/api/resources/oortMilestones/client/Client.d.ts +15 -28
- package/api/resources/oortMilestones/client/Client.js +41 -96
- package/api/resources/oortMilestones/client/requests/MilestoneUpdateReq.d.ts +1 -1
- package/api/resources/oortMilestones/client/requests/index.d.ts +0 -1
- package/api/resources/oortOrders/client/Client.d.ts +35 -45
- package/api/resources/oortOrders/client/Client.js +89 -140
- package/api/resources/oortOrders/client/requests/CreateOrderReq.d.ts +14 -14
- package/api/resources/oortOrgProfiles/client/Client.d.ts +3 -15
- package/api/resources/oortOrgProfiles/client/Client.js +8 -65
- package/api/resources/oortOrgProfiles/client/requests/CourierOrgProfileClientCreate3.d.ts +7 -6
- package/api/resources/oortOrgProfiles/client/requests/index.d.ts +0 -1
- package/api/resources/oortRateSheets/client/Client.d.ts +66 -0
- package/api/resources/{oortNotificationPreferences → oortRateSheets}/client/Client.js +52 -35
- package/{dist/api/resources/oortCourierPayDriverRate/client/requests/CourierPayDriverRateSheetClientCreate1.d.ts → api/resources/oortRateSheets/client/requests/RateSheetClientCreate1.d.ts} +25 -26
- package/api/resources/oortRateSheets/client/requests/index.d.ts +1 -0
- package/api/resources/oortRoutes/client/Client.d.ts +103 -0
- package/{dist/api/resources/oortOrgConnectionInfos → api/resources/oortRoutes}/client/Client.js +134 -71
- package/api/resources/oortRoutes/client/requests/GetOortRoutesByIdRequest.d.ts +29 -0
- package/api/resources/{orgs/client/requests/UpdateOrgPublicDataReq.d.ts → oortRoutes/client/requests/RouteCreateReq.d.ts} +3 -3
- package/{dist/api/resources/oortTaskGroups/client/requests/UpdateTaskGroupReq.d.ts → api/resources/oortRoutes/client/requests/UpdateRouteReq.d.ts} +6 -4
- package/api/resources/oortRoutes/client/requests/index.d.ts +3 -0
- package/api/resources/oortShippers/client/Client.d.ts +44 -0
- package/api/resources/oortShippers/client/Client.js +156 -0
- package/api/resources/oortShippers/client/index.d.ts +1 -0
- package/api/resources/oortTaskGroups/client/Client.d.ts +6 -56
- package/api/resources/oortTaskGroups/client/Client.js +6 -222
- package/api/resources/oortTaskGroups/client/index.d.ts +1 -1
- package/api/resources/oortTaskGroups/client/index.js +0 -15
- package/api/resources/orgs/client/Client.d.ts +2 -52
- package/api/resources/orgs/client/Client.js +5 -215
- package/api/resources/{oortConnections/client/requests/CreateConnectionReq.d.ts → orgs/client/requests/PostOrgPublicDataReq.d.ts} +1 -1
- package/api/resources/orgs/client/requests/index.d.ts +1 -2
- package/api/resources/payments/client/Client.js +3 -3
- package/api/resources/profiles/client/Client.d.ts +67 -0
- package/{dist/api/resources/oortShipperUserInfo → api/resources/profiles}/client/Client.js +49 -79
- package/api/resources/profiles/client/requests/CourierProfileCreate2.d.ts +32 -0
- package/api/resources/profiles/client/requests/GetCourierProfileRequest.d.ts +12 -0
- package/api/resources/profiles/client/requests/GetHandleIsAvailableRequest.d.ts +15 -0
- package/api/resources/profiles/client/requests/index.d.ts +3 -0
- package/api/resources/profiles/index.d.ts +2 -0
- package/api/resources/profiles/index.js +18 -0
- package/api/resources/profiles/types/Type.d.ts +8 -0
- package/api/resources/profiles/types/Type.js +10 -0
- package/api/resources/profiles/types/index.d.ts +1 -0
- package/api/resources/profiles/types/index.js +17 -0
- package/api/resources/root/client/Client.d.ts +12 -12
- package/api/resources/root/client/Client.js +31 -31
- package/api/resources/root/types/PydanticResponse.d.ts +1 -1
- package/api/resources/users/client/Client.js +1 -1
- package/api/types/Action.d.ts +1 -1
- package/{dist/api/types/Vehicle1.d.ts → api/types/AppModelsDbOortVehicle1Vehicle1.d.ts} +2 -2
- package/api/types/AppModelsDbProfilesCourierOrgProfile2Vehicle1.d.ts +10 -0
- package/api/types/Cargo1.d.ts +6 -6
- package/api/types/CargoClientCreate1.d.ts +3 -3
- package/api/types/CourierAvailabilityEnum.d.ts +9 -0
- package/api/types/CourierAvailabilityEnum.js +11 -0
- package/api/types/CourierCity.d.ts +9 -0
- package/{dist/api/types/CourierOrgConnectionInfo1.d.ts → api/types/CourierOrgInfo1.d.ts} +12 -11
- package/api/types/CourierOrgProfile3.d.ts +3 -4
- package/api/types/CourierProfile2.d.ts +28 -0
- package/{dist/api/types/MultipleTaskGroupsWithTasks.d.ts → api/types/CourierProfileRes2.d.ts} +3 -2
- package/api/types/CourierServiceEnum.d.ts +20 -0
- package/api/types/CourierServiceEnum.js +22 -0
- package/api/types/CourierState.d.ts +8 -0
- package/api/types/DecodedJwtWithOrgAndUserId.d.ts +8 -8
- package/api/types/Driver1.d.ts +8 -10
- package/api/types/EmailAddress1.d.ts +8 -0
- package/api/types/Expense1.d.ts +3 -3
- package/api/types/Feature.d.ts +2 -2
- package/api/types/GetOrderFullRes.d.ts +2 -2
- package/{dist/api/types/TaskGroupWithDetails.d.ts → api/types/GetTaskGroupWithFullTaskInfoRes.d.ts} +2 -2
- package/api/types/{TaskGroupWithTasks.d.ts → GetTaskGroupWithTasksRes.d.ts} +1 -1
- package/api/types/GetTaskGroupsWithFullTaskInfoListRes.d.ts +7 -0
- package/api/types/GetTaskGroupsWithTasksListRes.d.ts +7 -0
- package/api/types/{TaskGroupWithDetails.d.ts → GetTaskInfoListRes.d.ts} +2 -2
- package/api/types/Incident1.d.ts +1 -1
- package/api/types/IndustryEnum.d.ts +21 -0
- package/api/types/IndustryEnum.js +23 -0
- package/api/types/Insurance1.d.ts +1 -1
- package/api/types/LineItem1.d.ts +1 -1
- package/api/types/Milestone1.d.ts +12 -16
- package/api/types/MilestoneClientCreate1.d.ts +1 -1
- package/api/types/MilestoneTypeEnum1.d.ts +2 -3
- package/api/types/MilestoneTypeEnum1.js +1 -2
- package/api/types/Order1.d.ts +9 -11
- package/api/types/OrgMemberDetails.d.ts +2 -2
- package/api/types/OrgMembersAndDrivers.d.ts +1 -1
- package/api/types/OrgPublicData2.d.ts +3 -4
- package/api/types/PayablesInvoice1.d.ts +11 -11
- package/api/types/PhoneNumber1.d.ts +8 -0
- package/api/types/{CourierPayDriverRateSheet1.d.ts → RateSheet1.d.ts} +18 -18
- package/api/types/ReceivablesInvoice1.d.ts +7 -7
- package/api/types/Route1.d.ts +13 -0
- package/api/types/RouteByIdEnum.d.ts +8 -0
- package/api/types/RouteByIdEnum.js +10 -0
- package/api/types/RouteDetailRes.d.ts +9 -0
- package/api/types/Shipper2.d.ts +8 -8
- package/api/types/ShipperCourierConnection1.d.ts +4 -4
- package/api/types/{ShipperOrgConnectionInfo1.d.ts → ShipperOrgInfo1.d.ts} +8 -7
- package/api/types/ShipperToCourier1.d.ts +16 -0
- package/api/types/ShipperUserInfo1.d.ts +7 -7
- package/api/types/SocialLinks.d.ts +8 -0
- package/api/types/StreetAddress1.d.ts +3 -3
- package/api/types/StripeConnectInvoice1.d.ts +5 -5
- package/api/types/Task1.d.ts +13 -14
- package/api/types/TaskClientCreate1.d.ts +5 -6
- package/api/types/TaskCreateBundle.d.ts +2 -4
- package/api/types/TaskDetailRes.d.ts +9 -0
- package/api/types/TaskGroup1.d.ts +6 -12
- package/api/types/TaskGroupDetailRes.d.ts +8 -0
- package/{dist/api/types/TaskWithDetails.d.ts → api/types/TaskInfo.d.ts} +3 -3
- package/api/types/Tracker1.d.ts +1 -1
- package/api/types/TrackerSession1.d.ts +1 -1
- package/api/types/{UpdateTaskGroupRes.d.ts → UpdateRouteRes.d.ts} +1 -1
- package/api/types/UsStatesEnum.d.ts +58 -0
- package/api/types/UsStatesEnum.js +60 -0
- package/api/types/UserPublicData5.d.ts +6 -6
- package/api/types/Vehicle1Input.d.ts +10 -0
- package/api/types/VehicleRate1.d.ts +9 -0
- package/api/types/index.d.ts +32 -19
- package/api/types/index.js +32 -19
- package/dist/Client.d.ts +30 -24
- package/dist/Client.js +55 -45
- package/dist/api/resources/dev/client/Client.d.ts +7 -7
- package/dist/api/resources/dev/client/Client.js +48 -48
- package/dist/api/resources/directory/client/Client.js +1 -1
- package/dist/api/resources/directory/client/requests/DbQueryParams.d.ts +2 -2
- package/dist/api/resources/index.d.ts +16 -14
- package/dist/api/resources/index.js +17 -15
- package/dist/api/resources/{oortNotificationPreferences → messages}/client/Client.d.ts +20 -12
- package/dist/api/resources/messages/client/Client.js +191 -0
- package/dist/api/resources/messages/client/requests/ShipperToCourierCreate1.d.ts +27 -0
- package/dist/api/resources/messages/client/requests/index.d.ts +1 -0
- package/dist/api/resources/mirror/client/Client.d.ts +0 -25
- package/dist/api/resources/mirror/client/Client.js +10 -119
- package/dist/api/resources/oortCourierPayDriverRate/client/Client.d.ts +8 -38
- package/dist/api/resources/oortCourierPayDriverRate/client/Client.js +24 -65
- package/dist/api/resources/oortCourierPayDriverRate/client/index.d.ts +1 -1
- package/dist/api/resources/oortCourierPayDriverRate/client/index.js +0 -15
- package/dist/api/resources/oortDrivers/client/Client.d.ts +36 -48
- package/dist/api/resources/oortDrivers/client/Client.js +93 -146
- package/dist/api/resources/oortDrivers/client/requests/SetDriverActivationReq.d.ts +3 -3
- package/dist/api/resources/oortDrivers/client/requests/UpdateDriverDetailsReq.d.ts +0 -2
- package/dist/api/resources/oortDrivers/client/requests/index.d.ts +1 -2
- package/dist/api/resources/{oortConnections → oortHandles}/client/Client.d.ts +22 -15
- package/dist/api/resources/{oortConnections → oortHandles}/client/Client.js +40 -28
- package/dist/api/resources/{oortOrgProfiles/client/requests/GetAvatarRequest.d.ts → oortHandles/client/requests/HandlesReq.d.ts} +1 -1
- package/dist/api/resources/oortHandles/client/requests/index.d.ts +1 -0
- package/dist/api/resources/oortMilestones/client/Client.d.ts +15 -28
- package/dist/api/resources/oortMilestones/client/Client.js +41 -96
- package/dist/api/resources/oortMilestones/client/requests/MilestoneUpdateReq.d.ts +1 -1
- package/dist/api/resources/oortMilestones/client/requests/index.d.ts +0 -1
- package/dist/api/resources/oortOrders/client/Client.d.ts +35 -45
- package/dist/api/resources/oortOrders/client/Client.js +89 -140
- package/dist/api/resources/oortOrders/client/requests/CreateOrderReq.d.ts +14 -14
- package/dist/api/resources/oortOrgProfiles/client/Client.d.ts +3 -15
- package/dist/api/resources/oortOrgProfiles/client/Client.js +8 -65
- package/dist/api/resources/oortOrgProfiles/client/requests/CourierOrgProfileClientCreate3.d.ts +7 -6
- package/dist/api/resources/oortOrgProfiles/client/requests/index.d.ts +0 -1
- package/dist/api/resources/oortRateSheets/client/Client.d.ts +66 -0
- package/dist/api/resources/{oortNotificationPreferences → oortRateSheets}/client/Client.js +52 -35
- package/{api/resources/oortCourierPayDriverRate/client/requests/CourierPayDriverRateSheetClientCreate1.d.ts → dist/api/resources/oortRateSheets/client/requests/RateSheetClientCreate1.d.ts} +25 -26
- package/dist/api/resources/oortRateSheets/client/requests/index.d.ts +1 -0
- package/dist/api/resources/oortRoutes/client/Client.d.ts +103 -0
- package/{api/resources/oortOrgConnectionInfos → dist/api/resources/oortRoutes}/client/Client.js +134 -71
- package/dist/api/resources/oortRoutes/client/index.d.ts +1 -0
- package/dist/api/resources/oortRoutes/client/index.js +17 -0
- package/dist/api/resources/oortRoutes/client/requests/GetOortRoutesByIdRequest.d.ts +29 -0
- package/dist/api/resources/{orgs/client/requests/UpdateOrgPublicDataReq.d.ts → oortRoutes/client/requests/RouteCreateReq.d.ts} +3 -3
- package/{api/resources/oortTaskGroups/client/requests/UpdateTaskGroupReq.d.ts → dist/api/resources/oortRoutes/client/requests/UpdateRouteReq.d.ts} +6 -4
- package/dist/api/resources/oortRoutes/client/requests/index.d.ts +3 -0
- package/dist/api/resources/oortRoutes/index.d.ts +1 -0
- package/dist/api/resources/oortRoutes/index.js +17 -0
- package/dist/api/resources/oortShippers/client/Client.d.ts +44 -0
- package/dist/api/resources/oortShippers/client/Client.js +156 -0
- package/dist/api/resources/oortShippers/client/index.d.ts +1 -0
- package/dist/api/resources/oortShippers/index.d.ts +1 -0
- package/dist/api/resources/oortShippers/index.js +17 -0
- package/dist/api/resources/oortTaskGroups/client/Client.d.ts +6 -56
- package/dist/api/resources/oortTaskGroups/client/Client.js +6 -222
- package/dist/api/resources/oortTaskGroups/client/index.d.ts +1 -1
- package/dist/api/resources/oortTaskGroups/client/index.js +0 -15
- package/dist/api/resources/orgs/client/Client.d.ts +2 -52
- package/dist/api/resources/orgs/client/Client.js +5 -215
- package/dist/api/resources/{oortConnections/client/requests/CreateConnectionReq.d.ts → orgs/client/requests/PostOrgPublicDataReq.d.ts} +1 -1
- package/dist/api/resources/orgs/client/requests/index.d.ts +1 -2
- package/dist/api/resources/payments/client/Client.js +3 -3
- package/dist/api/resources/profiles/client/Client.d.ts +67 -0
- package/{api/resources/oortShipperUserInfo → dist/api/resources/profiles}/client/Client.js +49 -79
- package/dist/api/resources/profiles/client/index.d.ts +1 -0
- package/dist/api/resources/profiles/client/index.js +17 -0
- package/dist/api/resources/profiles/client/requests/CourierProfileCreate2.d.ts +32 -0
- package/dist/api/resources/profiles/client/requests/GetCourierProfileRequest.d.ts +12 -0
- package/dist/api/resources/profiles/client/requests/GetHandleIsAvailableRequest.d.ts +15 -0
- package/dist/api/resources/profiles/client/requests/index.d.ts +3 -0
- package/dist/api/resources/profiles/index.d.ts +2 -0
- package/dist/api/resources/profiles/index.js +18 -0
- package/dist/api/resources/profiles/types/Type.d.ts +8 -0
- package/dist/api/resources/profiles/types/Type.js +10 -0
- package/dist/api/resources/profiles/types/index.d.ts +1 -0
- package/dist/api/resources/profiles/types/index.js +17 -0
- package/dist/api/resources/root/client/Client.d.ts +12 -12
- package/dist/api/resources/root/client/Client.js +31 -31
- package/dist/api/resources/root/types/PydanticResponse.d.ts +1 -1
- package/dist/api/resources/users/client/Client.js +1 -1
- package/dist/api/types/Action.d.ts +1 -1
- package/{api/types/Vehicle1.d.ts → dist/api/types/AppModelsDbOortVehicle1Vehicle1.d.ts} +2 -2
- package/dist/api/types/AppModelsDbProfilesCourierOrgProfile2Vehicle1.d.ts +10 -0
- package/dist/api/types/Cargo1.d.ts +6 -6
- package/dist/api/types/CargoClientCreate1.d.ts +3 -3
- package/dist/api/types/CourierAvailabilityEnum.d.ts +9 -0
- package/dist/api/types/CourierAvailabilityEnum.js +11 -0
- package/dist/api/types/CourierCity.d.ts +9 -0
- package/{api/types/CourierOrgConnectionInfo1.d.ts → dist/api/types/CourierOrgInfo1.d.ts} +12 -11
- package/dist/api/types/CourierOrgProfile3.d.ts +3 -4
- package/dist/api/types/CourierProfile2.d.ts +28 -0
- package/{api/types/MultipleTaskGroupsWithTasks.d.ts → dist/api/types/CourierProfileRes2.d.ts} +3 -2
- package/dist/api/types/CourierServiceEnum.d.ts +20 -0
- package/dist/api/types/CourierServiceEnum.js +22 -0
- package/dist/api/types/CourierState.d.ts +8 -0
- package/dist/api/types/DecodedJwtWithOrgAndUserId.d.ts +8 -8
- package/dist/api/types/Driver1.d.ts +8 -10
- package/dist/api/types/EmailAddress1.d.ts +8 -0
- package/dist/api/types/Expense1.d.ts +3 -3
- package/dist/api/types/Feature.d.ts +2 -2
- package/dist/api/types/GetOrderFullRes.d.ts +2 -2
- package/dist/api/types/GetTaskGroupWithFullTaskInfoRes.d.ts +8 -0
- package/dist/api/types/{TaskGroupWithTasks.d.ts → GetTaskGroupWithTasksRes.d.ts} +1 -1
- package/dist/api/types/GetTaskGroupsWithFullTaskInfoListRes.d.ts +7 -0
- package/dist/api/types/GetTaskGroupsWithTasksListRes.d.ts +7 -0
- package/dist/api/types/GetTaskInfoListRes.d.ts +8 -0
- package/dist/api/types/Incident1.d.ts +1 -1
- package/dist/api/types/IndustryEnum.d.ts +21 -0
- package/dist/api/types/IndustryEnum.js +23 -0
- package/dist/api/types/Insurance1.d.ts +1 -1
- package/dist/api/types/LineItem1.d.ts +1 -1
- package/dist/api/types/Milestone1.d.ts +12 -16
- package/dist/api/types/MilestoneClientCreate1.d.ts +1 -1
- package/dist/api/types/MilestoneTypeEnum1.d.ts +2 -3
- package/dist/api/types/MilestoneTypeEnum1.js +1 -2
- package/dist/api/types/Order1.d.ts +9 -11
- package/dist/api/types/OrgMemberDetails.d.ts +2 -2
- package/dist/api/types/OrgMembersAndDrivers.d.ts +1 -1
- package/dist/api/types/OrgPublicData2.d.ts +3 -4
- package/dist/api/types/PayablesInvoice1.d.ts +11 -11
- package/dist/api/types/PhoneNumber1.d.ts +8 -0
- package/dist/api/types/{CourierPayDriverRateSheet1.d.ts → RateSheet1.d.ts} +18 -18
- package/dist/api/types/RateSheet1.js +5 -0
- package/dist/api/types/ReceivablesInvoice1.d.ts +7 -7
- package/dist/api/types/Route1.d.ts +13 -0
- package/dist/api/types/Route1.js +5 -0
- package/dist/api/types/RouteByIdEnum.d.ts +8 -0
- package/dist/api/types/RouteByIdEnum.js +10 -0
- package/dist/api/types/RouteDetailRes.d.ts +9 -0
- package/dist/api/types/RouteDetailRes.js +5 -0
- package/dist/api/types/Shipper2.d.ts +8 -8
- package/dist/api/types/ShipperCourierConnection1.d.ts +4 -4
- package/dist/api/types/{ShipperOrgConnectionInfo1.d.ts → ShipperOrgInfo1.d.ts} +8 -7
- package/dist/api/types/ShipperOrgInfo1.js +5 -0
- package/dist/api/types/ShipperToCourier1.d.ts +16 -0
- package/dist/api/types/ShipperToCourier1.js +5 -0
- package/dist/api/types/ShipperUserInfo1.d.ts +7 -7
- package/dist/api/types/SocialLinks.d.ts +8 -0
- package/dist/api/types/SocialLinks.js +5 -0
- package/dist/api/types/StreetAddress1.d.ts +3 -3
- package/dist/api/types/StripeConnectInvoice1.d.ts +5 -5
- package/dist/api/types/Task1.d.ts +13 -14
- package/dist/api/types/TaskClientCreate1.d.ts +5 -6
- package/dist/api/types/TaskCreateBundle.d.ts +2 -4
- package/dist/api/types/TaskDetailRes.d.ts +9 -0
- package/dist/api/types/TaskDetailRes.js +5 -0
- package/dist/api/types/TaskGroup1.d.ts +6 -12
- package/dist/api/types/TaskGroupDetailRes.d.ts +8 -0
- package/dist/api/types/TaskGroupDetailRes.js +5 -0
- package/{api/types/TaskWithDetails.d.ts → dist/api/types/TaskInfo.d.ts} +3 -3
- package/dist/api/types/TaskInfo.js +5 -0
- package/dist/api/types/Tracker1.d.ts +1 -1
- package/dist/api/types/TrackerSession1.d.ts +1 -1
- package/dist/api/types/{UpdateTaskGroupRes.d.ts → UpdateRouteRes.d.ts} +1 -1
- package/dist/api/types/UpdateRouteRes.js +5 -0
- package/dist/api/types/UsStatesEnum.d.ts +58 -0
- package/dist/api/types/UsStatesEnum.js +60 -0
- package/dist/api/types/UserPublicData5.d.ts +6 -6
- package/dist/api/types/Vehicle1Input.d.ts +10 -0
- package/dist/api/types/Vehicle1Input.js +5 -0
- package/dist/api/types/VehicleRate1.d.ts +9 -0
- package/dist/api/types/VehicleRate1.js +5 -0
- package/dist/api/types/index.d.ts +32 -19
- package/dist/api/types/index.js +32 -19
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +759 -1435
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/oortConnections/client/requests/index.d.ts +0 -1
- package/api/resources/oortCourierPayDriverRate/client/requests/index.d.ts +0 -1
- package/api/resources/oortDrivers/client/requests/DriverCreateReq.d.ts +0 -17
- package/api/resources/oortMilestones/client/requests/MilestoneAddToTaskReq.d.ts +0 -16
- package/api/resources/oortNotificationPreferences/client/requests/NotificationPreferencesClientCreate1.d.ts +0 -18
- package/api/resources/oortNotificationPreferences/client/requests/index.d.ts +0 -1
- package/api/resources/oortOrgConnectionInfos/client/Client.d.ts +0 -102
- package/api/resources/oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoClientCreate1.d.ts +0 -24
- package/api/resources/oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoUpdate.d.ts +0 -18
- package/api/resources/oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientCreate1.d.ts +0 -24
- package/api/resources/oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientUpdate1.d.ts +0 -20
- package/api/resources/oortOrgConnectionInfos/client/requests/index.d.ts +0 -4
- package/api/resources/oortShipperUserInfo/client/Client.d.ts +0 -73
- package/api/resources/oortShipperUserInfo/client/requests/ShipperUserInfoClientCreate1.d.ts +0 -24
- package/api/resources/oortShipperUserInfo/client/requests/ShipperUserInfoClientUpdate1.d.ts +0 -21
- package/api/resources/oortShipperUserInfo/client/requests/index.d.ts +0 -2
- package/api/resources/oortTaskGroups/client/requests/SetTaskGroupPauseReq.d.ts +0 -14
- package/api/resources/oortTaskGroups/client/requests/index.d.ts +0 -2
- package/api/resources/orgs/client/requests/CreateOrgPublicDataReq.d.ts +0 -14
- package/api/types/DriverStatusEnum.d.ts +0 -9
- package/api/types/DriverStatusEnum.js +0 -11
- package/api/types/EmailReq.d.ts +0 -6
- package/api/types/EmailRes.d.ts +0 -7
- package/api/types/MultipleTaskGroupsDetailsResponse.d.ts +0 -7
- package/api/types/NotificationChannelEnum.d.ts +0 -10
- package/api/types/NotificationChannelEnum.js +0 -12
- package/api/types/NotificationPreferences1.d.ts +0 -18
- package/api/types/OrderStatusEnum1.d.ts +0 -10
- package/api/types/OrderStatusEnum1.js +0 -12
- package/api/types/TaskGroupDetailsResponse.d.ts +0 -8
- package/api/types/TaskGroupStatusEnum1.d.ts +0 -9
- package/api/types/TaskGroupStatusEnum1.js +0 -11
- package/dist/api/resources/oortConnections/client/requests/index.d.ts +0 -1
- package/dist/api/resources/oortCourierPayDriverRate/client/requests/index.d.ts +0 -1
- package/dist/api/resources/oortDrivers/client/requests/DriverCreateReq.d.ts +0 -17
- package/dist/api/resources/oortMilestones/client/requests/MilestoneAddToTaskReq.d.ts +0 -16
- package/dist/api/resources/oortNotificationPreferences/client/requests/NotificationPreferencesClientCreate1.d.ts +0 -18
- package/dist/api/resources/oortNotificationPreferences/client/requests/index.d.ts +0 -1
- package/dist/api/resources/oortOrgConnectionInfos/client/Client.d.ts +0 -102
- package/dist/api/resources/oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoClientCreate1.d.ts +0 -24
- package/dist/api/resources/oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoUpdate.d.ts +0 -18
- package/dist/api/resources/oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientCreate1.d.ts +0 -24
- package/dist/api/resources/oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientUpdate1.d.ts +0 -20
- package/dist/api/resources/oortOrgConnectionInfos/client/requests/index.d.ts +0 -4
- package/dist/api/resources/oortShipperUserInfo/client/Client.d.ts +0 -73
- package/dist/api/resources/oortShipperUserInfo/client/requests/ShipperUserInfoClientCreate1.d.ts +0 -24
- package/dist/api/resources/oortShipperUserInfo/client/requests/ShipperUserInfoClientUpdate1.d.ts +0 -21
- package/dist/api/resources/oortShipperUserInfo/client/requests/index.d.ts +0 -2
- package/dist/api/resources/oortTaskGroups/client/requests/SetTaskGroupPauseReq.d.ts +0 -14
- package/dist/api/resources/oortTaskGroups/client/requests/index.d.ts +0 -2
- package/dist/api/resources/orgs/client/requests/CreateOrgPublicDataReq.d.ts +0 -14
- package/dist/api/types/DriverStatusEnum.d.ts +0 -9
- package/dist/api/types/DriverStatusEnum.js +0 -11
- package/dist/api/types/EmailReq.d.ts +0 -6
- package/dist/api/types/EmailRes.d.ts +0 -7
- package/dist/api/types/MultipleTaskGroupsDetailsResponse.d.ts +0 -7
- package/dist/api/types/NotificationChannelEnum.d.ts +0 -10
- package/dist/api/types/NotificationChannelEnum.js +0 -12
- package/dist/api/types/NotificationPreferences1.d.ts +0 -18
- package/dist/api/types/OrderStatusEnum1.d.ts +0 -10
- package/dist/api/types/OrderStatusEnum1.js +0 -12
- package/dist/api/types/TaskGroupDetailsResponse.d.ts +0 -8
- package/dist/api/types/TaskGroupStatusEnum1.d.ts +0 -9
- package/dist/api/types/TaskGroupStatusEnum1.js +0 -11
- /package/api/resources/{oortConnections → messages}/client/index.d.ts +0 -0
- /package/api/resources/{oortConnections → messages}/client/index.js +0 -0
- /package/api/resources/{oortConnections/client/requests/CreateConnectionReq.js → messages/client/requests/ShipperToCourierCreate1.js} +0 -0
- /package/api/resources/{oortConnections → messages}/client/requests/index.js +0 -0
- /package/api/resources/{oortConnections → messages}/index.d.ts +0 -0
- /package/api/resources/{oortConnections → messages}/index.js +0 -0
- /package/api/resources/{oortNotificationPreferences → oortHandles}/client/index.d.ts +0 -0
- /package/api/resources/{oortNotificationPreferences → oortHandles}/client/index.js +0 -0
- /package/api/resources/{oortCourierPayDriverRate/client/requests/CourierPayDriverRateSheetClientCreate1.js → oortHandles/client/requests/HandlesReq.js} +0 -0
- /package/api/resources/{oortCourierPayDriverRate → oortHandles}/client/requests/index.js +0 -0
- /package/api/resources/{oortNotificationPreferences → oortHandles}/index.d.ts +0 -0
- /package/api/resources/{oortNotificationPreferences → oortHandles}/index.js +0 -0
- /package/api/resources/{oortOrgConnectionInfos → oortRateSheets}/client/index.d.ts +0 -0
- /package/api/resources/{oortOrgConnectionInfos → oortRateSheets}/client/index.js +0 -0
- /package/api/resources/{oortDrivers/client/requests/DriverCreateReq.js → oortRateSheets/client/requests/RateSheetClientCreate1.js} +0 -0
- /package/api/resources/{oortNotificationPreferences → oortRateSheets}/client/requests/index.js +0 -0
- /package/api/resources/{oortOrgConnectionInfos → oortRateSheets}/index.d.ts +0 -0
- /package/api/resources/{oortOrgConnectionInfos → oortRateSheets}/index.js +0 -0
- /package/api/resources/{oortShipperUserInfo → oortRoutes}/client/index.d.ts +0 -0
- /package/api/resources/{oortShipperUserInfo → oortRoutes}/client/index.js +0 -0
- /package/api/resources/{oortMilestones/client/requests/MilestoneAddToTaskReq.js → oortRoutes/client/requests/GetOortRoutesByIdRequest.js} +0 -0
- /package/api/resources/{oortNotificationPreferences/client/requests/NotificationPreferencesClientCreate1.js → oortRoutes/client/requests/RouteCreateReq.js} +0 -0
- /package/api/resources/{oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoClientCreate1.js → oortRoutes/client/requests/UpdateRouteReq.js} +0 -0
- /package/api/resources/{oortOrgConnectionInfos → oortRoutes}/client/requests/index.js +0 -0
- /package/api/resources/{oortShipperUserInfo → oortRoutes}/index.d.ts +0 -0
- /package/api/resources/{oortShipperUserInfo → oortRoutes}/index.js +0 -0
- /package/api/resources/{oortShipperUserInfo/client/requests → oortShippers/client}/index.js +0 -0
- /package/{dist/api/resources/oortConnections → api/resources/oortShippers}/index.d.ts +0 -0
- /package/{dist/api/resources/oortConnections → api/resources/oortShippers}/index.js +0 -0
- /package/api/resources/{oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoUpdate.js → orgs/client/requests/PostOrgPublicDataReq.js} +0 -0
- /package/{dist/api/resources/oortConnections → api/resources/profiles}/client/index.d.ts +0 -0
- /package/{dist/api/resources/oortConnections → api/resources/profiles}/client/index.js +0 -0
- /package/api/resources/{oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientCreate1.js → profiles/client/requests/CourierProfileCreate2.js} +0 -0
- /package/api/resources/{oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientUpdate1.js → profiles/client/requests/GetCourierProfileRequest.js} +0 -0
- /package/api/resources/{oortOrgProfiles/client/requests/GetAvatarRequest.js → profiles/client/requests/GetHandleIsAvailableRequest.js} +0 -0
- /package/api/resources/{oortTaskGroups → profiles}/client/requests/index.js +0 -0
- /package/api/{resources/oortShipperUserInfo/client/requests/ShipperUserInfoClientCreate1.js → types/AppModelsDbOortVehicle1Vehicle1.js} +0 -0
- /package/api/{resources/oortShipperUserInfo/client/requests/ShipperUserInfoClientUpdate1.js → types/AppModelsDbProfilesCourierOrgProfile2Vehicle1.js} +0 -0
- /package/api/{resources/oortTaskGroups/client/requests/SetTaskGroupPauseReq.js → types/CourierCity.js} +0 -0
- /package/api/{resources/oortTaskGroups/client/requests/UpdateTaskGroupReq.js → types/CourierOrgInfo1.js} +0 -0
- /package/api/{resources/orgs/client/requests/CreateOrgPublicDataReq.js → types/CourierProfile2.js} +0 -0
- /package/api/{resources/orgs/client/requests/UpdateOrgPublicDataReq.js → types/CourierProfileRes2.js} +0 -0
- /package/api/types/{CourierOrgConnectionInfo1.js → CourierState.js} +0 -0
- /package/api/types/{CourierPayDriverRateSheet1.js → EmailAddress1.js} +0 -0
- /package/api/types/{EmailReq.js → GetTaskGroupWithFullTaskInfoRes.js} +0 -0
- /package/api/types/{EmailRes.js → GetTaskGroupWithTasksRes.js} +0 -0
- /package/api/types/{MultipleTaskGroupsDetailsResponse.js → GetTaskGroupsWithFullTaskInfoListRes.js} +0 -0
- /package/api/types/{MultipleTaskGroupsWithTasks.js → GetTaskGroupsWithTasksListRes.js} +0 -0
- /package/api/types/{NotificationPreferences1.js → GetTaskInfoListRes.js} +0 -0
- /package/api/types/{ShipperOrgConnectionInfo1.js → PhoneNumber1.js} +0 -0
- /package/api/types/{TaskGroupDetailsResponse.js → RateSheet1.js} +0 -0
- /package/api/types/{TaskGroupWithDetails.js → Route1.js} +0 -0
- /package/api/types/{TaskGroupWithTasks.js → RouteDetailRes.js} +0 -0
- /package/api/types/{TaskWithDetails.js → ShipperOrgInfo1.js} +0 -0
- /package/api/types/{UpdateTaskGroupRes.js → ShipperToCourier1.js} +0 -0
- /package/api/types/{Vehicle1.js → SocialLinks.js} +0 -0
- /package/{dist/api/resources/oortConnections/client/requests/CreateConnectionReq.js → api/types/TaskDetailRes.js} +0 -0
- /package/{dist/api/resources/oortCourierPayDriverRate/client/requests/CourierPayDriverRateSheetClientCreate1.js → api/types/TaskGroupDetailRes.js} +0 -0
- /package/{dist/api/resources/oortDrivers/client/requests/DriverCreateReq.js → api/types/TaskInfo.js} +0 -0
- /package/{dist/api/resources/oortMilestones/client/requests/MilestoneAddToTaskReq.js → api/types/UpdateRouteRes.js} +0 -0
- /package/{dist/api/resources/oortNotificationPreferences/client/requests/NotificationPreferencesClientCreate1.js → api/types/Vehicle1Input.js} +0 -0
- /package/{dist/api/resources/oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoClientCreate1.js → api/types/VehicleRate1.js} +0 -0
- /package/dist/api/resources/{oortNotificationPreferences → messages}/client/index.d.ts +0 -0
- /package/dist/api/resources/{oortNotificationPreferences → messages}/client/index.js +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos/client/requests/CourierOrgConnectionInfoUpdate.js → messages/client/requests/ShipperToCourierCreate1.js} +0 -0
- /package/dist/api/resources/{oortConnections → messages}/client/requests/index.js +0 -0
- /package/dist/api/resources/{oortNotificationPreferences → messages}/index.d.ts +0 -0
- /package/dist/api/resources/{oortNotificationPreferences → messages}/index.js +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos → oortHandles}/client/index.d.ts +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos → oortHandles}/client/index.js +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientCreate1.js → oortHandles/client/requests/HandlesReq.js} +0 -0
- /package/dist/api/resources/{oortCourierPayDriverRate → oortHandles}/client/requests/index.js +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos → oortHandles}/index.d.ts +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos → oortHandles}/index.js +0 -0
- /package/dist/api/resources/{oortShipperUserInfo → oortRateSheets}/client/index.d.ts +0 -0
- /package/dist/api/resources/{oortShipperUserInfo → oortRateSheets}/client/index.js +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos/client/requests/ShipperOrgConnectionInfoClientUpdate1.js → oortRateSheets/client/requests/RateSheetClientCreate1.js} +0 -0
- /package/dist/api/resources/{oortNotificationPreferences → oortRateSheets}/client/requests/index.js +0 -0
- /package/dist/api/resources/{oortShipperUserInfo → oortRateSheets}/index.d.ts +0 -0
- /package/dist/api/resources/{oortShipperUserInfo → oortRateSheets}/index.js +0 -0
- /package/dist/api/resources/{oortOrgProfiles/client/requests/GetAvatarRequest.js → oortRoutes/client/requests/GetOortRoutesByIdRequest.js} +0 -0
- /package/dist/api/resources/{oortShipperUserInfo/client/requests/ShipperUserInfoClientCreate1.js → oortRoutes/client/requests/RouteCreateReq.js} +0 -0
- /package/dist/api/resources/{oortShipperUserInfo/client/requests/ShipperUserInfoClientUpdate1.js → oortRoutes/client/requests/UpdateRouteReq.js} +0 -0
- /package/dist/api/resources/{oortOrgConnectionInfos → oortRoutes}/client/requests/index.js +0 -0
- /package/dist/api/resources/{oortShipperUserInfo/client/requests → oortShippers/client}/index.js +0 -0
- /package/dist/api/resources/{oortTaskGroups/client/requests/SetTaskGroupPauseReq.js → orgs/client/requests/PostOrgPublicDataReq.js} +0 -0
- /package/dist/api/resources/{oortTaskGroups/client/requests/UpdateTaskGroupReq.js → profiles/client/requests/CourierProfileCreate2.js} +0 -0
- /package/dist/api/resources/{orgs/client/requests/CreateOrgPublicDataReq.js → profiles/client/requests/GetCourierProfileRequest.js} +0 -0
- /package/dist/api/resources/{orgs/client/requests/UpdateOrgPublicDataReq.js → profiles/client/requests/GetHandleIsAvailableRequest.js} +0 -0
- /package/dist/api/resources/{oortTaskGroups → profiles}/client/requests/index.js +0 -0
- /package/dist/api/types/{CourierOrgConnectionInfo1.js → AppModelsDbOortVehicle1Vehicle1.js} +0 -0
- /package/dist/api/types/{CourierPayDriverRateSheet1.js → AppModelsDbProfilesCourierOrgProfile2Vehicle1.js} +0 -0
- /package/dist/api/types/{EmailReq.js → CourierCity.js} +0 -0
- /package/dist/api/types/{EmailRes.js → CourierOrgInfo1.js} +0 -0
- /package/dist/api/types/{MultipleTaskGroupsDetailsResponse.js → CourierProfile2.js} +0 -0
- /package/dist/api/types/{MultipleTaskGroupsWithTasks.js → CourierProfileRes2.js} +0 -0
- /package/dist/api/types/{NotificationPreferences1.js → CourierState.js} +0 -0
- /package/dist/api/types/{ShipperOrgConnectionInfo1.js → EmailAddress1.js} +0 -0
- /package/dist/api/types/{TaskGroupDetailsResponse.js → GetTaskGroupWithFullTaskInfoRes.js} +0 -0
- /package/dist/api/types/{TaskGroupWithDetails.js → GetTaskGroupWithTasksRes.js} +0 -0
- /package/dist/api/types/{TaskGroupWithTasks.js → GetTaskGroupsWithFullTaskInfoListRes.js} +0 -0
- /package/dist/api/types/{TaskWithDetails.js → GetTaskGroupsWithTasksListRes.js} +0 -0
- /package/dist/api/types/{UpdateTaskGroupRes.js → GetTaskInfoListRes.js} +0 -0
- /package/dist/api/types/{Vehicle1.js → PhoneNumber1.js} +0 -0
package/reference.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Dev
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getUserId</a>() -> string</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
9
|
-
####
|
|
9
|
+
#### 🔌 Usage
|
|
10
10
|
|
|
11
11
|
<dl>
|
|
12
12
|
<dd>
|
|
@@ -14,13 +14,38 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
```typescript
|
|
18
|
+
await client.dev.getUserId();
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
</dd>
|
|
22
|
+
</dl>
|
|
23
|
+
</dd>
|
|
24
|
+
</dl>
|
|
25
|
+
|
|
26
|
+
#### ⚙️ Parameters
|
|
27
|
+
|
|
28
|
+
<dl>
|
|
29
|
+
<dd>
|
|
30
|
+
|
|
31
|
+
<dl>
|
|
32
|
+
<dd>
|
|
33
|
+
|
|
34
|
+
**requestOptions:** `Dev.RequestOptions`
|
|
18
35
|
|
|
19
36
|
</dd>
|
|
20
37
|
</dl>
|
|
21
38
|
</dd>
|
|
22
39
|
</dl>
|
|
23
40
|
|
|
41
|
+
</dd>
|
|
42
|
+
</dl>
|
|
43
|
+
</details>
|
|
44
|
+
|
|
45
|
+
<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getDecodedJwt</a>() -> Chrt.DecodedJwtWithOrgAndUserId</code></summary>
|
|
46
|
+
<dl>
|
|
47
|
+
<dd>
|
|
48
|
+
|
|
24
49
|
#### 🔌 Usage
|
|
25
50
|
|
|
26
51
|
<dl>
|
|
@@ -30,7 +55,7 @@ Returns a greeting message
|
|
|
30
55
|
<dd>
|
|
31
56
|
|
|
32
57
|
```typescript
|
|
33
|
-
await client.
|
|
58
|
+
await client.dev.getDecodedJwt();
|
|
34
59
|
```
|
|
35
60
|
|
|
36
61
|
</dd>
|
|
@@ -46,7 +71,7 @@ await client.root.getRoot();
|
|
|
46
71
|
<dl>
|
|
47
72
|
<dd>
|
|
48
73
|
|
|
49
|
-
**requestOptions:** `
|
|
74
|
+
**requestOptions:** `Dev.RequestOptions`
|
|
50
75
|
|
|
51
76
|
</dd>
|
|
52
77
|
</dl>
|
|
@@ -57,7 +82,7 @@ await client.root.getRoot();
|
|
|
57
82
|
</dl>
|
|
58
83
|
</details>
|
|
59
84
|
|
|
60
|
-
<details><summary><code>client.
|
|
85
|
+
<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getEmail</a>() -> string</code></summary>
|
|
61
86
|
<dl>
|
|
62
87
|
<dd>
|
|
63
88
|
|
|
@@ -70,7 +95,7 @@ await client.root.getRoot();
|
|
|
70
95
|
<dd>
|
|
71
96
|
|
|
72
97
|
```typescript
|
|
73
|
-
await client.
|
|
98
|
+
await client.dev.getEmail();
|
|
74
99
|
```
|
|
75
100
|
|
|
76
101
|
</dd>
|
|
@@ -86,7 +111,7 @@ await client.root.getAuthd();
|
|
|
86
111
|
<dl>
|
|
87
112
|
<dd>
|
|
88
113
|
|
|
89
|
-
**requestOptions:** `
|
|
114
|
+
**requestOptions:** `Dev.RequestOptions`
|
|
90
115
|
|
|
91
116
|
</dd>
|
|
92
117
|
</dl>
|
|
@@ -97,7 +122,7 @@ await client.root.getAuthd();
|
|
|
97
122
|
</dl>
|
|
98
123
|
</details>
|
|
99
124
|
|
|
100
|
-
<details><summary><code>client.
|
|
125
|
+
<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getTemplate</a>() -> string</code></summary>
|
|
101
126
|
<dl>
|
|
102
127
|
<dd>
|
|
103
128
|
|
|
@@ -110,7 +135,7 @@ await client.root.getAuthd();
|
|
|
110
135
|
<dd>
|
|
111
136
|
|
|
112
137
|
```typescript
|
|
113
|
-
await client.
|
|
138
|
+
await client.dev.getTemplate();
|
|
114
139
|
```
|
|
115
140
|
|
|
116
141
|
</dd>
|
|
@@ -126,7 +151,7 @@ await client.root.postAuthd();
|
|
|
126
151
|
<dl>
|
|
127
152
|
<dd>
|
|
128
153
|
|
|
129
|
-
**requestOptions:** `
|
|
154
|
+
**requestOptions:** `Dev.RequestOptions`
|
|
130
155
|
|
|
131
156
|
</dd>
|
|
132
157
|
</dl>
|
|
@@ -137,7 +162,7 @@ await client.root.postAuthd();
|
|
|
137
162
|
</dl>
|
|
138
163
|
</details>
|
|
139
164
|
|
|
140
|
-
<details><summary><code>client.
|
|
165
|
+
<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">postTemplate</a>({ ...params }) -> Chrt.TemplateRes</code></summary>
|
|
141
166
|
<dl>
|
|
142
167
|
<dd>
|
|
143
168
|
|
|
@@ -150,7 +175,11 @@ await client.root.postAuthd();
|
|
|
150
175
|
<dd>
|
|
151
176
|
|
|
152
177
|
```typescript
|
|
153
|
-
await client.
|
|
178
|
+
await client.dev.postTemplate({
|
|
179
|
+
message: "message",
|
|
180
|
+
number: 1,
|
|
181
|
+
timestamp: "2024-01-15T09:30:00Z",
|
|
182
|
+
});
|
|
154
183
|
```
|
|
155
184
|
|
|
156
185
|
</dd>
|
|
@@ -166,7 +195,15 @@ await client.root.getFailure();
|
|
|
166
195
|
<dl>
|
|
167
196
|
<dd>
|
|
168
197
|
|
|
169
|
-
**
|
|
198
|
+
**request:** `Chrt.TemplateReq`
|
|
199
|
+
|
|
200
|
+
</dd>
|
|
201
|
+
</dl>
|
|
202
|
+
|
|
203
|
+
<dl>
|
|
204
|
+
<dd>
|
|
205
|
+
|
|
206
|
+
**requestOptions:** `Dev.RequestOptions`
|
|
170
207
|
|
|
171
208
|
</dd>
|
|
172
209
|
</dl>
|
|
@@ -177,7 +214,9 @@ await client.root.getFailure();
|
|
|
177
214
|
</dl>
|
|
178
215
|
</details>
|
|
179
216
|
|
|
180
|
-
|
|
217
|
+
## Directory
|
|
218
|
+
|
|
219
|
+
<details><summary><code>client.directory.<a href="/src/api/resources/directory/client/Client.ts">postShippers</a>({ ...params }) -> Chrt.Shipper2[]</code></summary>
|
|
181
220
|
<dl>
|
|
182
221
|
<dd>
|
|
183
222
|
|
|
@@ -189,7 +228,7 @@ await client.root.getFailure();
|
|
|
189
228
|
<dl>
|
|
190
229
|
<dd>
|
|
191
230
|
|
|
192
|
-
|
|
231
|
+
Retrieve the full list of shippers with optional pagination and sorting
|
|
193
232
|
|
|
194
233
|
</dd>
|
|
195
234
|
</dl>
|
|
@@ -205,7 +244,7 @@ Used for monitoring system health
|
|
|
205
244
|
<dd>
|
|
206
245
|
|
|
207
246
|
```typescript
|
|
208
|
-
await client.
|
|
247
|
+
await client.directory.postShippers();
|
|
209
248
|
```
|
|
210
249
|
|
|
211
250
|
</dd>
|
|
@@ -221,7 +260,15 @@ await client.root.getHealth();
|
|
|
221
260
|
<dl>
|
|
222
261
|
<dd>
|
|
223
262
|
|
|
224
|
-
**
|
|
263
|
+
**request:** `Chrt.DbQueryParams`
|
|
264
|
+
|
|
265
|
+
</dd>
|
|
266
|
+
</dl>
|
|
267
|
+
|
|
268
|
+
<dl>
|
|
269
|
+
<dd>
|
|
270
|
+
|
|
271
|
+
**requestOptions:** `Directory.RequestOptions`
|
|
225
272
|
|
|
226
273
|
</dd>
|
|
227
274
|
</dl>
|
|
@@ -232,7 +279,9 @@ await client.root.getHealth();
|
|
|
232
279
|
</dl>
|
|
233
280
|
</details>
|
|
234
281
|
|
|
235
|
-
|
|
282
|
+
## Messages
|
|
283
|
+
|
|
284
|
+
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">getForCourier</a>() -> Chrt.ShipperToCourier1[]</code></summary>
|
|
236
285
|
<dl>
|
|
237
286
|
<dd>
|
|
238
287
|
|
|
@@ -245,7 +294,7 @@ await client.root.getHealth();
|
|
|
245
294
|
<dd>
|
|
246
295
|
|
|
247
296
|
```typescript
|
|
248
|
-
await client.
|
|
297
|
+
await client.messages.getForCourier();
|
|
249
298
|
```
|
|
250
299
|
|
|
251
300
|
</dd>
|
|
@@ -261,7 +310,7 @@ await client.root.getOptionallyAuthd();
|
|
|
261
310
|
<dl>
|
|
262
311
|
<dd>
|
|
263
312
|
|
|
264
|
-
**requestOptions:** `
|
|
313
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
265
314
|
|
|
266
315
|
</dd>
|
|
267
316
|
</dl>
|
|
@@ -272,7 +321,7 @@ await client.root.getOptionallyAuthd();
|
|
|
272
321
|
</dl>
|
|
273
322
|
</details>
|
|
274
323
|
|
|
275
|
-
<details><summary><code>client.
|
|
324
|
+
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">postShipperToCourier</a>({ ...params }) -> unknown</code></summary>
|
|
276
325
|
<dl>
|
|
277
326
|
<dd>
|
|
278
327
|
|
|
@@ -284,7 +333,7 @@ await client.root.getOptionallyAuthd();
|
|
|
284
333
|
<dl>
|
|
285
334
|
<dd>
|
|
286
335
|
|
|
287
|
-
|
|
336
|
+
Server logic overwrites `user_id`, `shipper_user_id`, and `created_at`
|
|
288
337
|
|
|
289
338
|
</dd>
|
|
290
339
|
</dl>
|
|
@@ -300,7 +349,15 @@ This route exposes pydantic models - which are not returned by any other route -
|
|
|
300
349
|
<dd>
|
|
301
350
|
|
|
302
351
|
```typescript
|
|
303
|
-
await client.
|
|
352
|
+
await client.messages.postShipperToCourier({
|
|
353
|
+
handle: "handle",
|
|
354
|
+
schema_version: 1,
|
|
355
|
+
user_id: "user_id",
|
|
356
|
+
name: "name",
|
|
357
|
+
email_address: "email_address",
|
|
358
|
+
message: "message",
|
|
359
|
+
viewed: true,
|
|
360
|
+
});
|
|
304
361
|
```
|
|
305
362
|
|
|
306
363
|
</dd>
|
|
@@ -316,7 +373,15 @@ await client.root.pydantic();
|
|
|
316
373
|
<dl>
|
|
317
374
|
<dd>
|
|
318
375
|
|
|
319
|
-
**
|
|
376
|
+
**request:** `Chrt.ShipperToCourierCreate1`
|
|
377
|
+
|
|
378
|
+
</dd>
|
|
379
|
+
</dl>
|
|
380
|
+
|
|
381
|
+
<dl>
|
|
382
|
+
<dd>
|
|
383
|
+
|
|
384
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
320
385
|
|
|
321
386
|
</dd>
|
|
322
387
|
</dl>
|
|
@@ -327,12 +392,27 @@ await client.root.pydantic();
|
|
|
327
392
|
</dl>
|
|
328
393
|
</details>
|
|
329
394
|
|
|
330
|
-
##
|
|
395
|
+
## OortDrivers
|
|
396
|
+
|
|
397
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversByUserId</a>() -> Chrt.Driver1</code></summary>
|
|
398
|
+
<dl>
|
|
399
|
+
<dd>
|
|
400
|
+
|
|
401
|
+
#### 📝 Description
|
|
402
|
+
|
|
403
|
+
<dl>
|
|
404
|
+
<dd>
|
|
331
405
|
|
|
332
|
-
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">getAuthdMirror</a>() -> unknown</code></summary>
|
|
333
406
|
<dl>
|
|
334
407
|
<dd>
|
|
335
408
|
|
|
409
|
+
Uses user_id from the JWT. (originally included for use by Pytest)
|
|
410
|
+
|
|
411
|
+
</dd>
|
|
412
|
+
</dl>
|
|
413
|
+
</dd>
|
|
414
|
+
</dl>
|
|
415
|
+
|
|
336
416
|
#### 🔌 Usage
|
|
337
417
|
|
|
338
418
|
<dl>
|
|
@@ -342,7 +422,7 @@ await client.root.pydantic();
|
|
|
342
422
|
<dd>
|
|
343
423
|
|
|
344
424
|
```typescript
|
|
345
|
-
await client.
|
|
425
|
+
await client.oortDrivers.getOortDriversByUserId();
|
|
346
426
|
```
|
|
347
427
|
|
|
348
428
|
</dd>
|
|
@@ -358,7 +438,7 @@ await client.mirror.getAuthdMirror();
|
|
|
358
438
|
<dl>
|
|
359
439
|
<dd>
|
|
360
440
|
|
|
361
|
-
**requestOptions:** `
|
|
441
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
362
442
|
|
|
363
443
|
</dd>
|
|
364
444
|
</dl>
|
|
@@ -369,11 +449,11 @@ await client.mirror.getAuthdMirror();
|
|
|
369
449
|
</dl>
|
|
370
450
|
</details>
|
|
371
451
|
|
|
372
|
-
<details><summary><code>client.
|
|
452
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">deleteOortDrivers</a>(driverId) -> boolean</code></summary>
|
|
373
453
|
<dl>
|
|
374
454
|
<dd>
|
|
375
455
|
|
|
376
|
-
####
|
|
456
|
+
#### 📝 Description
|
|
377
457
|
|
|
378
458
|
<dl>
|
|
379
459
|
<dd>
|
|
@@ -381,16 +461,14 @@ await client.mirror.getAuthdMirror();
|
|
|
381
461
|
<dl>
|
|
382
462
|
<dd>
|
|
383
463
|
|
|
384
|
-
|
|
385
|
-
await client.mirror.postAuthdMirror();
|
|
386
|
-
```
|
|
464
|
+
Can be used e.g. if a driver is removed from an org
|
|
387
465
|
|
|
388
466
|
</dd>
|
|
389
467
|
</dl>
|
|
390
468
|
</dd>
|
|
391
469
|
</dl>
|
|
392
470
|
|
|
393
|
-
####
|
|
471
|
+
#### 🔌 Usage
|
|
394
472
|
|
|
395
473
|
<dl>
|
|
396
474
|
<dd>
|
|
@@ -398,61 +476,62 @@ await client.mirror.postAuthdMirror();
|
|
|
398
476
|
<dl>
|
|
399
477
|
<dd>
|
|
400
478
|
|
|
401
|
-
|
|
479
|
+
```typescript
|
|
480
|
+
await client.oortDrivers.deleteOortDrivers("driver_id");
|
|
481
|
+
```
|
|
402
482
|
|
|
403
483
|
</dd>
|
|
404
484
|
</dl>
|
|
405
485
|
</dd>
|
|
406
486
|
</dl>
|
|
407
487
|
|
|
408
|
-
|
|
409
|
-
</dl>
|
|
410
|
-
</details>
|
|
488
|
+
#### ⚙️ Parameters
|
|
411
489
|
|
|
412
|
-
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">putAuthdMirror</a>() -> unknown</code></summary>
|
|
413
490
|
<dl>
|
|
414
491
|
<dd>
|
|
415
492
|
|
|
416
|
-
#### 🔌 Usage
|
|
417
|
-
|
|
418
493
|
<dl>
|
|
419
494
|
<dd>
|
|
420
495
|
|
|
496
|
+
**driverId:** `string`
|
|
497
|
+
|
|
498
|
+
</dd>
|
|
499
|
+
</dl>
|
|
500
|
+
|
|
421
501
|
<dl>
|
|
422
502
|
<dd>
|
|
423
503
|
|
|
424
|
-
|
|
425
|
-
await client.mirror.putAuthdMirror();
|
|
426
|
-
```
|
|
504
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
427
505
|
|
|
428
506
|
</dd>
|
|
429
507
|
</dl>
|
|
430
508
|
</dd>
|
|
431
509
|
</dl>
|
|
432
510
|
|
|
433
|
-
|
|
511
|
+
</dd>
|
|
512
|
+
</dl>
|
|
513
|
+
</details>
|
|
434
514
|
|
|
515
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">postOortDriversSetActivation</a>({ ...params }) -> boolean</code></summary>
|
|
435
516
|
<dl>
|
|
436
517
|
<dd>
|
|
437
518
|
|
|
519
|
+
#### 📝 Description
|
|
520
|
+
|
|
438
521
|
<dl>
|
|
439
522
|
<dd>
|
|
440
523
|
|
|
441
|
-
|
|
524
|
+
<dl>
|
|
525
|
+
<dd>
|
|
526
|
+
|
|
527
|
+
Set a driver's activation status (active=true/false).
|
|
528
|
+
This route is idempotent - setting a driver to their current status is allowed.
|
|
442
529
|
|
|
443
530
|
</dd>
|
|
444
531
|
</dl>
|
|
445
532
|
</dd>
|
|
446
533
|
</dl>
|
|
447
534
|
|
|
448
|
-
</dd>
|
|
449
|
-
</dl>
|
|
450
|
-
</details>
|
|
451
|
-
|
|
452
|
-
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">deleteAuthdMirror</a>() -> unknown</code></summary>
|
|
453
|
-
<dl>
|
|
454
|
-
<dd>
|
|
455
|
-
|
|
456
535
|
#### 🔌 Usage
|
|
457
536
|
|
|
458
537
|
<dl>
|
|
@@ -462,7 +541,10 @@ await client.mirror.putAuthdMirror();
|
|
|
462
541
|
<dd>
|
|
463
542
|
|
|
464
543
|
```typescript
|
|
465
|
-
await client.
|
|
544
|
+
await client.oortDrivers.postOortDriversSetActivation({
|
|
545
|
+
driver_object_id: "driver_object_id",
|
|
546
|
+
active: true,
|
|
547
|
+
});
|
|
466
548
|
```
|
|
467
549
|
|
|
468
550
|
</dd>
|
|
@@ -478,7 +560,15 @@ await client.mirror.deleteAuthdMirror();
|
|
|
478
560
|
<dl>
|
|
479
561
|
<dd>
|
|
480
562
|
|
|
481
|
-
**
|
|
563
|
+
**request:** `Chrt.SetDriverActivationReq`
|
|
564
|
+
|
|
565
|
+
</dd>
|
|
566
|
+
</dl>
|
|
567
|
+
|
|
568
|
+
<dl>
|
|
569
|
+
<dd>
|
|
570
|
+
|
|
571
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
482
572
|
|
|
483
573
|
</dd>
|
|
484
574
|
</dl>
|
|
@@ -489,7 +579,7 @@ await client.mirror.deleteAuthdMirror();
|
|
|
489
579
|
</dl>
|
|
490
580
|
</details>
|
|
491
581
|
|
|
492
|
-
<details><summary><code>client.
|
|
582
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">postOortDriversLastSeen</a>({ ...params }) -> boolean</code></summary>
|
|
493
583
|
<dl>
|
|
494
584
|
<dd>
|
|
495
585
|
|
|
@@ -502,7 +592,11 @@ await client.mirror.deleteAuthdMirror();
|
|
|
502
592
|
<dd>
|
|
503
593
|
|
|
504
594
|
```typescript
|
|
505
|
-
await client.
|
|
595
|
+
await client.oortDrivers.postOortDriversLastSeen({
|
|
596
|
+
location: {
|
|
597
|
+
type: "Feature",
|
|
598
|
+
},
|
|
599
|
+
});
|
|
506
600
|
```
|
|
507
601
|
|
|
508
602
|
</dd>
|
|
@@ -518,7 +612,15 @@ await client.mirror.patchAuthdMirror();
|
|
|
518
612
|
<dl>
|
|
519
613
|
<dd>
|
|
520
614
|
|
|
521
|
-
**
|
|
615
|
+
**request:** `Chrt.DriverLastSeenReq`
|
|
616
|
+
|
|
617
|
+
</dd>
|
|
618
|
+
</dl>
|
|
619
|
+
|
|
620
|
+
<dl>
|
|
621
|
+
<dd>
|
|
622
|
+
|
|
623
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
522
624
|
|
|
523
625
|
</dd>
|
|
524
626
|
</dl>
|
|
@@ -529,7 +631,7 @@ await client.mirror.patchAuthdMirror();
|
|
|
529
631
|
</dl>
|
|
530
632
|
</details>
|
|
531
633
|
|
|
532
|
-
<details><summary><code>client.
|
|
634
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">putOortDriversUpdateDriverDetails</a>({ ...params }) -> boolean</code></summary>
|
|
533
635
|
<dl>
|
|
534
636
|
<dd>
|
|
535
637
|
|
|
@@ -542,7 +644,9 @@ await client.mirror.patchAuthdMirror();
|
|
|
542
644
|
<dd>
|
|
543
645
|
|
|
544
646
|
```typescript
|
|
545
|
-
await client.
|
|
647
|
+
await client.oortDrivers.putOortDriversUpdateDriverDetails({
|
|
648
|
+
driver_object_id: "driver_object_id",
|
|
649
|
+
});
|
|
546
650
|
```
|
|
547
651
|
|
|
548
652
|
</dd>
|
|
@@ -558,7 +662,15 @@ await client.mirror.getMirror();
|
|
|
558
662
|
<dl>
|
|
559
663
|
<dd>
|
|
560
664
|
|
|
561
|
-
**
|
|
665
|
+
**request:** `Chrt.UpdateDriverDetailsReq`
|
|
666
|
+
|
|
667
|
+
</dd>
|
|
668
|
+
</dl>
|
|
669
|
+
|
|
670
|
+
<dl>
|
|
671
|
+
<dd>
|
|
672
|
+
|
|
673
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
562
674
|
|
|
563
675
|
</dd>
|
|
564
676
|
</dl>
|
|
@@ -569,7 +681,7 @@ await client.mirror.getMirror();
|
|
|
569
681
|
</dl>
|
|
570
682
|
</details>
|
|
571
683
|
|
|
572
|
-
<details><summary><code>client.
|
|
684
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">postOortDriversCreate</a>({ ...params }) -> string</code></summary>
|
|
573
685
|
<dl>
|
|
574
686
|
<dd>
|
|
575
687
|
|
|
@@ -582,7 +694,10 @@ await client.mirror.getMirror();
|
|
|
582
694
|
<dd>
|
|
583
695
|
|
|
584
696
|
```typescript
|
|
585
|
-
await client.
|
|
697
|
+
await client.oortDrivers.postOortDriversCreate({
|
|
698
|
+
role: "role",
|
|
699
|
+
user_id: "user_id",
|
|
700
|
+
});
|
|
586
701
|
```
|
|
587
702
|
|
|
588
703
|
</dd>
|
|
@@ -598,7 +713,15 @@ await client.mirror.postMirror();
|
|
|
598
713
|
<dl>
|
|
599
714
|
<dd>
|
|
600
715
|
|
|
601
|
-
**
|
|
716
|
+
**request:** `Chrt.OrgMemberDetails`
|
|
717
|
+
|
|
718
|
+
</dd>
|
|
719
|
+
</dl>
|
|
720
|
+
|
|
721
|
+
<dl>
|
|
722
|
+
<dd>
|
|
723
|
+
|
|
724
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
602
725
|
|
|
603
726
|
</dd>
|
|
604
727
|
</dl>
|
|
@@ -609,11 +732,11 @@ await client.mirror.postMirror();
|
|
|
609
732
|
</dl>
|
|
610
733
|
</details>
|
|
611
734
|
|
|
612
|
-
<details><summary><code>client.
|
|
735
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversListOrgMembersAndDrivers</a>() -> Chrt.OrgMembersAndDrivers[]</code></summary>
|
|
613
736
|
<dl>
|
|
614
737
|
<dd>
|
|
615
738
|
|
|
616
|
-
####
|
|
739
|
+
#### 📝 Description
|
|
617
740
|
|
|
618
741
|
<dl>
|
|
619
742
|
<dd>
|
|
@@ -621,16 +744,14 @@ await client.mirror.postMirror();
|
|
|
621
744
|
<dl>
|
|
622
745
|
<dd>
|
|
623
746
|
|
|
624
|
-
|
|
625
|
-
await client.mirror.putMirror();
|
|
626
|
-
```
|
|
747
|
+
Uses the org_id from the JWT
|
|
627
748
|
|
|
628
749
|
</dd>
|
|
629
750
|
</dl>
|
|
630
751
|
</dd>
|
|
631
752
|
</dl>
|
|
632
753
|
|
|
633
|
-
####
|
|
754
|
+
#### 🔌 Usage
|
|
634
755
|
|
|
635
756
|
<dl>
|
|
636
757
|
<dd>
|
|
@@ -638,22 +759,16 @@ await client.mirror.putMirror();
|
|
|
638
759
|
<dl>
|
|
639
760
|
<dd>
|
|
640
761
|
|
|
641
|
-
|
|
762
|
+
```typescript
|
|
763
|
+
await client.oortDrivers.getOortDriversListOrgMembersAndDrivers();
|
|
764
|
+
```
|
|
642
765
|
|
|
643
766
|
</dd>
|
|
644
767
|
</dl>
|
|
645
768
|
</dd>
|
|
646
769
|
</dl>
|
|
647
770
|
|
|
648
|
-
|
|
649
|
-
</dl>
|
|
650
|
-
</details>
|
|
651
|
-
|
|
652
|
-
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">deleteMirror</a>() -> unknown</code></summary>
|
|
653
|
-
<dl>
|
|
654
|
-
<dd>
|
|
655
|
-
|
|
656
|
-
#### 🔌 Usage
|
|
771
|
+
#### ⚙️ Parameters
|
|
657
772
|
|
|
658
773
|
<dl>
|
|
659
774
|
<dd>
|
|
@@ -661,38 +776,36 @@ await client.mirror.putMirror();
|
|
|
661
776
|
<dl>
|
|
662
777
|
<dd>
|
|
663
778
|
|
|
664
|
-
|
|
665
|
-
await client.mirror.deleteMirror();
|
|
666
|
-
```
|
|
779
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
667
780
|
|
|
668
781
|
</dd>
|
|
669
782
|
</dl>
|
|
670
783
|
</dd>
|
|
671
784
|
</dl>
|
|
672
785
|
|
|
673
|
-
|
|
786
|
+
</dd>
|
|
787
|
+
</dl>
|
|
788
|
+
</details>
|
|
674
789
|
|
|
790
|
+
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversByOrgId</a>() -> Chrt.Driver1[]</code></summary>
|
|
675
791
|
<dl>
|
|
676
792
|
<dd>
|
|
677
793
|
|
|
794
|
+
#### 📝 Description
|
|
795
|
+
|
|
678
796
|
<dl>
|
|
679
797
|
<dd>
|
|
680
798
|
|
|
681
|
-
|
|
799
|
+
<dl>
|
|
800
|
+
<dd>
|
|
801
|
+
|
|
802
|
+
Used org_id from the JWT
|
|
682
803
|
|
|
683
804
|
</dd>
|
|
684
805
|
</dl>
|
|
685
806
|
</dd>
|
|
686
807
|
</dl>
|
|
687
808
|
|
|
688
|
-
</dd>
|
|
689
|
-
</dl>
|
|
690
|
-
</details>
|
|
691
|
-
|
|
692
|
-
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">patchMirror</a>() -> unknown</code></summary>
|
|
693
|
-
<dl>
|
|
694
|
-
<dd>
|
|
695
|
-
|
|
696
809
|
#### 🔌 Usage
|
|
697
810
|
|
|
698
811
|
<dl>
|
|
@@ -702,7 +815,7 @@ await client.mirror.deleteMirror();
|
|
|
702
815
|
<dd>
|
|
703
816
|
|
|
704
817
|
```typescript
|
|
705
|
-
await client.
|
|
818
|
+
await client.oortDrivers.getOortDriversByOrgId();
|
|
706
819
|
```
|
|
707
820
|
|
|
708
821
|
</dd>
|
|
@@ -718,7 +831,7 @@ await client.mirror.patchMirror();
|
|
|
718
831
|
<dl>
|
|
719
832
|
<dd>
|
|
720
833
|
|
|
721
|
-
**requestOptions:** `
|
|
834
|
+
**requestOptions:** `OortDrivers.RequestOptions`
|
|
722
835
|
|
|
723
836
|
</dd>
|
|
724
837
|
</dl>
|
|
@@ -729,11 +842,13 @@ await client.mirror.patchMirror();
|
|
|
729
842
|
</dl>
|
|
730
843
|
</details>
|
|
731
844
|
|
|
732
|
-
|
|
845
|
+
## OortHandles
|
|
846
|
+
|
|
847
|
+
<details><summary><code>client.oortHandles.<a href="/src/api/resources/oortHandles/client/Client.ts">getHandlesByOrgId</a>() -> string</code></summary>
|
|
733
848
|
<dl>
|
|
734
849
|
<dd>
|
|
735
850
|
|
|
736
|
-
####
|
|
851
|
+
#### 📝 Description
|
|
737
852
|
|
|
738
853
|
<dl>
|
|
739
854
|
<dd>
|
|
@@ -741,18 +856,14 @@ await client.mirror.patchMirror();
|
|
|
741
856
|
<dl>
|
|
742
857
|
<dd>
|
|
743
858
|
|
|
744
|
-
|
|
745
|
-
await client.mirror.postOrderCompletedEmail({
|
|
746
|
-
to: ["to"],
|
|
747
|
-
});
|
|
748
|
-
```
|
|
859
|
+
This uses the org_id from the JWT
|
|
749
860
|
|
|
750
861
|
</dd>
|
|
751
862
|
</dl>
|
|
752
863
|
</dd>
|
|
753
864
|
</dl>
|
|
754
865
|
|
|
755
|
-
####
|
|
866
|
+
#### 🔌 Usage
|
|
756
867
|
|
|
757
868
|
<dl>
|
|
758
869
|
<dd>
|
|
@@ -760,15 +871,24 @@ await client.mirror.postOrderCompletedEmail({
|
|
|
760
871
|
<dl>
|
|
761
872
|
<dd>
|
|
762
873
|
|
|
763
|
-
|
|
874
|
+
```typescript
|
|
875
|
+
await client.oortHandles.getHandlesByOrgId();
|
|
876
|
+
```
|
|
764
877
|
|
|
765
878
|
</dd>
|
|
766
879
|
</dl>
|
|
880
|
+
</dd>
|
|
881
|
+
</dl>
|
|
882
|
+
|
|
883
|
+
#### ⚙️ Parameters
|
|
767
884
|
|
|
768
885
|
<dl>
|
|
769
886
|
<dd>
|
|
770
887
|
|
|
771
|
-
|
|
888
|
+
<dl>
|
|
889
|
+
<dd>
|
|
890
|
+
|
|
891
|
+
**requestOptions:** `OortHandles.RequestOptions`
|
|
772
892
|
|
|
773
893
|
</dd>
|
|
774
894
|
</dl>
|
|
@@ -779,10 +899,25 @@ await client.mirror.postOrderCompletedEmail({
|
|
|
779
899
|
</dl>
|
|
780
900
|
</details>
|
|
781
901
|
|
|
782
|
-
<details><summary><code>client.
|
|
902
|
+
<details><summary><code>client.oortHandles.<a href="/src/api/resources/oortHandles/client/Client.ts">getAvailability</a>(handle) -> boolean</code></summary>
|
|
903
|
+
<dl>
|
|
904
|
+
<dd>
|
|
905
|
+
|
|
906
|
+
#### 📝 Description
|
|
907
|
+
|
|
783
908
|
<dl>
|
|
784
909
|
<dd>
|
|
785
910
|
|
|
911
|
+
<dl>
|
|
912
|
+
<dd>
|
|
913
|
+
|
|
914
|
+
Check if a handle is available, returns true if it is, false if it is not
|
|
915
|
+
|
|
916
|
+
</dd>
|
|
917
|
+
</dl>
|
|
918
|
+
</dd>
|
|
919
|
+
</dl>
|
|
920
|
+
|
|
786
921
|
#### 🔌 Usage
|
|
787
922
|
|
|
788
923
|
<dl>
|
|
@@ -792,9 +927,7 @@ await client.mirror.postOrderCompletedEmail({
|
|
|
792
927
|
<dd>
|
|
793
928
|
|
|
794
929
|
```typescript
|
|
795
|
-
await client.
|
|
796
|
-
to: ["to"],
|
|
797
|
-
});
|
|
930
|
+
await client.oortHandles.getAvailability("handle");
|
|
798
931
|
```
|
|
799
932
|
|
|
800
933
|
</dd>
|
|
@@ -810,7 +943,7 @@ await client.mirror.postOrderInProgressEmail({
|
|
|
810
943
|
<dl>
|
|
811
944
|
<dd>
|
|
812
945
|
|
|
813
|
-
**
|
|
946
|
+
**handle:** `string`
|
|
814
947
|
|
|
815
948
|
</dd>
|
|
816
949
|
</dl>
|
|
@@ -818,7 +951,7 @@ await client.mirror.postOrderInProgressEmail({
|
|
|
818
951
|
<dl>
|
|
819
952
|
<dd>
|
|
820
953
|
|
|
821
|
-
**requestOptions:** `
|
|
954
|
+
**requestOptions:** `OortHandles.RequestOptions`
|
|
822
955
|
|
|
823
956
|
</dd>
|
|
824
957
|
</dl>
|
|
@@ -829,13 +962,11 @@ await client.mirror.postOrderInProgressEmail({
|
|
|
829
962
|
</dl>
|
|
830
963
|
</details>
|
|
831
964
|
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getDecodedJwt</a>() -> Chrt.DecodedJwtWithOrgAndUserId</code></summary>
|
|
965
|
+
<details><summary><code>client.oortHandles.<a href="/src/api/resources/oortHandles/client/Client.ts">createHandle</a>({ ...params }) -> boolean</code></summary>
|
|
835
966
|
<dl>
|
|
836
967
|
<dd>
|
|
837
968
|
|
|
838
|
-
####
|
|
969
|
+
#### 📝 Description
|
|
839
970
|
|
|
840
971
|
<dl>
|
|
841
972
|
<dd>
|
|
@@ -843,16 +974,14 @@ await client.mirror.postOrderInProgressEmail({
|
|
|
843
974
|
<dl>
|
|
844
975
|
<dd>
|
|
845
976
|
|
|
846
|
-
|
|
847
|
-
await client.dev.getDecodedJwt();
|
|
848
|
-
```
|
|
977
|
+
Create a new handle for an org
|
|
849
978
|
|
|
850
979
|
</dd>
|
|
851
980
|
</dl>
|
|
852
981
|
</dd>
|
|
853
982
|
</dl>
|
|
854
983
|
|
|
855
|
-
####
|
|
984
|
+
#### 🔌 Usage
|
|
856
985
|
|
|
857
986
|
<dl>
|
|
858
987
|
<dd>
|
|
@@ -860,22 +989,18 @@ await client.dev.getDecodedJwt();
|
|
|
860
989
|
<dl>
|
|
861
990
|
<dd>
|
|
862
991
|
|
|
863
|
-
|
|
992
|
+
```typescript
|
|
993
|
+
await client.oortHandles.createHandle({
|
|
994
|
+
handle: "handle",
|
|
995
|
+
});
|
|
996
|
+
```
|
|
864
997
|
|
|
865
998
|
</dd>
|
|
866
999
|
</dl>
|
|
867
1000
|
</dd>
|
|
868
1001
|
</dl>
|
|
869
1002
|
|
|
870
|
-
|
|
871
|
-
</dl>
|
|
872
|
-
</details>
|
|
873
|
-
|
|
874
|
-
<details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getEmail</a>() -> string</code></summary>
|
|
875
|
-
<dl>
|
|
876
|
-
<dd>
|
|
877
|
-
|
|
878
|
-
#### 🔌 Usage
|
|
1003
|
+
#### ⚙️ Parameters
|
|
879
1004
|
|
|
880
1005
|
<dl>
|
|
881
1006
|
<dd>
|
|
@@ -883,24 +1008,15 @@ await client.dev.getDecodedJwt();
|
|
|
883
1008
|
<dl>
|
|
884
1009
|
<dd>
|
|
885
1010
|
|
|
886
|
-
|
|
887
|
-
await client.dev.getEmail();
|
|
888
|
-
```
|
|
1011
|
+
**request:** `Chrt.HandlesReq`
|
|
889
1012
|
|
|
890
1013
|
</dd>
|
|
891
1014
|
</dl>
|
|
892
|
-
</dd>
|
|
893
|
-
</dl>
|
|
894
|
-
|
|
895
|
-
#### ⚙️ Parameters
|
|
896
|
-
|
|
897
|
-
<dl>
|
|
898
|
-
<dd>
|
|
899
1015
|
|
|
900
1016
|
<dl>
|
|
901
1017
|
<dd>
|
|
902
1018
|
|
|
903
|
-
**requestOptions:** `
|
|
1019
|
+
**requestOptions:** `OortHandles.RequestOptions`
|
|
904
1020
|
|
|
905
1021
|
</dd>
|
|
906
1022
|
</dl>
|
|
@@ -911,7 +1027,9 @@ await client.dev.getEmail();
|
|
|
911
1027
|
</dl>
|
|
912
1028
|
</details>
|
|
913
1029
|
|
|
914
|
-
|
|
1030
|
+
## OortMilestones
|
|
1031
|
+
|
|
1032
|
+
<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">postOortMilestonesUpdate</a>({ ...params }) -> boolean</code></summary>
|
|
915
1033
|
<dl>
|
|
916
1034
|
<dd>
|
|
917
1035
|
|
|
@@ -924,7 +1042,9 @@ await client.dev.getEmail();
|
|
|
924
1042
|
<dd>
|
|
925
1043
|
|
|
926
1044
|
```typescript
|
|
927
|
-
await client.
|
|
1045
|
+
await client.oortMilestones.postOortMilestonesUpdate({
|
|
1046
|
+
milestone_id: "milestone_id",
|
|
1047
|
+
});
|
|
928
1048
|
```
|
|
929
1049
|
|
|
930
1050
|
</dd>
|
|
@@ -940,7 +1060,15 @@ await client.dev.getTemplate();
|
|
|
940
1060
|
<dl>
|
|
941
1061
|
<dd>
|
|
942
1062
|
|
|
943
|
-
**
|
|
1063
|
+
**request:** `Chrt.MilestoneUpdateReq`
|
|
1064
|
+
|
|
1065
|
+
</dd>
|
|
1066
|
+
</dl>
|
|
1067
|
+
|
|
1068
|
+
<dl>
|
|
1069
|
+
<dd>
|
|
1070
|
+
|
|
1071
|
+
**requestOptions:** `OortMilestones.RequestOptions`
|
|
944
1072
|
|
|
945
1073
|
</dd>
|
|
946
1074
|
</dl>
|
|
@@ -951,7 +1079,7 @@ await client.dev.getTemplate();
|
|
|
951
1079
|
</dl>
|
|
952
1080
|
</details>
|
|
953
1081
|
|
|
954
|
-
<details><summary><code>client.
|
|
1082
|
+
<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">postOortMilestonesUploadImage</a>(image, milestoneId, { ...params }) -> boolean</code></summary>
|
|
955
1083
|
<dl>
|
|
956
1084
|
<dd>
|
|
957
1085
|
|
|
@@ -964,11 +1092,11 @@ await client.dev.getTemplate();
|
|
|
964
1092
|
<dd>
|
|
965
1093
|
|
|
966
1094
|
```typescript
|
|
967
|
-
await client.
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
1095
|
+
await client.oortMilestones.postOortMilestonesUploadImage(
|
|
1096
|
+
fs.createReadStream("/path/to/your/file"),
|
|
1097
|
+
"milestone_id",
|
|
1098
|
+
{},
|
|
1099
|
+
);
|
|
972
1100
|
```
|
|
973
1101
|
|
|
974
1102
|
</dd>
|
|
@@ -984,7 +1112,7 @@ await client.dev.postTemplate({
|
|
|
984
1112
|
<dl>
|
|
985
1113
|
<dd>
|
|
986
1114
|
|
|
987
|
-
**
|
|
1115
|
+
**image:** `File | fs.ReadStream | Blob`
|
|
988
1116
|
|
|
989
1117
|
</dd>
|
|
990
1118
|
</dl>
|
|
@@ -992,7 +1120,23 @@ await client.dev.postTemplate({
|
|
|
992
1120
|
<dl>
|
|
993
1121
|
<dd>
|
|
994
1122
|
|
|
995
|
-
**
|
|
1123
|
+
**milestoneId:** `string`
|
|
1124
|
+
|
|
1125
|
+
</dd>
|
|
1126
|
+
</dl>
|
|
1127
|
+
|
|
1128
|
+
<dl>
|
|
1129
|
+
<dd>
|
|
1130
|
+
|
|
1131
|
+
**request:** `Chrt.BodyPostOortMilestonesUploadImageOortMilestonesUploadImageMilestoneIdPost`
|
|
1132
|
+
|
|
1133
|
+
</dd>
|
|
1134
|
+
</dl>
|
|
1135
|
+
|
|
1136
|
+
<dl>
|
|
1137
|
+
<dd>
|
|
1138
|
+
|
|
1139
|
+
**requestOptions:** `OortMilestones.RequestOptions`
|
|
996
1140
|
|
|
997
1141
|
</dd>
|
|
998
1142
|
</dl>
|
|
@@ -1003,7 +1147,7 @@ await client.dev.postTemplate({
|
|
|
1003
1147
|
</dl>
|
|
1004
1148
|
</details>
|
|
1005
1149
|
|
|
1006
|
-
<details><summary><code>client.
|
|
1150
|
+
<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">getOortMilestonesImages</a>(milestoneS3ObjectMetadataId) -> unknown</code></summary>
|
|
1007
1151
|
<dl>
|
|
1008
1152
|
<dd>
|
|
1009
1153
|
|
|
@@ -1016,7 +1160,7 @@ await client.dev.postTemplate({
|
|
|
1016
1160
|
<dd>
|
|
1017
1161
|
|
|
1018
1162
|
```typescript
|
|
1019
|
-
await client.
|
|
1163
|
+
await client.oortMilestones.getOortMilestonesImages("milestone_s3_object_metadata_id");
|
|
1020
1164
|
```
|
|
1021
1165
|
|
|
1022
1166
|
</dd>
|
|
@@ -1032,7 +1176,15 @@ await client.dev.getUserId();
|
|
|
1032
1176
|
<dl>
|
|
1033
1177
|
<dd>
|
|
1034
1178
|
|
|
1035
|
-
**
|
|
1179
|
+
**milestoneS3ObjectMetadataId:** `string`
|
|
1180
|
+
|
|
1181
|
+
</dd>
|
|
1182
|
+
</dl>
|
|
1183
|
+
|
|
1184
|
+
<dl>
|
|
1185
|
+
<dd>
|
|
1186
|
+
|
|
1187
|
+
**requestOptions:** `OortMilestones.RequestOptions`
|
|
1036
1188
|
|
|
1037
1189
|
</dd>
|
|
1038
1190
|
</dl>
|
|
@@ -1043,9 +1195,7 @@ await client.dev.getUserId();
|
|
|
1043
1195
|
</dl>
|
|
1044
1196
|
</details>
|
|
1045
1197
|
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
<details><summary><code>client.directory.<a href="/src/api/resources/directory/client/Client.ts">postShippers</a>({ ...params }) -> Chrt.Shipper2[]</code></summary>
|
|
1198
|
+
<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">deleteOortMilestonesImage</a>(milestoneS3ObjectMetadataId) -> boolean</code></summary>
|
|
1049
1199
|
<dl>
|
|
1050
1200
|
<dd>
|
|
1051
1201
|
|
|
@@ -1057,7 +1207,7 @@ await client.dev.getUserId();
|
|
|
1057
1207
|
<dl>
|
|
1058
1208
|
<dd>
|
|
1059
1209
|
|
|
1060
|
-
|
|
1210
|
+
The `id` is the MilestoneS3ObjectMetadata1 id
|
|
1061
1211
|
|
|
1062
1212
|
</dd>
|
|
1063
1213
|
</dl>
|
|
@@ -1073,7 +1223,7 @@ Retrieve the full list of shippers with optional pagination and sorting
|
|
|
1073
1223
|
<dd>
|
|
1074
1224
|
|
|
1075
1225
|
```typescript
|
|
1076
|
-
await client.
|
|
1226
|
+
await client.oortMilestones.deleteOortMilestonesImage("milestone_s3_object_metadata_id");
|
|
1077
1227
|
```
|
|
1078
1228
|
|
|
1079
1229
|
</dd>
|
|
@@ -1089,7 +1239,7 @@ await client.directory.postShippers();
|
|
|
1089
1239
|
<dl>
|
|
1090
1240
|
<dd>
|
|
1091
1241
|
|
|
1092
|
-
**
|
|
1242
|
+
**milestoneS3ObjectMetadataId:** `string`
|
|
1093
1243
|
|
|
1094
1244
|
</dd>
|
|
1095
1245
|
</dl>
|
|
@@ -1097,7 +1247,7 @@ await client.directory.postShippers();
|
|
|
1097
1247
|
<dl>
|
|
1098
1248
|
<dd>
|
|
1099
1249
|
|
|
1100
|
-
**requestOptions:** `
|
|
1250
|
+
**requestOptions:** `OortMilestones.RequestOptions`
|
|
1101
1251
|
|
|
1102
1252
|
</dd>
|
|
1103
1253
|
</dl>
|
|
@@ -1108,9 +1258,9 @@ await client.directory.postShippers();
|
|
|
1108
1258
|
</dl>
|
|
1109
1259
|
</details>
|
|
1110
1260
|
|
|
1111
|
-
##
|
|
1261
|
+
## OortOrgProfiles
|
|
1112
1262
|
|
|
1113
|
-
<details><summary><code>client.
|
|
1263
|
+
<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">getProfileByHandle</a>(handle) -> Chrt.CourierOrgProfile3</code></summary>
|
|
1114
1264
|
<dl>
|
|
1115
1265
|
<dd>
|
|
1116
1266
|
|
|
@@ -1123,7 +1273,7 @@ await client.directory.postShippers();
|
|
|
1123
1273
|
<dd>
|
|
1124
1274
|
|
|
1125
1275
|
```typescript
|
|
1126
|
-
await client.
|
|
1276
|
+
await client.oortOrgProfiles.getProfileByHandle("handle");
|
|
1127
1277
|
```
|
|
1128
1278
|
|
|
1129
1279
|
</dd>
|
|
@@ -1139,7 +1289,15 @@ await client.oortConnections.getConnectionsInfoForCouriers();
|
|
|
1139
1289
|
<dl>
|
|
1140
1290
|
<dd>
|
|
1141
1291
|
|
|
1142
|
-
**
|
|
1292
|
+
**handle:** `string`
|
|
1293
|
+
|
|
1294
|
+
</dd>
|
|
1295
|
+
</dl>
|
|
1296
|
+
|
|
1297
|
+
<dl>
|
|
1298
|
+
<dd>
|
|
1299
|
+
|
|
1300
|
+
**requestOptions:** `OortOrgProfiles.RequestOptions`
|
|
1143
1301
|
|
|
1144
1302
|
</dd>
|
|
1145
1303
|
</dl>
|
|
@@ -1150,7 +1308,7 @@ await client.oortConnections.getConnectionsInfoForCouriers();
|
|
|
1150
1308
|
</dl>
|
|
1151
1309
|
</details>
|
|
1152
1310
|
|
|
1153
|
-
<details><summary><code>client.
|
|
1311
|
+
<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">getProfileByOrgId</a>() -> Chrt.CourierOrgProfile3</code></summary>
|
|
1154
1312
|
<dl>
|
|
1155
1313
|
<dd>
|
|
1156
1314
|
|
|
@@ -1163,7 +1321,7 @@ await client.oortConnections.getConnectionsInfoForCouriers();
|
|
|
1163
1321
|
<dd>
|
|
1164
1322
|
|
|
1165
1323
|
```typescript
|
|
1166
|
-
await client.
|
|
1324
|
+
await client.oortOrgProfiles.getProfileByOrgId();
|
|
1167
1325
|
```
|
|
1168
1326
|
|
|
1169
1327
|
</dd>
|
|
@@ -1179,7 +1337,7 @@ await client.oortConnections.getConnectionsInfoForShippers();
|
|
|
1179
1337
|
<dl>
|
|
1180
1338
|
<dd>
|
|
1181
1339
|
|
|
1182
|
-
**requestOptions:** `
|
|
1340
|
+
**requestOptions:** `OortOrgProfiles.RequestOptions`
|
|
1183
1341
|
|
|
1184
1342
|
</dd>
|
|
1185
1343
|
</dl>
|
|
@@ -1190,25 +1348,10 @@ await client.oortConnections.getConnectionsInfoForShippers();
|
|
|
1190
1348
|
</dl>
|
|
1191
1349
|
</details>
|
|
1192
1350
|
|
|
1193
|
-
<details><summary><code>client.
|
|
1194
|
-
<dl>
|
|
1195
|
-
<dd>
|
|
1196
|
-
|
|
1197
|
-
#### 📝 Description
|
|
1198
|
-
|
|
1199
|
-
<dl>
|
|
1200
|
-
<dd>
|
|
1201
|
-
|
|
1351
|
+
<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">postOrgProfile</a>({ ...params }) -> boolean</code></summary>
|
|
1202
1352
|
<dl>
|
|
1203
1353
|
<dd>
|
|
1204
1354
|
|
|
1205
|
-
Body: Courier Handle, Shipper Org Id from JWT
|
|
1206
|
-
|
|
1207
|
-
</dd>
|
|
1208
|
-
</dl>
|
|
1209
|
-
</dd>
|
|
1210
|
-
</dl>
|
|
1211
|
-
|
|
1212
1355
|
#### 🔌 Usage
|
|
1213
1356
|
|
|
1214
1357
|
<dl>
|
|
@@ -1218,8 +1361,11 @@ Body: Courier Handle, Shipper Org Id from JWT
|
|
|
1218
1361
|
<dd>
|
|
1219
1362
|
|
|
1220
1363
|
```typescript
|
|
1221
|
-
await client.
|
|
1222
|
-
|
|
1364
|
+
await client.oortOrgProfiles.postOrgProfile({
|
|
1365
|
+
schema_version: 1,
|
|
1366
|
+
description: "description",
|
|
1367
|
+
org_id: "org_id",
|
|
1368
|
+
company_name: "company_name",
|
|
1223
1369
|
});
|
|
1224
1370
|
```
|
|
1225
1371
|
|
|
@@ -1236,7 +1382,7 @@ await client.oortConnections.createConnectionToCourier({
|
|
|
1236
1382
|
<dl>
|
|
1237
1383
|
<dd>
|
|
1238
1384
|
|
|
1239
|
-
**request:** `Chrt.
|
|
1385
|
+
**request:** `Chrt.CourierOrgProfileClientCreate3`
|
|
1240
1386
|
|
|
1241
1387
|
</dd>
|
|
1242
1388
|
</dl>
|
|
@@ -1244,7 +1390,7 @@ await client.oortConnections.createConnectionToCourier({
|
|
|
1244
1390
|
<dl>
|
|
1245
1391
|
<dd>
|
|
1246
1392
|
|
|
1247
|
-
**requestOptions:** `
|
|
1393
|
+
**requestOptions:** `OortOrgProfiles.RequestOptions`
|
|
1248
1394
|
|
|
1249
1395
|
</dd>
|
|
1250
1396
|
</dl>
|
|
@@ -1255,9 +1401,9 @@ await client.oortConnections.createConnectionToCourier({
|
|
|
1255
1401
|
</dl>
|
|
1256
1402
|
</details>
|
|
1257
1403
|
|
|
1258
|
-
##
|
|
1404
|
+
## OortOrders
|
|
1259
1405
|
|
|
1260
|
-
<details><summary><code>client.
|
|
1406
|
+
<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.GetOrderRes</code></summary>
|
|
1261
1407
|
<dl>
|
|
1262
1408
|
<dd>
|
|
1263
1409
|
|
|
@@ -1269,7 +1415,7 @@ await client.oortConnections.createConnectionToCourier({
|
|
|
1269
1415
|
<dl>
|
|
1270
1416
|
<dd>
|
|
1271
1417
|
|
|
1272
|
-
|
|
1418
|
+
Accepts both order_id and order_short_id values and returns the Order
|
|
1273
1419
|
|
|
1274
1420
|
</dd>
|
|
1275
1421
|
</dl>
|
|
@@ -1285,7 +1431,7 @@ This is for getting a list of all rate sheets by courier org id from the JWT
|
|
|
1285
1431
|
<dd>
|
|
1286
1432
|
|
|
1287
1433
|
```typescript
|
|
1288
|
-
await client.
|
|
1434
|
+
await client.oortOrders.getOortOrdersOrderIdOrShortId("order_id_or_short_id");
|
|
1289
1435
|
```
|
|
1290
1436
|
|
|
1291
1437
|
</dd>
|
|
@@ -1301,7 +1447,15 @@ await client.oortCourierPayDriverRate.getRateSheetsByCourierOrgId();
|
|
|
1301
1447
|
<dl>
|
|
1302
1448
|
<dd>
|
|
1303
1449
|
|
|
1304
|
-
**
|
|
1450
|
+
**orderIdOrShortId:** `string`
|
|
1451
|
+
|
|
1452
|
+
</dd>
|
|
1453
|
+
</dl>
|
|
1454
|
+
|
|
1455
|
+
<dl>
|
|
1456
|
+
<dd>
|
|
1457
|
+
|
|
1458
|
+
**requestOptions:** `OortOrders.RequestOptions`
|
|
1305
1459
|
|
|
1306
1460
|
</dd>
|
|
1307
1461
|
</dl>
|
|
@@ -1312,7 +1466,7 @@ await client.oortCourierPayDriverRate.getRateSheetsByCourierOrgId();
|
|
|
1312
1466
|
</dl>
|
|
1313
1467
|
</details>
|
|
1314
1468
|
|
|
1315
|
-
<details><summary><code>client.
|
|
1469
|
+
<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersOrderIdOrShortIdFull</a>(orderIdOrShortId) -> Chrt.GetOrderFullRes</code></summary>
|
|
1316
1470
|
<dl>
|
|
1317
1471
|
<dd>
|
|
1318
1472
|
|
|
@@ -1324,7 +1478,7 @@ await client.oortCourierPayDriverRate.getRateSheetsByCourierOrgId();
|
|
|
1324
1478
|
<dl>
|
|
1325
1479
|
<dd>
|
|
1326
1480
|
|
|
1327
|
-
|
|
1481
|
+
Accepts both order_id and order_short_id values and returns the Order with all its Task Groups, Tasks, Milestones, and Cargos
|
|
1328
1482
|
|
|
1329
1483
|
</dd>
|
|
1330
1484
|
</dl>
|
|
@@ -1340,7 +1494,7 @@ Get a rate sheet by driver ID, courier org id from JWT
|
|
|
1340
1494
|
<dd>
|
|
1341
1495
|
|
|
1342
1496
|
```typescript
|
|
1343
|
-
await client.
|
|
1497
|
+
await client.oortOrders.getOortOrdersOrderIdOrShortIdFull("order_id_or_short_id");
|
|
1344
1498
|
```
|
|
1345
1499
|
|
|
1346
1500
|
</dd>
|
|
@@ -1356,7 +1510,7 @@ await client.oortCourierPayDriverRate.getRateSheetByDriverId("driver_id");
|
|
|
1356
1510
|
<dl>
|
|
1357
1511
|
<dd>
|
|
1358
1512
|
|
|
1359
|
-
**
|
|
1513
|
+
**orderIdOrShortId:** `string`
|
|
1360
1514
|
|
|
1361
1515
|
</dd>
|
|
1362
1516
|
</dl>
|
|
@@ -1364,7 +1518,7 @@ await client.oortCourierPayDriverRate.getRateSheetByDriverId("driver_id");
|
|
|
1364
1518
|
<dl>
|
|
1365
1519
|
<dd>
|
|
1366
1520
|
|
|
1367
|
-
**requestOptions:** `
|
|
1521
|
+
**requestOptions:** `OortOrders.RequestOptions`
|
|
1368
1522
|
|
|
1369
1523
|
</dd>
|
|
1370
1524
|
</dl>
|
|
@@ -1375,26 +1529,11 @@ await client.oortCourierPayDriverRate.getRateSheetByDriverId("driver_id");
|
|
|
1375
1529
|
</dl>
|
|
1376
1530
|
</details>
|
|
1377
1531
|
|
|
1378
|
-
<details><summary><code>client.
|
|
1532
|
+
<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">postOortOrdersCreate</a>({ ...params }) -> Chrt.CreateOrderRes</code></summary>
|
|
1379
1533
|
<dl>
|
|
1380
1534
|
<dd>
|
|
1381
1535
|
|
|
1382
|
-
####
|
|
1383
|
-
|
|
1384
|
-
<dl>
|
|
1385
|
-
<dd>
|
|
1386
|
-
|
|
1387
|
-
<dl>
|
|
1388
|
-
<dd>
|
|
1389
|
-
|
|
1390
|
-
This is for getting a list of all rate sheets by shipper org id from the JWT
|
|
1391
|
-
|
|
1392
|
-
</dd>
|
|
1393
|
-
</dl>
|
|
1394
|
-
</dd>
|
|
1395
|
-
</dl>
|
|
1396
|
-
|
|
1397
|
-
#### 🔌 Usage
|
|
1536
|
+
#### 🔌 Usage
|
|
1398
1537
|
|
|
1399
1538
|
<dl>
|
|
1400
1539
|
<dd>
|
|
@@ -1403,7 +1542,29 @@ This is for getting a list of all rate sheets by shipper org id from the JWT
|
|
|
1403
1542
|
<dd>
|
|
1404
1543
|
|
|
1405
1544
|
```typescript
|
|
1406
|
-
await client.
|
|
1545
|
+
await client.oortOrders.postOortOrdersCreate({
|
|
1546
|
+
order_client_create: {
|
|
1547
|
+
schema_version: 1,
|
|
1548
|
+
},
|
|
1549
|
+
task_client_creates_bundle_groupings: [
|
|
1550
|
+
[
|
|
1551
|
+
{
|
|
1552
|
+
task_client_create: {
|
|
1553
|
+
schema_version: 1,
|
|
1554
|
+
},
|
|
1555
|
+
},
|
|
1556
|
+
],
|
|
1557
|
+
],
|
|
1558
|
+
cargo_client_creates_map: {
|
|
1559
|
+
key: {
|
|
1560
|
+
schema_version: 1,
|
|
1561
|
+
cargo_type: "spare_parts",
|
|
1562
|
+
},
|
|
1563
|
+
},
|
|
1564
|
+
order_created_by_type: "chrt",
|
|
1565
|
+
order_dispatch_type: "dtc",
|
|
1566
|
+
transport_type: "ground_only",
|
|
1567
|
+
});
|
|
1407
1568
|
```
|
|
1408
1569
|
|
|
1409
1570
|
</dd>
|
|
@@ -1419,7 +1580,15 @@ await client.oortCourierPayDriverRate.getRateSheetsByShipperOrgId();
|
|
|
1419
1580
|
<dl>
|
|
1420
1581
|
<dd>
|
|
1421
1582
|
|
|
1422
|
-
**
|
|
1583
|
+
**request:** `Chrt.CreateOrderReq`
|
|
1584
|
+
|
|
1585
|
+
</dd>
|
|
1586
|
+
</dl>
|
|
1587
|
+
|
|
1588
|
+
<dl>
|
|
1589
|
+
<dd>
|
|
1590
|
+
|
|
1591
|
+
**requestOptions:** `OortOrders.RequestOptions`
|
|
1423
1592
|
|
|
1424
1593
|
</dd>
|
|
1425
1594
|
</dl>
|
|
@@ -1430,7 +1599,7 @@ await client.oortCourierPayDriverRate.getRateSheetsByShipperOrgId();
|
|
|
1430
1599
|
</dl>
|
|
1431
1600
|
</details>
|
|
1432
1601
|
|
|
1433
|
-
<details><summary><code>client.
|
|
1602
|
+
<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersListByShipperOrgId</a>() -> Chrt.Order1[]</code></summary>
|
|
1434
1603
|
<dl>
|
|
1435
1604
|
<dd>
|
|
1436
1605
|
|
|
@@ -1442,7 +1611,7 @@ await client.oortCourierPayDriverRate.getRateSheetsByShipperOrgId();
|
|
|
1442
1611
|
<dl>
|
|
1443
1612
|
<dd>
|
|
1444
1613
|
|
|
1445
|
-
|
|
1614
|
+
Uses the org_id from the JWT
|
|
1446
1615
|
|
|
1447
1616
|
</dd>
|
|
1448
1617
|
</dl>
|
|
@@ -1458,23 +1627,7 @@ This is for creating a rate sheet
|
|
|
1458
1627
|
<dd>
|
|
1459
1628
|
|
|
1460
1629
|
```typescript
|
|
1461
|
-
await client.
|
|
1462
|
-
additional_mileage_rate_usd_per_mile: 1.1,
|
|
1463
|
-
after_hours: 1.1,
|
|
1464
|
-
base_mileage_distance_miles: 1.1,
|
|
1465
|
-
base_mileage_rate_usd_per_instance: 1.1,
|
|
1466
|
-
courier_org_id: "courier_org_id",
|
|
1467
|
-
dangerous_goods_rate_usd_per_instance: 1.1,
|
|
1468
|
-
extra_stop_rate_usd: 1.1,
|
|
1469
|
-
fuel_surchage_rate_usd_per_mile: 1.1,
|
|
1470
|
-
holiday: 1.1,
|
|
1471
|
-
long_distance_surcharge_miles_before_surcharge: 1.1,
|
|
1472
|
-
long_distance_surcharge_rate_usd_per_mile: 1.1,
|
|
1473
|
-
schema_version: 1,
|
|
1474
|
-
wait_time_before_charge_minutes: 1.1,
|
|
1475
|
-
wait_time_rate_usd_per_minute: 1.1,
|
|
1476
|
-
weekend: 1.1,
|
|
1477
|
-
});
|
|
1630
|
+
await client.oortOrders.getOortOrdersListByShipperOrgId();
|
|
1478
1631
|
```
|
|
1479
1632
|
|
|
1480
1633
|
</dd>
|
|
@@ -1490,15 +1643,7 @@ await client.oortCourierPayDriverRate.postCreateRateSheet({
|
|
|
1490
1643
|
<dl>
|
|
1491
1644
|
<dd>
|
|
1492
1645
|
|
|
1493
|
-
**
|
|
1494
|
-
|
|
1495
|
-
</dd>
|
|
1496
|
-
</dl>
|
|
1497
|
-
|
|
1498
|
-
<dl>
|
|
1499
|
-
<dd>
|
|
1500
|
-
|
|
1501
|
-
**requestOptions:** `OortCourierPayDriverRate.RequestOptions`
|
|
1646
|
+
**requestOptions:** `OortOrders.RequestOptions`
|
|
1502
1647
|
|
|
1503
1648
|
</dd>
|
|
1504
1649
|
</dl>
|
|
@@ -1509,13 +1654,11 @@ await client.oortCourierPayDriverRate.postCreateRateSheet({
|
|
|
1509
1654
|
</dl>
|
|
1510
1655
|
</details>
|
|
1511
1656
|
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
<details><summary><code>client.oortDrivers.<a href="/src/api/resources/oortDrivers/client/Client.ts">getOortDriversByDriverId</a>(driverId) -> Chrt.Driver1</code></summary>
|
|
1657
|
+
<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersListByShipperOrgIdFull</a>() -> Chrt.GetOrderFullRes[]</code></summary>
|
|
1515
1658
|
<dl>
|
|
1516
1659
|
<dd>
|
|
1517
1660
|
|
|
1518
|
-
####
|
|
1661
|
+
#### 📝 Description
|
|
1519
1662
|
|
|
1520
1663
|
<dl>
|
|
1521
1664
|
<dd>
|
|
@@ -1523,16 +1666,14 @@ await client.oortCourierPayDriverRate.postCreateRateSheet({
|
|
|
1523
1666
|
<dl>
|
|
1524
1667
|
<dd>
|
|
1525
1668
|
|
|
1526
|
-
|
|
1527
|
-
await client.oortDrivers.getOortDriversByDriverId("driver_id");
|
|
1528
|
-
```
|
|
1669
|
+
Uses the org_id from the JWT
|
|
1529
1670
|
|
|
1530
1671
|
</dd>
|
|
1531
1672
|
</dl>
|
|
1532
1673
|
</dd>
|
|
1533
1674
|
</dl>
|
|
1534
1675
|
|
|
1535
|
-
####
|
|
1676
|
+
#### 🔌 Usage
|
|
1536
1677
|
|
|
1537
1678
|
<dl>
|
|
1538
1679
|
<dd>
|
|
@@ -1540,15 +1681,24 @@ await client.oortDrivers.getOortDriversByDriverId("driver_id");
|
|
|
1540
1681
|
<dl>
|
|
1541
1682
|
<dd>
|
|
1542
1683
|
|
|
1543
|
-
|
|
1684
|
+
```typescript
|
|
1685
|
+
await client.oortOrders.getOortOrdersListByShipperOrgIdFull();
|
|
1686
|
+
```
|
|
1544
1687
|
|
|
1545
1688
|
</dd>
|
|
1546
1689
|
</dl>
|
|
1690
|
+
</dd>
|
|
1691
|
+
</dl>
|
|
1692
|
+
|
|
1693
|
+
#### ⚙️ Parameters
|
|
1547
1694
|
|
|
1548
1695
|
<dl>
|
|
1549
1696
|
<dd>
|
|
1550
1697
|
|
|
1551
|
-
|
|
1698
|
+
<dl>
|
|
1699
|
+
<dd>
|
|
1700
|
+
|
|
1701
|
+
**requestOptions:** `OortOrders.RequestOptions`
|
|
1552
1702
|
|
|
1553
1703
|
</dd>
|
|
1554
1704
|
</dl>
|
|
@@ -1559,7 +1709,7 @@ await client.oortDrivers.getOortDriversByDriverId("driver_id");
|
|
|
1559
1709
|
</dl>
|
|
1560
1710
|
</details>
|
|
1561
1711
|
|
|
1562
|
-
<details><summary><code>client.
|
|
1712
|
+
<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">getOortOrdersListByCourierOrgId</a>() -> Chrt.Order1[]</code></summary>
|
|
1563
1713
|
<dl>
|
|
1564
1714
|
<dd>
|
|
1565
1715
|
|
|
@@ -1571,7 +1721,7 @@ await client.oortDrivers.getOortDriversByDriverId("driver_id");
|
|
|
1571
1721
|
<dl>
|
|
1572
1722
|
<dd>
|
|
1573
1723
|
|
|
1574
|
-
Uses
|
|
1724
|
+
Uses the org_id from the JWT
|
|
1575
1725
|
|
|
1576
1726
|
</dd>
|
|
1577
1727
|
</dl>
|
|
@@ -1587,7 +1737,7 @@ Uses user_id from the JWT. (originally included for use by Pytest)
|
|
|
1587
1737
|
<dd>
|
|
1588
1738
|
|
|
1589
1739
|
```typescript
|
|
1590
|
-
await client.
|
|
1740
|
+
await client.oortOrders.getOortOrdersListByCourierOrgId();
|
|
1591
1741
|
```
|
|
1592
1742
|
|
|
1593
1743
|
</dd>
|
|
@@ -1603,7 +1753,7 @@ await client.oortDrivers.getOortDriversByUserId();
|
|
|
1603
1753
|
<dl>
|
|
1604
1754
|
<dd>
|
|
1605
1755
|
|
|
1606
|
-
**requestOptions:** `
|
|
1756
|
+
**requestOptions:** `OortOrders.RequestOptions`
|
|
1607
1757
|
|
|
1608
1758
|
</dd>
|
|
1609
1759
|
</dl>
|
|
@@ -1614,10 +1764,27 @@ await client.oortDrivers.getOortDriversByUserId();
|
|
|
1614
1764
|
</dl>
|
|
1615
1765
|
</details>
|
|
1616
1766
|
|
|
1617
|
-
|
|
1767
|
+
## OortRateSheets
|
|
1768
|
+
|
|
1769
|
+
<details><summary><code>client.oortRateSheets.<a href="/src/api/resources/oortRateSheets/client/Client.ts">postCreateRateSheet</a>({ ...params }) -> string</code></summary>
|
|
1770
|
+
<dl>
|
|
1771
|
+
<dd>
|
|
1772
|
+
|
|
1773
|
+
#### 📝 Description
|
|
1774
|
+
|
|
1618
1775
|
<dl>
|
|
1619
1776
|
<dd>
|
|
1620
1777
|
|
|
1778
|
+
<dl>
|
|
1779
|
+
<dd>
|
|
1780
|
+
|
|
1781
|
+
This is for creating a rate sheet
|
|
1782
|
+
|
|
1783
|
+
</dd>
|
|
1784
|
+
</dl>
|
|
1785
|
+
</dd>
|
|
1786
|
+
</dl>
|
|
1787
|
+
|
|
1621
1788
|
#### 🔌 Usage
|
|
1622
1789
|
|
|
1623
1790
|
<dl>
|
|
@@ -1627,11 +1794,21 @@ await client.oortDrivers.getOortDriversByUserId();
|
|
|
1627
1794
|
<dd>
|
|
1628
1795
|
|
|
1629
1796
|
```typescript
|
|
1630
|
-
await client.
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1797
|
+
await client.oortRateSheets.postCreateRateSheet({
|
|
1798
|
+
schema_version: 1,
|
|
1799
|
+
base_mileage_distance_miles: 1.1,
|
|
1800
|
+
base_mileage_rate_usd_per_instance: 1.1,
|
|
1801
|
+
additional_mileage_rate_usd_per_mile: 1.1,
|
|
1802
|
+
long_distance_surcharge_miles_before_surcharge: 1.1,
|
|
1803
|
+
long_distance_surcharge_rate_usd_per_mile: 1.1,
|
|
1804
|
+
fuel_surchage_rate_usd_per_mile: 1.1,
|
|
1805
|
+
wait_time_before_charge_minutes: 1.1,
|
|
1806
|
+
wait_time_rate_usd_per_minute: 1.1,
|
|
1807
|
+
extra_stop_rate_usd: 1.1,
|
|
1808
|
+
dangerous_goods_rate_usd_per_instance: 1.1,
|
|
1809
|
+
after_hours: 1.1,
|
|
1810
|
+
weekend: 1.1,
|
|
1811
|
+
holiday: 1.1,
|
|
1635
1812
|
});
|
|
1636
1813
|
```
|
|
1637
1814
|
|
|
@@ -1648,7 +1825,7 @@ await client.oortDrivers.postOortDriversCreate({
|
|
|
1648
1825
|
<dl>
|
|
1649
1826
|
<dd>
|
|
1650
1827
|
|
|
1651
|
-
**request:** `Chrt.
|
|
1828
|
+
**request:** `Chrt.RateSheetClientCreate1`
|
|
1652
1829
|
|
|
1653
1830
|
</dd>
|
|
1654
1831
|
</dl>
|
|
@@ -1656,7 +1833,7 @@ await client.oortDrivers.postOortDriversCreate({
|
|
|
1656
1833
|
<dl>
|
|
1657
1834
|
<dd>
|
|
1658
1835
|
|
|
1659
|
-
**requestOptions:** `
|
|
1836
|
+
**requestOptions:** `OortRateSheets.RequestOptions`
|
|
1660
1837
|
|
|
1661
1838
|
</dd>
|
|
1662
1839
|
</dl>
|
|
@@ -1667,11 +1844,11 @@ await client.oortDrivers.postOortDriversCreate({
|
|
|
1667
1844
|
</dl>
|
|
1668
1845
|
</details>
|
|
1669
1846
|
|
|
1670
|
-
<details><summary><code>client.
|
|
1847
|
+
<details><summary><code>client.oortRateSheets.<a href="/src/api/resources/oortRateSheets/client/Client.ts">getRateSheetsByShipperOrgId</a>() -> Chrt.RateSheet1[]</code></summary>
|
|
1671
1848
|
<dl>
|
|
1672
1849
|
<dd>
|
|
1673
1850
|
|
|
1674
|
-
####
|
|
1851
|
+
#### 📝 Description
|
|
1675
1852
|
|
|
1676
1853
|
<dl>
|
|
1677
1854
|
<dd>
|
|
@@ -1679,20 +1856,14 @@ await client.oortDrivers.postOortDriversCreate({
|
|
|
1679
1856
|
<dl>
|
|
1680
1857
|
<dd>
|
|
1681
1858
|
|
|
1682
|
-
|
|
1683
|
-
await client.oortDrivers.postOortDriversLastSeen({
|
|
1684
|
-
location: {
|
|
1685
|
-
type: "Feature",
|
|
1686
|
-
},
|
|
1687
|
-
});
|
|
1688
|
-
```
|
|
1859
|
+
This is for getting a list of all rate sheets by shipper org id from the JWT
|
|
1689
1860
|
|
|
1690
1861
|
</dd>
|
|
1691
1862
|
</dl>
|
|
1692
1863
|
</dd>
|
|
1693
1864
|
</dl>
|
|
1694
1865
|
|
|
1695
|
-
####
|
|
1866
|
+
#### 🔌 Usage
|
|
1696
1867
|
|
|
1697
1868
|
<dl>
|
|
1698
1869
|
<dd>
|
|
@@ -1700,15 +1871,24 @@ await client.oortDrivers.postOortDriversLastSeen({
|
|
|
1700
1871
|
<dl>
|
|
1701
1872
|
<dd>
|
|
1702
1873
|
|
|
1703
|
-
|
|
1874
|
+
```typescript
|
|
1875
|
+
await client.oortRateSheets.getRateSheetsByShipperOrgId();
|
|
1876
|
+
```
|
|
1704
1877
|
|
|
1705
1878
|
</dd>
|
|
1706
1879
|
</dl>
|
|
1880
|
+
</dd>
|
|
1881
|
+
</dl>
|
|
1882
|
+
|
|
1883
|
+
#### ⚙️ Parameters
|
|
1707
1884
|
|
|
1708
1885
|
<dl>
|
|
1709
1886
|
<dd>
|
|
1710
1887
|
|
|
1711
|
-
|
|
1888
|
+
<dl>
|
|
1889
|
+
<dd>
|
|
1890
|
+
|
|
1891
|
+
**requestOptions:** `OortRateSheets.RequestOptions`
|
|
1712
1892
|
|
|
1713
1893
|
</dd>
|
|
1714
1894
|
</dl>
|
|
@@ -1719,11 +1899,13 @@ await client.oortDrivers.postOortDriversLastSeen({
|
|
|
1719
1899
|
</dl>
|
|
1720
1900
|
</details>
|
|
1721
1901
|
|
|
1722
|
-
|
|
1902
|
+
## OortRoutes
|
|
1903
|
+
|
|
1904
|
+
<details><summary><code>client.oortRoutes.<a href="/src/api/resources/oortRoutes/client/Client.ts">getRoutesListByDriverId</a>(driverId) -> Chrt.Route1[]</code></summary>
|
|
1723
1905
|
<dl>
|
|
1724
1906
|
<dd>
|
|
1725
1907
|
|
|
1726
|
-
####
|
|
1908
|
+
#### 🔌 Usage
|
|
1727
1909
|
|
|
1728
1910
|
<dl>
|
|
1729
1911
|
<dd>
|
|
@@ -1731,14 +1913,16 @@ await client.oortDrivers.postOortDriversLastSeen({
|
|
|
1731
1913
|
<dl>
|
|
1732
1914
|
<dd>
|
|
1733
1915
|
|
|
1734
|
-
|
|
1916
|
+
```typescript
|
|
1917
|
+
await client.oortRoutes.getRoutesListByDriverId("driver_id");
|
|
1918
|
+
```
|
|
1735
1919
|
|
|
1736
1920
|
</dd>
|
|
1737
1921
|
</dl>
|
|
1738
1922
|
</dd>
|
|
1739
1923
|
</dl>
|
|
1740
1924
|
|
|
1741
|
-
####
|
|
1925
|
+
#### ⚙️ Parameters
|
|
1742
1926
|
|
|
1743
1927
|
<dl>
|
|
1744
1928
|
<dd>
|
|
@@ -1746,24 +1930,15 @@ Used org_id from the JWT
|
|
|
1746
1930
|
<dl>
|
|
1747
1931
|
<dd>
|
|
1748
1932
|
|
|
1749
|
-
|
|
1750
|
-
await client.oortDrivers.getOortDriversByOrgId();
|
|
1751
|
-
```
|
|
1933
|
+
**driverId:** `string`
|
|
1752
1934
|
|
|
1753
1935
|
</dd>
|
|
1754
1936
|
</dl>
|
|
1755
|
-
</dd>
|
|
1756
|
-
</dl>
|
|
1757
|
-
|
|
1758
|
-
#### ⚙️ Parameters
|
|
1759
1937
|
|
|
1760
1938
|
<dl>
|
|
1761
1939
|
<dd>
|
|
1762
1940
|
|
|
1763
|
-
|
|
1764
|
-
<dd>
|
|
1765
|
-
|
|
1766
|
-
**requestOptions:** `OortDrivers.RequestOptions`
|
|
1941
|
+
**requestOptions:** `OortRoutes.RequestOptions`
|
|
1767
1942
|
|
|
1768
1943
|
</dd>
|
|
1769
1944
|
</dl>
|
|
@@ -1774,11 +1949,11 @@ await client.oortDrivers.getOortDriversByOrgId();
|
|
|
1774
1949
|
</dl>
|
|
1775
1950
|
</details>
|
|
1776
1951
|
|
|
1777
|
-
<details><summary><code>client.
|
|
1952
|
+
<details><summary><code>client.oortRoutes.<a href="/src/api/resources/oortRoutes/client/Client.ts">getOortRoutesListByOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.Route1[]</code></summary>
|
|
1778
1953
|
<dl>
|
|
1779
1954
|
<dd>
|
|
1780
1955
|
|
|
1781
|
-
####
|
|
1956
|
+
#### 🔌 Usage
|
|
1782
1957
|
|
|
1783
1958
|
<dl>
|
|
1784
1959
|
<dd>
|
|
@@ -1786,14 +1961,16 @@ await client.oortDrivers.getOortDriversByOrgId();
|
|
|
1786
1961
|
<dl>
|
|
1787
1962
|
<dd>
|
|
1788
1963
|
|
|
1789
|
-
|
|
1964
|
+
```typescript
|
|
1965
|
+
await client.oortRoutes.getOortRoutesListByOrderIdOrShortId("order_id_or_short_id");
|
|
1966
|
+
```
|
|
1790
1967
|
|
|
1791
1968
|
</dd>
|
|
1792
1969
|
</dl>
|
|
1793
1970
|
</dd>
|
|
1794
1971
|
</dl>
|
|
1795
1972
|
|
|
1796
|
-
####
|
|
1973
|
+
#### ⚙️ Parameters
|
|
1797
1974
|
|
|
1798
1975
|
<dl>
|
|
1799
1976
|
<dd>
|
|
@@ -1801,24 +1978,15 @@ Uses the org_id from the JWT
|
|
|
1801
1978
|
<dl>
|
|
1802
1979
|
<dd>
|
|
1803
1980
|
|
|
1804
|
-
|
|
1805
|
-
await client.oortDrivers.getOortDriversListOrgMembersAndDrivers();
|
|
1806
|
-
```
|
|
1981
|
+
**orderIdOrShortId:** `string`
|
|
1807
1982
|
|
|
1808
1983
|
</dd>
|
|
1809
1984
|
</dl>
|
|
1810
|
-
</dd>
|
|
1811
|
-
</dl>
|
|
1812
|
-
|
|
1813
|
-
#### ⚙️ Parameters
|
|
1814
1985
|
|
|
1815
1986
|
<dl>
|
|
1816
1987
|
<dd>
|
|
1817
1988
|
|
|
1818
|
-
|
|
1819
|
-
<dd>
|
|
1820
|
-
|
|
1821
|
-
**requestOptions:** `OortDrivers.RequestOptions`
|
|
1989
|
+
**requestOptions:** `OortRoutes.RequestOptions`
|
|
1822
1990
|
|
|
1823
1991
|
</dd>
|
|
1824
1992
|
</dl>
|
|
@@ -1829,7 +1997,7 @@ await client.oortDrivers.getOortDriversListOrgMembersAndDrivers();
|
|
|
1829
1997
|
</dl>
|
|
1830
1998
|
</details>
|
|
1831
1999
|
|
|
1832
|
-
<details><summary><code>client.
|
|
2000
|
+
<details><summary><code>client.oortRoutes.<a href="/src/api/resources/oortRoutes/client/Client.ts">getRoutesListByCourierOrgId</a>() -> Chrt.Route1[]</code></summary>
|
|
1833
2001
|
<dl>
|
|
1834
2002
|
<dd>
|
|
1835
2003
|
|
|
@@ -1841,8 +2009,7 @@ await client.oortDrivers.getOortDriversListOrgMembersAndDrivers();
|
|
|
1841
2009
|
<dl>
|
|
1842
2010
|
<dd>
|
|
1843
2011
|
|
|
1844
|
-
|
|
1845
|
-
This route is idempotent - setting a driver to their current status is allowed.
|
|
2012
|
+
Uses the org_id from the JWT
|
|
1846
2013
|
|
|
1847
2014
|
</dd>
|
|
1848
2015
|
</dl>
|
|
@@ -1858,10 +2025,7 @@ This route is idempotent - setting a driver to their current status is allowed.
|
|
|
1858
2025
|
<dd>
|
|
1859
2026
|
|
|
1860
2027
|
```typescript
|
|
1861
|
-
await client.
|
|
1862
|
-
active: true,
|
|
1863
|
-
driver_object_id: "driver_object_id",
|
|
1864
|
-
});
|
|
2028
|
+
await client.oortRoutes.getRoutesListByCourierOrgId();
|
|
1865
2029
|
```
|
|
1866
2030
|
|
|
1867
2031
|
</dd>
|
|
@@ -1877,15 +2041,7 @@ await client.oortDrivers.postOortDriversSetActivation({
|
|
|
1877
2041
|
<dl>
|
|
1878
2042
|
<dd>
|
|
1879
2043
|
|
|
1880
|
-
**
|
|
1881
|
-
|
|
1882
|
-
</dd>
|
|
1883
|
-
</dl>
|
|
1884
|
-
|
|
1885
|
-
<dl>
|
|
1886
|
-
<dd>
|
|
1887
|
-
|
|
1888
|
-
**requestOptions:** `OortDrivers.RequestOptions`
|
|
2044
|
+
**requestOptions:** `OortRoutes.RequestOptions`
|
|
1889
2045
|
|
|
1890
2046
|
</dd>
|
|
1891
2047
|
</dl>
|
|
@@ -1896,7 +2052,7 @@ await client.oortDrivers.postOortDriversSetActivation({
|
|
|
1896
2052
|
</dl>
|
|
1897
2053
|
</details>
|
|
1898
2054
|
|
|
1899
|
-
<details><summary><code>client.
|
|
2055
|
+
<details><summary><code>client.oortRoutes.<a href="/src/api/resources/oortRoutes/client/Client.ts">postOortRoutesUpdate</a>({ ...params }) -> Chrt.UpdateRouteRes</code></summary>
|
|
1900
2056
|
<dl>
|
|
1901
2057
|
<dd>
|
|
1902
2058
|
|
|
@@ -1909,8 +2065,8 @@ await client.oortDrivers.postOortDriversSetActivation({
|
|
|
1909
2065
|
<dd>
|
|
1910
2066
|
|
|
1911
2067
|
```typescript
|
|
1912
|
-
await client.
|
|
1913
|
-
|
|
2068
|
+
await client.oortRoutes.postOortRoutesUpdate({
|
|
2069
|
+
route_id: "route_id",
|
|
1914
2070
|
});
|
|
1915
2071
|
```
|
|
1916
2072
|
|
|
@@ -1927,7 +2083,7 @@ await client.oortDrivers.putOortDriversUpdateDriverDetails({
|
|
|
1927
2083
|
<dl>
|
|
1928
2084
|
<dd>
|
|
1929
2085
|
|
|
1930
|
-
**request:** `Chrt.
|
|
2086
|
+
**request:** `Chrt.UpdateRouteReq`
|
|
1931
2087
|
|
|
1932
2088
|
</dd>
|
|
1933
2089
|
</dl>
|
|
@@ -1935,7 +2091,7 @@ await client.oortDrivers.putOortDriversUpdateDriverDetails({
|
|
|
1935
2091
|
<dl>
|
|
1936
2092
|
<dd>
|
|
1937
2093
|
|
|
1938
|
-
**requestOptions:** `
|
|
2094
|
+
**requestOptions:** `OortRoutes.RequestOptions`
|
|
1939
2095
|
|
|
1940
2096
|
</dd>
|
|
1941
2097
|
</dl>
|
|
@@ -1946,25 +2102,10 @@ await client.oortDrivers.putOortDriversUpdateDriverDetails({
|
|
|
1946
2102
|
</dl>
|
|
1947
2103
|
</details>
|
|
1948
2104
|
|
|
1949
|
-
<details><summary><code>client.
|
|
1950
|
-
<dl>
|
|
1951
|
-
<dd>
|
|
1952
|
-
|
|
1953
|
-
#### 📝 Description
|
|
1954
|
-
|
|
2105
|
+
<details><summary><code>client.oortRoutes.<a href="/src/api/resources/oortRoutes/client/Client.ts">deleteOortRoutes</a>(routeId) -> boolean</code></summary>
|
|
1955
2106
|
<dl>
|
|
1956
2107
|
<dd>
|
|
1957
2108
|
|
|
1958
|
-
<dl>
|
|
1959
|
-
<dd>
|
|
1960
|
-
|
|
1961
|
-
Can be used e.g. if a driver is removed from an org
|
|
1962
|
-
|
|
1963
|
-
</dd>
|
|
1964
|
-
</dl>
|
|
1965
|
-
</dd>
|
|
1966
|
-
</dl>
|
|
1967
|
-
|
|
1968
2109
|
#### 🔌 Usage
|
|
1969
2110
|
|
|
1970
2111
|
<dl>
|
|
@@ -1974,7 +2115,7 @@ Can be used e.g. if a driver is removed from an org
|
|
|
1974
2115
|
<dd>
|
|
1975
2116
|
|
|
1976
2117
|
```typescript
|
|
1977
|
-
await client.
|
|
2118
|
+
await client.oortRoutes.deleteOortRoutes("route_id");
|
|
1978
2119
|
```
|
|
1979
2120
|
|
|
1980
2121
|
</dd>
|
|
@@ -1990,7 +2131,7 @@ await client.oortDrivers.deleteOortDrivers("driver_id");
|
|
|
1990
2131
|
<dl>
|
|
1991
2132
|
<dd>
|
|
1992
2133
|
|
|
1993
|
-
**
|
|
2134
|
+
**routeId:** `string`
|
|
1994
2135
|
|
|
1995
2136
|
</dd>
|
|
1996
2137
|
</dl>
|
|
@@ -1998,7 +2139,7 @@ await client.oortDrivers.deleteOortDrivers("driver_id");
|
|
|
1998
2139
|
<dl>
|
|
1999
2140
|
<dd>
|
|
2000
2141
|
|
|
2001
|
-
**requestOptions:** `
|
|
2142
|
+
**requestOptions:** `OortRoutes.RequestOptions`
|
|
2002
2143
|
|
|
2003
2144
|
</dd>
|
|
2004
2145
|
</dl>
|
|
@@ -2009,9 +2150,7 @@ await client.oortDrivers.deleteOortDrivers("driver_id");
|
|
|
2009
2150
|
</dl>
|
|
2010
2151
|
</details>
|
|
2011
2152
|
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
<details><summary><code>client.oortMilestones.<a href="/src/api/resources/oortMilestones/client/Client.ts">postOortMilestonesAddToTask</a>({ ...params }) -> boolean</code></summary>
|
|
2153
|
+
<details><summary><code>client.oortRoutes.<a href="/src/api/resources/oortRoutes/client/Client.ts">getOortRoutesById</a>(idType, id, { ...params }) -> Chrt.RouteDetailRes</code></summary>
|
|
2015
2154
|
<dl>
|
|
2016
2155
|
<dd>
|
|
2017
2156
|
|
|
@@ -2024,10 +2163,7 @@ await client.oortDrivers.deleteOortDrivers("driver_id");
|
|
|
2024
2163
|
<dd>
|
|
2025
2164
|
|
|
2026
2165
|
```typescript
|
|
2027
|
-
await client.
|
|
2028
|
-
task_id: "task_id",
|
|
2029
|
-
type: "image",
|
|
2030
|
-
});
|
|
2166
|
+
await client.oortRoutes.getOortRoutesById("route_id", "id");
|
|
2031
2167
|
```
|
|
2032
2168
|
|
|
2033
2169
|
</dd>
|
|
@@ -2043,7 +2179,7 @@ await client.oortMilestones.postOortMilestonesAddToTask({
|
|
|
2043
2179
|
<dl>
|
|
2044
2180
|
<dd>
|
|
2045
2181
|
|
|
2046
|
-
**
|
|
2182
|
+
**idType:** `Chrt.RouteByIdEnum`
|
|
2047
2183
|
|
|
2048
2184
|
</dd>
|
|
2049
2185
|
</dl>
|
|
@@ -2051,7 +2187,23 @@ await client.oortMilestones.postOortMilestonesAddToTask({
|
|
|
2051
2187
|
<dl>
|
|
2052
2188
|
<dd>
|
|
2053
2189
|
|
|
2054
|
-
**
|
|
2190
|
+
**id:** `string`
|
|
2191
|
+
|
|
2192
|
+
</dd>
|
|
2193
|
+
</dl>
|
|
2194
|
+
|
|
2195
|
+
<dl>
|
|
2196
|
+
<dd>
|
|
2197
|
+
|
|
2198
|
+
**request:** `Chrt.GetOortRoutesByIdRequest`
|
|
2199
|
+
|
|
2200
|
+
</dd>
|
|
2201
|
+
</dl>
|
|
2202
|
+
|
|
2203
|
+
<dl>
|
|
2204
|
+
<dd>
|
|
2205
|
+
|
|
2206
|
+
**requestOptions:** `OortRoutes.RequestOptions`
|
|
2055
2207
|
|
|
2056
2208
|
</dd>
|
|
2057
2209
|
</dl>
|
|
@@ -2062,7 +2214,7 @@ await client.oortMilestones.postOortMilestonesAddToTask({
|
|
|
2062
2214
|
</dl>
|
|
2063
2215
|
</details>
|
|
2064
2216
|
|
|
2065
|
-
<details><summary><code>client.
|
|
2217
|
+
<details><summary><code>client.oortRoutes.<a href="/src/api/resources/oortRoutes/client/Client.ts">postOortRoutesCreate</a>({ ...params }) -> string</code></summary>
|
|
2066
2218
|
<dl>
|
|
2067
2219
|
<dd>
|
|
2068
2220
|
|
|
@@ -2075,7 +2227,7 @@ await client.oortMilestones.postOortMilestonesAddToTask({
|
|
|
2075
2227
|
<dd>
|
|
2076
2228
|
|
|
2077
2229
|
```typescript
|
|
2078
|
-
await client.
|
|
2230
|
+
await client.oortRoutes.postOortRoutesCreate();
|
|
2079
2231
|
```
|
|
2080
2232
|
|
|
2081
2233
|
</dd>
|
|
@@ -2091,7 +2243,7 @@ await client.oortMilestones.getOortMilestonesImages("milestone_s3_object_metadat
|
|
|
2091
2243
|
<dl>
|
|
2092
2244
|
<dd>
|
|
2093
2245
|
|
|
2094
|
-
**
|
|
2246
|
+
**request:** `Chrt.RouteCreateReq`
|
|
2095
2247
|
|
|
2096
2248
|
</dd>
|
|
2097
2249
|
</dl>
|
|
@@ -2099,7 +2251,7 @@ await client.oortMilestones.getOortMilestonesImages("milestone_s3_object_metadat
|
|
|
2099
2251
|
<dl>
|
|
2100
2252
|
<dd>
|
|
2101
2253
|
|
|
2102
|
-
**requestOptions:** `
|
|
2254
|
+
**requestOptions:** `OortRoutes.RequestOptions`
|
|
2103
2255
|
|
|
2104
2256
|
</dd>
|
|
2105
2257
|
</dl>
|
|
@@ -2110,25 +2262,12 @@ await client.oortMilestones.getOortMilestonesImages("milestone_s3_object_metadat
|
|
|
2110
2262
|
</dl>
|
|
2111
2263
|
</details>
|
|
2112
2264
|
|
|
2113
|
-
|
|
2114
|
-
<dl>
|
|
2115
|
-
<dd>
|
|
2116
|
-
|
|
2117
|
-
#### 📝 Description
|
|
2118
|
-
|
|
2119
|
-
<dl>
|
|
2120
|
-
<dd>
|
|
2265
|
+
## OortShippers
|
|
2121
2266
|
|
|
2267
|
+
<details><summary><code>client.oortShippers.<a href="/src/api/resources/oortShippers/client/Client.ts">getShipperConnectionsForCourier</a>() -> Chrt.ShipperOrgInfo1[]</code></summary>
|
|
2122
2268
|
<dl>
|
|
2123
2269
|
<dd>
|
|
2124
2270
|
|
|
2125
|
-
The `id` is the MilestoneS3ObjectMetadata1 id
|
|
2126
|
-
|
|
2127
|
-
</dd>
|
|
2128
|
-
</dl>
|
|
2129
|
-
</dd>
|
|
2130
|
-
</dl>
|
|
2131
|
-
|
|
2132
2271
|
#### 🔌 Usage
|
|
2133
2272
|
|
|
2134
2273
|
<dl>
|
|
@@ -2138,7 +2277,7 @@ The `id` is the MilestoneS3ObjectMetadata1 id
|
|
|
2138
2277
|
<dd>
|
|
2139
2278
|
|
|
2140
2279
|
```typescript
|
|
2141
|
-
await client.
|
|
2280
|
+
await client.oortShippers.getShipperConnectionsForCourier();
|
|
2142
2281
|
```
|
|
2143
2282
|
|
|
2144
2283
|
</dd>
|
|
@@ -2154,15 +2293,7 @@ await client.oortMilestones.deleteOortMilestonesImage("milestone_s3_object_metad
|
|
|
2154
2293
|
<dl>
|
|
2155
2294
|
<dd>
|
|
2156
2295
|
|
|
2157
|
-
**
|
|
2158
|
-
|
|
2159
|
-
</dd>
|
|
2160
|
-
</dl>
|
|
2161
|
-
|
|
2162
|
-
<dl>
|
|
2163
|
-
<dd>
|
|
2164
|
-
|
|
2165
|
-
**requestOptions:** `OortMilestones.RequestOptions`
|
|
2296
|
+
**requestOptions:** `OortShippers.RequestOptions`
|
|
2166
2297
|
|
|
2167
2298
|
</dd>
|
|
2168
2299
|
</dl>
|
|
@@ -2173,7 +2304,7 @@ await client.oortMilestones.deleteOortMilestonesImage("milestone_s3_object_metad
|
|
|
2173
2304
|
</dl>
|
|
2174
2305
|
</details>
|
|
2175
2306
|
|
|
2176
|
-
<details><summary><code>client.
|
|
2307
|
+
<details><summary><code>client.oortShippers.<a href="/src/api/resources/oortShippers/client/Client.ts">getCourierConnectionsForShippers</a>() -> Chrt.CourierOrgInfo1[]</code></summary>
|
|
2177
2308
|
<dl>
|
|
2178
2309
|
<dd>
|
|
2179
2310
|
|
|
@@ -2186,9 +2317,7 @@ await client.oortMilestones.deleteOortMilestonesImage("milestone_s3_object_metad
|
|
|
2186
2317
|
<dd>
|
|
2187
2318
|
|
|
2188
2319
|
```typescript
|
|
2189
|
-
await client.
|
|
2190
|
-
milestone_id: "milestone_id",
|
|
2191
|
-
});
|
|
2320
|
+
await client.oortShippers.getCourierConnectionsForShippers();
|
|
2192
2321
|
```
|
|
2193
2322
|
|
|
2194
2323
|
</dd>
|
|
@@ -2204,15 +2333,7 @@ await client.oortMilestones.postOortMilestonesUpdate({
|
|
|
2204
2333
|
<dl>
|
|
2205
2334
|
<dd>
|
|
2206
2335
|
|
|
2207
|
-
**
|
|
2208
|
-
|
|
2209
|
-
</dd>
|
|
2210
|
-
</dl>
|
|
2211
|
-
|
|
2212
|
-
<dl>
|
|
2213
|
-
<dd>
|
|
2214
|
-
|
|
2215
|
-
**requestOptions:** `OortMilestones.RequestOptions`
|
|
2336
|
+
**requestOptions:** `OortShippers.RequestOptions`
|
|
2216
2337
|
|
|
2217
2338
|
</dd>
|
|
2218
2339
|
</dl>
|
|
@@ -2223,11 +2344,13 @@ await client.oortMilestones.postOortMilestonesUpdate({
|
|
|
2223
2344
|
</dl>
|
|
2224
2345
|
</details>
|
|
2225
2346
|
|
|
2226
|
-
|
|
2347
|
+
## OortTaskGroups
|
|
2348
|
+
|
|
2349
|
+
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsListByCourierOrgId</a>() -> Chrt.GetTaskGroupsWithTasksListRes</code></summary>
|
|
2227
2350
|
<dl>
|
|
2228
2351
|
<dd>
|
|
2229
2352
|
|
|
2230
|
-
####
|
|
2353
|
+
#### 📝 Description
|
|
2231
2354
|
|
|
2232
2355
|
<dl>
|
|
2233
2356
|
<dd>
|
|
@@ -2235,20 +2358,14 @@ await client.oortMilestones.postOortMilestonesUpdate({
|
|
|
2235
2358
|
<dl>
|
|
2236
2359
|
<dd>
|
|
2237
2360
|
|
|
2238
|
-
|
|
2239
|
-
await client.oortMilestones.postOortMilestonesUploadImage(
|
|
2240
|
-
fs.createReadStream("/path/to/your/file"),
|
|
2241
|
-
"milestone_id",
|
|
2242
|
-
{},
|
|
2243
|
-
);
|
|
2244
|
-
```
|
|
2361
|
+
Uses the org_id from the JWT
|
|
2245
2362
|
|
|
2246
2363
|
</dd>
|
|
2247
2364
|
</dl>
|
|
2248
2365
|
</dd>
|
|
2249
2366
|
</dl>
|
|
2250
2367
|
|
|
2251
|
-
####
|
|
2368
|
+
#### 🔌 Usage
|
|
2252
2369
|
|
|
2253
2370
|
<dl>
|
|
2254
2371
|
<dd>
|
|
@@ -2256,31 +2373,24 @@ await client.oortMilestones.postOortMilestonesUploadImage(
|
|
|
2256
2373
|
<dl>
|
|
2257
2374
|
<dd>
|
|
2258
2375
|
|
|
2259
|
-
|
|
2376
|
+
```typescript
|
|
2377
|
+
await client.oortTaskGroups.getOortTaskGroupsListByCourierOrgId();
|
|
2378
|
+
```
|
|
2260
2379
|
|
|
2261
2380
|
</dd>
|
|
2262
2381
|
</dl>
|
|
2263
|
-
|
|
2264
|
-
<dl>
|
|
2265
|
-
<dd>
|
|
2266
|
-
|
|
2267
|
-
**milestoneId:** `string`
|
|
2268
|
-
|
|
2269
2382
|
</dd>
|
|
2270
2383
|
</dl>
|
|
2271
2384
|
|
|
2385
|
+
#### ⚙️ Parameters
|
|
2386
|
+
|
|
2272
2387
|
<dl>
|
|
2273
2388
|
<dd>
|
|
2274
2389
|
|
|
2275
|
-
**request:** `Chrt.BodyPostOortMilestonesUploadImageOortMilestonesUploadImageMilestoneIdPost`
|
|
2276
|
-
|
|
2277
|
-
</dd>
|
|
2278
|
-
</dl>
|
|
2279
|
-
|
|
2280
2390
|
<dl>
|
|
2281
2391
|
<dd>
|
|
2282
2392
|
|
|
2283
|
-
**requestOptions:** `
|
|
2393
|
+
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
2284
2394
|
|
|
2285
2395
|
</dd>
|
|
2286
2396
|
</dl>
|
|
@@ -2291,12 +2401,25 @@ await client.oortMilestones.postOortMilestonesUploadImage(
|
|
|
2291
2401
|
</dl>
|
|
2292
2402
|
</details>
|
|
2293
2403
|
|
|
2294
|
-
|
|
2404
|
+
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsListByCourierOrgIdFull</a>() -> Chrt.GetTaskGroupsWithFullTaskInfoListRes</code></summary>
|
|
2405
|
+
<dl>
|
|
2406
|
+
<dd>
|
|
2407
|
+
|
|
2408
|
+
#### 📝 Description
|
|
2409
|
+
|
|
2410
|
+
<dl>
|
|
2411
|
+
<dd>
|
|
2295
2412
|
|
|
2296
|
-
<details><summary><code>client.oortNotificationPreferences.<a href="/src/api/resources/oortNotificationPreferences/client/Client.ts">getNotificationPreferencesByOrgId</a>() -> Chrt.NotificationPreferences1</code></summary>
|
|
2297
2413
|
<dl>
|
|
2298
2414
|
<dd>
|
|
2299
2415
|
|
|
2416
|
+
Uses the org_id from the JWT - returns full task info with milestones and cargos
|
|
2417
|
+
|
|
2418
|
+
</dd>
|
|
2419
|
+
</dl>
|
|
2420
|
+
</dd>
|
|
2421
|
+
</dl>
|
|
2422
|
+
|
|
2300
2423
|
#### 🔌 Usage
|
|
2301
2424
|
|
|
2302
2425
|
<dl>
|
|
@@ -2306,7 +2429,7 @@ await client.oortMilestones.postOortMilestonesUploadImage(
|
|
|
2306
2429
|
<dd>
|
|
2307
2430
|
|
|
2308
2431
|
```typescript
|
|
2309
|
-
await client.
|
|
2432
|
+
await client.oortTaskGroups.getOortTaskGroupsListByCourierOrgIdFull();
|
|
2310
2433
|
```
|
|
2311
2434
|
|
|
2312
2435
|
</dd>
|
|
@@ -2322,7 +2445,7 @@ await client.oortNotificationPreferences.getNotificationPreferencesByOrgId();
|
|
|
2322
2445
|
<dl>
|
|
2323
2446
|
<dd>
|
|
2324
2447
|
|
|
2325
|
-
**requestOptions:** `
|
|
2448
|
+
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
2326
2449
|
|
|
2327
2450
|
</dd>
|
|
2328
2451
|
</dl>
|
|
@@ -2333,7 +2456,7 @@ await client.oortNotificationPreferences.getNotificationPreferencesByOrgId();
|
|
|
2333
2456
|
</dl>
|
|
2334
2457
|
</details>
|
|
2335
2458
|
|
|
2336
|
-
<details><summary><code>client.
|
|
2459
|
+
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsTaskInfoList</a>(taskGroupId) -> Chrt.GetTaskGroupWithTasksRes</code></summary>
|
|
2337
2460
|
<dl>
|
|
2338
2461
|
<dd>
|
|
2339
2462
|
|
|
@@ -2346,9 +2469,7 @@ await client.oortNotificationPreferences.getNotificationPreferencesByOrgId();
|
|
|
2346
2469
|
<dd>
|
|
2347
2470
|
|
|
2348
2471
|
```typescript
|
|
2349
|
-
await client.
|
|
2350
|
-
schema_version: 1,
|
|
2351
|
-
});
|
|
2472
|
+
await client.oortTaskGroups.getOortTaskGroupsTaskInfoList("task_group_id");
|
|
2352
2473
|
```
|
|
2353
2474
|
|
|
2354
2475
|
</dd>
|
|
@@ -2364,7 +2485,7 @@ await client.oortNotificationPreferences.postNotificationPreferencesCreate({
|
|
|
2364
2485
|
<dl>
|
|
2365
2486
|
<dd>
|
|
2366
2487
|
|
|
2367
|
-
**
|
|
2488
|
+
**taskGroupId:** `string`
|
|
2368
2489
|
|
|
2369
2490
|
</dd>
|
|
2370
2491
|
</dl>
|
|
@@ -2372,7 +2493,7 @@ await client.oortNotificationPreferences.postNotificationPreferencesCreate({
|
|
|
2372
2493
|
<dl>
|
|
2373
2494
|
<dd>
|
|
2374
2495
|
|
|
2375
|
-
**requestOptions:** `
|
|
2496
|
+
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
2376
2497
|
|
|
2377
2498
|
</dd>
|
|
2378
2499
|
</dl>
|
|
@@ -2383,9 +2504,7 @@ await client.oortNotificationPreferences.postNotificationPreferencesCreate({
|
|
|
2383
2504
|
</dl>
|
|
2384
2505
|
</details>
|
|
2385
2506
|
|
|
2386
|
-
|
|
2387
|
-
|
|
2388
|
-
<details><summary><code>client.oortOrders.<a href="/src/api/resources/oortOrders/client/Client.ts">postOortOrdersCreate</a>({ ...params }) -> Chrt.CreateOrderRes</code></summary>
|
|
2507
|
+
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsTaskInfoListFull</a>(taskGroupId) -> Chrt.GetTaskInfoListRes</code></summary>
|
|
2389
2508
|
<dl>
|
|
2390
2509
|
<dd>
|
|
2391
2510
|
|
|
@@ -2398,29 +2517,7 @@ await client.oortNotificationPreferences.postNotificationPreferencesCreate({
|
|
|
2398
2517
|
<dd>
|
|
2399
2518
|
|
|
2400
2519
|
```typescript
|
|
2401
|
-
await client.
|
|
2402
|
-
cargo_client_creates_map: {
|
|
2403
|
-
key: {
|
|
2404
|
-
cargo_type: "spare_parts",
|
|
2405
|
-
schema_version: 1,
|
|
2406
|
-
},
|
|
2407
|
-
},
|
|
2408
|
-
order_client_create: {
|
|
2409
|
-
schema_version: 1,
|
|
2410
|
-
},
|
|
2411
|
-
order_created_by_type: "chrt",
|
|
2412
|
-
order_dispatch_type: "dtc",
|
|
2413
|
-
task_client_creates_bundle_groupings: [
|
|
2414
|
-
[
|
|
2415
|
-
{
|
|
2416
|
-
task_client_create: {
|
|
2417
|
-
schema_version: 1,
|
|
2418
|
-
},
|
|
2419
|
-
},
|
|
2420
|
-
],
|
|
2421
|
-
],
|
|
2422
|
-
transport_type: "ground_only",
|
|
2423
|
-
});
|
|
2520
|
+
await client.oortTaskGroups.getOortTaskGroupsTaskInfoListFull("task_group_id");
|
|
2424
2521
|
```
|
|
2425
2522
|
|
|
2426
2523
|
</dd>
|
|
@@ -2436,7 +2533,7 @@ await client.oortOrders.postOortOrdersCreate({
|
|
|
2436
2533
|
<dl>
|
|
2437
2534
|
<dd>
|
|
2438
2535
|
|
|
2439
|
-
**
|
|
2536
|
+
**taskGroupId:** `string`
|
|
2440
2537
|
|
|
2441
2538
|
</dd>
|
|
2442
2539
|
</dl>
|
|
@@ -2444,7 +2541,7 @@ await client.oortOrders.postOortOrdersCreate({
|
|
|
2444
2541
|
<dl>
|
|
2445
2542
|
<dd>
|
|
2446
2543
|
|
|
2447
|
-
**requestOptions:** `
|
|
2544
|
+
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
2448
2545
|
|
|
2449
2546
|
</dd>
|
|
2450
2547
|
</dl>
|
|
@@ -2455,25 +2552,12 @@ await client.oortOrders.postOortOrdersCreate({
|
|
|
2455
2552
|
</dl>
|
|
2456
2553
|
</details>
|
|
2457
2554
|
|
|
2458
|
-
|
|
2459
|
-
<dl>
|
|
2460
|
-
<dd>
|
|
2461
|
-
|
|
2462
|
-
#### 📝 Description
|
|
2463
|
-
|
|
2464
|
-
<dl>
|
|
2465
|
-
<dd>
|
|
2555
|
+
## Orgs
|
|
2466
2556
|
|
|
2557
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgMembers</a>() -> Chrt.OrgMemberDetails[]</code></summary>
|
|
2467
2558
|
<dl>
|
|
2468
2559
|
<dd>
|
|
2469
2560
|
|
|
2470
|
-
Uses the org_id from the JWT
|
|
2471
|
-
|
|
2472
|
-
</dd>
|
|
2473
|
-
</dl>
|
|
2474
|
-
</dd>
|
|
2475
|
-
</dl>
|
|
2476
|
-
|
|
2477
2561
|
#### 🔌 Usage
|
|
2478
2562
|
|
|
2479
2563
|
<dl>
|
|
@@ -2483,7 +2567,7 @@ Uses the org_id from the JWT
|
|
|
2483
2567
|
<dd>
|
|
2484
2568
|
|
|
2485
2569
|
```typescript
|
|
2486
|
-
await client.
|
|
2570
|
+
await client.orgs.getOrgMembers();
|
|
2487
2571
|
```
|
|
2488
2572
|
|
|
2489
2573
|
</dd>
|
|
@@ -2499,7 +2583,7 @@ await client.oortOrders.getOortOrdersListByCourierOrgId();
|
|
|
2499
2583
|
<dl>
|
|
2500
2584
|
<dd>
|
|
2501
2585
|
|
|
2502
|
-
**requestOptions:** `
|
|
2586
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
2503
2587
|
|
|
2504
2588
|
</dd>
|
|
2505
2589
|
</dl>
|
|
@@ -2510,25 +2594,10 @@ await client.oortOrders.getOortOrdersListByCourierOrgId();
|
|
|
2510
2594
|
</dl>
|
|
2511
2595
|
</details>
|
|
2512
2596
|
|
|
2513
|
-
<details><summary><code>client.
|
|
2514
|
-
<dl>
|
|
2515
|
-
<dd>
|
|
2516
|
-
|
|
2517
|
-
#### 📝 Description
|
|
2518
|
-
|
|
2519
|
-
<dl>
|
|
2520
|
-
<dd>
|
|
2521
|
-
|
|
2597
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgsPublicData</a>() -> Chrt.OrgPublicData2</code></summary>
|
|
2522
2598
|
<dl>
|
|
2523
2599
|
<dd>
|
|
2524
2600
|
|
|
2525
|
-
Uses the org_id from the JWT
|
|
2526
|
-
|
|
2527
|
-
</dd>
|
|
2528
|
-
</dl>
|
|
2529
|
-
</dd>
|
|
2530
|
-
</dl>
|
|
2531
|
-
|
|
2532
2601
|
#### 🔌 Usage
|
|
2533
2602
|
|
|
2534
2603
|
<dl>
|
|
@@ -2538,7 +2607,7 @@ Uses the org_id from the JWT
|
|
|
2538
2607
|
<dd>
|
|
2539
2608
|
|
|
2540
2609
|
```typescript
|
|
2541
|
-
await client.
|
|
2610
|
+
await client.orgs.getOrgsPublicData();
|
|
2542
2611
|
```
|
|
2543
2612
|
|
|
2544
2613
|
</dd>
|
|
@@ -2554,7 +2623,7 @@ await client.oortOrders.getOortOrdersListByShipperOrgId();
|
|
|
2554
2623
|
<dl>
|
|
2555
2624
|
<dd>
|
|
2556
2625
|
|
|
2557
|
-
**requestOptions:** `
|
|
2626
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
2558
2627
|
|
|
2559
2628
|
</dd>
|
|
2560
2629
|
</dl>
|
|
@@ -2565,11 +2634,11 @@ await client.oortOrders.getOortOrdersListByShipperOrgId();
|
|
|
2565
2634
|
</dl>
|
|
2566
2635
|
</details>
|
|
2567
2636
|
|
|
2568
|
-
<details><summary><code>client.
|
|
2637
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">postOrgsPublicData</a>({ ...params }) -> boolean</code></summary>
|
|
2569
2638
|
<dl>
|
|
2570
2639
|
<dd>
|
|
2571
2640
|
|
|
2572
|
-
####
|
|
2641
|
+
#### 🔌 Usage
|
|
2573
2642
|
|
|
2574
2643
|
<dl>
|
|
2575
2644
|
<dd>
|
|
@@ -2577,14 +2646,18 @@ await client.oortOrders.getOortOrdersListByShipperOrgId();
|
|
|
2577
2646
|
<dl>
|
|
2578
2647
|
<dd>
|
|
2579
2648
|
|
|
2580
|
-
|
|
2649
|
+
```typescript
|
|
2650
|
+
await client.orgs.postOrgsPublicData({
|
|
2651
|
+
handle: "handle",
|
|
2652
|
+
});
|
|
2653
|
+
```
|
|
2581
2654
|
|
|
2582
2655
|
</dd>
|
|
2583
2656
|
</dl>
|
|
2584
2657
|
</dd>
|
|
2585
2658
|
</dl>
|
|
2586
2659
|
|
|
2587
|
-
####
|
|
2660
|
+
#### ⚙️ Parameters
|
|
2588
2661
|
|
|
2589
2662
|
<dl>
|
|
2590
2663
|
<dd>
|
|
@@ -2592,24 +2665,15 @@ Uses the org_id from the JWT
|
|
|
2592
2665
|
<dl>
|
|
2593
2666
|
<dd>
|
|
2594
2667
|
|
|
2595
|
-
|
|
2596
|
-
await client.oortOrders.getOortOrdersListByShipperOrgIdFull();
|
|
2597
|
-
```
|
|
2668
|
+
**request:** `Chrt.PostOrgPublicDataReq`
|
|
2598
2669
|
|
|
2599
2670
|
</dd>
|
|
2600
2671
|
</dl>
|
|
2601
|
-
</dd>
|
|
2602
|
-
</dl>
|
|
2603
|
-
|
|
2604
|
-
#### ⚙️ Parameters
|
|
2605
|
-
|
|
2606
|
-
<dl>
|
|
2607
|
-
<dd>
|
|
2608
2672
|
|
|
2609
2673
|
<dl>
|
|
2610
2674
|
<dd>
|
|
2611
2675
|
|
|
2612
|
-
**requestOptions:** `
|
|
2676
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
2613
2677
|
|
|
2614
2678
|
</dd>
|
|
2615
2679
|
</dl>
|
|
@@ -2620,7 +2684,9 @@ await client.oortOrders.getOortOrdersListByShipperOrgIdFull();
|
|
|
2620
2684
|
</dl>
|
|
2621
2685
|
</details>
|
|
2622
2686
|
|
|
2623
|
-
|
|
2687
|
+
## Payments
|
|
2688
|
+
|
|
2689
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createCheckoutSession</a>({ ...params }) -> Chrt.CreateCheckoutSessionRes2</code></summary>
|
|
2624
2690
|
<dl>
|
|
2625
2691
|
<dd>
|
|
2626
2692
|
|
|
@@ -2632,7 +2698,13 @@ await client.oortOrders.getOortOrdersListByShipperOrgIdFull();
|
|
|
2632
2698
|
<dl>
|
|
2633
2699
|
<dd>
|
|
2634
2700
|
|
|
2635
|
-
|
|
2701
|
+
Steps:
|
|
2702
|
+
(1) (a) Validate and decode the jwt, (b) check for an org_id
|
|
2703
|
+
(2) Resolve the subscription_plan
|
|
2704
|
+
(3) Check for an already-active same subscription within the org
|
|
2705
|
+
(4) Check if the current org membership count <= subscription_plan's limit
|
|
2706
|
+
(5) Get the customer_id
|
|
2707
|
+
(6) Create the checkout session url
|
|
2636
2708
|
|
|
2637
2709
|
</dd>
|
|
2638
2710
|
</dl>
|
|
@@ -2648,7 +2720,9 @@ Accepts both order_id and order_short_id values and returns just the Order
|
|
|
2648
2720
|
<dd>
|
|
2649
2721
|
|
|
2650
2722
|
```typescript
|
|
2651
|
-
await client.
|
|
2723
|
+
await client.payments.createCheckoutSession({
|
|
2724
|
+
price_name: "courier_ops_solo_100_month",
|
|
2725
|
+
});
|
|
2652
2726
|
```
|
|
2653
2727
|
|
|
2654
2728
|
</dd>
|
|
@@ -2664,7 +2738,7 @@ await client.oortOrders.getOortOrdersOrderIdOrShortId("order_id_or_short_id");
|
|
|
2664
2738
|
<dl>
|
|
2665
2739
|
<dd>
|
|
2666
2740
|
|
|
2667
|
-
**
|
|
2741
|
+
**request:** `Chrt.CreateCheckoutSessionReq2`
|
|
2668
2742
|
|
|
2669
2743
|
</dd>
|
|
2670
2744
|
</dl>
|
|
@@ -2672,7 +2746,7 @@ await client.oortOrders.getOortOrdersOrderIdOrShortId("order_id_or_short_id");
|
|
|
2672
2746
|
<dl>
|
|
2673
2747
|
<dd>
|
|
2674
2748
|
|
|
2675
|
-
**requestOptions:** `
|
|
2749
|
+
**requestOptions:** `Payments.RequestOptions`
|
|
2676
2750
|
|
|
2677
2751
|
</dd>
|
|
2678
2752
|
</dl>
|
|
@@ -2683,7 +2757,7 @@ await client.oortOrders.getOortOrdersOrderIdOrShortId("order_id_or_short_id");
|
|
|
2683
2757
|
</dl>
|
|
2684
2758
|
</details>
|
|
2685
2759
|
|
|
2686
|
-
<details><summary><code>client.
|
|
2760
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerk</a>() -> boolean</code></summary>
|
|
2687
2761
|
<dl>
|
|
2688
2762
|
<dd>
|
|
2689
2763
|
|
|
@@ -2696,7 +2770,7 @@ await client.oortOrders.getOortOrdersOrderIdOrShortId("order_id_or_short_id");
|
|
|
2696
2770
|
<dd>
|
|
2697
2771
|
|
|
2698
2772
|
```typescript
|
|
2699
|
-
await client.
|
|
2773
|
+
await client.payments.syncStripeToClerk();
|
|
2700
2774
|
```
|
|
2701
2775
|
|
|
2702
2776
|
</dd>
|
|
@@ -2712,15 +2786,7 @@ await client.oortOrders.putOortOrdersOrderIdOrShortIdCancel("order_id_or_short_i
|
|
|
2712
2786
|
<dl>
|
|
2713
2787
|
<dd>
|
|
2714
2788
|
|
|
2715
|
-
**
|
|
2716
|
-
|
|
2717
|
-
</dd>
|
|
2718
|
-
</dl>
|
|
2719
|
-
|
|
2720
|
-
<dl>
|
|
2721
|
-
<dd>
|
|
2722
|
-
|
|
2723
|
-
**requestOptions:** `OortOrders.RequestOptions`
|
|
2789
|
+
**requestOptions:** `Payments.RequestOptions`
|
|
2724
2790
|
|
|
2725
2791
|
</dd>
|
|
2726
2792
|
</dl>
|
|
@@ -2731,25 +2797,10 @@ await client.oortOrders.putOortOrdersOrderIdOrShortIdCancel("order_id_or_short_i
|
|
|
2731
2797
|
</dl>
|
|
2732
2798
|
</details>
|
|
2733
2799
|
|
|
2734
|
-
<details><summary><code>client.
|
|
2735
|
-
<dl>
|
|
2736
|
-
<dd>
|
|
2737
|
-
|
|
2738
|
-
#### 📝 Description
|
|
2739
|
-
|
|
2740
|
-
<dl>
|
|
2741
|
-
<dd>
|
|
2742
|
-
|
|
2800
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">webhook</a>() -> boolean</code></summary>
|
|
2743
2801
|
<dl>
|
|
2744
2802
|
<dd>
|
|
2745
2803
|
|
|
2746
|
-
Accepts both order_id and order_short_id values and returns the Order with all its Task Groups, Tasks, Milestones, and Cargos
|
|
2747
|
-
|
|
2748
|
-
</dd>
|
|
2749
|
-
</dl>
|
|
2750
|
-
</dd>
|
|
2751
|
-
</dl>
|
|
2752
|
-
|
|
2753
2804
|
#### 🔌 Usage
|
|
2754
2805
|
|
|
2755
2806
|
<dl>
|
|
@@ -2759,7 +2810,7 @@ Accepts both order_id and order_short_id values and returns the Order with all i
|
|
|
2759
2810
|
<dd>
|
|
2760
2811
|
|
|
2761
2812
|
```typescript
|
|
2762
|
-
await client.
|
|
2813
|
+
await client.payments.webhook();
|
|
2763
2814
|
```
|
|
2764
2815
|
|
|
2765
2816
|
</dd>
|
|
@@ -2775,15 +2826,7 @@ await client.oortOrders.getOortOrdersOrderIdOrShortIdFull("order_id_or_short_id"
|
|
|
2775
2826
|
<dl>
|
|
2776
2827
|
<dd>
|
|
2777
2828
|
|
|
2778
|
-
**
|
|
2779
|
-
|
|
2780
|
-
</dd>
|
|
2781
|
-
</dl>
|
|
2782
|
-
|
|
2783
|
-
<dl>
|
|
2784
|
-
<dd>
|
|
2785
|
-
|
|
2786
|
-
**requestOptions:** `OortOrders.RequestOptions`
|
|
2829
|
+
**requestOptions:** `Payments.RequestOptions`
|
|
2787
2830
|
|
|
2788
2831
|
</dd>
|
|
2789
2832
|
</dl>
|
|
@@ -2794,9 +2837,9 @@ await client.oortOrders.getOortOrdersOrderIdOrShortIdFull("order_id_or_short_id"
|
|
|
2794
2837
|
</dl>
|
|
2795
2838
|
</details>
|
|
2796
2839
|
|
|
2797
|
-
##
|
|
2840
|
+
## Profiles
|
|
2798
2841
|
|
|
2799
|
-
<details><summary><code>client.
|
|
2842
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">getCourierProfile</a>({ ...params }) -> Chrt.CourierProfileRes2</code></summary>
|
|
2800
2843
|
<dl>
|
|
2801
2844
|
<dd>
|
|
2802
2845
|
|
|
@@ -2808,7 +2851,7 @@ await client.oortOrders.getOortOrdersOrderIdOrShortIdFull("order_id_or_short_id"
|
|
|
2808
2851
|
<dl>
|
|
2809
2852
|
<dd>
|
|
2810
2853
|
|
|
2811
|
-
|
|
2854
|
+
...
|
|
2812
2855
|
|
|
2813
2856
|
</dd>
|
|
2814
2857
|
</dl>
|
|
@@ -2824,10 +2867,7 @@ Create a new courier org info. Fails if one already exists.
|
|
|
2824
2867
|
<dd>
|
|
2825
2868
|
|
|
2826
2869
|
```typescript
|
|
2827
|
-
await client.
|
|
2828
|
-
email_address_primary: "email_address_primary",
|
|
2829
|
-
schema_version: 1,
|
|
2830
|
-
});
|
|
2870
|
+
await client.profiles.getCourierProfile();
|
|
2831
2871
|
```
|
|
2832
2872
|
|
|
2833
2873
|
</dd>
|
|
@@ -2843,7 +2883,7 @@ await client.oortOrgConnectionInfos.createCourierOrgInfo({
|
|
|
2843
2883
|
<dl>
|
|
2844
2884
|
<dd>
|
|
2845
2885
|
|
|
2846
|
-
**request:** `Chrt.
|
|
2886
|
+
**request:** `Chrt.GetCourierProfileRequest`
|
|
2847
2887
|
|
|
2848
2888
|
</dd>
|
|
2849
2889
|
</dl>
|
|
@@ -2851,7 +2891,7 @@ await client.oortOrgConnectionInfos.createCourierOrgInfo({
|
|
|
2851
2891
|
<dl>
|
|
2852
2892
|
<dd>
|
|
2853
2893
|
|
|
2854
|
-
**requestOptions:** `
|
|
2894
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
2855
2895
|
|
|
2856
2896
|
</dd>
|
|
2857
2897
|
</dl>
|
|
@@ -2862,11 +2902,11 @@ await client.oortOrgConnectionInfos.createCourierOrgInfo({
|
|
|
2862
2902
|
</dl>
|
|
2863
2903
|
</details>
|
|
2864
2904
|
|
|
2865
|
-
<details><summary><code>client.
|
|
2905
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">postCourierProfile</a>({ ...params }) -> string</code></summary>
|
|
2866
2906
|
<dl>
|
|
2867
2907
|
<dd>
|
|
2868
2908
|
|
|
2869
|
-
####
|
|
2909
|
+
#### 🔌 Usage
|
|
2870
2910
|
|
|
2871
2911
|
<dl>
|
|
2872
2912
|
<dd>
|
|
@@ -2874,12 +2914,48 @@ await client.oortOrgConnectionInfos.createCourierOrgInfo({
|
|
|
2874
2914
|
<dl>
|
|
2875
2915
|
<dd>
|
|
2876
2916
|
|
|
2877
|
-
|
|
2917
|
+
```typescript
|
|
2918
|
+
await client.profiles.postCourierProfile({
|
|
2919
|
+
schema_version: 1,
|
|
2920
|
+
owner_name: "owner_name",
|
|
2921
|
+
});
|
|
2922
|
+
```
|
|
2923
|
+
|
|
2924
|
+
</dd>
|
|
2925
|
+
</dl>
|
|
2926
|
+
</dd>
|
|
2927
|
+
</dl>
|
|
2928
|
+
|
|
2929
|
+
#### ⚙️ Parameters
|
|
2930
|
+
|
|
2931
|
+
<dl>
|
|
2932
|
+
<dd>
|
|
2933
|
+
|
|
2934
|
+
<dl>
|
|
2935
|
+
<dd>
|
|
2936
|
+
|
|
2937
|
+
**request:** `Chrt.CourierProfileCreate2`
|
|
2938
|
+
|
|
2939
|
+
</dd>
|
|
2940
|
+
</dl>
|
|
2941
|
+
|
|
2942
|
+
<dl>
|
|
2943
|
+
<dd>
|
|
2878
2944
|
|
|
2945
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
2946
|
+
|
|
2947
|
+
</dd>
|
|
2948
|
+
</dl>
|
|
2879
2949
|
</dd>
|
|
2880
2950
|
</dl>
|
|
2951
|
+
|
|
2881
2952
|
</dd>
|
|
2882
2953
|
</dl>
|
|
2954
|
+
</details>
|
|
2955
|
+
|
|
2956
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">getHandleIsAvailable</a>({ ...params }) -> boolean</code></summary>
|
|
2957
|
+
<dl>
|
|
2958
|
+
<dd>
|
|
2883
2959
|
|
|
2884
2960
|
#### 🔌 Usage
|
|
2885
2961
|
|
|
@@ -2890,9 +2966,8 @@ Create a new shipper org info. Fails if one already exists.
|
|
|
2890
2966
|
<dd>
|
|
2891
2967
|
|
|
2892
2968
|
```typescript
|
|
2893
|
-
await client.
|
|
2894
|
-
|
|
2895
|
-
schema_version: 1,
|
|
2969
|
+
await client.profiles.getHandleIsAvailable({
|
|
2970
|
+
handle: "handle",
|
|
2896
2971
|
});
|
|
2897
2972
|
```
|
|
2898
2973
|
|
|
@@ -2909,7 +2984,7 @@ await client.oortOrgConnectionInfos.createShipperOrgInfo({
|
|
|
2909
2984
|
<dl>
|
|
2910
2985
|
<dd>
|
|
2911
2986
|
|
|
2912
|
-
**request:** `Chrt.
|
|
2987
|
+
**request:** `Chrt.GetHandleIsAvailableRequest`
|
|
2913
2988
|
|
|
2914
2989
|
</dd>
|
|
2915
2990
|
</dl>
|
|
@@ -2917,7 +2992,7 @@ await client.oortOrgConnectionInfos.createShipperOrgInfo({
|
|
|
2917
2992
|
<dl>
|
|
2918
2993
|
<dd>
|
|
2919
2994
|
|
|
2920
|
-
**requestOptions:** `
|
|
2995
|
+
**requestOptions:** `Profiles.RequestOptions`
|
|
2921
2996
|
|
|
2922
2997
|
</dd>
|
|
2923
2998
|
</dl>
|
|
@@ -2928,11 +3003,13 @@ await client.oortOrgConnectionInfos.createShipperOrgInfo({
|
|
|
2928
3003
|
</dl>
|
|
2929
3004
|
</details>
|
|
2930
3005
|
|
|
2931
|
-
|
|
3006
|
+
## Root
|
|
3007
|
+
|
|
3008
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getAuthd</a>() -> Record<string, string></code></summary>
|
|
2932
3009
|
<dl>
|
|
2933
3010
|
<dd>
|
|
2934
3011
|
|
|
2935
|
-
####
|
|
3012
|
+
#### 🔌 Usage
|
|
2936
3013
|
|
|
2937
3014
|
<dl>
|
|
2938
3015
|
<dd>
|
|
@@ -2940,14 +3017,16 @@ await client.oortOrgConnectionInfos.createShipperOrgInfo({
|
|
|
2940
3017
|
<dl>
|
|
2941
3018
|
<dd>
|
|
2942
3019
|
|
|
2943
|
-
|
|
3020
|
+
```typescript
|
|
3021
|
+
await client.root.getAuthd();
|
|
3022
|
+
```
|
|
2944
3023
|
|
|
2945
3024
|
</dd>
|
|
2946
3025
|
</dl>
|
|
2947
3026
|
</dd>
|
|
2948
3027
|
</dl>
|
|
2949
3028
|
|
|
2950
|
-
####
|
|
3029
|
+
#### ⚙️ Parameters
|
|
2951
3030
|
|
|
2952
3031
|
<dl>
|
|
2953
3032
|
<dd>
|
|
@@ -2955,16 +3034,22 @@ Gets the courier org info for the authenticated user
|
|
|
2955
3034
|
<dl>
|
|
2956
3035
|
<dd>
|
|
2957
3036
|
|
|
2958
|
-
|
|
2959
|
-
await client.oortOrgConnectionInfos.getCourierOrgInfo();
|
|
2960
|
-
```
|
|
3037
|
+
**requestOptions:** `Root.RequestOptions`
|
|
2961
3038
|
|
|
2962
3039
|
</dd>
|
|
2963
3040
|
</dl>
|
|
2964
3041
|
</dd>
|
|
2965
3042
|
</dl>
|
|
2966
3043
|
|
|
2967
|
-
|
|
3044
|
+
</dd>
|
|
3045
|
+
</dl>
|
|
3046
|
+
</details>
|
|
3047
|
+
|
|
3048
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">postAuthd</a>() -> unknown</code></summary>
|
|
3049
|
+
<dl>
|
|
3050
|
+
<dd>
|
|
3051
|
+
|
|
3052
|
+
#### 🔌 Usage
|
|
2968
3053
|
|
|
2969
3054
|
<dl>
|
|
2970
3055
|
<dd>
|
|
@@ -2972,22 +3057,16 @@ await client.oortOrgConnectionInfos.getCourierOrgInfo();
|
|
|
2972
3057
|
<dl>
|
|
2973
3058
|
<dd>
|
|
2974
3059
|
|
|
2975
|
-
|
|
3060
|
+
```typescript
|
|
3061
|
+
await client.root.postAuthd();
|
|
3062
|
+
```
|
|
2976
3063
|
|
|
2977
3064
|
</dd>
|
|
2978
3065
|
</dl>
|
|
2979
3066
|
</dd>
|
|
2980
3067
|
</dl>
|
|
2981
3068
|
|
|
2982
|
-
|
|
2983
|
-
</dl>
|
|
2984
|
-
</details>
|
|
2985
|
-
|
|
2986
|
-
<details><summary><code>client.oortOrgConnectionInfos.<a href="/src/api/resources/oortOrgConnectionInfos/client/Client.ts">getShipperOrgInfo</a>() -> Chrt.ShipperOrgConnectionInfo1</code></summary>
|
|
2987
|
-
<dl>
|
|
2988
|
-
<dd>
|
|
2989
|
-
|
|
2990
|
-
#### 📝 Description
|
|
3069
|
+
#### ⚙️ Parameters
|
|
2991
3070
|
|
|
2992
3071
|
<dl>
|
|
2993
3072
|
<dd>
|
|
@@ -2995,13 +3074,21 @@ await client.oortOrgConnectionInfos.getCourierOrgInfo();
|
|
|
2995
3074
|
<dl>
|
|
2996
3075
|
<dd>
|
|
2997
3076
|
|
|
2998
|
-
|
|
3077
|
+
**requestOptions:** `Root.RequestOptions`
|
|
2999
3078
|
|
|
3000
3079
|
</dd>
|
|
3001
3080
|
</dl>
|
|
3002
3081
|
</dd>
|
|
3003
3082
|
</dl>
|
|
3004
3083
|
|
|
3084
|
+
</dd>
|
|
3085
|
+
</dl>
|
|
3086
|
+
</details>
|
|
3087
|
+
|
|
3088
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getOptionallyAuthd</a>() -> unknown</code></summary>
|
|
3089
|
+
<dl>
|
|
3090
|
+
<dd>
|
|
3091
|
+
|
|
3005
3092
|
#### 🔌 Usage
|
|
3006
3093
|
|
|
3007
3094
|
<dl>
|
|
@@ -3011,7 +3098,7 @@ Gets the shipper org info for the authenticated user
|
|
|
3011
3098
|
<dd>
|
|
3012
3099
|
|
|
3013
3100
|
```typescript
|
|
3014
|
-
await client.
|
|
3101
|
+
await client.root.getOptionallyAuthd();
|
|
3015
3102
|
```
|
|
3016
3103
|
|
|
3017
3104
|
</dd>
|
|
@@ -3027,7 +3114,7 @@ await client.oortOrgConnectionInfos.getShipperOrgInfo();
|
|
|
3027
3114
|
<dl>
|
|
3028
3115
|
<dd>
|
|
3029
3116
|
|
|
3030
|
-
**requestOptions:** `
|
|
3117
|
+
**requestOptions:** `Root.RequestOptions`
|
|
3031
3118
|
|
|
3032
3119
|
</dd>
|
|
3033
3120
|
</dl>
|
|
@@ -3038,7 +3125,7 @@ await client.oortOrgConnectionInfos.getShipperOrgInfo();
|
|
|
3038
3125
|
</dl>
|
|
3039
3126
|
</details>
|
|
3040
3127
|
|
|
3041
|
-
<details><summary><code>client.
|
|
3128
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getRoot</a>() -> unknown</code></summary>
|
|
3042
3129
|
<dl>
|
|
3043
3130
|
<dd>
|
|
3044
3131
|
|
|
@@ -3050,7 +3137,7 @@ await client.oortOrgConnectionInfos.getShipperOrgInfo();
|
|
|
3050
3137
|
<dl>
|
|
3051
3138
|
<dd>
|
|
3052
3139
|
|
|
3053
|
-
|
|
3140
|
+
Returns a greeting message
|
|
3054
3141
|
|
|
3055
3142
|
</dd>
|
|
3056
3143
|
</dl>
|
|
@@ -3066,7 +3153,7 @@ Update existing courier org info. Can update one or more fields.
|
|
|
3066
3153
|
<dd>
|
|
3067
3154
|
|
|
3068
3155
|
```typescript
|
|
3069
|
-
await client.
|
|
3156
|
+
await client.root.getRoot();
|
|
3070
3157
|
```
|
|
3071
3158
|
|
|
3072
3159
|
</dd>
|
|
@@ -3082,15 +3169,7 @@ await client.oortOrgConnectionInfos.updateCourierOrgInfo();
|
|
|
3082
3169
|
<dl>
|
|
3083
3170
|
<dd>
|
|
3084
3171
|
|
|
3085
|
-
**
|
|
3086
|
-
|
|
3087
|
-
</dd>
|
|
3088
|
-
</dl>
|
|
3089
|
-
|
|
3090
|
-
<dl>
|
|
3091
|
-
<dd>
|
|
3092
|
-
|
|
3093
|
-
**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
|
|
3172
|
+
**requestOptions:** `Root.RequestOptions`
|
|
3094
3173
|
|
|
3095
3174
|
</dd>
|
|
3096
3175
|
</dl>
|
|
@@ -3101,7 +3180,7 @@ await client.oortOrgConnectionInfos.updateCourierOrgInfo();
|
|
|
3101
3180
|
</dl>
|
|
3102
3181
|
</details>
|
|
3103
3182
|
|
|
3104
|
-
<details><summary><code>client.
|
|
3183
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getHealth</a>() -> unknown</code></summary>
|
|
3105
3184
|
<dl>
|
|
3106
3185
|
<dd>
|
|
3107
3186
|
|
|
@@ -3113,7 +3192,7 @@ await client.oortOrgConnectionInfos.updateCourierOrgInfo();
|
|
|
3113
3192
|
<dl>
|
|
3114
3193
|
<dd>
|
|
3115
3194
|
|
|
3116
|
-
|
|
3195
|
+
Used for monitoring system health
|
|
3117
3196
|
|
|
3118
3197
|
</dd>
|
|
3119
3198
|
</dl>
|
|
@@ -3129,7 +3208,7 @@ Update existing shipper org info. Can update one or more fields.
|
|
|
3129
3208
|
<dd>
|
|
3130
3209
|
|
|
3131
3210
|
```typescript
|
|
3132
|
-
await client.
|
|
3211
|
+
await client.root.getHealth();
|
|
3133
3212
|
```
|
|
3134
3213
|
|
|
3135
3214
|
</dd>
|
|
@@ -3145,15 +3224,7 @@ await client.oortOrgConnectionInfos.updateShipperOrgInfo();
|
|
|
3145
3224
|
<dl>
|
|
3146
3225
|
<dd>
|
|
3147
3226
|
|
|
3148
|
-
**
|
|
3149
|
-
|
|
3150
|
-
</dd>
|
|
3151
|
-
</dl>
|
|
3152
|
-
|
|
3153
|
-
<dl>
|
|
3154
|
-
<dd>
|
|
3155
|
-
|
|
3156
|
-
**requestOptions:** `OortOrgConnectionInfos.RequestOptions`
|
|
3227
|
+
**requestOptions:** `Root.RequestOptions`
|
|
3157
3228
|
|
|
3158
3229
|
</dd>
|
|
3159
3230
|
</dl>
|
|
@@ -3164,9 +3235,7 @@ await client.oortOrgConnectionInfos.updateShipperOrgInfo();
|
|
|
3164
3235
|
</dl>
|
|
3165
3236
|
</details>
|
|
3166
3237
|
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
<details><summary><code>client.oortOrgProfiles.<a href="/src/api/resources/oortOrgProfiles/client/Client.ts">getAvatar</a>({ ...params }) -> string</code></summary>
|
|
3238
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">getFailure</a>() -> unknown</code></summary>
|
|
3170
3239
|
<dl>
|
|
3171
3240
|
<dd>
|
|
3172
3241
|
|
|
@@ -3179,9 +3248,7 @@ await client.oortOrgConnectionInfos.updateShipperOrgInfo();
|
|
|
3179
3248
|
<dd>
|
|
3180
3249
|
|
|
3181
3250
|
```typescript
|
|
3182
|
-
await client.
|
|
3183
|
-
handle: "handle",
|
|
3184
|
-
});
|
|
3251
|
+
await client.root.getFailure();
|
|
3185
3252
|
```
|
|
3186
3253
|
|
|
3187
3254
|
</dd>
|
|
@@ -3197,15 +3264,7 @@ await client.oortOrgProfiles.getAvatar({
|
|
|
3197
3264
|
<dl>
|
|
3198
3265
|
<dd>
|
|
3199
3266
|
|
|
3200
|
-
**
|
|
3201
|
-
|
|
3202
|
-
</dd>
|
|
3203
|
-
</dl>
|
|
3204
|
-
|
|
3205
|
-
<dl>
|
|
3206
|
-
<dd>
|
|
3207
|
-
|
|
3208
|
-
**requestOptions:** `OortOrgProfiles.RequestOptions`
|
|
3267
|
+
**requestOptions:** `Root.RequestOptions`
|
|
3209
3268
|
|
|
3210
3269
|
</dd>
|
|
3211
3270
|
</dl>
|
|
@@ -3216,11 +3275,11 @@ await client.oortOrgProfiles.getAvatar({
|
|
|
3216
3275
|
</dl>
|
|
3217
3276
|
</details>
|
|
3218
3277
|
|
|
3219
|
-
<details><summary><code>client.
|
|
3278
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pydantic</a>() -> Chrt.PydanticResponse</code></summary>
|
|
3220
3279
|
<dl>
|
|
3221
3280
|
<dd>
|
|
3222
3281
|
|
|
3223
|
-
####
|
|
3282
|
+
#### 📝 Description
|
|
3224
3283
|
|
|
3225
3284
|
<dl>
|
|
3226
3285
|
<dd>
|
|
@@ -3228,16 +3287,14 @@ await client.oortOrgProfiles.getAvatar({
|
|
|
3228
3287
|
<dl>
|
|
3229
3288
|
<dd>
|
|
3230
3289
|
|
|
3231
|
-
|
|
3232
|
-
await client.oortOrgProfiles.getProfileByHandle("handle");
|
|
3233
|
-
```
|
|
3290
|
+
This route exposes pydantic models - which are not returned by any other route - to the OpenAPI spec to ensure they get included during sdk codegen
|
|
3234
3291
|
|
|
3235
3292
|
</dd>
|
|
3236
3293
|
</dl>
|
|
3237
3294
|
</dd>
|
|
3238
3295
|
</dl>
|
|
3239
3296
|
|
|
3240
|
-
####
|
|
3297
|
+
#### 🔌 Usage
|
|
3241
3298
|
|
|
3242
3299
|
<dl>
|
|
3243
3300
|
<dd>
|
|
@@ -3245,15 +3302,24 @@ await client.oortOrgProfiles.getProfileByHandle("handle");
|
|
|
3245
3302
|
<dl>
|
|
3246
3303
|
<dd>
|
|
3247
3304
|
|
|
3248
|
-
|
|
3305
|
+
```typescript
|
|
3306
|
+
await client.root.pydantic();
|
|
3307
|
+
```
|
|
3249
3308
|
|
|
3250
3309
|
</dd>
|
|
3251
3310
|
</dl>
|
|
3311
|
+
</dd>
|
|
3312
|
+
</dl>
|
|
3313
|
+
|
|
3314
|
+
#### ⚙️ Parameters
|
|
3252
3315
|
|
|
3253
3316
|
<dl>
|
|
3254
3317
|
<dd>
|
|
3255
3318
|
|
|
3256
|
-
|
|
3319
|
+
<dl>
|
|
3320
|
+
<dd>
|
|
3321
|
+
|
|
3322
|
+
**requestOptions:** `Root.RequestOptions`
|
|
3257
3323
|
|
|
3258
3324
|
</dd>
|
|
3259
3325
|
</dl>
|
|
@@ -3264,7 +3330,9 @@ await client.oortOrgProfiles.getProfileByHandle("handle");
|
|
|
3264
3330
|
</dl>
|
|
3265
3331
|
</details>
|
|
3266
3332
|
|
|
3267
|
-
|
|
3333
|
+
## Users
|
|
3334
|
+
|
|
3335
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicData</a>() -> Chrt.UserPublicData5</code></summary>
|
|
3268
3336
|
<dl>
|
|
3269
3337
|
<dd>
|
|
3270
3338
|
|
|
@@ -3277,7 +3345,7 @@ await client.oortOrgProfiles.getProfileByHandle("handle");
|
|
|
3277
3345
|
<dd>
|
|
3278
3346
|
|
|
3279
3347
|
```typescript
|
|
3280
|
-
await client.
|
|
3348
|
+
await client.users.getUserPublicData();
|
|
3281
3349
|
```
|
|
3282
3350
|
|
|
3283
3351
|
</dd>
|
|
@@ -3293,7 +3361,7 @@ await client.oortOrgProfiles.getProfileByOrgId();
|
|
|
3293
3361
|
<dl>
|
|
3294
3362
|
<dd>
|
|
3295
3363
|
|
|
3296
|
-
**requestOptions:** `
|
|
3364
|
+
**requestOptions:** `Users.RequestOptions`
|
|
3297
3365
|
|
|
3298
3366
|
</dd>
|
|
3299
3367
|
</dl>
|
|
@@ -3304,7 +3372,9 @@ await client.oortOrgProfiles.getProfileByOrgId();
|
|
|
3304
3372
|
</dl>
|
|
3305
3373
|
</details>
|
|
3306
3374
|
|
|
3307
|
-
|
|
3375
|
+
## Mirror
|
|
3376
|
+
|
|
3377
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">getAuthdMirror</a>() -> unknown</code></summary>
|
|
3308
3378
|
<dl>
|
|
3309
3379
|
<dd>
|
|
3310
3380
|
|
|
@@ -3317,12 +3387,7 @@ await client.oortOrgProfiles.getProfileByOrgId();
|
|
|
3317
3387
|
<dd>
|
|
3318
3388
|
|
|
3319
3389
|
```typescript
|
|
3320
|
-
await client.
|
|
3321
|
-
description: "description",
|
|
3322
|
-
email_address_primary: "email_address_primary",
|
|
3323
|
-
phone_number_primary: "phone_number_primary",
|
|
3324
|
-
schema_version: 1,
|
|
3325
|
-
});
|
|
3390
|
+
await client.mirror.getAuthdMirror();
|
|
3326
3391
|
```
|
|
3327
3392
|
|
|
3328
3393
|
</dd>
|
|
@@ -3338,15 +3403,7 @@ await client.oortOrgProfiles.postOrgProfile({
|
|
|
3338
3403
|
<dl>
|
|
3339
3404
|
<dd>
|
|
3340
3405
|
|
|
3341
|
-
**
|
|
3342
|
-
|
|
3343
|
-
</dd>
|
|
3344
|
-
</dl>
|
|
3345
|
-
|
|
3346
|
-
<dl>
|
|
3347
|
-
<dd>
|
|
3348
|
-
|
|
3349
|
-
**requestOptions:** `OortOrgProfiles.RequestOptions`
|
|
3406
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
3350
3407
|
|
|
3351
3408
|
</dd>
|
|
3352
3409
|
</dl>
|
|
@@ -3357,27 +3414,10 @@ await client.oortOrgProfiles.postOrgProfile({
|
|
|
3357
3414
|
</dl>
|
|
3358
3415
|
</details>
|
|
3359
3416
|
|
|
3360
|
-
|
|
3361
|
-
|
|
3362
|
-
<details><summary><code>client.oortShipperUserInfo.<a href="/src/api/resources/oortShipperUserInfo/client/Client.ts">getShipperUserInfoByUserId</a>() -> Chrt.ShipperUserInfo1</code></summary>
|
|
3363
|
-
<dl>
|
|
3364
|
-
<dd>
|
|
3365
|
-
|
|
3366
|
-
#### 📝 Description
|
|
3367
|
-
|
|
3368
|
-
<dl>
|
|
3369
|
-
<dd>
|
|
3370
|
-
|
|
3417
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">postAuthdMirror</a>() -> unknown</code></summary>
|
|
3371
3418
|
<dl>
|
|
3372
3419
|
<dd>
|
|
3373
3420
|
|
|
3374
|
-
Get the shipper user info for the authenticated user jwt
|
|
3375
|
-
|
|
3376
|
-
</dd>
|
|
3377
|
-
</dl>
|
|
3378
|
-
</dd>
|
|
3379
|
-
</dl>
|
|
3380
|
-
|
|
3381
3421
|
#### 🔌 Usage
|
|
3382
3422
|
|
|
3383
3423
|
<dl>
|
|
@@ -3387,7 +3427,7 @@ Get the shipper user info for the authenticated user jwt
|
|
|
3387
3427
|
<dd>
|
|
3388
3428
|
|
|
3389
3429
|
```typescript
|
|
3390
|
-
await client.
|
|
3430
|
+
await client.mirror.postAuthdMirror();
|
|
3391
3431
|
```
|
|
3392
3432
|
|
|
3393
3433
|
</dd>
|
|
@@ -3403,7 +3443,7 @@ await client.oortShipperUserInfo.getShipperUserInfoByUserId();
|
|
|
3403
3443
|
<dl>
|
|
3404
3444
|
<dd>
|
|
3405
3445
|
|
|
3406
|
-
**requestOptions:** `
|
|
3446
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
3407
3447
|
|
|
3408
3448
|
</dd>
|
|
3409
3449
|
</dl>
|
|
@@ -3414,7 +3454,7 @@ await client.oortShipperUserInfo.getShipperUserInfoByUserId();
|
|
|
3414
3454
|
</dl>
|
|
3415
3455
|
</details>
|
|
3416
3456
|
|
|
3417
|
-
<details><summary><code>client.
|
|
3457
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">putAuthdMirror</a>() -> unknown</code></summary>
|
|
3418
3458
|
<dl>
|
|
3419
3459
|
<dd>
|
|
3420
3460
|
|
|
@@ -3427,9 +3467,7 @@ await client.oortShipperUserInfo.getShipperUserInfoByUserId();
|
|
|
3427
3467
|
<dd>
|
|
3428
3468
|
|
|
3429
3469
|
```typescript
|
|
3430
|
-
await client.
|
|
3431
|
-
schema_version: 1,
|
|
3432
|
-
});
|
|
3470
|
+
await client.mirror.putAuthdMirror();
|
|
3433
3471
|
```
|
|
3434
3472
|
|
|
3435
3473
|
</dd>
|
|
@@ -3445,15 +3483,7 @@ await client.oortShipperUserInfo.createShipperUserInfo({
|
|
|
3445
3483
|
<dl>
|
|
3446
3484
|
<dd>
|
|
3447
3485
|
|
|
3448
|
-
**
|
|
3449
|
-
|
|
3450
|
-
</dd>
|
|
3451
|
-
</dl>
|
|
3452
|
-
|
|
3453
|
-
<dl>
|
|
3454
|
-
<dd>
|
|
3455
|
-
|
|
3456
|
-
**requestOptions:** `OortShipperUserInfo.RequestOptions`
|
|
3486
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
3457
3487
|
|
|
3458
3488
|
</dd>
|
|
3459
3489
|
</dl>
|
|
@@ -3464,25 +3494,10 @@ await client.oortShipperUserInfo.createShipperUserInfo({
|
|
|
3464
3494
|
</dl>
|
|
3465
3495
|
</details>
|
|
3466
3496
|
|
|
3467
|
-
<details><summary><code>client.
|
|
3468
|
-
<dl>
|
|
3469
|
-
<dd>
|
|
3470
|
-
|
|
3471
|
-
#### 📝 Description
|
|
3472
|
-
|
|
3473
|
-
<dl>
|
|
3474
|
-
<dd>
|
|
3475
|
-
|
|
3497
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">deleteAuthdMirror</a>() -> unknown</code></summary>
|
|
3476
3498
|
<dl>
|
|
3477
3499
|
<dd>
|
|
3478
3500
|
|
|
3479
|
-
Get the list of shipper user info for the authenticated user jwt
|
|
3480
|
-
|
|
3481
|
-
</dd>
|
|
3482
|
-
</dl>
|
|
3483
|
-
</dd>
|
|
3484
|
-
</dl>
|
|
3485
|
-
|
|
3486
3501
|
#### 🔌 Usage
|
|
3487
3502
|
|
|
3488
3503
|
<dl>
|
|
@@ -3492,7 +3507,7 @@ Get the list of shipper user info for the authenticated user jwt
|
|
|
3492
3507
|
<dd>
|
|
3493
3508
|
|
|
3494
3509
|
```typescript
|
|
3495
|
-
await client.
|
|
3510
|
+
await client.mirror.deleteAuthdMirror();
|
|
3496
3511
|
```
|
|
3497
3512
|
|
|
3498
3513
|
</dd>
|
|
@@ -3508,15 +3523,7 @@ await client.oortShipperUserInfo.getShipperUserInfoListByOrgId("org_id");
|
|
|
3508
3523
|
<dl>
|
|
3509
3524
|
<dd>
|
|
3510
3525
|
|
|
3511
|
-
**
|
|
3512
|
-
|
|
3513
|
-
</dd>
|
|
3514
|
-
</dl>
|
|
3515
|
-
|
|
3516
|
-
<dl>
|
|
3517
|
-
<dd>
|
|
3518
|
-
|
|
3519
|
-
**requestOptions:** `OortShipperUserInfo.RequestOptions`
|
|
3526
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
3520
3527
|
|
|
3521
3528
|
</dd>
|
|
3522
3529
|
</dl>
|
|
@@ -3527,7 +3534,7 @@ await client.oortShipperUserInfo.getShipperUserInfoListByOrgId("org_id");
|
|
|
3527
3534
|
</dl>
|
|
3528
3535
|
</details>
|
|
3529
3536
|
|
|
3530
|
-
<details><summary><code>client.
|
|
3537
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">patchAuthdMirror</a>() -> unknown</code></summary>
|
|
3531
3538
|
<dl>
|
|
3532
3539
|
<dd>
|
|
3533
3540
|
|
|
@@ -3540,7 +3547,7 @@ await client.oortShipperUserInfo.getShipperUserInfoListByOrgId("org_id");
|
|
|
3540
3547
|
<dd>
|
|
3541
3548
|
|
|
3542
3549
|
```typescript
|
|
3543
|
-
await client.
|
|
3550
|
+
await client.mirror.patchAuthdMirror();
|
|
3544
3551
|
```
|
|
3545
3552
|
|
|
3546
3553
|
</dd>
|
|
@@ -3556,15 +3563,7 @@ await client.oortShipperUserInfo.updateShipperUserInfo();
|
|
|
3556
3563
|
<dl>
|
|
3557
3564
|
<dd>
|
|
3558
3565
|
|
|
3559
|
-
**
|
|
3560
|
-
|
|
3561
|
-
</dd>
|
|
3562
|
-
</dl>
|
|
3563
|
-
|
|
3564
|
-
<dl>
|
|
3565
|
-
<dd>
|
|
3566
|
-
|
|
3567
|
-
**requestOptions:** `OortShipperUserInfo.RequestOptions`
|
|
3566
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
3568
3567
|
|
|
3569
3568
|
</dd>
|
|
3570
3569
|
</dl>
|
|
@@ -3575,27 +3574,10 @@ await client.oortShipperUserInfo.updateShipperUserInfo();
|
|
|
3575
3574
|
</dl>
|
|
3576
3575
|
</details>
|
|
3577
3576
|
|
|
3578
|
-
|
|
3579
|
-
|
|
3580
|
-
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsListByCourierOrgId</a>() -> Chrt.MultipleTaskGroupsWithTasks</code></summary>
|
|
3581
|
-
<dl>
|
|
3582
|
-
<dd>
|
|
3583
|
-
|
|
3584
|
-
#### 📝 Description
|
|
3585
|
-
|
|
3586
|
-
<dl>
|
|
3587
|
-
<dd>
|
|
3588
|
-
|
|
3577
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">getMirror</a>() -> unknown</code></summary>
|
|
3589
3578
|
<dl>
|
|
3590
3579
|
<dd>
|
|
3591
3580
|
|
|
3592
|
-
Uses the org_id from the JWT - returns task groups and with their list of tasks for the courier org
|
|
3593
|
-
|
|
3594
|
-
</dd>
|
|
3595
|
-
</dl>
|
|
3596
|
-
</dd>
|
|
3597
|
-
</dl>
|
|
3598
|
-
|
|
3599
3581
|
#### 🔌 Usage
|
|
3600
3582
|
|
|
3601
3583
|
<dl>
|
|
@@ -3605,7 +3587,7 @@ Uses the org_id from the JWT - returns task groups and with their list of tasks
|
|
|
3605
3587
|
<dd>
|
|
3606
3588
|
|
|
3607
3589
|
```typescript
|
|
3608
|
-
await client.
|
|
3590
|
+
await client.mirror.getMirror();
|
|
3609
3591
|
```
|
|
3610
3592
|
|
|
3611
3593
|
</dd>
|
|
@@ -3621,7 +3603,7 @@ await client.oortTaskGroups.getOortTaskGroupsListByCourierOrgId();
|
|
|
3621
3603
|
<dl>
|
|
3622
3604
|
<dd>
|
|
3623
3605
|
|
|
3624
|
-
**requestOptions:** `
|
|
3606
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
3625
3607
|
|
|
3626
3608
|
</dd>
|
|
3627
3609
|
</dl>
|
|
@@ -3632,517 +3614,11 @@ await client.oortTaskGroups.getOortTaskGroupsListByCourierOrgId();
|
|
|
3632
3614
|
</dl>
|
|
3633
3615
|
</details>
|
|
3634
3616
|
|
|
3635
|
-
<details><summary><code>client.
|
|
3617
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">postMirror</a>() -> unknown</code></summary>
|
|
3636
3618
|
<dl>
|
|
3637
3619
|
<dd>
|
|
3638
3620
|
|
|
3639
|
-
####
|
|
3640
|
-
|
|
3641
|
-
<dl>
|
|
3642
|
-
<dd>
|
|
3643
|
-
|
|
3644
|
-
<dl>
|
|
3645
|
-
<dd>
|
|
3646
|
-
|
|
3647
|
-
Uses the org_id from the JWT - returns multiple task groups with their tasks, milestones, and cargos
|
|
3648
|
-
|
|
3649
|
-
</dd>
|
|
3650
|
-
</dl>
|
|
3651
|
-
</dd>
|
|
3652
|
-
</dl>
|
|
3653
|
-
|
|
3654
|
-
#### 🔌 Usage
|
|
3655
|
-
|
|
3656
|
-
<dl>
|
|
3657
|
-
<dd>
|
|
3658
|
-
|
|
3659
|
-
<dl>
|
|
3660
|
-
<dd>
|
|
3661
|
-
|
|
3662
|
-
```typescript
|
|
3663
|
-
await client.oortTaskGroups.getOortTaskGroupsListByCourierOrgIdFull();
|
|
3664
|
-
```
|
|
3665
|
-
|
|
3666
|
-
</dd>
|
|
3667
|
-
</dl>
|
|
3668
|
-
</dd>
|
|
3669
|
-
</dl>
|
|
3670
|
-
|
|
3671
|
-
#### ⚙️ Parameters
|
|
3672
|
-
|
|
3673
|
-
<dl>
|
|
3674
|
-
<dd>
|
|
3675
|
-
|
|
3676
|
-
<dl>
|
|
3677
|
-
<dd>
|
|
3678
|
-
|
|
3679
|
-
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
3680
|
-
|
|
3681
|
-
</dd>
|
|
3682
|
-
</dl>
|
|
3683
|
-
</dd>
|
|
3684
|
-
</dl>
|
|
3685
|
-
|
|
3686
|
-
</dd>
|
|
3687
|
-
</dl>
|
|
3688
|
-
</details>
|
|
3689
|
-
|
|
3690
|
-
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getTaskGroupsListByDriverId</a>(driverId) -> Chrt.TaskGroup1[]</code></summary>
|
|
3691
|
-
<dl>
|
|
3692
|
-
<dd>
|
|
3693
|
-
|
|
3694
|
-
#### 🔌 Usage
|
|
3695
|
-
|
|
3696
|
-
<dl>
|
|
3697
|
-
<dd>
|
|
3698
|
-
|
|
3699
|
-
<dl>
|
|
3700
|
-
<dd>
|
|
3701
|
-
|
|
3702
|
-
```typescript
|
|
3703
|
-
await client.oortTaskGroups.getTaskGroupsListByDriverId("driver_id");
|
|
3704
|
-
```
|
|
3705
|
-
|
|
3706
|
-
</dd>
|
|
3707
|
-
</dl>
|
|
3708
|
-
</dd>
|
|
3709
|
-
</dl>
|
|
3710
|
-
|
|
3711
|
-
#### ⚙️ Parameters
|
|
3712
|
-
|
|
3713
|
-
<dl>
|
|
3714
|
-
<dd>
|
|
3715
|
-
|
|
3716
|
-
<dl>
|
|
3717
|
-
<dd>
|
|
3718
|
-
|
|
3719
|
-
**driverId:** `string`
|
|
3720
|
-
|
|
3721
|
-
</dd>
|
|
3722
|
-
</dl>
|
|
3723
|
-
|
|
3724
|
-
<dl>
|
|
3725
|
-
<dd>
|
|
3726
|
-
|
|
3727
|
-
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
3728
|
-
|
|
3729
|
-
</dd>
|
|
3730
|
-
</dl>
|
|
3731
|
-
</dd>
|
|
3732
|
-
</dl>
|
|
3733
|
-
|
|
3734
|
-
</dd>
|
|
3735
|
-
</dl>
|
|
3736
|
-
</details>
|
|
3737
|
-
|
|
3738
|
-
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">postOortTaskGroupsUpdate</a>({ ...params }) -> Chrt.UpdateTaskGroupRes</code></summary>
|
|
3739
|
-
<dl>
|
|
3740
|
-
<dd>
|
|
3741
|
-
|
|
3742
|
-
#### 🔌 Usage
|
|
3743
|
-
|
|
3744
|
-
<dl>
|
|
3745
|
-
<dd>
|
|
3746
|
-
|
|
3747
|
-
<dl>
|
|
3748
|
-
<dd>
|
|
3749
|
-
|
|
3750
|
-
```typescript
|
|
3751
|
-
await client.oortTaskGroups.postOortTaskGroupsUpdate({
|
|
3752
|
-
task_group_id: "task_group_id",
|
|
3753
|
-
});
|
|
3754
|
-
```
|
|
3755
|
-
|
|
3756
|
-
</dd>
|
|
3757
|
-
</dl>
|
|
3758
|
-
</dd>
|
|
3759
|
-
</dl>
|
|
3760
|
-
|
|
3761
|
-
#### ⚙️ Parameters
|
|
3762
|
-
|
|
3763
|
-
<dl>
|
|
3764
|
-
<dd>
|
|
3765
|
-
|
|
3766
|
-
<dl>
|
|
3767
|
-
<dd>
|
|
3768
|
-
|
|
3769
|
-
**request:** `Chrt.UpdateTaskGroupReq`
|
|
3770
|
-
|
|
3771
|
-
</dd>
|
|
3772
|
-
</dl>
|
|
3773
|
-
|
|
3774
|
-
<dl>
|
|
3775
|
-
<dd>
|
|
3776
|
-
|
|
3777
|
-
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
3778
|
-
|
|
3779
|
-
</dd>
|
|
3780
|
-
</dl>
|
|
3781
|
-
</dd>
|
|
3782
|
-
</dl>
|
|
3783
|
-
|
|
3784
|
-
</dd>
|
|
3785
|
-
</dl>
|
|
3786
|
-
</details>
|
|
3787
|
-
|
|
3788
|
-
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsTaskInfoList</a>(taskGroupId) -> Chrt.TaskGroupWithTasks</code></summary>
|
|
3789
|
-
<dl>
|
|
3790
|
-
<dd>
|
|
3791
|
-
|
|
3792
|
-
#### 📝 Description
|
|
3793
|
-
|
|
3794
|
-
<dl>
|
|
3795
|
-
<dd>
|
|
3796
|
-
|
|
3797
|
-
<dl>
|
|
3798
|
-
<dd>
|
|
3799
|
-
|
|
3800
|
-
Returns a single task group and its tasks
|
|
3801
|
-
|
|
3802
|
-
</dd>
|
|
3803
|
-
</dl>
|
|
3804
|
-
</dd>
|
|
3805
|
-
</dl>
|
|
3806
|
-
|
|
3807
|
-
#### 🔌 Usage
|
|
3808
|
-
|
|
3809
|
-
<dl>
|
|
3810
|
-
<dd>
|
|
3811
|
-
|
|
3812
|
-
<dl>
|
|
3813
|
-
<dd>
|
|
3814
|
-
|
|
3815
|
-
```typescript
|
|
3816
|
-
await client.oortTaskGroups.getOortTaskGroupsTaskInfoList("task_group_id");
|
|
3817
|
-
```
|
|
3818
|
-
|
|
3819
|
-
</dd>
|
|
3820
|
-
</dl>
|
|
3821
|
-
</dd>
|
|
3822
|
-
</dl>
|
|
3823
|
-
|
|
3824
|
-
#### ⚙️ Parameters
|
|
3825
|
-
|
|
3826
|
-
<dl>
|
|
3827
|
-
<dd>
|
|
3828
|
-
|
|
3829
|
-
<dl>
|
|
3830
|
-
<dd>
|
|
3831
|
-
|
|
3832
|
-
**taskGroupId:** `string`
|
|
3833
|
-
|
|
3834
|
-
</dd>
|
|
3835
|
-
</dl>
|
|
3836
|
-
|
|
3837
|
-
<dl>
|
|
3838
|
-
<dd>
|
|
3839
|
-
|
|
3840
|
-
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
3841
|
-
|
|
3842
|
-
</dd>
|
|
3843
|
-
</dl>
|
|
3844
|
-
</dd>
|
|
3845
|
-
</dl>
|
|
3846
|
-
|
|
3847
|
-
</dd>
|
|
3848
|
-
</dl>
|
|
3849
|
-
</details>
|
|
3850
|
-
|
|
3851
|
-
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">getOortTaskGroupsTaskInfoListFull</a>(taskGroupId) -> Chrt.TaskGroupWithDetails</code></summary>
|
|
3852
|
-
<dl>
|
|
3853
|
-
<dd>
|
|
3854
|
-
|
|
3855
|
-
#### 📝 Description
|
|
3856
|
-
|
|
3857
|
-
<dl>
|
|
3858
|
-
<dd>
|
|
3859
|
-
|
|
3860
|
-
<dl>
|
|
3861
|
-
<dd>
|
|
3862
|
-
|
|
3863
|
-
Returns a single task group and its tasks, milestones, and cargos
|
|
3864
|
-
|
|
3865
|
-
</dd>
|
|
3866
|
-
</dl>
|
|
3867
|
-
</dd>
|
|
3868
|
-
</dl>
|
|
3869
|
-
|
|
3870
|
-
#### 🔌 Usage
|
|
3871
|
-
|
|
3872
|
-
<dl>
|
|
3873
|
-
<dd>
|
|
3874
|
-
|
|
3875
|
-
<dl>
|
|
3876
|
-
<dd>
|
|
3877
|
-
|
|
3878
|
-
```typescript
|
|
3879
|
-
await client.oortTaskGroups.getOortTaskGroupsTaskInfoListFull("task_group_id");
|
|
3880
|
-
```
|
|
3881
|
-
|
|
3882
|
-
</dd>
|
|
3883
|
-
</dl>
|
|
3884
|
-
</dd>
|
|
3885
|
-
</dl>
|
|
3886
|
-
|
|
3887
|
-
#### ⚙️ Parameters
|
|
3888
|
-
|
|
3889
|
-
<dl>
|
|
3890
|
-
<dd>
|
|
3891
|
-
|
|
3892
|
-
<dl>
|
|
3893
|
-
<dd>
|
|
3894
|
-
|
|
3895
|
-
**taskGroupId:** `string`
|
|
3896
|
-
|
|
3897
|
-
</dd>
|
|
3898
|
-
</dl>
|
|
3899
|
-
|
|
3900
|
-
<dl>
|
|
3901
|
-
<dd>
|
|
3902
|
-
|
|
3903
|
-
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
3904
|
-
|
|
3905
|
-
</dd>
|
|
3906
|
-
</dl>
|
|
3907
|
-
</dd>
|
|
3908
|
-
</dl>
|
|
3909
|
-
|
|
3910
|
-
</dd>
|
|
3911
|
-
</dl>
|
|
3912
|
-
</details>
|
|
3913
|
-
|
|
3914
|
-
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">putOortTaskGroupsStart</a>(taskGroupId) -> boolean</code></summary>
|
|
3915
|
-
<dl>
|
|
3916
|
-
<dd>
|
|
3917
|
-
|
|
3918
|
-
#### 🔌 Usage
|
|
3919
|
-
|
|
3920
|
-
<dl>
|
|
3921
|
-
<dd>
|
|
3922
|
-
|
|
3923
|
-
<dl>
|
|
3924
|
-
<dd>
|
|
3925
|
-
|
|
3926
|
-
```typescript
|
|
3927
|
-
await client.oortTaskGroups.putOortTaskGroupsStart("task_group_id");
|
|
3928
|
-
```
|
|
3929
|
-
|
|
3930
|
-
</dd>
|
|
3931
|
-
</dl>
|
|
3932
|
-
</dd>
|
|
3933
|
-
</dl>
|
|
3934
|
-
|
|
3935
|
-
#### ⚙️ Parameters
|
|
3936
|
-
|
|
3937
|
-
<dl>
|
|
3938
|
-
<dd>
|
|
3939
|
-
|
|
3940
|
-
<dl>
|
|
3941
|
-
<dd>
|
|
3942
|
-
|
|
3943
|
-
**taskGroupId:** `string`
|
|
3944
|
-
|
|
3945
|
-
</dd>
|
|
3946
|
-
</dl>
|
|
3947
|
-
|
|
3948
|
-
<dl>
|
|
3949
|
-
<dd>
|
|
3950
|
-
|
|
3951
|
-
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
3952
|
-
|
|
3953
|
-
</dd>
|
|
3954
|
-
</dl>
|
|
3955
|
-
</dd>
|
|
3956
|
-
</dl>
|
|
3957
|
-
|
|
3958
|
-
</dd>
|
|
3959
|
-
</dl>
|
|
3960
|
-
</details>
|
|
3961
|
-
|
|
3962
|
-
<details><summary><code>client.oortTaskGroups.<a href="/src/api/resources/oortTaskGroups/client/Client.ts">putOortTaskGroupsSetPause</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
3963
|
-
<dl>
|
|
3964
|
-
<dd>
|
|
3965
|
-
|
|
3966
|
-
#### 🔌 Usage
|
|
3967
|
-
|
|
3968
|
-
<dl>
|
|
3969
|
-
<dd>
|
|
3970
|
-
|
|
3971
|
-
<dl>
|
|
3972
|
-
<dd>
|
|
3973
|
-
|
|
3974
|
-
```typescript
|
|
3975
|
-
await client.oortTaskGroups.putOortTaskGroupsSetPause("task_group_id", {
|
|
3976
|
-
paused: true,
|
|
3977
|
-
task_group_id: "task_group_id",
|
|
3978
|
-
});
|
|
3979
|
-
```
|
|
3980
|
-
|
|
3981
|
-
</dd>
|
|
3982
|
-
</dl>
|
|
3983
|
-
</dd>
|
|
3984
|
-
</dl>
|
|
3985
|
-
|
|
3986
|
-
#### ⚙️ Parameters
|
|
3987
|
-
|
|
3988
|
-
<dl>
|
|
3989
|
-
<dd>
|
|
3990
|
-
|
|
3991
|
-
<dl>
|
|
3992
|
-
<dd>
|
|
3993
|
-
|
|
3994
|
-
**taskGroupId:** `string`
|
|
3995
|
-
|
|
3996
|
-
</dd>
|
|
3997
|
-
</dl>
|
|
3998
|
-
|
|
3999
|
-
<dl>
|
|
4000
|
-
<dd>
|
|
4001
|
-
|
|
4002
|
-
**request:** `Chrt.SetTaskGroupPauseReq`
|
|
4003
|
-
|
|
4004
|
-
</dd>
|
|
4005
|
-
</dl>
|
|
4006
|
-
|
|
4007
|
-
<dl>
|
|
4008
|
-
<dd>
|
|
4009
|
-
|
|
4010
|
-
**requestOptions:** `OortTaskGroups.RequestOptions`
|
|
4011
|
-
|
|
4012
|
-
</dd>
|
|
4013
|
-
</dl>
|
|
4014
|
-
</dd>
|
|
4015
|
-
</dl>
|
|
4016
|
-
|
|
4017
|
-
</dd>
|
|
4018
|
-
</dl>
|
|
4019
|
-
</details>
|
|
4020
|
-
|
|
4021
|
-
## Orgs
|
|
4022
|
-
|
|
4023
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgsHandle</a>() -> string</code></summary>
|
|
4024
|
-
<dl>
|
|
4025
|
-
<dd>
|
|
4026
|
-
|
|
4027
|
-
#### 📝 Description
|
|
4028
|
-
|
|
4029
|
-
<dl>
|
|
4030
|
-
<dd>
|
|
4031
|
-
|
|
4032
|
-
<dl>
|
|
4033
|
-
<dd>
|
|
4034
|
-
|
|
4035
|
-
Get the handle for the org from JWT
|
|
4036
|
-
|
|
4037
|
-
</dd>
|
|
4038
|
-
</dl>
|
|
4039
|
-
</dd>
|
|
4040
|
-
</dl>
|
|
4041
|
-
|
|
4042
|
-
#### 🔌 Usage
|
|
4043
|
-
|
|
4044
|
-
<dl>
|
|
4045
|
-
<dd>
|
|
4046
|
-
|
|
4047
|
-
<dl>
|
|
4048
|
-
<dd>
|
|
4049
|
-
|
|
4050
|
-
```typescript
|
|
4051
|
-
await client.orgs.getOrgsHandle();
|
|
4052
|
-
```
|
|
4053
|
-
|
|
4054
|
-
</dd>
|
|
4055
|
-
</dl>
|
|
4056
|
-
</dd>
|
|
4057
|
-
</dl>
|
|
4058
|
-
|
|
4059
|
-
#### ⚙️ Parameters
|
|
4060
|
-
|
|
4061
|
-
<dl>
|
|
4062
|
-
<dd>
|
|
4063
|
-
|
|
4064
|
-
<dl>
|
|
4065
|
-
<dd>
|
|
4066
|
-
|
|
4067
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
4068
|
-
|
|
4069
|
-
</dd>
|
|
4070
|
-
</dl>
|
|
4071
|
-
</dd>
|
|
4072
|
-
</dl>
|
|
4073
|
-
|
|
4074
|
-
</dd>
|
|
4075
|
-
</dl>
|
|
4076
|
-
</details>
|
|
4077
|
-
|
|
4078
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getHandleAvailability</a>(handle) -> boolean</code></summary>
|
|
4079
|
-
<dl>
|
|
4080
|
-
<dd>
|
|
4081
|
-
|
|
4082
|
-
#### 📝 Description
|
|
4083
|
-
|
|
4084
|
-
<dl>
|
|
4085
|
-
<dd>
|
|
4086
|
-
|
|
4087
|
-
<dl>
|
|
4088
|
-
<dd>
|
|
4089
|
-
|
|
4090
|
-
Check if a handle is available, returns true if it is, false if it is not
|
|
4091
|
-
|
|
4092
|
-
</dd>
|
|
4093
|
-
</dl>
|
|
4094
|
-
</dd>
|
|
4095
|
-
</dl>
|
|
4096
|
-
|
|
4097
|
-
#### 🔌 Usage
|
|
4098
|
-
|
|
4099
|
-
<dl>
|
|
4100
|
-
<dd>
|
|
4101
|
-
|
|
4102
|
-
<dl>
|
|
4103
|
-
<dd>
|
|
4104
|
-
|
|
4105
|
-
```typescript
|
|
4106
|
-
await client.orgs.getHandleAvailability("handle");
|
|
4107
|
-
```
|
|
4108
|
-
|
|
4109
|
-
</dd>
|
|
4110
|
-
</dl>
|
|
4111
|
-
</dd>
|
|
4112
|
-
</dl>
|
|
4113
|
-
|
|
4114
|
-
#### ⚙️ Parameters
|
|
4115
|
-
|
|
4116
|
-
<dl>
|
|
4117
|
-
<dd>
|
|
4118
|
-
|
|
4119
|
-
<dl>
|
|
4120
|
-
<dd>
|
|
4121
|
-
|
|
4122
|
-
**handle:** `string`
|
|
4123
|
-
|
|
4124
|
-
</dd>
|
|
4125
|
-
</dl>
|
|
4126
|
-
|
|
4127
|
-
<dl>
|
|
4128
|
-
<dd>
|
|
4129
|
-
|
|
4130
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
4131
|
-
|
|
4132
|
-
</dd>
|
|
4133
|
-
</dl>
|
|
4134
|
-
</dd>
|
|
4135
|
-
</dl>
|
|
4136
|
-
|
|
4137
|
-
</dd>
|
|
4138
|
-
</dl>
|
|
4139
|
-
</details>
|
|
4140
|
-
|
|
4141
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgMembers</a>() -> Chrt.OrgMemberDetails[]</code></summary>
|
|
4142
|
-
<dl>
|
|
4143
|
-
<dd>
|
|
4144
|
-
|
|
4145
|
-
#### 🔌 Usage
|
|
3621
|
+
#### 🔌 Usage
|
|
4146
3622
|
|
|
4147
3623
|
<dl>
|
|
4148
3624
|
<dd>
|
|
@@ -4151,7 +3627,7 @@ await client.orgs.getHandleAvailability("handle");
|
|
|
4151
3627
|
<dd>
|
|
4152
3628
|
|
|
4153
3629
|
```typescript
|
|
4154
|
-
await client.
|
|
3630
|
+
await client.mirror.postMirror();
|
|
4155
3631
|
```
|
|
4156
3632
|
|
|
4157
3633
|
</dd>
|
|
@@ -4167,7 +3643,7 @@ await client.orgs.getOrgMembers();
|
|
|
4167
3643
|
<dl>
|
|
4168
3644
|
<dd>
|
|
4169
3645
|
|
|
4170
|
-
**requestOptions:** `
|
|
3646
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
4171
3647
|
|
|
4172
3648
|
</dd>
|
|
4173
3649
|
</dl>
|
|
@@ -4178,25 +3654,10 @@ await client.orgs.getOrgMembers();
|
|
|
4178
3654
|
</dl>
|
|
4179
3655
|
</details>
|
|
4180
3656
|
|
|
4181
|
-
<details><summary><code>client.
|
|
4182
|
-
<dl>
|
|
4183
|
-
<dd>
|
|
4184
|
-
|
|
4185
|
-
#### 📝 Description
|
|
4186
|
-
|
|
4187
|
-
<dl>
|
|
4188
|
-
<dd>
|
|
4189
|
-
|
|
3657
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">putMirror</a>() -> unknown</code></summary>
|
|
4190
3658
|
<dl>
|
|
4191
3659
|
<dd>
|
|
4192
3660
|
|
|
4193
|
-
Get the org public data for the org from JWT
|
|
4194
|
-
|
|
4195
|
-
</dd>
|
|
4196
|
-
</dl>
|
|
4197
|
-
</dd>
|
|
4198
|
-
</dl>
|
|
4199
|
-
|
|
4200
3661
|
#### 🔌 Usage
|
|
4201
3662
|
|
|
4202
3663
|
<dl>
|
|
@@ -4206,7 +3667,7 @@ Get the org public data for the org from JWT
|
|
|
4206
3667
|
<dd>
|
|
4207
3668
|
|
|
4208
3669
|
```typescript
|
|
4209
|
-
await client.
|
|
3670
|
+
await client.mirror.putMirror();
|
|
4210
3671
|
```
|
|
4211
3672
|
|
|
4212
3673
|
</dd>
|
|
@@ -4222,7 +3683,7 @@ await client.orgs.getOrgsPublicData();
|
|
|
4222
3683
|
<dl>
|
|
4223
3684
|
<dd>
|
|
4224
3685
|
|
|
4225
|
-
**requestOptions:** `
|
|
3686
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
4226
3687
|
|
|
4227
3688
|
</dd>
|
|
4228
3689
|
</dl>
|
|
@@ -4233,25 +3694,10 @@ await client.orgs.getOrgsPublicData();
|
|
|
4233
3694
|
</dl>
|
|
4234
3695
|
</details>
|
|
4235
3696
|
|
|
4236
|
-
<details><summary><code>client.
|
|
4237
|
-
<dl>
|
|
4238
|
-
<dd>
|
|
4239
|
-
|
|
4240
|
-
#### 📝 Description
|
|
4241
|
-
|
|
4242
|
-
<dl>
|
|
4243
|
-
<dd>
|
|
4244
|
-
|
|
3697
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">deleteMirror</a>() -> unknown</code></summary>
|
|
4245
3698
|
<dl>
|
|
4246
3699
|
<dd>
|
|
4247
3700
|
|
|
4248
|
-
Create org public data with handle and company name
|
|
4249
|
-
|
|
4250
|
-
</dd>
|
|
4251
|
-
</dl>
|
|
4252
|
-
</dd>
|
|
4253
|
-
</dl>
|
|
4254
|
-
|
|
4255
3701
|
#### 🔌 Usage
|
|
4256
3702
|
|
|
4257
3703
|
<dl>
|
|
@@ -4261,10 +3707,7 @@ Create org public data with handle and company name
|
|
|
4261
3707
|
<dd>
|
|
4262
3708
|
|
|
4263
3709
|
```typescript
|
|
4264
|
-
await client.
|
|
4265
|
-
company_name: "company_name",
|
|
4266
|
-
handle: "handle",
|
|
4267
|
-
});
|
|
3710
|
+
await client.mirror.deleteMirror();
|
|
4268
3711
|
```
|
|
4269
3712
|
|
|
4270
3713
|
</dd>
|
|
@@ -4280,15 +3723,7 @@ await client.orgs.postOrgsPublicData({
|
|
|
4280
3723
|
<dl>
|
|
4281
3724
|
<dd>
|
|
4282
3725
|
|
|
4283
|
-
**
|
|
4284
|
-
|
|
4285
|
-
</dd>
|
|
4286
|
-
</dl>
|
|
4287
|
-
|
|
4288
|
-
<dl>
|
|
4289
|
-
<dd>
|
|
4290
|
-
|
|
4291
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
3726
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
4292
3727
|
|
|
4293
3728
|
</dd>
|
|
4294
3729
|
</dl>
|
|
@@ -4299,25 +3734,10 @@ await client.orgs.postOrgsPublicData({
|
|
|
4299
3734
|
</dl>
|
|
4300
3735
|
</details>
|
|
4301
3736
|
|
|
4302
|
-
<details><summary><code>client.
|
|
4303
|
-
<dl>
|
|
4304
|
-
<dd>
|
|
4305
|
-
|
|
4306
|
-
#### 📝 Description
|
|
4307
|
-
|
|
4308
|
-
<dl>
|
|
4309
|
-
<dd>
|
|
4310
|
-
|
|
3737
|
+
<details><summary><code>client.mirror.<a href="/src/api/resources/mirror/client/Client.ts">patchMirror</a>() -> unknown</code></summary>
|
|
4311
3738
|
<dl>
|
|
4312
3739
|
<dd>
|
|
4313
3740
|
|
|
4314
|
-
Update handle or company_name for an org
|
|
4315
|
-
|
|
4316
|
-
</dd>
|
|
4317
|
-
</dl>
|
|
4318
|
-
</dd>
|
|
4319
|
-
</dl>
|
|
4320
|
-
|
|
4321
3741
|
#### 🔌 Usage
|
|
4322
3742
|
|
|
4323
3743
|
<dl>
|
|
@@ -4327,7 +3747,7 @@ Update handle or company_name for an org
|
|
|
4327
3747
|
<dd>
|
|
4328
3748
|
|
|
4329
3749
|
```typescript
|
|
4330
|
-
await client.
|
|
3750
|
+
await client.mirror.patchMirror();
|
|
4331
3751
|
```
|
|
4332
3752
|
|
|
4333
3753
|
</dd>
|
|
@@ -4343,15 +3763,7 @@ await client.orgs.patchOrgsPublicData();
|
|
|
4343
3763
|
<dl>
|
|
4344
3764
|
<dd>
|
|
4345
3765
|
|
|
4346
|
-
**
|
|
4347
|
-
|
|
4348
|
-
</dd>
|
|
4349
|
-
</dl>
|
|
4350
|
-
|
|
4351
|
-
<dl>
|
|
4352
|
-
<dd>
|
|
4353
|
-
|
|
4354
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
3766
|
+
**requestOptions:** `Mirror.RequestOptions`
|
|
4355
3767
|
|
|
4356
3768
|
</dd>
|
|
4357
3769
|
</dl>
|
|
@@ -4362,25 +3774,12 @@ await client.orgs.patchOrgsPublicData();
|
|
|
4362
3774
|
</dl>
|
|
4363
3775
|
</details>
|
|
4364
3776
|
|
|
4365
|
-
|
|
4366
|
-
<dl>
|
|
4367
|
-
<dd>
|
|
4368
|
-
|
|
4369
|
-
#### 📝 Description
|
|
4370
|
-
|
|
4371
|
-
<dl>
|
|
4372
|
-
<dd>
|
|
3777
|
+
## OortCourierPayDriverRate
|
|
4373
3778
|
|
|
3779
|
+
<details><summary><code>client.oortCourierPayDriverRate.<a href="/src/api/resources/oortCourierPayDriverRate/client/Client.ts">getOortCourierPayDriverRateSheetsByCourierOrgId</a>() -> void</code></summary>
|
|
4374
3780
|
<dl>
|
|
4375
3781
|
<dd>
|
|
4376
3782
|
|
|
4377
|
-
Get the org public data for the org from org_id
|
|
4378
|
-
|
|
4379
|
-
</dd>
|
|
4380
|
-
</dl>
|
|
4381
|
-
</dd>
|
|
4382
|
-
</dl>
|
|
4383
|
-
|
|
4384
3783
|
#### 🔌 Usage
|
|
4385
3784
|
|
|
4386
3785
|
<dl>
|
|
@@ -4390,7 +3789,7 @@ Get the org public data for the org from org_id
|
|
|
4390
3789
|
<dd>
|
|
4391
3790
|
|
|
4392
3791
|
```typescript
|
|
4393
|
-
await client.
|
|
3792
|
+
await client.oortCourierPayDriverRate.getOortCourierPayDriverRateSheetsByCourierOrgId();
|
|
4394
3793
|
```
|
|
4395
3794
|
|
|
4396
3795
|
</dd>
|
|
@@ -4406,15 +3805,7 @@ await client.orgs.getOrgsPublicDataByOrgId("org_id");
|
|
|
4406
3805
|
<dl>
|
|
4407
3806
|
<dd>
|
|
4408
3807
|
|
|
4409
|
-
**
|
|
4410
|
-
|
|
4411
|
-
</dd>
|
|
4412
|
-
</dl>
|
|
4413
|
-
|
|
4414
|
-
<dl>
|
|
4415
|
-
<dd>
|
|
4416
|
-
|
|
4417
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
3808
|
+
**requestOptions:** `OortCourierPayDriverRate.RequestOptions`
|
|
4418
3809
|
|
|
4419
3810
|
</dd>
|
|
4420
3811
|
</dl>
|
|
@@ -4425,33 +3816,10 @@ await client.orgs.getOrgsPublicDataByOrgId("org_id");
|
|
|
4425
3816
|
</dl>
|
|
4426
3817
|
</details>
|
|
4427
3818
|
|
|
4428
|
-
|
|
4429
|
-
|
|
4430
|
-
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createCheckoutSession</a>({ ...params }) -> Chrt.CreateCheckoutSessionRes2</code></summary>
|
|
4431
|
-
<dl>
|
|
4432
|
-
<dd>
|
|
4433
|
-
|
|
4434
|
-
#### 📝 Description
|
|
4435
|
-
|
|
4436
|
-
<dl>
|
|
4437
|
-
<dd>
|
|
4438
|
-
|
|
3819
|
+
<details><summary><code>client.oortCourierPayDriverRate.<a href="/src/api/resources/oortCourierPayDriverRate/client/Client.ts">getOortCourierPayDriverRateSheetsByDriverIdDriverId</a>(driverId) -> void</code></summary>
|
|
4439
3820
|
<dl>
|
|
4440
3821
|
<dd>
|
|
4441
3822
|
|
|
4442
|
-
Steps:
|
|
4443
|
-
(1) (a) Validate and decode the jwt, (b) check for an org_id
|
|
4444
|
-
(2) Resolve the subscription_plan
|
|
4445
|
-
(3) Check for an already-active same subscription within the org
|
|
4446
|
-
(4) Check if the current org membership count <= subscription_plan's limit
|
|
4447
|
-
(5) Get the customer_id
|
|
4448
|
-
(6) Create the checkout session url
|
|
4449
|
-
|
|
4450
|
-
</dd>
|
|
4451
|
-
</dl>
|
|
4452
|
-
</dd>
|
|
4453
|
-
</dl>
|
|
4454
|
-
|
|
4455
3823
|
#### 🔌 Usage
|
|
4456
3824
|
|
|
4457
3825
|
<dl>
|
|
@@ -4461,9 +3829,7 @@ Steps:
|
|
|
4461
3829
|
<dd>
|
|
4462
3830
|
|
|
4463
3831
|
```typescript
|
|
4464
|
-
await client.
|
|
4465
|
-
price_name: "courier_ops_solo_100_month",
|
|
4466
|
-
});
|
|
3832
|
+
await client.oortCourierPayDriverRate.getOortCourierPayDriverRateSheetsByDriverIdDriverId("driver_id");
|
|
4467
3833
|
```
|
|
4468
3834
|
|
|
4469
3835
|
</dd>
|
|
@@ -4479,55 +3845,15 @@ await client.payments.createCheckoutSession({
|
|
|
4479
3845
|
<dl>
|
|
4480
3846
|
<dd>
|
|
4481
3847
|
|
|
4482
|
-
**
|
|
4483
|
-
|
|
4484
|
-
</dd>
|
|
4485
|
-
</dl>
|
|
4486
|
-
|
|
4487
|
-
<dl>
|
|
4488
|
-
<dd>
|
|
4489
|
-
|
|
4490
|
-
**requestOptions:** `Payments.RequestOptions`
|
|
4491
|
-
|
|
4492
|
-
</dd>
|
|
4493
|
-
</dl>
|
|
4494
|
-
</dd>
|
|
4495
|
-
</dl>
|
|
4496
|
-
|
|
4497
|
-
</dd>
|
|
4498
|
-
</dl>
|
|
4499
|
-
</details>
|
|
4500
|
-
|
|
4501
|
-
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerk</a>() -> boolean</code></summary>
|
|
4502
|
-
<dl>
|
|
4503
|
-
<dd>
|
|
4504
|
-
|
|
4505
|
-
#### 🔌 Usage
|
|
4506
|
-
|
|
4507
|
-
<dl>
|
|
4508
|
-
<dd>
|
|
4509
|
-
|
|
4510
|
-
<dl>
|
|
4511
|
-
<dd>
|
|
4512
|
-
|
|
4513
|
-
```typescript
|
|
4514
|
-
await client.payments.syncStripeToClerk();
|
|
4515
|
-
```
|
|
3848
|
+
**driverId:** `string`
|
|
4516
3849
|
|
|
4517
3850
|
</dd>
|
|
4518
3851
|
</dl>
|
|
4519
|
-
</dd>
|
|
4520
|
-
</dl>
|
|
4521
|
-
|
|
4522
|
-
#### ⚙️ Parameters
|
|
4523
|
-
|
|
4524
|
-
<dl>
|
|
4525
|
-
<dd>
|
|
4526
3852
|
|
|
4527
3853
|
<dl>
|
|
4528
3854
|
<dd>
|
|
4529
3855
|
|
|
4530
|
-
**requestOptions:** `
|
|
3856
|
+
**requestOptions:** `OortCourierPayDriverRate.RequestOptions`
|
|
4531
3857
|
|
|
4532
3858
|
</dd>
|
|
4533
3859
|
</dl>
|
|
@@ -4538,7 +3864,7 @@ await client.payments.syncStripeToClerk();
|
|
|
4538
3864
|
</dl>
|
|
4539
3865
|
</details>
|
|
4540
3866
|
|
|
4541
|
-
<details><summary><code>client.
|
|
3867
|
+
<details><summary><code>client.oortCourierPayDriverRate.<a href="/src/api/resources/oortCourierPayDriverRate/client/Client.ts">getOortCourierPayDriverRateSheetsByShipperOrgId</a>() -> void</code></summary>
|
|
4542
3868
|
<dl>
|
|
4543
3869
|
<dd>
|
|
4544
3870
|
|
|
@@ -4551,7 +3877,7 @@ await client.payments.syncStripeToClerk();
|
|
|
4551
3877
|
<dd>
|
|
4552
3878
|
|
|
4553
3879
|
```typescript
|
|
4554
|
-
await client.
|
|
3880
|
+
await client.oortCourierPayDriverRate.getOortCourierPayDriverRateSheetsByShipperOrgId();
|
|
4555
3881
|
```
|
|
4556
3882
|
|
|
4557
3883
|
</dd>
|
|
@@ -4567,7 +3893,7 @@ await client.payments.webhook();
|
|
|
4567
3893
|
<dl>
|
|
4568
3894
|
<dd>
|
|
4569
3895
|
|
|
4570
|
-
**requestOptions:** `
|
|
3896
|
+
**requestOptions:** `OortCourierPayDriverRate.RequestOptions`
|
|
4571
3897
|
|
|
4572
3898
|
</dd>
|
|
4573
3899
|
</dl>
|
|
@@ -4578,9 +3904,7 @@ await client.payments.webhook();
|
|
|
4578
3904
|
</dl>
|
|
4579
3905
|
</details>
|
|
4580
3906
|
|
|
4581
|
-
|
|
4582
|
-
|
|
4583
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicData</a>() -> Chrt.UserPublicData5</code></summary>
|
|
3907
|
+
<details><summary><code>client.oortCourierPayDriverRate.<a href="/src/api/resources/oortCourierPayDriverRate/client/Client.ts">postOortCourierPayDriverRateSheetsCreate</a>() -> void</code></summary>
|
|
4584
3908
|
<dl>
|
|
4585
3909
|
<dd>
|
|
4586
3910
|
|
|
@@ -4593,7 +3917,7 @@ await client.payments.webhook();
|
|
|
4593
3917
|
<dd>
|
|
4594
3918
|
|
|
4595
3919
|
```typescript
|
|
4596
|
-
await client.
|
|
3920
|
+
await client.oortCourierPayDriverRate.postOortCourierPayDriverRateSheetsCreate();
|
|
4597
3921
|
```
|
|
4598
3922
|
|
|
4599
3923
|
</dd>
|
|
@@ -4609,7 +3933,7 @@ await client.users.getUserPublicData();
|
|
|
4609
3933
|
<dl>
|
|
4610
3934
|
<dd>
|
|
4611
3935
|
|
|
4612
|
-
**requestOptions:** `
|
|
3936
|
+
**requestOptions:** `OortCourierPayDriverRate.RequestOptions`
|
|
4613
3937
|
|
|
4614
3938
|
</dd>
|
|
4615
3939
|
</dl>
|