@chrt-inc/typescript-sdk 1.930.0 → 1.935.0

package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersListV1Request.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         sort_by: "mirrored_at_timestamp",
+ *         sort_order: "asc",
+ *         limit: 1,
+ *         page: 1,
+ *         search: "search",
+ *         filter_provider_org_id: ["filter_provider_org_id"],
+ *         filter_integration_order_id: "filter_integration_order_id",
+ *         filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
+ *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+ *         filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z"
+ *     }
+ */
+export interface OrdersListV1Request {
+    /** Field to sort by */
+    sort_by?: Chrt.AtlasOrderSortByEnum | null;
+    /** Sort direction */
+    sort_order?: Chrt.SortOrderEnum | null;
+    /** Max items to return */
+    limit?: number | null;
+    /** Page number (1-indexed) */
+    page?: number | null;
+    /** Search Atlas order IDs. */
+    search?: string | null;
+    /** Filter by provider org ID(s) */
+    filter_provider_org_id?: (string | null) | (string | null)[];
+    /** Filter by Atlas's exact order ID */
+    filter_integration_order_id?: string | null;
+    /** Filter mirrored_at_timestamp >= value */
+    filter_mirrored_at_timestamp_gte?: string | null;
+    /** Filter mirrored_at_timestamp <= value */
+    filter_mirrored_at_timestamp_lte?: 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 updated_at_timestamp >= value */
+    filter_updated_at_timestamp_gte?: string | null;
+    /** Filter updated_at_timestamp <= value */
+    filter_updated_at_timestamp_lte?: string | null;
+}

package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersListV1Request.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/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         query: "query",
+ *         limit: 1
+ *     }
+ */
+export interface OrdersTypeaheadV1Request {
+    /** Typeahead search query */
+    query: string;
+    /** Max results */
+    limit?: number | null;
+}

package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.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/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export { type OrdersListV1Request } from "./OrdersListV1Request.js";
+export { type AtlasOrderSyncOneReq } from "./AtlasOrderSyncOneReq.js";
+export { type OrdersTypeaheadV1Request } from "./OrdersTypeaheadV1Request.js";

package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.js

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

package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/index.d.ts

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

package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/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/shippingIntegrations/resources/connections/client/Client.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 Connections {
+    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 Connections {
+    protected readonly _options: Connections.Options;
+    constructor(_options?: Connections.Options);
+    /**
+     * Lists every provider the caller's organization has credentials for, across all shipping integrations, with public organization data expanded. | () -> (ShippingIntegrationConnectionListRes)
+     *
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.shippingIntegrations.connections.listV1()
+     */
+    listV1(requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShippingIntegrationConnectionListRes>;
+    private __listV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}

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

@@ -0,0 +1,121 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connections = void 0;
+const environments = __importStar(require("../../../../../../environments.js"));
+const core = __importStar(require("../../../../../../core/index.js"));
+const headers_js_1 = require("../../../../../../core/headers.js");
+const errors = __importStar(require("../../../../../../errors/index.js"));
+class Connections {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Lists every provider the caller's organization has credentials for, across all shipping integrations, with public organization data expanded. | () -> (ShippingIntegrationConnectionListRes)
+     *
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.shippingIntegrations.connections.listV1()
+     */
+    listV1(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listV1(requestOptions));
+    }
+    __listV1(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, "shipping_integrations/connections/list/v1"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: 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") {
+                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 /shipping_integrations/connections/list/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;
+        });
+    }
+}
+exports.Connections = Connections;

package/dist/cjs/api/resources/shippingIntegrations/resources/connections/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/api/resources/shippingIntegrations/resources/connections/client/index.js

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

package/dist/cjs/api/resources/shippingIntegrations/resources/connections/index.d.ts

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

