@chrt-inc/typescript-sdk 1.421.0 → 1.431.0

package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.d.mts

@@ -1,9 +1,8 @@
-export { type DevicesRegisterToOrgReq1 } from "./DevicesRegisterToOrgReq1.mjs";
-export { type DevicesUpdateRequest1 } from "./DevicesUpdateRequest1.mjs";
-export { type DevicesDeleteV1Request } from "./DevicesDeleteV1Request.mjs";
-export { type DevicesLinkToCargoV1Request } from "./DevicesLinkToCargoV1Request.mjs";
-export { type DevicesUnlinkFromCargoV1Request } from "./DevicesUnlinkFromCargoV1Request.mjs";
+export { type DeviceClientCreate1 } from "./DeviceClientCreate1.mjs";
+export { type DeviceClientUpdate1 } from "./DeviceClientUpdate1.mjs";
+export { type DevicesArchiveV1Request } from "./DevicesArchiveV1Request.mjs";
+export { type DevicesUpdateSharedOrgsReq1 } from "./DevicesUpdateSharedOrgsReq1.mjs";
 export { type DevicesGetV1Request } from "./DevicesGetV1Request.mjs";
 export { type DevicesListV1Request } from "./DevicesListV1Request.mjs";
-export { type DevicesTypeaheadOffChrtOrderIdV1Request } from "./DevicesTypeaheadOffChrtOrderIdV1Request.mjs";
+export { type DevicesTypeaheadV1Request } from "./DevicesTypeaheadV1Request.mjs";
 export { type DevicesSearchV1Request } from "./DevicesSearchV1Request.mjs";

package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts

