@chrt-inc/typescript-sdk 1.325.0 → 1.331.0

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

@@ -1,242 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../../../environments.mjs";
-import * as core from "../../../../../../core/index.mjs";
-import * as Chrt from "../../../../../index.mjs";
-export declare namespace SessionByDevice {
-    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 SessionByDevice {
-    protected readonly _options: SessionByDevice.Options;
-    constructor(_options?: SessionByDevice.Options);
-    /**
-     * Returns all tracking sessions for the caller's organization. | () -> (list[Session1])
-     *
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.listV1()
-     */
-    listV1(requestOptions?: SessionByDevice.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.SessionByDeviceGetV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.getV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    getV1(request: Chrt.tracking.SessionByDeviceGetV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.Session1>;
-    private __getV1;
-    /**
-     * Returns the most recent data point for a session, excluding outliers. Access restricted to the caller's organization. | () -> (TrackingSessionByDeviceDataPoint1 | None)
-     *
-     * @param {Chrt.tracking.SessionByDeviceLastSeenV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.lastSeenV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    lastSeenV1(request: Chrt.tracking.SessionByDeviceLastSeenV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
-    private __lastSeenV1;
-    /**
-     * Returns up to the specified number of data points for a session, intelligently sampled across the time range. Excludes outliers. | () -> (list[TrackingSessionByDeviceDataPoint1])
-     *
-     * @param {Chrt.tracking.SessionByDeviceDataPointsV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.dataPointsV1({
-     *         session_id: "session_id",
-     *         limit: 1
-     *     })
-     */
-    dataPointsV1(request: Chrt.tracking.SessionByDeviceDataPointsV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
-    private __dataPointsV1;
-    /**
-     * Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionByDeviceCreateSessionRequest1) -> (PydanticObjectId)
-     *
-     * @param {Chrt.tracking.SessionByDeviceCreateSessionRequest1} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.createSessionV1({
-     *         device_mac_address: "device_mac_address"
-     *     })
-     */
-    createSessionV1(request: Chrt.tracking.SessionByDeviceCreateSessionRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<string>;
-    private __createSessionV1;
-    /**
-     * Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionByDeviceUpdateRequest1) -> (bool)
-     *
-     * @param {Chrt.tracking.SessionByDeviceUpdateRequest1} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.updateV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    updateV1(request: Chrt.tracking.SessionByDeviceUpdateRequest1, requestOptions?: SessionByDevice.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.SessionByDeviceStartV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.startV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    startV1(request: Chrt.tracking.SessionByDeviceStartV1Request, requestOptions?: SessionByDevice.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.SessionByDevicePauseRecordingV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.pauseRecordingV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    pauseRecordingV1(request: Chrt.tracking.SessionByDevicePauseRecordingV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __pauseRecordingV1;
-    /**
-     * Resumes location recording for a session by setting recording status to true. | () -> (bool)
-     *
-     * @param {Chrt.tracking.SessionByDeviceResumeRecordingV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.resumeRecordingV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    resumeRecordingV1(request: Chrt.tracking.SessionByDeviceResumeRecordingV1Request, requestOptions?: SessionByDevice.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.SessionByDeviceTerminateV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.terminateV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    terminateV1(request: Chrt.tracking.SessionByDeviceTerminateV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __terminateV1;
-    /**
-     * Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
-     *
-     * @param {Chrt.tracking.SessionByDeviceMarkOutliersRequest1} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.outlierV1({
-     *         tracking_session_by_device_data_point_ids: ["tracking_session_by_device_data_point_ids"],
-     *         outlier: true
-     *     })
-     */
-    outlierV1(request: Chrt.tracking.SessionByDeviceMarkOutliersRequest1, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceMarkOutliersResponse1>;
-    private __outlierV1;
-    /**
-     * Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionByDeviceDeleteResponse1)
-     *
-     * @param {Chrt.tracking.SessionByDeviceDeleteV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.deleteV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    deleteV1(request: Chrt.tracking.SessionByDeviceDeleteV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.SessionByDeviceDeleteResponse1>;
-    private __deleteV1;
-    /**
-     * Returns the most recent data point for a public session, excluding outliers. No authentication required if session has public visibility enabled. | () -> (TrackingSessionByDeviceDataPoint1 | None)
-     *
-     * @param {Chrt.tracking.SessionByDeviceLastSeenPublicV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.lastSeenPublicV1({
-     *         session_id: "session_id"
-     *     })
-     */
-    lastSeenPublicV1(request: Chrt.tracking.SessionByDeviceLastSeenPublicV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined>;
-    private __lastSeenPublicV1;
-    /**
-     * 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. | () -> (list[TrackingSessionByDeviceDataPoint1])
-     *
-     * @param {Chrt.tracking.SessionByDeviceDataPointsPublicV1Request} request
-     * @param {SessionByDevice.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.sessionByDevice.dataPointsPublicV1({
-     *         session_id: "session_id",
-     *         limit: 1
-     *     })
-     */
-    dataPointsPublicV1(request: Chrt.tracking.SessionByDeviceDataPointsPublicV1Request, requestOptions?: SessionByDevice.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSessionByDeviceDataPoint1[]>;
-    private __dataPointsPublicV1;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}

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

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         session_id: "session_id"
- *     }
- */
-export interface SessionByDevicePauseRecordingV1Request {
-    session_id: string;
-}

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

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         session_id: "session_id"
- *     }
- */
-export interface SessionByDeviceResumeRecordingV1Request {
-    session_id: string;
-}

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

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         session_id: "session_id"
- *     }
- */
-export interface SessionByDeviceTerminateV1Request {
-    session_id: string;
-}

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

@@ -1,13 +0,0 @@
-export { type SessionByDeviceGetV1Request } from "./SessionByDeviceGetV1Request.mjs";
-export { type SessionByDeviceLastSeenV1Request } from "./SessionByDeviceLastSeenV1Request.mjs";
-export { type SessionByDeviceDataPointsV1Request } from "./SessionByDeviceDataPointsV1Request.mjs";
-export { type SessionByDeviceCreateSessionRequest1 } from "./SessionByDeviceCreateSessionRequest1.mjs";
-export { type SessionByDeviceUpdateRequest1 } from "./SessionByDeviceUpdateRequest1.mjs";
-export { type SessionByDeviceStartV1Request } from "./SessionByDeviceStartV1Request.mjs";
-export { type SessionByDevicePauseRecordingV1Request } from "./SessionByDevicePauseRecordingV1Request.mjs";
-export { type SessionByDeviceResumeRecordingV1Request } from "./SessionByDeviceResumeRecordingV1Request.mjs";
-export { type SessionByDeviceTerminateV1Request } from "./SessionByDeviceTerminateV1Request.mjs";
-export { type SessionByDeviceMarkOutliersRequest1 } from "./SessionByDeviceMarkOutliersRequest1.mjs";
-export { type SessionByDeviceDeleteV1Request } from "./SessionByDeviceDeleteV1Request.mjs";
-export { type SessionByDeviceLastSeenPublicV1Request } from "./SessionByDeviceLastSeenPublicV1Request.mjs";
-export { type SessionByDeviceDataPointsPublicV1Request } from "./SessionByDeviceDataPointsPublicV1Request.mjs";

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

@@ -1,49 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../../../environments.mjs";
-import * as core from "../../../../../../core/index.mjs";
-import * as Chrt from "../../../../../index.mjs";
-export declare namespace TaskGroupByDriver {
-    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 TaskGroupByDriver {
-    protected readonly _options: TaskGroupByDriver.Options;
-    constructor(_options?: TaskGroupByDriver.Options);
-    /**
-     * Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TrackingTaskGroupByDriverDataPoint1 | None)
-     *
-     * @param {Chrt.tracking.TaskGroupByDriverLastSeenV1Request} request
-     * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.taskGroupByDriver.lastSeenV1({
-     *         task_group_id: "task_group_id"
-     *     })
-     */
-    lastSeenV1(request: Chrt.tracking.TaskGroupByDriverLastSeenV1Request, requestOptions?: TaskGroupByDriver.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingTaskGroupByDriverDataPoint1 | null) | undefined>;
-    private __lastSeenV1;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}

package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/Client.mjs

@@ -1,98 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import * as environments from "../../../../../../environments.mjs";
-import * as core from "../../../../../../core/index.mjs";
-import * as Chrt from "../../../../../index.mjs";
-import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
-import * as errors from "../../../../../../errors/index.mjs";
-export class TaskGroupByDriver {
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    /**
-     * Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TrackingTaskGroupByDriverDataPoint1 | None)
-     *
-     * @param {Chrt.tracking.TaskGroupByDriverLastSeenV1Request} request
-     * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.taskGroupByDriver.lastSeenV1({
-     *         task_group_id: "task_group_id"
-     *     })
-     */
-    lastSeenV1(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__lastSeenV1(request, requestOptions));
-    }
-    __lastSeenV1(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            const { task_group_id: taskGroupId } = request;
-            const _queryParams = {};
-            _queryParams["task_group_id"] = taskGroupId;
-            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "tracking/task_group_by_driver/last_seen/v1"),
-                method: "GET",
-                headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.ChrtError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.ChrtError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/task_group_by_driver/last_seen/v1.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    _getAuthorizationHeader() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const bearer = yield core.Supplier.get(this._options.token);
-            if (bearer != null) {
-                return `Bearer ${bearer}`;
-            }
-            return undefined;
-        });
-    }
-}

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

@@ -1 +0,0 @@
-export { type TaskGroupByDriverLastSeenV1Request } from "./TaskGroupByDriverLastSeenV1Request.mjs";