package/dist/cjs/api/resources/shippingIntegrations/resources/connections/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/shippingIntegrations/resources/cxt/client/Client.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { Creds } from "../resources/creds/client/Client.js";
+import { Orders } from "../resources/orders/client/Client.js";
+export declare namespace Cxt {
+    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;
+    }
+}
+export declare class Cxt {
+    protected readonly _options: Cxt.Options;
+    protected _creds: Creds | undefined;
+    protected _orders: Orders | undefined;
+    constructor(_options?: Cxt.Options);
+    get creds(): Creds;
+    get orders(): Orders;
+}

package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/client/Client.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cxt = void 0;
+const Client_js_1 = require("../resources/creds/client/Client.js");
+const Client_js_2 = require("../resources/orders/client/Client.js");
+class Cxt {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get creds() {
+        var _a;
+        return ((_a = this._creds) !== null && _a !== void 0 ? _a : (this._creds = new Client_js_1.Creds(this._options)));
+    }
+    get orders() {
+        var _a;
+        return ((_a = this._orders) !== null && _a !== void 0 ? _a : (this._orders = new Client_js_2.Orders(this._options)));
+    }
+}
+exports.Cxt = Cxt;

package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/client/index.js

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

package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/index.d.ts

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

package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/index.js

@@ -0,0 +1,18 @@
+"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);
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/shippingIntegrations/resources/cxt/resources/creds/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 Creds {
+    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 Creds {
+    protected readonly _options: Creds.Options;
+    constructor(_options?: Creds.Options);
+    /**
+     * Returns the caller's CXT credential for one provider, without passwords or access tokens. | () -> (CxtCredsLimited1)
+     *
+     * @param {string} providerOrgId - Must be a string starting with `org_`
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.cxt.creds.detailV1("provider_org_id")
+     */
+    detailV1(providerOrgId: string, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<Chrt.CxtCredsLimited1>;
+    private __detailV1;
+    /**
+     * Lists the caller's CXT credentials, one per connected provider, without passwords or access tokens. | () -> (CxtCredsListRes)
+     *
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.shippingIntegrations.cxt.creds.listV1()
+     */
+    listV1(requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<Chrt.CxtCredsListRes>;
+    private __listV1;
+    /**
+     * Tests whether stored CXT credentials can authenticate against the provider. | authz: min_org_role=operator | () -> (CxtCredsTestRes)
+     *
+     * @param {string} providerOrgId - Must be a string starting with `org_`
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.cxt.creds.testV1("provider_org_id")
+     */
+    testV1(providerOrgId: string, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<Chrt.CxtCredsTestRes>;
+    private __testV1;
+    /**
+     * Stores CXT credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (CxtCredsClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {string} providerOrgId - Must be a string starting with `org_`
+     * @param {Chrt.shippingIntegrations.cxt.CxtCredsClientCreate1} request
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.cxt.creds.createV1("provider_org_id", {
+     *         base_url: "base_url",
+     *         cxt_auth_type: "xd_user",
+     *         password: "password",
+     *         schema_version: 1,
+     *         username: "username"
+     *     })
+     */
+    createV1(providerOrgId: string, request: Chrt.shippingIntegrations.cxt.CxtCredsClientCreate1, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
+    /**
+     * Deletes stored CXT credentials for one provider. | authz: min_org_role=administrator | () -> (bool)
+     *
+     * @param {string} providerOrgId - Must be a string starting with `org_`
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.cxt.creds.deleteV1("provider_org_id")
+     */
+    deleteV1(providerOrgId: string, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Updates stored CXT credentials for one provider. | authz: min_org_role=administrator | (CxtCredsClientUpdate1) -> (bool)
+     *
+     * @param {string} providerOrgId - Must be a string starting with `org_`
+     * @param {Chrt.shippingIntegrations.cxt.CxtCredsClientUpdate1} request
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.cxt.creds.updateV1("provider_org_id")
+     */
+    updateV1(providerOrgId: string, request?: Chrt.shippingIntegrations.cxt.CxtCredsClientUpdate1, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}