@chrt-inc/typescript-sdk 1.925.0 → 1.929.0

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/GeofenceTemplatesListV1Request.d.ts

@@ -0,0 +1,45 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         sort_by: "created_at_timestamp",
+ *         sort_order: "asc",
+ *         page: 1,
+ *         page_size: 1,
+ *         filter_archived: true,
+ *         filter_owned_by_user_id: "filter_owned_by_user_id",
+ *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+ *         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
+ *         filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z"
+ *     }
+ */
+export interface GeofenceTemplatesListV1Request {
+    /** Field to sort by. */
+    sort_by?: Chrt.GeofenceTemplateSortByEnum | null;
+    /** Sort order. */
+    sort_order?: Chrt.SortOrderEnum | null;
+    page?: number | null;
+    page_size?: number | null;
+    /** Include archived templates instead of active templates. */
+    filter_archived?: boolean | null;
+    /** Filter by the user that created the template. */
+    filter_owned_by_user_id?: string | null;
+    /** Filter created_at_timestamp >= value. */
+    filter_created_at_timestamp_gte?: string | null;
+    /** Filter created_at_timestamp <= value. */
+    filter_created_at_timestamp_lte?: string | null;
+    /** Filter last_edited_at_timestamp >= value. */
+    filter_last_edited_at_timestamp_gte?: string | null;
+    /** Filter last_edited_at_timestamp <= value. */
+    filter_last_edited_at_timestamp_lte?: string | null;
+    /** Filter last_used_at_timestamp >= value. */
+    filter_last_used_at_timestamp_gte?: string | null;
+    /** Filter last_used_at_timestamp <= value. */
+    filter_last_used_at_timestamp_lte?: string | null;
+}

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientCreate1.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         geofences: [{
+ *                 display_name: "display_name",
+ *                 location: {
+ *                     geometry: {
+ *                         coordinates: [],
+ *                         type: "Point"
+ *                     },
+ *                     type: "Feature"
+ *                 },
+ *                 radius_miles: 1.1
+ *             }],
+ *         name: "name",
+ *         schema_version: 1
+ *     }
+ */
+export interface SessionGeofenceTemplateClientCreate1 {
+    description?: string | null;
+    geofences: Chrt.SessionGeofenceBase1[];
+    name: string;
+    schema_version: number;
+}

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientUpdate1.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface SessionGeofenceTemplateClientUpdate1 {
+    description?: string | null;
+    description__set_to_None?: boolean;
+    geofences?: Chrt.SessionGeofenceBase1[];
+    name?: string | null;
+}

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/SessionGeofenceTemplateClientUpdate1.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,3 @@
+export { type GeofenceTemplatesListV1Request } from "./GeofenceTemplatesListV1Request.js";
+export { type SessionGeofenceTemplateClientUpdate1 } from "./SessionGeofenceTemplateClientUpdate1.js";
+export { type SessionGeofenceTemplateClientCreate1 } from "./SessionGeofenceTemplateClientCreate1.js";

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/cjs/api/resources/tracking/resources/geofenceTemplates/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/tracking/resources/index.d.ts

@@ -1,9 +1,13 @@
 export * as devices from "./devices/index.js";
 export * as driver from "./driver/index.js";
+export * as geofenceTemplates from "./geofenceTemplates/index.js";
 export * as sessions from "./sessions/index.js";
+export * as sessionGeofences from "./sessionGeofences/index.js";
 export * as sharingSettings from "./sharingSettings/index.js";
 export * as timeseries from "./timeseries/index.js";
 export * from "./devices/client/requests/index.js";
 export * from "./driver/client/requests/index.js";
+export * from "./geofenceTemplates/client/requests/index.js";
 export * from "./sessions/client/requests/index.js";
+export * from "./sessionGeofences/client/requests/index.js";
 export * from "./sharingSettings/client/requests/index.js";

package/dist/cjs/api/resources/tracking/resources/index.js

@@ -36,13 +36,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.timeseries = exports.sharingSettings = exports.sessions = exports.driver = exports.devices = void 0;
+exports.timeseries = exports.sharingSettings = exports.sessionGeofences = exports.sessions = exports.geofenceTemplates = exports.driver = exports.devices = void 0;
 exports.devices = __importStar(require("./devices/index.js"));
 exports.driver = __importStar(require("./driver/index.js"));
