@chrt-inc/typescript-sdk 1.282.0 → 1.288.0

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

@@ -31,62 +31,62 @@ export declare class SessionByDevice {
     protected readonly _options: SessionByDevice.Options;
     constructor(_options?: SessionByDevice.Options);
     /**
-     * List all sessions for the current organization.
+     * Returns all tracking sessions for the authenticated user's organization.
      *
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.tracking.sessionByDevice.list()
+     *     await client.tracking.sessionByDevice.listV1()
      */
-    list(requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1[]>;
-    private __list;
+    listV1(requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1[]>;
+    private __listV1;
     /**
-     * Get a single session document by session_id.
+     * Retrieves a single session by its ID. Access restricted to the session's organization.
      *
-     * @param {Chrt.tracking.SessionByDeviceGetRequest} request
+     * @param {Chrt.tracking.SessionByDeviceGetV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.get({
+     *     await client.tracking.sessionByDevice.getV1({
      *         session_id: "session_id"
      *     })
      */
-    get(request: Chrt.tracking.SessionByDeviceGetRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
-    private __get;
+    getV1(request: Chrt.tracking.SessionByDeviceGetV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
+    private __getV1;
     /**
-     * Return the most recent datapoint for a session.
+     * Returns the most recent data point for a session, excluding outliers. Access restricted to the session's organization.
      *
-     * @param {Chrt.tracking.SessionByDeviceLastSeenRequest} request
+     * @param {Chrt.tracking.SessionByDeviceLastSeenV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.lastSeen({
+     *     await client.tracking.sessionByDevice.lastSeenV1({
      *         session_id: "session_id"
      *     })
      */
-    lastSeen(request: Chrt.tracking.SessionByDeviceLastSeenRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
-    private __lastSeen;
+    lastSeenV1(request: Chrt.tracking.SessionByDeviceLastSeenV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
+    private __lastSeenV1;
     /**
-     * Return a specified number of data points for a session, intelligently sampled across the time range.
+     * Returns up to the specified number of data points for a session, intelligently sampled across the time range. Excludes outliers.
      *
-     * @param {Chrt.tracking.SessionByDeviceDataPointsRequest} request
+     * @param {Chrt.tracking.SessionByDeviceDataPointsV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.dataPoints({
+     *     await client.tracking.sessionByDevice.dataPointsV1({
      *         session_id: "session_id"
      *     })
      */
-    dataPoints(request: Chrt.tracking.SessionByDeviceDataPointsRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
-    private __dataPoints;
+    dataPointsV1(request: Chrt.tracking.SessionByDeviceDataPointsV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
+    private __dataPointsV1;
     /**
-     * Create a session for a device and link the device to it.
+     * Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization.
      *
      * @param {Chrt.tracking.SessionByDeviceCreateSessionRequest1} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
@@ -94,14 +94,14 @@ export declare class SessionByDevice {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.createSession({
+     *     await client.tracking.sessionByDevice.createSessionV1({
      *         device_mac_address: "device_mac_address"
      *     })
      */
-    createSession(request: Chrt.tracking.SessionByDeviceCreateSessionRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<string>;
-    private __createSession;
+    createSessionV1(request: Chrt.tracking.SessionByDeviceCreateSessionRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<string>;
+    private __createSessionV1;
     /**
-     * Update a session's comments and/or public visibility status.
+     * Updates a session's comments and/or public visibility status. Can update one or both fields.
      *
      * @param {Chrt.tracking.SessionByDeviceUpdateRequest1} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
@@ -109,74 +109,74 @@ export declare class SessionByDevice {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.update({
+     *     await client.tracking.sessionByDevice.updateV1({
      *         session_id: "session_id"
      *     })
      */
-    update(request: Chrt.tracking.SessionByDeviceUpdateRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __update;
+    updateV1(request: Chrt.tracking.SessionByDeviceUpdateRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
     /**
-     * Start a session (set recording=true).
+     * Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start.
      *
-     * @param {Chrt.tracking.SessionByDeviceStartRequest} request
+     * @param {Chrt.tracking.SessionByDeviceStartV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.start({
+     *     await client.tracking.sessionByDevice.startV1({
      *         session_id: "session_id"
      *     })
      */
-    start(request: Chrt.tracking.SessionByDeviceStartRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __start;
+    startV1(request: Chrt.tracking.SessionByDeviceStartV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __startV1;
     /**
-     * Pause a session (set recording=false).
+     * Pauses location recording for a session by setting recording status to false. Device remains linked to the session.
      *
-     * @param {Chrt.tracking.SessionByDevicePauseRecordingRequest} request
+     * @param {Chrt.tracking.SessionByDevicePauseRecordingV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.pauseRecording({
+     *     await client.tracking.sessionByDevice.pauseRecordingV1({
      *         session_id: "session_id"
      *     })
      */
-    pauseRecording(request: Chrt.tracking.SessionByDevicePauseRecordingRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __pauseRecording;
+    pauseRecordingV1(request: Chrt.tracking.SessionByDevicePauseRecordingV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __pauseRecordingV1;
     /**
-     * Resume a session (set recording=true).
+     * Resumes location recording for a session by setting recording status to true.
      *
-     * @param {Chrt.tracking.SessionByDeviceResumeRecordingRequest} request
+     * @param {Chrt.tracking.SessionByDeviceResumeRecordingV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.resumeRecording({
+     *     await client.tracking.sessionByDevice.resumeRecordingV1({
      *         session_id: "session_id"
      *     })
      */
-    resumeRecording(request: Chrt.tracking.SessionByDeviceResumeRecordingRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __resumeRecording;
+    resumeRecordingV1(request: Chrt.tracking.SessionByDeviceResumeRecordingV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __resumeRecordingV1;
     /**
-     * End a session (set recording=false).
+     * Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session.
      *
-     * @param {Chrt.tracking.SessionByDeviceTerminateRequest} request
+     * @param {Chrt.tracking.SessionByDeviceTerminateV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.terminate({
+     *     await client.tracking.sessionByDevice.terminateV1({
      *         session_id: "session_id"
      *     })
      */
-    terminate(request: Chrt.tracking.SessionByDeviceTerminateRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __terminate;
+    terminateV1(request: Chrt.tracking.SessionByDeviceTerminateV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __terminateV1;
     /**
-     * Mark data points as outliers or non-outliers. Uses atomic delete + insert strategy for time-series collection updates.
+     * Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates.
      *
      * @param {Chrt.tracking.SessionByDeviceMarkOutliersRequest1} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
@@ -184,57 +184,57 @@ export declare class SessionByDevice {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.outlier({
+     *     await client.tracking.sessionByDevice.outlierV1({
      *         tracking_session_by_device_data_point_ids: ["tracking_session_by_device_data_point_ids"],
      *         outlier: true
      *     })
      */
-    outlier(request: Chrt.tracking.SessionByDeviceMarkOutliersRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceMarkOutliersResponse1>;
-    private __outlier;
+    outlierV1(request: Chrt.tracking.SessionByDeviceMarkOutliersRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceMarkOutliersResponse1>;
+    private __outlierV1;
     /**
-     * Delete a terminated session and all associated timeseries data.
+     * Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted.
      *
-     * @param {Chrt.tracking.SessionByDeviceDeleteRequest} request
+     * @param {Chrt.tracking.SessionByDeviceDeleteV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.delete({
+     *     await client.tracking.sessionByDevice.deleteV1({
      *         session_id: "session_id"
      *     })
      */
-    delete(request: Chrt.tracking.SessionByDeviceDeleteRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceDeleteResponse1>;
-    private __delete;
+    deleteV1(request: Chrt.tracking.SessionByDeviceDeleteV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceDeleteResponse1>;
+    private __deleteV1;
     /**
-     * Return the most recent datapoint for a session. Session must be have public=True.
+     * Returns the most recent data point for a public session, excluding outliers. No authentication required if session has public visibility enabled.
      *
-     * @param {Chrt.tracking.SessionByDeviceLastSeenPublicRequest} request
+     * @param {Chrt.tracking.SessionByDeviceLastSeenPublicV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.lastSeenPublic({
+     *     await client.tracking.sessionByDevice.lastSeenPublicV1({
      *         session_id: "session_id"
      *     })
      */
-    lastSeenPublic(request: Chrt.tracking.SessionByDeviceLastSeenPublicRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
-    private __lastSeenPublic;
+    lastSeenPublicV1(request: Chrt.tracking.SessionByDeviceLastSeenPublicV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
+    private __lastSeenPublicV1;
     /**
-     * Return a specified number of data points for a public session, intelligently sampled across the time range. Session must have public=True.
+     * Returns up to the specified number of data points for a public session, intelligently sampled across the time range. Excludes outliers. No authentication required if session has public visibility enabled.
      *
-     * @param {Chrt.tracking.SessionByDeviceDataPointsPublicRequest} request
+     * @param {Chrt.tracking.SessionByDeviceDataPointsPublicV1Request} request
      * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.sessionByDevice.dataPointsPublic({
+     *     await client.tracking.sessionByDevice.dataPointsPublicV1({
      *         session_id: "session_id"
      *     })
      */
-    dataPointsPublic(request: Chrt.tracking.SessionByDeviceDataPointsPublicRequest, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
-    private __dataPointsPublic;
+    dataPointsPublicV1(request: Chrt.tracking.SessionByDeviceDataPointsPublicV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
+    private __dataPointsPublicV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }