@chrt-inc/typescript-sdk 1.1020.0 → 1.1025.0

package/dist/cjs/Client.js

@@ -62,8 +62,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.1020.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.1020.0",
+                "X-Fern-SDK-Version": "1.1025.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.1025.0",
                 "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/orgs/resources/connections/client/Client.d.ts

@@ -192,6 +192,22 @@ export declare class Connections {
      */
     setShipperCoordinatorDefaultDepartmentV1(connectionId: string, request?: Chrt.orgs.ShipperCoordinatorConnectionClientUpdate1, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setShipperCoordinatorDefaultDepartmentV1;
+    /**
+     * Sets the coordinator's known-shipper designation for an on- or off-CHRT shipper and records who changed it and when. | authz: allowed_org_types=[provider], min_org_role=operator | (ShipperCoordinatorUpdateKnownShipperReq) -> (bool)
+     *
+     * @param {string} connectionId
+     * @param {Chrt.orgs.ShipperCoordinatorUpdateKnownShipperReq} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orgs.connections.setShipperCoordinatorKnownShipperV1("connection_id", {
+     *         known_shipper: true
+     *     })
+     */
+    setShipperCoordinatorKnownShipperV1(connectionId: string, request: Chrt.orgs.ShipperCoordinatorUpdateKnownShipperReq, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setShipperCoordinatorKnownShipperV1;
     /**
      * Lists the caller's shipper connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider] | () -> (ShipperCoordinatorConnectionsForCoordinatorListRes)
      *
@@ -206,7 +222,8 @@ export declare class Connections {
      *         page: 1,
      *         page_size: 1,
      *         filter_connection_ids: ["filter_connection_ids"],
-     *         filter_connected: true
+     *         filter_connected: true,
+     *         filter_known_shipper: true
      *     })
      */
     listShippersForCoordinatorV1(request?: Chrt.orgs.ConnectionsListShippersForCoordinatorV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShipperCoordinatorConnectionsForCoordinatorListRes>;

package/dist/cjs/api/resources/orgs/resources/connections/client/Client.js

@@ -760,6 +760,71 @@ class Connections {
             }
         });
     }
+    /**
+     * Sets the coordinator's known-shipper designation for an on- or off-CHRT shipper and records who changed it and when. | authz: allowed_org_types=[provider], min_org_role=operator | (ShipperCoordinatorUpdateKnownShipperReq) -> (bool)
+     *
+     * @param {string} connectionId
+     * @param {Chrt.orgs.ShipperCoordinatorUpdateKnownShipperReq} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orgs.connections.setShipperCoordinatorKnownShipperV1("connection_id", {
+     *         known_shipper: true
+     *     })
+     */
+    setShipperCoordinatorKnownShipperV1(connectionId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__setShipperCoordinatorKnownShipperV1(connectionId, request, requestOptions));
+    }
+    __setShipperCoordinatorKnownShipperV1(connectionId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.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, `orgs/connections/set_shipper_coordinator_known_shipper/v1/${encodeURIComponent(connectionId)}`),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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 PATCH /orgs/connections/set_shipper_coordinator_known_shipper/v1/{connection_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Lists the caller's shipper connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider] | () -> (ShipperCoordinatorConnectionsForCoordinatorListRes)
      *
@@ -774,7 +839,8 @@ class Connections {
      *         page: 1,
      *         page_size: 1,
      *         filter_connection_ids: ["filter_connection_ids"],
-     *         filter_connected: true
+     *         filter_connected: true,
+     *         filter_known_shipper: true
      *     })
      */
     listShippersForCoordinatorV1(request = {}, requestOptions) {
@@ -782,8 +848,8 @@ class Connections {
     }
     __listShippersForCoordinatorV1() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f, _g;
-            const { search, page, page_size: pageSize, filter_connection_ids: filterConnectionIds, filter_connected: filterConnected, } = request;
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { search, page, page_size: pageSize, filter_connection_ids: filterConnectionIds, filter_connected: filterConnected, filter_known_shipper: filterKnownShipper, } = request;
             const _queryParams = {};
             if (search !== undefined) {
                 _queryParams["search"] = search;
@@ -805,9 +871,12 @@ class Connections {
             if (filterConnected !== undefined) {
                 _queryParams["filter_connected"] = (_c = filterConnected === null || filterConnected === void 0 ? void 0 : filterConnected.toString()) !== null && _c !== void 0 ? _c : null;
             }
-            let _headers = (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_e = this._options.fetcher) !== null && _e !== void 0 ? _e : core.fetcher)({
-                url: core.url.join((_g = (_f = (yield core.Supplier.get(this._options.baseUrl))) !== null && _f !== void 0 ? _f : (yield core.Supplier.get(this._options.environment))) !== null && _g !== void 0 ? _g : environments.ChrtEnvironment.Local, "orgs/connections/shippers/list/for_coordinator/v1"),
+            if (filterKnownShipper !== undefined) {
+                _queryParams["filter_known_shipper"] = (_d = filterKnownShipper === null || filterKnownShipper === void 0 ? void 0 : filterKnownShipper.toString()) !== null && _d !== void 0 ? _d : null;
+            }
+            let _headers = (0, headers_js_1.mergeHeaders)((_e = this._options) === null || _e === void 0 ? void 0 : _e.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
+                url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.ChrtEnvironment.Local, "orgs/connections/shippers/list/for_coordinator/v1"),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),

package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersForCoordinatorV1Request.d.ts

@@ -8,7 +8,8 @@
  *         page: 1,
  *         page_size: 1,
  *         filter_connection_ids: ["filter_connection_ids"],
- *         filter_connected: true
+ *         filter_connected: true,
+ *         filter_known_shipper: true
  *     }
  */
 export interface ConnectionsListShippersForCoordinatorV1Request {
@@ -20,4 +21,6 @@ export interface ConnectionsListShippersForCoordinatorV1Request {
     filter_connection_ids?: (string | null) | (string | null)[];
     /** Filter by connection status */
     filter_connected?: boolean | null;
+    /** Filter by the coordinator's known-shipper designation */
+    filter_known_shipper?: boolean | null;
 }

package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ShipperCoordinatorUpdateKnownShipperReq.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         known_shipper: true
+ *     }
+ */
+export interface ShipperCoordinatorUpdateKnownShipperReq {
+    known_shipper: boolean;
+}

package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ShipperCoordinatorUpdateKnownShipperReq.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/orgs/resources/connections/client/requests/index.d.ts

@@ -4,4 +4,5 @@ export { type ConnectionsListExecutorsGeoSearchForCoordinatorV1Request } from ".
 export { type ConnectionsListExecutorsForCoordinatorV1Request } from "./ConnectionsListExecutorsForCoordinatorV1Request.js";
 export { type CoordinatorExecutorUpdateAutoAssignReq } from "./CoordinatorExecutorUpdateAutoAssignReq.js";
 export { type ShipperCoordinatorConnectionClientUpdate1 } from "./ShipperCoordinatorConnectionClientUpdate1.js";
+export { type ShipperCoordinatorUpdateKnownShipperReq } from "./ShipperCoordinatorUpdateKnownShipperReq.js";
 export { type ConnectionsListShippersForCoordinatorV1Request } from "./ConnectionsListShippersForCoordinatorV1Request.js";

package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "../../../../../../environments.js";
 import * as core from "../../../../../../core/index.js";
 import * as Chrt from "../../../../../index.js";
+import { S3Object } from "../resources/s3Object/client/Client.js";
 export declare namespace PublicData {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
@@ -29,7 +30,9 @@ export declare namespace PublicData {
 }
 export declare class PublicData {
     protected readonly _options: PublicData.Options;
+    protected _s3Object: S3Object | undefined;
     constructor(_options?: PublicData.Options);
+    get s3Object(): S3Object;
     /**
      * Returns the organization avatar URL or a placeholder. | () -> (str)
      *

package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.js

@@ -51,10 +51,15 @@ const core = __importStar(require("../../../../../../core/index.js"));
 const Chrt = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
+const Client_js_1 = require("../resources/s3Object/client/Client.js");
 class PublicData {
     constructor(_options = {}) {
         this._options = _options;
     }
+    get s3Object() {
+        var _a;
+        return ((_a = this._s3Object) !== null && _a !== void 0 ? _a : (this._s3Object = new Client_js_1.S3Object(this._options)));
+    }
     /**
      * Returns the organization avatar URL or a placeholder. | () -> (str)
      *

package/dist/cjs/api/resources/orgs/resources/publicData/index.d.ts

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

package/dist/cjs/api/resources/orgs/resources/publicData/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/orgs/resources/publicData/resources/index.d.ts

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

package/dist/cjs/api/resources/orgs/resources/publicData/resources/index.js

@@ -0,0 +1,41 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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.s3Object = void 0;
+exports.s3Object = __importStar(require("./s3Object/index.js"));
+__exportStar(require("./s3Object/client/requests/index.js"), exports);

package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.d.ts

@@ -0,0 +1,86 @@
+/**
+ * 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 S3Object {
+    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 S3Object {
+    protected readonly _options: S3Object.Options;
+    constructor(_options?: S3Object.Options);
+    /**
+     * Uploads a file, such as a logo, to the caller's organization public data. Retains uploaded files; previews require a clean malware scan. | authz: min_org_role=operator | (UploadFile) -> (OrgPublicDataS3ObjectMetadata1)
+     *
+     * @param {Chrt.orgs.publicData.BodyPostOrgPublicDataS3ObjectAddV1} request
+     * @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.orgs.publicData.s3Object.addV1({
+     *         file: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    addV1(request: Chrt.orgs.publicData.BodyPostOrgPublicDataS3ObjectAddV1, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<Chrt.OrgPublicDataS3ObjectMetadata1>;
+    private __addV1;
+    /**
+     * Deletes an S3 object and its metadata from the caller's organization public data. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orgPublicDataS3ObjectMetadataId
+     * @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orgs.publicData.s3Object.deleteV1("org_public_data_s3_object_metadata_id")
+     */
+    deleteV1(orgPublicDataS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Retrieves metadata for an organization public data S3 object. | () -> (OrgPublicDataS3ObjectMetadata1)
+     *
+     * @param {string} orgPublicDataS3ObjectMetadataId
+     * @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orgs.publicData.s3Object.getS3ObjectMetadataV1("org_public_data_s3_object_metadata_id")
+     */
+    getS3ObjectMetadataV1(orgPublicDataS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<Chrt.OrgPublicDataS3ObjectMetadata1>;
+    private __getS3ObjectMetadataV1;
+    /**
+     * Streams an organization public data S3 object file from storage. | () -> (binary)
+     * @throws {@link Chrt.ForbiddenError}
+     * @throws {@link Chrt.NotFoundError}
+     * @throws {@link Chrt.UnprocessableEntityError}
+     * @throws {@link Chrt.LockedError}
+     * @throws {@link Chrt.ServiceUnavailableError}
+     */
+    getV1(orgPublicDataS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __getV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}