@chrt-inc/typescript-sdk 1.675.0 → 1.676.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 +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/Client.js +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/requests/BillingLedgerPeriodsListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.js +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgersListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.js +2 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.js +2 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.js +6 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.js +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.js +2 -1
- package/dist/cjs/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.ts +2 -1
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/client/Client.js +1 -0
- package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.js +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.js +3 -3
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +18 -2
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +66 -2
- package/dist/cjs/api/resources/shipping/resources/tasks/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/index.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.d.ts +50 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.js +133 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/resources/index.js +41 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +8 -8
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +6 -6
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js +3 -3
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.js +3 -3
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.js +2 -2
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.js +2 -2
- package/dist/cjs/api/types/ListingListingDriverInvitedToBidWebhookPayload.d.ts +16 -0
- package/dist/cjs/api/types/ListingListingDriverInvitedToBidWebhookPayload.js +5 -0
- package/dist/cjs/api/types/ListingListingProviderInvitedToBidWebhookPayload.d.ts +16 -0
- package/dist/cjs/api/types/ListingListingProviderInvitedToBidWebhookPayload.js +5 -0
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +5 -1
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +4 -0
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +4 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +3 -0
- package/dist/cjs/api/types/OperationsCaseGroupAssignedWebhookPayload.d.ts +16 -0
- package/dist/cjs/api/types/OperationsCaseGroupAssignedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/OperationsCaseOperatorAssignedWebhookPayload.d.ts +14 -0
- package/dist/cjs/api/types/OperationsCaseOperatorAssignedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +2 -0
- package/dist/cjs/api/types/TaskExecutorOrgNote1.d.ts +11 -0
- package/dist/cjs/api/types/TaskExecutorOrgNote1.js +5 -0
- package/dist/cjs/api/types/TaskStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskStatusEnum1.js +1 -0
- package/dist/cjs/api/types/index.d.ts +5 -0
- package/dist/cjs/api/types/index.js +5 -0
- 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 +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/Client.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/requests/BillingLedgerPeriodsListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/Client.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgersListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/statements/client/Client.mjs +2 -0
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.mjs +2 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/listings/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/listing/resources/listings/client/Client.mjs +6 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.mjs +2 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/departments/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/operations/resources/departments/client/Client.mjs +2 -1
- package/dist/esm/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.mts +2 -1
- package/dist/esm/api/resources/orgs/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/orgs/client/Client.mjs +1 -0
- package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.mjs +3 -3
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.mjs +3 -3
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +18 -2
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +66 -2
- package/dist/esm/api/resources/shipping/resources/tasks/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.d.mts +50 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.mjs +96 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/AddExecutorOrgNoteReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/executorOrgNotes/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/tasks/resources/index.mjs +2 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +8 -8
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +6 -6
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDevice/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/cargoByDriver/client/Client.mjs +2 -2
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/sessionByDevice/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.mjs +2 -2
- package/dist/esm/api/types/ListingListingDriverInvitedToBidWebhookPayload.d.mts +16 -0
- package/dist/esm/api/types/ListingListingDriverInvitedToBidWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/ListingListingProviderInvitedToBidWebhookPayload.d.mts +16 -0
- package/dist/esm/api/types/ListingListingProviderInvitedToBidWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +5 -1
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +4 -0
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +4 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +3 -0
- package/dist/esm/api/types/OperationsCaseGroupAssignedWebhookPayload.d.mts +16 -0
- package/dist/esm/api/types/OperationsCaseGroupAssignedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/OperationsCaseOperatorAssignedWebhookPayload.d.mts +14 -0
- package/dist/esm/api/types/OperationsCaseOperatorAssignedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +2 -0
- package/dist/esm/api/types/TaskExecutorOrgNote1.d.mts +11 -0
- package/dist/esm/api/types/TaskExecutorOrgNote1.mjs +4 -0
- package/dist/esm/api/types/TaskStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/index.d.mts +5 -0
- package/dist/esm/api/types/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +199 -37
package/reference.md
CHANGED
|
@@ -86,6 +86,7 @@ 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"],
|
|
89
90
|
sort_by: "first_name",
|
|
90
91
|
sort_order: "asc",
|
|
91
92
|
page: 1,
|
|
@@ -480,6 +481,7 @@ await client.billing.billingLedgers.listV1({
|
|
|
480
481
|
sort_order: "asc",
|
|
481
482
|
page: 1,
|
|
482
483
|
page_size: 1,
|
|
484
|
+
filter_status: ["active"],
|
|
483
485
|
filter_task_group_type: "chrt_ground_provider",
|
|
484
486
|
filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
485
487
|
filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -817,6 +819,7 @@ await client.billing.billingLedgerPeriods.listV1({
|
|
|
817
819
|
page_size: 1,
|
|
818
820
|
filter_billing_ledger_id: "filter_billing_ledger_id",
|
|
819
821
|
filter_owned_by_org_id: "filter_owned_by_org_id",
|
|
822
|
+
filter_status: ["open"],
|
|
820
823
|
filter_statement_id: "filter_statement_id",
|
|
821
824
|
filter_attached_to_statement: true,
|
|
822
825
|
filter_period_end_at_timestamp_before: "2024-01-15T09:30:00Z",
|
|
@@ -1224,6 +1227,7 @@ await client.billing.lineItemGroups.listV1({
|
|
|
1224
1227
|
sort_order: "asc",
|
|
1225
1228
|
page: 1,
|
|
1226
1229
|
page_size: 1,
|
|
1230
|
+
filter_status: ["staged"],
|
|
1227
1231
|
filter_task_group_id: "filter_task_group_id",
|
|
1228
1232
|
filter_order_id: "filter_order_id",
|
|
1229
1233
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -4259,6 +4263,7 @@ await client.billing.statements.listV1({
|
|
|
4259
4263
|
sort_order: "asc",
|
|
4260
4264
|
page: 1,
|
|
4261
4265
|
page_size: 1,
|
|
4266
|
+
filter_status: ["staged"],
|
|
4262
4267
|
filter_settlement_type: "stripe_connect",
|
|
4263
4268
|
filter_order_id: "filter_order_id",
|
|
4264
4269
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -4343,6 +4348,7 @@ await client.billing.statements.expandedListV1({
|
|
|
4343
4348
|
sort_order: "asc",
|
|
4344
4349
|
page: 1,
|
|
4345
4350
|
page_size: 1,
|
|
4351
|
+
filter_status: ["staged"],
|
|
4346
4352
|
filter_settlement_type: "stripe_connect",
|
|
4347
4353
|
filter_order_id: "filter_order_id",
|
|
4348
4354
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -6979,6 +6985,8 @@ await client.listing.listings.listByOrgV1({
|
|
|
6979
6985
|
sort_order: "asc",
|
|
6980
6986
|
page: 1,
|
|
6981
6987
|
page_size: 1,
|
|
6988
|
+
filter_status: ["open"],
|
|
6989
|
+
filter_type: ["dispatch"],
|
|
6982
6990
|
filter_task_group_id: "filter_task_group_id",
|
|
6983
6991
|
filter_order_id: "filter_order_id",
|
|
6984
6992
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -7055,6 +7063,8 @@ await client.listing.listings.listForProviderBidderV1({
|
|
|
7055
7063
|
sort_order: "asc",
|
|
7056
7064
|
page: 1,
|
|
7057
7065
|
page_size: 1,
|
|
7066
|
+
filter_status: ["open"],
|
|
7067
|
+
filter_type: ["dispatch"],
|
|
7058
7068
|
filter_task_group_id: "filter_task_group_id",
|
|
7059
7069
|
filter_order_id: "filter_order_id",
|
|
7060
7070
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -7131,6 +7141,8 @@ await client.listing.listings.listForDriverBidderV1({
|
|
|
7131
7141
|
sort_order: "asc",
|
|
7132
7142
|
page: 1,
|
|
7133
7143
|
page_size: 1,
|
|
7144
|
+
filter_status: ["open"],
|
|
7145
|
+
filter_type: ["dispatch"],
|
|
7134
7146
|
filter_task_group_id: "filter_task_group_id",
|
|
7135
7147
|
filter_order_id: "filter_order_id",
|
|
7136
7148
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -8724,6 +8736,7 @@ await client.listing.bidThreads.listForListingV1("listing_id", {
|
|
|
8724
8736
|
sort_order: "asc",
|
|
8725
8737
|
page: 1,
|
|
8726
8738
|
page_size: 1,
|
|
8739
|
+
filter_status: ["open"],
|
|
8727
8740
|
filter_listing_id: "filter_listing_id",
|
|
8728
8741
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
8729
8742
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -8807,6 +8820,7 @@ await client.listing.bidThreads.listForBidderV1({
|
|
|
8807
8820
|
sort_order: "asc",
|
|
8808
8821
|
page: 1,
|
|
8809
8822
|
page_size: 1,
|
|
8823
|
+
filter_status: ["open"],
|
|
8810
8824
|
filter_listing_id: "filter_listing_id",
|
|
8811
8825
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
8812
8826
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -10795,6 +10809,8 @@ await client.operations.cases.listV1({
|
|
|
10795
10809
|
sort_order: "asc",
|
|
10796
10810
|
page: 1,
|
|
10797
10811
|
page_size: 1,
|
|
10812
|
+
filter_status: ["open"],
|
|
10813
|
+
filter_department_id: ["filter_department_id"],
|
|
10798
10814
|
filter_assigned_operator_user_id: "filter_assigned_operator_user_id",
|
|
10799
10815
|
filter_needs_action: true,
|
|
10800
10816
|
filter_unassigned: true,
|
|
@@ -11627,6 +11643,7 @@ await client.operations.departments.listV1({
|
|
|
11627
11643
|
sort_order: "asc",
|
|
11628
11644
|
page: 1,
|
|
11629
11645
|
page_size: 1,
|
|
11646
|
+
filter_department: ["automotive"],
|
|
11630
11647
|
});
|
|
11631
11648
|
```
|
|
11632
11649
|
|
|
@@ -14662,6 +14679,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
14662
14679
|
```typescript
|
|
14663
14680
|
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
14664
14681
|
search: "search",
|
|
14682
|
+
filter_role: ["owner"],
|
|
14665
14683
|
filter_available_according_to_driver: true,
|
|
14666
14684
|
filter_available_according_to_operators: true,
|
|
14667
14685
|
sort_by: "first_name",
|
|
@@ -15263,7 +15281,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
15263
15281
|
<dl>
|
|
15264
15282
|
<dd>
|
|
15265
15283
|
|
|
15266
|
-
Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[
|
|
15284
|
+
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)
|
|
15267
15285
|
|
|
15268
15286
|
</dd>
|
|
15269
15287
|
</dl>
|
|
@@ -15328,7 +15346,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
15328
15346
|
<dl>
|
|
15329
15347
|
<dd>
|
|
15330
15348
|
|
|
15331
|
-
Adds a new task artifact to a task. | authz_personas=[
|
|
15349
|
+
Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
|
|
15332
15350
|
|
|
15333
15351
|
</dd>
|
|
15334
15352
|
</dl>
|
|
@@ -15405,7 +15423,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
15405
15423
|
<dl>
|
|
15406
15424
|
<dd>
|
|
15407
15425
|
|
|
15408
|
-
Marks a task artifact as COMPLETED. | authz_personas=[
|
|
15426
|
+
Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
15409
15427
|
|
|
15410
15428
|
</dd>
|
|
15411
15429
|
</dl>
|
|
@@ -15468,7 +15486,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
15468
15486
|
<dl>
|
|
15469
15487
|
<dd>
|
|
15470
15488
|
|
|
15471
|
-
Marks a task artifact as SKIPPED. | authz_personas=[
|
|
15489
|
+
Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
15472
15490
|
|
|
15473
15491
|
</dd>
|
|
15474
15492
|
</dl>
|
|
@@ -16078,6 +16096,8 @@ await client.shipping.orderSchedules.listV1({
|
|
|
16078
16096
|
sort_order: "asc",
|
|
16079
16097
|
page: 1,
|
|
16080
16098
|
page_size: 1,
|
|
16099
|
+
filter_status: ["draft"],
|
|
16100
|
+
filter_orchestrator_schedule_status: ["not_created"],
|
|
16081
16101
|
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16082
16102
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16083
16103
|
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -17252,7 +17272,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
|
17252
17272
|
<dl>
|
|
17253
17273
|
<dd>
|
|
17254
17274
|
|
|
17255
|
-
Adds a message to a task group's message log. | authz_personas=[
|
|
17275
|
+
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)
|
|
17256
17276
|
|
|
17257
17277
|
</dd>
|
|
17258
17278
|
</dl>
|
|
@@ -18506,7 +18526,7 @@ await client.shipping.tasks.updateV1("task_id", {});
|
|
|
18506
18526
|
<dl>
|
|
18507
18527
|
<dd>
|
|
18508
18528
|
|
|
18509
|
-
Marks a task as COMPLETED. | authz_personas=[
|
|
18529
|
+
Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
|
|
18510
18530
|
|
|
18511
18531
|
</dd>
|
|
18512
18532
|
</dl>
|
|
@@ -18569,7 +18589,7 @@ await client.shipping.tasks.completeV1("task_id");
|
|
|
18569
18589
|
<dl>
|
|
18570
18590
|
<dd>
|
|
18571
18591
|
|
|
18572
|
-
Marks a task as SKIPPED. | authz_personas=[
|
|
18592
|
+
Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
|
|
18573
18593
|
|
|
18574
18594
|
</dd>
|
|
18575
18595
|
</dl>
|
|
@@ -18620,6 +18640,69 @@ await client.shipping.tasks.skipV1("task_id");
|
|
|
18620
18640
|
</dl>
|
|
18621
18641
|
</details>
|
|
18622
18642
|
|
|
18643
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">attemptV1</a>(taskId) -> boolean</code></summary>
|
|
18644
|
+
<dl>
|
|
18645
|
+
<dd>
|
|
18646
|
+
|
|
18647
|
+
#### 📝 Description
|
|
18648
|
+
|
|
18649
|
+
<dl>
|
|
18650
|
+
<dd>
|
|
18651
|
+
|
|
18652
|
+
<dl>
|
|
18653
|
+
<dd>
|
|
18654
|
+
|
|
18655
|
+
Marks a task as ATTEMPT. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
|
|
18656
|
+
|
|
18657
|
+
</dd>
|
|
18658
|
+
</dl>
|
|
18659
|
+
</dd>
|
|
18660
|
+
</dl>
|
|
18661
|
+
|
|
18662
|
+
#### 🔌 Usage
|
|
18663
|
+
|
|
18664
|
+
<dl>
|
|
18665
|
+
<dd>
|
|
18666
|
+
|
|
18667
|
+
<dl>
|
|
18668
|
+
<dd>
|
|
18669
|
+
|
|
18670
|
+
```typescript
|
|
18671
|
+
await client.shipping.tasks.attemptV1("task_id");
|
|
18672
|
+
```
|
|
18673
|
+
|
|
18674
|
+
</dd>
|
|
18675
|
+
</dl>
|
|
18676
|
+
</dd>
|
|
18677
|
+
</dl>
|
|
18678
|
+
|
|
18679
|
+
#### ⚙️ Parameters
|
|
18680
|
+
|
|
18681
|
+
<dl>
|
|
18682
|
+
<dd>
|
|
18683
|
+
|
|
18684
|
+
<dl>
|
|
18685
|
+
<dd>
|
|
18686
|
+
|
|
18687
|
+
**taskId:** `string`
|
|
18688
|
+
|
|
18689
|
+
</dd>
|
|
18690
|
+
</dl>
|
|
18691
|
+
|
|
18692
|
+
<dl>
|
|
18693
|
+
<dd>
|
|
18694
|
+
|
|
18695
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18696
|
+
|
|
18697
|
+
</dd>
|
|
18698
|
+
</dl>
|
|
18699
|
+
</dd>
|
|
18700
|
+
</dl>
|
|
18701
|
+
|
|
18702
|
+
</dd>
|
|
18703
|
+
</dl>
|
|
18704
|
+
</details>
|
|
18705
|
+
|
|
18623
18706
|
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
18624
18707
|
<dl>
|
|
18625
18708
|
<dd>
|
|
@@ -20221,6 +20304,7 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
20221
20304
|
page: 1,
|
|
20222
20305
|
page_size: 1,
|
|
20223
20306
|
search: "search",
|
|
20307
|
+
filter_status: ["draft"],
|
|
20224
20308
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20225
20309
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20226
20310
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -20307,6 +20391,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
20307
20391
|
page: 1,
|
|
20308
20392
|
page_size: 1,
|
|
20309
20393
|
search: "search",
|
|
20394
|
+
filter_status: ["draft"],
|
|
20310
20395
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20311
20396
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20312
20397
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -20438,7 +20523,7 @@ await client.shipping.orders.expanded.typeaheadV1({
|
|
|
20438
20523
|
<dl>
|
|
20439
20524
|
<dd>
|
|
20440
20525
|
|
|
20441
|
-
Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[
|
|
20526
|
+
Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)
|
|
20442
20527
|
|
|
20443
20528
|
</dd>
|
|
20444
20529
|
</dl>
|
|
@@ -20501,7 +20586,7 @@ await client.shipping.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifac
|
|
|
20501
20586
|
<dl>
|
|
20502
20587
|
<dd>
|
|
20503
20588
|
|
|
20504
|
-
Streams a task artifact S3 object file from storage. | authz_personas=[
|
|
20589
|
+
Streams a task artifact S3 object file from storage. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (binary)
|
|
20505
20590
|
|
|
20506
20591
|
</dd>
|
|
20507
20592
|
</dl>
|
|
@@ -20564,7 +20649,7 @@ await client.shipping.taskArtifacts.s3Object.getV1("task_artifact_s3_object_meta
|
|
|
20564
20649
|
<dl>
|
|
20565
20650
|
<dd>
|
|
20566
20651
|
|
|
20567
|
-
Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[
|
|
20652
|
+
Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
20568
20653
|
|
|
20569
20654
|
</dd>
|
|
20570
20655
|
</dl>
|
|
@@ -20956,7 +21041,7 @@ await client.shipping.taskGroups.s3Object.getV1("task_group_s3_object_metadata_i
|
|
|
20956
21041
|
<dl>
|
|
20957
21042
|
<dd>
|
|
20958
21043
|
|
|
20959
|
-
Uploads a file (image, PDF, etc.) to a task group. Automatic blurhash generation for images. | authz_personas=[
|
|
21044
|
+
Uploads a file (image, PDF, etc.) to a task group. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
20960
21045
|
|
|
20961
21046
|
</dd>
|
|
20962
21047
|
</dl>
|
|
@@ -21400,6 +21485,7 @@ await client.shipping.taskGroups.expanded.listForExecutorOperatorsV1({
|
|
|
21400
21485
|
page: 1,
|
|
21401
21486
|
page_size: 1,
|
|
21402
21487
|
search: "search",
|
|
21488
|
+
filter_status: ["draft"],
|
|
21403
21489
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21404
21490
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21405
21491
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -21487,6 +21573,7 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
21487
21573
|
page: 1,
|
|
21488
21574
|
page_size: 1,
|
|
21489
21575
|
search: "search",
|
|
21576
|
+
filter_status: ["draft"],
|
|
21490
21577
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21491
21578
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21492
21579
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -21605,6 +21692,81 @@ await client.shipping.taskGroups.expanded.typeaheadV1({
|
|
|
21605
21692
|
</dl>
|
|
21606
21693
|
</details>
|
|
21607
21694
|
|
|
21695
|
+
## Shipping Tasks ExecutorOrgNotes
|
|
21696
|
+
|
|
21697
|
+
<details><summary><code>client.shipping.tasks.executorOrgNotes.<a href="/src/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.ts">addV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
21698
|
+
<dl>
|
|
21699
|
+
<dd>
|
|
21700
|
+
|
|
21701
|
+
#### 📝 Description
|
|
21702
|
+
|
|
21703
|
+
<dl>
|
|
21704
|
+
<dd>
|
|
21705
|
+
|
|
21706
|
+
<dl>
|
|
21707
|
+
<dd>
|
|
21708
|
+
|
|
21709
|
+
Adds an executor-side note to a task. | authz_personas=[driver_for_executor, executor_org_operators] | (AddExecutorOrgNoteReq) -> (bool)
|
|
21710
|
+
|
|
21711
|
+
</dd>
|
|
21712
|
+
</dl>
|
|
21713
|
+
</dd>
|
|
21714
|
+
</dl>
|
|
21715
|
+
|
|
21716
|
+
#### 🔌 Usage
|
|
21717
|
+
|
|
21718
|
+
<dl>
|
|
21719
|
+
<dd>
|
|
21720
|
+
|
|
21721
|
+
<dl>
|
|
21722
|
+
<dd>
|
|
21723
|
+
|
|
21724
|
+
```typescript
|
|
21725
|
+
await client.shipping.tasks.executorOrgNotes.addV1("task_id", {
|
|
21726
|
+
note: "note",
|
|
21727
|
+
});
|
|
21728
|
+
```
|
|
21729
|
+
|
|
21730
|
+
</dd>
|
|
21731
|
+
</dl>
|
|
21732
|
+
</dd>
|
|
21733
|
+
</dl>
|
|
21734
|
+
|
|
21735
|
+
#### ⚙️ Parameters
|
|
21736
|
+
|
|
21737
|
+
<dl>
|
|
21738
|
+
<dd>
|
|
21739
|
+
|
|
21740
|
+
<dl>
|
|
21741
|
+
<dd>
|
|
21742
|
+
|
|
21743
|
+
**taskId:** `string`
|
|
21744
|
+
|
|
21745
|
+
</dd>
|
|
21746
|
+
</dl>
|
|
21747
|
+
|
|
21748
|
+
<dl>
|
|
21749
|
+
<dd>
|
|
21750
|
+
|
|
21751
|
+
**request:** `Chrt.shipping.tasks.AddExecutorOrgNoteReq`
|
|
21752
|
+
|
|
21753
|
+
</dd>
|
|
21754
|
+
</dl>
|
|
21755
|
+
|
|
21756
|
+
<dl>
|
|
21757
|
+
<dd>
|
|
21758
|
+
|
|
21759
|
+
**requestOptions:** `ExecutorOrgNotes.RequestOptions`
|
|
21760
|
+
|
|
21761
|
+
</dd>
|
|
21762
|
+
</dl>
|
|
21763
|
+
</dd>
|
|
21764
|
+
</dl>
|
|
21765
|
+
|
|
21766
|
+
</dd>
|
|
21767
|
+
</dl>
|
|
21768
|
+
</details>
|
|
21769
|
+
|
|
21608
21770
|
## Tracking Devices
|
|
21609
21771
|
|
|
21610
21772
|
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrgV1</a>({ ...params }) -> string</code></summary>
|
|
@@ -21685,7 +21847,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
21685
21847
|
<dl>
|
|
21686
21848
|
<dd>
|
|
21687
21849
|
|
|
21688
|
-
Updates a device's type, comments, and/or off_chrt_reference_id. Use \_\_set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)
|
|
21850
|
+
Updates a device's type, comments, and/or off_chrt_reference_id. Use \_\_set_to_None flags to explicitly clear Optional fields. | auth: api_key | (DeviceClientUpdate1) -> (bool)
|
|
21689
21851
|
|
|
21690
21852
|
</dd>
|
|
21691
21853
|
</dl>
|
|
@@ -21750,7 +21912,7 @@ await client.tracking.devices.updateV1({
|
|
|
21750
21912
|
<dl>
|
|
21751
21913
|
<dd>
|
|
21752
21914
|
|
|
21753
|
-
Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)
|
|
21915
|
+
Archives a device by setting archived=True. Device must not have an active session — terminate it first. | auth: api_key | () -> (bool)
|
|
21754
21916
|
|
|
21755
21917
|
</dd>
|
|
21756
21918
|
</dl>
|
|
@@ -21815,7 +21977,7 @@ await client.tracking.devices.archiveV1({
|
|
|
21815
21977
|
<dl>
|
|
21816
21978
|
<dd>
|
|
21817
21979
|
|
|
21818
|
-
Pauses a device and opens a new pause time window. | () -> (bool)
|
|
21980
|
+
Pauses a device and opens a new pause time window. | auth: api_key | () -> (bool)
|
|
21819
21981
|
|
|
21820
21982
|
</dd>
|
|
21821
21983
|
</dl>
|
|
@@ -21880,7 +22042,7 @@ await client.tracking.devices.pauseV1({
|
|
|
21880
22042
|
<dl>
|
|
21881
22043
|
<dd>
|
|
21882
22044
|
|
|
21883
|
-
Unpauses a device. Closes the open pause time window. | () -> (bool)
|
|
22045
|
+
Unpauses a device. Closes the open pause time window. | auth: api_key | () -> (bool)
|
|
21884
22046
|
|
|
21885
22047
|
</dd>
|
|
21886
22048
|
</dl>
|
|
@@ -21945,7 +22107,7 @@ await client.tracking.devices.unpauseV1({
|
|
|
21945
22107
|
<dl>
|
|
21946
22108
|
<dd>
|
|
21947
22109
|
|
|
21948
|
-
Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
22110
|
+
Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | auth: api_key | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
21949
22111
|
|
|
21950
22112
|
</dd>
|
|
21951
22113
|
</dl>
|
|
@@ -22010,7 +22172,7 @@ await client.tracking.devices.updateSharedOrgsV1({
|
|
|
22010
22172
|
<dl>
|
|
22011
22173
|
<dd>
|
|
22012
22174
|
|
|
22013
|
-
Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
22175
|
+
Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
22014
22176
|
|
|
22015
22177
|
</dd>
|
|
22016
22178
|
</dl>
|
|
@@ -22075,7 +22237,7 @@ await client.tracking.devices.getV1({
|
|
|
22075
22237
|
<dl>
|
|
22076
22238
|
<dd>
|
|
22077
22239
|
|
|
22078
|
-
Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
22240
|
+
Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
22079
22241
|
|
|
22080
22242
|
</dd>
|
|
22081
22243
|
</dl>
|
|
@@ -22158,7 +22320,7 @@ await client.tracking.devices.listV1({
|
|
|
22158
22320
|
<dl>
|
|
22159
22321
|
<dd>
|
|
22160
22322
|
|
|
22161
|
-
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
22323
|
+
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
22162
22324
|
|
|
22163
22325
|
</dd>
|
|
22164
22326
|
</dl>
|
|
@@ -22227,7 +22389,7 @@ await client.tracking.devices.typeaheadV1({
|
|
|
22227
22389
|
<dl>
|
|
22228
22390
|
<dd>
|
|
22229
22391
|
|
|
22230
|
-
Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | (LocationFeature) -> (DriverUpdateRes)
|
|
22392
|
+
Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | auth: api_key | (LocationFeature) -> (DriverUpdateRes)
|
|
22231
22393
|
|
|
22232
22394
|
</dd>
|
|
22233
22395
|
</dl>
|
|
@@ -22585,7 +22747,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
22585
22747
|
<dl>
|
|
22586
22748
|
<dd>
|
|
22587
22749
|
|
|
22588
|
-
Updates a session's metadata. | (SessionClientUpdate1) -> (bool)
|
|
22750
|
+
Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
22589
22751
|
|
|
22590
22752
|
</dd>
|
|
22591
22753
|
</dl>
|
|
@@ -22650,7 +22812,7 @@ await client.tracking.sessions.updateV1({
|
|
|
22650
22812
|
<dl>
|
|
22651
22813
|
<dd>
|
|
22652
22814
|
|
|
22653
|
-
Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | (SessionsUpdateSharedOrgsReq1) -> (bool)
|
|
22815
|
+
Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | auth: api_key | (SessionsUpdateSharedOrgsReq1) -> (bool)
|
|
22654
22816
|
|
|
22655
22817
|
</dd>
|
|
22656
22818
|
</dl>
|
|
@@ -22715,7 +22877,7 @@ await client.tracking.sessions.updateSharedOrgsV1({
|
|
|
22715
22877
|
<dl>
|
|
22716
22878
|
<dd>
|
|
22717
22879
|
|
|
22718
|
-
Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)
|
|
22880
|
+
Terminates a session. Moves device.active_session_id to device.past_session_ids. | auth: api_key | () -> (bool)
|
|
22719
22881
|
|
|
22720
22882
|
</dd>
|
|
22721
22883
|
</dl>
|
|
@@ -22780,7 +22942,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
22780
22942
|
<dl>
|
|
22781
22943
|
<dd>
|
|
22782
22944
|
|
|
22783
|
-
Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
|
|
22945
|
+
Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | auth: api_key | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
|
|
22784
22946
|
|
|
22785
22947
|
</dd>
|
|
22786
22948
|
</dl>
|
|
@@ -22847,7 +23009,7 @@ await client.tracking.sessions.addFlightV1({
|
|
|
22847
23009
|
<dl>
|
|
22848
23010
|
<dd>
|
|
22849
23011
|
|
|
22850
|
-
Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
|
|
23012
|
+
Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | auth: api_key | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
|
|
22851
23013
|
|
|
22852
23014
|
</dd>
|
|
22853
23015
|
</dl>
|
|
@@ -22914,7 +23076,7 @@ await client.tracking.sessions.removeFlightV1({
|
|
|
22914
23076
|
<dl>
|
|
22915
23077
|
<dd>
|
|
22916
23078
|
|
|
22917
|
-
Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | authz: min_org_role=operator | () -> (bool)
|
|
23079
|
+
Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | auth: api_key | authz: min_org_role=operator | () -> (bool)
|
|
22918
23080
|
|
|
22919
23081
|
</dd>
|
|
22920
23082
|
</dl>
|
|
@@ -22981,7 +23143,7 @@ await client.tracking.sessions.syncFlightStatusV1({
|
|
|
22981
23143
|
<dl>
|
|
22982
23144
|
<dd>
|
|
22983
23145
|
|
|
22984
|
-
Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
|
|
23146
|
+
Updates the sharing settings for a task group by driver tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
|
|
22985
23147
|
|
|
22986
23148
|
</dd>
|
|
22987
23149
|
</dl>
|
|
@@ -23047,7 +23209,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
|
|
|
23047
23209
|
<dl>
|
|
23048
23210
|
<dd>
|
|
23049
23211
|
|
|
23050
|
-
Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
|
|
23212
|
+
Updates the sharing settings for a cargo by driver tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
|
|
23051
23213
|
|
|
23052
23214
|
</dd>
|
|
23053
23215
|
</dl>
|
|
@@ -23114,7 +23276,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
|
|
|
23114
23276
|
<dl>
|
|
23115
23277
|
<dd>
|
|
23116
23278
|
|
|
23117
|
-
Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[coordinator_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
|
|
23279
|
+
Updates the sharing settings for a cargo by device tracking dataset. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
|
|
23118
23280
|
|
|
23119
23281
|
</dd>
|
|
23120
23282
|
</dl>
|
|
@@ -23247,7 +23409,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_ref");
|
|
|
23247
23409
|
<dl>
|
|
23248
23410
|
<dd>
|
|
23249
23411
|
|
|
23250
|
-
Returns the last seen data point for cargo within a task group. Access granted to the order's coordinator/shipper/executor org or the assigned driver, or via public sharing. | () -> (CargoByDeviceDataPoint1 | None)
|
|
23412
|
+
Returns the last seen data point for cargo within a task group. Access granted to the order's coordinator/shipper/executor org or the assigned driver, or via public sharing. | auth: api_key | () -> (CargoByDeviceDataPoint1 | None)
|
|
23251
23413
|
|
|
23252
23414
|
</dd>
|
|
23253
23415
|
</dl>
|
|
@@ -23313,7 +23475,7 @@ await client.tracking.timeseries.cargoByDevice.lastSeenV1({
|
|
|
23313
23475
|
<dl>
|
|
23314
23476
|
<dd>
|
|
23315
23477
|
|
|
23316
|
-
Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDeviceDataPoint1])
|
|
23478
|
+
Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | auth: api_key | () -> (list[CargoByDeviceDataPoint1])
|
|
23317
23479
|
|
|
23318
23480
|
</dd>
|
|
23319
23481
|
</dl>
|
|
@@ -23380,7 +23542,7 @@ await client.tracking.timeseries.cargoByDevice.dataPointsV1({
|
|
|
23380
23542
|
<dl>
|
|
23381
23543
|
<dd>
|
|
23382
23544
|
|
|
23383
|
-
Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (CargoByDeviceMarkOutliersRequest1) -> (CargoByDeviceMarkOutliersResponse1)
|
|
23545
|
+
Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | auth: api_key | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (CargoByDeviceMarkOutliersRequest1) -> (CargoByDeviceMarkOutliersResponse1)
|
|
23384
23546
|
|
|
23385
23547
|
</dd>
|
|
23386
23548
|
</dl>
|
|
@@ -23581,7 +23743,7 @@ await client.tracking.timeseries.cargoByDevice.dataPointsPublicV1({
|
|
|
23581
23743
|
<dl>
|
|
23582
23744
|
<dd>
|
|
23583
23745
|
|
|
23584
|
-
Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (CargoByDriverDataPoint1 | None)
|
|
23746
|
+
Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | auth: api_key | () -> (CargoByDriverDataPoint1 | None)
|
|
23585
23747
|
|
|
23586
23748
|
</dd>
|
|
23587
23749
|
</dl>
|
|
@@ -23647,7 +23809,7 @@ await client.tracking.timeseries.cargoByDriver.lastSeenV1({
|
|
|
23647
23809
|
<dl>
|
|
23648
23810
|
<dd>
|
|
23649
23811
|
|
|
23650
|
-
Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | () -> (list[CargoByDriverDataPoint1])
|
|
23812
|
+
Returns up to the specified number of data points for a cargo within a task group, intelligently sampled across the time range. Excludes outliers. | auth: api_key | () -> (list[CargoByDriverDataPoint1])
|
|
23651
23813
|
|
|
23652
23814
|
</dd>
|
|
23653
23815
|
</dl>
|
|
@@ -23982,7 +24144,7 @@ await client.tracking.timeseries.sessionByDevice.dataPointsV1({
|
|
|
23982
24144
|
<dl>
|
|
23983
24145
|
<dd>
|
|
23984
24146
|
|
|
23985
|
-
Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
24147
|
+
Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | auth: api_key | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
|
|
23986
24148
|
|
|
23987
24149
|
</dd>
|
|
23988
24150
|
</dl>
|
|
@@ -24183,7 +24345,7 @@ await client.tracking.timeseries.sessionByDevice.dataPointsPublicV1({
|
|
|
24183
24345
|
<dl>
|
|
24184
24346
|
<dd>
|
|
24185
24347
|
|
|
24186
|
-
Returns the most recent driver location data point for a task group. | authz_personas=[
|
|
24348
|
+
Returns the most recent driver location data point for a task group. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (TaskGroupByDriverDataPoint1 | None)
|
|
24187
24349
|
|
|
24188
24350
|
</dd>
|
|
24189
24351
|
</dl>
|
|
@@ -24248,7 +24410,7 @@ await client.tracking.timeseries.taskGroupByDriver.lastSeenV1({
|
|
|
24248
24410
|
<dl>
|
|
24249
24411
|
<dd>
|
|
24250
24412
|
|
|
24251
|
-
Returns sampled driver location data points for a task group. Excludes outliers. | authz_personas=[
|
|
24413
|
+
Returns sampled driver location data points for a task group. Excludes outliers. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (list[TaskGroupByDriverDataPoint1])
|
|
24252
24414
|
|
|
24253
24415
|
</dd>
|
|
24254
24416
|
</dl>
|