@chrt-inc/typescript-sdk 1.326.0 → 1.331.0

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

@@ -0,0 +1,164 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.js";
+import * as core from "../../../../../../core/index.js";
+import * as Chrt from "../../../../../index.js";
+export declare namespace Sessions {
+    interface Options {
+        environment?: core.Supplier<environments.ChrtEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Sessions {
+    protected readonly _options: Sessions.Options;
+    constructor(_options?: Sessions.Options);
+    /**
+     * Returns all tracking sessions for the caller's organization. | () -> (list[Session1])
+     *
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.tracking.sessions.listV1()
+     */
+    listV1(requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.Session1[]>;
+    private __listV1;
+    /**
+     * Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)
+     *
+     * @param {Chrt.tracking.SessionsGetV1Request} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.getV1({
+     *         session_id: "session_id"
+     *     })
+     */
+    getV1(request: Chrt.tracking.SessionsGetV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
+    private __getV1;
+    /**
+     * 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)
+     *
+     * @param {Chrt.tracking.SessionCreateSessionRequest1} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.createSessionV1({
+     *         device_mac_address: "device_mac_address"
+     *     })
+     */
+    createSessionV1(request: Chrt.tracking.SessionCreateSessionRequest1, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<string>;
+    private __createSessionV1;
+    /**
+     * Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionUpdateRequest1) -> (bool)
+     *
+     * @param {Chrt.tracking.SessionUpdateRequest1} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.updateV1({
+     *         session_id: "session_id"
+     *     })
+     */
+    updateV1(request: Chrt.tracking.SessionUpdateRequest1, 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)
+     *
+     * @param {Chrt.tracking.SessionsStartV1Request} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.startV1({
+     *         session_id: "session_id"
+     *     })
+     */
+    startV1(request: Chrt.tracking.SessionsStartV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __startV1;
+    /**
+     * Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)
+     *
+     * @param {Chrt.tracking.SessionsPauseRecordingV1Request} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.pauseRecordingV1({
+     *         session_id: "session_id"
+     *     })
+     */
+    pauseRecordingV1(request: Chrt.tracking.SessionsPauseRecordingV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __pauseRecordingV1;
+    /**
+     * Resumes location recording for a session by setting recording status to true. | () -> (bool)
+     *
+     * @param {Chrt.tracking.SessionsResumeRecordingV1Request} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.resumeRecordingV1({
+     *         session_id: "session_id"
+     *     })
+     */
+    resumeRecordingV1(request: Chrt.tracking.SessionsResumeRecordingV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __resumeRecordingV1;
+    /**
+     * Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)
+     *
+     * @param {Chrt.tracking.SessionsTerminateV1Request} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.terminateV1({
+     *         session_id: "session_id"
+     *     })
+     */
+    terminateV1(request: Chrt.tracking.SessionsTerminateV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __terminateV1;
+    /**
+     * Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionDeleteResponse1)
+     *
+     * @param {Chrt.tracking.SessionsDeleteV1Request} request
+     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessions.deleteV1({
+     *         session_id: "session_id"
+     *     })
+     */
+    deleteV1(request: Chrt.tracking.SessionsDeleteV1Request, requestOptions?: Sessions.RequestOptions): core.HttpResponsePromise<Chrt.SessionDeleteResponse1>;
+    private __deleteV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}