+exports.geofenceTemplates = __importStar(require("./geofenceTemplates/index.js"));
 exports.sessions = __importStar(require("./sessions/index.js"));
+exports.sessionGeofences = __importStar(require("./sessionGeofences/index.js"));
 exports.sharingSettings = __importStar(require("./sharingSettings/index.js"));
 exports.timeseries = __importStar(require("./timeseries/index.js"));
 __exportStar(require("./devices/client/requests/index.js"), exports);
 __exportStar(require("./driver/client/requests/index.js"), exports);
+__exportStar(require("./geofenceTemplates/client/requests/index.js"), exports);
 __exportStar(require("./sessions/client/requests/index.js"), exports);
+__exportStar(require("./sessionGeofences/client/requests/index.js"), exports);
 __exportStar(require("./sharingSettings/client/requests/index.js"), exports);

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

@@ -0,0 +1,117 @@
+/**
+ * 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 SessionGeofences {
+    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 SessionGeofences {
+    protected readonly _options: SessionGeofences.Options;
+    constructor(_options?: SessionGeofences.Options);
+    /**
+     * Adds a geofence to an active session. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceClientCreate1) -> (Session2)
+     *
+     * @param {string} sessionId
+     * @param {Chrt.SessionGeofenceClientCreate1} request
+     * @param {SessionGeofences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionGeofences.addV1("session_id", {
+     *         display_name: "display_name",
+     *         location: {
+     *             geometry: {
+     *                 coordinates: [],
+     *                 type: "Point"
+     *             },
+     *             type: "Feature"
+     *         },
+     *         radius_miles: 1.1
+     *     })
+     */
+    addV1(sessionId: string, request: Chrt.SessionGeofenceClientCreate1, requestOptions?: SessionGeofences.RequestOptions): core.HttpResponsePromise<Chrt.Session2>;
+    private __addV1;
+    /**
+     * Replaces an active session's geofences from an active organization template. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceApplyTemplateReq) -> (Session2)
+     *
+     * @param {string} sessionId
+     * @param {Chrt.tracking.SessionGeofenceApplyTemplateReq} request
+     * @param {SessionGeofences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionGeofences.applyTemplateV1("session_id", {
+     *         geofence_template_id: "geofence_template_id"
+     *     })
+     */
+    applyTemplateV1(sessionId: string, request: Chrt.tracking.SessionGeofenceApplyTemplateReq, requestOptions?: SessionGeofences.RequestOptions): core.HttpResponsePromise<Chrt.Session2>;
+    private __applyTemplateV1;
+    /**
+     * Reorders an active session's geofences using an exact ID permutation. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceReorderReq) -> (Session2)
+     *
+     * @param {string} sessionId
+     * @param {Chrt.tracking.SessionGeofenceReorderReq} request
+     * @param {SessionGeofences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionGeofences.reorderV1("session_id")
+     */
+    reorderV1(sessionId: string, request?: Chrt.tracking.SessionGeofenceReorderReq, requestOptions?: SessionGeofences.RequestOptions): core.HttpResponsePromise<Chrt.Session2>;
+    private __reorderV1;
+    /**
+     * Updates a session geofence, resetting entry state only when location or radius changes. | auth: api_key | authz: min_org_role=operator | (SessionGeofenceClientUpdate1) -> (Session2)
+     *
+     * @param {string} sessionId
+     * @param {string} geofenceId
+     * @param {Chrt.tracking.SessionGeofenceClientUpdate1} request
+     * @param {SessionGeofences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionGeofences.updateV1("session_id", "geofence_id")
+     */
+    updateV1(sessionId: string, geofenceId: string, request?: Chrt.tracking.SessionGeofenceClientUpdate1, requestOptions?: SessionGeofences.RequestOptions): core.HttpResponsePromise<Chrt.Session2>;
+    private __updateV1;
+    /**
+     * Removes a geofence from an active session. | auth: api_key | authz: min_org_role=operator | () -> (Session2)
+     *
+     * @param {string} sessionId
+     * @param {string} geofenceId
+     * @param {SessionGeofences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.tracking.sessionGeofences.removeV1("session_id", "geofence_id")
+     */
+    removeV1(sessionId: string, geofenceId: string, requestOptions?: SessionGeofences.RequestOptions): core.HttpResponsePromise<Chrt.Session2>;
+    private __removeV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}