@chrt-inc/typescript-sdk 0.0.170 → 0.0.179

package/dist/cjs/api/resources/root/client/Client.d.ts

@@ -3,7 +3,6 @@
  */
 import * as environments from "../../../../environments.js";
 import * as core from "../../../../core/index.js";
-import * as Chrt from "../../../index.js";
 export declare namespace Root {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
@@ -29,66 +28,54 @@ export declare class Root {
     protected readonly _options: Root.Options;
     constructor(_options?: Root.Options);
     /**
-     * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
+     * Test endpoint for authenticated requests that requires valid authentication tokens.
      *
-     * @example
-     *     await client.root.getAuthd()
-     */
-    getAuthd(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<Record<string, string>>;
-    private __getAuthd;
-    /**
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.postAuthd()
+     *     await client.root.pingAuthd()
      */
-    postAuthd(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
-    private __postAuthd;
+    pingAuthd(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<Record<string, string>>;
+    private __pingAuthd;
     /**
+     * Test endpoint for optionally authenticated requests that works with or without authentication.
+     *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getOptionallyAuthd()
+     *     await client.root.pingOptionallyAuthd()
      */
-    getOptionallyAuthd(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
-    private __getOptionallyAuthd;
+    pingOptionallyAuthd(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __pingOptionallyAuthd;
     /**
      * Returns a greeting message
      *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getRoot()
+     *     await client.root.pingUnauthd()
      */
-    getRoot(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
-    private __getRoot;
+    pingUnauthd(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __pingUnauthd;
     /**
      * Used for monitoring system health
      *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getHealth()
-     */
-    getHealth(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
-    private __getHealth;
-    /**
-     * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.root.getFailure()
+     *     await client.root.health()
      */
-    getFailure(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
-    private __getFailure;
+    health(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __health;
     /**
-     * This route exposes pydantic models - which are not returned by any other route - to the OpenAPI spec to ensure they get included during sdk codegen
+     * Test endpoint that intentionally fails for error handling validation and monitoring purposes.
      *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.pydantic()
+     *     await client.root.failure()
      */
-    pydantic(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<Chrt.PydanticResponse>;
-    private __pydantic;
+    failure(requestOptions?: Root.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __failure;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/cjs/api/resources/root/client/Client.js

@@ -55,15 +55,17 @@ class Root {
         this._options = _options;
     }
     /**
+     * Test endpoint for authenticated requests that requires valid authentication tokens.
+     *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getAuthd()
+     *     await client.root.pingAuthd()
      */
-    getAuthd(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getAuthd(requestOptions));
+    pingAuthd(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingAuthd(requestOptions));
     }
-    __getAuthd(requestOptions) {
+    __pingAuthd(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -102,62 +104,17 @@ class Root {
         });
     }
     /**
-     * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
+     * Test endpoint for optionally authenticated requests that works with or without authentication.
      *
-     * @example
-     *     await client.root.postAuthd()
-     */
-    postAuthd(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__postAuthd(requestOptions));
-    }
-    __postAuthd(requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "authd"),
-                method: "POST",
-                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),
-                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 POST /authd.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    /**
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getOptionallyAuthd()
+     *     await client.root.pingOptionallyAuthd()
      */
-    getOptionallyAuthd(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getOptionallyAuthd(requestOptions));
+    pingOptionallyAuthd(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingOptionallyAuthd(requestOptions));
     }
-    __getOptionallyAuthd(requestOptions) {
+    __pingOptionallyAuthd(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -201,12 +158,12 @@ class Root {
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getRoot()
+     *     await client.root.pingUnauthd()
      */
-    getRoot(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getRoot(requestOptions));
+    pingUnauthd(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingUnauthd(requestOptions));
     }
-    __getRoot(requestOptions) {
+    __pingUnauthd(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -250,12 +207,12 @@ class Root {
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getHealth()
+     *     await client.root.health()
      */
-    getHealth(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getHealth(requestOptions));
+    health(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__health(requestOptions));
     }
-    __getHealth(requestOptions) {
+    __health(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -294,15 +251,17 @@ class Root {
         });
     }
     /**
+     * Test endpoint that intentionally fails for error handling validation and monitoring purposes.
+     *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.getFailure()
+     *     await client.root.failure()
      */
-    getFailure(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getFailure(requestOptions));
+    failure(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__failure(requestOptions));
     }
-    __getFailure(requestOptions) {
+    __failure(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -340,55 +299,6 @@ class Root {
             }
         });
     }
-    /**
-     * This route exposes pydantic models - which are not returned by any other route - to the OpenAPI spec to ensure they get included during sdk codegen
-     *
-     * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.root.pydantic()
-     */
-    pydantic(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__pydantic(requestOptions));
-    }
-    __pydantic(requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "pydantic"),
-                method: "GET",
-                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),
-                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 /pydantic.");
-                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);

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

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

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

@@ -14,5 +14,4 @@ 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("./types/index.js"), exports);
 __exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/shipperContactInfo/client/Client.d.ts

@@ -0,0 +1,148 @@
+/**
+ * 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 ShipperContactInfo {
+    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 | undefined> | 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 headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class ShipperContactInfo {
+    protected readonly _options: ShipperContactInfo.Options;
+    constructor(_options?: ShipperContactInfo.Options);
+    /**
+     * Retrieves the authenticated user's own shipper contact information.
+     *
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.shipperContactInfo.getByJwtUserId()
+     */
+    getByJwtUserId(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
+    private __getByJwtUserId;
+    /**
+     * Lists all shipper contacts created by the authenticated organization.
+     *
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.shipperContactInfo.listByJwtOrgId()
+     */
+    listByJwtOrgId(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    private __listByJwtOrgId;
+    /**
+     * Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
+     *
+     * @param {string} shipperOrgId
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_id")
+     */
+    listCourierContactsByShipperOrgId(shipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    private __listCourierContactsByShipperOrgId;
+    /**
+     * Lists all shipper contacts for a specific off-platform shipper connection.
+     *
+     * @param {string} offChrtShipperOrgConnectionInfoId
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chrt_shipper_org_connection_info_id")
+     */
+    listByOffChrtShipperOrgConnectionInfoId(offChrtShipperOrgConnectionInfoId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    private __listByOffChrtShipperOrgConnectionInfoId;
+    /**
+     * Retrieves a specific shipper contact by ID if authorized to access it.
+     *
+     * @param {string} id
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperContactInfo.getById("id")
+     */
+    getById(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
+    private __getById;
+    /**
+     * Creates contact information for an on-platform shipper organization or user.
+     *
+     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperContactInfo.createOnPlatform({
+     *         schema_version: 1
+     *     })
+     */
+    createOnPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
+    private __createOnPlatform;
+    /**
+     * Creates contact information for an off-platform shipper using connection info.
+     *
+     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperContactInfo.createOffPlatform({
+     *         schema_version: 1
+     *     })
+     */
+    createOffPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
+    private __createOffPlatform;
+    /**
+     * Updates existing shipper contact information owned by the authenticated organization.
+     *
+     * @param {string} shipperContactInfoId
+     * @param {Chrt.ShipperContactInfoClientUpdate1} request
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperContactInfo.update("shipper_contact_info_id")
+     */
+    update(shipperContactInfoId: string, request?: Chrt.ShipperContactInfoClientUpdate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __update;
+    /**
+     * Deletes shipper contact information owned by the authenticated organization.
+     *
+     * @param {string} id
+     * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipperContactInfo.deleteById("id")
+     */
+    deleteById(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteById;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}