@chrt-inc/typescript-sdk 1.676.0 → 1.685.0
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/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/Client.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/Client.js +0 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/requests/BillingLedgerPeriodsListV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.js +0 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgersListV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +0 -1
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.d.ts +0 -2
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.js +0 -2
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.d.ts +0 -2
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.js +0 -2
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.d.ts +0 -6
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.js +0 -6
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.ts +0 -2
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.ts +0 -2
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.ts +0 -2
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.d.ts +0 -2
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.js +0 -2
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.ts +0 -2
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.js +1 -2
- package/dist/cjs/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.ts +1 -2
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +3 -1
- package/dist/cjs/api/resources/orgs/client/Client.js +13 -9
- package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.d.ts +76 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.js +248 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/index.js +17 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.ts +17 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/index.js +18 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/index.js +41 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.d.ts +83 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.js +311 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.js +17 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.d.ts +13 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.js +17 -0
- package/dist/cjs/api/resources/orgs/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/index.js +3 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +3 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +5 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/index.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.ts +80 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.js +257 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.ts +17 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.js +18 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.js +41 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.d.ts +83 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.js +311 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/index.js +41 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.js +0 -2
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +0 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +1 -1
- package/dist/cjs/api/types/BillingLineItemS3ObjectAddedWebhookPayload.d.ts +14 -0
- package/dist/cjs/api/types/BillingLineItemS3ObjectAddedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/DateTimeWindow1.d.ts +7 -0
- package/dist/cjs/api/types/DateTimeWindow1.js +5 -0
- package/dist/cjs/api/types/DriverComplianceDocument1.d.ts +15 -0
- package/dist/cjs/api/types/DriverComplianceDocument1.js +5 -0
- package/dist/cjs/api/types/DriverComplianceDocumentS3ObjectMetadata1.d.ts +19 -0
- package/dist/cjs/api/types/DriverComplianceDocumentS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.d.ts +8 -0
- package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.js +10 -0
- package/dist/cjs/api/types/ListingBidThreadActionAddedWebhookPayload.d.ts +21 -0
- package/dist/cjs/api/types/ListingBidThreadActionAddedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +8 -2
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +7 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +7 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +6 -0
- package/dist/cjs/api/types/OperationsCaseMessageWebhookPayload.d.ts +15 -0
- package/dist/cjs/api/types/OperationsCaseMessageWebhookPayload.js +5 -0
- package/dist/cjs/api/types/OperationsCaseS3ObjectAddedWebhookPayload.d.ts +14 -0
- package/dist/cjs/api/types/OperationsCaseS3ObjectAddedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/OrgComplianceDocument1.d.ts +15 -0
- package/dist/cjs/api/types/OrgComplianceDocument1.js +5 -0
- package/dist/cjs/api/types/OrgComplianceDocumentS3ObjectMetadata1.d.ts +19 -0
- package/dist/cjs/api/types/OrgComplianceDocumentS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.d.ts +8 -0
- package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.js +10 -0
- package/dist/cjs/api/types/ShippingTaskAttemptedWebhookPayload.d.ts +22 -0
- package/dist/cjs/api/types/ShippingTaskAttemptedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.d.ts +17 -0
- package/dist/cjs/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.d.ts +14 -0
- package/dist/cjs/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +1 -1
- package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -1
- package/dist/cjs/api/types/TaskClientUpdate1.d.ts +1 -1
- package/dist/cjs/api/types/TimeWindow1.d.ts +2 -2
- package/dist/cjs/api/types/index.d.ts +14 -1
- package/dist/cjs/api/types/index.js +14 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/Client.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/Client.mjs +0 -1
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/requests/BillingLedgerPeriodsListV1Request.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/Client.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/Client.mjs +0 -1
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgersListV1Request.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +0 -1
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListV1Request.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts +0 -2
- package/dist/esm/api/resources/billing/resources/statements/client/Client.mjs +0 -2
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.mts +0 -1
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.d.mts +0 -2
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.mjs +0 -2
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.mts +0 -1
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.mts +0 -1
- package/dist/esm/api/resources/listing/resources/listings/client/Client.d.mts +0 -6
- package/dist/esm/api/resources/listing/resources/listings/client/Client.mjs +0 -6
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.mts +0 -2
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.mts +0 -2
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.mts +0 -2
- package/dist/esm/api/resources/operations/resources/cases/client/Client.d.mts +0 -2
- package/dist/esm/api/resources/operations/resources/cases/client/Client.mjs +0 -2
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.mts +0 -2
- package/dist/esm/api/resources/operations/resources/departments/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/operations/resources/departments/client/Client.mjs +1 -2
- package/dist/esm/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.mts +1 -2
- package/dist/esm/api/resources/orgs/client/Client.d.mts +3 -1
- package/dist/esm/api/resources/orgs/client/Client.mjs +5 -1
- package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +0 -1
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.d.mts +76 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.mjs +211 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.mts +17 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/index.mjs +2 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/index.mjs +2 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.d.mts +83 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.mjs +274 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.d.mts +13 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +3 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +5 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/drivers/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.mts +80 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.mjs +220 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.mts +17 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.d.mts +83 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.mjs +274 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.mjs +0 -2
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +0 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +0 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +1 -1
- package/dist/esm/api/types/BillingLineItemS3ObjectAddedWebhookPayload.d.mts +14 -0
- package/dist/esm/api/types/BillingLineItemS3ObjectAddedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/DateTimeWindow1.d.mts +7 -0
- package/dist/esm/api/types/DateTimeWindow1.mjs +4 -0
- package/dist/esm/api/types/DriverComplianceDocument1.d.mts +15 -0
- package/dist/esm/api/types/DriverComplianceDocument1.mjs +4 -0
- package/dist/esm/api/types/DriverComplianceDocumentS3ObjectMetadata1.d.mts +19 -0
- package/dist/esm/api/types/DriverComplianceDocumentS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.d.mts +8 -0
- package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.mjs +7 -0
- package/dist/esm/api/types/ListingBidThreadActionAddedWebhookPayload.d.mts +21 -0
- package/dist/esm/api/types/ListingBidThreadActionAddedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +8 -2
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +7 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +7 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +6 -0
- package/dist/esm/api/types/OperationsCaseMessageWebhookPayload.d.mts +15 -0
- package/dist/esm/api/types/OperationsCaseMessageWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/OperationsCaseS3ObjectAddedWebhookPayload.d.mts +14 -0
- package/dist/esm/api/types/OperationsCaseS3ObjectAddedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/OrgComplianceDocument1.d.mts +15 -0
- package/dist/esm/api/types/OrgComplianceDocument1.mjs +4 -0
- package/dist/esm/api/types/OrgComplianceDocumentS3ObjectMetadata1.d.mts +19 -0
- package/dist/esm/api/types/OrgComplianceDocumentS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.d.mts +8 -0
- package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.mjs +7 -0
- package/dist/esm/api/types/ShippingTaskAttemptedWebhookPayload.d.mts +22 -0
- package/dist/esm/api/types/ShippingTaskAttemptedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.d.mts +17 -0
- package/dist/esm/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.d.mts +14 -0
- package/dist/esm/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +1 -1
- package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -1
- package/dist/esm/api/types/TaskClientUpdate1.d.mts +1 -1
- package/dist/esm/api/types/TimeWindow1.d.mts +2 -2
- package/dist/esm/api/types/index.d.mts +14 -1
- package/dist/esm/api/types/index.mjs +14 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1487 -593
- package/dist/cjs/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.d.ts +0 -14
- package/dist/esm/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.d.mts +0 -14
- /package/dist/cjs/api/{types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.js → resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.js} +0 -0
- /package/dist/esm/api/{types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.mjs → resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -86,7 +86,6 @@ Lists all members of the caller's organization with their roles and details. Sup
|
|
|
86
86
|
|
|
87
87
|
```typescript
|
|
88
88
|
await client.orgs.listMembersV1({
|
|
89
|
-
filter_role: ["owner"],
|
|
90
89
|
sort_by: "first_name",
|
|
91
90
|
sort_order: "asc",
|
|
92
91
|
page: 1,
|
|
@@ -481,7 +480,6 @@ await client.billing.billingLedgers.listV1({
|
|
|
481
480
|
sort_order: "asc",
|
|
482
481
|
page: 1,
|
|
483
482
|
page_size: 1,
|
|
484
|
-
filter_status: ["active"],
|
|
485
483
|
filter_task_group_type: "chrt_ground_provider",
|
|
486
484
|
filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
487
485
|
filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -819,7 +817,6 @@ await client.billing.billingLedgerPeriods.listV1({
|
|
|
819
817
|
page_size: 1,
|
|
820
818
|
filter_billing_ledger_id: "filter_billing_ledger_id",
|
|
821
819
|
filter_owned_by_org_id: "filter_owned_by_org_id",
|
|
822
|
-
filter_status: ["open"],
|
|
823
820
|
filter_statement_id: "filter_statement_id",
|
|
824
821
|
filter_attached_to_statement: true,
|
|
825
822
|
filter_period_end_at_timestamp_before: "2024-01-15T09:30:00Z",
|
|
@@ -1227,7 +1224,6 @@ await client.billing.lineItemGroups.listV1({
|
|
|
1227
1224
|
sort_order: "asc",
|
|
1228
1225
|
page: 1,
|
|
1229
1226
|
page_size: 1,
|
|
1230
|
-
filter_status: ["staged"],
|
|
1231
1227
|
filter_task_group_id: "filter_task_group_id",
|
|
1232
1228
|
filter_order_id: "filter_order_id",
|
|
1233
1229
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -4263,7 +4259,6 @@ await client.billing.statements.listV1({
|
|
|
4263
4259
|
sort_order: "asc",
|
|
4264
4260
|
page: 1,
|
|
4265
4261
|
page_size: 1,
|
|
4266
|
-
filter_status: ["staged"],
|
|
4267
4262
|
filter_settlement_type: "stripe_connect",
|
|
4268
4263
|
filter_order_id: "filter_order_id",
|
|
4269
4264
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -4348,7 +4343,6 @@ await client.billing.statements.expandedListV1({
|
|
|
4348
4343
|
sort_order: "asc",
|
|
4349
4344
|
page: 1,
|
|
4350
4345
|
page_size: 1,
|
|
4351
|
-
filter_status: ["staged"],
|
|
4352
4346
|
filter_settlement_type: "stripe_connect",
|
|
4353
4347
|
filter_order_id: "filter_order_id",
|
|
4354
4348
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -6985,8 +6979,6 @@ await client.listing.listings.listByOrgV1({
|
|
|
6985
6979
|
sort_order: "asc",
|
|
6986
6980
|
page: 1,
|
|
6987
6981
|
page_size: 1,
|
|
6988
|
-
filter_status: ["open"],
|
|
6989
|
-
filter_type: ["dispatch"],
|
|
6990
6982
|
filter_task_group_id: "filter_task_group_id",
|
|
6991
6983
|
filter_order_id: "filter_order_id",
|
|
6992
6984
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -7063,8 +7055,6 @@ await client.listing.listings.listForProviderBidderV1({
|
|
|
7063
7055
|
sort_order: "asc",
|
|
7064
7056
|
page: 1,
|
|
7065
7057
|
page_size: 1,
|
|
7066
|
-
filter_status: ["open"],
|
|
7067
|
-
filter_type: ["dispatch"],
|
|
7068
7058
|
filter_task_group_id: "filter_task_group_id",
|
|
7069
7059
|
filter_order_id: "filter_order_id",
|
|
7070
7060
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -7141,8 +7131,6 @@ await client.listing.listings.listForDriverBidderV1({
|
|
|
7141
7131
|
sort_order: "asc",
|
|
7142
7132
|
page: 1,
|
|
7143
7133
|
page_size: 1,
|
|
7144
|
-
filter_status: ["open"],
|
|
7145
|
-
filter_type: ["dispatch"],
|
|
7146
7134
|
filter_task_group_id: "filter_task_group_id",
|
|
7147
7135
|
filter_order_id: "filter_order_id",
|
|
7148
7136
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -8736,7 +8724,6 @@ await client.listing.bidThreads.listForListingV1("listing_id", {
|
|
|
8736
8724
|
sort_order: "asc",
|
|
8737
8725
|
page: 1,
|
|
8738
8726
|
page_size: 1,
|
|
8739
|
-
filter_status: ["open"],
|
|
8740
8727
|
filter_listing_id: "filter_listing_id",
|
|
8741
8728
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
8742
8729
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -8820,7 +8807,6 @@ await client.listing.bidThreads.listForBidderV1({
|
|
|
8820
8807
|
sort_order: "asc",
|
|
8821
8808
|
page: 1,
|
|
8822
8809
|
page_size: 1,
|
|
8823
|
-
filter_status: ["open"],
|
|
8824
8810
|
filter_listing_id: "filter_listing_id",
|
|
8825
8811
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
8826
8812
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -10809,8 +10795,6 @@ await client.operations.cases.listV1({
|
|
|
10809
10795
|
sort_order: "asc",
|
|
10810
10796
|
page: 1,
|
|
10811
10797
|
page_size: 1,
|
|
10812
|
-
filter_status: ["open"],
|
|
10813
|
-
filter_department_id: ["filter_department_id"],
|
|
10814
10798
|
filter_assigned_operator_user_id: "filter_assigned_operator_user_id",
|
|
10815
10799
|
filter_needs_action: true,
|
|
10816
10800
|
filter_unassigned: true,
|
|
@@ -11643,7 +11627,6 @@ await client.operations.departments.listV1({
|
|
|
11643
11627
|
sort_order: "asc",
|
|
11644
11628
|
page: 1,
|
|
11645
11629
|
page_size: 1,
|
|
11646
|
-
filter_department: ["automotive"],
|
|
11647
11630
|
});
|
|
11648
11631
|
```
|
|
11649
11632
|
|
|
@@ -13485,9 +13468,9 @@ await client.orgs.offChrtShipperOrg.updateByIdV1("id");
|
|
|
13485
13468
|
</dl>
|
|
13486
13469
|
</details>
|
|
13487
13470
|
|
|
13488
|
-
## Orgs
|
|
13471
|
+
## Orgs ComplianceDocuments
|
|
13489
13472
|
|
|
13490
|
-
<details><summary><code>client.orgs.
|
|
13473
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">listV1</a>() -> Chrt.OrgComplianceDocument1[]</code></summary>
|
|
13491
13474
|
<dl>
|
|
13492
13475
|
<dd>
|
|
13493
13476
|
|
|
@@ -13499,7 +13482,7 @@ await client.orgs.offChrtShipperOrg.updateByIdV1("id");
|
|
|
13499
13482
|
<dl>
|
|
13500
13483
|
<dd>
|
|
13501
13484
|
|
|
13502
|
-
|
|
13485
|
+
Lists compliance documents for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[OrgComplianceDocument1])
|
|
13503
13486
|
|
|
13504
13487
|
</dd>
|
|
13505
13488
|
</dl>
|
|
@@ -13515,7 +13498,7 @@ Retrieves private organization data for the caller's organization. | authz: min_
|
|
|
13515
13498
|
<dd>
|
|
13516
13499
|
|
|
13517
13500
|
```typescript
|
|
13518
|
-
await client.orgs.
|
|
13501
|
+
await client.orgs.complianceDocuments.listV1();
|
|
13519
13502
|
```
|
|
13520
13503
|
|
|
13521
13504
|
</dd>
|
|
@@ -13531,7 +13514,7 @@ await client.orgs.privateData.getV1();
|
|
|
13531
13514
|
<dl>
|
|
13532
13515
|
<dd>
|
|
13533
13516
|
|
|
13534
|
-
**requestOptions:** `
|
|
13517
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
13535
13518
|
|
|
13536
13519
|
</dd>
|
|
13537
13520
|
</dl>
|
|
@@ -13542,9 +13525,7 @@ await client.orgs.privateData.getV1();
|
|
|
13542
13525
|
</dl>
|
|
13543
13526
|
</details>
|
|
13544
13527
|
|
|
13545
|
-
|
|
13546
|
-
|
|
13547
|
-
<details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgProfile1</code></summary>
|
|
13528
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">getV1</a>(orgComplianceDocumentId) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
13548
13529
|
<dl>
|
|
13549
13530
|
<dd>
|
|
13550
13531
|
|
|
@@ -13556,7 +13537,7 @@ await client.orgs.privateData.getV1();
|
|
|
13556
13537
|
<dl>
|
|
13557
13538
|
<dd>
|
|
13558
13539
|
|
|
13559
|
-
Retrieves
|
|
13540
|
+
Retrieves one compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrgComplianceDocument1)
|
|
13560
13541
|
|
|
13561
13542
|
</dd>
|
|
13562
13543
|
</dl>
|
|
@@ -13572,7 +13553,7 @@ Retrieves the provider organization profile for the caller's organization. | ()
|
|
|
13572
13553
|
<dd>
|
|
13573
13554
|
|
|
13574
13555
|
```typescript
|
|
13575
|
-
await client.orgs.
|
|
13556
|
+
await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
13576
13557
|
```
|
|
13577
13558
|
|
|
13578
13559
|
</dd>
|
|
@@ -13588,7 +13569,15 @@ await client.orgs.orgProfiles.getV1();
|
|
|
13588
13569
|
<dl>
|
|
13589
13570
|
<dd>
|
|
13590
13571
|
|
|
13591
|
-
**
|
|
13572
|
+
**orgComplianceDocumentId:** `string`
|
|
13573
|
+
|
|
13574
|
+
</dd>
|
|
13575
|
+
</dl>
|
|
13576
|
+
|
|
13577
|
+
<dl>
|
|
13578
|
+
<dd>
|
|
13579
|
+
|
|
13580
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
13592
13581
|
|
|
13593
13582
|
</dd>
|
|
13594
13583
|
</dl>
|
|
@@ -13599,7 +13588,7 @@ await client.orgs.orgProfiles.getV1();
|
|
|
13599
13588
|
</dl>
|
|
13600
13589
|
</details>
|
|
13601
13590
|
|
|
13602
|
-
<details><summary><code>client.orgs.
|
|
13591
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">createV1</a>({ ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
13603
13592
|
<dl>
|
|
13604
13593
|
<dd>
|
|
13605
13594
|
|
|
@@ -13611,7 +13600,7 @@ await client.orgs.orgProfiles.getV1();
|
|
|
13611
13600
|
<dl>
|
|
13612
13601
|
<dd>
|
|
13613
13602
|
|
|
13614
|
-
Creates a
|
|
13603
|
+
Creates a compliance document record for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientCreate1) -> (OrgComplianceDocument1)
|
|
13615
13604
|
|
|
13616
13605
|
</dd>
|
|
13617
13606
|
</dl>
|
|
@@ -13627,11 +13616,9 @@ Creates a new provider organization profile. Fails if a profile already exists f
|
|
|
13627
13616
|
<dd>
|
|
13628
13617
|
|
|
13629
13618
|
```typescript
|
|
13630
|
-
await client.orgs.
|
|
13619
|
+
await client.orgs.complianceDocuments.createV1({
|
|
13631
13620
|
schema_version: 1,
|
|
13632
|
-
|
|
13633
|
-
email_address_primary: "email_address_primary",
|
|
13634
|
-
phone_number_primary: "phone_number_primary",
|
|
13621
|
+
document_type: "security_threat_assessment",
|
|
13635
13622
|
});
|
|
13636
13623
|
```
|
|
13637
13624
|
|
|
@@ -13648,7 +13635,7 @@ await client.orgs.orgProfiles.createProviderV1({
|
|
|
13648
13635
|
<dl>
|
|
13649
13636
|
<dd>
|
|
13650
13637
|
|
|
13651
|
-
**request:** `Chrt.orgs.
|
|
13638
|
+
**request:** `Chrt.orgs.OrgComplianceDocumentClientCreate1`
|
|
13652
13639
|
|
|
13653
13640
|
</dd>
|
|
13654
13641
|
</dl>
|
|
@@ -13656,7 +13643,7 @@ await client.orgs.orgProfiles.createProviderV1({
|
|
|
13656
13643
|
<dl>
|
|
13657
13644
|
<dd>
|
|
13658
13645
|
|
|
13659
|
-
**requestOptions:** `
|
|
13646
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
13660
13647
|
|
|
13661
13648
|
</dd>
|
|
13662
13649
|
</dl>
|
|
@@ -13667,7 +13654,9 @@ await client.orgs.orgProfiles.createProviderV1({
|
|
|
13667
13654
|
</dl>
|
|
13668
13655
|
</details>
|
|
13669
13656
|
|
|
13670
|
-
|
|
13657
|
+
## Orgs PrivateData
|
|
13658
|
+
|
|
13659
|
+
<details><summary><code>client.orgs.privateData.<a href="/src/api/resources/orgs/resources/privateData/client/Client.ts">getV1</a>() -> Chrt.OrgPrivateData1</code></summary>
|
|
13671
13660
|
<dl>
|
|
13672
13661
|
<dd>
|
|
13673
13662
|
|
|
@@ -13679,7 +13668,7 @@ await client.orgs.orgProfiles.createProviderV1({
|
|
|
13679
13668
|
<dl>
|
|
13680
13669
|
<dd>
|
|
13681
13670
|
|
|
13682
|
-
|
|
13671
|
+
Retrieves private organization data for the caller's organization. | authz: min_org_role=operator | () -> (OrgPrivateData1)
|
|
13683
13672
|
|
|
13684
13673
|
</dd>
|
|
13685
13674
|
</dl>
|
|
@@ -13695,7 +13684,7 @@ Updates an existing provider organization profile. | (ProviderOrgProfileClientUp
|
|
|
13695
13684
|
<dd>
|
|
13696
13685
|
|
|
13697
13686
|
```typescript
|
|
13698
|
-
await client.orgs.
|
|
13687
|
+
await client.orgs.privateData.getV1();
|
|
13699
13688
|
```
|
|
13700
13689
|
|
|
13701
13690
|
</dd>
|
|
@@ -13711,15 +13700,7 @@ await client.orgs.orgProfiles.updateProviderV1();
|
|
|
13711
13700
|
<dl>
|
|
13712
13701
|
<dd>
|
|
13713
13702
|
|
|
13714
|
-
**
|
|
13715
|
-
|
|
13716
|
-
</dd>
|
|
13717
|
-
</dl>
|
|
13718
|
-
|
|
13719
|
-
<dl>
|
|
13720
|
-
<dd>
|
|
13721
|
-
|
|
13722
|
-
**requestOptions:** `OrgProfiles.RequestOptions`
|
|
13703
|
+
**requestOptions:** `PrivateData.RequestOptions`
|
|
13723
13704
|
|
|
13724
13705
|
</dd>
|
|
13725
13706
|
</dl>
|
|
@@ -13730,7 +13711,9 @@ await client.orgs.orgProfiles.updateProviderV1();
|
|
|
13730
13711
|
</dl>
|
|
13731
13712
|
</details>
|
|
13732
13713
|
|
|
13733
|
-
|
|
13714
|
+
## Orgs OrgProfiles
|
|
13715
|
+
|
|
13716
|
+
<details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgProfile1</code></summary>
|
|
13734
13717
|
<dl>
|
|
13735
13718
|
<dd>
|
|
13736
13719
|
|
|
@@ -13742,7 +13725,7 @@ await client.orgs.orgProfiles.updateProviderV1();
|
|
|
13742
13725
|
<dl>
|
|
13743
13726
|
<dd>
|
|
13744
13727
|
|
|
13745
|
-
Retrieves
|
|
13728
|
+
Retrieves the provider organization profile for the caller's organization. | () -> (ProviderOrgProfile1)
|
|
13746
13729
|
|
|
13747
13730
|
</dd>
|
|
13748
13731
|
</dl>
|
|
@@ -13758,7 +13741,7 @@ Retrieves a provider organization profile by handle for public profile viewing.
|
|
|
13758
13741
|
<dd>
|
|
13759
13742
|
|
|
13760
13743
|
```typescript
|
|
13761
|
-
await client.orgs.orgProfiles.
|
|
13744
|
+
await client.orgs.orgProfiles.getV1();
|
|
13762
13745
|
```
|
|
13763
13746
|
|
|
13764
13747
|
</dd>
|
|
@@ -13774,14 +13757,6 @@ await client.orgs.orgProfiles.getByHandleV1("handle");
|
|
|
13774
13757
|
<dl>
|
|
13775
13758
|
<dd>
|
|
13776
13759
|
|
|
13777
|
-
**handle:** `string`
|
|
13778
|
-
|
|
13779
|
-
</dd>
|
|
13780
|
-
</dl>
|
|
13781
|
-
|
|
13782
|
-
<dl>
|
|
13783
|
-
<dd>
|
|
13784
|
-
|
|
13785
13760
|
**requestOptions:** `OrgProfiles.RequestOptions`
|
|
13786
13761
|
|
|
13787
13762
|
</dd>
|
|
@@ -13793,7 +13768,7 @@ await client.orgs.orgProfiles.getByHandleV1("handle");
|
|
|
13793
13768
|
</dl>
|
|
13794
13769
|
</details>
|
|
13795
13770
|
|
|
13796
|
-
<details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">
|
|
13771
|
+
<details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">createProviderV1</a>({ ...params }) -> string</code></summary>
|
|
13797
13772
|
<dl>
|
|
13798
13773
|
<dd>
|
|
13799
13774
|
|
|
@@ -13805,7 +13780,7 @@ await client.orgs.orgProfiles.getByHandleV1("handle");
|
|
|
13805
13780
|
<dl>
|
|
13806
13781
|
<dd>
|
|
13807
13782
|
|
|
13808
|
-
|
|
13783
|
+
Creates a new provider organization profile. Fails if a profile already exists for the organization. | (ProviderOrgProfileClientCreate1) -> (PydanticObjectId)
|
|
13809
13784
|
|
|
13810
13785
|
</dd>
|
|
13811
13786
|
</dl>
|
|
@@ -13821,7 +13796,12 @@ Returns the organization avatar image URL from WorkOS or a placeholder if not fo
|
|
|
13821
13796
|
<dd>
|
|
13822
13797
|
|
|
13823
13798
|
```typescript
|
|
13824
|
-
await client.orgs.orgProfiles.
|
|
13799
|
+
await client.orgs.orgProfiles.createProviderV1({
|
|
13800
|
+
schema_version: 1,
|
|
13801
|
+
description: "description",
|
|
13802
|
+
email_address_primary: "email_address_primary",
|
|
13803
|
+
phone_number_primary: "phone_number_primary",
|
|
13804
|
+
});
|
|
13825
13805
|
```
|
|
13826
13806
|
|
|
13827
13807
|
</dd>
|
|
@@ -13837,7 +13817,7 @@ await client.orgs.orgProfiles.getAvatarV1("handle");
|
|
|
13837
13817
|
<dl>
|
|
13838
13818
|
<dd>
|
|
13839
13819
|
|
|
13840
|
-
**
|
|
13820
|
+
**request:** `Chrt.orgs.ProviderOrgProfileClientCreate1`
|
|
13841
13821
|
|
|
13842
13822
|
</dd>
|
|
13843
13823
|
</dl>
|
|
@@ -13856,9 +13836,7 @@ await client.orgs.orgProfiles.getAvatarV1("handle");
|
|
|
13856
13836
|
</dl>
|
|
13857
13837
|
</details>
|
|
13858
13838
|
|
|
13859
|
-
|
|
13860
|
-
|
|
13861
|
-
<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getV1</a>() -> Chrt.OrgPublicData1</code></summary>
|
|
13839
|
+
<details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">updateProviderV1</a>({ ...params }) -> boolean</code></summary>
|
|
13862
13840
|
<dl>
|
|
13863
13841
|
<dd>
|
|
13864
13842
|
|
|
@@ -13870,7 +13848,7 @@ await client.orgs.orgProfiles.getAvatarV1("handle");
|
|
|
13870
13848
|
<dl>
|
|
13871
13849
|
<dd>
|
|
13872
13850
|
|
|
13873
|
-
|
|
13851
|
+
Updates an existing provider organization profile. | (ProviderOrgProfileClientUpdate1) -> (bool)
|
|
13874
13852
|
|
|
13875
13853
|
</dd>
|
|
13876
13854
|
</dl>
|
|
@@ -13886,7 +13864,7 @@ Retrieves public organization data for the caller's organization. | () -> (OrgPu
|
|
|
13886
13864
|
<dd>
|
|
13887
13865
|
|
|
13888
13866
|
```typescript
|
|
13889
|
-
await client.orgs.
|
|
13867
|
+
await client.orgs.orgProfiles.updateProviderV1();
|
|
13890
13868
|
```
|
|
13891
13869
|
|
|
13892
13870
|
</dd>
|
|
@@ -13902,7 +13880,15 @@ await client.orgs.publicData.getV1();
|
|
|
13902
13880
|
<dl>
|
|
13903
13881
|
<dd>
|
|
13904
13882
|
|
|
13905
|
-
**
|
|
13883
|
+
**request:** `Chrt.orgs.ProviderOrgProfileClientUpdate1`
|
|
13884
|
+
|
|
13885
|
+
</dd>
|
|
13886
|
+
</dl>
|
|
13887
|
+
|
|
13888
|
+
<dl>
|
|
13889
|
+
<dd>
|
|
13890
|
+
|
|
13891
|
+
**requestOptions:** `OrgProfiles.RequestOptions`
|
|
13906
13892
|
|
|
13907
13893
|
</dd>
|
|
13908
13894
|
</dl>
|
|
@@ -13913,7 +13899,7 @@ await client.orgs.publicData.getV1();
|
|
|
13913
13899
|
</dl>
|
|
13914
13900
|
</details>
|
|
13915
13901
|
|
|
13916
|
-
<details><summary><code>client.orgs.
|
|
13902
|
+
<details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getByHandleV1</a>(handle) -> Chrt.ProviderOrgProfile1</code></summary>
|
|
13917
13903
|
<dl>
|
|
13918
13904
|
<dd>
|
|
13919
13905
|
|
|
@@ -13925,7 +13911,7 @@ await client.orgs.publicData.getV1();
|
|
|
13925
13911
|
<dl>
|
|
13926
13912
|
<dd>
|
|
13927
13913
|
|
|
13928
|
-
|
|
13914
|
+
Retrieves a provider organization profile by handle for public profile viewing. | () -> (ProviderOrgProfile1)
|
|
13929
13915
|
|
|
13930
13916
|
</dd>
|
|
13931
13917
|
</dl>
|
|
@@ -13941,7 +13927,7 @@ Updates the handle and/or company_name for the caller's organization. | (UpdateO
|
|
|
13941
13927
|
<dd>
|
|
13942
13928
|
|
|
13943
13929
|
```typescript
|
|
13944
|
-
await client.orgs.
|
|
13930
|
+
await client.orgs.orgProfiles.getByHandleV1("handle");
|
|
13945
13931
|
```
|
|
13946
13932
|
|
|
13947
13933
|
</dd>
|
|
@@ -13957,7 +13943,7 @@ await client.orgs.publicData.updateV1();
|
|
|
13957
13943
|
<dl>
|
|
13958
13944
|
<dd>
|
|
13959
13945
|
|
|
13960
|
-
**
|
|
13946
|
+
**handle:** `string`
|
|
13961
13947
|
|
|
13962
13948
|
</dd>
|
|
13963
13949
|
</dl>
|
|
@@ -13965,7 +13951,7 @@ await client.orgs.publicData.updateV1();
|
|
|
13965
13951
|
<dl>
|
|
13966
13952
|
<dd>
|
|
13967
13953
|
|
|
13968
|
-
**requestOptions:** `
|
|
13954
|
+
**requestOptions:** `OrgProfiles.RequestOptions`
|
|
13969
13955
|
|
|
13970
13956
|
</dd>
|
|
13971
13957
|
</dl>
|
|
@@ -13976,7 +13962,7 @@ await client.orgs.publicData.updateV1();
|
|
|
13976
13962
|
</dl>
|
|
13977
13963
|
</details>
|
|
13978
13964
|
|
|
13979
|
-
<details><summary><code>client.orgs.
|
|
13965
|
+
<details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getAvatarV1</a>(handle) -> string</code></summary>
|
|
13980
13966
|
<dl>
|
|
13981
13967
|
<dd>
|
|
13982
13968
|
|
|
@@ -13988,7 +13974,7 @@ await client.orgs.publicData.updateV1();
|
|
|
13988
13974
|
<dl>
|
|
13989
13975
|
<dd>
|
|
13990
13976
|
|
|
13991
|
-
|
|
13977
|
+
Returns the organization avatar image URL from WorkOS or a placeholder if not found. | () -> (str)
|
|
13992
13978
|
|
|
13993
13979
|
</dd>
|
|
13994
13980
|
</dl>
|
|
@@ -14004,7 +13990,7 @@ Retrieves public organization data for a specific organization by ID. | () -> (O
|
|
|
14004
13990
|
<dd>
|
|
14005
13991
|
|
|
14006
13992
|
```typescript
|
|
14007
|
-
await client.orgs.
|
|
13993
|
+
await client.orgs.orgProfiles.getAvatarV1("handle");
|
|
14008
13994
|
```
|
|
14009
13995
|
|
|
14010
13996
|
</dd>
|
|
@@ -14020,7 +14006,7 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
|
|
|
14020
14006
|
<dl>
|
|
14021
14007
|
<dd>
|
|
14022
14008
|
|
|
14023
|
-
**
|
|
14009
|
+
**handle:** `string`
|
|
14024
14010
|
|
|
14025
14011
|
</dd>
|
|
14026
14012
|
</dl>
|
|
@@ -14028,7 +14014,7 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
|
|
|
14028
14014
|
<dl>
|
|
14029
14015
|
<dd>
|
|
14030
14016
|
|
|
14031
|
-
**requestOptions:** `
|
|
14017
|
+
**requestOptions:** `OrgProfiles.RequestOptions`
|
|
14032
14018
|
|
|
14033
14019
|
</dd>
|
|
14034
14020
|
</dl>
|
|
@@ -14039,7 +14025,9 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
|
|
|
14039
14025
|
</dl>
|
|
14040
14026
|
</details>
|
|
14041
14027
|
|
|
14042
|
-
|
|
14028
|
+
## Orgs PublicData
|
|
14029
|
+
|
|
14030
|
+
<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getV1</a>() -> Chrt.OrgPublicData1</code></summary>
|
|
14043
14031
|
<dl>
|
|
14044
14032
|
<dd>
|
|
14045
14033
|
|
|
@@ -14051,7 +14039,7 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
|
|
|
14051
14039
|
<dl>
|
|
14052
14040
|
<dd>
|
|
14053
14041
|
|
|
14054
|
-
|
|
14042
|
+
Retrieves public organization data for the caller's organization. | () -> (OrgPublicData1)
|
|
14055
14043
|
|
|
14056
14044
|
</dd>
|
|
14057
14045
|
</dl>
|
|
@@ -14067,7 +14055,7 @@ Returns True when the provided handle is available, otherwise False. | () -> (bo
|
|
|
14067
14055
|
<dd>
|
|
14068
14056
|
|
|
14069
14057
|
```typescript
|
|
14070
|
-
await client.orgs.publicData.
|
|
14058
|
+
await client.orgs.publicData.getV1();
|
|
14071
14059
|
```
|
|
14072
14060
|
|
|
14073
14061
|
</dd>
|
|
@@ -14083,14 +14071,6 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
14083
14071
|
<dl>
|
|
14084
14072
|
<dd>
|
|
14085
14073
|
|
|
14086
|
-
**handle:** `string`
|
|
14087
|
-
|
|
14088
|
-
</dd>
|
|
14089
|
-
</dl>
|
|
14090
|
-
|
|
14091
|
-
<dl>
|
|
14092
|
-
<dd>
|
|
14093
|
-
|
|
14094
14074
|
**requestOptions:** `PublicData.RequestOptions`
|
|
14095
14075
|
|
|
14096
14076
|
</dd>
|
|
@@ -14102,9 +14082,7 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
14102
14082
|
</dl>
|
|
14103
14083
|
</details>
|
|
14104
14084
|
|
|
14105
|
-
|
|
14106
|
-
|
|
14107
|
-
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
14085
|
+
<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
14108
14086
|
<dl>
|
|
14109
14087
|
<dd>
|
|
14110
14088
|
|
|
@@ -14116,7 +14094,7 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
14116
14094
|
<dl>
|
|
14117
14095
|
<dd>
|
|
14118
14096
|
|
|
14119
|
-
|
|
14097
|
+
Updates the handle and/or company_name for the caller's organization. | (UpdateOrgPublicDataReq) -> (bool)
|
|
14120
14098
|
|
|
14121
14099
|
</dd>
|
|
14122
14100
|
</dl>
|
|
@@ -14132,7 +14110,7 @@ Retrieves shipper organization connection information for the caller's organizat
|
|
|
14132
14110
|
<dd>
|
|
14133
14111
|
|
|
14134
14112
|
```typescript
|
|
14135
|
-
await client.orgs.
|
|
14113
|
+
await client.orgs.publicData.updateV1();
|
|
14136
14114
|
```
|
|
14137
14115
|
|
|
14138
14116
|
</dd>
|
|
@@ -14148,7 +14126,15 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
14148
14126
|
<dl>
|
|
14149
14127
|
<dd>
|
|
14150
14128
|
|
|
14151
|
-
**
|
|
14129
|
+
**request:** `Chrt.orgs.UpdateOrgPublicDataReq`
|
|
14130
|
+
|
|
14131
|
+
</dd>
|
|
14132
|
+
</dl>
|
|
14133
|
+
|
|
14134
|
+
<dl>
|
|
14135
|
+
<dd>
|
|
14136
|
+
|
|
14137
|
+
**requestOptions:** `PublicData.RequestOptions`
|
|
14152
14138
|
|
|
14153
14139
|
</dd>
|
|
14154
14140
|
</dl>
|
|
@@ -14159,7 +14145,7 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
14159
14145
|
</dl>
|
|
14160
14146
|
</details>
|
|
14161
14147
|
|
|
14162
|
-
<details><summary><code>client.orgs.
|
|
14148
|
+
<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
|
|
14163
14149
|
<dl>
|
|
14164
14150
|
<dd>
|
|
14165
14151
|
|
|
@@ -14171,7 +14157,7 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
14171
14157
|
<dl>
|
|
14172
14158
|
<dd>
|
|
14173
14159
|
|
|
14174
|
-
|
|
14160
|
+
Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
|
|
14175
14161
|
|
|
14176
14162
|
</dd>
|
|
14177
14163
|
</dl>
|
|
@@ -14187,10 +14173,7 @@ Creates shipper organization connection information. Fails if already exists. |
|
|
|
14187
14173
|
<dd>
|
|
14188
14174
|
|
|
14189
14175
|
```typescript
|
|
14190
|
-
await client.orgs.
|
|
14191
|
-
schema_version: 1,
|
|
14192
|
-
email_address_primary: "email_address_primary",
|
|
14193
|
-
});
|
|
14176
|
+
await client.orgs.publicData.getByOrgIdV1("org_id");
|
|
14194
14177
|
```
|
|
14195
14178
|
|
|
14196
14179
|
</dd>
|
|
@@ -14206,7 +14189,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
14206
14189
|
<dl>
|
|
14207
14190
|
<dd>
|
|
14208
14191
|
|
|
14209
|
-
**
|
|
14192
|
+
**orgId:** `string`
|
|
14210
14193
|
|
|
14211
14194
|
</dd>
|
|
14212
14195
|
</dl>
|
|
@@ -14214,7 +14197,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
14214
14197
|
<dl>
|
|
14215
14198
|
<dd>
|
|
14216
14199
|
|
|
14217
|
-
**requestOptions:** `
|
|
14200
|
+
**requestOptions:** `PublicData.RequestOptions`
|
|
14218
14201
|
|
|
14219
14202
|
</dd>
|
|
14220
14203
|
</dl>
|
|
@@ -14225,7 +14208,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
14225
14208
|
</dl>
|
|
14226
14209
|
</details>
|
|
14227
14210
|
|
|
14228
|
-
<details><summary><code>client.orgs.
|
|
14211
|
+
<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
|
|
14229
14212
|
<dl>
|
|
14230
14213
|
<dd>
|
|
14231
14214
|
|
|
@@ -14237,7 +14220,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
14237
14220
|
<dl>
|
|
14238
14221
|
<dd>
|
|
14239
14222
|
|
|
14240
|
-
|
|
14223
|
+
Returns True when the provided handle is available, otherwise False. | () -> (bool)
|
|
14241
14224
|
|
|
14242
14225
|
</dd>
|
|
14243
14226
|
</dl>
|
|
@@ -14253,7 +14236,7 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
|
|
|
14253
14236
|
<dd>
|
|
14254
14237
|
|
|
14255
14238
|
```typescript
|
|
14256
|
-
await client.orgs.
|
|
14239
|
+
await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
14257
14240
|
```
|
|
14258
14241
|
|
|
14259
14242
|
</dd>
|
|
@@ -14269,7 +14252,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
14269
14252
|
<dl>
|
|
14270
14253
|
<dd>
|
|
14271
14254
|
|
|
14272
|
-
**
|
|
14255
|
+
**handle:** `string`
|
|
14273
14256
|
|
|
14274
14257
|
</dd>
|
|
14275
14258
|
</dl>
|
|
@@ -14277,7 +14260,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
14277
14260
|
<dl>
|
|
14278
14261
|
<dd>
|
|
14279
14262
|
|
|
14280
|
-
**requestOptions:** `
|
|
14263
|
+
**requestOptions:** `PublicData.RequestOptions`
|
|
14281
14264
|
|
|
14282
14265
|
</dd>
|
|
14283
14266
|
</dl>
|
|
@@ -14288,9 +14271,9 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
14288
14271
|
</dl>
|
|
14289
14272
|
</details>
|
|
14290
14273
|
|
|
14291
|
-
## Orgs
|
|
14274
|
+
## Orgs ComplianceDocuments S3Object
|
|
14292
14275
|
|
|
14293
|
-
<details><summary><code>client.orgs.
|
|
14276
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> Chrt.OrgComplianceDocumentS3ObjectMetadata1</code></summary>
|
|
14294
14277
|
<dl>
|
|
14295
14278
|
<dd>
|
|
14296
14279
|
|
|
@@ -14302,7 +14285,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
14302
14285
|
<dl>
|
|
14303
14286
|
<dd>
|
|
14304
14287
|
|
|
14305
|
-
Retrieves
|
|
14288
|
+
Retrieves metadata for an organization compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (OrgComplianceDocumentS3ObjectMetadata1)
|
|
14306
14289
|
|
|
14307
14290
|
</dd>
|
|
14308
14291
|
</dl>
|
|
@@ -14318,7 +14301,7 @@ Retrieves provider organization connection information for the caller's organiza
|
|
|
14318
14301
|
<dd>
|
|
14319
14302
|
|
|
14320
14303
|
```typescript
|
|
14321
|
-
await client.orgs.
|
|
14304
|
+
await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compliance_document_s3_object_metadata_id");
|
|
14322
14305
|
```
|
|
14323
14306
|
|
|
14324
14307
|
</dd>
|
|
@@ -14334,7 +14317,15 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
14334
14317
|
<dl>
|
|
14335
14318
|
<dd>
|
|
14336
14319
|
|
|
14337
|
-
**
|
|
14320
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
14321
|
+
|
|
14322
|
+
</dd>
|
|
14323
|
+
</dl>
|
|
14324
|
+
|
|
14325
|
+
<dl>
|
|
14326
|
+
<dd>
|
|
14327
|
+
|
|
14328
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
14338
14329
|
|
|
14339
14330
|
</dd>
|
|
14340
14331
|
</dl>
|
|
@@ -14345,7 +14336,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
14345
14336
|
</dl>
|
|
14346
14337
|
</details>
|
|
14347
14338
|
|
|
14348
|
-
<details><summary><code>client.orgs.
|
|
14339
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
14349
14340
|
<dl>
|
|
14350
14341
|
<dd>
|
|
14351
14342
|
|
|
@@ -14357,7 +14348,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
14357
14348
|
<dl>
|
|
14358
14349
|
<dd>
|
|
14359
14350
|
|
|
14360
|
-
|
|
14351
|
+
Streams an organization compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
|
|
14361
14352
|
|
|
14362
14353
|
</dd>
|
|
14363
14354
|
</dl>
|
|
@@ -14373,7 +14364,7 @@ Retrieves list of provider org info documents for providers connected to the cal
|
|
|
14373
14364
|
<dd>
|
|
14374
14365
|
|
|
14375
14366
|
```typescript
|
|
14376
|
-
await client.orgs.
|
|
14367
|
+
await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3_object_metadata_id");
|
|
14377
14368
|
```
|
|
14378
14369
|
|
|
14379
14370
|
</dd>
|
|
@@ -14389,7 +14380,15 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
14389
14380
|
<dl>
|
|
14390
14381
|
<dd>
|
|
14391
14382
|
|
|
14392
|
-
**
|
|
14383
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
14384
|
+
|
|
14385
|
+
</dd>
|
|
14386
|
+
</dl>
|
|
14387
|
+
|
|
14388
|
+
<dl>
|
|
14389
|
+
<dd>
|
|
14390
|
+
|
|
14391
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
14393
14392
|
|
|
14394
14393
|
</dd>
|
|
14395
14394
|
</dl>
|
|
@@ -14400,7 +14399,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
14400
14399
|
</dl>
|
|
14401
14400
|
</details>
|
|
14402
14401
|
|
|
14403
|
-
<details><summary><code>client.orgs.
|
|
14402
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">addV1</a>(orgComplianceDocumentId, { ...params }) -> boolean</code></summary>
|
|
14404
14403
|
<dl>
|
|
14405
14404
|
<dd>
|
|
14406
14405
|
|
|
@@ -14412,7 +14411,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
14412
14411
|
<dl>
|
|
14413
14412
|
<dd>
|
|
14414
14413
|
|
|
14415
|
-
|
|
14414
|
+
Uploads a file to an organization compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)
|
|
14416
14415
|
|
|
14417
14416
|
</dd>
|
|
14418
14417
|
</dl>
|
|
@@ -14428,9 +14427,8 @@ Creates provider organization connection information. Fails if already exists. |
|
|
|
14428
14427
|
<dd>
|
|
14429
14428
|
|
|
14430
14429
|
```typescript
|
|
14431
|
-
await client.orgs.
|
|
14432
|
-
|
|
14433
|
-
email_address_primary: "email_address_primary",
|
|
14430
|
+
await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id", {
|
|
14431
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
14434
14432
|
});
|
|
14435
14433
|
```
|
|
14436
14434
|
|
|
@@ -14447,7 +14445,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
14447
14445
|
<dl>
|
|
14448
14446
|
<dd>
|
|
14449
14447
|
|
|
14450
|
-
**
|
|
14448
|
+
**orgComplianceDocumentId:** `string`
|
|
14451
14449
|
|
|
14452
14450
|
</dd>
|
|
14453
14451
|
</dl>
|
|
@@ -14455,7 +14453,15 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
14455
14453
|
<dl>
|
|
14456
14454
|
<dd>
|
|
14457
14455
|
|
|
14458
|
-
**
|
|
14456
|
+
**request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
|
|
14457
|
+
|
|
14458
|
+
</dd>
|
|
14459
|
+
</dl>
|
|
14460
|
+
|
|
14461
|
+
<dl>
|
|
14462
|
+
<dd>
|
|
14463
|
+
|
|
14464
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
14459
14465
|
|
|
14460
14466
|
</dd>
|
|
14461
14467
|
</dl>
|
|
@@ -14466,7 +14472,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
14466
14472
|
</dl>
|
|
14467
14473
|
</details>
|
|
14468
14474
|
|
|
14469
|
-
<details><summary><code>client.orgs.
|
|
14475
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">deleteV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> boolean</code></summary>
|
|
14470
14476
|
<dl>
|
|
14471
14477
|
<dd>
|
|
14472
14478
|
|
|
@@ -14478,7 +14484,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
14478
14484
|
<dl>
|
|
14479
14485
|
<dd>
|
|
14480
14486
|
|
|
14481
|
-
|
|
14487
|
+
Deletes an organization compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)
|
|
14482
14488
|
|
|
14483
14489
|
</dd>
|
|
14484
14490
|
</dl>
|
|
@@ -14494,7 +14500,7 @@ Updates existing provider organization connection information. | (ProviderOrgInf
|
|
|
14494
14500
|
<dd>
|
|
14495
14501
|
|
|
14496
14502
|
```typescript
|
|
14497
|
-
await client.orgs.
|
|
14503
|
+
await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document_s3_object_metadata_id");
|
|
14498
14504
|
```
|
|
14499
14505
|
|
|
14500
14506
|
</dd>
|
|
@@ -14510,7 +14516,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
14510
14516
|
<dl>
|
|
14511
14517
|
<dd>
|
|
14512
14518
|
|
|
14513
|
-
**
|
|
14519
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
14514
14520
|
|
|
14515
14521
|
</dd>
|
|
14516
14522
|
</dl>
|
|
@@ -14518,7 +14524,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
14518
14524
|
<dl>
|
|
14519
14525
|
<dd>
|
|
14520
14526
|
|
|
14521
|
-
**requestOptions:** `
|
|
14527
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
14522
14528
|
|
|
14523
14529
|
</dd>
|
|
14524
14530
|
</dl>
|
|
@@ -14529,9 +14535,9 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
14529
14535
|
</dl>
|
|
14530
14536
|
</details>
|
|
14531
14537
|
|
|
14532
|
-
##
|
|
14538
|
+
## Orgs OrgInfoForConnections Shipper
|
|
14533
14539
|
|
|
14534
|
-
<details><summary><code>client.
|
|
14540
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
14535
14541
|
<dl>
|
|
14536
14542
|
<dd>
|
|
14537
14543
|
|
|
@@ -14543,7 +14549,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
14543
14549
|
<dl>
|
|
14544
14550
|
<dd>
|
|
14545
14551
|
|
|
14546
|
-
Retrieves
|
|
14552
|
+
Retrieves shipper organization connection information for the caller's organization. | () -> (ShipperOrgInfoForConnections1)
|
|
14547
14553
|
|
|
14548
14554
|
</dd>
|
|
14549
14555
|
</dl>
|
|
@@ -14559,7 +14565,7 @@ Retrieves driver information for the caller within their organization. | () -> (
|
|
|
14559
14565
|
<dd>
|
|
14560
14566
|
|
|
14561
14567
|
```typescript
|
|
14562
|
-
await client.
|
|
14568
|
+
await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
14563
14569
|
```
|
|
14564
14570
|
|
|
14565
14571
|
</dd>
|
|
@@ -14575,7 +14581,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
14575
14581
|
<dl>
|
|
14576
14582
|
<dd>
|
|
14577
14583
|
|
|
14578
|
-
**requestOptions:** `
|
|
14584
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
14579
14585
|
|
|
14580
14586
|
</dd>
|
|
14581
14587
|
</dl>
|
|
@@ -14586,7 +14592,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
14586
14592
|
</dl>
|
|
14587
14593
|
</details>
|
|
14588
14594
|
|
|
14589
|
-
<details><summary><code>client.
|
|
14595
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
14590
14596
|
<dl>
|
|
14591
14597
|
<dd>
|
|
14592
14598
|
|
|
@@ -14598,7 +14604,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
14598
14604
|
<dl>
|
|
14599
14605
|
<dd>
|
|
14600
14606
|
|
|
14601
|
-
|
|
14607
|
+
Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
14602
14608
|
|
|
14603
14609
|
</dd>
|
|
14604
14610
|
</dl>
|
|
@@ -14614,7 +14620,10 @@ Retrieves detailed driver information by driver ID within the organization. | ()
|
|
|
14614
14620
|
<dd>
|
|
14615
14621
|
|
|
14616
14622
|
```typescript
|
|
14617
|
-
await client.
|
|
14623
|
+
await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
14624
|
+
schema_version: 1,
|
|
14625
|
+
email_address_primary: "email_address_primary",
|
|
14626
|
+
});
|
|
14618
14627
|
```
|
|
14619
14628
|
|
|
14620
14629
|
</dd>
|
|
@@ -14630,7 +14639,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
14630
14639
|
<dl>
|
|
14631
14640
|
<dd>
|
|
14632
14641
|
|
|
14633
|
-
**
|
|
14642
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
|
|
14634
14643
|
|
|
14635
14644
|
</dd>
|
|
14636
14645
|
</dl>
|
|
@@ -14638,7 +14647,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
14638
14647
|
<dl>
|
|
14639
14648
|
<dd>
|
|
14640
14649
|
|
|
14641
|
-
**requestOptions:** `
|
|
14650
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
14642
14651
|
|
|
14643
14652
|
</dd>
|
|
14644
14653
|
</dl>
|
|
@@ -14649,7 +14658,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
14649
14658
|
</dl>
|
|
14650
14659
|
</details>
|
|
14651
14660
|
|
|
14652
|
-
<details><summary><code>client.
|
|
14661
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
14653
14662
|
<dl>
|
|
14654
14663
|
<dd>
|
|
14655
14664
|
|
|
@@ -14661,7 +14670,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
14661
14670
|
<dl>
|
|
14662
14671
|
<dd>
|
|
14663
14672
|
|
|
14664
|
-
|
|
14673
|
+
Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
14665
14674
|
|
|
14666
14675
|
</dd>
|
|
14667
14676
|
</dl>
|
|
@@ -14677,16 +14686,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
14677
14686
|
<dd>
|
|
14678
14687
|
|
|
14679
14688
|
```typescript
|
|
14680
|
-
await client.
|
|
14681
|
-
search: "search",
|
|
14682
|
-
filter_role: ["owner"],
|
|
14683
|
-
filter_available_according_to_driver: true,
|
|
14684
|
-
filter_available_according_to_operators: true,
|
|
14685
|
-
sort_by: "first_name",
|
|
14686
|
-
sort_order: "asc",
|
|
14687
|
-
page: 1,
|
|
14688
|
-
page_size: 1,
|
|
14689
|
-
});
|
|
14689
|
+
await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
14690
14690
|
```
|
|
14691
14691
|
|
|
14692
14692
|
</dd>
|
|
@@ -14702,7 +14702,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
14702
14702
|
<dl>
|
|
14703
14703
|
<dd>
|
|
14704
14704
|
|
|
14705
|
-
**request:** `Chrt.
|
|
14705
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
|
|
14706
14706
|
|
|
14707
14707
|
</dd>
|
|
14708
14708
|
</dl>
|
|
@@ -14710,7 +14710,439 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
14710
14710
|
<dl>
|
|
14711
14711
|
<dd>
|
|
14712
14712
|
|
|
14713
|
-
**requestOptions:** `
|
|
14713
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
14714
|
+
|
|
14715
|
+
</dd>
|
|
14716
|
+
</dl>
|
|
14717
|
+
</dd>
|
|
14718
|
+
</dl>
|
|
14719
|
+
|
|
14720
|
+
</dd>
|
|
14721
|
+
</dl>
|
|
14722
|
+
</details>
|
|
14723
|
+
|
|
14724
|
+
## Orgs OrgInfoForConnections Provider
|
|
14725
|
+
|
|
14726
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgInfoForConnections1</code></summary>
|
|
14727
|
+
<dl>
|
|
14728
|
+
<dd>
|
|
14729
|
+
|
|
14730
|
+
#### 📝 Description
|
|
14731
|
+
|
|
14732
|
+
<dl>
|
|
14733
|
+
<dd>
|
|
14734
|
+
|
|
14735
|
+
<dl>
|
|
14736
|
+
<dd>
|
|
14737
|
+
|
|
14738
|
+
Retrieves provider organization connection information for the caller's organization. | () -> (ProviderOrgInfoForConnections1)
|
|
14739
|
+
|
|
14740
|
+
</dd>
|
|
14741
|
+
</dl>
|
|
14742
|
+
</dd>
|
|
14743
|
+
</dl>
|
|
14744
|
+
|
|
14745
|
+
#### 🔌 Usage
|
|
14746
|
+
|
|
14747
|
+
<dl>
|
|
14748
|
+
<dd>
|
|
14749
|
+
|
|
14750
|
+
<dl>
|
|
14751
|
+
<dd>
|
|
14752
|
+
|
|
14753
|
+
```typescript
|
|
14754
|
+
await client.orgs.orgInfoForConnections.provider.getV1();
|
|
14755
|
+
```
|
|
14756
|
+
|
|
14757
|
+
</dd>
|
|
14758
|
+
</dl>
|
|
14759
|
+
</dd>
|
|
14760
|
+
</dl>
|
|
14761
|
+
|
|
14762
|
+
#### ⚙️ Parameters
|
|
14763
|
+
|
|
14764
|
+
<dl>
|
|
14765
|
+
<dd>
|
|
14766
|
+
|
|
14767
|
+
<dl>
|
|
14768
|
+
<dd>
|
|
14769
|
+
|
|
14770
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
14771
|
+
|
|
14772
|
+
</dd>
|
|
14773
|
+
</dl>
|
|
14774
|
+
</dd>
|
|
14775
|
+
</dl>
|
|
14776
|
+
|
|
14777
|
+
</dd>
|
|
14778
|
+
</dl>
|
|
14779
|
+
</details>
|
|
14780
|
+
|
|
14781
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">listV1</a>() -> Chrt.ProviderOrgInfoForConnections1[]</code></summary>
|
|
14782
|
+
<dl>
|
|
14783
|
+
<dd>
|
|
14784
|
+
|
|
14785
|
+
#### 📝 Description
|
|
14786
|
+
|
|
14787
|
+
<dl>
|
|
14788
|
+
<dd>
|
|
14789
|
+
|
|
14790
|
+
<dl>
|
|
14791
|
+
<dd>
|
|
14792
|
+
|
|
14793
|
+
Retrieves list of provider org info documents for providers connected to the caller. Shippers see providers via shipper_provider_connections; providers see other providers via provider_provider_connections (in either direction). | () -> (list[ProviderOrgInfoForConnections1])
|
|
14794
|
+
|
|
14795
|
+
</dd>
|
|
14796
|
+
</dl>
|
|
14797
|
+
</dd>
|
|
14798
|
+
</dl>
|
|
14799
|
+
|
|
14800
|
+
#### 🔌 Usage
|
|
14801
|
+
|
|
14802
|
+
<dl>
|
|
14803
|
+
<dd>
|
|
14804
|
+
|
|
14805
|
+
<dl>
|
|
14806
|
+
<dd>
|
|
14807
|
+
|
|
14808
|
+
```typescript
|
|
14809
|
+
await client.orgs.orgInfoForConnections.provider.listV1();
|
|
14810
|
+
```
|
|
14811
|
+
|
|
14812
|
+
</dd>
|
|
14813
|
+
</dl>
|
|
14814
|
+
</dd>
|
|
14815
|
+
</dl>
|
|
14816
|
+
|
|
14817
|
+
#### ⚙️ Parameters
|
|
14818
|
+
|
|
14819
|
+
<dl>
|
|
14820
|
+
<dd>
|
|
14821
|
+
|
|
14822
|
+
<dl>
|
|
14823
|
+
<dd>
|
|
14824
|
+
|
|
14825
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
14826
|
+
|
|
14827
|
+
</dd>
|
|
14828
|
+
</dl>
|
|
14829
|
+
</dd>
|
|
14830
|
+
</dl>
|
|
14831
|
+
|
|
14832
|
+
</dd>
|
|
14833
|
+
</dl>
|
|
14834
|
+
</details>
|
|
14835
|
+
|
|
14836
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
14837
|
+
<dl>
|
|
14838
|
+
<dd>
|
|
14839
|
+
|
|
14840
|
+
#### 📝 Description
|
|
14841
|
+
|
|
14842
|
+
<dl>
|
|
14843
|
+
<dd>
|
|
14844
|
+
|
|
14845
|
+
<dl>
|
|
14846
|
+
<dd>
|
|
14847
|
+
|
|
14848
|
+
Creates provider organization connection information. Fails if already exists. | (ProviderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
14849
|
+
|
|
14850
|
+
</dd>
|
|
14851
|
+
</dl>
|
|
14852
|
+
</dd>
|
|
14853
|
+
</dl>
|
|
14854
|
+
|
|
14855
|
+
#### 🔌 Usage
|
|
14856
|
+
|
|
14857
|
+
<dl>
|
|
14858
|
+
<dd>
|
|
14859
|
+
|
|
14860
|
+
<dl>
|
|
14861
|
+
<dd>
|
|
14862
|
+
|
|
14863
|
+
```typescript
|
|
14864
|
+
await client.orgs.orgInfoForConnections.provider.createV1({
|
|
14865
|
+
schema_version: 1,
|
|
14866
|
+
email_address_primary: "email_address_primary",
|
|
14867
|
+
});
|
|
14868
|
+
```
|
|
14869
|
+
|
|
14870
|
+
</dd>
|
|
14871
|
+
</dl>
|
|
14872
|
+
</dd>
|
|
14873
|
+
</dl>
|
|
14874
|
+
|
|
14875
|
+
#### ⚙️ Parameters
|
|
14876
|
+
|
|
14877
|
+
<dl>
|
|
14878
|
+
<dd>
|
|
14879
|
+
|
|
14880
|
+
<dl>
|
|
14881
|
+
<dd>
|
|
14882
|
+
|
|
14883
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientCreate1`
|
|
14884
|
+
|
|
14885
|
+
</dd>
|
|
14886
|
+
</dl>
|
|
14887
|
+
|
|
14888
|
+
<dl>
|
|
14889
|
+
<dd>
|
|
14890
|
+
|
|
14891
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
14892
|
+
|
|
14893
|
+
</dd>
|
|
14894
|
+
</dl>
|
|
14895
|
+
</dd>
|
|
14896
|
+
</dl>
|
|
14897
|
+
|
|
14898
|
+
</dd>
|
|
14899
|
+
</dl>
|
|
14900
|
+
</details>
|
|
14901
|
+
|
|
14902
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
14903
|
+
<dl>
|
|
14904
|
+
<dd>
|
|
14905
|
+
|
|
14906
|
+
#### 📝 Description
|
|
14907
|
+
|
|
14908
|
+
<dl>
|
|
14909
|
+
<dd>
|
|
14910
|
+
|
|
14911
|
+
<dl>
|
|
14912
|
+
<dd>
|
|
14913
|
+
|
|
14914
|
+
Updates existing provider organization connection information. | (ProviderOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
14915
|
+
|
|
14916
|
+
</dd>
|
|
14917
|
+
</dl>
|
|
14918
|
+
</dd>
|
|
14919
|
+
</dl>
|
|
14920
|
+
|
|
14921
|
+
#### 🔌 Usage
|
|
14922
|
+
|
|
14923
|
+
<dl>
|
|
14924
|
+
<dd>
|
|
14925
|
+
|
|
14926
|
+
<dl>
|
|
14927
|
+
<dd>
|
|
14928
|
+
|
|
14929
|
+
```typescript
|
|
14930
|
+
await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
14931
|
+
```
|
|
14932
|
+
|
|
14933
|
+
</dd>
|
|
14934
|
+
</dl>
|
|
14935
|
+
</dd>
|
|
14936
|
+
</dl>
|
|
14937
|
+
|
|
14938
|
+
#### ⚙️ Parameters
|
|
14939
|
+
|
|
14940
|
+
<dl>
|
|
14941
|
+
<dd>
|
|
14942
|
+
|
|
14943
|
+
<dl>
|
|
14944
|
+
<dd>
|
|
14945
|
+
|
|
14946
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientUpdate1`
|
|
14947
|
+
|
|
14948
|
+
</dd>
|
|
14949
|
+
</dl>
|
|
14950
|
+
|
|
14951
|
+
<dl>
|
|
14952
|
+
<dd>
|
|
14953
|
+
|
|
14954
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
14955
|
+
|
|
14956
|
+
</dd>
|
|
14957
|
+
</dl>
|
|
14958
|
+
</dd>
|
|
14959
|
+
</dl>
|
|
14960
|
+
|
|
14961
|
+
</dd>
|
|
14962
|
+
</dl>
|
|
14963
|
+
</details>
|
|
14964
|
+
|
|
14965
|
+
## Shipping Drivers
|
|
14966
|
+
|
|
14967
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
|
|
14968
|
+
<dl>
|
|
14969
|
+
<dd>
|
|
14970
|
+
|
|
14971
|
+
#### 📝 Description
|
|
14972
|
+
|
|
14973
|
+
<dl>
|
|
14974
|
+
<dd>
|
|
14975
|
+
|
|
14976
|
+
<dl>
|
|
14977
|
+
<dd>
|
|
14978
|
+
|
|
14979
|
+
Retrieves driver information for the caller within their organization. | () -> (Driver1)
|
|
14980
|
+
|
|
14981
|
+
</dd>
|
|
14982
|
+
</dl>
|
|
14983
|
+
</dd>
|
|
14984
|
+
</dl>
|
|
14985
|
+
|
|
14986
|
+
#### 🔌 Usage
|
|
14987
|
+
|
|
14988
|
+
<dl>
|
|
14989
|
+
<dd>
|
|
14990
|
+
|
|
14991
|
+
<dl>
|
|
14992
|
+
<dd>
|
|
14993
|
+
|
|
14994
|
+
```typescript
|
|
14995
|
+
await client.shipping.drivers.getForCallerV1();
|
|
14996
|
+
```
|
|
14997
|
+
|
|
14998
|
+
</dd>
|
|
14999
|
+
</dl>
|
|
15000
|
+
</dd>
|
|
15001
|
+
</dl>
|
|
15002
|
+
|
|
15003
|
+
#### ⚙️ Parameters
|
|
15004
|
+
|
|
15005
|
+
<dl>
|
|
15006
|
+
<dd>
|
|
15007
|
+
|
|
15008
|
+
<dl>
|
|
15009
|
+
<dd>
|
|
15010
|
+
|
|
15011
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
15012
|
+
|
|
15013
|
+
</dd>
|
|
15014
|
+
</dl>
|
|
15015
|
+
</dd>
|
|
15016
|
+
</dl>
|
|
15017
|
+
|
|
15018
|
+
</dd>
|
|
15019
|
+
</dl>
|
|
15020
|
+
</details>
|
|
15021
|
+
|
|
15022
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1</code></summary>
|
|
15023
|
+
<dl>
|
|
15024
|
+
<dd>
|
|
15025
|
+
|
|
15026
|
+
#### 📝 Description
|
|
15027
|
+
|
|
15028
|
+
<dl>
|
|
15029
|
+
<dd>
|
|
15030
|
+
|
|
15031
|
+
<dl>
|
|
15032
|
+
<dd>
|
|
15033
|
+
|
|
15034
|
+
Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
|
|
15035
|
+
|
|
15036
|
+
</dd>
|
|
15037
|
+
</dl>
|
|
15038
|
+
</dd>
|
|
15039
|
+
</dl>
|
|
15040
|
+
|
|
15041
|
+
#### 🔌 Usage
|
|
15042
|
+
|
|
15043
|
+
<dl>
|
|
15044
|
+
<dd>
|
|
15045
|
+
|
|
15046
|
+
<dl>
|
|
15047
|
+
<dd>
|
|
15048
|
+
|
|
15049
|
+
```typescript
|
|
15050
|
+
await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
15051
|
+
```
|
|
15052
|
+
|
|
15053
|
+
</dd>
|
|
15054
|
+
</dl>
|
|
15055
|
+
</dd>
|
|
15056
|
+
</dl>
|
|
15057
|
+
|
|
15058
|
+
#### ⚙️ Parameters
|
|
15059
|
+
|
|
15060
|
+
<dl>
|
|
15061
|
+
<dd>
|
|
15062
|
+
|
|
15063
|
+
<dl>
|
|
15064
|
+
<dd>
|
|
15065
|
+
|
|
15066
|
+
**driverId:** `string`
|
|
15067
|
+
|
|
15068
|
+
</dd>
|
|
15069
|
+
</dl>
|
|
15070
|
+
|
|
15071
|
+
<dl>
|
|
15072
|
+
<dd>
|
|
15073
|
+
|
|
15074
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
15075
|
+
|
|
15076
|
+
</dd>
|
|
15077
|
+
</dl>
|
|
15078
|
+
</dd>
|
|
15079
|
+
</dl>
|
|
15080
|
+
|
|
15081
|
+
</dd>
|
|
15082
|
+
</dl>
|
|
15083
|
+
</details>
|
|
15084
|
+
|
|
15085
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDriversListRes</code></summary>
|
|
15086
|
+
<dl>
|
|
15087
|
+
<dd>
|
|
15088
|
+
|
|
15089
|
+
#### 📝 Description
|
|
15090
|
+
|
|
15091
|
+
<dl>
|
|
15092
|
+
<dd>
|
|
15093
|
+
|
|
15094
|
+
<dl>
|
|
15095
|
+
<dd>
|
|
15096
|
+
|
|
15097
|
+
Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
|
|
15098
|
+
|
|
15099
|
+
</dd>
|
|
15100
|
+
</dl>
|
|
15101
|
+
</dd>
|
|
15102
|
+
</dl>
|
|
15103
|
+
|
|
15104
|
+
#### 🔌 Usage
|
|
15105
|
+
|
|
15106
|
+
<dl>
|
|
15107
|
+
<dd>
|
|
15108
|
+
|
|
15109
|
+
<dl>
|
|
15110
|
+
<dd>
|
|
15111
|
+
|
|
15112
|
+
```typescript
|
|
15113
|
+
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
15114
|
+
search: "search",
|
|
15115
|
+
filter_available_according_to_driver: true,
|
|
15116
|
+
filter_available_according_to_operators: true,
|
|
15117
|
+
sort_by: "first_name",
|
|
15118
|
+
sort_order: "asc",
|
|
15119
|
+
page: 1,
|
|
15120
|
+
page_size: 1,
|
|
15121
|
+
});
|
|
15122
|
+
```
|
|
15123
|
+
|
|
15124
|
+
</dd>
|
|
15125
|
+
</dl>
|
|
15126
|
+
</dd>
|
|
15127
|
+
</dl>
|
|
15128
|
+
|
|
15129
|
+
#### ⚙️ Parameters
|
|
15130
|
+
|
|
15131
|
+
<dl>
|
|
15132
|
+
<dd>
|
|
15133
|
+
|
|
15134
|
+
<dl>
|
|
15135
|
+
<dd>
|
|
15136
|
+
|
|
15137
|
+
**request:** `Chrt.shipping.DriversListOrgMembersAndDriversV1Request`
|
|
15138
|
+
|
|
15139
|
+
</dd>
|
|
15140
|
+
</dl>
|
|
15141
|
+
|
|
15142
|
+
<dl>
|
|
15143
|
+
<dd>
|
|
15144
|
+
|
|
15145
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
14714
15146
|
|
|
14715
15147
|
</dd>
|
|
14716
15148
|
</dl>
|
|
@@ -14733,7 +15165,334 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
14733
15165
|
<dl>
|
|
14734
15166
|
<dd>
|
|
14735
15167
|
|
|
14736
|
-
Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
|
|
15168
|
+
Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
|
|
15169
|
+
|
|
15170
|
+
</dd>
|
|
15171
|
+
</dl>
|
|
15172
|
+
</dd>
|
|
15173
|
+
</dl>
|
|
15174
|
+
|
|
15175
|
+
#### 🔌 Usage
|
|
15176
|
+
|
|
15177
|
+
<dl>
|
|
15178
|
+
<dd>
|
|
15179
|
+
|
|
15180
|
+
<dl>
|
|
15181
|
+
<dd>
|
|
15182
|
+
|
|
15183
|
+
```typescript
|
|
15184
|
+
await client.shipping.drivers.listV1({
|
|
15185
|
+
sort_order: "asc",
|
|
15186
|
+
page: 1,
|
|
15187
|
+
page_size: 1,
|
|
15188
|
+
search: "search",
|
|
15189
|
+
filter_available_according_to_driver: true,
|
|
15190
|
+
filter_available_according_to_operators: true,
|
|
15191
|
+
});
|
|
15192
|
+
```
|
|
15193
|
+
|
|
15194
|
+
</dd>
|
|
15195
|
+
</dl>
|
|
15196
|
+
</dd>
|
|
15197
|
+
</dl>
|
|
15198
|
+
|
|
15199
|
+
#### ⚙️ Parameters
|
|
15200
|
+
|
|
15201
|
+
<dl>
|
|
15202
|
+
<dd>
|
|
15203
|
+
|
|
15204
|
+
<dl>
|
|
15205
|
+
<dd>
|
|
15206
|
+
|
|
15207
|
+
**request:** `Chrt.shipping.DriversListV1Request`
|
|
15208
|
+
|
|
15209
|
+
</dd>
|
|
15210
|
+
</dl>
|
|
15211
|
+
|
|
15212
|
+
<dl>
|
|
15213
|
+
<dd>
|
|
15214
|
+
|
|
15215
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
15216
|
+
|
|
15217
|
+
</dd>
|
|
15218
|
+
</dl>
|
|
15219
|
+
</dd>
|
|
15220
|
+
</dl>
|
|
15221
|
+
|
|
15222
|
+
</dd>
|
|
15223
|
+
</dl>
|
|
15224
|
+
</details>
|
|
15225
|
+
|
|
15226
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
15227
|
+
<dl>
|
|
15228
|
+
<dd>
|
|
15229
|
+
|
|
15230
|
+
#### 📝 Description
|
|
15231
|
+
|
|
15232
|
+
<dl>
|
|
15233
|
+
<dd>
|
|
15234
|
+
|
|
15235
|
+
<dl>
|
|
15236
|
+
<dd>
|
|
15237
|
+
|
|
15238
|
+
Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Provider orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
|
|
15239
|
+
|
|
15240
|
+
</dd>
|
|
15241
|
+
</dl>
|
|
15242
|
+
</dd>
|
|
15243
|
+
</dl>
|
|
15244
|
+
|
|
15245
|
+
#### 🔌 Usage
|
|
15246
|
+
|
|
15247
|
+
<dl>
|
|
15248
|
+
<dd>
|
|
15249
|
+
|
|
15250
|
+
<dl>
|
|
15251
|
+
<dd>
|
|
15252
|
+
|
|
15253
|
+
```typescript
|
|
15254
|
+
await client.shipping.drivers.createV1({
|
|
15255
|
+
target_user_id: "target_user_id",
|
|
15256
|
+
schema_version: 1,
|
|
15257
|
+
});
|
|
15258
|
+
```
|
|
15259
|
+
|
|
15260
|
+
</dd>
|
|
15261
|
+
</dl>
|
|
15262
|
+
</dd>
|
|
15263
|
+
</dl>
|
|
15264
|
+
|
|
15265
|
+
#### ⚙️ Parameters
|
|
15266
|
+
|
|
15267
|
+
<dl>
|
|
15268
|
+
<dd>
|
|
15269
|
+
|
|
15270
|
+
<dl>
|
|
15271
|
+
<dd>
|
|
15272
|
+
|
|
15273
|
+
**request:** `Chrt.shipping.DriverClientCreate1`
|
|
15274
|
+
|
|
15275
|
+
</dd>
|
|
15276
|
+
</dl>
|
|
15277
|
+
|
|
15278
|
+
<dl>
|
|
15279
|
+
<dd>
|
|
15280
|
+
|
|
15281
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
15282
|
+
|
|
15283
|
+
</dd>
|
|
15284
|
+
</dl>
|
|
15285
|
+
</dd>
|
|
15286
|
+
</dl>
|
|
15287
|
+
|
|
15288
|
+
</dd>
|
|
15289
|
+
</dl>
|
|
15290
|
+
</details>
|
|
15291
|
+
|
|
15292
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
15293
|
+
<dl>
|
|
15294
|
+
<dd>
|
|
15295
|
+
|
|
15296
|
+
#### 📝 Description
|
|
15297
|
+
|
|
15298
|
+
<dl>
|
|
15299
|
+
<dd>
|
|
15300
|
+
|
|
15301
|
+
<dl>
|
|
15302
|
+
<dd>
|
|
15303
|
+
|
|
15304
|
+
Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
|
|
15305
|
+
|
|
15306
|
+
</dd>
|
|
15307
|
+
</dl>
|
|
15308
|
+
</dd>
|
|
15309
|
+
</dl>
|
|
15310
|
+
|
|
15311
|
+
#### 🔌 Usage
|
|
15312
|
+
|
|
15313
|
+
<dl>
|
|
15314
|
+
<dd>
|
|
15315
|
+
|
|
15316
|
+
<dl>
|
|
15317
|
+
<dd>
|
|
15318
|
+
|
|
15319
|
+
```typescript
|
|
15320
|
+
await client.shipping.drivers.updateV1("driver_id");
|
|
15321
|
+
```
|
|
15322
|
+
|
|
15323
|
+
</dd>
|
|
15324
|
+
</dl>
|
|
15325
|
+
</dd>
|
|
15326
|
+
</dl>
|
|
15327
|
+
|
|
15328
|
+
#### ⚙️ Parameters
|
|
15329
|
+
|
|
15330
|
+
<dl>
|
|
15331
|
+
<dd>
|
|
15332
|
+
|
|
15333
|
+
<dl>
|
|
15334
|
+
<dd>
|
|
15335
|
+
|
|
15336
|
+
**driverId:** `string`
|
|
15337
|
+
|
|
15338
|
+
</dd>
|
|
15339
|
+
</dl>
|
|
15340
|
+
|
|
15341
|
+
<dl>
|
|
15342
|
+
<dd>
|
|
15343
|
+
|
|
15344
|
+
**request:** `Chrt.shipping.DriverClientUpdate1`
|
|
15345
|
+
|
|
15346
|
+
</dd>
|
|
15347
|
+
</dl>
|
|
15348
|
+
|
|
15349
|
+
<dl>
|
|
15350
|
+
<dd>
|
|
15351
|
+
|
|
15352
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
15353
|
+
|
|
15354
|
+
</dd>
|
|
15355
|
+
</dl>
|
|
15356
|
+
</dd>
|
|
15357
|
+
</dl>
|
|
15358
|
+
|
|
15359
|
+
</dd>
|
|
15360
|
+
</dl>
|
|
15361
|
+
</details>
|
|
15362
|
+
|
|
15363
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
|
|
15364
|
+
<dl>
|
|
15365
|
+
<dd>
|
|
15366
|
+
|
|
15367
|
+
#### 📝 Description
|
|
15368
|
+
|
|
15369
|
+
<dl>
|
|
15370
|
+
<dd>
|
|
15371
|
+
|
|
15372
|
+
<dl>
|
|
15373
|
+
<dd>
|
|
15374
|
+
|
|
15375
|
+
Clears the driver's last known location and timestamp. | () -> (bool)
|
|
15376
|
+
|
|
15377
|
+
</dd>
|
|
15378
|
+
</dl>
|
|
15379
|
+
</dd>
|
|
15380
|
+
</dl>
|
|
15381
|
+
|
|
15382
|
+
#### 🔌 Usage
|
|
15383
|
+
|
|
15384
|
+
<dl>
|
|
15385
|
+
<dd>
|
|
15386
|
+
|
|
15387
|
+
<dl>
|
|
15388
|
+
<dd>
|
|
15389
|
+
|
|
15390
|
+
```typescript
|
|
15391
|
+
await client.shipping.drivers.clearLastSeenV1();
|
|
15392
|
+
```
|
|
15393
|
+
|
|
15394
|
+
</dd>
|
|
15395
|
+
</dl>
|
|
15396
|
+
</dd>
|
|
15397
|
+
</dl>
|
|
15398
|
+
|
|
15399
|
+
#### ⚙️ Parameters
|
|
15400
|
+
|
|
15401
|
+
<dl>
|
|
15402
|
+
<dd>
|
|
15403
|
+
|
|
15404
|
+
<dl>
|
|
15405
|
+
<dd>
|
|
15406
|
+
|
|
15407
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
15408
|
+
|
|
15409
|
+
</dd>
|
|
15410
|
+
</dl>
|
|
15411
|
+
</dd>
|
|
15412
|
+
</dl>
|
|
15413
|
+
|
|
15414
|
+
</dd>
|
|
15415
|
+
</dl>
|
|
15416
|
+
</details>
|
|
15417
|
+
|
|
15418
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToDriverV1</a>({ ...params }) -> boolean</code></summary>
|
|
15419
|
+
<dl>
|
|
15420
|
+
<dd>
|
|
15421
|
+
|
|
15422
|
+
#### 📝 Description
|
|
15423
|
+
|
|
15424
|
+
<dl>
|
|
15425
|
+
<dd>
|
|
15426
|
+
|
|
15427
|
+
<dl>
|
|
15428
|
+
<dd>
|
|
15429
|
+
|
|
15430
|
+
Updates the caller's driver availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only. | (DriverUpdateAvailabilityReq) -> (bool)
|
|
15431
|
+
|
|
15432
|
+
</dd>
|
|
15433
|
+
</dl>
|
|
15434
|
+
</dd>
|
|
15435
|
+
</dl>
|
|
15436
|
+
|
|
15437
|
+
#### 🔌 Usage
|
|
15438
|
+
|
|
15439
|
+
<dl>
|
|
15440
|
+
<dd>
|
|
15441
|
+
|
|
15442
|
+
<dl>
|
|
15443
|
+
<dd>
|
|
15444
|
+
|
|
15445
|
+
```typescript
|
|
15446
|
+
await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
15447
|
+
available: true,
|
|
15448
|
+
});
|
|
15449
|
+
```
|
|
15450
|
+
|
|
15451
|
+
</dd>
|
|
15452
|
+
</dl>
|
|
15453
|
+
</dd>
|
|
15454
|
+
</dl>
|
|
15455
|
+
|
|
15456
|
+
#### ⚙️ Parameters
|
|
15457
|
+
|
|
15458
|
+
<dl>
|
|
15459
|
+
<dd>
|
|
15460
|
+
|
|
15461
|
+
<dl>
|
|
15462
|
+
<dd>
|
|
15463
|
+
|
|
15464
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
15465
|
+
|
|
15466
|
+
</dd>
|
|
15467
|
+
</dl>
|
|
15468
|
+
|
|
15469
|
+
<dl>
|
|
15470
|
+
<dd>
|
|
15471
|
+
|
|
15472
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
15473
|
+
|
|
15474
|
+
</dd>
|
|
15475
|
+
</dl>
|
|
15476
|
+
</dd>
|
|
15477
|
+
</dl>
|
|
15478
|
+
|
|
15479
|
+
</dd>
|
|
15480
|
+
</dl>
|
|
15481
|
+
</details>
|
|
15482
|
+
|
|
15483
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToOperatorsV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
15484
|
+
<dl>
|
|
15485
|
+
<dd>
|
|
15486
|
+
|
|
15487
|
+
#### 📝 Description
|
|
15488
|
+
|
|
15489
|
+
<dl>
|
|
15490
|
+
<dd>
|
|
15491
|
+
|
|
15492
|
+
<dl>
|
|
15493
|
+
<dd>
|
|
15494
|
+
|
|
15495
|
+
Updates a driver's availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)
|
|
14737
15496
|
|
|
14738
15497
|
</dd>
|
|
14739
15498
|
</dl>
|
|
@@ -14749,13 +15508,8 @@ Lists all drivers belonging to the caller's organization with filtering, sorting
|
|
|
14749
15508
|
<dd>
|
|
14750
15509
|
|
|
14751
15510
|
```typescript
|
|
14752
|
-
await client.shipping.drivers.
|
|
14753
|
-
|
|
14754
|
-
page: 1,
|
|
14755
|
-
page_size: 1,
|
|
14756
|
-
search: "search",
|
|
14757
|
-
filter_available_according_to_driver: true,
|
|
14758
|
-
filter_available_according_to_operators: true,
|
|
15511
|
+
await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
|
|
15512
|
+
available: true,
|
|
14759
15513
|
});
|
|
14760
15514
|
```
|
|
14761
15515
|
|
|
@@ -14772,7 +15526,15 @@ await client.shipping.drivers.listV1({
|
|
|
14772
15526
|
<dl>
|
|
14773
15527
|
<dd>
|
|
14774
15528
|
|
|
14775
|
-
**
|
|
15529
|
+
**driverId:** `string`
|
|
15530
|
+
|
|
15531
|
+
</dd>
|
|
15532
|
+
</dl>
|
|
15533
|
+
|
|
15534
|
+
<dl>
|
|
15535
|
+
<dd>
|
|
15536
|
+
|
|
15537
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
14776
15538
|
|
|
14777
15539
|
</dd>
|
|
14778
15540
|
</dl>
|
|
@@ -14791,7 +15553,7 @@ await client.shipping.drivers.listV1({
|
|
|
14791
15553
|
</dl>
|
|
14792
15554
|
</details>
|
|
14793
15555
|
|
|
14794
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
15556
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAutoAssignV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
14795
15557
|
<dl>
|
|
14796
15558
|
<dd>
|
|
14797
15559
|
|
|
@@ -14803,7 +15565,7 @@ await client.shipping.drivers.listV1({
|
|
|
14803
15565
|
<dl>
|
|
14804
15566
|
<dd>
|
|
14805
15567
|
|
|
14806
|
-
|
|
15568
|
+
Toggles a driver's `auto_assign_enabled` flag — opt-in for direct (non-bidding) task-group assignment. Authorized: the driver themselves OR an operator+ in the driver's org (operators may override the driver's setting). Provider orgs only. | (DriverUpdateAutoAssignReq) -> (bool)
|
|
14807
15569
|
|
|
14808
15570
|
</dd>
|
|
14809
15571
|
</dl>
|
|
@@ -14819,9 +15581,8 @@ Creates a new driver profile for the target user (defaults to caller). Drivers c
|
|
|
14819
15581
|
<dd>
|
|
14820
15582
|
|
|
14821
15583
|
```typescript
|
|
14822
|
-
await client.shipping.drivers.
|
|
14823
|
-
|
|
14824
|
-
schema_version: 1,
|
|
15584
|
+
await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
15585
|
+
auto_assign_enabled: true,
|
|
14825
15586
|
});
|
|
14826
15587
|
```
|
|
14827
15588
|
|
|
@@ -14838,7 +15599,15 @@ await client.shipping.drivers.createV1({
|
|
|
14838
15599
|
<dl>
|
|
14839
15600
|
<dd>
|
|
14840
15601
|
|
|
14841
|
-
**
|
|
15602
|
+
**driverId:** `string`
|
|
15603
|
+
|
|
15604
|
+
</dd>
|
|
15605
|
+
</dl>
|
|
15606
|
+
|
|
15607
|
+
<dl>
|
|
15608
|
+
<dd>
|
|
15609
|
+
|
|
15610
|
+
**request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
|
|
14842
15611
|
|
|
14843
15612
|
</dd>
|
|
14844
15613
|
</dl>
|
|
@@ -14857,7 +15626,9 @@ await client.shipping.drivers.createV1({
|
|
|
14857
15626
|
</dl>
|
|
14858
15627
|
</details>
|
|
14859
15628
|
|
|
14860
|
-
|
|
15629
|
+
## Shipping Cargos
|
|
15630
|
+
|
|
15631
|
+
<details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
14861
15632
|
<dl>
|
|
14862
15633
|
<dd>
|
|
14863
15634
|
|
|
@@ -14869,7 +15640,7 @@ await client.shipping.drivers.createV1({
|
|
|
14869
15640
|
<dl>
|
|
14870
15641
|
<dd>
|
|
14871
15642
|
|
|
14872
|
-
Updates
|
|
15643
|
+
Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_owner_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
14873
15644
|
|
|
14874
15645
|
</dd>
|
|
14875
15646
|
</dl>
|
|
@@ -14885,7 +15656,7 @@ Updates driver contact details and vehicle type assignments. Provider orgs only;
|
|
|
14885
15656
|
<dd>
|
|
14886
15657
|
|
|
14887
15658
|
```typescript
|
|
14888
|
-
await client.shipping.
|
|
15659
|
+
await client.shipping.cargos.updateV1("cargo_id", {});
|
|
14889
15660
|
```
|
|
14890
15661
|
|
|
14891
15662
|
</dd>
|
|
@@ -14901,7 +15672,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
14901
15672
|
<dl>
|
|
14902
15673
|
<dd>
|
|
14903
15674
|
|
|
14904
|
-
**
|
|
15675
|
+
**cargoId:** `string`
|
|
14905
15676
|
|
|
14906
15677
|
</dd>
|
|
14907
15678
|
</dl>
|
|
@@ -14909,7 +15680,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
14909
15680
|
<dl>
|
|
14910
15681
|
<dd>
|
|
14911
15682
|
|
|
14912
|
-
**request:** `Chrt.
|
|
15683
|
+
**request:** `Chrt.CargoClientUpdate1`
|
|
14913
15684
|
|
|
14914
15685
|
</dd>
|
|
14915
15686
|
</dl>
|
|
@@ -14917,7 +15688,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
14917
15688
|
<dl>
|
|
14918
15689
|
<dd>
|
|
14919
15690
|
|
|
14920
|
-
**requestOptions:** `
|
|
15691
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
14921
15692
|
|
|
14922
15693
|
</dd>
|
|
14923
15694
|
</dl>
|
|
@@ -14928,7 +15699,9 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
14928
15699
|
</dl>
|
|
14929
15700
|
</details>
|
|
14930
15701
|
|
|
14931
|
-
|
|
15702
|
+
## Shipping Flights
|
|
15703
|
+
|
|
15704
|
+
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
|
|
14932
15705
|
<dl>
|
|
14933
15706
|
<dd>
|
|
14934
15707
|
|
|
@@ -14940,7 +15713,149 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
14940
15713
|
<dl>
|
|
14941
15714
|
<dd>
|
|
14942
15715
|
|
|
14943
|
-
|
|
15716
|
+
Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
|
|
15717
|
+
|
|
15718
|
+
</dd>
|
|
15719
|
+
</dl>
|
|
15720
|
+
</dd>
|
|
15721
|
+
</dl>
|
|
15722
|
+
|
|
15723
|
+
#### 🔌 Usage
|
|
15724
|
+
|
|
15725
|
+
<dl>
|
|
15726
|
+
<dd>
|
|
15727
|
+
|
|
15728
|
+
<dl>
|
|
15729
|
+
<dd>
|
|
15730
|
+
|
|
15731
|
+
```typescript
|
|
15732
|
+
await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
15733
|
+
```
|
|
15734
|
+
|
|
15735
|
+
</dd>
|
|
15736
|
+
</dl>
|
|
15737
|
+
</dd>
|
|
15738
|
+
</dl>
|
|
15739
|
+
|
|
15740
|
+
#### ⚙️ Parameters
|
|
15741
|
+
|
|
15742
|
+
<dl>
|
|
15743
|
+
<dd>
|
|
15744
|
+
|
|
15745
|
+
<dl>
|
|
15746
|
+
<dd>
|
|
15747
|
+
|
|
15748
|
+
**taskId:** `string`
|
|
15749
|
+
|
|
15750
|
+
</dd>
|
|
15751
|
+
</dl>
|
|
15752
|
+
|
|
15753
|
+
<dl>
|
|
15754
|
+
<dd>
|
|
15755
|
+
|
|
15756
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
15757
|
+
|
|
15758
|
+
</dd>
|
|
15759
|
+
</dl>
|
|
15760
|
+
</dd>
|
|
15761
|
+
</dl>
|
|
15762
|
+
|
|
15763
|
+
</dd>
|
|
15764
|
+
</dl>
|
|
15765
|
+
</details>
|
|
15766
|
+
|
|
15767
|
+
## Shipping TaskArtifacts
|
|
15768
|
+
|
|
15769
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
15770
|
+
<dl>
|
|
15771
|
+
<dd>
|
|
15772
|
+
|
|
15773
|
+
#### 📝 Description
|
|
15774
|
+
|
|
15775
|
+
<dl>
|
|
15776
|
+
<dd>
|
|
15777
|
+
|
|
15778
|
+
<dl>
|
|
15779
|
+
<dd>
|
|
15780
|
+
|
|
15781
|
+
Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
|
|
15782
|
+
|
|
15783
|
+
</dd>
|
|
15784
|
+
</dl>
|
|
15785
|
+
</dd>
|
|
15786
|
+
</dl>
|
|
15787
|
+
|
|
15788
|
+
#### 🔌 Usage
|
|
15789
|
+
|
|
15790
|
+
<dl>
|
|
15791
|
+
<dd>
|
|
15792
|
+
|
|
15793
|
+
<dl>
|
|
15794
|
+
<dd>
|
|
15795
|
+
|
|
15796
|
+
```typescript
|
|
15797
|
+
await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
15798
|
+
task_artifact: {
|
|
15799
|
+
schema_version: 1,
|
|
15800
|
+
type: "image",
|
|
15801
|
+
},
|
|
15802
|
+
status: "draft",
|
|
15803
|
+
});
|
|
15804
|
+
```
|
|
15805
|
+
|
|
15806
|
+
</dd>
|
|
15807
|
+
</dl>
|
|
15808
|
+
</dd>
|
|
15809
|
+
</dl>
|
|
15810
|
+
|
|
15811
|
+
#### ⚙️ Parameters
|
|
15812
|
+
|
|
15813
|
+
<dl>
|
|
15814
|
+
<dd>
|
|
15815
|
+
|
|
15816
|
+
<dl>
|
|
15817
|
+
<dd>
|
|
15818
|
+
|
|
15819
|
+
**taskId:** `string`
|
|
15820
|
+
|
|
15821
|
+
</dd>
|
|
15822
|
+
</dl>
|
|
15823
|
+
|
|
15824
|
+
<dl>
|
|
15825
|
+
<dd>
|
|
15826
|
+
|
|
15827
|
+
**request:** `Chrt.shipping.AddTaskArtifactReq`
|
|
15828
|
+
|
|
15829
|
+
</dd>
|
|
15830
|
+
</dl>
|
|
15831
|
+
|
|
15832
|
+
<dl>
|
|
15833
|
+
<dd>
|
|
15834
|
+
|
|
15835
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
15836
|
+
|
|
15837
|
+
</dd>
|
|
15838
|
+
</dl>
|
|
15839
|
+
</dd>
|
|
15840
|
+
</dl>
|
|
15841
|
+
|
|
15842
|
+
</dd>
|
|
15843
|
+
</dl>
|
|
15844
|
+
</details>
|
|
15845
|
+
|
|
15846
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">completeV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
15847
|
+
<dl>
|
|
15848
|
+
<dd>
|
|
15849
|
+
|
|
15850
|
+
#### 📝 Description
|
|
15851
|
+
|
|
15852
|
+
<dl>
|
|
15853
|
+
<dd>
|
|
15854
|
+
|
|
15855
|
+
<dl>
|
|
15856
|
+
<dd>
|
|
15857
|
+
|
|
15858
|
+
Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
14944
15859
|
|
|
14945
15860
|
</dd>
|
|
14946
15861
|
</dl>
|
|
@@ -14956,7 +15871,7 @@ Clears the driver's last known location and timestamp. | () -> (bool)
|
|
|
14956
15871
|
<dd>
|
|
14957
15872
|
|
|
14958
15873
|
```typescript
|
|
14959
|
-
await client.shipping.
|
|
15874
|
+
await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
14960
15875
|
```
|
|
14961
15876
|
|
|
14962
15877
|
</dd>
|
|
@@ -14972,7 +15887,15 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
14972
15887
|
<dl>
|
|
14973
15888
|
<dd>
|
|
14974
15889
|
|
|
14975
|
-
**
|
|
15890
|
+
**taskArtifactId:** `string`
|
|
15891
|
+
|
|
15892
|
+
</dd>
|
|
15893
|
+
</dl>
|
|
15894
|
+
|
|
15895
|
+
<dl>
|
|
15896
|
+
<dd>
|
|
15897
|
+
|
|
15898
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
14976
15899
|
|
|
14977
15900
|
</dd>
|
|
14978
15901
|
</dl>
|
|
@@ -14983,7 +15906,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
14983
15906
|
</dl>
|
|
14984
15907
|
</details>
|
|
14985
15908
|
|
|
14986
|
-
<details><summary><code>client.shipping.
|
|
15909
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
14987
15910
|
<dl>
|
|
14988
15911
|
<dd>
|
|
14989
15912
|
|
|
@@ -14995,7 +15918,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
14995
15918
|
<dl>
|
|
14996
15919
|
<dd>
|
|
14997
15920
|
|
|
14998
|
-
|
|
15921
|
+
Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
14999
15922
|
|
|
15000
15923
|
</dd>
|
|
15001
15924
|
</dl>
|
|
@@ -15011,9 +15934,7 @@ Updates the caller's driver availability status. Must have status UNASSIGNED to
|
|
|
15011
15934
|
<dd>
|
|
15012
15935
|
|
|
15013
15936
|
```typescript
|
|
15014
|
-
await client.shipping.
|
|
15015
|
-
available: true,
|
|
15016
|
-
});
|
|
15937
|
+
await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
15017
15938
|
```
|
|
15018
15939
|
|
|
15019
15940
|
</dd>
|
|
@@ -15029,7 +15950,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
15029
15950
|
<dl>
|
|
15030
15951
|
<dd>
|
|
15031
15952
|
|
|
15032
|
-
**
|
|
15953
|
+
**taskArtifactId:** `string`
|
|
15033
15954
|
|
|
15034
15955
|
</dd>
|
|
15035
15956
|
</dl>
|
|
@@ -15037,7 +15958,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
15037
15958
|
<dl>
|
|
15038
15959
|
<dd>
|
|
15039
15960
|
|
|
15040
|
-
**requestOptions:** `
|
|
15961
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
15041
15962
|
|
|
15042
15963
|
</dd>
|
|
15043
15964
|
</dl>
|
|
@@ -15048,7 +15969,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
15048
15969
|
</dl>
|
|
15049
15970
|
</details>
|
|
15050
15971
|
|
|
15051
|
-
<details><summary><code>client.shipping.
|
|
15972
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
15052
15973
|
<dl>
|
|
15053
15974
|
<dd>
|
|
15054
15975
|
|
|
@@ -15060,7 +15981,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
15060
15981
|
<dl>
|
|
15061
15982
|
<dd>
|
|
15062
15983
|
|
|
15063
|
-
|
|
15984
|
+
Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
15064
15985
|
|
|
15065
15986
|
</dd>
|
|
15066
15987
|
</dl>
|
|
@@ -15076,9 +15997,7 @@ Updates a driver's availability status. Must have status UNASSIGNED to set avail
|
|
|
15076
15997
|
<dd>
|
|
15077
15998
|
|
|
15078
15999
|
```typescript
|
|
15079
|
-
await client.shipping.
|
|
15080
|
-
available: true,
|
|
15081
|
-
});
|
|
16000
|
+
await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
15082
16001
|
```
|
|
15083
16002
|
|
|
15084
16003
|
</dd>
|
|
@@ -15094,15 +16013,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
15094
16013
|
<dl>
|
|
15095
16014
|
<dd>
|
|
15096
16015
|
|
|
15097
|
-
**
|
|
15098
|
-
|
|
15099
|
-
</dd>
|
|
15100
|
-
</dl>
|
|
15101
|
-
|
|
15102
|
-
<dl>
|
|
15103
|
-
<dd>
|
|
15104
|
-
|
|
15105
|
-
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
16016
|
+
**taskArtifactId:** `string`
|
|
15106
16017
|
|
|
15107
16018
|
</dd>
|
|
15108
16019
|
</dl>
|
|
@@ -15110,7 +16021,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
15110
16021
|
<dl>
|
|
15111
16022
|
<dd>
|
|
15112
16023
|
|
|
15113
|
-
**requestOptions:** `
|
|
16024
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
15114
16025
|
|
|
15115
16026
|
</dd>
|
|
15116
16027
|
</dl>
|
|
@@ -15121,7 +16032,9 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
15121
16032
|
</dl>
|
|
15122
16033
|
</details>
|
|
15123
16034
|
|
|
15124
|
-
|
|
16035
|
+
## Shipping Orders
|
|
16036
|
+
|
|
16037
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
15125
16038
|
<dl>
|
|
15126
16039
|
<dd>
|
|
15127
16040
|
|
|
@@ -15133,7 +16046,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
15133
16046
|
<dl>
|
|
15134
16047
|
<dd>
|
|
15135
16048
|
|
|
15136
|
-
|
|
16049
|
+
Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
15137
16050
|
|
|
15138
16051
|
</dd>
|
|
15139
16052
|
</dl>
|
|
@@ -15149,9 +16062,7 @@ Toggles a driver's `auto_assign_enabled` flag — opt-in for direct (non-bidding
|
|
|
15149
16062
|
<dd>
|
|
15150
16063
|
|
|
15151
16064
|
```typescript
|
|
15152
|
-
await client.shipping.
|
|
15153
|
-
auto_assign_enabled: true,
|
|
15154
|
-
});
|
|
16065
|
+
await client.shipping.orders.stageV1("order_id");
|
|
15155
16066
|
```
|
|
15156
16067
|
|
|
15157
16068
|
</dd>
|
|
@@ -15167,15 +16078,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
15167
16078
|
<dl>
|
|
15168
16079
|
<dd>
|
|
15169
16080
|
|
|
15170
|
-
**
|
|
15171
|
-
|
|
15172
|
-
</dd>
|
|
15173
|
-
</dl>
|
|
15174
|
-
|
|
15175
|
-
<dl>
|
|
15176
|
-
<dd>
|
|
15177
|
-
|
|
15178
|
-
**request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
|
|
16081
|
+
**orderId:** `string`
|
|
15179
16082
|
|
|
15180
16083
|
</dd>
|
|
15181
16084
|
</dl>
|
|
@@ -15183,7 +16086,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
15183
16086
|
<dl>
|
|
15184
16087
|
<dd>
|
|
15185
16088
|
|
|
15186
|
-
**requestOptions:** `
|
|
16089
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
15187
16090
|
|
|
15188
16091
|
</dd>
|
|
15189
16092
|
</dl>
|
|
@@ -15194,9 +16097,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
15194
16097
|
</dl>
|
|
15195
16098
|
</details>
|
|
15196
16099
|
|
|
15197
|
-
|
|
15198
|
-
|
|
15199
|
-
<details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
16100
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateOffChrtReferenceIdV1</a>(orderId, { ...params }) -> Chrt.OrdersUpdateOffChrtReferenceIdRes</code></summary>
|
|
15200
16101
|
<dl>
|
|
15201
16102
|
<dd>
|
|
15202
16103
|
|
|
@@ -15208,7 +16109,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
15208
16109
|
<dl>
|
|
15209
16110
|
<dd>
|
|
15210
16111
|
|
|
15211
|
-
Updates
|
|
16112
|
+
Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
15212
16113
|
|
|
15213
16114
|
</dd>
|
|
15214
16115
|
</dl>
|
|
@@ -15224,7 +16125,7 @@ Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPP
|
|
|
15224
16125
|
<dd>
|
|
15225
16126
|
|
|
15226
16127
|
```typescript
|
|
15227
|
-
await client.shipping.
|
|
16128
|
+
await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
15228
16129
|
```
|
|
15229
16130
|
|
|
15230
16131
|
</dd>
|
|
@@ -15240,7 +16141,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
15240
16141
|
<dl>
|
|
15241
16142
|
<dd>
|
|
15242
16143
|
|
|
15243
|
-
**
|
|
16144
|
+
**orderId:** `string`
|
|
15244
16145
|
|
|
15245
16146
|
</dd>
|
|
15246
16147
|
</dl>
|
|
@@ -15248,7 +16149,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
15248
16149
|
<dl>
|
|
15249
16150
|
<dd>
|
|
15250
16151
|
|
|
15251
|
-
**request:** `Chrt.
|
|
16152
|
+
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
15252
16153
|
|
|
15253
16154
|
</dd>
|
|
15254
16155
|
</dl>
|
|
@@ -15256,7 +16157,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
15256
16157
|
<dl>
|
|
15257
16158
|
<dd>
|
|
15258
16159
|
|
|
15259
|
-
**requestOptions:** `
|
|
16160
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
15260
16161
|
|
|
15261
16162
|
</dd>
|
|
15262
16163
|
</dl>
|
|
@@ -15267,9 +16168,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
15267
16168
|
</dl>
|
|
15268
16169
|
</details>
|
|
15269
16170
|
|
|
15270
|
-
|
|
15271
|
-
|
|
15272
|
-
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
|
|
16171
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
|
|
15273
16172
|
<dl>
|
|
15274
16173
|
<dd>
|
|
15275
16174
|
|
|
@@ -15281,7 +16180,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
15281
16180
|
<dl>
|
|
15282
16181
|
<dd>
|
|
15283
16182
|
|
|
15284
|
-
|
|
16183
|
+
Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
15285
16184
|
|
|
15286
16185
|
</dd>
|
|
15287
16186
|
</dl>
|
|
@@ -15297,7 +16196,7 @@ Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or
|
|
|
15297
16196
|
<dd>
|
|
15298
16197
|
|
|
15299
16198
|
```typescript
|
|
15300
|
-
await client.shipping.
|
|
16199
|
+
await client.shipping.orders.cancelV1("order_id");
|
|
15301
16200
|
```
|
|
15302
16201
|
|
|
15303
16202
|
</dd>
|
|
@@ -15313,7 +16212,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
15313
16212
|
<dl>
|
|
15314
16213
|
<dd>
|
|
15315
16214
|
|
|
15316
|
-
**
|
|
16215
|
+
**orderId:** `string`
|
|
15317
16216
|
|
|
15318
16217
|
</dd>
|
|
15319
16218
|
</dl>
|
|
@@ -15321,7 +16220,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
15321
16220
|
<dl>
|
|
15322
16221
|
<dd>
|
|
15323
16222
|
|
|
15324
|
-
**requestOptions:** `
|
|
16223
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
15325
16224
|
|
|
15326
16225
|
</dd>
|
|
15327
16226
|
</dl>
|
|
@@ -15332,9 +16231,9 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
15332
16231
|
</dl>
|
|
15333
16232
|
</details>
|
|
15334
16233
|
|
|
15335
|
-
## Shipping
|
|
16234
|
+
## Shipping OrderDrafts
|
|
15336
16235
|
|
|
15337
|
-
<details><summary><code>client.shipping.
|
|
16236
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
15338
16237
|
<dl>
|
|
15339
16238
|
<dd>
|
|
15340
16239
|
|
|
@@ -15346,7 +16245,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
15346
16245
|
<dl>
|
|
15347
16246
|
<dd>
|
|
15348
16247
|
|
|
15349
|
-
|
|
16248
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
15350
16249
|
|
|
15351
16250
|
</dd>
|
|
15352
16251
|
</dl>
|
|
@@ -15362,13 +16261,7 @@ Adds a new task artifact to a task. | authz_personas=[driver_for_executor, execu
|
|
|
15362
16261
|
<dd>
|
|
15363
16262
|
|
|
15364
16263
|
```typescript
|
|
15365
|
-
await client.shipping.
|
|
15366
|
-
task_artifact: {
|
|
15367
|
-
schema_version: 1,
|
|
15368
|
-
type: "image",
|
|
15369
|
-
},
|
|
15370
|
-
status: "draft",
|
|
15371
|
-
});
|
|
16264
|
+
await client.shipping.orderDrafts.newV1();
|
|
15372
16265
|
```
|
|
15373
16266
|
|
|
15374
16267
|
</dd>
|
|
@@ -15384,15 +16277,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
15384
16277
|
<dl>
|
|
15385
16278
|
<dd>
|
|
15386
16279
|
|
|
15387
|
-
**
|
|
15388
|
-
|
|
15389
|
-
</dd>
|
|
15390
|
-
</dl>
|
|
15391
|
-
|
|
15392
|
-
<dl>
|
|
15393
|
-
<dd>
|
|
15394
|
-
|
|
15395
|
-
**request:** `Chrt.shipping.AddTaskArtifactReq`
|
|
16280
|
+
**request:** `Chrt.shipping.OrdersNewDraftReq`
|
|
15396
16281
|
|
|
15397
16282
|
</dd>
|
|
15398
16283
|
</dl>
|
|
@@ -15400,7 +16285,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
15400
16285
|
<dl>
|
|
15401
16286
|
<dd>
|
|
15402
16287
|
|
|
15403
|
-
**requestOptions:** `
|
|
16288
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
15404
16289
|
|
|
15405
16290
|
</dd>
|
|
15406
16291
|
</dl>
|
|
@@ -15411,7 +16296,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
15411
16296
|
</dl>
|
|
15412
16297
|
</details>
|
|
15413
16298
|
|
|
15414
|
-
<details><summary><code>client.shipping.
|
|
16299
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">updateV1</a>(orderId, { ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
15415
16300
|
<dl>
|
|
15416
16301
|
<dd>
|
|
15417
16302
|
|
|
@@ -15423,7 +16308,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
15423
16308
|
<dl>
|
|
15424
16309
|
<dd>
|
|
15425
16310
|
|
|
15426
|
-
|
|
16311
|
+
Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
15427
16312
|
|
|
15428
16313
|
</dd>
|
|
15429
16314
|
</dl>
|
|
@@ -15439,7 +16324,7 @@ Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, execu
|
|
|
15439
16324
|
<dd>
|
|
15440
16325
|
|
|
15441
16326
|
```typescript
|
|
15442
|
-
await client.shipping.
|
|
16327
|
+
await client.shipping.orderDrafts.updateV1("order_id");
|
|
15443
16328
|
```
|
|
15444
16329
|
|
|
15445
16330
|
</dd>
|
|
@@ -15455,7 +16340,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
15455
16340
|
<dl>
|
|
15456
16341
|
<dd>
|
|
15457
16342
|
|
|
15458
|
-
**
|
|
16343
|
+
**orderId:** `string`
|
|
15459
16344
|
|
|
15460
16345
|
</dd>
|
|
15461
16346
|
</dl>
|
|
@@ -15463,7 +16348,15 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
15463
16348
|
<dl>
|
|
15464
16349
|
<dd>
|
|
15465
16350
|
|
|
15466
|
-
**
|
|
16351
|
+
**request:** `Chrt.shipping.OrdersDraftUpdateReq`
|
|
16352
|
+
|
|
16353
|
+
</dd>
|
|
16354
|
+
</dl>
|
|
16355
|
+
|
|
16356
|
+
<dl>
|
|
16357
|
+
<dd>
|
|
16358
|
+
|
|
16359
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
15467
16360
|
|
|
15468
16361
|
</dd>
|
|
15469
16362
|
</dl>
|
|
@@ -15474,7 +16367,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
15474
16367
|
</dl>
|
|
15475
16368
|
</details>
|
|
15476
16369
|
|
|
15477
|
-
<details><summary><code>client.shipping.
|
|
16370
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
15478
16371
|
<dl>
|
|
15479
16372
|
<dd>
|
|
15480
16373
|
|
|
@@ -15486,7 +16379,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
15486
16379
|
<dl>
|
|
15487
16380
|
<dd>
|
|
15488
16381
|
|
|
15489
|
-
|
|
16382
|
+
Deletes a draft order and all associated entities. | () -> (bool)
|
|
15490
16383
|
|
|
15491
16384
|
</dd>
|
|
15492
16385
|
</dl>
|
|
@@ -15502,7 +16395,7 @@ Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executo
|
|
|
15502
16395
|
<dd>
|
|
15503
16396
|
|
|
15504
16397
|
```typescript
|
|
15505
|
-
await client.shipping.
|
|
16398
|
+
await client.shipping.orderDrafts.deleteV1("order_id");
|
|
15506
16399
|
```
|
|
15507
16400
|
|
|
15508
16401
|
</dd>
|
|
@@ -15518,7 +16411,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
15518
16411
|
<dl>
|
|
15519
16412
|
<dd>
|
|
15520
16413
|
|
|
15521
|
-
**
|
|
16414
|
+
**orderId:** `string`
|
|
15522
16415
|
|
|
15523
16416
|
</dd>
|
|
15524
16417
|
</dl>
|
|
@@ -15526,7 +16419,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
15526
16419
|
<dl>
|
|
15527
16420
|
<dd>
|
|
15528
16421
|
|
|
15529
|
-
**requestOptions:** `
|
|
16422
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
15530
16423
|
|
|
15531
16424
|
</dd>
|
|
15532
16425
|
</dl>
|
|
@@ -15537,7 +16430,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
15537
16430
|
</dl>
|
|
15538
16431
|
</details>
|
|
15539
16432
|
|
|
15540
|
-
<details><summary><code>client.shipping.
|
|
16433
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
|
|
15541
16434
|
<dl>
|
|
15542
16435
|
<dd>
|
|
15543
16436
|
|
|
@@ -15549,7 +16442,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
15549
16442
|
<dl>
|
|
15550
16443
|
<dd>
|
|
15551
16444
|
|
|
15552
|
-
|
|
16445
|
+
Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
|
|
15553
16446
|
|
|
15554
16447
|
</dd>
|
|
15555
16448
|
</dl>
|
|
@@ -15565,7 +16458,7 @@ Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
|
15565
16458
|
<dd>
|
|
15566
16459
|
|
|
15567
16460
|
```typescript
|
|
15568
|
-
await client.shipping.
|
|
16461
|
+
await client.shipping.orderDrafts.validateV1("order_id");
|
|
15569
16462
|
```
|
|
15570
16463
|
|
|
15571
16464
|
</dd>
|
|
@@ -15581,7 +16474,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
15581
16474
|
<dl>
|
|
15582
16475
|
<dd>
|
|
15583
16476
|
|
|
15584
|
-
**
|
|
16477
|
+
**orderId:** `string`
|
|
15585
16478
|
|
|
15586
16479
|
</dd>
|
|
15587
16480
|
</dl>
|
|
@@ -15589,7 +16482,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
15589
16482
|
<dl>
|
|
15590
16483
|
<dd>
|
|
15591
16484
|
|
|
15592
|
-
**requestOptions:** `
|
|
16485
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
15593
16486
|
|
|
15594
16487
|
</dd>
|
|
15595
16488
|
</dl>
|
|
@@ -15600,9 +16493,9 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
15600
16493
|
</dl>
|
|
15601
16494
|
</details>
|
|
15602
16495
|
|
|
15603
|
-
## Shipping
|
|
16496
|
+
## Shipping OrderSchedules
|
|
15604
16497
|
|
|
15605
|
-
<details><summary><code>client.shipping.
|
|
16498
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderScheduleListRes</code></summary>
|
|
15606
16499
|
<dl>
|
|
15607
16500
|
<dd>
|
|
15608
16501
|
|
|
@@ -15614,7 +16507,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
15614
16507
|
<dl>
|
|
15615
16508
|
<dd>
|
|
15616
16509
|
|
|
15617
|
-
|
|
16510
|
+
Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
|
|
15618
16511
|
|
|
15619
16512
|
</dd>
|
|
15620
16513
|
</dl>
|
|
@@ -15630,7 +16523,17 @@ Validates a draft order and stages all related entities in a transaction. | () -
|
|
|
15630
16523
|
<dd>
|
|
15631
16524
|
|
|
15632
16525
|
```typescript
|
|
15633
|
-
await client.shipping.
|
|
16526
|
+
await client.shipping.orderSchedules.listV1({
|
|
16527
|
+
sort_by: "created_at_timestamp",
|
|
16528
|
+
sort_order: "asc",
|
|
16529
|
+
page: 1,
|
|
16530
|
+
page_size: 1,
|
|
16531
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16532
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16533
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16534
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16535
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16536
|
+
});
|
|
15634
16537
|
```
|
|
15635
16538
|
|
|
15636
16539
|
</dd>
|
|
@@ -15646,7 +16549,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
15646
16549
|
<dl>
|
|
15647
16550
|
<dd>
|
|
15648
16551
|
|
|
15649
|
-
**
|
|
16552
|
+
**request:** `Chrt.shipping.OrderSchedulesListV1Request`
|
|
15650
16553
|
|
|
15651
16554
|
</dd>
|
|
15652
16555
|
</dl>
|
|
@@ -15654,7 +16557,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
15654
16557
|
<dl>
|
|
15655
16558
|
<dd>
|
|
15656
16559
|
|
|
15657
|
-
**requestOptions:** `
|
|
16560
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15658
16561
|
|
|
15659
16562
|
</dd>
|
|
15660
16563
|
</dl>
|
|
@@ -15665,7 +16568,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
15665
16568
|
</dl>
|
|
15666
16569
|
</details>
|
|
15667
16570
|
|
|
15668
|
-
<details><summary><code>client.shipping.
|
|
16571
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">getByIdV1</a>(orderScheduleId) -> Chrt.OrderSchedule1</code></summary>
|
|
15669
16572
|
<dl>
|
|
15670
16573
|
<dd>
|
|
15671
16574
|
|
|
@@ -15677,7 +16580,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
15677
16580
|
<dl>
|
|
15678
16581
|
<dd>
|
|
15679
16582
|
|
|
15680
|
-
|
|
16583
|
+
Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
|
|
15681
16584
|
|
|
15682
16585
|
</dd>
|
|
15683
16586
|
</dl>
|
|
@@ -15693,7 +16596,7 @@ Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_crea
|
|
|
15693
16596
|
<dd>
|
|
15694
16597
|
|
|
15695
16598
|
```typescript
|
|
15696
|
-
await client.shipping.
|
|
16599
|
+
await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
15697
16600
|
```
|
|
15698
16601
|
|
|
15699
16602
|
</dd>
|
|
@@ -15709,15 +16612,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
15709
16612
|
<dl>
|
|
15710
16613
|
<dd>
|
|
15711
16614
|
|
|
15712
|
-
**
|
|
15713
|
-
|
|
15714
|
-
</dd>
|
|
15715
|
-
</dl>
|
|
15716
|
-
|
|
15717
|
-
<dl>
|
|
15718
|
-
<dd>
|
|
15719
|
-
|
|
15720
|
-
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
16615
|
+
**orderScheduleId:** `string`
|
|
15721
16616
|
|
|
15722
16617
|
</dd>
|
|
15723
16618
|
</dl>
|
|
@@ -15725,7 +16620,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
15725
16620
|
<dl>
|
|
15726
16621
|
<dd>
|
|
15727
16622
|
|
|
15728
|
-
**requestOptions:** `
|
|
16623
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15729
16624
|
|
|
15730
16625
|
</dd>
|
|
15731
16626
|
</dl>
|
|
@@ -15736,7 +16631,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
15736
16631
|
</dl>
|
|
15737
16632
|
</details>
|
|
15738
16633
|
|
|
15739
|
-
<details><summary><code>client.shipping.
|
|
16634
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">aboutV1</a>(orderScheduleId) -> Chrt.OrderScheduleAboutRes</code></summary>
|
|
15740
16635
|
<dl>
|
|
15741
16636
|
<dd>
|
|
15742
16637
|
|
|
@@ -15748,7 +16643,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
15748
16643
|
<dl>
|
|
15749
16644
|
<dd>
|
|
15750
16645
|
|
|
15751
|
-
|
|
16646
|
+
Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
15752
16647
|
|
|
15753
16648
|
</dd>
|
|
15754
16649
|
</dl>
|
|
@@ -15764,7 +16659,7 @@ Cancels an order and all related task groups and tasks in a transaction. | authz
|
|
|
15764
16659
|
<dd>
|
|
15765
16660
|
|
|
15766
16661
|
```typescript
|
|
15767
|
-
await client.shipping.
|
|
16662
|
+
await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
15768
16663
|
```
|
|
15769
16664
|
|
|
15770
16665
|
</dd>
|
|
@@ -15780,7 +16675,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
15780
16675
|
<dl>
|
|
15781
16676
|
<dd>
|
|
15782
16677
|
|
|
15783
|
-
**
|
|
16678
|
+
**orderScheduleId:** `string`
|
|
15784
16679
|
|
|
15785
16680
|
</dd>
|
|
15786
16681
|
</dl>
|
|
@@ -15788,7 +16683,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
15788
16683
|
<dl>
|
|
15789
16684
|
<dd>
|
|
15790
16685
|
|
|
15791
|
-
**requestOptions:** `
|
|
16686
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15792
16687
|
|
|
15793
16688
|
</dd>
|
|
15794
16689
|
</dl>
|
|
@@ -15799,9 +16694,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
15799
16694
|
</dl>
|
|
15800
16695
|
</details>
|
|
15801
16696
|
|
|
15802
|
-
|
|
15803
|
-
|
|
15804
|
-
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
16697
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
|
|
15805
16698
|
<dl>
|
|
15806
16699
|
<dd>
|
|
15807
16700
|
|
|
@@ -15813,7 +16706,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
15813
16706
|
<dl>
|
|
15814
16707
|
<dd>
|
|
15815
16708
|
|
|
15816
|
-
Creates a new draft order
|
|
16709
|
+
Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
|
|
15817
16710
|
|
|
15818
16711
|
</dd>
|
|
15819
16712
|
</dl>
|
|
@@ -15829,7 +16722,12 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
15829
16722
|
<dd>
|
|
15830
16723
|
|
|
15831
16724
|
```typescript
|
|
15832
|
-
await client.shipping.
|
|
16725
|
+
await client.shipping.orderSchedules.newV1({
|
|
16726
|
+
schema_version: 1,
|
|
16727
|
+
name: "name",
|
|
16728
|
+
order_manifest: {},
|
|
16729
|
+
schedule_spec: {},
|
|
16730
|
+
});
|
|
15833
16731
|
```
|
|
15834
16732
|
|
|
15835
16733
|
</dd>
|
|
@@ -15845,7 +16743,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
15845
16743
|
<dl>
|
|
15846
16744
|
<dd>
|
|
15847
16745
|
|
|
15848
|
-
**request:** `Chrt.shipping.
|
|
16746
|
+
**request:** `Chrt.shipping.OrderScheduleClientCreate1`
|
|
15849
16747
|
|
|
15850
16748
|
</dd>
|
|
15851
16749
|
</dl>
|
|
@@ -15853,7 +16751,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
15853
16751
|
<dl>
|
|
15854
16752
|
<dd>
|
|
15855
16753
|
|
|
15856
|
-
**requestOptions:** `
|
|
16754
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15857
16755
|
|
|
15858
16756
|
</dd>
|
|
15859
16757
|
</dl>
|
|
@@ -15864,7 +16762,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
15864
16762
|
</dl>
|
|
15865
16763
|
</details>
|
|
15866
16764
|
|
|
15867
|
-
<details><summary><code>client.shipping.
|
|
16765
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
|
|
15868
16766
|
<dl>
|
|
15869
16767
|
<dd>
|
|
15870
16768
|
|
|
@@ -15876,7 +16774,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
15876
16774
|
<dl>
|
|
15877
16775
|
<dd>
|
|
15878
16776
|
|
|
15879
|
-
Updates
|
|
16777
|
+
Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
15880
16778
|
|
|
15881
16779
|
</dd>
|
|
15882
16780
|
</dl>
|
|
@@ -15892,7 +16790,7 @@ Updates coordinator and/or shipper org assignments for a draft order. | (OrdersD
|
|
|
15892
16790
|
<dd>
|
|
15893
16791
|
|
|
15894
16792
|
```typescript
|
|
15895
|
-
await client.shipping.
|
|
16793
|
+
await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
15896
16794
|
```
|
|
15897
16795
|
|
|
15898
16796
|
</dd>
|
|
@@ -15908,7 +16806,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
15908
16806
|
<dl>
|
|
15909
16807
|
<dd>
|
|
15910
16808
|
|
|
15911
|
-
**
|
|
16809
|
+
**orderScheduleId:** `string`
|
|
15912
16810
|
|
|
15913
16811
|
</dd>
|
|
15914
16812
|
</dl>
|
|
@@ -15916,7 +16814,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
15916
16814
|
<dl>
|
|
15917
16815
|
<dd>
|
|
15918
16816
|
|
|
15919
|
-
**request:** `Chrt.shipping.
|
|
16817
|
+
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
15920
16818
|
|
|
15921
16819
|
</dd>
|
|
15922
16820
|
</dl>
|
|
@@ -15924,7 +16822,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
15924
16822
|
<dl>
|
|
15925
16823
|
<dd>
|
|
15926
16824
|
|
|
15927
|
-
**requestOptions:** `
|
|
16825
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15928
16826
|
|
|
15929
16827
|
</dd>
|
|
15930
16828
|
</dl>
|
|
@@ -15935,7 +16833,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
15935
16833
|
</dl>
|
|
15936
16834
|
</details>
|
|
15937
16835
|
|
|
15938
|
-
<details><summary><code>client.shipping.
|
|
16836
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15939
16837
|
<dl>
|
|
15940
16838
|
<dd>
|
|
15941
16839
|
|
|
@@ -15947,7 +16845,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
15947
16845
|
<dl>
|
|
15948
16846
|
<dd>
|
|
15949
16847
|
|
|
15950
|
-
|
|
16848
|
+
Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
15951
16849
|
|
|
15952
16850
|
</dd>
|
|
15953
16851
|
</dl>
|
|
@@ -15963,7 +16861,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
15963
16861
|
<dd>
|
|
15964
16862
|
|
|
15965
16863
|
```typescript
|
|
15966
|
-
await client.shipping.
|
|
16864
|
+
await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
15967
16865
|
```
|
|
15968
16866
|
|
|
15969
16867
|
</dd>
|
|
@@ -15979,7 +16877,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
15979
16877
|
<dl>
|
|
15980
16878
|
<dd>
|
|
15981
16879
|
|
|
15982
|
-
**
|
|
16880
|
+
**orderScheduleId:** `string`
|
|
15983
16881
|
|
|
15984
16882
|
</dd>
|
|
15985
16883
|
</dl>
|
|
@@ -15987,7 +16885,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
15987
16885
|
<dl>
|
|
15988
16886
|
<dd>
|
|
15989
16887
|
|
|
15990
|
-
**requestOptions:** `
|
|
16888
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15991
16889
|
|
|
15992
16890
|
</dd>
|
|
15993
16891
|
</dl>
|
|
@@ -15998,7 +16896,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
15998
16896
|
</dl>
|
|
15999
16897
|
</details>
|
|
16000
16898
|
|
|
16001
|
-
<details><summary><code>client.shipping.
|
|
16899
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
16002
16900
|
<dl>
|
|
16003
16901
|
<dd>
|
|
16004
16902
|
|
|
@@ -16010,7 +16908,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
16010
16908
|
<dl>
|
|
16011
16909
|
<dd>
|
|
16012
16910
|
|
|
16013
|
-
Validates
|
|
16911
|
+
Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
16014
16912
|
|
|
16015
16913
|
</dd>
|
|
16016
16914
|
</dl>
|
|
@@ -16026,7 +16924,7 @@ Validates the draft order for staging and returns requirement results. | () -> (
|
|
|
16026
16924
|
<dd>
|
|
16027
16925
|
|
|
16028
16926
|
```typescript
|
|
16029
|
-
await client.shipping.
|
|
16927
|
+
await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
16030
16928
|
```
|
|
16031
16929
|
|
|
16032
16930
|
</dd>
|
|
@@ -16042,7 +16940,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
16042
16940
|
<dl>
|
|
16043
16941
|
<dd>
|
|
16044
16942
|
|
|
16045
|
-
**
|
|
16943
|
+
**orderScheduleId:** `string`
|
|
16046
16944
|
|
|
16047
16945
|
</dd>
|
|
16048
16946
|
</dl>
|
|
@@ -16050,7 +16948,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
16050
16948
|
<dl>
|
|
16051
16949
|
<dd>
|
|
16052
16950
|
|
|
16053
|
-
**requestOptions:** `
|
|
16951
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
16054
16952
|
|
|
16055
16953
|
</dd>
|
|
16056
16954
|
</dl>
|
|
@@ -16061,9 +16959,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
16061
16959
|
</dl>
|
|
16062
16960
|
</details>
|
|
16063
16961
|
|
|
16064
|
-
|
|
16065
|
-
|
|
16066
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderScheduleListRes</code></summary>
|
|
16962
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
16067
16963
|
<dl>
|
|
16068
16964
|
<dd>
|
|
16069
16965
|
|
|
@@ -16075,7 +16971,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
16075
16971
|
<dl>
|
|
16076
16972
|
<dd>
|
|
16077
16973
|
|
|
16078
|
-
|
|
16974
|
+
Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
16079
16975
|
|
|
16080
16976
|
</dd>
|
|
16081
16977
|
</dl>
|
|
@@ -16091,19 +16987,7 @@ Lists order schedules for the caller's organization with filtering, sorting, and
|
|
|
16091
16987
|
<dd>
|
|
16092
16988
|
|
|
16093
16989
|
```typescript
|
|
16094
|
-
await client.shipping.orderSchedules.
|
|
16095
|
-
sort_by: "created_at_timestamp",
|
|
16096
|
-
sort_order: "asc",
|
|
16097
|
-
page: 1,
|
|
16098
|
-
page_size: 1,
|
|
16099
|
-
filter_status: ["draft"],
|
|
16100
|
-
filter_orchestrator_schedule_status: ["not_created"],
|
|
16101
|
-
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16102
|
-
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16103
|
-
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16104
|
-
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16105
|
-
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16106
|
-
});
|
|
16990
|
+
await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
16107
16991
|
```
|
|
16108
16992
|
|
|
16109
16993
|
</dd>
|
|
@@ -16119,7 +17003,7 @@ await client.shipping.orderSchedules.listV1({
|
|
|
16119
17003
|
<dl>
|
|
16120
17004
|
<dd>
|
|
16121
17005
|
|
|
16122
|
-
**
|
|
17006
|
+
**orderScheduleId:** `string`
|
|
16123
17007
|
|
|
16124
17008
|
</dd>
|
|
16125
17009
|
</dl>
|
|
@@ -16138,7 +17022,7 @@ await client.shipping.orderSchedules.listV1({
|
|
|
16138
17022
|
</dl>
|
|
16139
17023
|
</details>
|
|
16140
17024
|
|
|
16141
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
17025
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
16142
17026
|
<dl>
|
|
16143
17027
|
<dd>
|
|
16144
17028
|
|
|
@@ -16150,7 +17034,7 @@ await client.shipping.orderSchedules.listV1({
|
|
|
16150
17034
|
<dl>
|
|
16151
17035
|
<dd>
|
|
16152
17036
|
|
|
16153
|
-
|
|
17037
|
+
Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
16154
17038
|
|
|
16155
17039
|
</dd>
|
|
16156
17040
|
</dl>
|
|
@@ -16166,7 +17050,7 @@ Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (Order
|
|
|
16166
17050
|
<dd>
|
|
16167
17051
|
|
|
16168
17052
|
```typescript
|
|
16169
|
-
await client.shipping.orderSchedules.
|
|
17053
|
+
await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
16170
17054
|
```
|
|
16171
17055
|
|
|
16172
17056
|
</dd>
|
|
@@ -16201,7 +17085,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
16201
17085
|
</dl>
|
|
16202
17086
|
</details>
|
|
16203
17087
|
|
|
16204
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
17088
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
16205
17089
|
<dl>
|
|
16206
17090
|
<dd>
|
|
16207
17091
|
|
|
@@ -16213,7 +17097,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
16213
17097
|
<dl>
|
|
16214
17098
|
<dd>
|
|
16215
17099
|
|
|
16216
|
-
|
|
17100
|
+
Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
|
|
16217
17101
|
|
|
16218
17102
|
</dd>
|
|
16219
17103
|
</dl>
|
|
@@ -16229,7 +17113,7 @@ Retrieves schedule metadata, generated order count, and live orchestrator status
|
|
|
16229
17113
|
<dd>
|
|
16230
17114
|
|
|
16231
17115
|
```typescript
|
|
16232
|
-
await client.shipping.orderSchedules.
|
|
17116
|
+
await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
16233
17117
|
```
|
|
16234
17118
|
|
|
16235
17119
|
</dd>
|
|
@@ -16264,7 +17148,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
16264
17148
|
</dl>
|
|
16265
17149
|
</details>
|
|
16266
17150
|
|
|
16267
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
17151
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
16268
17152
|
<dl>
|
|
16269
17153
|
<dd>
|
|
16270
17154
|
|
|
@@ -16276,7 +17160,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
16276
17160
|
<dl>
|
|
16277
17161
|
<dd>
|
|
16278
17162
|
|
|
16279
|
-
|
|
17163
|
+
Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
|
|
16280
17164
|
|
|
16281
17165
|
</dd>
|
|
16282
17166
|
</dl>
|
|
@@ -16292,12 +17176,7 @@ Creates a new draft order schedule. | authz: min_org_role=operator | (OrderSched
|
|
|
16292
17176
|
<dd>
|
|
16293
17177
|
|
|
16294
17178
|
```typescript
|
|
16295
|
-
await client.shipping.orderSchedules.
|
|
16296
|
-
schema_version: 1,
|
|
16297
|
-
name: "name",
|
|
16298
|
-
order_manifest: {},
|
|
16299
|
-
schedule_spec: {},
|
|
16300
|
-
});
|
|
17179
|
+
await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
16301
17180
|
```
|
|
16302
17181
|
|
|
16303
17182
|
</dd>
|
|
@@ -16313,7 +17192,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
16313
17192
|
<dl>
|
|
16314
17193
|
<dd>
|
|
16315
17194
|
|
|
16316
|
-
**
|
|
17195
|
+
**orderScheduleId:** `string`
|
|
16317
17196
|
|
|
16318
17197
|
</dd>
|
|
16319
17198
|
</dl>
|
|
@@ -16332,7 +17211,9 @@ await client.shipping.orderSchedules.newV1({
|
|
|
16332
17211
|
</dl>
|
|
16333
17212
|
</details>
|
|
16334
17213
|
|
|
16335
|
-
|
|
17214
|
+
## Shipping TaskGroups
|
|
17215
|
+
|
|
17216
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
16336
17217
|
<dl>
|
|
16337
17218
|
<dd>
|
|
16338
17219
|
|
|
@@ -16344,7 +17225,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
16344
17225
|
<dl>
|
|
16345
17226
|
<dd>
|
|
16346
17227
|
|
|
16347
|
-
|
|
17228
|
+
Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
16348
17229
|
|
|
16349
17230
|
</dd>
|
|
16350
17231
|
</dl>
|
|
@@ -16360,7 +17241,7 @@ Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClient
|
|
|
16360
17241
|
<dd>
|
|
16361
17242
|
|
|
16362
17243
|
```typescript
|
|
16363
|
-
await client.shipping.
|
|
17244
|
+
await client.shipping.taskGroups.startV1("task_group_id");
|
|
16364
17245
|
```
|
|
16365
17246
|
|
|
16366
17247
|
</dd>
|
|
@@ -16376,15 +17257,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
16376
17257
|
<dl>
|
|
16377
17258
|
<dd>
|
|
16378
17259
|
|
|
16379
|
-
**
|
|
16380
|
-
|
|
16381
|
-
</dd>
|
|
16382
|
-
</dl>
|
|
16383
|
-
|
|
16384
|
-
<dl>
|
|
16385
|
-
<dd>
|
|
16386
|
-
|
|
16387
|
-
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
17260
|
+
**taskGroupId:** `string`
|
|
16388
17261
|
|
|
16389
17262
|
</dd>
|
|
16390
17263
|
</dl>
|
|
@@ -16392,7 +17265,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
16392
17265
|
<dl>
|
|
16393
17266
|
<dd>
|
|
16394
17267
|
|
|
16395
|
-
**requestOptions:** `
|
|
17268
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16396
17269
|
|
|
16397
17270
|
</dd>
|
|
16398
17271
|
</dl>
|
|
@@ -16403,7 +17276,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
16403
17276
|
</dl>
|
|
16404
17277
|
</details>
|
|
16405
17278
|
|
|
16406
|
-
<details><summary><code>client.shipping.
|
|
17279
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16407
17280
|
<dl>
|
|
16408
17281
|
<dd>
|
|
16409
17282
|
|
|
@@ -16415,7 +17288,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
16415
17288
|
<dl>
|
|
16416
17289
|
<dd>
|
|
16417
17290
|
|
|
16418
|
-
|
|
17291
|
+
Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_owner_operators] | (SetTaskOrderingReq) -> (bool)
|
|
16419
17292
|
|
|
16420
17293
|
</dd>
|
|
16421
17294
|
</dl>
|
|
@@ -16431,7 +17304,9 @@ Transfers order schedule workflow ownership to the caller. | authz: min_org_role
|
|
|
16431
17304
|
<dd>
|
|
16432
17305
|
|
|
16433
17306
|
```typescript
|
|
16434
|
-
await client.shipping.
|
|
17307
|
+
await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
17308
|
+
task_ids: ["task_ids"],
|
|
17309
|
+
});
|
|
16435
17310
|
```
|
|
16436
17311
|
|
|
16437
17312
|
</dd>
|
|
@@ -16447,7 +17322,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
16447
17322
|
<dl>
|
|
16448
17323
|
<dd>
|
|
16449
17324
|
|
|
16450
|
-
**
|
|
17325
|
+
**taskGroupId:** `string`
|
|
16451
17326
|
|
|
16452
17327
|
</dd>
|
|
16453
17328
|
</dl>
|
|
@@ -16455,7 +17330,15 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
16455
17330
|
<dl>
|
|
16456
17331
|
<dd>
|
|
16457
17332
|
|
|
16458
|
-
**
|
|
17333
|
+
**request:** `Chrt.shipping.SetTaskOrderingReq`
|
|
17334
|
+
|
|
17335
|
+
</dd>
|
|
17336
|
+
</dl>
|
|
17337
|
+
|
|
17338
|
+
<dl>
|
|
17339
|
+
<dd>
|
|
17340
|
+
|
|
17341
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16459
17342
|
|
|
16460
17343
|
</dd>
|
|
16461
17344
|
</dl>
|
|
@@ -16466,7 +17349,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
16466
17349
|
</dl>
|
|
16467
17350
|
</details>
|
|
16468
17351
|
|
|
16469
|
-
<details><summary><code>client.shipping.
|
|
17352
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16470
17353
|
<dl>
|
|
16471
17354
|
<dd>
|
|
16472
17355
|
|
|
@@ -16478,7 +17361,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
16478
17361
|
<dl>
|
|
16479
17362
|
<dd>
|
|
16480
17363
|
|
|
16481
|
-
|
|
17364
|
+
Assigns or swaps the driver on a task group. Driver must belong to the task group's executor organization. | authz_personas=[executor_org_operators] | (UpdateDriverReq) -> (bool)
|
|
16482
17365
|
|
|
16483
17366
|
</dd>
|
|
16484
17367
|
</dl>
|
|
@@ -16494,7 +17377,9 @@ Validates a draft order schedule, creates its Temporal orchestrator schedule, an
|
|
|
16494
17377
|
<dd>
|
|
16495
17378
|
|
|
16496
17379
|
```typescript
|
|
16497
|
-
await client.shipping.
|
|
17380
|
+
await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
17381
|
+
driver_id: "driver_id",
|
|
17382
|
+
});
|
|
16498
17383
|
```
|
|
16499
17384
|
|
|
16500
17385
|
</dd>
|
|
@@ -16510,7 +17395,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
16510
17395
|
<dl>
|
|
16511
17396
|
<dd>
|
|
16512
17397
|
|
|
16513
|
-
**
|
|
17398
|
+
**taskGroupId:** `string`
|
|
16514
17399
|
|
|
16515
17400
|
</dd>
|
|
16516
17401
|
</dl>
|
|
@@ -16518,7 +17403,15 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
16518
17403
|
<dl>
|
|
16519
17404
|
<dd>
|
|
16520
17405
|
|
|
16521
|
-
**
|
|
17406
|
+
**request:** `Chrt.shipping.UpdateDriverReq`
|
|
17407
|
+
|
|
17408
|
+
</dd>
|
|
17409
|
+
</dl>
|
|
17410
|
+
|
|
17411
|
+
<dl>
|
|
17412
|
+
<dd>
|
|
17413
|
+
|
|
17414
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16522
17415
|
|
|
16523
17416
|
</dd>
|
|
16524
17417
|
</dl>
|
|
@@ -16529,7 +17422,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
16529
17422
|
</dl>
|
|
16530
17423
|
</details>
|
|
16531
17424
|
|
|
16532
|
-
<details><summary><code>client.shipping.
|
|
17425
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeDriverV1</a>(taskGroupId) -> boolean</code></summary>
|
|
16533
17426
|
<dl>
|
|
16534
17427
|
<dd>
|
|
16535
17428
|
|
|
@@ -16541,7 +17434,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
16541
17434
|
<dl>
|
|
16542
17435
|
<dd>
|
|
16543
17436
|
|
|
16544
|
-
|
|
17437
|
+
Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
|
|
16545
17438
|
|
|
16546
17439
|
</dd>
|
|
16547
17440
|
</dl>
|
|
@@ -16557,7 +17450,7 @@ Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
16557
17450
|
<dd>
|
|
16558
17451
|
|
|
16559
17452
|
```typescript
|
|
16560
|
-
await client.shipping.
|
|
17453
|
+
await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
16561
17454
|
```
|
|
16562
17455
|
|
|
16563
17456
|
</dd>
|
|
@@ -16573,7 +17466,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
16573
17466
|
<dl>
|
|
16574
17467
|
<dd>
|
|
16575
17468
|
|
|
16576
|
-
**
|
|
17469
|
+
**taskGroupId:** `string`
|
|
16577
17470
|
|
|
16578
17471
|
</dd>
|
|
16579
17472
|
</dl>
|
|
@@ -16581,7 +17474,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
16581
17474
|
<dl>
|
|
16582
17475
|
<dd>
|
|
16583
17476
|
|
|
16584
|
-
**requestOptions:** `
|
|
17477
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16585
17478
|
|
|
16586
17479
|
</dd>
|
|
16587
17480
|
</dl>
|
|
@@ -16592,7 +17485,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
16592
17485
|
</dl>
|
|
16593
17486
|
</details>
|
|
16594
17487
|
|
|
16595
|
-
<details><summary><code>client.shipping.
|
|
17488
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addExecutorV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16596
17489
|
<dl>
|
|
16597
17490
|
<dd>
|
|
16598
17491
|
|
|
@@ -16604,7 +17497,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
16604
17497
|
<dl>
|
|
16605
17498
|
<dd>
|
|
16606
17499
|
|
|
16607
|
-
|
|
17500
|
+
Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordinator-only. Requires both executor_org_id and off_chrt_executor_org_id to be None (use remove_executor/v1 first to swap). | authz_personas=[coordinator_org_operators] | (AddExecutorReq) -> (bool)
|
|
16608
17501
|
|
|
16609
17502
|
</dd>
|
|
16610
17503
|
</dl>
|
|
@@ -16620,7 +17513,7 @@ Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
16620
17513
|
<dd>
|
|
16621
17514
|
|
|
16622
17515
|
```typescript
|
|
16623
|
-
await client.shipping.
|
|
17516
|
+
await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
16624
17517
|
```
|
|
16625
17518
|
|
|
16626
17519
|
</dd>
|
|
@@ -16636,7 +17529,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
16636
17529
|
<dl>
|
|
16637
17530
|
<dd>
|
|
16638
17531
|
|
|
16639
|
-
**
|
|
17532
|
+
**taskGroupId:** `string`
|
|
16640
17533
|
|
|
16641
17534
|
</dd>
|
|
16642
17535
|
</dl>
|
|
@@ -16644,7 +17537,15 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
16644
17537
|
<dl>
|
|
16645
17538
|
<dd>
|
|
16646
17539
|
|
|
16647
|
-
**
|
|
17540
|
+
**request:** `Chrt.shipping.AddExecutorReq`
|
|
17541
|
+
|
|
17542
|
+
</dd>
|
|
17543
|
+
</dl>
|
|
17544
|
+
|
|
17545
|
+
<dl>
|
|
17546
|
+
<dd>
|
|
17547
|
+
|
|
17548
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16648
17549
|
|
|
16649
17550
|
</dd>
|
|
16650
17551
|
</dl>
|
|
@@ -16655,7 +17556,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
16655
17556
|
</dl>
|
|
16656
17557
|
</details>
|
|
16657
17558
|
|
|
16658
|
-
<details><summary><code>client.shipping.
|
|
17559
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeExecutorV1</a>(taskGroupId) -> boolean</code></summary>
|
|
16659
17560
|
<dl>
|
|
16660
17561
|
<dd>
|
|
16661
17562
|
|
|
@@ -16667,7 +17568,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
16667
17568
|
<dl>
|
|
16668
17569
|
<dd>
|
|
16669
17570
|
|
|
16670
|
-
|
|
17571
|
+
Clears the executor on a task group along with the assigned driver and all PPP/PPD billing attachments, returning the TG to executor-less state. Coordinator-only. PPP/PPD LineItemGroup1 and BillingLedgerPeriod1 documents stay alive (orphaned-but-alive); the (ex-)executor disposes of them via their own routes. SPP is unaffected. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
16671
17572
|
|
|
16672
17573
|
</dd>
|
|
16673
17574
|
</dl>
|
|
@@ -16683,7 +17584,7 @@ Archives an order schedule and prevents future runs. | authz: min_org_role=opera
|
|
|
16683
17584
|
<dd>
|
|
16684
17585
|
|
|
16685
17586
|
```typescript
|
|
16686
|
-
await client.shipping.
|
|
17587
|
+
await client.shipping.taskGroups.removeExecutorV1("task_group_id");
|
|
16687
17588
|
```
|
|
16688
17589
|
|
|
16689
17590
|
</dd>
|
|
@@ -16699,7 +17600,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
16699
17600
|
<dl>
|
|
16700
17601
|
<dd>
|
|
16701
17602
|
|
|
16702
|
-
**
|
|
17603
|
+
**taskGroupId:** `string`
|
|
16703
17604
|
|
|
16704
17605
|
</dd>
|
|
16705
17606
|
</dl>
|
|
@@ -16707,7 +17608,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
16707
17608
|
<dl>
|
|
16708
17609
|
<dd>
|
|
16709
17610
|
|
|
16710
|
-
**requestOptions:** `
|
|
17611
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16711
17612
|
|
|
16712
17613
|
</dd>
|
|
16713
17614
|
</dl>
|
|
@@ -16718,7 +17619,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
16718
17619
|
</dl>
|
|
16719
17620
|
</details>
|
|
16720
17621
|
|
|
16721
|
-
<details><summary><code>client.shipping.
|
|
17622
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16722
17623
|
<dl>
|
|
16723
17624
|
<dd>
|
|
16724
17625
|
|
|
@@ -16730,7 +17631,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
16730
17631
|
<dl>
|
|
16731
17632
|
<dd>
|
|
16732
17633
|
|
|
16733
|
-
|
|
17634
|
+
Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
|
|
16734
17635
|
|
|
16735
17636
|
</dd>
|
|
16736
17637
|
</dl>
|
|
@@ -16746,7 +17647,7 @@ Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (
|
|
|
16746
17647
|
<dd>
|
|
16747
17648
|
|
|
16748
17649
|
```typescript
|
|
16749
|
-
await client.shipping.
|
|
17650
|
+
await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
16750
17651
|
```
|
|
16751
17652
|
|
|
16752
17653
|
</dd>
|
|
@@ -16762,7 +17663,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
16762
17663
|
<dl>
|
|
16763
17664
|
<dd>
|
|
16764
17665
|
|
|
16765
|
-
**
|
|
17666
|
+
**taskGroupId:** `string`
|
|
16766
17667
|
|
|
16767
17668
|
</dd>
|
|
16768
17669
|
</dl>
|
|
@@ -16770,7 +17671,15 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
16770
17671
|
<dl>
|
|
16771
17672
|
<dd>
|
|
16772
17673
|
|
|
16773
|
-
**
|
|
17674
|
+
**request:** `Chrt.SetFlightInfoReq`
|
|
17675
|
+
|
|
17676
|
+
</dd>
|
|
17677
|
+
</dl>
|
|
17678
|
+
|
|
17679
|
+
<dl>
|
|
17680
|
+
<dd>
|
|
17681
|
+
|
|
17682
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16774
17683
|
|
|
16775
17684
|
</dd>
|
|
16776
17685
|
</dl>
|
|
@@ -16781,9 +17690,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
16781
17690
|
</dl>
|
|
16782
17691
|
</details>
|
|
16783
17692
|
|
|
16784
|
-
|
|
16785
|
-
|
|
16786
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
17693
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addMessageV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16787
17694
|
<dl>
|
|
16788
17695
|
<dd>
|
|
16789
17696
|
|
|
@@ -16795,7 +17702,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
16795
17702
|
<dl>
|
|
16796
17703
|
<dd>
|
|
16797
17704
|
|
|
16798
|
-
|
|
17705
|
+
Adds a message to a task group's message log. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
|
|
16799
17706
|
|
|
16800
17707
|
</dd>
|
|
16801
17708
|
</dl>
|
|
@@ -16811,7 +17718,9 @@ Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing r
|
|
|
16811
17718
|
<dd>
|
|
16812
17719
|
|
|
16813
17720
|
```typescript
|
|
16814
|
-
await client.shipping.taskGroups.
|
|
17721
|
+
await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
17722
|
+
message: "message",
|
|
17723
|
+
});
|
|
16815
17724
|
```
|
|
16816
17725
|
|
|
16817
17726
|
</dd>
|
|
@@ -16835,6 +17744,14 @@ await client.shipping.taskGroups.startV1("task_group_id");
|
|
|
16835
17744
|
<dl>
|
|
16836
17745
|
<dd>
|
|
16837
17746
|
|
|
17747
|
+
**request:** `Chrt.shipping.AddMessageReq`
|
|
17748
|
+
|
|
17749
|
+
</dd>
|
|
17750
|
+
</dl>
|
|
17751
|
+
|
|
17752
|
+
<dl>
|
|
17753
|
+
<dd>
|
|
17754
|
+
|
|
16838
17755
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16839
17756
|
|
|
16840
17757
|
</dd>
|
|
@@ -16846,7 +17763,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
|
|
|
16846
17763
|
</dl>
|
|
16847
17764
|
</details>
|
|
16848
17765
|
|
|
16849
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
17766
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToShipperPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
|
|
16850
17767
|
<dl>
|
|
16851
17768
|
<dd>
|
|
16852
17769
|
|
|
@@ -16858,7 +17775,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
|
|
|
16858
17775
|
<dl>
|
|
16859
17776
|
<dd>
|
|
16860
17777
|
|
|
16861
|
-
|
|
17778
|
+
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector. Period parties must match the TG's SPP parties. The SPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
|
|
16862
17779
|
|
|
16863
17780
|
</dd>
|
|
16864
17781
|
</dl>
|
|
@@ -16874,8 +17791,8 @@ Sets the ordering of tasks within a task group. Requires complete list of task I
|
|
|
16874
17791
|
<dd>
|
|
16875
17792
|
|
|
16876
17793
|
```typescript
|
|
16877
|
-
await client.shipping.taskGroups.
|
|
16878
|
-
|
|
17794
|
+
await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1("task_group_id", {
|
|
17795
|
+
billing_ledger_period_id: "billing_ledger_period_id",
|
|
16879
17796
|
});
|
|
16880
17797
|
```
|
|
16881
17798
|
|
|
@@ -16900,7 +17817,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
16900
17817
|
<dl>
|
|
16901
17818
|
<dd>
|
|
16902
17819
|
|
|
16903
|
-
**request:** `Chrt.
|
|
17820
|
+
**request:** `Chrt.AttachBillingLedgerPeriodReq`
|
|
16904
17821
|
|
|
16905
17822
|
</dd>
|
|
16906
17823
|
</dl>
|
|
@@ -16919,7 +17836,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
16919
17836
|
</dl>
|
|
16920
17837
|
</details>
|
|
16921
17838
|
|
|
16922
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
17839
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToProviderPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
|
|
16923
17840
|
<dl>
|
|
16924
17841
|
<dd>
|
|
16925
17842
|
|
|
@@ -16931,7 +17848,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
16931
17848
|
<dl>
|
|
16932
17849
|
<dd>
|
|
16933
17850
|
|
|
16934
|
-
|
|
17851
|
+
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector. Period parties must match the TG's PPP parties. The PPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
|
|
16935
17852
|
|
|
16936
17853
|
</dd>
|
|
16937
17854
|
</dl>
|
|
@@ -16947,8 +17864,8 @@ Assigns or swaps the driver on a task group. Driver must belong to the task grou
|
|
|
16947
17864
|
<dd>
|
|
16948
17865
|
|
|
16949
17866
|
```typescript
|
|
16950
|
-
await client.shipping.taskGroups.
|
|
16951
|
-
|
|
17867
|
+
await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV1("task_group_id", {
|
|
17868
|
+
billing_ledger_period_id: "billing_ledger_period_id",
|
|
16952
17869
|
});
|
|
16953
17870
|
```
|
|
16954
17871
|
|
|
@@ -16973,7 +17890,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
|
16973
17890
|
<dl>
|
|
16974
17891
|
<dd>
|
|
16975
17892
|
|
|
16976
|
-
**request:** `Chrt.
|
|
17893
|
+
**request:** `Chrt.AttachBillingLedgerPeriodReq`
|
|
16977
17894
|
|
|
16978
17895
|
</dd>
|
|
16979
17896
|
</dl>
|
|
@@ -16992,7 +17909,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
|
16992
17909
|
</dl>
|
|
16993
17910
|
</details>
|
|
16994
17911
|
|
|
16995
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
17912
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToProviderPayDriverV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
|
|
16996
17913
|
<dl>
|
|
16997
17914
|
<dd>
|
|
16998
17915
|
|
|
@@ -17004,7 +17921,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
|
17004
17921
|
<dl>
|
|
17005
17922
|
<dd>
|
|
17006
17923
|
|
|
17007
|
-
|
|
17924
|
+
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector. Period parties must match the TG's PPD parties. The PPD vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
|
|
17008
17925
|
|
|
17009
17926
|
</dd>
|
|
17010
17927
|
</dl>
|
|
@@ -17020,7 +17937,9 @@ Removes the driver from a task group (sets driver_id to null). Allowed when STAG
|
|
|
17020
17937
|
<dd>
|
|
17021
17938
|
|
|
17022
17939
|
```typescript
|
|
17023
|
-
await client.shipping.taskGroups.
|
|
17940
|
+
await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1("task_group_id", {
|
|
17941
|
+
billing_ledger_period_id: "billing_ledger_period_id",
|
|
17942
|
+
});
|
|
17024
17943
|
```
|
|
17025
17944
|
|
|
17026
17945
|
</dd>
|
|
@@ -17044,6 +17963,14 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
|
17044
17963
|
<dl>
|
|
17045
17964
|
<dd>
|
|
17046
17965
|
|
|
17966
|
+
**request:** `Chrt.AttachBillingLedgerPeriodReq`
|
|
17967
|
+
|
|
17968
|
+
</dd>
|
|
17969
|
+
</dl>
|
|
17970
|
+
|
|
17971
|
+
<dl>
|
|
17972
|
+
<dd>
|
|
17973
|
+
|
|
17047
17974
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
17048
17975
|
|
|
17049
17976
|
</dd>
|
|
@@ -17055,7 +17982,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
|
17055
17982
|
</dl>
|
|
17056
17983
|
</details>
|
|
17057
17984
|
|
|
17058
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
17985
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromShipperPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
|
|
17059
17986
|
<dl>
|
|
17060
17987
|
<dd>
|
|
17061
17988
|
|
|
@@ -17067,7 +17994,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
|
17067
17994
|
<dl>
|
|
17068
17995
|
<dd>
|
|
17069
17996
|
|
|
17070
|
-
|
|
17997
|
+
Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_shipper_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
17071
17998
|
|
|
17072
17999
|
</dd>
|
|
17073
18000
|
</dl>
|
|
@@ -17083,7 +18010,7 @@ Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordina
|
|
|
17083
18010
|
<dd>
|
|
17084
18011
|
|
|
17085
18012
|
```typescript
|
|
17086
|
-
await client.shipping.taskGroups.
|
|
18013
|
+
await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProviderV1("task_group_id");
|
|
17087
18014
|
```
|
|
17088
18015
|
|
|
17089
18016
|
</dd>
|
|
@@ -17107,14 +18034,6 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
17107
18034
|
<dl>
|
|
17108
18035
|
<dd>
|
|
17109
18036
|
|
|
17110
|
-
**request:** `Chrt.shipping.AddExecutorReq`
|
|
17111
|
-
|
|
17112
|
-
</dd>
|
|
17113
|
-
</dl>
|
|
17114
|
-
|
|
17115
|
-
<dl>
|
|
17116
|
-
<dd>
|
|
17117
|
-
|
|
17118
18037
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
17119
18038
|
|
|
17120
18039
|
</dd>
|
|
@@ -17126,7 +18045,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
17126
18045
|
</dl>
|
|
17127
18046
|
</details>
|
|
17128
18047
|
|
|
17129
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18048
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromProviderPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
|
|
17130
18049
|
<dl>
|
|
17131
18050
|
<dd>
|
|
17132
18051
|
|
|
@@ -17138,7 +18057,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
17138
18057
|
<dl>
|
|
17139
18058
|
<dd>
|
|
17140
18059
|
|
|
17141
|
-
|
|
18060
|
+
Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
17142
18061
|
|
|
17143
18062
|
</dd>
|
|
17144
18063
|
</dl>
|
|
@@ -17154,7 +18073,7 @@ Clears the executor on a task group along with the assigned driver and all PPP/P
|
|
|
17154
18073
|
<dd>
|
|
17155
18074
|
|
|
17156
18075
|
```typescript
|
|
17157
|
-
await client.shipping.taskGroups.
|
|
18076
|
+
await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProviderV1("task_group_id");
|
|
17158
18077
|
```
|
|
17159
18078
|
|
|
17160
18079
|
</dd>
|
|
@@ -17189,7 +18108,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
|
|
|
17189
18108
|
</dl>
|
|
17190
18109
|
</details>
|
|
17191
18110
|
|
|
17192
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18111
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromProviderPayDriverV1</a>(taskGroupId) -> boolean</code></summary>
|
|
17193
18112
|
<dl>
|
|
17194
18113
|
<dd>
|
|
17195
18114
|
|
|
@@ -17201,7 +18120,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
|
|
|
17201
18120
|
<dl>
|
|
17202
18121
|
<dd>
|
|
17203
18122
|
|
|
17204
|
-
|
|
18123
|
+
Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_driver/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
|
|
17205
18124
|
|
|
17206
18125
|
</dd>
|
|
17207
18126
|
</dl>
|
|
@@ -17217,7 +18136,7 @@ Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[l
|
|
|
17217
18136
|
<dd>
|
|
17218
18137
|
|
|
17219
18138
|
```typescript
|
|
17220
|
-
await client.shipping.taskGroups.
|
|
18139
|
+
await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV1("task_group_id");
|
|
17221
18140
|
```
|
|
17222
18141
|
|
|
17223
18142
|
</dd>
|
|
@@ -17241,14 +18160,6 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
|
17241
18160
|
<dl>
|
|
17242
18161
|
<dd>
|
|
17243
18162
|
|
|
17244
|
-
**request:** `Chrt.SetFlightInfoReq`
|
|
17245
|
-
|
|
17246
|
-
</dd>
|
|
17247
|
-
</dl>
|
|
17248
|
-
|
|
17249
|
-
<dl>
|
|
17250
|
-
<dd>
|
|
17251
|
-
|
|
17252
18163
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
17253
18164
|
|
|
17254
18165
|
</dd>
|
|
@@ -17260,7 +18171,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
|
17260
18171
|
</dl>
|
|
17261
18172
|
</details>
|
|
17262
18173
|
|
|
17263
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18174
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToShipperPayProviderV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
17264
18175
|
<dl>
|
|
17265
18176
|
<dd>
|
|
17266
18177
|
|
|
@@ -17272,7 +18183,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
|
17272
18183
|
<dl>
|
|
17273
18184
|
<dd>
|
|
17274
18185
|
|
|
17275
|
-
|
|
18186
|
+
Attaches a STAGED, detached LineItemGroup to the SPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to SPP. The SPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `shipper_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
|
|
17276
18187
|
|
|
17277
18188
|
</dd>
|
|
17278
18189
|
</dl>
|
|
@@ -17288,8 +18199,8 @@ Adds a message to a task group's message log. | authz_personas=[driver_for_execu
|
|
|
17288
18199
|
<dd>
|
|
17289
18200
|
|
|
17290
18201
|
```typescript
|
|
17291
|
-
await client.shipping.taskGroups.
|
|
17292
|
-
|
|
18202
|
+
await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id", {
|
|
18203
|
+
line_item_group_id: "line_item_group_id",
|
|
17293
18204
|
});
|
|
17294
18205
|
```
|
|
17295
18206
|
|
|
@@ -17314,7 +18225,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
|
17314
18225
|
<dl>
|
|
17315
18226
|
<dd>
|
|
17316
18227
|
|
|
17317
|
-
**request:** `Chrt.
|
|
18228
|
+
**request:** `Chrt.AttachLigToVectorClientReq`
|
|
17318
18229
|
|
|
17319
18230
|
</dd>
|
|
17320
18231
|
</dl>
|
|
@@ -17333,7 +18244,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
|
17333
18244
|
</dl>
|
|
17334
18245
|
</details>
|
|
17335
18246
|
|
|
17336
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18247
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToProviderPayProviderV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
17337
18248
|
<dl>
|
|
17338
18249
|
<dd>
|
|
17339
18250
|
|
|
@@ -17345,7 +18256,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
|
17345
18256
|
<dl>
|
|
17346
18257
|
<dd>
|
|
17347
18258
|
|
|
17348
|
-
|
|
18259
|
+
Attaches a STAGED, detached LineItemGroup to the PPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to PPP. The PPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
|
|
17349
18260
|
|
|
17350
18261
|
</dd>
|
|
17351
18262
|
</dl>
|
|
@@ -17361,8 +18272,8 @@ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vec
|
|
|
17361
18272
|
<dd>
|
|
17362
18273
|
|
|
17363
18274
|
```typescript
|
|
17364
|
-
await client.shipping.taskGroups.
|
|
17365
|
-
|
|
18275
|
+
await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id", {
|
|
18276
|
+
line_item_group_id: "line_item_group_id",
|
|
17366
18277
|
});
|
|
17367
18278
|
```
|
|
17368
18279
|
|
|
@@ -17387,7 +18298,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1
|
|
|
17387
18298
|
<dl>
|
|
17388
18299
|
<dd>
|
|
17389
18300
|
|
|
17390
|
-
**request:** `Chrt.
|
|
18301
|
+
**request:** `Chrt.AttachLigToVectorClientReq`
|
|
17391
18302
|
|
|
17392
18303
|
</dd>
|
|
17393
18304
|
</dl>
|
|
@@ -17406,7 +18317,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1
|
|
|
17406
18317
|
</dl>
|
|
17407
18318
|
</details>
|
|
17408
18319
|
|
|
17409
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18320
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToProviderPayDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
17410
18321
|
<dl>
|
|
17411
18322
|
<dd>
|
|
17412
18323
|
|
|
@@ -17418,7 +18329,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1
|
|
|
17418
18329
|
<dl>
|
|
17419
18330
|
<dd>
|
|
17420
18331
|
|
|
17421
|
-
|
|
18332
|
+
Attaches a STAGED, detached LineItemGroup to the PPD vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the executor, and be party-matched to PPD. The PPD vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_driver_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachLigToVectorClientReq) -> (bool)
|
|
17422
18333
|
|
|
17423
18334
|
</dd>
|
|
17424
18335
|
</dl>
|
|
@@ -17434,8 +18345,8 @@ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vec
|
|
|
17434
18345
|
<dd>
|
|
17435
18346
|
|
|
17436
18347
|
```typescript
|
|
17437
|
-
await client.shipping.taskGroups.
|
|
17438
|
-
|
|
18348
|
+
await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id", {
|
|
18349
|
+
line_item_group_id: "line_item_group_id",
|
|
17439
18350
|
});
|
|
17440
18351
|
```
|
|
17441
18352
|
|
|
@@ -17460,7 +18371,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV
|
|
|
17460
18371
|
<dl>
|
|
17461
18372
|
<dd>
|
|
17462
18373
|
|
|
17463
|
-
**request:** `Chrt.
|
|
18374
|
+
**request:** `Chrt.AttachLigToVectorClientReq`
|
|
17464
18375
|
|
|
17465
18376
|
</dd>
|
|
17466
18377
|
</dl>
|
|
@@ -17479,7 +18390,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV
|
|
|
17479
18390
|
</dl>
|
|
17480
18391
|
</details>
|
|
17481
18392
|
|
|
17482
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18393
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromShipperPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
|
|
17483
18394
|
<dl>
|
|
17484
18395
|
<dd>
|
|
17485
18396
|
|
|
@@ -17491,7 +18402,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV
|
|
|
17491
18402
|
<dl>
|
|
17492
18403
|
<dd>
|
|
17493
18404
|
|
|
17494
|
-
|
|
18405
|
+
Clears the SPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The SPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
17495
18406
|
|
|
17496
18407
|
</dd>
|
|
17497
18408
|
</dl>
|
|
@@ -17507,9 +18418,7 @@ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vec
|
|
|
17507
18418
|
<dd>
|
|
17508
18419
|
|
|
17509
18420
|
```typescript
|
|
17510
|
-
await client.shipping.taskGroups.
|
|
17511
|
-
billing_ledger_period_id: "billing_ledger_period_id",
|
|
17512
|
-
});
|
|
18421
|
+
await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_id");
|
|
17513
18422
|
```
|
|
17514
18423
|
|
|
17515
18424
|
</dd>
|
|
@@ -17533,14 +18442,6 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1(
|
|
|
17533
18442
|
<dl>
|
|
17534
18443
|
<dd>
|
|
17535
18444
|
|
|
17536
|
-
**request:** `Chrt.AttachBillingLedgerPeriodReq`
|
|
17537
|
-
|
|
17538
|
-
</dd>
|
|
17539
|
-
</dl>
|
|
17540
|
-
|
|
17541
|
-
<dl>
|
|
17542
|
-
<dd>
|
|
17543
|
-
|
|
17544
18445
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
17545
18446
|
|
|
17546
18447
|
</dd>
|
|
@@ -17552,7 +18453,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1(
|
|
|
17552
18453
|
</dl>
|
|
17553
18454
|
</details>
|
|
17554
18455
|
|
|
17555
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18456
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromProviderPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
|
|
17556
18457
|
<dl>
|
|
17557
18458
|
<dd>
|
|
17558
18459
|
|
|
@@ -17564,7 +18465,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1(
|
|
|
17564
18465
|
<dl>
|
|
17565
18466
|
<dd>
|
|
17566
18467
|
|
|
17567
|
-
|
|
18468
|
+
Clears the PPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
17568
18469
|
|
|
17569
18470
|
</dd>
|
|
17570
18471
|
</dl>
|
|
@@ -17580,7 +18481,7 @@ Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_bill
|
|
|
17580
18481
|
<dd>
|
|
17581
18482
|
|
|
17582
18483
|
```typescript
|
|
17583
|
-
await client.shipping.taskGroups.
|
|
18484
|
+
await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_id");
|
|
17584
18485
|
```
|
|
17585
18486
|
|
|
17586
18487
|
</dd>
|
|
@@ -17615,7 +18516,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProvider
|
|
|
17615
18516
|
</dl>
|
|
17616
18517
|
</details>
|
|
17617
18518
|
|
|
17618
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18519
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromProviderPayDriverV1</a>(taskGroupId) -> boolean</code></summary>
|
|
17619
18520
|
<dl>
|
|
17620
18521
|
<dd>
|
|
17621
18522
|
|
|
@@ -17627,7 +18528,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProvider
|
|
|
17627
18528
|
<dl>
|
|
17628
18529
|
<dd>
|
|
17629
18530
|
|
|
17630
|
-
|
|
18531
|
+
Clears the PPD vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPD vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
|
|
17631
18532
|
|
|
17632
18533
|
</dd>
|
|
17633
18534
|
</dl>
|
|
@@ -17643,7 +18544,7 @@ Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_bill
|
|
|
17643
18544
|
<dd>
|
|
17644
18545
|
|
|
17645
18546
|
```typescript
|
|
17646
|
-
await client.shipping.taskGroups.
|
|
18547
|
+
await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id");
|
|
17647
18548
|
```
|
|
17648
18549
|
|
|
17649
18550
|
</dd>
|
|
@@ -17678,7 +18579,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProvide
|
|
|
17678
18579
|
</dl>
|
|
17679
18580
|
</details>
|
|
17680
18581
|
|
|
17681
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18582
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForShipperPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
|
|
17682
18583
|
<dl>
|
|
17683
18584
|
<dd>
|
|
17684
18585
|
|
|
@@ -17690,7 +18591,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProvide
|
|
|
17690
18591
|
<dl>
|
|
17691
18592
|
<dd>
|
|
17692
18593
|
|
|
17693
|
-
|
|
18594
|
+
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
|
|
17694
18595
|
|
|
17695
18596
|
</dd>
|
|
17696
18597
|
</dl>
|
|
@@ -17706,7 +18607,7 @@ Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_bill
|
|
|
17706
18607
|
<dd>
|
|
17707
18608
|
|
|
17708
18609
|
```typescript
|
|
17709
|
-
await client.shipping.taskGroups.
|
|
18610
|
+
await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
|
|
17710
18611
|
```
|
|
17711
18612
|
|
|
17712
18613
|
</dd>
|
|
@@ -17730,6 +18631,14 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV
|
|
|
17730
18631
|
<dl>
|
|
17731
18632
|
<dd>
|
|
17732
18633
|
|
|
18634
|
+
**request:** `Chrt.shipping.TaskGroupQuoteForShipperPayProviderClientReq`
|
|
18635
|
+
|
|
18636
|
+
</dd>
|
|
18637
|
+
</dl>
|
|
18638
|
+
|
|
18639
|
+
<dl>
|
|
18640
|
+
<dd>
|
|
18641
|
+
|
|
17733
18642
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
17734
18643
|
|
|
17735
18644
|
</dd>
|
|
@@ -17741,7 +18650,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV
|
|
|
17741
18650
|
</dl>
|
|
17742
18651
|
</details>
|
|
17743
18652
|
|
|
17744
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18653
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForProviderPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
|
|
17745
18654
|
<dl>
|
|
17746
18655
|
<dd>
|
|
17747
18656
|
|
|
@@ -17753,7 +18662,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV
|
|
|
17753
18662
|
<dl>
|
|
17754
18663
|
<dd>
|
|
17755
18664
|
|
|
17756
|
-
|
|
18665
|
+
Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (coordinator -> executor). Auto-resolves the rate sheet via RateSheetMapping1 for the requested executor unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_provider/v1 then attach_lig_to_provider_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForProviderPayProviderClientReq) -> (TaskGroupQuoteResp)
|
|
17757
18666
|
|
|
17758
18667
|
</dd>
|
|
17759
18668
|
</dl>
|
|
@@ -17769,9 +18678,7 @@ Attaches a STAGED, detached LineItemGroup to the SPP vector AND sets `LineItemGr
|
|
|
17769
18678
|
<dd>
|
|
17770
18679
|
|
|
17771
18680
|
```typescript
|
|
17772
|
-
await client.shipping.taskGroups.
|
|
17773
|
-
line_item_group_id: "line_item_group_id",
|
|
17774
|
-
});
|
|
18681
|
+
await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
|
|
17775
18682
|
```
|
|
17776
18683
|
|
|
17777
18684
|
</dd>
|
|
@@ -17795,7 +18702,7 @@ await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id"
|
|
|
17795
18702
|
<dl>
|
|
17796
18703
|
<dd>
|
|
17797
18704
|
|
|
17798
|
-
**request:** `Chrt.
|
|
18705
|
+
**request:** `Chrt.shipping.TaskGroupQuoteForProviderPayProviderClientReq`
|
|
17799
18706
|
|
|
17800
18707
|
</dd>
|
|
17801
18708
|
</dl>
|
|
@@ -17814,7 +18721,7 @@ await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id"
|
|
|
17814
18721
|
</dl>
|
|
17815
18722
|
</details>
|
|
17816
18723
|
|
|
17817
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
18724
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForProviderPayDriverV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
|
|
17818
18725
|
<dl>
|
|
17819
18726
|
<dd>
|
|
17820
18727
|
|
|
@@ -17826,7 +18733,7 @@ await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id"
|
|
|
17826
18733
|
<dl>
|
|
17827
18734
|
<dd>
|
|
17828
18735
|
|
|
17829
|
-
|
|
18736
|
+
Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only — TGs with an off-chrt executor are 400'd. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)
|
|
17830
18737
|
|
|
17831
18738
|
</dd>
|
|
17832
18739
|
</dl>
|
|
@@ -17842,8 +18749,8 @@ Attaches a STAGED, detached LineItemGroup to the PPP vector AND sets `LineItemGr
|
|
|
17842
18749
|
<dd>
|
|
17843
18750
|
|
|
17844
18751
|
```typescript
|
|
17845
|
-
await client.shipping.taskGroups.
|
|
17846
|
-
|
|
18752
|
+
await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
|
|
18753
|
+
driver_id: "driver_id",
|
|
17847
18754
|
});
|
|
17848
18755
|
```
|
|
17849
18756
|
|
|
@@ -17868,7 +18775,7 @@ await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id
|
|
|
17868
18775
|
<dl>
|
|
17869
18776
|
<dd>
|
|
17870
18777
|
|
|
17871
|
-
**request:** `Chrt.
|
|
18778
|
+
**request:** `Chrt.shipping.TaskGroupQuoteForProviderPayDriverClientReq`
|
|
17872
18779
|
|
|
17873
18780
|
</dd>
|
|
17874
18781
|
</dl>
|
|
@@ -17887,7 +18794,9 @@ await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id
|
|
|
17887
18794
|
</dl>
|
|
17888
18795
|
</details>
|
|
17889
18796
|
|
|
17890
|
-
|
|
18797
|
+
## Shipping Tasks
|
|
18798
|
+
|
|
18799
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
|
|
17891
18800
|
<dl>
|
|
17892
18801
|
<dd>
|
|
17893
18802
|
|
|
@@ -17899,7 +18808,7 @@ await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id
|
|
|
17899
18808
|
<dl>
|
|
17900
18809
|
<dd>
|
|
17901
18810
|
|
|
17902
|
-
|
|
18811
|
+
Adds a new task to a task group at a specific index. | authz_personas=[lig_owner_operators] | (AddTaskToGroupReq) -> (PydanticObjectId)
|
|
17903
18812
|
|
|
17904
18813
|
</dd>
|
|
17905
18814
|
</dl>
|
|
@@ -17915,8 +18824,12 @@ Attaches a STAGED, detached LineItemGroup to the PPD vector AND sets `LineItemGr
|
|
|
17915
18824
|
<dd>
|
|
17916
18825
|
|
|
17917
18826
|
```typescript
|
|
17918
|
-
await client.shipping.
|
|
17919
|
-
|
|
18827
|
+
await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
|
|
18828
|
+
task: {
|
|
18829
|
+
schema_version: 1,
|
|
18830
|
+
},
|
|
18831
|
+
status: "draft",
|
|
18832
|
+
index: 1,
|
|
17920
18833
|
});
|
|
17921
18834
|
```
|
|
17922
18835
|
|
|
@@ -17941,7 +18854,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
|
|
|
17941
18854
|
<dl>
|
|
17942
18855
|
<dd>
|
|
17943
18856
|
|
|
17944
|
-
**request:** `Chrt.
|
|
18857
|
+
**request:** `Chrt.shipping.AddTaskToGroupReq`
|
|
17945
18858
|
|
|
17946
18859
|
</dd>
|
|
17947
18860
|
</dl>
|
|
@@ -17949,7 +18862,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
|
|
|
17949
18862
|
<dl>
|
|
17950
18863
|
<dd>
|
|
17951
18864
|
|
|
17952
|
-
**requestOptions:** `
|
|
18865
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
17953
18866
|
|
|
17954
18867
|
</dd>
|
|
17955
18868
|
</dl>
|
|
@@ -17960,7 +18873,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
|
|
|
17960
18873
|
</dl>
|
|
17961
18874
|
</details>
|
|
17962
18875
|
|
|
17963
|
-
<details><summary><code>client.shipping.
|
|
18876
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">updateV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
17964
18877
|
<dl>
|
|
17965
18878
|
<dd>
|
|
17966
18879
|
|
|
@@ -17972,7 +18885,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
|
|
|
17972
18885
|
<dl>
|
|
17973
18886
|
<dd>
|
|
17974
18887
|
|
|
17975
|
-
|
|
18888
|
+
Updates a task. Operational fields (location, action, datetime_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). directory_entry_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
|
|
17976
18889
|
|
|
17977
18890
|
</dd>
|
|
17978
18891
|
</dl>
|
|
@@ -17988,7 +18901,7 @@ Clears the SPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears th
|
|
|
17988
18901
|
<dd>
|
|
17989
18902
|
|
|
17990
18903
|
```typescript
|
|
17991
|
-
await client.shipping.
|
|
18904
|
+
await client.shipping.tasks.updateV1("task_id", {});
|
|
17992
18905
|
```
|
|
17993
18906
|
|
|
17994
18907
|
</dd>
|
|
@@ -18004,7 +18917,7 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
|
|
|
18004
18917
|
<dl>
|
|
18005
18918
|
<dd>
|
|
18006
18919
|
|
|
18007
|
-
**
|
|
18920
|
+
**taskId:** `string`
|
|
18008
18921
|
|
|
18009
18922
|
</dd>
|
|
18010
18923
|
</dl>
|
|
@@ -18012,7 +18925,15 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
|
|
|
18012
18925
|
<dl>
|
|
18013
18926
|
<dd>
|
|
18014
18927
|
|
|
18015
|
-
**
|
|
18928
|
+
**request:** `Chrt.TaskClientUpdate1`
|
|
18929
|
+
|
|
18930
|
+
</dd>
|
|
18931
|
+
</dl>
|
|
18932
|
+
|
|
18933
|
+
<dl>
|
|
18934
|
+
<dd>
|
|
18935
|
+
|
|
18936
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18016
18937
|
|
|
18017
18938
|
</dd>
|
|
18018
18939
|
</dl>
|
|
@@ -18023,7 +18944,7 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
|
|
|
18023
18944
|
</dl>
|
|
18024
18945
|
</details>
|
|
18025
18946
|
|
|
18026
|
-
<details><summary><code>client.shipping.
|
|
18947
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
|
|
18027
18948
|
<dl>
|
|
18028
18949
|
<dd>
|
|
18029
18950
|
|
|
@@ -18035,7 +18956,7 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
|
|
|
18035
18956
|
<dl>
|
|
18036
18957
|
<dd>
|
|
18037
18958
|
|
|
18038
|
-
|
|
18959
|
+
Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
|
|
18039
18960
|
|
|
18040
18961
|
</dd>
|
|
18041
18962
|
</dl>
|
|
@@ -18051,7 +18972,7 @@ Clears the PPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears th
|
|
|
18051
18972
|
<dd>
|
|
18052
18973
|
|
|
18053
18974
|
```typescript
|
|
18054
|
-
await client.shipping.
|
|
18975
|
+
await client.shipping.tasks.completeV1("task_id");
|
|
18055
18976
|
```
|
|
18056
18977
|
|
|
18057
18978
|
</dd>
|
|
@@ -18067,7 +18988,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
|
|
|
18067
18988
|
<dl>
|
|
18068
18989
|
<dd>
|
|
18069
18990
|
|
|
18070
|
-
**
|
|
18991
|
+
**taskId:** `string`
|
|
18071
18992
|
|
|
18072
18993
|
</dd>
|
|
18073
18994
|
</dl>
|
|
@@ -18075,7 +18996,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
|
|
|
18075
18996
|
<dl>
|
|
18076
18997
|
<dd>
|
|
18077
18998
|
|
|
18078
|
-
**requestOptions:** `
|
|
18999
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18079
19000
|
|
|
18080
19001
|
</dd>
|
|
18081
19002
|
</dl>
|
|
@@ -18086,7 +19007,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
|
|
|
18086
19007
|
</dl>
|
|
18087
19008
|
</details>
|
|
18088
19009
|
|
|
18089
|
-
<details><summary><code>client.shipping.
|
|
19010
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">skipV1</a>(taskId) -> boolean</code></summary>
|
|
18090
19011
|
<dl>
|
|
18091
19012
|
<dd>
|
|
18092
19013
|
|
|
@@ -18098,7 +19019,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
|
|
|
18098
19019
|
<dl>
|
|
18099
19020
|
<dd>
|
|
18100
19021
|
|
|
18101
|
-
|
|
19022
|
+
Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
|
|
18102
19023
|
|
|
18103
19024
|
</dd>
|
|
18104
19025
|
</dl>
|
|
@@ -18114,7 +19035,7 @@ Clears the PPD vector's `_line_item_group_id` and `_rate_sheet_id` AND clears th
|
|
|
18114
19035
|
<dd>
|
|
18115
19036
|
|
|
18116
19037
|
```typescript
|
|
18117
|
-
await client.shipping.
|
|
19038
|
+
await client.shipping.tasks.skipV1("task_id");
|
|
18118
19039
|
```
|
|
18119
19040
|
|
|
18120
19041
|
</dd>
|
|
@@ -18130,7 +19051,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
|
|
|
18130
19051
|
<dl>
|
|
18131
19052
|
<dd>
|
|
18132
19053
|
|
|
18133
|
-
**
|
|
19054
|
+
**taskId:** `string`
|
|
18134
19055
|
|
|
18135
19056
|
</dd>
|
|
18136
19057
|
</dl>
|
|
@@ -18138,7 +19059,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
|
|
|
18138
19059
|
<dl>
|
|
18139
19060
|
<dd>
|
|
18140
19061
|
|
|
18141
|
-
**requestOptions:** `
|
|
19062
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18142
19063
|
|
|
18143
19064
|
</dd>
|
|
18144
19065
|
</dl>
|
|
@@ -18149,7 +19070,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
|
|
|
18149
19070
|
</dl>
|
|
18150
19071
|
</details>
|
|
18151
19072
|
|
|
18152
|
-
<details><summary><code>client.shipping.
|
|
19073
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">attemptV1</a>(taskId) -> boolean</code></summary>
|
|
18153
19074
|
<dl>
|
|
18154
19075
|
<dd>
|
|
18155
19076
|
|
|
@@ -18161,7 +19082,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
|
|
|
18161
19082
|
<dl>
|
|
18162
19083
|
<dd>
|
|
18163
19084
|
|
|
18164
|
-
|
|
19085
|
+
Marks a task as ATTEMPT. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
|
|
18165
19086
|
|
|
18166
19087
|
</dd>
|
|
18167
19088
|
</dl>
|
|
@@ -18177,7 +19098,7 @@ Preview the LineItem materialization that would result from applying a rate shee
|
|
|
18177
19098
|
<dd>
|
|
18178
19099
|
|
|
18179
19100
|
```typescript
|
|
18180
|
-
await client.shipping.
|
|
19101
|
+
await client.shipping.tasks.attemptV1("task_id");
|
|
18181
19102
|
```
|
|
18182
19103
|
|
|
18183
19104
|
</dd>
|
|
@@ -18193,15 +19114,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
|
|
|
18193
19114
|
<dl>
|
|
18194
19115
|
<dd>
|
|
18195
19116
|
|
|
18196
|
-
**
|
|
18197
|
-
|
|
18198
|
-
</dd>
|
|
18199
|
-
</dl>
|
|
18200
|
-
|
|
18201
|
-
<dl>
|
|
18202
|
-
<dd>
|
|
18203
|
-
|
|
18204
|
-
**request:** `Chrt.shipping.TaskGroupQuoteForShipperPayProviderClientReq`
|
|
19117
|
+
**taskId:** `string`
|
|
18205
19118
|
|
|
18206
19119
|
</dd>
|
|
18207
19120
|
</dl>
|
|
@@ -18209,7 +19122,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
|
|
|
18209
19122
|
<dl>
|
|
18210
19123
|
<dd>
|
|
18211
19124
|
|
|
18212
|
-
**requestOptions:** `
|
|
19125
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18213
19126
|
|
|
18214
19127
|
</dd>
|
|
18215
19128
|
</dl>
|
|
@@ -18220,7 +19133,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
|
|
|
18220
19133
|
</dl>
|
|
18221
19134
|
</details>
|
|
18222
19135
|
|
|
18223
|
-
<details><summary><code>client.shipping.
|
|
19136
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
18224
19137
|
<dl>
|
|
18225
19138
|
<dd>
|
|
18226
19139
|
|
|
@@ -18232,7 +19145,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
|
|
|
18232
19145
|
<dl>
|
|
18233
19146
|
<dd>
|
|
18234
19147
|
|
|
18235
|
-
|
|
19148
|
+
Deletes a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
18236
19149
|
|
|
18237
19150
|
</dd>
|
|
18238
19151
|
</dl>
|
|
@@ -18248,7 +19161,7 @@ Preview the LineItem materialization that would result from applying a rate shee
|
|
|
18248
19161
|
<dd>
|
|
18249
19162
|
|
|
18250
19163
|
```typescript
|
|
18251
|
-
await client.shipping.
|
|
19164
|
+
await client.shipping.tasks.deleteV1("task_id");
|
|
18252
19165
|
```
|
|
18253
19166
|
|
|
18254
19167
|
</dd>
|
|
@@ -18264,15 +19177,7 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
|
|
|
18264
19177
|
<dl>
|
|
18265
19178
|
<dd>
|
|
18266
19179
|
|
|
18267
|
-
**
|
|
18268
|
-
|
|
18269
|
-
</dd>
|
|
18270
|
-
</dl>
|
|
18271
|
-
|
|
18272
|
-
<dl>
|
|
18273
|
-
<dd>
|
|
18274
|
-
|
|
18275
|
-
**request:** `Chrt.shipping.TaskGroupQuoteForProviderPayProviderClientReq`
|
|
19180
|
+
**taskId:** `string`
|
|
18276
19181
|
|
|
18277
19182
|
</dd>
|
|
18278
19183
|
</dl>
|
|
@@ -18280,7 +19185,7 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
|
|
|
18280
19185
|
<dl>
|
|
18281
19186
|
<dd>
|
|
18282
19187
|
|
|
18283
|
-
**requestOptions:** `
|
|
19188
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18284
19189
|
|
|
18285
19190
|
</dd>
|
|
18286
19191
|
</dl>
|
|
@@ -18291,7 +19196,9 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
|
|
|
18291
19196
|
</dl>
|
|
18292
19197
|
</details>
|
|
18293
19198
|
|
|
18294
|
-
|
|
19199
|
+
## Shipping Drivers ComplianceDocuments
|
|
19200
|
+
|
|
19201
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">listV1</a>(driverId) -> Chrt.DriverComplianceDocument1[]</code></summary>
|
|
18295
19202
|
<dl>
|
|
18296
19203
|
<dd>
|
|
18297
19204
|
|
|
@@ -18303,7 +19210,7 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
|
|
|
18303
19210
|
<dl>
|
|
18304
19211
|
<dd>
|
|
18305
19212
|
|
|
18306
|
-
|
|
19213
|
+
Lists compliance documents for one driver in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[DriverComplianceDocument1])
|
|
18307
19214
|
|
|
18308
19215
|
</dd>
|
|
18309
19216
|
</dl>
|
|
@@ -18319,9 +19226,7 @@ Preview the LineItem materialization that would result from applying a rate shee
|
|
|
18319
19226
|
<dd>
|
|
18320
19227
|
|
|
18321
19228
|
```typescript
|
|
18322
|
-
await client.shipping.
|
|
18323
|
-
driver_id: "driver_id",
|
|
18324
|
-
});
|
|
19229
|
+
await client.shipping.drivers.complianceDocuments.listV1("driver_id");
|
|
18325
19230
|
```
|
|
18326
19231
|
|
|
18327
19232
|
</dd>
|
|
@@ -18337,15 +19242,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
|
|
|
18337
19242
|
<dl>
|
|
18338
19243
|
<dd>
|
|
18339
19244
|
|
|
18340
|
-
**
|
|
18341
|
-
|
|
18342
|
-
</dd>
|
|
18343
|
-
</dl>
|
|
18344
|
-
|
|
18345
|
-
<dl>
|
|
18346
|
-
<dd>
|
|
18347
|
-
|
|
18348
|
-
**request:** `Chrt.shipping.TaskGroupQuoteForProviderPayDriverClientReq`
|
|
19245
|
+
**driverId:** `string`
|
|
18349
19246
|
|
|
18350
19247
|
</dd>
|
|
18351
19248
|
</dl>
|
|
@@ -18353,7 +19250,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
|
|
|
18353
19250
|
<dl>
|
|
18354
19251
|
<dd>
|
|
18355
19252
|
|
|
18356
|
-
**requestOptions:** `
|
|
19253
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
18357
19254
|
|
|
18358
19255
|
</dd>
|
|
18359
19256
|
</dl>
|
|
@@ -18364,9 +19261,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
|
|
|
18364
19261
|
</dl>
|
|
18365
19262
|
</details>
|
|
18366
19263
|
|
|
18367
|
-
|
|
18368
|
-
|
|
18369
|
-
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
|
|
19264
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">getV1</a>(driverComplianceDocumentId) -> Chrt.DriverComplianceDocument1</code></summary>
|
|
18370
19265
|
<dl>
|
|
18371
19266
|
<dd>
|
|
18372
19267
|
|
|
@@ -18378,7 +19273,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
|
|
|
18378
19273
|
<dl>
|
|
18379
19274
|
<dd>
|
|
18380
19275
|
|
|
18381
|
-
|
|
19276
|
+
Retrieves one driver compliance document in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverComplianceDocument1)
|
|
18382
19277
|
|
|
18383
19278
|
</dd>
|
|
18384
19279
|
</dl>
|
|
@@ -18394,13 +19289,7 @@ Adds a new task to a task group at a specific index. | authz_personas=[lig_owner
|
|
|
18394
19289
|
<dd>
|
|
18395
19290
|
|
|
18396
19291
|
```typescript
|
|
18397
|
-
await client.shipping.
|
|
18398
|
-
task: {
|
|
18399
|
-
schema_version: 1,
|
|
18400
|
-
},
|
|
18401
|
-
status: "draft",
|
|
18402
|
-
index: 1,
|
|
18403
|
-
});
|
|
19292
|
+
await client.shipping.drivers.complianceDocuments.getV1("driver_compliance_document_id");
|
|
18404
19293
|
```
|
|
18405
19294
|
|
|
18406
19295
|
</dd>
|
|
@@ -18416,15 +19305,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
|
|
|
18416
19305
|
<dl>
|
|
18417
19306
|
<dd>
|
|
18418
19307
|
|
|
18419
|
-
**
|
|
18420
|
-
|
|
18421
|
-
</dd>
|
|
18422
|
-
</dl>
|
|
18423
|
-
|
|
18424
|
-
<dl>
|
|
18425
|
-
<dd>
|
|
18426
|
-
|
|
18427
|
-
**request:** `Chrt.shipping.AddTaskToGroupReq`
|
|
19308
|
+
**driverComplianceDocumentId:** `string`
|
|
18428
19309
|
|
|
18429
19310
|
</dd>
|
|
18430
19311
|
</dl>
|
|
@@ -18432,7 +19313,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
|
|
|
18432
19313
|
<dl>
|
|
18433
19314
|
<dd>
|
|
18434
19315
|
|
|
18435
|
-
**requestOptions:** `
|
|
19316
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
18436
19317
|
|
|
18437
19318
|
</dd>
|
|
18438
19319
|
</dl>
|
|
@@ -18443,7 +19324,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
|
|
|
18443
19324
|
</dl>
|
|
18444
19325
|
</details>
|
|
18445
19326
|
|
|
18446
|
-
<details><summary><code>client.shipping.
|
|
19327
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">createV1</a>(driverId, { ...params }) -> Chrt.DriverComplianceDocument1</code></summary>
|
|
18447
19328
|
<dl>
|
|
18448
19329
|
<dd>
|
|
18449
19330
|
|
|
@@ -18455,7 +19336,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
|
|
|
18455
19336
|
<dl>
|
|
18456
19337
|
<dd>
|
|
18457
19338
|
|
|
18458
|
-
|
|
19339
|
+
Creates a compliance document record for a driver in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (DriverComplianceDocumentClientCreate1) -> (DriverComplianceDocument1)
|
|
18459
19340
|
|
|
18460
19341
|
</dd>
|
|
18461
19342
|
</dl>
|
|
@@ -18471,7 +19352,10 @@ Updates a task. Operational fields (location, action, time_windows) require STAG
|
|
|
18471
19352
|
<dd>
|
|
18472
19353
|
|
|
18473
19354
|
```typescript
|
|
18474
|
-
await client.shipping.
|
|
19355
|
+
await client.shipping.drivers.complianceDocuments.createV1("driver_id", {
|
|
19356
|
+
schema_version: 1,
|
|
19357
|
+
document_type: "drivers_license",
|
|
19358
|
+
});
|
|
18475
19359
|
```
|
|
18476
19360
|
|
|
18477
19361
|
</dd>
|
|
@@ -18487,7 +19371,7 @@ await client.shipping.tasks.updateV1("task_id", {});
|
|
|
18487
19371
|
<dl>
|
|
18488
19372
|
<dd>
|
|
18489
19373
|
|
|
18490
|
-
**
|
|
19374
|
+
**driverId:** `string`
|
|
18491
19375
|
|
|
18492
19376
|
</dd>
|
|
18493
19377
|
</dl>
|
|
@@ -18495,7 +19379,7 @@ await client.shipping.tasks.updateV1("task_id", {});
|
|
|
18495
19379
|
<dl>
|
|
18496
19380
|
<dd>
|
|
18497
19381
|
|
|
18498
|
-
**request:** `Chrt.
|
|
19382
|
+
**request:** `Chrt.shipping.drivers.DriverComplianceDocumentClientCreate1`
|
|
18499
19383
|
|
|
18500
19384
|
</dd>
|
|
18501
19385
|
</dl>
|
|
@@ -18503,7 +19387,7 @@ await client.shipping.tasks.updateV1("task_id", {});
|
|
|
18503
19387
|
<dl>
|
|
18504
19388
|
<dd>
|
|
18505
19389
|
|
|
18506
|
-
**requestOptions:** `
|
|
19390
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
18507
19391
|
|
|
18508
19392
|
</dd>
|
|
18509
19393
|
</dl>
|
|
@@ -18514,7 +19398,9 @@ await client.shipping.tasks.updateV1("task_id", {});
|
|
|
18514
19398
|
</dl>
|
|
18515
19399
|
</details>
|
|
18516
19400
|
|
|
18517
|
-
|
|
19401
|
+
## Shipping Drivers ComplianceDocuments S3Object
|
|
19402
|
+
|
|
19403
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> Chrt.DriverComplianceDocumentS3ObjectMetadata1</code></summary>
|
|
18518
19404
|
<dl>
|
|
18519
19405
|
<dd>
|
|
18520
19406
|
|
|
@@ -18526,7 +19412,7 @@ await client.shipping.tasks.updateV1("task_id", {});
|
|
|
18526
19412
|
<dl>
|
|
18527
19413
|
<dd>
|
|
18528
19414
|
|
|
18529
|
-
|
|
19415
|
+
Retrieves metadata for a driver compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (DriverComplianceDocumentS3ObjectMetadata1)
|
|
18530
19416
|
|
|
18531
19417
|
</dd>
|
|
18532
19418
|
</dl>
|
|
@@ -18542,7 +19428,9 @@ Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_or
|
|
|
18542
19428
|
<dd>
|
|
18543
19429
|
|
|
18544
19430
|
```typescript
|
|
18545
|
-
await client.shipping.
|
|
19431
|
+
await client.shipping.drivers.complianceDocuments.s3Object.getS3ObjectMetadataV1(
|
|
19432
|
+
"driver_compliance_document_s3_object_metadata_id",
|
|
19433
|
+
);
|
|
18546
19434
|
```
|
|
18547
19435
|
|
|
18548
19436
|
</dd>
|
|
@@ -18558,7 +19446,7 @@ await client.shipping.tasks.completeV1("task_id");
|
|
|
18558
19446
|
<dl>
|
|
18559
19447
|
<dd>
|
|
18560
19448
|
|
|
18561
|
-
**
|
|
19449
|
+
**driverComplianceDocumentS3ObjectMetadataId:** `string`
|
|
18562
19450
|
|
|
18563
19451
|
</dd>
|
|
18564
19452
|
</dl>
|
|
@@ -18566,7 +19454,7 @@ await client.shipping.tasks.completeV1("task_id");
|
|
|
18566
19454
|
<dl>
|
|
18567
19455
|
<dd>
|
|
18568
19456
|
|
|
18569
|
-
**requestOptions:** `
|
|
19457
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
18570
19458
|
|
|
18571
19459
|
</dd>
|
|
18572
19460
|
</dl>
|
|
@@ -18577,7 +19465,7 @@ await client.shipping.tasks.completeV1("task_id");
|
|
|
18577
19465
|
</dl>
|
|
18578
19466
|
</details>
|
|
18579
19467
|
|
|
18580
|
-
<details><summary><code>client.shipping.
|
|
19468
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">getV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
18581
19469
|
<dl>
|
|
18582
19470
|
<dd>
|
|
18583
19471
|
|
|
@@ -18589,7 +19477,7 @@ await client.shipping.tasks.completeV1("task_id");
|
|
|
18589
19477
|
<dl>
|
|
18590
19478
|
<dd>
|
|
18591
19479
|
|
|
18592
|
-
|
|
19480
|
+
Streams a driver compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
|
|
18593
19481
|
|
|
18594
19482
|
</dd>
|
|
18595
19483
|
</dl>
|
|
@@ -18605,7 +19493,7 @@ Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_
|
|
|
18605
19493
|
<dd>
|
|
18606
19494
|
|
|
18607
19495
|
```typescript
|
|
18608
|
-
await client.shipping.
|
|
19496
|
+
await client.shipping.drivers.complianceDocuments.s3Object.getV1("driver_compliance_document_s3_object_metadata_id");
|
|
18609
19497
|
```
|
|
18610
19498
|
|
|
18611
19499
|
</dd>
|
|
@@ -18621,7 +19509,7 @@ await client.shipping.tasks.skipV1("task_id");
|
|
|
18621
19509
|
<dl>
|
|
18622
19510
|
<dd>
|
|
18623
19511
|
|
|
18624
|
-
**
|
|
19512
|
+
**driverComplianceDocumentS3ObjectMetadataId:** `string`
|
|
18625
19513
|
|
|
18626
19514
|
</dd>
|
|
18627
19515
|
</dl>
|
|
@@ -18629,7 +19517,7 @@ await client.shipping.tasks.skipV1("task_id");
|
|
|
18629
19517
|
<dl>
|
|
18630
19518
|
<dd>
|
|
18631
19519
|
|
|
18632
|
-
**requestOptions:** `
|
|
19520
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
18633
19521
|
|
|
18634
19522
|
</dd>
|
|
18635
19523
|
</dl>
|
|
@@ -18640,7 +19528,7 @@ await client.shipping.tasks.skipV1("task_id");
|
|
|
18640
19528
|
</dl>
|
|
18641
19529
|
</details>
|
|
18642
19530
|
|
|
18643
|
-
<details><summary><code>client.shipping.
|
|
19531
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">addV1</a>(driverComplianceDocumentId, { ...params }) -> boolean</code></summary>
|
|
18644
19532
|
<dl>
|
|
18645
19533
|
<dd>
|
|
18646
19534
|
|
|
@@ -18652,7 +19540,7 @@ await client.shipping.tasks.skipV1("task_id");
|
|
|
18652
19540
|
<dl>
|
|
18653
19541
|
<dd>
|
|
18654
19542
|
|
|
18655
|
-
|
|
19543
|
+
Uploads a file to a driver compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)
|
|
18656
19544
|
|
|
18657
19545
|
</dd>
|
|
18658
19546
|
</dl>
|
|
@@ -18668,7 +19556,9 @@ Marks a task as ATTEMPT. | authz_personas=[driver_for_executor, coordinator_org_
|
|
|
18668
19556
|
<dd>
|
|
18669
19557
|
|
|
18670
19558
|
```typescript
|
|
18671
|
-
await client.shipping.
|
|
19559
|
+
await client.shipping.drivers.complianceDocuments.s3Object.addV1("driver_compliance_document_id", {
|
|
19560
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
19561
|
+
});
|
|
18672
19562
|
```
|
|
18673
19563
|
|
|
18674
19564
|
</dd>
|
|
@@ -18684,7 +19574,7 @@ await client.shipping.tasks.attemptV1("task_id");
|
|
|
18684
19574
|
<dl>
|
|
18685
19575
|
<dd>
|
|
18686
19576
|
|
|
18687
|
-
**
|
|
19577
|
+
**driverComplianceDocumentId:** `string`
|
|
18688
19578
|
|
|
18689
19579
|
</dd>
|
|
18690
19580
|
</dl>
|
|
@@ -18692,7 +19582,15 @@ await client.shipping.tasks.attemptV1("task_id");
|
|
|
18692
19582
|
<dl>
|
|
18693
19583
|
<dd>
|
|
18694
19584
|
|
|
18695
|
-
**
|
|
19585
|
+
**request:** `Chrt.shipping.drivers.complianceDocuments.BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost`
|
|
19586
|
+
|
|
19587
|
+
</dd>
|
|
19588
|
+
</dl>
|
|
19589
|
+
|
|
19590
|
+
<dl>
|
|
19591
|
+
<dd>
|
|
19592
|
+
|
|
19593
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
18696
19594
|
|
|
18697
19595
|
</dd>
|
|
18698
19596
|
</dl>
|
|
@@ -18703,7 +19601,7 @@ await client.shipping.tasks.attemptV1("task_id");
|
|
|
18703
19601
|
</dl>
|
|
18704
19602
|
</details>
|
|
18705
19603
|
|
|
18706
|
-
<details><summary><code>client.shipping.
|
|
19604
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">deleteV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> boolean</code></summary>
|
|
18707
19605
|
<dl>
|
|
18708
19606
|
<dd>
|
|
18709
19607
|
|
|
@@ -18715,7 +19613,7 @@ await client.shipping.tasks.attemptV1("task_id");
|
|
|
18715
19613
|
<dl>
|
|
18716
19614
|
<dd>
|
|
18717
19615
|
|
|
18718
|
-
Deletes a
|
|
19616
|
+
Deletes a driver compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)
|
|
18719
19617
|
|
|
18720
19618
|
</dd>
|
|
18721
19619
|
</dl>
|
|
@@ -18731,7 +19629,7 @@ Deletes a task. Task must be in STAGED status. | authz_personas=[lig_owner_opera
|
|
|
18731
19629
|
<dd>
|
|
18732
19630
|
|
|
18733
19631
|
```typescript
|
|
18734
|
-
await client.shipping.
|
|
19632
|
+
await client.shipping.drivers.complianceDocuments.s3Object.deleteV1("driver_compliance_document_s3_object_metadata_id");
|
|
18735
19633
|
```
|
|
18736
19634
|
|
|
18737
19635
|
</dd>
|
|
@@ -18747,7 +19645,7 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
18747
19645
|
<dl>
|
|
18748
19646
|
<dd>
|
|
18749
19647
|
|
|
18750
|
-
**
|
|
19648
|
+
**driverComplianceDocumentS3ObjectMetadataId:** `string`
|
|
18751
19649
|
|
|
18752
19650
|
</dd>
|
|
18753
19651
|
</dl>
|
|
@@ -18755,7 +19653,7 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
18755
19653
|
<dl>
|
|
18756
19654
|
<dd>
|
|
18757
19655
|
|
|
18758
|
-
**requestOptions:** `
|
|
19656
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
18759
19657
|
|
|
18760
19658
|
</dd>
|
|
18761
19659
|
</dl>
|
|
@@ -20304,7 +21202,6 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
20304
21202
|
page: 1,
|
|
20305
21203
|
page_size: 1,
|
|
20306
21204
|
search: "search",
|
|
20307
|
-
filter_status: ["draft"],
|
|
20308
21205
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20309
21206
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20310
21207
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -20391,7 +21288,6 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
20391
21288
|
page: 1,
|
|
20392
21289
|
page_size: 1,
|
|
20393
21290
|
search: "search",
|
|
20394
|
-
filter_status: ["draft"],
|
|
20395
21291
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20396
21292
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20397
21293
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -21485,7 +22381,6 @@ await client.shipping.taskGroups.expanded.listForExecutorOperatorsV1({
|
|
|
21485
22381
|
page: 1,
|
|
21486
22382
|
page_size: 1,
|
|
21487
22383
|
search: "search",
|
|
21488
|
-
filter_status: ["draft"],
|
|
21489
22384
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21490
22385
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21491
22386
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -21573,7 +22468,6 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
21573
22468
|
page: 1,
|
|
21574
22469
|
page_size: 1,
|
|
21575
22470
|
search: "search",
|
|
21576
|
-
filter_status: ["draft"],
|
|
21577
22471
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21578
22472
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21579
22473
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|