@@ -31,7 +31,7 @@ export declare class Sessions {
     protected readonly _options: Sessions.Options;
     constructor(_options?: Sessions.Options);
     /**
-     * Lists sessions with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (SessionListRes)
+     * Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionListRes)
      *
      * @param {Chrt.tracking.SessionsListV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
@@ -40,26 +40,30 @@ export declare class Sessions {
      *
      * @example
      *     await client.tracking.sessions.listV1({
-     *         sort_by: "session_created_at_timestamp",
+     *         sort_by: "created_at_timestamp",
      *         sort_order: "asc",
      *         page: 1,
      *         page_size: 1,
-     *         filter_recording: true,
+     *         org_scope: "owned",
      *         filter_terminated: true,
      *         filter_public: true,
      *         filter_device_id: "filter_device_id",
-     *         filter_off_chrt_order_id: "filter_off_chrt_order_id",
+     *         filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
      *         filter_flight_number: "filter_flight_number",
-     *         filter_session_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
-     *         filter_session_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
-     *         filter_recording_initiated_at_timestamp_gte: "2024-01-15T09:30:00Z",
-     *         filter_recording_initiated_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *         filter_fa_flight_id: "filter_fa_flight_id",
+     *         filter_flight_loaded_status: "filter_flight_loaded_status",
+     *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_created_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"
      *     })
      */
     listV1(request?: Chrt.tracking.SessionsListV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionListRes>;
     private __listV1;
     /**
-     * Retrieves a single session by its ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Session1)
+     * Retrieves a single session by its ID. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (Session1)
      *
      * @param {Chrt.tracking.SessionsGetV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
@@ -74,23 +78,24 @@ export declare class Sessions {
     getV1(request: Chrt.tracking.SessionsGetV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
     private __getV1;
     /**
-     * Returns distinct off_chrt_order_id values matching the query via case-insensitive regex, searching sessions. | authz: min_org_role=operator | () -> (list[str])
+     * 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). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
      *
-     * @param {Chrt.tracking.SessionsTypeaheadOffChrtOrderIdV1Request} request
+     * @param {Chrt.tracking.SessionsTypeaheadV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.typeaheadOffChrtOrderIdV1({
+     *     await client.tracking.sessions.typeaheadV1({
      *         query: "query",
-     *         limit: 1
+     *         limit: 1,
+     *         org_scope: "owned"
      *     })
      */
-    typeaheadOffChrtOrderIdV1(request: Chrt.tracking.SessionsTypeaheadOffChrtOrderIdV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string[]>;
-    private __typeaheadOffChrtOrderIdV1;
+    typeaheadV1(request: Chrt.tracking.SessionsTypeaheadV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.TrackingTypeaheadResult[]>;
+    private __typeaheadV1;
     /**
-     * Full-text search across session comments, device_mac_address, flight_number, and off_chrt_order_id using Atlas Search. | authz: min_org_role=operator | () -> (SessionSearchRes)
+     * Search across session comments, device_mac_address, flight_numbers, and off_chrt_reference_id. Handles both partial and full matches. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionSearchRes)
      *
      * @param {Chrt.tracking.SessionsSearchV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
@@ -101,115 +106,123 @@ export declare class Sessions {
      *     await client.tracking.sessions.searchV1({
      *         query: "query",
      *         page: 1,
-     *         page_size: 1
+     *         page_size: 1,
+     *         org_scope: "owned"
      *     })
      */
     searchV1(request: Chrt.tracking.SessionsSearchV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionSearchRes>;
     private __searchV1;
     /**
-     * Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionCreateSessionRequest1) -> (PydanticObjectId)
+     * Creates a new tracking session for a device. The device must already be registered to the caller's org and must not have an active session. Recording starts immediately and auto-termination is scheduled for ~3 days out at 8 PM PT. | (SessionClientCreate1) -> (PydanticObjectId)
      *
-     * @param {Chrt.tracking.SessionCreateSessionRequest1} request
+     * @param {Chrt.tracking.SessionClientCreate1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
      *     await client.tracking.sessions.createSessionV1({
-     *         device_mac_address: "device_mac_address"
+     *         device_id: "device_id",
+     *         termination_scheduled_for_timestamp: "2024-01-15T09:30:00Z",
+     *         schema_version: 1
      *     })
      */
-    createSessionV1(request: Chrt.tracking.SessionCreateSessionRequest1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string>;
+    createSessionV1(request: Chrt.tracking.SessionClientCreate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string>;
     private __createSessionV1;
     /**
-     * Updates a session's mutable fields (comments, public, off_chrt_order_id, flight_number, fa_flight_ids). | (SessionUpdateRequest1) -> (bool)
+     * Updates a session's metadata and/or termination_scheduled_for_timestamp. | (SessionClientUpdate1) -> (bool)
      *
-     * @param {Chrt.tracking.SessionUpdateRequest1} request
+     * @param {Chrt.tracking.SessionClientUpdate1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
      *     await client.tracking.sessions.updateV1({
-     *         session_id: "session_id"
+     *         session_id: "session_id",
+     *         termination_scheduled_for_timestamp: "2024-01-15T09:30:00Z"
      *     })
      */
-    updateV1(request: Chrt.tracking.SessionUpdateRequest1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    updateV1(request: Chrt.tracking.SessionClientUpdate1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateV1;
     /**
-     * Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (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. | (SessionsUpdateSharedOrgsReq1) -> (bool)
      *
-     * @param {Chrt.tracking.SessionsStartV1Request} request
+     * @param {Chrt.tracking.SessionsUpdateSharedOrgsReq1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.startV1({
+     *     await client.tracking.sessions.updateSharedOrgsV1({
      *         session_id: "session_id"
      *     })
      */
-    startV1(request: Chrt.tracking.SessionsStartV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __startV1;
+    updateSharedOrgsV1(request: Chrt.tracking.SessionsUpdateSharedOrgsReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateSharedOrgsV1;
     /**
-     * Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)
+     * Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)
      *
-     * @param {Chrt.tracking.SessionsPauseRecordingV1Request} request
+     * @param {Chrt.tracking.SessionsTerminateV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.pauseRecordingV1({
+     *     await client.tracking.sessions.terminateV1({
      *         session_id: "session_id"
      *     })
      */
-    pauseRecordingV1(request: Chrt.tracking.SessionsPauseRecordingV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __pauseRecordingV1;
+    terminateV1(request: Chrt.tracking.SessionsTerminateV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __terminateV1;
     /**
-     * Resumes location recording for a session by setting recording status to true. | () -> (bool)
+     * Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
      *
-     * @param {Chrt.tracking.SessionsResumeRecordingV1Request} request
+     * @param {Chrt.tracking.SessionAddFlightReq1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.resumeRecordingV1({
-     *         session_id: "session_id"
+     *     await client.tracking.sessions.addFlightV1({
+     *         session_id: "session_id",
+     *         flight_number: "flight_number",
+     *         fa_flight_ids: ["fa_flight_ids"]
      *     })
      */
-    resumeRecordingV1(request: Chrt.tracking.SessionsResumeRecordingV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __resumeRecordingV1;
+    addFlightV1(request: Chrt.tracking.SessionAddFlightReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addFlightV1;
     /**
-     * Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)
+     * Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
      *
-     * @param {Chrt.tracking.SessionsTerminateV1Request} request
+     * @param {Chrt.tracking.SessionRemoveFlightReq1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.terminateV1({
-     *         session_id: "session_id"
+     *     await client.tracking.sessions.removeFlightV1({
+     *         session_id: "session_id",
+     *         flight_number: "flight_number",
+     *         fa_flight_ids: ["fa_flight_ids"]
      *     })
      */
-    terminateV1(request: Chrt.tracking.SessionsTerminateV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __terminateV1;
+    removeFlightV1(request: Chrt.tracking.SessionRemoveFlightReq1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeFlightV1;
     /**
-     * Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionDeleteResponse1)
+     * Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | authz: min_org_role=operator | () -> (bool)
      *
-     * @param {Chrt.tracking.SessionsDeleteV1Request} request
+     * @param {Chrt.tracking.SessionsSyncFlightStatusV1Request} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessions.deleteV1({
+     *     await client.tracking.sessions.syncFlightStatusV1({
      *         session_id: "session_id"
      *     })
      */
-    deleteV1(request: Chrt.tracking.SessionsDeleteV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionDeleteResponse1>;
-    private __deleteV1;
+    syncFlightStatusV1(request: Chrt.tracking.SessionsSyncFlightStatusV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __syncFlightStatusV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }