@chrt-inc/typescript-sdk 1.810.0 → 1.841.0

package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientCreate1.d.ts

@@ -5,15 +5,15 @@ import * as Chrt from "../../../../../../index.js";
 /**
  * @example
  *     {
- *         schema_version: 1,
- *         device_mac_address: "device_mac_address"
+ *         device_mac_address: "device_mac_address",
+ *         schema_version: 1
  *     }
  */
 export interface DeviceClientCreate1 {
-    schema_version: number;
-    device_mac_address: string;
-    type?: Chrt.TrackingDeviceTypeEnum1 | null;
     comments?: string | null;
+    device_mac_address: string;
     /** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
     off_chrt_reference_id?: string | null;
+    schema_version: number;
+    type?: Chrt.TrackingDeviceTypeEnum1 | null;
 }

package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.ts

@@ -10,11 +10,11 @@ import * as Chrt from "../../../../../../index.js";
  */
 export interface DeviceClientUpdate1 {
     device_id: string;
-    type?: Chrt.TrackingDeviceTypeEnum1 | null;
     comments?: string | null;
+    comments__set_to_None?: boolean;
     /** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
     off_chrt_reference_id?: string | null;
-    type__set_to_None?: boolean;
-    comments__set_to_None?: boolean;
     off_chrt_reference_id__set_to_None?: boolean;
+    type?: Chrt.TrackingDeviceTypeEnum1 | null;
+    type__set_to_None?: boolean;
 }

package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUpdateSharedOrgsReq1.d.ts

@@ -8,7 +8,7 @@
  *     }
  */
 export interface DevicesUpdateSharedOrgsReq1 {
-    device_id: string;
     add_org_ids?: string[];
+    device_id: string;
     remove_org_ids?: string[];
 }

package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.d.ts

@@ -1,9 +1,9 @@
-export { type DeviceClientCreate1 } from "./DeviceClientCreate1.js";
-export { type DeviceClientUpdate1 } from "./DeviceClientUpdate1.js";
 export { type DevicesArchiveV1Request } from "./DevicesArchiveV1Request.js";
-export { type DevicesPauseV1Request } from "./DevicesPauseV1Request.js";
-export { type DevicesUnpauseV1Request } from "./DevicesUnpauseV1Request.js";
-export { type DevicesUpdateSharedOrgsReq1 } from "./DevicesUpdateSharedOrgsReq1.js";
 export { type DevicesGetV1Request } from "./DevicesGetV1Request.js";
 export { type DevicesListV1Request } from "./DevicesListV1Request.js";
+export { type DevicesPauseV1Request } from "./DevicesPauseV1Request.js";
+export { type DeviceClientCreate1 } from "./DeviceClientCreate1.js";
 export { type DevicesTypeaheadV1Request } from "./DevicesTypeaheadV1Request.js";
+export { type DevicesUnpauseV1Request } from "./DevicesUnpauseV1Request.js";
+export { type DeviceClientUpdate1 } from "./DeviceClientUpdate1.js";
+export { type DevicesUpdateSharedOrgsReq1 } from "./DevicesUpdateSharedOrgsReq1.js";

package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts

@@ -40,17 +40,17 @@ export declare class Driver {
      *
      * @example
      *     await client.tracking.driver.updateV2({
-     *         schema_version: 1,
      *         location: {
-     *             type: "Feature",
      *             geometry: {
      *                 type: "GeometryCollection",
      *                 geometries: [{
      *                         type: "LineString",
      *                         coordinates: [[]]
      *                     }]
-     *             }
+     *             },
+     *             type: "Feature"
      *         },
+     *         schema_version: 1,
      *         timestamp: "2024-01-15T09:30:00Z"
      *     })
      */

package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js

@@ -65,17 +65,17 @@ class Driver {
      *
      * @example
      *     await client.tracking.driver.updateV2({
-     *         schema_version: 1,
      *         location: {
-     *             type: "Feature",
      *             geometry: {
      *                 type: "GeometryCollection",
      *                 geometries: [{
      *                         type: "LineString",
      *                         coordinates: [[]]
      *                     }]
-     *             }
+     *             },
+     *             type: "Feature"
      *         },
+     *         schema_version: 1,
      *         timestamp: "2024-01-15T09:30:00Z"
      *     })
      */

package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverByDriverDataPointClientCreate1.d.ts

@@ -5,22 +5,22 @@ import * as Chrt from "../../../../../../index.js";
 /**
  * @example
  *     {
- *         schema_version: 1,
  *         location: {
- *             type: "Feature",
  *             geometry: {
  *                 type: "GeometryCollection",
  *                 geometries: [{
  *                         type: "LineString",
  *                         coordinates: [[]]
  *                     }]
- *             }
+ *             },
+ *             type: "Feature"
  *         },
+ *         schema_version: 1,
  *         timestamp: "2024-01-15T09:30:00Z"
  *     }
  */
 export interface DriverByDriverDataPointClientCreate1 {
-    schema_version: number;
     location: Chrt.LocationFeature;
+    schema_version: number;
     timestamp: string;
 }

package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts

@@ -31,119 +31,127 @@ export declare class Sessions {
     protected readonly _options: Sessions.Options;
     constructor(_options?: Sessions.Options);
     /**
-     * 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)
+     * 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; attach flights afterwards via set_flight_info. 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)
      *
-     * @param {Chrt.tracking.SessionsListV1Request} request
+     * @param {Chrt.tracking.SessionClientCreate1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.listV1({
-     *         sort_by: "created_at_timestamp",
-     *         sort_order: "asc",
-     *         page: 1,
-     *         page_size: 1,
-     *         search: "search",
-     *         org_scope: "owned",
-     *         filter_terminated: true,
-     *         filter_public: true,
-     *         filter_device_id: "filter_device_id",
-     *         filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
-     *         filter_flight_number: "filter_flight_number",
-     *         filter_flight_loaded_status: "filter_flight_loaded_status",
-     *         filter_has_last_seen: true,
-     *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
-     *         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
-     *         filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
-     *         filter_last_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
-     *         filter_termination_scheduled_for_timestamp_gte: "2024-01-15T09:30:00Z",
-     *         filter_termination_scheduled_for_timestamp_lte: "2024-01-15T09:30:00Z",
-     *         filter_terminated_at_timestamp_gte: "2024-01-15T09:30:00Z",
-     *         filter_terminated_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     await client.tracking.sessions.createSessionV1({
+     *         device_id: "device_id",
+     *         no_auto_termination: true,
+     *         schema_version: 1
      *     })
      */
-    listV1(request?: Chrt.tracking.SessionsListV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionListRes>;
-    private __listV1;
+    createSessionV1(request: Chrt.tracking.SessionClientCreate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string>;
+    private __createSessionV1;
     /**
-     * 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 | () -> (Session1)
+     * 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])
      *
-     * @param {Chrt.tracking.SessionsGetV1Request} request
+     * @param {Chrt.tracking.SessionsFlightLegsV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.getV1({
+     *     await client.tracking.sessions.flightLegsV1({
      *         session_id: "session_id"
      *     })
      */
-    getV1(request: Chrt.tracking.SessionsGetV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
-    private __getV1;
+    flightLegsV1(request: Chrt.tracking.SessionsFlightLegsV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.FlightLeg1[]>;
+    private __flightLegsV1;
     /**
-     * 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])
+     * 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)
      *
-     * @param {Chrt.tracking.SessionsTypeaheadV1Request} request
+     * @param {Chrt.tracking.SessionsFlightTrackV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.typeaheadV1({
-     *         query: "query",
-     *         limit: 1,
-     *         org_scope: "owned"
+     *     await client.tracking.sessions.flightTrackV1({
+     *         session_id: "session_id",
+     *         flight_leg_id: "flight_leg_id"
      *     })
      */
-    typeaheadV1(request: Chrt.tracking.SessionsTypeaheadV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.TrackingTypeaheadResult[]>;
-    private __typeaheadV1;
+    flightTrackV1(request: Chrt.tracking.SessionsFlightTrackV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.FlightTrackRes>;
+    private __flightTrackV1;
     /**
-     * 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; attach flights afterwards via set_flight_info. 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)
+     * 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 | () -> (Session1)
      *
-     * @param {Chrt.tracking.SessionClientCreate1} request
+     * @param {Chrt.tracking.SessionsGetV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.createSessionV1({
-     *         device_id: "device_id",
-     *         no_auto_termination: true,
-     *         schema_version: 1
+     *     await client.tracking.sessions.getV1({
+     *         session_id: "session_id"
      *     })
      */
-    createSessionV1(request: Chrt.tracking.SessionClientCreate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string>;
-    private __createSessionV1;
+    getV1(request: Chrt.tracking.SessionsGetV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
+    private __getV1;
     /**
-     * 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)
+     * 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)
      *
-     * @param {Chrt.tracking.SessionClientUpdate1} request
+     * @param {Chrt.tracking.SessionsListV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.updateV1({
-     *         session_id: "session_id"
+     *     await client.tracking.sessions.listV1({
+     *         sort_by: "created_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         search: "search",
+     *         org_scope: "owned",
+     *         filter_terminated: true,
+     *         filter_public: true,
+     *         filter_device_id: "filter_device_id",
+     *         filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
+     *         filter_flight_number: "filter_flight_number",
+     *         filter_flight_loaded_status: "filter_flight_loaded_status",
+     *         filter_has_last_seen: true,
+     *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_last_seen_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_termination_scheduled_for_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_termination_scheduled_for_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_terminated_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_terminated_at_timestamp_lte: "2024-01-15T09:30:00Z"
      *     })
      */
-    updateV1(request: Chrt.tracking.SessionClientUpdate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateV1;
+    listV1(request?: Chrt.tracking.SessionsListV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionListRes>;
+    private __listV1;
     /**
-     * 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)
+     * 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)
      *
-     * @param {Chrt.tracking.SessionsUpdateSharedOrgsReq1} request
+     * @param {Chrt.tracking.SessionSetFlightInfoReq1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.updateSharedOrgsV1({
+     *     await client.tracking.sessions.setFlightInfoV1({
+     *         flight_legs: [{
+     *                 carrier_iata: "carrier_iata",
+     *                 destination_iata: "destination_iata",
+     *                 flight_number: "flight_number",
+     *                 origin_iata: "origin_iata",
+     *                 provenance: "manual",
+     *                 scheduled_departure_utc: "2024-01-15T09:30:00Z",
+     *                 schema_version: 1
+     *             }],
      *         session_id: "session_id"
      *     })
      */
-    updateSharedOrgsV1(request: Chrt.tracking.SessionsUpdateSharedOrgsReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateSharedOrgsV1;
+    setFlightInfoV1(request: Chrt.tracking.SessionSetFlightInfoReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setFlightInfoV1;
     /**
      * Terminates a session. Moves device.active_session_id to device.past_session_ids and deactivates the device. | auth: api_key | () -> (bool)
      *
@@ -160,59 +168,51 @@ export declare class Sessions {
     terminateV1(request: Chrt.tracking.SessionsTerminateV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
     private __terminateV1;
     /**
-     * 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])
+     * 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])
      *
-     * @param {Chrt.tracking.SessionsFlightLegsV1Request} request
+     * @param {Chrt.tracking.SessionsTypeaheadV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.flightLegsV1({
-     *         session_id: "session_id"
+     *     await client.tracking.sessions.typeaheadV1({
+     *         query: "query",
+     *         limit: 1,
+     *         org_scope: "owned"
      *     })
      */
-    flightLegsV1(request: Chrt.tracking.SessionsFlightLegsV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.FlightLeg1[]>;
-    private __flightLegsV1;
+    typeaheadV1(request: Chrt.tracking.SessionsTypeaheadV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.TrackingTypeaheadResult[]>;
+    private __typeaheadV1;
     /**
-     * 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)
+     * 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)
      *
-     * @param {Chrt.tracking.SessionsFlightTrackV1Request} request
+     * @param {Chrt.tracking.SessionClientUpdate1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.flightTrackV1({
-     *         session_id: "session_id",
-     *         flight_leg_id: "flight_leg_id"
+     *     await client.tracking.sessions.updateV1({
+     *         session_id: "session_id"
      *     })
      */
-    flightTrackV1(request: Chrt.tracking.SessionsFlightTrackV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.FlightTrackRes>;
-    private __flightTrackV1;
+    updateV1(request: Chrt.tracking.SessionClientUpdate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
     /**
-     * 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)
+     * 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)
      *
-     * @param {Chrt.tracking.SessionSetFlightInfoReq1} request
+     * @param {Chrt.tracking.SessionsUpdateSharedOrgsReq1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.setFlightInfoV1({
-     *         session_id: "session_id",
-     *         flight_legs: [{
-     *                 schema_version: 1,
-     *                 flight_number: "flight_number",
-     *                 provenance: "manual",
-     *                 origin_iata: "origin_iata",
-     *                 destination_iata: "destination_iata",
-     *                 scheduled_departure_utc: "2024-01-15T09:30:00Z",
-     *                 carrier_iata: "carrier_iata"
-     *             }]
+     *     await client.tracking.sessions.updateSharedOrgsV1({
+     *         session_id: "session_id"
      *     })
      */
-    setFlightInfoV1(request: Chrt.tracking.SessionSetFlightInfoReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __setFlightInfoV1;
+    updateSharedOrgsV1(request: Chrt.tracking.SessionsUpdateSharedOrgsReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateSharedOrgsV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }