@chrt-inc/typescript-sdk 1.925.0 → 1.929.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/billingNew/resources/invoices/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/Client.js +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.d.ts +3 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +11 -3
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksExpandedListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/Client.d.ts +6 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/Client.js +30 -2
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplatesNewListV1Request.d.ts +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/resources/tasks/client/requests/OrderTemplateNewTaskClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/task/client/requests/TaskClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +19 -2
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +74 -5
- package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/TaskCompleteReq.d.ts +10 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/TaskCompletionTimestampUpdateReq.d.ts +12 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/tracking/client/Client.js +16 -6
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/Client.d.ts +140 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/Client.js +494 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/GeofenceTemplatesListV1Request.d.ts +45 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientCreate1.d.ts +28 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientUpdate1.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/tracking/resources/index.js +5 -1
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/Client.d.ts +117 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/Client.js +393 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceApplyTemplateReq.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceApplyTemplateReq.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceClientUpdate1.d.ts +13 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceReorderReq.d.ts +10 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceReorderReq.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/sessionGeofences/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +5 -5
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionClientUpdate1.d.ts → SessionClientUpdate2.d.ts} +1 -5
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate2.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionClientCreate1.d.ts → SessionsCreateV1Req.d.ts} +3 -3
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsCreateV1Req.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/types/BillingInvoiceApprovedWebhookPayload.d.ts +10 -0
- package/dist/cjs/api/types/BillingInvoiceApprovedWebhookPayload.js +5 -0
- package/dist/cjs/api/types/DeviceExpandedRes.d.ts +2 -2
- package/dist/cjs/api/types/GeofencePointLocationFeature1.d.ts +14 -0
- package/dist/cjs/api/types/GeofencePointLocationFeature1.js +5 -0
- package/dist/cjs/api/types/GeofenceTemplateListRes.d.ts +8 -0
- package/dist/cjs/api/types/GeofenceTemplateListRes.js +5 -0
- package/dist/cjs/api/types/GeofenceTemplateSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/GeofenceTemplateSortByEnum.js +12 -0
- package/dist/cjs/api/types/InvoiceExpandedRes.d.ts +1 -1
- package/dist/cjs/api/types/InvoiceLineItemExpandedRes.d.ts +12 -0
- package/dist/cjs/api/types/InvoiceLineItemExpandedRes.js +5 -0
- package/dist/cjs/api/types/NotificationEventsForAdHocEnum.d.ts +2 -2
- package/dist/cjs/api/types/NotificationEventsForAdHocEnum.js +1 -1
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +3 -2
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +2 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +3 -2
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +2 -1
- package/dist/cjs/api/types/OrderAndTaskGroupExpandedReq.d.ts +1 -0
- package/dist/cjs/api/types/OrderExpandedForProvider.d.ts +1 -0
- package/dist/cjs/api/types/OrderTemplateNewExpanded1.d.ts +37 -0
- package/dist/cjs/api/types/OrderTemplateNewExpanded1.js +5 -0
- package/dist/cjs/api/types/OrderTemplateNewListRes.d.ts +1 -1
- package/dist/cjs/api/types/OrderTemplateNewTaskGroupExpanded1.d.ts +10 -0
- package/dist/cjs/api/types/OrderTemplateNewTaskGroupExpanded1.js +5 -0
- package/dist/cjs/api/types/Point.d.ts +1 -0
- package/dist/cjs/api/types/{Session1.d.ts → Session2.d.ts} +2 -4
- package/dist/cjs/api/types/Session2.js +5 -0
- package/dist/cjs/api/types/SessionGeofence1.d.ts +12 -0
- package/dist/cjs/api/types/SessionGeofence1.js +5 -0
- package/dist/cjs/api/types/SessionGeofenceBase1.d.ts +9 -0
- package/dist/cjs/api/types/SessionGeofenceBase1.js +5 -0
- package/dist/cjs/api/types/SessionGeofenceClientCreate1.d.ts +9 -0
- package/dist/cjs/api/types/SessionGeofenceClientCreate1.js +5 -0
- package/dist/cjs/api/types/SessionGeofenceTemplate1.d.ts +19 -0
- package/dist/cjs/api/types/SessionGeofenceTemplate1.js +5 -0
- package/dist/cjs/api/types/SessionListRes.d.ts +1 -1
- package/dist/cjs/api/types/Task1.d.ts +1 -0
- package/dist/cjs/api/types/TaskListToApplyToOrderExpanded.d.ts +8 -0
- package/dist/cjs/api/types/TaskListToApplyToOrderExpanded.js +5 -0
- package/dist/cjs/api/types/TrackingSessionGeofenceEnteredWebhookPayload.d.ts +14 -0
- package/dist/cjs/api/types/TrackingSessionGeofenceEnteredWebhookPayload.js +5 -0
- package/dist/cjs/api/types/index.d.ts +14 -2
- package/dist/cjs/api/types/index.js +14 -2
- 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/billingNew/resources/invoices/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/billingNew/resources/invoices/client/Client.mjs +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.d.mts +3 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +11 -3
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksExpandedListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/Client.d.mts +6 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/Client.mjs +30 -2
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplatesNewListV1Request.d.mts +17 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/resources/tasks/client/requests/OrderTemplateNewTaskClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/task/client/requests/TaskClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +19 -2
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +74 -5
- package/dist/esm/api/resources/shipping/resources/tasks/client/requests/TaskCompleteReq.d.mts +10 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/requests/TaskCompletionTimestampUpdateReq.d.mts +12 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/tracking/client/Client.mjs +10 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/Client.d.mts +140 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/Client.mjs +457 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/requests/GeofenceTemplatesListV1Request.d.mts +45 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientCreate1.d.mts +28 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientUpdate1.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/geofenceTemplates/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/tracking/resources/index.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/Client.d.mts +117 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/Client.mjs +356 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/index.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceApplyTemplateReq.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceApplyTemplateReq.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceClientUpdate1.d.mts +13 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceReorderReq.d.mts +10 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/SessionGeofenceReorderReq.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/sessionGeofences/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +5 -5
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionClientUpdate1.d.mts → SessionClientUpdate2.d.mts} +1 -5
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate2.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionClientCreate1.d.mts → SessionsCreateV1Req.d.mts} +3 -3
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsCreateV1Req.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +2 -2
- package/dist/esm/api/types/BillingInvoiceApprovedWebhookPayload.d.mts +10 -0
- package/dist/esm/api/types/BillingInvoiceApprovedWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/DeviceExpandedRes.d.mts +2 -2
- package/dist/esm/api/types/GeofencePointLocationFeature1.d.mts +14 -0
- package/dist/esm/api/types/GeofencePointLocationFeature1.mjs +4 -0
- package/dist/esm/api/types/GeofenceTemplateListRes.d.mts +8 -0
- package/dist/esm/api/types/GeofenceTemplateListRes.mjs +4 -0
- package/dist/esm/api/types/GeofenceTemplateSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/GeofenceTemplateSortByEnum.mjs +9 -0
- package/dist/esm/api/types/InvoiceExpandedRes.d.mts +1 -1
- package/dist/esm/api/types/InvoiceLineItemExpandedRes.d.mts +12 -0
- package/dist/esm/api/types/InvoiceLineItemExpandedRes.mjs +4 -0
- package/dist/esm/api/types/NotificationEventsForAdHocEnum.d.mts +2 -2
- package/dist/esm/api/types/NotificationEventsForAdHocEnum.mjs +1 -1
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +3 -2
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +2 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +3 -2
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +2 -1
- package/dist/esm/api/types/OrderAndTaskGroupExpandedReq.d.mts +1 -0
- package/dist/esm/api/types/OrderExpandedForProvider.d.mts +1 -0
- package/dist/esm/api/types/OrderTemplateNewExpanded1.d.mts +37 -0
- package/dist/esm/api/types/OrderTemplateNewExpanded1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateNewListRes.d.mts +1 -1
- package/dist/esm/api/types/OrderTemplateNewTaskGroupExpanded1.d.mts +10 -0
- package/dist/esm/api/types/OrderTemplateNewTaskGroupExpanded1.mjs +4 -0
- package/dist/esm/api/types/Point.d.mts +1 -0
- package/dist/esm/api/types/{Session1.d.mts → Session2.d.mts} +2 -4
- package/dist/esm/api/types/Session2.mjs +4 -0
- package/dist/esm/api/types/SessionGeofence1.d.mts +12 -0
- package/dist/esm/api/types/SessionGeofence1.mjs +4 -0
- package/dist/esm/api/types/SessionGeofenceBase1.d.mts +9 -0
- package/dist/esm/api/types/SessionGeofenceBase1.mjs +4 -0
- package/dist/esm/api/types/SessionGeofenceClientCreate1.d.mts +9 -0
- package/dist/esm/api/types/SessionGeofenceClientCreate1.mjs +4 -0
- package/dist/esm/api/types/SessionGeofenceTemplate1.d.mts +19 -0
- package/dist/esm/api/types/SessionGeofenceTemplate1.mjs +4 -0
- package/dist/esm/api/types/SessionListRes.d.mts +1 -1
- package/dist/esm/api/types/Task1.d.mts +1 -0
- package/dist/esm/api/types/TaskListToApplyToOrderExpanded.d.mts +8 -0
- package/dist/esm/api/types/TaskListToApplyToOrderExpanded.mjs +4 -0
- package/dist/esm/api/types/TrackingSessionGeofenceEnteredWebhookPayload.d.mts +14 -0
- package/dist/esm/api/types/TrackingSessionGeofenceEnteredWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +14 -2
- package/dist/esm/api/types/index.mjs +14 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +982 -100
- package/dist/cjs/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.ts +0 -10
- package/dist/esm/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.mts +0 -10
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionClientCreate1.js → shipping/resources/tasks/client/requests/TaskCompleteReq.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionClientUpdate1.js → shipping/resources/tasks/client/requests/TaskCompletionTimestampUpdateReq.js} +0 -0
- /package/dist/cjs/api/{types/Session1.js → resources/tracking/resources/geofenceTemplates/client/requests/GeofenceTemplatesListV1Request.js} +0 -0
- /package/dist/cjs/api/{types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.js → resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientCreate1.js} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionClientCreate1.mjs → shipping/resources/tasks/client/requests/TaskCompleteReq.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionClientUpdate1.mjs → shipping/resources/tasks/client/requests/TaskCompletionTimestampUpdateReq.mjs} +0 -0
- /package/dist/esm/api/{types/Session1.mjs → resources/tracking/resources/geofenceTemplates/client/requests/GeofenceTemplatesListV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.mjs → resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientCreate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -3006,7 +3006,7 @@ await client.billingNew.invoices.deleteV1("invoice_id");
|
|
|
3006
3006
|
<dl>
|
|
3007
3007
|
<dd>
|
|
3008
3008
|
|
|
3009
|
-
Retrieves an owner-scoped invoice with
|
|
3009
|
+
Retrieves an owner-scoped invoice with line-item orders, counterparties, and accounts expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceExpandedRes)
|
|
3010
3010
|
|
|
3011
3011
|
</dd>
|
|
3012
3012
|
</dl>
|
|
@@ -10567,6 +10567,7 @@ await client.operations.operationsTasks.expandedListV1({
|
|
|
10567
10567
|
filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
10568
10568
|
filter_department_id: "filter_department_id",
|
|
10569
10569
|
filter_assigned_user_id: "filter_assigned_user_id",
|
|
10570
|
+
filter_source_task_list_id: "filter_source_task_list_id",
|
|
10570
10571
|
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
10571
10572
|
filter_deadline_lte: "2024-01-15T09:30:00Z",
|
|
10572
10573
|
});
|
|
@@ -10616,7 +10617,7 @@ await client.operations.operationsTasks.expandedListV1({
|
|
|
10616
10617
|
<dl>
|
|
10617
10618
|
<dd>
|
|
10618
10619
|
|
|
10619
|
-
Lists OperationsTasks for the caller's organization, with order ids / order short id / order off-CHRT reference id / department / type / status / assignee / deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
|
|
10620
|
+
Lists OperationsTasks for the caller's organization, with order ids / order short id / order off-CHRT reference id / department / type / status / assignee / source task list / deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
|
|
10620
10621
|
|
|
10621
10622
|
</dd>
|
|
10622
10623
|
</dl>
|
|
@@ -10642,6 +10643,7 @@ await client.operations.operationsTasks.listV1({
|
|
|
10642
10643
|
filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
10643
10644
|
filter_department_id: "filter_department_id",
|
|
10644
10645
|
filter_assigned_user_id: "filter_assigned_user_id",
|
|
10646
|
+
filter_source_task_list_id: "filter_source_task_list_id",
|
|
10645
10647
|
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
10646
10648
|
filter_deadline_lte: "2024-01-15T09:30:00Z",
|
|
10647
10649
|
});
|
|
@@ -16749,7 +16751,7 @@ await client.shipping.orderTemplatesNew.resolveDateparserV1({
|
|
|
16749
16751
|
<dl>
|
|
16750
16752
|
<dd>
|
|
16751
16753
|
|
|
16752
|
-
Lists order templates
|
|
16754
|
+
Lists order templates with filtering, sorting, pagination, full-text search, and party/account expansion. | authz: min_org_role=operator | () -> (OrderTemplateNewListRes)
|
|
16753
16755
|
|
|
16754
16756
|
</dd>
|
|
16755
16757
|
</dl>
|
|
@@ -16770,8 +16772,13 @@ await client.shipping.orderTemplatesNew.listV1({
|
|
|
16770
16772
|
sort_order: "asc",
|
|
16771
16773
|
page: 1,
|
|
16772
16774
|
page_size: 1,
|
|
16775
|
+
search: "search",
|
|
16773
16776
|
filter_archived: true,
|
|
16774
16777
|
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16778
|
+
filter_executor_org_id: "filter_executor_org_id",
|
|
16779
|
+
filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
|
|
16780
|
+
filter_shipper_org_id: "filter_shipper_org_id",
|
|
16781
|
+
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
16775
16782
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16776
16783
|
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16777
16784
|
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -18291,7 +18298,7 @@ await client.shipping.tasks.attemptV1("task_id");
|
|
|
18291
18298
|
</dl>
|
|
18292
18299
|
</details>
|
|
18293
18300
|
|
|
18294
|
-
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
|
|
18301
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">completeV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
18295
18302
|
<dl>
|
|
18296
18303
|
<dd>
|
|
18297
18304
|
|
|
@@ -18303,7 +18310,7 @@ await client.shipping.tasks.attemptV1("task_id");
|
|
|
18303
18310
|
<dl>
|
|
18304
18311
|
<dd>
|
|
18305
18312
|
|
|
18306
|
-
Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
|
|
18313
|
+
Marks a task as COMPLETED, optionally recording a client-supplied completion timestamp no more than five minutes in the future. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | (TaskCompleteReq) -> (bool)
|
|
18307
18314
|
|
|
18308
18315
|
</dd>
|
|
18309
18316
|
</dl>
|
|
@@ -18343,6 +18350,87 @@ await client.shipping.tasks.completeV1("task_id");
|
|
|
18343
18350
|
<dl>
|
|
18344
18351
|
<dd>
|
|
18345
18352
|
|
|
18353
|
+
**request:** `Chrt.shipping.TaskCompleteReq`
|
|
18354
|
+
|
|
18355
|
+
</dd>
|
|
18356
|
+
</dl>
|
|
18357
|
+
|
|
18358
|
+
<dl>
|
|
18359
|
+
<dd>
|
|
18360
|
+
|
|
18361
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18362
|
+
|
|
18363
|
+
</dd>
|
|
18364
|
+
</dl>
|
|
18365
|
+
</dd>
|
|
18366
|
+
</dl>
|
|
18367
|
+
|
|
18368
|
+
</dd>
|
|
18369
|
+
</dl>
|
|
18370
|
+
</details>
|
|
18371
|
+
|
|
18372
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">updateCompletionTimestampV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
18373
|
+
<dl>
|
|
18374
|
+
<dd>
|
|
18375
|
+
|
|
18376
|
+
#### 📝 Description
|
|
18377
|
+
|
|
18378
|
+
<dl>
|
|
18379
|
+
<dd>
|
|
18380
|
+
|
|
18381
|
+
<dl>
|
|
18382
|
+
<dd>
|
|
18383
|
+
|
|
18384
|
+
Corrects a completed task's completion timestamp. The driver may correct only their own completion; authorized operators may override it. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | (TaskCompletionTimestampUpdateReq) -> (bool)
|
|
18385
|
+
|
|
18386
|
+
</dd>
|
|
18387
|
+
</dl>
|
|
18388
|
+
</dd>
|
|
18389
|
+
</dl>
|
|
18390
|
+
|
|
18391
|
+
#### 🔌 Usage
|
|
18392
|
+
|
|
18393
|
+
<dl>
|
|
18394
|
+
<dd>
|
|
18395
|
+
|
|
18396
|
+
<dl>
|
|
18397
|
+
<dd>
|
|
18398
|
+
|
|
18399
|
+
```typescript
|
|
18400
|
+
await client.shipping.tasks.updateCompletionTimestampV1("task_id", {
|
|
18401
|
+
completed_at_timestamp: "2024-01-15T09:30:00Z",
|
|
18402
|
+
});
|
|
18403
|
+
```
|
|
18404
|
+
|
|
18405
|
+
</dd>
|
|
18406
|
+
</dl>
|
|
18407
|
+
</dd>
|
|
18408
|
+
</dl>
|
|
18409
|
+
|
|
18410
|
+
#### ⚙️ Parameters
|
|
18411
|
+
|
|
18412
|
+
<dl>
|
|
18413
|
+
<dd>
|
|
18414
|
+
|
|
18415
|
+
<dl>
|
|
18416
|
+
<dd>
|
|
18417
|
+
|
|
18418
|
+
**taskId:** `string`
|
|
18419
|
+
|
|
18420
|
+
</dd>
|
|
18421
|
+
</dl>
|
|
18422
|
+
|
|
18423
|
+
<dl>
|
|
18424
|
+
<dd>
|
|
18425
|
+
|
|
18426
|
+
**request:** `Chrt.shipping.TaskCompletionTimestampUpdateReq`
|
|
18427
|
+
|
|
18428
|
+
</dd>
|
|
18429
|
+
</dl>
|
|
18430
|
+
|
|
18431
|
+
<dl>
|
|
18432
|
+
<dd>
|
|
18433
|
+
|
|
18346
18434
|
**requestOptions:** `Tasks.RequestOptions`
|
|
18347
18435
|
|
|
18348
18436
|
</dd>
|
|
@@ -25315,9 +25403,9 @@ await client.tracking.driver.updateV2({
|
|
|
25315
25403
|
</dl>
|
|
25316
25404
|
</details>
|
|
25317
25405
|
|
|
25318
|
-
## Tracking
|
|
25406
|
+
## Tracking GeofenceTemplates
|
|
25319
25407
|
|
|
25320
|
-
<details><summary><code>client.tracking.
|
|
25408
|
+
<details><summary><code>client.tracking.geofenceTemplates.<a href="/src/api/resources/tracking/resources/geofenceTemplates/client/Client.ts">archiveV1</a>(geofenceTemplateId) -> boolean</code></summary>
|
|
25321
25409
|
<dl>
|
|
25322
25410
|
<dd>
|
|
25323
25411
|
|
|
@@ -25329,7 +25417,7 @@ await client.tracking.driver.updateV2({
|
|
|
25329
25417
|
<dl>
|
|
25330
25418
|
<dd>
|
|
25331
25419
|
|
|
25332
|
-
|
|
25420
|
+
Archives a geofence template owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
|
|
25333
25421
|
|
|
25334
25422
|
</dd>
|
|
25335
25423
|
</dl>
|
|
@@ -25345,11 +25433,7 @@ Creates a new tracking session for a device and automatically starts recording d
|
|
|
25345
25433
|
<dd>
|
|
25346
25434
|
|
|
25347
25435
|
```typescript
|
|
25348
|
-
await client.tracking.
|
|
25349
|
-
device_id: "device_id",
|
|
25350
|
-
no_auto_termination: true,
|
|
25351
|
-
schema_version: 1,
|
|
25352
|
-
});
|
|
25436
|
+
await client.tracking.geofenceTemplates.archiveV1("geofence_template_id");
|
|
25353
25437
|
```
|
|
25354
25438
|
|
|
25355
25439
|
</dd>
|
|
@@ -25365,7 +25449,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
25365
25449
|
<dl>
|
|
25366
25450
|
<dd>
|
|
25367
25451
|
|
|
25368
|
-
**
|
|
25452
|
+
**geofenceTemplateId:** `string`
|
|
25369
25453
|
|
|
25370
25454
|
</dd>
|
|
25371
25455
|
</dl>
|
|
@@ -25373,7 +25457,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
25373
25457
|
<dl>
|
|
25374
25458
|
<dd>
|
|
25375
25459
|
|
|
25376
|
-
**requestOptions:** `
|
|
25460
|
+
**requestOptions:** `GeofenceTemplates.RequestOptions`
|
|
25377
25461
|
|
|
25378
25462
|
</dd>
|
|
25379
25463
|
</dl>
|
|
@@ -25384,7 +25468,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
25384
25468
|
</dl>
|
|
25385
25469
|
</details>
|
|
25386
25470
|
|
|
25387
|
-
<details><summary><code>client.tracking.
|
|
25471
|
+
<details><summary><code>client.tracking.geofenceTemplates.<a href="/src/api/resources/tracking/resources/geofenceTemplates/client/Client.ts">listV1</a>({ ...params }) -> Chrt.GeofenceTemplateListRes</code></summary>
|
|
25388
25472
|
<dl>
|
|
25389
25473
|
<dd>
|
|
25390
25474
|
|
|
@@ -25396,7 +25480,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
25396
25480
|
<dl>
|
|
25397
25481
|
<dd>
|
|
25398
25482
|
|
|
25399
|
-
|
|
25483
|
+
Lists geofence templates for the caller's organization. | authz: min_org_role=operator | () -> (GeofenceTemplateListRes)
|
|
25400
25484
|
|
|
25401
25485
|
</dd>
|
|
25402
25486
|
</dl>
|
|
@@ -25412,8 +25496,19 @@ Returns the session's flight legs in order, with Cirium-sourced status lazily re
|
|
|
25412
25496
|
<dd>
|
|
25413
25497
|
|
|
25414
25498
|
```typescript
|
|
25415
|
-
await client.tracking.
|
|
25416
|
-
|
|
25499
|
+
await client.tracking.geofenceTemplates.listV1({
|
|
25500
|
+
sort_by: "created_at_timestamp",
|
|
25501
|
+
sort_order: "asc",
|
|
25502
|
+
page: 1,
|
|
25503
|
+
page_size: 1,
|
|
25504
|
+
filter_archived: true,
|
|
25505
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
25506
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25507
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25508
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25509
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25510
|
+
filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25511
|
+
filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25417
25512
|
});
|
|
25418
25513
|
```
|
|
25419
25514
|
|
|
@@ -25430,7 +25525,7 @@ await client.tracking.sessions.flightLegsV1({
|
|
|
25430
25525
|
<dl>
|
|
25431
25526
|
<dd>
|
|
25432
25527
|
|
|
25433
|
-
**request:** `Chrt.tracking.
|
|
25528
|
+
**request:** `Chrt.tracking.GeofenceTemplatesListV1Request`
|
|
25434
25529
|
|
|
25435
25530
|
</dd>
|
|
25436
25531
|
</dl>
|
|
@@ -25438,7 +25533,7 @@ await client.tracking.sessions.flightLegsV1({
|
|
|
25438
25533
|
<dl>
|
|
25439
25534
|
<dd>
|
|
25440
25535
|
|
|
25441
|
-
**requestOptions:** `
|
|
25536
|
+
**requestOptions:** `GeofenceTemplates.RequestOptions`
|
|
25442
25537
|
|
|
25443
25538
|
</dd>
|
|
25444
25539
|
</dl>
|
|
@@ -25449,7 +25544,7 @@ await client.tracking.sessions.flightLegsV1({
|
|
|
25449
25544
|
</dl>
|
|
25450
25545
|
</details>
|
|
25451
25546
|
|
|
25452
|
-
<details><summary><code>client.tracking.
|
|
25547
|
+
<details><summary><code>client.tracking.geofenceTemplates.<a href="/src/api/resources/tracking/resources/geofenceTemplates/client/Client.ts">unarchiveV1</a>(geofenceTemplateId) -> boolean</code></summary>
|
|
25453
25548
|
<dl>
|
|
25454
25549
|
<dd>
|
|
25455
25550
|
|
|
@@ -25461,7 +25556,7 @@ await client.tracking.sessions.flightLegsV1({
|
|
|
25461
25556
|
<dl>
|
|
25462
25557
|
<dd>
|
|
25463
25558
|
|
|
25464
|
-
|
|
25559
|
+
Restores an archived geofence template owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
|
|
25465
25560
|
|
|
25466
25561
|
</dd>
|
|
25467
25562
|
</dl>
|
|
@@ -25477,10 +25572,7 @@ Returns the Cirium-sourced positional track for one of the session's flight legs
|
|
|
25477
25572
|
<dd>
|
|
25478
25573
|
|
|
25479
25574
|
```typescript
|
|
25480
|
-
await client.tracking.
|
|
25481
|
-
session_id: "session_id",
|
|
25482
|
-
flight_leg_id: "flight_leg_id",
|
|
25483
|
-
});
|
|
25575
|
+
await client.tracking.geofenceTemplates.unarchiveV1("geofence_template_id");
|
|
25484
25576
|
```
|
|
25485
25577
|
|
|
25486
25578
|
</dd>
|
|
@@ -25496,7 +25588,7 @@ await client.tracking.sessions.flightTrackV1({
|
|
|
25496
25588
|
<dl>
|
|
25497
25589
|
<dd>
|
|
25498
25590
|
|
|
25499
|
-
**
|
|
25591
|
+
**geofenceTemplateId:** `string`
|
|
25500
25592
|
|
|
25501
25593
|
</dd>
|
|
25502
25594
|
</dl>
|
|
@@ -25504,7 +25596,7 @@ await client.tracking.sessions.flightTrackV1({
|
|
|
25504
25596
|
<dl>
|
|
25505
25597
|
<dd>
|
|
25506
25598
|
|
|
25507
|
-
**requestOptions:** `
|
|
25599
|
+
**requestOptions:** `GeofenceTemplates.RequestOptions`
|
|
25508
25600
|
|
|
25509
25601
|
</dd>
|
|
25510
25602
|
</dl>
|
|
@@ -25515,7 +25607,7 @@ await client.tracking.sessions.flightTrackV1({
|
|
|
25515
25607
|
</dl>
|
|
25516
25608
|
</details>
|
|
25517
25609
|
|
|
25518
|
-
<details><summary><code>client.tracking.
|
|
25610
|
+
<details><summary><code>client.tracking.geofenceTemplates.<a href="/src/api/resources/tracking/resources/geofenceTemplates/client/Client.ts">updateV1</a>(geofenceTemplateId, { ...params }) -> Chrt.SessionGeofenceTemplate1</code></summary>
|
|
25519
25611
|
<dl>
|
|
25520
25612
|
<dd>
|
|
25521
25613
|
|
|
@@ -25527,7 +25619,7 @@ await client.tracking.sessions.flightTrackV1({
|
|
|
25527
25619
|
<dl>
|
|
25528
25620
|
<dd>
|
|
25529
25621
|
|
|
25530
|
-
|
|
25622
|
+
Updates an active geofence template owned by the caller's organization. | authz: min_org_role=operator | (SessionGeofenceTemplateClientUpdate1) -> (SessionGeofenceTemplate1)
|
|
25531
25623
|
|
|
25532
25624
|
</dd>
|
|
25533
25625
|
</dl>
|
|
@@ -25543,9 +25635,7 @@ Retrieves a single session by its ID. Access restricted to the caller's organiza
|
|
|
25543
25635
|
<dd>
|
|
25544
25636
|
|
|
25545
25637
|
```typescript
|
|
25546
|
-
await client.tracking.
|
|
25547
|
-
session_id: "session_id",
|
|
25548
|
-
});
|
|
25638
|
+
await client.tracking.geofenceTemplates.updateV1("geofence_template_id");
|
|
25549
25639
|
```
|
|
25550
25640
|
|
|
25551
25641
|
</dd>
|
|
@@ -25561,7 +25651,7 @@ await client.tracking.sessions.getV1({
|
|
|
25561
25651
|
<dl>
|
|
25562
25652
|
<dd>
|
|
25563
25653
|
|
|
25564
|
-
**
|
|
25654
|
+
**geofenceTemplateId:** `string`
|
|
25565
25655
|
|
|
25566
25656
|
</dd>
|
|
25567
25657
|
</dl>
|
|
@@ -25569,7 +25659,15 @@ await client.tracking.sessions.getV1({
|
|
|
25569
25659
|
<dl>
|
|
25570
25660
|
<dd>
|
|
25571
25661
|
|
|
25572
|
-
**
|
|
25662
|
+
**request:** `Chrt.tracking.SessionGeofenceTemplateClientUpdate1`
|
|
25663
|
+
|
|
25664
|
+
</dd>
|
|
25665
|
+
</dl>
|
|
25666
|
+
|
|
25667
|
+
<dl>
|
|
25668
|
+
<dd>
|
|
25669
|
+
|
|
25670
|
+
**requestOptions:** `GeofenceTemplates.RequestOptions`
|
|
25573
25671
|
|
|
25574
25672
|
</dd>
|
|
25575
25673
|
</dl>
|
|
@@ -25580,7 +25678,7 @@ await client.tracking.sessions.getV1({
|
|
|
25580
25678
|
</dl>
|
|
25581
25679
|
</details>
|
|
25582
25680
|
|
|
25583
|
-
<details><summary><code>client.tracking.
|
|
25681
|
+
<details><summary><code>client.tracking.geofenceTemplates.<a href="/src/api/resources/tracking/resources/geofenceTemplates/client/Client.ts">createV1</a>({ ...params }) -> Chrt.SessionGeofenceTemplate1</code></summary>
|
|
25584
25682
|
<dl>
|
|
25585
25683
|
<dd>
|
|
25586
25684
|
|
|
@@ -25592,7 +25690,7 @@ await client.tracking.sessions.getV1({
|
|
|
25592
25690
|
<dl>
|
|
25593
25691
|
<dd>
|
|
25594
25692
|
|
|
25595
|
-
|
|
25693
|
+
Creates a geofence template owned by the caller's organization. | authz: min_org_role=operator | (SessionGeofenceTemplateClientCreate1) -> (SessionGeofenceTemplate1)
|
|
25596
25694
|
|
|
25597
25695
|
</dd>
|
|
25598
25696
|
</dl>
|
|
@@ -25608,28 +25706,22 @@ Lists sessions with filtering, sorting, and pagination. Use org_scope to restric
|
|
|
25608
25706
|
<dd>
|
|
25609
25707
|
|
|
25610
25708
|
```typescript
|
|
25611
|
-
await client.tracking.
|
|
25612
|
-
|
|
25613
|
-
|
|
25614
|
-
|
|
25615
|
-
|
|
25616
|
-
|
|
25617
|
-
|
|
25618
|
-
|
|
25619
|
-
|
|
25620
|
-
|
|
25621
|
-
|
|
25622
|
-
|
|
25623
|
-
|
|
25624
|
-
|
|
25625
|
-
|
|
25626
|
-
|
|
25627
|
-
filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25628
|
-
filter_last_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25629
|
-
filter_termination_scheduled_for_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25630
|
-
filter_termination_scheduled_for_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25631
|
-
filter_terminated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25632
|
-
filter_terminated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25709
|
+
await client.tracking.geofenceTemplates.createV1({
|
|
25710
|
+
geofences: [
|
|
25711
|
+
{
|
|
25712
|
+
display_name: "display_name",
|
|
25713
|
+
location: {
|
|
25714
|
+
geometry: {
|
|
25715
|
+
coordinates: [],
|
|
25716
|
+
type: "Point",
|
|
25717
|
+
},
|
|
25718
|
+
type: "Feature",
|
|
25719
|
+
},
|
|
25720
|
+
radius_miles: 1.1,
|
|
25721
|
+
},
|
|
25722
|
+
],
|
|
25723
|
+
name: "name",
|
|
25724
|
+
schema_version: 1,
|
|
25633
25725
|
});
|
|
25634
25726
|
```
|
|
25635
25727
|
|
|
@@ -25646,7 +25738,7 @@ await client.tracking.sessions.listV1({
|
|
|
25646
25738
|
<dl>
|
|
25647
25739
|
<dd>
|
|
25648
25740
|
|
|
25649
|
-
**request:** `Chrt.tracking.
|
|
25741
|
+
**request:** `Chrt.tracking.SessionGeofenceTemplateClientCreate1`
|
|
25650
25742
|
|
|
25651
25743
|
</dd>
|
|
25652
25744
|
</dl>
|
|
@@ -25654,7 +25746,7 @@ await client.tracking.sessions.listV1({
|
|
|
25654
25746
|
<dl>
|
|
25655
25747
|
<dd>
|
|
25656
25748
|
|
|
25657
|
-
**requestOptions:** `
|
|
25749
|
+
**requestOptions:** `GeofenceTemplates.RequestOptions`
|
|
25658
25750
|
|
|
25659
25751
|
</dd>
|
|
25660
25752
|
</dl>
|
|
@@ -25665,7 +25757,7 @@ await client.tracking.sessions.listV1({
|
|
|
25665
25757
|
</dl>
|
|
25666
25758
|
</details>
|
|
25667
25759
|
|
|
25668
|
-
<details><summary><code>client.tracking.
|
|
25760
|
+
<details><summary><code>client.tracking.geofenceTemplates.<a href="/src/api/resources/tracking/resources/geofenceTemplates/client/Client.ts">getByIdV1</a>(geofenceTemplateId) -> Chrt.SessionGeofenceTemplate1</code></summary>
|
|
25669
25761
|
<dl>
|
|
25670
25762
|
<dd>
|
|
25671
25763
|
|
|
@@ -25677,7 +25769,7 @@ await client.tracking.sessions.listV1({
|
|
|
25677
25769
|
<dl>
|
|
25678
25770
|
<dd>
|
|
25679
25771
|
|
|
25680
|
-
|
|
25772
|
+
Retrieves a geofence template owned by the caller's organization. | authz: min_org_role=operator | () -> (SessionGeofenceTemplate1)
|
|
25681
25773
|
|
|
25682
25774
|
</dd>
|
|
25683
25775
|
</dl>
|
|
@@ -25693,20 +25785,7 @@ Replaces the session's followed flights: deletes the existing session-owned Flig
|
|
|
25693
25785
|
<dd>
|
|
25694
25786
|
|
|
25695
25787
|
```typescript
|
|
25696
|
-
await client.tracking.
|
|
25697
|
-
flight_legs: [
|
|
25698
|
-
{
|
|
25699
|
-
carrier_iata: "carrier_iata",
|
|
25700
|
-
destination_iata: "destination_iata",
|
|
25701
|
-
flight_number: "flight_number",
|
|
25702
|
-
origin_iata: "origin_iata",
|
|
25703
|
-
provenance: "manual",
|
|
25704
|
-
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
25705
|
-
schema_version: 1,
|
|
25706
|
-
},
|
|
25707
|
-
],
|
|
25708
|
-
session_id: "session_id",
|
|
25709
|
-
});
|
|
25788
|
+
await client.tracking.geofenceTemplates.getByIdV1("geofence_template_id");
|
|
25710
25789
|
```
|
|
25711
25790
|
|
|
25712
25791
|
</dd>
|
|
@@ -25722,7 +25801,7 @@ await client.tracking.sessions.setFlightInfoV1({
|
|
|
25722
25801
|
<dl>
|
|
25723
25802
|
<dd>
|
|
25724
25803
|
|
|
25725
|
-
**
|
|
25804
|
+
**geofenceTemplateId:** `string`
|
|
25726
25805
|
|
|
25727
25806
|
</dd>
|
|
25728
25807
|
</dl>
|
|
@@ -25730,7 +25809,7 @@ await client.tracking.sessions.setFlightInfoV1({
|
|
|
25730
25809
|
<dl>
|
|
25731
25810
|
<dd>
|
|
25732
25811
|
|
|
25733
|
-
**requestOptions:** `
|
|
25812
|
+
**requestOptions:** `GeofenceTemplates.RequestOptions`
|
|
25734
25813
|
|
|
25735
25814
|
</dd>
|
|
25736
25815
|
</dl>
|
|
@@ -25741,7 +25820,9 @@ await client.tracking.sessions.setFlightInfoV1({
|
|
|
25741
25820
|
</dl>
|
|
25742
25821
|
</details>
|
|
25743
25822
|
|
|
25744
|
-
|
|
25823
|
+
## Tracking Sessions
|
|
25824
|
+
|
|
25825
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">createSessionV1</a>({ ...params }) -> string</code></summary>
|
|
25745
25826
|
<dl>
|
|
25746
25827
|
<dd>
|
|
25747
25828
|
|
|
@@ -25753,7 +25834,7 @@ await client.tracking.sessions.setFlightInfoV1({
|
|
|
25753
25834
|
<dl>
|
|
25754
25835
|
<dd>
|
|
25755
25836
|
|
|
25756
|
-
|
|
25837
|
+
Creates a tracking session with ordered geofences or an organization template and links its device. | auth: api_key | authz: min_org_role=operator | (SessionsCreateV1Req) -> (PydanticObjectId)
|
|
25757
25838
|
|
|
25758
25839
|
</dd>
|
|
25759
25840
|
</dl>
|
|
@@ -25769,8 +25850,10 @@ Terminates a session. Moves device.active_session_id to device.past_session_ids
|
|
|
25769
25850
|
<dd>
|
|
25770
25851
|
|
|
25771
25852
|
```typescript
|
|
25772
|
-
await client.tracking.sessions.
|
|
25773
|
-
|
|
25853
|
+
await client.tracking.sessions.createSessionV1({
|
|
25854
|
+
device_id: "device_id",
|
|
25855
|
+
no_auto_termination: true,
|
|
25856
|
+
schema_version: 1,
|
|
25774
25857
|
});
|
|
25775
25858
|
```
|
|
25776
25859
|
|
|
@@ -25787,7 +25870,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
25787
25870
|
<dl>
|
|
25788
25871
|
<dd>
|
|
25789
25872
|
|
|
25790
|
-
**request:** `Chrt.tracking.
|
|
25873
|
+
**request:** `Chrt.tracking.SessionsCreateV1Req`
|
|
25791
25874
|
|
|
25792
25875
|
</dd>
|
|
25793
25876
|
</dl>
|
|
@@ -25806,7 +25889,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
25806
25889
|
</dl>
|
|
25807
25890
|
</details>
|
|
25808
25891
|
|
|
25809
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
25892
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">flightLegsV1</a>({ ...params }) -> Chrt.FlightLeg1[]</code></summary>
|
|
25810
25893
|
<dl>
|
|
25811
25894
|
<dd>
|
|
25812
25895
|
|
|
@@ -25818,7 +25901,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
25818
25901
|
<dl>
|
|
25819
25902
|
<dd>
|
|
25820
25903
|
|
|
25821
|
-
Returns
|
|
25904
|
+
Returns the session's flight legs in order, with Cirium-sourced status lazily resolved and refreshed on read. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (list[FlightLeg1])
|
|
25822
25905
|
|
|
25823
25906
|
</dd>
|
|
25824
25907
|
</dl>
|
|
@@ -25834,10 +25917,8 @@ Returns distinct device_mac_address and off_chrt_reference_id values matching th
|
|
|
25834
25917
|
<dd>
|
|
25835
25918
|
|
|
25836
25919
|
```typescript
|
|
25837
|
-
await client.tracking.sessions.
|
|
25838
|
-
|
|
25839
|
-
limit: 1,
|
|
25840
|
-
org_scope: "owned",
|
|
25920
|
+
await client.tracking.sessions.flightLegsV1({
|
|
25921
|
+
session_id: "session_id",
|
|
25841
25922
|
});
|
|
25842
25923
|
```
|
|
25843
25924
|
|
|
@@ -25854,7 +25935,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
25854
25935
|
<dl>
|
|
25855
25936
|
<dd>
|
|
25856
25937
|
|
|
25857
|
-
**request:** `Chrt.tracking.
|
|
25938
|
+
**request:** `Chrt.tracking.SessionsFlightLegsV1Request`
|
|
25858
25939
|
|
|
25859
25940
|
</dd>
|
|
25860
25941
|
</dl>
|
|
@@ -25873,7 +25954,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
25873
25954
|
</dl>
|
|
25874
25955
|
</details>
|
|
25875
25956
|
|
|
25876
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
25957
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">flightTrackV1</a>({ ...params }) -> Chrt.FlightTrackRes</code></summary>
|
|
25877
25958
|
<dl>
|
|
25878
25959
|
<dd>
|
|
25879
25960
|
|
|
@@ -25885,7 +25966,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
25885
25966
|
<dl>
|
|
25886
25967
|
<dd>
|
|
25887
25968
|
|
|
25888
|
-
|
|
25969
|
+
Returns the Cirium-sourced positional track for one of the session's flight legs — the live breadcrumb trail plus the planned path (waypoints + legacy route) — cached on read. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (FlightTrackRes)
|
|
25889
25970
|
|
|
25890
25971
|
</dd>
|
|
25891
25972
|
</dl>
|
|
@@ -25901,8 +25982,9 @@ Updates a session's mutable metadata (off_chrt_reference_id, comments, public, t
|
|
|
25901
25982
|
<dd>
|
|
25902
25983
|
|
|
25903
25984
|
```typescript
|
|
25904
|
-
await client.tracking.sessions.
|
|
25985
|
+
await client.tracking.sessions.flightTrackV1({
|
|
25905
25986
|
session_id: "session_id",
|
|
25987
|
+
flight_leg_id: "flight_leg_id",
|
|
25906
25988
|
});
|
|
25907
25989
|
```
|
|
25908
25990
|
|
|
@@ -25919,7 +26001,7 @@ await client.tracking.sessions.updateV1({
|
|
|
25919
26001
|
<dl>
|
|
25920
26002
|
<dd>
|
|
25921
26003
|
|
|
25922
|
-
**request:** `Chrt.tracking.
|
|
26004
|
+
**request:** `Chrt.tracking.SessionsFlightTrackV1Request`
|
|
25923
26005
|
|
|
25924
26006
|
</dd>
|
|
25925
26007
|
</dl>
|
|
@@ -25938,7 +26020,7 @@ await client.tracking.sessions.updateV1({
|
|
|
25938
26020
|
</dl>
|
|
25939
26021
|
</details>
|
|
25940
26022
|
|
|
25941
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
26023
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">getV1</a>({ ...params }) -> Chrt.Session2</code></summary>
|
|
25942
26024
|
<dl>
|
|
25943
26025
|
<dd>
|
|
25944
26026
|
|
|
@@ -25950,7 +26032,7 @@ await client.tracking.sessions.updateV1({
|
|
|
25950
26032
|
<dl>
|
|
25951
26033
|
<dd>
|
|
25952
26034
|
|
|
25953
|
-
|
|
26035
|
+
Retrieves a single session by its ID. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (Session2)
|
|
25954
26036
|
|
|
25955
26037
|
</dd>
|
|
25956
26038
|
</dl>
|
|
@@ -25966,7 +26048,7 @@ Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the
|
|
|
25966
26048
|
<dd>
|
|
25967
26049
|
|
|
25968
26050
|
```typescript
|
|
25969
|
-
await client.tracking.sessions.
|
|
26051
|
+
await client.tracking.sessions.getV1({
|
|
25970
26052
|
session_id: "session_id",
|
|
25971
26053
|
});
|
|
25972
26054
|
```
|
|
@@ -25984,7 +26066,7 @@ await client.tracking.sessions.updateSharedOrgsV1({
|
|
|
25984
26066
|
<dl>
|
|
25985
26067
|
<dd>
|
|
25986
26068
|
|
|
25987
|
-
**request:** `Chrt.tracking.
|
|
26069
|
+
**request:** `Chrt.tracking.SessionsGetV1Request`
|
|
25988
26070
|
|
|
25989
26071
|
</dd>
|
|
25990
26072
|
</dl>
|
|
@@ -26003,6 +26085,806 @@ await client.tracking.sessions.updateSharedOrgsV1({
|
|
|
26003
26085
|
</dl>
|
|
26004
26086
|
</details>
|
|
26005
26087
|
|
|
26088
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">listV1</a>({ ...params }) -> Chrt.SessionListRes</code></summary>
|
|
26089
|
+
<dl>
|
|
26090
|
+
<dd>
|
|
26091
|
+
|
|
26092
|
+
#### 📝 Description
|
|
26093
|
+
|
|
26094
|
+
<dl>
|
|
26095
|
+
<dd>
|
|
26096
|
+
|
|
26097
|
+
<dl>
|
|
26098
|
+
<dd>
|
|
26099
|
+
|
|
26100
|
+
Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (SessionListRes)
|
|
26101
|
+
|
|
26102
|
+
</dd>
|
|
26103
|
+
</dl>
|
|
26104
|
+
</dd>
|
|
26105
|
+
</dl>
|
|
26106
|
+
|
|
26107
|
+
#### 🔌 Usage
|
|
26108
|
+
|
|
26109
|
+
<dl>
|
|
26110
|
+
<dd>
|
|
26111
|
+
|
|
26112
|
+
<dl>
|
|
26113
|
+
<dd>
|
|
26114
|
+
|
|
26115
|
+
```typescript
|
|
26116
|
+
await client.tracking.sessions.listV1({
|
|
26117
|
+
sort_by: "created_at_timestamp",
|
|
26118
|
+
sort_order: "asc",
|
|
26119
|
+
page: 1,
|
|
26120
|
+
page_size: 1,
|
|
26121
|
+
search: "search",
|
|
26122
|
+
org_scope: "owned",
|
|
26123
|
+
filter_terminated: true,
|
|
26124
|
+
filter_public: true,
|
|
26125
|
+
filter_device_id: "filter_device_id",
|
|
26126
|
+
filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
|
|
26127
|
+
filter_flight_number: "filter_flight_number",
|
|
26128
|
+
filter_flight_loaded_status: "filter_flight_loaded_status",
|
|
26129
|
+
filter_has_last_seen: true,
|
|
26130
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
26131
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26132
|
+
filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
26133
|
+
filter_last_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26134
|
+
filter_termination_scheduled_for_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
26135
|
+
filter_termination_scheduled_for_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26136
|
+
filter_terminated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
26137
|
+
filter_terminated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26138
|
+
});
|
|
26139
|
+
```
|
|
26140
|
+
|
|
26141
|
+
</dd>
|
|
26142
|
+
</dl>
|
|
26143
|
+
</dd>
|
|
26144
|
+
</dl>
|
|
26145
|
+
|
|
26146
|
+
#### ⚙️ Parameters
|
|
26147
|
+
|
|
26148
|
+
<dl>
|
|
26149
|
+
<dd>
|
|
26150
|
+
|
|
26151
|
+
<dl>
|
|
26152
|
+
<dd>
|
|
26153
|
+
|
|
26154
|
+
**request:** `Chrt.tracking.SessionsListV1Request`
|
|
26155
|
+
|
|
26156
|
+
</dd>
|
|
26157
|
+
</dl>
|
|
26158
|
+
|
|
26159
|
+
<dl>
|
|
26160
|
+
<dd>
|
|
26161
|
+
|
|
26162
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
26163
|
+
|
|
26164
|
+
</dd>
|
|
26165
|
+
</dl>
|
|
26166
|
+
</dd>
|
|
26167
|
+
</dl>
|
|
26168
|
+
|
|
26169
|
+
</dd>
|
|
26170
|
+
</dl>
|
|
26171
|
+
</details>
|
|
26172
|
+
|
|
26173
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">setFlightInfoV1</a>({ ...params }) -> boolean</code></summary>
|
|
26174
|
+
<dl>
|
|
26175
|
+
<dd>
|
|
26176
|
+
|
|
26177
|
+
#### 📝 Description
|
|
26178
|
+
|
|
26179
|
+
<dl>
|
|
26180
|
+
<dd>
|
|
26181
|
+
|
|
26182
|
+
<dl>
|
|
26183
|
+
<dd>
|
|
26184
|
+
|
|
26185
|
+
Replaces the session's followed flights: deletes the existing session-owned FlightLeg documents and creates new ones from the supplied flight details. Each leg's Cirium flightId and status resolve lazily on read. Pass an empty list to clear all flights. | auth: api_key | authz: min_org_role=operator | (SessionSetFlightInfoReq1) -> (bool)
|
|
26186
|
+
|
|
26187
|
+
</dd>
|
|
26188
|
+
</dl>
|
|
26189
|
+
</dd>
|
|
26190
|
+
</dl>
|
|
26191
|
+
|
|
26192
|
+
#### 🔌 Usage
|
|
26193
|
+
|
|
26194
|
+
<dl>
|
|
26195
|
+
<dd>
|
|
26196
|
+
|
|
26197
|
+
<dl>
|
|
26198
|
+
<dd>
|
|
26199
|
+
|
|
26200
|
+
```typescript
|
|
26201
|
+
await client.tracking.sessions.setFlightInfoV1({
|
|
26202
|
+
flight_legs: [
|
|
26203
|
+
{
|
|
26204
|
+
carrier_iata: "carrier_iata",
|
|
26205
|
+
destination_iata: "destination_iata",
|
|
26206
|
+
flight_number: "flight_number",
|
|
26207
|
+
origin_iata: "origin_iata",
|
|
26208
|
+
provenance: "manual",
|
|
26209
|
+
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
26210
|
+
schema_version: 1,
|
|
26211
|
+
},
|
|
26212
|
+
],
|
|
26213
|
+
session_id: "session_id",
|
|
26214
|
+
});
|
|
26215
|
+
```
|
|
26216
|
+
|
|
26217
|
+
</dd>
|
|
26218
|
+
</dl>
|
|
26219
|
+
</dd>
|
|
26220
|
+
</dl>
|
|
26221
|
+
|
|
26222
|
+
#### ⚙️ Parameters
|
|
26223
|
+
|
|
26224
|
+
<dl>
|
|
26225
|
+
<dd>
|
|
26226
|
+
|
|
26227
|
+
<dl>
|
|
26228
|
+
<dd>
|
|
26229
|
+
|
|
26230
|
+
**request:** `Chrt.tracking.SessionSetFlightInfoReq1`
|
|
26231
|
+
|
|
26232
|
+
</dd>
|
|
26233
|
+
</dl>
|
|
26234
|
+
|
|
26235
|
+
<dl>
|
|
26236
|
+
<dd>
|
|
26237
|
+
|
|
26238
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
26239
|
+
|
|
26240
|
+
</dd>
|
|
26241
|
+
</dl>
|
|
26242
|
+
</dd>
|
|
26243
|
+
</dl>
|
|
26244
|
+
|
|
26245
|
+
</dd>
|
|
26246
|
+
</dl>
|
|
26247
|
+
</details>
|
|
26248
|
+
|
|
26249
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">terminateV1</a>({ ...params }) -> boolean</code></summary>
|
|
26250
|
+
<dl>
|
|
26251
|
+
<dd>
|
|
26252
|
+
|
|
26253
|
+
#### 📝 Description
|
|
26254
|
+
|
|
26255
|
+
<dl>
|
|
26256
|
+
<dd>
|
|
26257
|
+
|
|
26258
|
+
<dl>
|
|
26259
|
+
<dd>
|
|
26260
|
+
|
|
26261
|
+
Terminates a session. Moves device.active_session_id to device.past_session_ids and deactivates the device. | auth: api_key | () -> (bool)
|
|
26262
|
+
|
|
26263
|
+
</dd>
|
|
26264
|
+
</dl>
|
|
26265
|
+
</dd>
|
|
26266
|
+
</dl>
|
|
26267
|
+
|
|
26268
|
+
#### 🔌 Usage
|
|
26269
|
+
|
|
26270
|
+
<dl>
|
|
26271
|
+
<dd>
|
|
26272
|
+
|
|
26273
|
+
<dl>
|
|
26274
|
+
<dd>
|
|
26275
|
+
|
|
26276
|
+
```typescript
|
|
26277
|
+
await client.tracking.sessions.terminateV1({
|
|
26278
|
+
session_id: "session_id",
|
|
26279
|
+
});
|
|
26280
|
+
```
|
|
26281
|
+
|
|
26282
|
+
</dd>
|
|
26283
|
+
</dl>
|
|
26284
|
+
</dd>
|
|
26285
|
+
</dl>
|
|
26286
|
+
|
|
26287
|
+
#### ⚙️ Parameters
|
|
26288
|
+
|
|
26289
|
+
<dl>
|
|
26290
|
+
<dd>
|
|
26291
|
+
|
|
26292
|
+
<dl>
|
|
26293
|
+
<dd>
|
|
26294
|
+
|
|
26295
|
+
**request:** `Chrt.tracking.SessionsTerminateV1Request`
|
|
26296
|
+
|
|
26297
|
+
</dd>
|
|
26298
|
+
</dl>
|
|
26299
|
+
|
|
26300
|
+
<dl>
|
|
26301
|
+
<dd>
|
|
26302
|
+
|
|
26303
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
26304
|
+
|
|
26305
|
+
</dd>
|
|
26306
|
+
</dl>
|
|
26307
|
+
</dd>
|
|
26308
|
+
</dl>
|
|
26309
|
+
|
|
26310
|
+
</dd>
|
|
26311
|
+
</dl>
|
|
26312
|
+
</details>
|
|
26313
|
+
|
|
26314
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TrackingTypeaheadResult[]</code></summary>
|
|
26315
|
+
<dl>
|
|
26316
|
+
<dd>
|
|
26317
|
+
|
|
26318
|
+
#### 📝 Description
|
|
26319
|
+
|
|
26320
|
+
<dl>
|
|
26321
|
+
<dd>
|
|
26322
|
+
|
|
26323
|
+
<dl>
|
|
26324
|
+
<dd>
|
|
26325
|
+
|
|
26326
|
+
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching sessions. Use org_scope to restrict to owned, shared, or both (default). | auth: api_key | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
26327
|
+
|
|
26328
|
+
</dd>
|
|
26329
|
+
</dl>
|
|
26330
|
+
</dd>
|
|
26331
|
+
</dl>
|
|
26332
|
+
|
|
26333
|
+
#### 🔌 Usage
|
|
26334
|
+
|
|
26335
|
+
<dl>
|
|
26336
|
+
<dd>
|
|
26337
|
+
|
|
26338
|
+
<dl>
|
|
26339
|
+
<dd>
|
|
26340
|
+
|
|
26341
|
+
```typescript
|
|
26342
|
+
await client.tracking.sessions.typeaheadV1({
|
|
26343
|
+
query: "query",
|
|
26344
|
+
limit: 1,
|
|
26345
|
+
org_scope: "owned",
|
|
26346
|
+
});
|
|
26347
|
+
```
|
|
26348
|
+
|
|
26349
|
+
</dd>
|
|
26350
|
+
</dl>
|
|
26351
|
+
</dd>
|
|
26352
|
+
</dl>
|
|
26353
|
+
|
|
26354
|
+
#### ⚙️ Parameters
|
|
26355
|
+
|
|
26356
|
+
<dl>
|
|
26357
|
+
<dd>
|
|
26358
|
+
|
|
26359
|
+
<dl>
|
|
26360
|
+
<dd>
|
|
26361
|
+
|
|
26362
|
+
**request:** `Chrt.tracking.SessionsTypeaheadV1Request`
|
|
26363
|
+
|
|
26364
|
+
</dd>
|
|
26365
|
+
</dl>
|
|
26366
|
+
|
|
26367
|
+
<dl>
|
|
26368
|
+
<dd>
|
|
26369
|
+
|
|
26370
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
26371
|
+
|
|
26372
|
+
</dd>
|
|
26373
|
+
</dl>
|
|
26374
|
+
</dd>
|
|
26375
|
+
</dl>
|
|
26376
|
+
|
|
26377
|
+
</dd>
|
|
26378
|
+
</dl>
|
|
26379
|
+
</details>
|
|
26380
|
+
|
|
26381
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
26382
|
+
<dl>
|
|
26383
|
+
<dd>
|
|
26384
|
+
|
|
26385
|
+
#### 📝 Description
|
|
26386
|
+
|
|
26387
|
+
<dl>
|
|
26388
|
+
<dd>
|
|
26389
|
+
|
|
26390
|
+
<dl>
|
|
26391
|
+
<dd>
|
|
26392
|
+
|
|
26393
|
+
Updates mutable non-geofence session fields. Use dedicated geofence routes for geofence changes. | auth: api_key | authz: min_org_role=operator | (SessionClientUpdate2) -> (bool)
|
|
26394
|
+
|
|
26395
|
+
</dd>
|
|
26396
|
+
</dl>
|
|
26397
|
+
</dd>
|
|
26398
|
+
</dl>
|
|
26399
|
+
|
|
26400
|
+
#### 🔌 Usage
|
|
26401
|
+
|
|
26402
|
+
<dl>
|
|
26403
|
+
<dd>
|
|
26404
|
+
|
|
26405
|
+
<dl>
|
|
26406
|
+
<dd>
|
|
26407
|
+
|
|
26408
|
+
```typescript
|
|
26409
|
+
await client.tracking.sessions.updateV1({
|
|
26410
|
+
session_id: "session_id",
|
|
26411
|
+
});
|
|
26412
|
+
```
|
|
26413
|
+
|
|
26414
|
+
</dd>
|
|
26415
|
+
</dl>
|
|
26416
|
+
</dd>
|
|
26417
|
+
</dl>
|
|
26418
|
+
|
|
26419
|
+
#### ⚙️ Parameters
|
|
26420
|
+
|
|
26421
|
+
<dl>
|
|
26422
|
+
<dd>
|
|
26423
|
+
|
|
26424
|
+
<dl>
|
|
26425
|
+
<dd>
|
|
26426
|
+
|
|
26427
|
+
**request:** `Chrt.tracking.SessionClientUpdate2`
|
|
26428
|
+
|
|
26429
|
+
</dd>
|
|
26430
|
+
</dl>
|
|
26431
|
+
|
|
26432
|
+
<dl>
|
|
26433
|
+
<dd>
|
|
26434
|
+
|
|
26435
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
26436
|
+
|
|
26437
|
+
</dd>
|
|
26438
|
+
</dl>
|
|
26439
|
+
</dd>
|
|
26440
|
+
</dl>
|
|
26441
|
+
|
|
26442
|
+
</dd>
|
|
26443
|
+
</dl>
|
|
26444
|
+
</details>
|
|
26445
|
+
|
|
26446
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">updateSharedOrgsV1</a>({ ...params }) -> boolean</code></summary>
|
|
26447
|
+
<dl>
|
|
26448
|
+
<dd>
|
|
26449
|
+
|
|
26450
|
+
#### 📝 Description
|
|
26451
|
+
|
|
26452
|
+
<dl>
|
|
26453
|
+
<dd>
|
|
26454
|
+
|
|
26455
|
+
<dl>
|
|
26456
|
+
<dd>
|
|
26457
|
+
|
|
26458
|
+
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)
|
|
26459
|
+
|
|
26460
|
+
</dd>
|
|
26461
|
+
</dl>
|
|
26462
|
+
</dd>
|
|
26463
|
+
</dl>
|
|
26464
|
+
|
|
26465
|
+
#### 🔌 Usage
|
|
26466
|
+
|
|
26467
|
+
<dl>
|
|
26468
|
+
<dd>
|
|
26469
|
+
|
|
26470
|
+
<dl>
|
|
26471
|
+
<dd>
|
|
26472
|
+
|
|
26473
|
+
```typescript
|
|
26474
|
+
await client.tracking.sessions.updateSharedOrgsV1({
|
|
26475
|
+
session_id: "session_id",
|
|
26476
|
+
});
|
|
26477
|
+
```
|
|
26478
|
+
|
|
26479
|
+
</dd>
|
|
26480
|
+
</dl>
|
|
26481
|
+
</dd>
|
|
26482
|
+
</dl>
|
|
26483
|
+
|
|
26484
|
+
#### ⚙️ Parameters
|
|
26485
|
+
|
|
26486
|
+
<dl>
|
|
26487
|
+
<dd>
|
|
26488
|
+
|
|
26489
|
+
<dl>
|
|
26490
|
+
<dd>
|
|
26491
|
+
|
|
26492
|
+
**request:** `Chrt.tracking.SessionsUpdateSharedOrgsReq1`
|
|
26493
|
+
|
|
26494
|
+
</dd>
|
|
26495
|
+
</dl>
|
|
26496
|
+
|
|
26497
|
+
<dl>
|
|
26498
|
+
<dd>
|
|
26499
|
+
|
|
26500
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
26501
|
+
|
|
26502
|
+
</dd>
|
|
26503
|
+
</dl>
|
|
26504
|
+
</dd>
|
|
26505
|
+
</dl>
|
|
26506
|
+
|
|
26507
|
+
</dd>
|
|
26508
|
+
</dl>
|
|
26509
|
+
</details>
|
|
26510
|
+
|
|
26511
|
+
## Tracking SessionGeofences
|
|
26512
|
+
|
|
26513
|
+
<details><summary><code>client.tracking.sessionGeofences.<a href="/src/api/resources/tracking/resources/sessionGeofences/client/Client.ts">addV1</a>(sessionId, { ...params }) -> Chrt.Session2</code></summary>
|
|
26514
|
+
<dl>
|
|
26515
|
+
<dd>
|
|
26516
|
+
|
|
26517
|
+
#### 📝 Description
|
|
26518
|
+
|
|
26519
|
+
<dl>
|
|
26520
|
+
<dd>
|
|
26521
|
+
|
|
26522
|
+
<dl>
|
|
26523
|
+
<dd>
|
|
26524
|
+
|
|
26525
|
+
Adds a geofence to an active session. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceClientCreate1) -> (Session2)
|
|
26526
|
+
|
|
26527
|
+
</dd>
|
|
26528
|
+
</dl>
|
|
26529
|
+
</dd>
|
|
26530
|
+
</dl>
|
|
26531
|
+
|
|
26532
|
+
#### 🔌 Usage
|
|
26533
|
+
|
|
26534
|
+
<dl>
|
|
26535
|
+
<dd>
|
|
26536
|
+
|
|
26537
|
+
<dl>
|
|
26538
|
+
<dd>
|
|
26539
|
+
|
|
26540
|
+
```typescript
|
|
26541
|
+
await client.tracking.sessionGeofences.addV1("session_id", {
|
|
26542
|
+
display_name: "display_name",
|
|
26543
|
+
location: {
|
|
26544
|
+
geometry: {
|
|
26545
|
+
coordinates: [],
|
|
26546
|
+
type: "Point",
|
|
26547
|
+
},
|
|
26548
|
+
type: "Feature",
|
|
26549
|
+
},
|
|
26550
|
+
radius_miles: 1.1,
|
|
26551
|
+
});
|
|
26552
|
+
```
|
|
26553
|
+
|
|
26554
|
+
</dd>
|
|
26555
|
+
</dl>
|
|
26556
|
+
</dd>
|
|
26557
|
+
</dl>
|
|
26558
|
+
|
|
26559
|
+
#### ⚙️ Parameters
|
|
26560
|
+
|
|
26561
|
+
<dl>
|
|
26562
|
+
<dd>
|
|
26563
|
+
|
|
26564
|
+
<dl>
|
|
26565
|
+
<dd>
|
|
26566
|
+
|
|
26567
|
+
**sessionId:** `string`
|
|
26568
|
+
|
|
26569
|
+
</dd>
|
|
26570
|
+
</dl>
|
|
26571
|
+
|
|
26572
|
+
<dl>
|
|
26573
|
+
<dd>
|
|
26574
|
+
|
|
26575
|
+
**request:** `Chrt.SessionGeofenceClientCreate1`
|
|
26576
|
+
|
|
26577
|
+
</dd>
|
|
26578
|
+
</dl>
|
|
26579
|
+
|
|
26580
|
+
<dl>
|
|
26581
|
+
<dd>
|
|
26582
|
+
|
|
26583
|
+
**requestOptions:** `SessionGeofences.RequestOptions`
|
|
26584
|
+
|
|
26585
|
+
</dd>
|
|
26586
|
+
</dl>
|
|
26587
|
+
</dd>
|
|
26588
|
+
</dl>
|
|
26589
|
+
|
|
26590
|
+
</dd>
|
|
26591
|
+
</dl>
|
|
26592
|
+
</details>
|
|
26593
|
+
|
|
26594
|
+
<details><summary><code>client.tracking.sessionGeofences.<a href="/src/api/resources/tracking/resources/sessionGeofences/client/Client.ts">applyTemplateV1</a>(sessionId, { ...params }) -> Chrt.Session2</code></summary>
|
|
26595
|
+
<dl>
|
|
26596
|
+
<dd>
|
|
26597
|
+
|
|
26598
|
+
#### 📝 Description
|
|
26599
|
+
|
|
26600
|
+
<dl>
|
|
26601
|
+
<dd>
|
|
26602
|
+
|
|
26603
|
+
<dl>
|
|
26604
|
+
<dd>
|
|
26605
|
+
|
|
26606
|
+
Replaces an active session's geofences from an active organization template. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceApplyTemplateReq) -> (Session2)
|
|
26607
|
+
|
|
26608
|
+
</dd>
|
|
26609
|
+
</dl>
|
|
26610
|
+
</dd>
|
|
26611
|
+
</dl>
|
|
26612
|
+
|
|
26613
|
+
#### 🔌 Usage
|
|
26614
|
+
|
|
26615
|
+
<dl>
|
|
26616
|
+
<dd>
|
|
26617
|
+
|
|
26618
|
+
<dl>
|
|
26619
|
+
<dd>
|
|
26620
|
+
|
|
26621
|
+
```typescript
|
|
26622
|
+
await client.tracking.sessionGeofences.applyTemplateV1("session_id", {
|
|
26623
|
+
geofence_template_id: "geofence_template_id",
|
|
26624
|
+
});
|
|
26625
|
+
```
|
|
26626
|
+
|
|
26627
|
+
</dd>
|
|
26628
|
+
</dl>
|
|
26629
|
+
</dd>
|
|
26630
|
+
</dl>
|
|
26631
|
+
|
|
26632
|
+
#### ⚙️ Parameters
|
|
26633
|
+
|
|
26634
|
+
<dl>
|
|
26635
|
+
<dd>
|
|
26636
|
+
|
|
26637
|
+
<dl>
|
|
26638
|
+
<dd>
|
|
26639
|
+
|
|
26640
|
+
**sessionId:** `string`
|
|
26641
|
+
|
|
26642
|
+
</dd>
|
|
26643
|
+
</dl>
|
|
26644
|
+
|
|
26645
|
+
<dl>
|
|
26646
|
+
<dd>
|
|
26647
|
+
|
|
26648
|
+
**request:** `Chrt.tracking.SessionGeofenceApplyTemplateReq`
|
|
26649
|
+
|
|
26650
|
+
</dd>
|
|
26651
|
+
</dl>
|
|
26652
|
+
|
|
26653
|
+
<dl>
|
|
26654
|
+
<dd>
|
|
26655
|
+
|
|
26656
|
+
**requestOptions:** `SessionGeofences.RequestOptions`
|
|
26657
|
+
|
|
26658
|
+
</dd>
|
|
26659
|
+
</dl>
|
|
26660
|
+
</dd>
|
|
26661
|
+
</dl>
|
|
26662
|
+
|
|
26663
|
+
</dd>
|
|
26664
|
+
</dl>
|
|
26665
|
+
</details>
|
|
26666
|
+
|
|
26667
|
+
<details><summary><code>client.tracking.sessionGeofences.<a href="/src/api/resources/tracking/resources/sessionGeofences/client/Client.ts">reorderV1</a>(sessionId, { ...params }) -> Chrt.Session2</code></summary>
|
|
26668
|
+
<dl>
|
|
26669
|
+
<dd>
|
|
26670
|
+
|
|
26671
|
+
#### 📝 Description
|
|
26672
|
+
|
|
26673
|
+
<dl>
|
|
26674
|
+
<dd>
|
|
26675
|
+
|
|
26676
|
+
<dl>
|
|
26677
|
+
<dd>
|
|
26678
|
+
|
|
26679
|
+
Reorders an active session's geofences using an exact ID permutation. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceReorderReq) -> (Session2)
|
|
26680
|
+
|
|
26681
|
+
</dd>
|
|
26682
|
+
</dl>
|
|
26683
|
+
</dd>
|
|
26684
|
+
</dl>
|
|
26685
|
+
|
|
26686
|
+
#### 🔌 Usage
|
|
26687
|
+
|
|
26688
|
+
<dl>
|
|
26689
|
+
<dd>
|
|
26690
|
+
|
|
26691
|
+
<dl>
|
|
26692
|
+
<dd>
|
|
26693
|
+
|
|
26694
|
+
```typescript
|
|
26695
|
+
await client.tracking.sessionGeofences.reorderV1("session_id");
|
|
26696
|
+
```
|
|
26697
|
+
|
|
26698
|
+
</dd>
|
|
26699
|
+
</dl>
|
|
26700
|
+
</dd>
|
|
26701
|
+
</dl>
|
|
26702
|
+
|
|
26703
|
+
#### ⚙️ Parameters
|
|
26704
|
+
|
|
26705
|
+
<dl>
|
|
26706
|
+
<dd>
|
|
26707
|
+
|
|
26708
|
+
<dl>
|
|
26709
|
+
<dd>
|
|
26710
|
+
|
|
26711
|
+
**sessionId:** `string`
|
|
26712
|
+
|
|
26713
|
+
</dd>
|
|
26714
|
+
</dl>
|
|
26715
|
+
|
|
26716
|
+
<dl>
|
|
26717
|
+
<dd>
|
|
26718
|
+
|
|
26719
|
+
**request:** `Chrt.tracking.SessionGeofenceReorderReq`
|
|
26720
|
+
|
|
26721
|
+
</dd>
|
|
26722
|
+
</dl>
|
|
26723
|
+
|
|
26724
|
+
<dl>
|
|
26725
|
+
<dd>
|
|
26726
|
+
|
|
26727
|
+
**requestOptions:** `SessionGeofences.RequestOptions`
|
|
26728
|
+
|
|
26729
|
+
</dd>
|
|
26730
|
+
</dl>
|
|
26731
|
+
</dd>
|
|
26732
|
+
</dl>
|
|
26733
|
+
|
|
26734
|
+
</dd>
|
|
26735
|
+
</dl>
|
|
26736
|
+
</details>
|
|
26737
|
+
|
|
26738
|
+
<details><summary><code>client.tracking.sessionGeofences.<a href="/src/api/resources/tracking/resources/sessionGeofences/client/Client.ts">updateV1</a>(sessionId, geofenceId, { ...params }) -> Chrt.Session2</code></summary>
|
|
26739
|
+
<dl>
|
|
26740
|
+
<dd>
|
|
26741
|
+
|
|
26742
|
+
#### 📝 Description
|
|
26743
|
+
|
|
26744
|
+
<dl>
|
|
26745
|
+
<dd>
|
|
26746
|
+
|
|
26747
|
+
<dl>
|
|
26748
|
+
<dd>
|
|
26749
|
+
|
|
26750
|
+
Updates a session geofence, resetting entry state only when location or radius changes. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceClientUpdate1) -> (Session2)
|
|
26751
|
+
|
|
26752
|
+
</dd>
|
|
26753
|
+
</dl>
|
|
26754
|
+
</dd>
|
|
26755
|
+
</dl>
|
|
26756
|
+
|
|
26757
|
+
#### 🔌 Usage
|
|
26758
|
+
|
|
26759
|
+
<dl>
|
|
26760
|
+
<dd>
|
|
26761
|
+
|
|
26762
|
+
<dl>
|
|
26763
|
+
<dd>
|
|
26764
|
+
|
|
26765
|
+
```typescript
|
|
26766
|
+
await client.tracking.sessionGeofences.updateV1("session_id", "geofence_id");
|
|
26767
|
+
```
|
|
26768
|
+
|
|
26769
|
+
</dd>
|
|
26770
|
+
</dl>
|
|
26771
|
+
</dd>
|
|
26772
|
+
</dl>
|
|
26773
|
+
|
|
26774
|
+
#### ⚙️ Parameters
|
|
26775
|
+
|
|
26776
|
+
<dl>
|
|
26777
|
+
<dd>
|
|
26778
|
+
|
|
26779
|
+
<dl>
|
|
26780
|
+
<dd>
|
|
26781
|
+
|
|
26782
|
+
**sessionId:** `string`
|
|
26783
|
+
|
|
26784
|
+
</dd>
|
|
26785
|
+
</dl>
|
|
26786
|
+
|
|
26787
|
+
<dl>
|
|
26788
|
+
<dd>
|
|
26789
|
+
|
|
26790
|
+
**geofenceId:** `string`
|
|
26791
|
+
|
|
26792
|
+
</dd>
|
|
26793
|
+
</dl>
|
|
26794
|
+
|
|
26795
|
+
<dl>
|
|
26796
|
+
<dd>
|
|
26797
|
+
|
|
26798
|
+
**request:** `Chrt.tracking.SessionGeofenceClientUpdate1`
|
|
26799
|
+
|
|
26800
|
+
</dd>
|
|
26801
|
+
</dl>
|
|
26802
|
+
|
|
26803
|
+
<dl>
|
|
26804
|
+
<dd>
|
|
26805
|
+
|
|
26806
|
+
**requestOptions:** `SessionGeofences.RequestOptions`
|
|
26807
|
+
|
|
26808
|
+
</dd>
|
|
26809
|
+
</dl>
|
|
26810
|
+
</dd>
|
|
26811
|
+
</dl>
|
|
26812
|
+
|
|
26813
|
+
</dd>
|
|
26814
|
+
</dl>
|
|
26815
|
+
</details>
|
|
26816
|
+
|
|
26817
|
+
<details><summary><code>client.tracking.sessionGeofences.<a href="/src/api/resources/tracking/resources/sessionGeofences/client/Client.ts">removeV1</a>(sessionId, geofenceId) -> Chrt.Session2</code></summary>
|
|
26818
|
+
<dl>
|
|
26819
|
+
<dd>
|
|
26820
|
+
|
|
26821
|
+
#### 📝 Description
|
|
26822
|
+
|
|
26823
|
+
<dl>
|
|
26824
|
+
<dd>
|
|
26825
|
+
|
|
26826
|
+
<dl>
|
|
26827
|
+
<dd>
|
|
26828
|
+
|
|
26829
|
+
Removes a geofence from an active session. | auth: api_key | authz: min_org_role=operator | () -> (Session2)
|
|
26830
|
+
|
|
26831
|
+
</dd>
|
|
26832
|
+
</dl>
|
|
26833
|
+
</dd>
|
|
26834
|
+
</dl>
|
|
26835
|
+
|
|
26836
|
+
#### 🔌 Usage
|
|
26837
|
+
|
|
26838
|
+
<dl>
|
|
26839
|
+
<dd>
|
|
26840
|
+
|
|
26841
|
+
<dl>
|
|
26842
|
+
<dd>
|
|
26843
|
+
|
|
26844
|
+
```typescript
|
|
26845
|
+
await client.tracking.sessionGeofences.removeV1("session_id", "geofence_id");
|
|
26846
|
+
```
|
|
26847
|
+
|
|
26848
|
+
</dd>
|
|
26849
|
+
</dl>
|
|
26850
|
+
</dd>
|
|
26851
|
+
</dl>
|
|
26852
|
+
|
|
26853
|
+
#### ⚙️ Parameters
|
|
26854
|
+
|
|
26855
|
+
<dl>
|
|
26856
|
+
<dd>
|
|
26857
|
+
|
|
26858
|
+
<dl>
|
|
26859
|
+
<dd>
|
|
26860
|
+
|
|
26861
|
+
**sessionId:** `string`
|
|
26862
|
+
|
|
26863
|
+
</dd>
|
|
26864
|
+
</dl>
|
|
26865
|
+
|
|
26866
|
+
<dl>
|
|
26867
|
+
<dd>
|
|
26868
|
+
|
|
26869
|
+
**geofenceId:** `string`
|
|
26870
|
+
|
|
26871
|
+
</dd>
|
|
26872
|
+
</dl>
|
|
26873
|
+
|
|
26874
|
+
<dl>
|
|
26875
|
+
<dd>
|
|
26876
|
+
|
|
26877
|
+
**requestOptions:** `SessionGeofences.RequestOptions`
|
|
26878
|
+
|
|
26879
|
+
</dd>
|
|
26880
|
+
</dl>
|
|
26881
|
+
</dd>
|
|
26882
|
+
</dl>
|
|
26883
|
+
|
|
26884
|
+
</dd>
|
|
26885
|
+
</dl>
|
|
26886
|
+
</details>
|
|
26887
|
+
|
|
26006
26888
|
## Tracking SharingSettings
|
|
26007
26889
|
|
|
26008
26890
|
<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderRef) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
|