@chrt-inc/typescript-sdk 1.930.0 → 1.935.0

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

@@ -0,0 +1,44 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         filter_shipping_integration: ["xcelerator"],
+ *         filter_provider_org_id: ["filter_provider_org_id"],
+ *         filter_status: ["staged"],
+ *         filter_integration_order_id: "filter_integration_order_id",
+ *         filter_reference_number: "filter_reference_number",
+ *         filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
+ *         filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
+ *         filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
+ *         filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z"
+ *     }
+ */
+export interface OrdersStatusSummaryV1Request {
+    /** Filter by shipping integration(s) */
+    filter_shipping_integration?: (Chrt.OrgShippingIntegrationEnum1 | null) | (Chrt.OrgShippingIntegrationEnum1 | null)[];
+    /** Filter by provider org ID(s) */
+    filter_provider_org_id?: (string | null) | (string | null)[];
+    /** Filter by unified status(es) */
+    filter_status?: (Chrt.ShippingIntegrationOrderStatusEnum1 | null) | (Chrt.ShippingIntegrationOrderStatusEnum1 | null)[];
+    /** Filter by the provider's exact order ID */
+    filter_integration_order_id?: string | null;
+    /** Filter by an exact reference number carried on the order */
+    filter_reference_number?: string | null;
+    /** Filter ordered_at_timestamp >= value */
+    filter_ordered_at_timestamp_gte?: string | null;
+    /** Filter ordered_at_timestamp <= value */
+    filter_ordered_at_timestamp_lte?: string | null;
+    /** Filter last_mirrored_at_timestamp >= value */
+    filter_last_mirrored_at_timestamp_gte?: string | null;
+    /** Filter last_mirrored_at_timestamp <= value */
+    filter_last_mirrored_at_timestamp_lte?: string | null;
+    /** Filter first_mirrored_at_timestamp >= value */
+    filter_first_mirrored_at_timestamp_gte?: string | null;
+    /** Filter first_mirrored_at_timestamp <= value */
+    filter_first_mirrored_at_timestamp_lte?: string | null;
+}

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

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

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

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

package/dist/cjs/api/resources/shippingIntegrations/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/xcelerator/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 Xcelerator {
+    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 Xcelerator {
+    protected readonly _options: Xcelerator.Options;
+    protected _creds: Creds | undefined;
+    protected _orders: Orders | undefined;
+    constructor(_options?: Xcelerator.Options);
+    get creds(): Creds;
+    get orders(): Orders;
+}

package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/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.Xcelerator = void 0;
+const Client_js_1 = require("../resources/creds/client/Client.js");
+const Client_js_2 = require("../resources/orders/client/Client.js");
+class Xcelerator {
+    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.Xcelerator = Xcelerator;

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

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

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

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

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

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

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

@@ -0,0 +1,116 @@
+/**
+ * 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 Xcelerator credential for one provider, without password or access token. | () -> (XceleratorCredsLimited1)
+     *
+     * @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.xcelerator.creds.detailV1("provider_org_id")
+     */
+    detailV1(providerOrgId: string, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<Chrt.XceleratorCredsLimited1>;
+    private __detailV1;
+    /**
+     * Lists the caller's Xcelerator credentials, one per connected provider, without password or access token. | () -> (XceleratorCredsListRes)
+     *
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.shippingIntegrations.xcelerator.creds.listV1()
+     */
+    listV1(requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<Chrt.XceleratorCredsListRes>;
+    private __listV1;
+    /**
+     * Confirms the caller's stored Xcelerator credentials for one provider can still obtain an access token, and best-effort refreshes the provider's own account label for the caller to eyeball. | authz: min_org_role=operator | () -> (XceleratorCredsTestRes)
+     *
+     * @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.xcelerator.creds.testV1("provider_org_id")
+     */
+    testV1(providerOrgId: string, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<Chrt.XceleratorCredsTestRes>;
+    private __testV1;
+    /**
+     * Stores Xcelerator credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (XceleratorCredsClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {string} providerOrgId - Must be a string starting with `org_`
+     * @param {Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientCreate1} request
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.xcelerator.creds.createV1("provider_org_id", {
+     *         base_url: "https://tenant.dispatchscience.com",
+     *         password: "password",
+     *         schema_version: 1,
+     *         username: "username"
+     *     })
+     */
+    createV1(providerOrgId: string, request: Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientCreate1, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
+    /**
+     * Deletes the caller's Xcelerator credentials for one provider, stopping future syncs. | 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.xcelerator.creds.deleteV1("provider_org_id")
+     */
+    deleteV1(providerOrgId: string, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Updates the caller's Xcelerator credentials for one provider. | authz: min_org_role=administrator | (XceleratorCredsClientUpdate1) -> (bool)
+     *
+     * @param {string} providerOrgId - Must be a string starting with `org_`
+     * @param {Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientUpdate1} request
+     * @param {Creds.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shippingIntegrations.xcelerator.creds.updateV1("provider_org_id")
+     */
+    updateV1(providerOrgId: string, request?: Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientUpdate1, requestOptions?: Creds.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}