@chrt-inc/typescript-sdk 1.762.0 → 1.772.0

package/reference.md

@@ -9594,6 +9594,80 @@ await client.notifications.adHoc.listByOrderIdV1("order_id", {
 </dl>
 </details>
 
+<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>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists all ad-hoc notification intents for a tracking session. | authz: min_org_role=operator | () -> (NotificationAdHocListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.notifications.adHoc.listBySessionIdV1("session_id", {
+    page: 1,
+    page_size: 1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**sessionId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.notifications.AdHocListBySessionIdV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AdHoc.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createV1</a>(orderId, { ...params }) -> string</code></summary>
 <dl>
 <dd>
@@ -9649,7 +9723,81 @@ await client.notifications.adHoc.createV1("order_id", {
 <dl>
 <dd>
 
-**request:** `Chrt.notifications.NotificationIntentAdHocClientCreate1`
+**request:** `Chrt.NotificationIntentAdHocClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AdHoc.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createForSessionV1</a>(sessionId, { ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new ad-hoc notification intent for a tracking session. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.notifications.adHoc.createForSessionV1("session_id", {
+    schema_version: 1,
+    directory_entry_id: "directory_entry_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**sessionId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.NotificationIntentAdHocClientCreate1`
 
 </dd>
 </dl>
@@ -29053,7 +29201,7 @@ await client.tracking.sessions.typeaheadV1({
 <dl>
 <dd>
 
-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)
+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)
 
 </dd>
 </dl>
@@ -29120,7 +29268,7 @@ await client.tracking.sessions.createSessionV1({
 <dl>
 <dd>
 
-Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
+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)
 
 </dd>
 </dl>