@chrt-inc/typescript-sdk 1.762.0 → 1.788.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/lineItemGroups/client/Client.d.ts +18 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +67 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupSharedTaskGroupMileageCreateClientReq.d.ts +23 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.d.ts +36 -2
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js +138 -1
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.d.ts +46 -9
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.js +148 -16
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListClientCreate1.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListReorderEntries1.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +2 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts +3 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.ts +4 -0
- package/dist/cjs/api/types/LineItem1.d.ts +1 -0
- package/dist/cjs/api/types/NotificationEventsForAdHocEnum.d.ts +4 -3
- package/dist/cjs/api/types/NotificationEventsForAdHocEnum.js +1 -0
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +2 -1
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +1 -0
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +2 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +1 -0
- package/dist/cjs/api/types/NotificationIntentAdHoc1.d.ts +2 -1
- package/dist/cjs/api/{resources/notifications/resources/adHoc/client/requests → types}/NotificationIntentAdHocClientCreate1.d.ts +1 -8
- package/dist/cjs/api/types/NotificationIntentAdHocClientCreate1.js +5 -0
- package/dist/cjs/api/types/OnboardCourierTaskActionEnum1.d.ts +1 -11
- package/dist/cjs/api/types/OnboardCourierTaskActionEnum1.js +0 -10
- package/dist/cjs/api/types/OperationsTaskListEntry1.d.ts +4 -12
- package/dist/cjs/api/types/OperationsTaskListEntryClientCreate1.d.ts +15 -0
- package/dist/cjs/api/types/OperationsTaskListEntryClientCreate1.js +5 -0
- package/dist/cjs/api/types/OrderTemplate1.d.ts +1 -0
- package/dist/cjs/api/types/OrderTemplateCore1.d.ts +1 -0
- package/dist/cjs/api/types/Session1.d.ts +3 -0
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.ts +10 -0
- package/dist/cjs/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.js +5 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -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/lineItemGroups/client/Client.d.mts +18 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +67 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupSharedTaskGroupMileageCreateClientReq.d.mts +23 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.d.mts +36 -2
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs +138 -1
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.d.mts +14 -0
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.d.mts +46 -9
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.mjs +148 -16
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListClientCreate1.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListReorderEntries1.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +2 -2
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.mts +3 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.mts +4 -0
- package/dist/esm/api/types/LineItem1.d.mts +1 -0
- package/dist/esm/api/types/NotificationEventsForAdHocEnum.d.mts +4 -3
- package/dist/esm/api/types/NotificationEventsForAdHocEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +2 -1
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +2 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationIntentAdHoc1.d.mts +2 -1
- package/dist/esm/api/{resources/notifications/resources/adHoc/client/requests → types}/NotificationIntentAdHocClientCreate1.d.mts +1 -8
- package/dist/esm/api/types/NotificationIntentAdHocClientCreate1.mjs +4 -0
- package/dist/esm/api/types/OnboardCourierTaskActionEnum1.d.mts +1 -11
- package/dist/esm/api/types/OnboardCourierTaskActionEnum1.mjs +0 -10
- package/dist/esm/api/types/OperationsTaskListEntry1.d.mts +4 -12
- package/dist/esm/api/types/OperationsTaskListEntryClientCreate1.d.mts +15 -0
- package/dist/esm/api/types/OperationsTaskListEntryClientCreate1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplate1.d.mts +1 -0
- package/dist/esm/api/types/OrderTemplateCore1.d.mts +1 -0
- package/dist/esm/api/types/Session1.d.mts +3 -0
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.mts +10 -0
- package/dist/esm/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +384 -10
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.d.ts +0 -11
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.d.mts +0 -11
- /package/dist/cjs/api/resources/{notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.js → billing/resources/lineItemGroups/client/requests/LineItemGroupSharedTaskGroupMileageCreateClientReq.js} +0 -0
- /package/dist/cjs/api/resources/{operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.js → notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.js} +0 -0
- /package/dist/esm/api/resources/{notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.mjs → billing/resources/lineItemGroups/client/requests/LineItemGroupSharedTaskGroupMileageCreateClientReq.mjs} +0 -0
- /package/dist/esm/api/resources/{operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.mjs → notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.mjs} +0 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export interface TrackingSessionDestinationGeofenceEnteredWebhookPayload {
|
|
5
|
+
event_type?: "tracking.session.destination_geofence_entered";
|
|
6
|
+
/** UTC timestamp when the event occurred */
|
|
7
|
+
event_timestamp: string;
|
|
8
|
+
/** The tracking session whose tracker entered the destination geofence */
|
|
9
|
+
session_id: string;
|
|
10
|
+
}
|
|
@@ -210,6 +210,7 @@ export * from "./NotificationGroupLimitedForDriver1.mjs";
|
|
|
210
210
|
export * from "./NotificationGroupListRes.mjs";
|
|
211
211
|
export * from "./NotificationGroupUserListRes.mjs";
|
|
212
212
|
export * from "./NotificationIntentAdHoc1.mjs";
|
|
213
|
+
export * from "./NotificationIntentAdHocClientCreate1.mjs";
|
|
213
214
|
export * from "./NotificationUserPreferences1.mjs";
|
|
214
215
|
export * from "./OffChrtProviderOrg1.mjs";
|
|
215
216
|
export * from "./OffChrtProviderOrgListRes.mjs";
|
|
@@ -228,6 +229,7 @@ export * from "./OperationsTask1.mjs";
|
|
|
228
229
|
export * from "./OperationsTaskComment1.mjs";
|
|
229
230
|
export * from "./OperationsTaskList1.mjs";
|
|
230
231
|
export * from "./OperationsTaskListEntry1.mjs";
|
|
232
|
+
export * from "./OperationsTaskListEntryClientCreate1.mjs";
|
|
231
233
|
export * from "./OperationsTaskListListRes.mjs";
|
|
232
234
|
export * from "./OperationsTaskListRemoveFromCaseRes1.mjs";
|
|
233
235
|
export * from "./OperationsTaskListRes.mjs";
|
|
@@ -405,6 +407,7 @@ export * from "./TiveTimeseriesRes.mjs";
|
|
|
405
407
|
export * from "./TiveTimeseriesSyncRes.mjs";
|
|
406
408
|
export * from "./TrackingDeviceTypeEnum1.mjs";
|
|
407
409
|
export * from "./TrackingOrgScopeEnum.mjs";
|
|
410
|
+
export * from "./TrackingSessionDestinationGeofenceEnteredWebhookPayload.mjs";
|
|
408
411
|
export * from "./TrackingSharingSettingsRes.mjs";
|
|
409
412
|
export * from "./TrackingTypeaheadFieldEnum.mjs";
|
|
410
413
|
export * from "./TrackingTypeaheadResult.mjs";
|
|
@@ -210,6 +210,7 @@ export * from "./NotificationGroupLimitedForDriver1.mjs";
|
|
|
210
210
|
export * from "./NotificationGroupListRes.mjs";
|
|
211
211
|
export * from "./NotificationGroupUserListRes.mjs";
|
|
212
212
|
export * from "./NotificationIntentAdHoc1.mjs";
|
|
213
|
+
export * from "./NotificationIntentAdHocClientCreate1.mjs";
|
|
213
214
|
export * from "./NotificationUserPreferences1.mjs";
|
|
214
215
|
export * from "./OffChrtProviderOrg1.mjs";
|
|
215
216
|
export * from "./OffChrtProviderOrgListRes.mjs";
|
|
@@ -228,6 +229,7 @@ export * from "./OperationsTask1.mjs";
|
|
|
228
229
|
export * from "./OperationsTaskComment1.mjs";
|
|
229
230
|
export * from "./OperationsTaskList1.mjs";
|
|
230
231
|
export * from "./OperationsTaskListEntry1.mjs";
|
|
232
|
+
export * from "./OperationsTaskListEntryClientCreate1.mjs";
|
|
231
233
|
export * from "./OperationsTaskListListRes.mjs";
|
|
232
234
|
export * from "./OperationsTaskListRemoveFromCaseRes1.mjs";
|
|
233
235
|
export * from "./OperationsTaskListRes.mjs";
|
|
@@ -405,6 +407,7 @@ export * from "./TiveTimeseriesRes.mjs";
|
|
|
405
407
|
export * from "./TiveTimeseriesSyncRes.mjs";
|
|
406
408
|
export * from "./TrackingDeviceTypeEnum1.mjs";
|
|
407
409
|
export * from "./TrackingOrgScopeEnum.mjs";
|
|
410
|
+
export * from "./TrackingSessionDestinationGeofenceEnteredWebhookPayload.mjs";
|
|
408
411
|
export * from "./TrackingSharingSettingsRes.mjs";
|
|
409
412
|
export * from "./TrackingTypeaheadFieldEnum.mjs";
|
|
410
413
|
export * from "./TrackingTypeaheadResult.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.788.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.788.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -2090,6 +2090,74 @@ await client.billing.lineItemGroups.fromRateSheetCreateForProviderPayDriverV1({
|
|
|
2090
2090
|
</dl>
|
|
2091
2091
|
</details>
|
|
2092
2092
|
|
|
2093
|
+
<details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">sharedTaskGroupMileageCreateV1</a>({ ...params }) -> Chrt.LineItemGroup1</code></summary>
|
|
2094
|
+
<dl>
|
|
2095
|
+
<dd>
|
|
2096
|
+
|
|
2097
|
+
#### 📝 Description
|
|
2098
|
+
|
|
2099
|
+
<dl>
|
|
2100
|
+
<dd>
|
|
2101
|
+
|
|
2102
|
+
<dl>
|
|
2103
|
+
<dd>
|
|
2104
|
+
|
|
2105
|
+
Prices a single driver's combined trip across several task groups once. Recomputes route mileage from the ordered task locations (plus optional start/end legs), applies the CHRT-ground rate sheet, and atomically creates an OrderGroup-anchored LineItemGroup, its mileage LineItems, and the LineItemCalculation that records how the charges were derived. The LIG is detached on create (task_group_id is None) — attach to a Statement afterwards. | authz: allowed_org_types=[provider], min_org_role=operator | (LineItemGroupSharedTaskGroupMileageCreateClientReq) -> (LineItemGroup1)
|
|
2106
|
+
|
|
2107
|
+
</dd>
|
|
2108
|
+
</dl>
|
|
2109
|
+
</dd>
|
|
2110
|
+
</dl>
|
|
2111
|
+
|
|
2112
|
+
#### 🔌 Usage
|
|
2113
|
+
|
|
2114
|
+
<dl>
|
|
2115
|
+
<dd>
|
|
2116
|
+
|
|
2117
|
+
<dl>
|
|
2118
|
+
<dd>
|
|
2119
|
+
|
|
2120
|
+
```typescript
|
|
2121
|
+
await client.billing.lineItemGroups.sharedTaskGroupMileageCreateV1({
|
|
2122
|
+
order_group_id: "order_group_id",
|
|
2123
|
+
rate_sheet_id: "rate_sheet_id",
|
|
2124
|
+
payment_destination_driver_id: "payment_destination_driver_id",
|
|
2125
|
+
task_ids: ["task_ids"],
|
|
2126
|
+
});
|
|
2127
|
+
```
|
|
2128
|
+
|
|
2129
|
+
</dd>
|
|
2130
|
+
</dl>
|
|
2131
|
+
</dd>
|
|
2132
|
+
</dl>
|
|
2133
|
+
|
|
2134
|
+
#### ⚙️ Parameters
|
|
2135
|
+
|
|
2136
|
+
<dl>
|
|
2137
|
+
<dd>
|
|
2138
|
+
|
|
2139
|
+
<dl>
|
|
2140
|
+
<dd>
|
|
2141
|
+
|
|
2142
|
+
**request:** `Chrt.billing.LineItemGroupSharedTaskGroupMileageCreateClientReq`
|
|
2143
|
+
|
|
2144
|
+
</dd>
|
|
2145
|
+
</dl>
|
|
2146
|
+
|
|
2147
|
+
<dl>
|
|
2148
|
+
<dd>
|
|
2149
|
+
|
|
2150
|
+
**requestOptions:** `LineItemGroups.RequestOptions`
|
|
2151
|
+
|
|
2152
|
+
</dd>
|
|
2153
|
+
</dl>
|
|
2154
|
+
</dd>
|
|
2155
|
+
</dl>
|
|
2156
|
+
|
|
2157
|
+
</dd>
|
|
2158
|
+
</dl>
|
|
2159
|
+
</details>
|
|
2160
|
+
|
|
2093
2161
|
## Billing ChrtGroundProviderRateSheets
|
|
2094
2162
|
|
|
2095
2163
|
<details><summary><code>client.billing.chrtGroundProviderRateSheets.<a href="/src/api/resources/billing/resources/chrtGroundProviderRateSheets/client/Client.ts">getByIdV1</a>(id) -> Chrt.ChrtGroundProviderRateSheet1</code></summary>
|
|
@@ -9594,6 +9662,80 @@ await client.notifications.adHoc.listByOrderIdV1("order_id", {
|
|
|
9594
9662
|
</dl>
|
|
9595
9663
|
</details>
|
|
9596
9664
|
|
|
9665
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">listBySessionIdV1</a>(sessionId, { ...params }) -> Chrt.NotificationAdHocListRes</code></summary>
|
|
9666
|
+
<dl>
|
|
9667
|
+
<dd>
|
|
9668
|
+
|
|
9669
|
+
#### 📝 Description
|
|
9670
|
+
|
|
9671
|
+
<dl>
|
|
9672
|
+
<dd>
|
|
9673
|
+
|
|
9674
|
+
<dl>
|
|
9675
|
+
<dd>
|
|
9676
|
+
|
|
9677
|
+
Lists all ad-hoc notification intents for a tracking session. | authz: min_org_role=operator | () -> (NotificationAdHocListRes)
|
|
9678
|
+
|
|
9679
|
+
</dd>
|
|
9680
|
+
</dl>
|
|
9681
|
+
</dd>
|
|
9682
|
+
</dl>
|
|
9683
|
+
|
|
9684
|
+
#### 🔌 Usage
|
|
9685
|
+
|
|
9686
|
+
<dl>
|
|
9687
|
+
<dd>
|
|
9688
|
+
|
|
9689
|
+
<dl>
|
|
9690
|
+
<dd>
|
|
9691
|
+
|
|
9692
|
+
```typescript
|
|
9693
|
+
await client.notifications.adHoc.listBySessionIdV1("session_id", {
|
|
9694
|
+
page: 1,
|
|
9695
|
+
page_size: 1,
|
|
9696
|
+
});
|
|
9697
|
+
```
|
|
9698
|
+
|
|
9699
|
+
</dd>
|
|
9700
|
+
</dl>
|
|
9701
|
+
</dd>
|
|
9702
|
+
</dl>
|
|
9703
|
+
|
|
9704
|
+
#### ⚙️ Parameters
|
|
9705
|
+
|
|
9706
|
+
<dl>
|
|
9707
|
+
<dd>
|
|
9708
|
+
|
|
9709
|
+
<dl>
|
|
9710
|
+
<dd>
|
|
9711
|
+
|
|
9712
|
+
**sessionId:** `string`
|
|
9713
|
+
|
|
9714
|
+
</dd>
|
|
9715
|
+
</dl>
|
|
9716
|
+
|
|
9717
|
+
<dl>
|
|
9718
|
+
<dd>
|
|
9719
|
+
|
|
9720
|
+
**request:** `Chrt.notifications.AdHocListBySessionIdV1Request`
|
|
9721
|
+
|
|
9722
|
+
</dd>
|
|
9723
|
+
</dl>
|
|
9724
|
+
|
|
9725
|
+
<dl>
|
|
9726
|
+
<dd>
|
|
9727
|
+
|
|
9728
|
+
**requestOptions:** `AdHoc.RequestOptions`
|
|
9729
|
+
|
|
9730
|
+
</dd>
|
|
9731
|
+
</dl>
|
|
9732
|
+
</dd>
|
|
9733
|
+
</dl>
|
|
9734
|
+
|
|
9735
|
+
</dd>
|
|
9736
|
+
</dl>
|
|
9737
|
+
</details>
|
|
9738
|
+
|
|
9597
9739
|
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createV1</a>(orderId, { ...params }) -> string</code></summary>
|
|
9598
9740
|
<dl>
|
|
9599
9741
|
<dd>
|
|
@@ -9649,7 +9791,81 @@ await client.notifications.adHoc.createV1("order_id", {
|
|
|
9649
9791
|
<dl>
|
|
9650
9792
|
<dd>
|
|
9651
9793
|
|
|
9652
|
-
**request:** `Chrt.
|
|
9794
|
+
**request:** `Chrt.NotificationIntentAdHocClientCreate1`
|
|
9795
|
+
|
|
9796
|
+
</dd>
|
|
9797
|
+
</dl>
|
|
9798
|
+
|
|
9799
|
+
<dl>
|
|
9800
|
+
<dd>
|
|
9801
|
+
|
|
9802
|
+
**requestOptions:** `AdHoc.RequestOptions`
|
|
9803
|
+
|
|
9804
|
+
</dd>
|
|
9805
|
+
</dl>
|
|
9806
|
+
</dd>
|
|
9807
|
+
</dl>
|
|
9808
|
+
|
|
9809
|
+
</dd>
|
|
9810
|
+
</dl>
|
|
9811
|
+
</details>
|
|
9812
|
+
|
|
9813
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createForSessionV1</a>(sessionId, { ...params }) -> string</code></summary>
|
|
9814
|
+
<dl>
|
|
9815
|
+
<dd>
|
|
9816
|
+
|
|
9817
|
+
#### 📝 Description
|
|
9818
|
+
|
|
9819
|
+
<dl>
|
|
9820
|
+
<dd>
|
|
9821
|
+
|
|
9822
|
+
<dl>
|
|
9823
|
+
<dd>
|
|
9824
|
+
|
|
9825
|
+
Creates a new ad-hoc notification intent for a tracking session. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
9826
|
+
|
|
9827
|
+
</dd>
|
|
9828
|
+
</dl>
|
|
9829
|
+
</dd>
|
|
9830
|
+
</dl>
|
|
9831
|
+
|
|
9832
|
+
#### 🔌 Usage
|
|
9833
|
+
|
|
9834
|
+
<dl>
|
|
9835
|
+
<dd>
|
|
9836
|
+
|
|
9837
|
+
<dl>
|
|
9838
|
+
<dd>
|
|
9839
|
+
|
|
9840
|
+
```typescript
|
|
9841
|
+
await client.notifications.adHoc.createForSessionV1("session_id", {
|
|
9842
|
+
schema_version: 1,
|
|
9843
|
+
directory_entry_id: "directory_entry_id",
|
|
9844
|
+
});
|
|
9845
|
+
```
|
|
9846
|
+
|
|
9847
|
+
</dd>
|
|
9848
|
+
</dl>
|
|
9849
|
+
</dd>
|
|
9850
|
+
</dl>
|
|
9851
|
+
|
|
9852
|
+
#### ⚙️ Parameters
|
|
9853
|
+
|
|
9854
|
+
<dl>
|
|
9855
|
+
<dd>
|
|
9856
|
+
|
|
9857
|
+
<dl>
|
|
9858
|
+
<dd>
|
|
9859
|
+
|
|
9860
|
+
**sessionId:** `string`
|
|
9861
|
+
|
|
9862
|
+
</dd>
|
|
9863
|
+
</dl>
|
|
9864
|
+
|
|
9865
|
+
<dl>
|
|
9866
|
+
<dd>
|
|
9867
|
+
|
|
9868
|
+
**request:** `Chrt.NotificationIntentAdHocClientCreate1`
|
|
9653
9869
|
|
|
9654
9870
|
</dd>
|
|
9655
9871
|
</dl>
|
|
@@ -12773,7 +12989,165 @@ await client.operations.operationsTaskLists.createV1({
|
|
|
12773
12989
|
</dl>
|
|
12774
12990
|
</details>
|
|
12775
12991
|
|
|
12776
|
-
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">
|
|
12992
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">addEntryV1</a>(taskListId, { ...params }) -> string</code></summary>
|
|
12993
|
+
<dl>
|
|
12994
|
+
<dd>
|
|
12995
|
+
|
|
12996
|
+
#### 📝 Description
|
|
12997
|
+
|
|
12998
|
+
<dl>
|
|
12999
|
+
<dd>
|
|
13000
|
+
|
|
13001
|
+
<dl>
|
|
13002
|
+
<dd>
|
|
13003
|
+
|
|
13004
|
+
Appends a new entry to an OperationsTaskList's `entries` array. The server assigns a fresh UUID and returns it. Order is load-bearing for from_previous_task-anchored deadlines. | authz: min_org_role=operator | (OperationsTaskListEntryClientCreate1) -> (str)
|
|
13005
|
+
|
|
13006
|
+
</dd>
|
|
13007
|
+
</dl>
|
|
13008
|
+
</dd>
|
|
13009
|
+
</dl>
|
|
13010
|
+
|
|
13011
|
+
#### 🔌 Usage
|
|
13012
|
+
|
|
13013
|
+
<dl>
|
|
13014
|
+
<dd>
|
|
13015
|
+
|
|
13016
|
+
<dl>
|
|
13017
|
+
<dd>
|
|
13018
|
+
|
|
13019
|
+
```typescript
|
|
13020
|
+
await client.operations.operationsTaskLists.addEntryV1("task_list_id", {
|
|
13021
|
+
task_type: "review_order_details",
|
|
13022
|
+
title: "title",
|
|
13023
|
+
description: "description",
|
|
13024
|
+
});
|
|
13025
|
+
```
|
|
13026
|
+
|
|
13027
|
+
</dd>
|
|
13028
|
+
</dl>
|
|
13029
|
+
</dd>
|
|
13030
|
+
</dl>
|
|
13031
|
+
|
|
13032
|
+
#### ⚙️ Parameters
|
|
13033
|
+
|
|
13034
|
+
<dl>
|
|
13035
|
+
<dd>
|
|
13036
|
+
|
|
13037
|
+
<dl>
|
|
13038
|
+
<dd>
|
|
13039
|
+
|
|
13040
|
+
**taskListId:** `string`
|
|
13041
|
+
|
|
13042
|
+
</dd>
|
|
13043
|
+
</dl>
|
|
13044
|
+
|
|
13045
|
+
<dl>
|
|
13046
|
+
<dd>
|
|
13047
|
+
|
|
13048
|
+
**request:** `Chrt.OperationsTaskListEntryClientCreate1`
|
|
13049
|
+
|
|
13050
|
+
</dd>
|
|
13051
|
+
</dl>
|
|
13052
|
+
|
|
13053
|
+
<dl>
|
|
13054
|
+
<dd>
|
|
13055
|
+
|
|
13056
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
13057
|
+
|
|
13058
|
+
</dd>
|
|
13059
|
+
</dl>
|
|
13060
|
+
</dd>
|
|
13061
|
+
</dl>
|
|
13062
|
+
|
|
13063
|
+
</dd>
|
|
13064
|
+
</dl>
|
|
13065
|
+
</details>
|
|
13066
|
+
|
|
13067
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">editEntryV1</a>(taskListId, entryUuid, { ...params }) -> boolean</code></summary>
|
|
13068
|
+
<dl>
|
|
13069
|
+
<dd>
|
|
13070
|
+
|
|
13071
|
+
#### 📝 Description
|
|
13072
|
+
|
|
13073
|
+
<dl>
|
|
13074
|
+
<dd>
|
|
13075
|
+
|
|
13076
|
+
<dl>
|
|
13077
|
+
<dd>
|
|
13078
|
+
|
|
13079
|
+
Replaces the entry with the given uuid in an OperationsTaskList's `entries` array. The stored uuid is preserved regardless of the request body. 404 if no entry matches. | authz: min_org_role=operator | (OperationsTaskListEntryClientCreate1) -> (bool)
|
|
13080
|
+
|
|
13081
|
+
</dd>
|
|
13082
|
+
</dl>
|
|
13083
|
+
</dd>
|
|
13084
|
+
</dl>
|
|
13085
|
+
|
|
13086
|
+
#### 🔌 Usage
|
|
13087
|
+
|
|
13088
|
+
<dl>
|
|
13089
|
+
<dd>
|
|
13090
|
+
|
|
13091
|
+
<dl>
|
|
13092
|
+
<dd>
|
|
13093
|
+
|
|
13094
|
+
```typescript
|
|
13095
|
+
await client.operations.operationsTaskLists.editEntryV1("task_list_id", "entry_uuid", {
|
|
13096
|
+
task_type: "review_order_details",
|
|
13097
|
+
title: "title",
|
|
13098
|
+
description: "description",
|
|
13099
|
+
});
|
|
13100
|
+
```
|
|
13101
|
+
|
|
13102
|
+
</dd>
|
|
13103
|
+
</dl>
|
|
13104
|
+
</dd>
|
|
13105
|
+
</dl>
|
|
13106
|
+
|
|
13107
|
+
#### ⚙️ Parameters
|
|
13108
|
+
|
|
13109
|
+
<dl>
|
|
13110
|
+
<dd>
|
|
13111
|
+
|
|
13112
|
+
<dl>
|
|
13113
|
+
<dd>
|
|
13114
|
+
|
|
13115
|
+
**taskListId:** `string`
|
|
13116
|
+
|
|
13117
|
+
</dd>
|
|
13118
|
+
</dl>
|
|
13119
|
+
|
|
13120
|
+
<dl>
|
|
13121
|
+
<dd>
|
|
13122
|
+
|
|
13123
|
+
**entryUuid:** `string`
|
|
13124
|
+
|
|
13125
|
+
</dd>
|
|
13126
|
+
</dl>
|
|
13127
|
+
|
|
13128
|
+
<dl>
|
|
13129
|
+
<dd>
|
|
13130
|
+
|
|
13131
|
+
**request:** `Chrt.OperationsTaskListEntryClientCreate1`
|
|
13132
|
+
|
|
13133
|
+
</dd>
|
|
13134
|
+
</dl>
|
|
13135
|
+
|
|
13136
|
+
<dl>
|
|
13137
|
+
<dd>
|
|
13138
|
+
|
|
13139
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
13140
|
+
|
|
13141
|
+
</dd>
|
|
13142
|
+
</dl>
|
|
13143
|
+
</dd>
|
|
13144
|
+
</dl>
|
|
13145
|
+
|
|
13146
|
+
</dd>
|
|
13147
|
+
</dl>
|
|
13148
|
+
</details>
|
|
13149
|
+
|
|
13150
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">removeEntryV1</a>(taskListId, entryUuid) -> boolean</code></summary>
|
|
12777
13151
|
<dl>
|
|
12778
13152
|
<dd>
|
|
12779
13153
|
|
|
@@ -12785,7 +13159,7 @@ await client.operations.operationsTaskLists.createV1({
|
|
|
12785
13159
|
<dl>
|
|
12786
13160
|
<dd>
|
|
12787
13161
|
|
|
12788
|
-
|
|
13162
|
+
Removes the entry with the given uuid from an OperationsTaskList's `entries` array, closing the gap in order. 404 if no entry matches. | authz: min_org_role=operator | () -> (bool)
|
|
12789
13163
|
|
|
12790
13164
|
</dd>
|
|
12791
13165
|
</dl>
|
|
@@ -12801,7 +13175,7 @@ Replaces an OperationsTaskList's `entries` array wholesale — covering add, rem
|
|
|
12801
13175
|
<dd>
|
|
12802
13176
|
|
|
12803
13177
|
```typescript
|
|
12804
|
-
await client.operations.operationsTaskLists.
|
|
13178
|
+
await client.operations.operationsTaskLists.removeEntryV1("task_list_id", "entry_uuid");
|
|
12805
13179
|
```
|
|
12806
13180
|
|
|
12807
13181
|
</dd>
|
|
@@ -12825,7 +13199,7 @@ await client.operations.operationsTaskLists.setEntriesV1("task_list_id");
|
|
|
12825
13199
|
<dl>
|
|
12826
13200
|
<dd>
|
|
12827
13201
|
|
|
12828
|
-
**
|
|
13202
|
+
**entryUuid:** `string`
|
|
12829
13203
|
|
|
12830
13204
|
</dd>
|
|
12831
13205
|
</dl>
|
|
@@ -12856,7 +13230,7 @@ await client.operations.operationsTaskLists.setEntriesV1("task_list_id");
|
|
|
12856
13230
|
<dl>
|
|
12857
13231
|
<dd>
|
|
12858
13232
|
|
|
12859
|
-
Reorders an OperationsTaskList's existing entries. `
|
|
13233
|
+
Reorders an OperationsTaskList's existing entries. `entry_uuids` must be an exact permutation of the list's current entry uuids (every uuid present, no extras, no duplicates), so a reorder can never drop, add, or mutate an entry. | authz: min_org_role=operator | (OperationsTaskListReorderEntries1) -> (bool)
|
|
12860
13234
|
|
|
12861
13235
|
</dd>
|
|
12862
13236
|
</dl>
|
|
@@ -13122,7 +13496,7 @@ await client.operations.operationsTaskLists.applyToCaseV1("task_list_id", "case_
|
|
|
13122
13496
|
</dl>
|
|
13123
13497
|
</details>
|
|
13124
13498
|
|
|
13125
|
-
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">
|
|
13499
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">removeNotStartedTasksFromCaseV1</a>(taskListId, caseId) -> Chrt.OperationsTaskListRemoveFromCaseRes1</code></summary>
|
|
13126
13500
|
<dl>
|
|
13127
13501
|
<dd>
|
|
13128
13502
|
|
|
@@ -13150,7 +13524,7 @@ Removes the OperationsTasks this OperationsTaskList added to the Case (matched b
|
|
|
13150
13524
|
<dd>
|
|
13151
13525
|
|
|
13152
13526
|
```typescript
|
|
13153
|
-
await client.operations.operationsTaskLists.
|
|
13527
|
+
await client.operations.operationsTaskLists.removeNotStartedTasksFromCaseV1("task_list_id", "case_id");
|
|
13154
13528
|
```
|
|
13155
13529
|
|
|
13156
13530
|
</dd>
|
|
@@ -29053,7 +29427,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
29053
29427
|
<dl>
|
|
29054
29428
|
<dd>
|
|
29055
29429
|
|
|
29056
|
-
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~1 week out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
|
|
29430
|
+
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Optionally seed a destination geofence (location + radius) to fire a destination geofence entered notification. Auto-termination is scheduled for ~1 week out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
|
|
29057
29431
|
|
|
29058
29432
|
</dd>
|
|
29059
29433
|
</dl>
|
|
@@ -29120,7 +29494,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
29120
29494
|
<dl>
|
|
29121
29495
|
<dd>
|
|
29122
29496
|
|
|
29123
|
-
Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
29497
|
+
Updates a session's mutable metadata (off_chrt_reference_id, comments, public, termination_scheduled_for_timestamp, destination_geofence_location, destination_geofence_radius_miles). Setting or replacing the destination geofence location resets the entered latch so it can fire again; clearing it (destination_geofence_location\_\_set_to_None) also resets the latch. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
29124
29498
|
|
|
29125
29499
|
</dd>
|
|
29126
29500
|
</dl>
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../../../../../../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface OperationsTaskListSetEntries1 {
|
|
10
|
-
entries?: Chrt.OperationsTaskListEntry1[];
|
|
11
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../../../../../../index.mjs";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface OperationsTaskListSetEntries1 {
|
|
10
|
-
entries?: Chrt.OperationsTaskListEntry1[];
|
|
11
|
-
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|