@chrt-inc/typescript-sdk 1.421.0 → 1.421.1

package/dist/cjs/Client.js

@@ -67,8 +67,8 @@ class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "1.421.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.421.0",
+                "X-Fern-SDK-Version": "1.421.1",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.421.1",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -31,82 +31,68 @@ export declare class Devices {
     protected readonly _options: Devices.Options;
     constructor(_options?: Devices.Options);
     /**
-     * Registers a tracking device to the caller's organization. If device is already registered to a different organization, registration is blocked. | (DevicesRegisterToOrgReq1) -> (PydanticObjectId)
+     * Registers a tracking device to the caller's organization. If the device is already registered to a different organization, returns 409 Conflict. | (DeviceClientCreate1) -> (PydanticObjectId)
      *
-     * @param {Chrt.tracking.DevicesRegisterToOrgReq1} request
+     * @param {Chrt.tracking.DeviceClientCreate1} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
      *     await client.tracking.devices.registerToOrgV1({
+     *         schema_version: 1,
      *         device_mac_address: "device_mac_address"
      *     })
      */
-    registerToOrgV1(request: Chrt.tracking.DevicesRegisterToOrgReq1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string>;
+    registerToOrgV1(request: Chrt.tracking.DeviceClientCreate1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string>;
     private __registerToOrgV1;
     /**
-     * Updates a device's type, comments, and/or off_chrt_order_id. Can update one or more fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)
+     * Updates a device's type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)
      *
-     * @param {Chrt.tracking.DevicesUpdateRequest1} request
+     * @param {Chrt.tracking.DeviceClientUpdate1} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.devices.updateV1()
-     */
-    updateV1(request?: Chrt.tracking.DevicesUpdateRequest1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateV1;
-    /**
-     * Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)
-     *
-     * @param {Chrt.tracking.DevicesDeleteV1Request} request
-     * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.tracking.devices.deleteV1({
-     *         device_id: "device_id",
-     *         device_mac_address: "device_mac_address"
+     *     await client.tracking.devices.updateV1({
+     *         device_id: "device_id"
      *     })
      */
-    deleteV1(request?: Chrt.tracking.DevicesDeleteV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteV1;
+    updateV1(request: Chrt.tracking.DeviceClientUpdate1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
     /**
-     * Links a device to cargo with bidirectional references. Device must not already be linked to a session or different cargo. | () -> (bool)
+     * Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)
      *
-     * @param {Chrt.tracking.DevicesLinkToCargoV1Request} request
+     * @param {Chrt.tracking.DevicesArchiveV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.devices.linkToCargoV1({
-     *         device_mac_address: "device_mac_address",
-     *         cargo_id: "cargo_id"
+     *     await client.tracking.devices.archiveV1({
+     *         device_id: "device_id"
      *     })
      */
-    linkToCargoV1(request: Chrt.tracking.DevicesLinkToCargoV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __linkToCargoV1;
+    archiveV1(request: Chrt.tracking.DevicesArchiveV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __archiveV1;
     /**
-     * Unlinks a device from its linked cargo, removing the bidirectional reference. Returns false if device is not linked to any cargo. | () -> (bool)
+     * Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)
      *
-     * @param {Chrt.tracking.DevicesUnlinkFromCargoV1Request} request
+     * @param {Chrt.tracking.DevicesUpdateSharedOrgsReq1} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.devices.unlinkFromCargoV1({
-     *         device_mac_address: "device_mac_address"
+     *     await client.tracking.devices.updateSharedOrgsV1({
+     *         device_id: "device_id"
      *     })
      */
-    unlinkFromCargoV1(request: Chrt.tracking.DevicesUnlinkFromCargoV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __unlinkFromCargoV1;
+    updateSharedOrgsV1(request: Chrt.tracking.DevicesUpdateSharedOrgsReq1, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateSharedOrgsV1;
     /**
-     * Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Device1)
+     * Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)
      *
      * @param {Chrt.tracking.DevicesGetV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
@@ -115,14 +101,13 @@ export declare class Devices {
      *
      * @example
      *     await client.tracking.devices.getV1({
-     *         device_mac_address: "device_mac_address",
      *         device_id: "device_id"
      *     })
      */
-    getV1(request?: Chrt.tracking.DevicesGetV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.Device1>;
+    getV1(request: Chrt.tracking.DevicesGetV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.DeviceExpandedRes>;
     private __getV1;
     /**
-     * Lists devices with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (DeviceListRes)
+     * Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)
      *
      * @param {Chrt.tracking.DevicesListV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
@@ -135,11 +120,11 @@ export declare class Devices {
      *         sort_order: "asc",
      *         page: 1,
      *         page_size: 1,
-     *         filter_off_chrt_order_id: "filter_off_chrt_order_id",
-     *         filter_device_mac_address: "filter_device_mac_address",
+     *         org_scope: "owned",
+     *         filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
      *         filter_type: "D15N-tag",
-     *         filter_cargo_id: "filter_cargo_id",
-     *         filter_session_id: "filter_session_id",
+     *         filter_active_cargo_id: "filter_active_cargo_id",
+     *         filter_active_session_id: "filter_active_session_id",
      *         filter_registered_at_timestamp_gte: "2024-01-15T09:30:00Z",
      *         filter_registered_at_timestamp_lte: "2024-01-15T09:30:00Z",
      *         filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
@@ -149,23 +134,24 @@ export declare class Devices {
     listV1(request?: Chrt.tracking.DevicesListV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.DeviceListRes>;
     private __listV1;
     /**
-     * Returns distinct off_chrt_order_id values matching the query via case-insensitive regex, searching devices. | 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 devices. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
      *
-     * @param {Chrt.tracking.DevicesTypeaheadOffChrtOrderIdV1Request} request
+     * @param {Chrt.tracking.DevicesTypeaheadV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.devices.typeaheadOffChrtOrderIdV1({
+     *     await client.tracking.devices.typeaheadV1({
      *         query: "query",
-     *         limit: 1
+     *         limit: 1,
+     *         org_scope: "owned"
      *     })
      */
-    typeaheadOffChrtOrderIdV1(request: Chrt.tracking.DevicesTypeaheadOffChrtOrderIdV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<string[]>;
-    private __typeaheadOffChrtOrderIdV1;
+    typeaheadV1(request: Chrt.tracking.DevicesTypeaheadV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.TrackingTypeaheadResult[]>;
+    private __typeaheadV1;
     /**
-     * Full-text search across device device_mac_address, comments, and off_chrt_order_id using Atlas Search. | authz: min_org_role=operator | () -> (DeviceSearchRes)
+     * Search across device device_mac_address, comments, and off_chrt_reference_id. Handles both partial (typing) and full query submission. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceSearchRes)
      *
      * @param {Chrt.tracking.DevicesSearchV1Request} request
      * @param {Devices.RequestOptions} requestOptions - Request-specific configuration.
@@ -176,7 +162,8 @@ export declare class Devices {
      *     await client.tracking.devices.searchV1({
      *         query: "query",
      *         page: 1,
-     *         page_size: 1
+     *         page_size: 1,
+     *         org_scope: "owned"
      *     })
      */
     searchV1(request: Chrt.tracking.DevicesSearchV1Request, requestOptions?: Devices.RequestOptions): core.HttpResponsePromise<Chrt.DeviceSearchRes>;