@chrt-inc/typescript-sdk 0.1.0-beta0 → 0.1.0-beta1

package/README.md

@@ -58,6 +58,7 @@ try {
         console.log(err.statusCode);
         console.log(err.message);
         console.log(err.body);
+        console.log(err.rawResponse);
     }
 }
 ```
@@ -79,10 +80,10 @@ const response = await client.dev.postTemplate(..., {
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
 retry limit (default: 2).
 
-A request is deemed retriable when any of the following HTTP status codes is returned:
+A request is deemed retryable when any of the following HTTP status codes is returned:
 
 - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
 - [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
@@ -118,6 +119,18 @@ const response = await client.dev.postTemplate(..., {
 controller.abort(); // aborts the request
 ```
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.dev.postTemplate(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
 ### Runtime Compatibility
 
 The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
@@ -132,7 +145,7 @@ runtimes:
 
 ### Customizing Fetch Client
 
-The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
 unsupported environment, this provides a way for you to break glass and ensure the SDK works.
 
 ```typescript

package/dist/cjs/Client.d.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 { Dev } from "./api/resources/dev/client/Client.js";
+import { Directory } from "./api/resources/directory/client/Client.js";
+import { Messages } from "./api/resources/messages/client/Client.js";
+import { OortDrivers } from "./api/resources/oortDrivers/client/Client.js";
+import { OortHandles } from "./api/resources/oortHandles/client/Client.js";
+import { OortMilestones } from "./api/resources/oortMilestones/client/Client.js";
+import { OortOrgProfiles } from "./api/resources/oortOrgProfiles/client/Client.js";
+import { OortOrders } from "./api/resources/oortOrders/client/Client.js";
+import { OortRateSheets } from "./api/resources/oortRateSheets/client/Client.js";
+import { OortRoutes } from "./api/resources/oortRoutes/client/Client.js";
+import { OortShippers } from "./api/resources/oortShippers/client/Client.js";
+import { OortTaskGroups } from "./api/resources/oortTaskGroups/client/Client.js";
+import { Orgs } from "./api/resources/orgs/client/Client.js";
+import { Payments } from "./api/resources/payments/client/Client.js";
+import { Profiles } from "./api/resources/profiles/client/Client.js";
+import { Root } from "./api/resources/root/client/Client.js";
+import { Users } from "./api/resources/users/client/Client.js";
+import { Mirror } from "./api/resources/mirror/client/Client.js";
+import { OortCourierPayDriverRate } from "./api/resources/oortCourierPayDriverRate/client/Client.js";
+export declare namespace ChrtClient {
+    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 ChrtClient {
+    protected readonly _options: ChrtClient.Options;
+    protected _dev: Dev | undefined;
+    protected _directory: Directory | undefined;
+    protected _messages: Messages | undefined;
+    protected _oortDrivers: OortDrivers | undefined;
+    protected _oortHandles: OortHandles | undefined;
+    protected _oortMilestones: OortMilestones | undefined;
+    protected _oortOrgProfiles: OortOrgProfiles | undefined;
+    protected _oortOrders: OortOrders | undefined;
+    protected _oortRateSheets: OortRateSheets | undefined;
+    protected _oortRoutes: OortRoutes | undefined;
+    protected _oortShippers: OortShippers | undefined;
+    protected _oortTaskGroups: OortTaskGroups | undefined;
+    protected _orgs: Orgs | undefined;
+    protected _payments: Payments | undefined;
+    protected _profiles: Profiles | undefined;
+    protected _root: Root | undefined;
+    protected _users: Users | undefined;
+    protected _mirror: Mirror | undefined;
+    protected _oortCourierPayDriverRate: OortCourierPayDriverRate | undefined;
+    constructor(_options?: ChrtClient.Options);
+    get dev(): Dev;
+    get directory(): Directory;
+    get messages(): Messages;
+    get oortDrivers(): OortDrivers;
+    get oortHandles(): OortHandles;
+    get oortMilestones(): OortMilestones;
+    get oortOrgProfiles(): OortOrgProfiles;
+    get oortOrders(): OortOrders;
+    get oortRateSheets(): OortRateSheets;
+    get oortRoutes(): OortRoutes;
+    get oortShippers(): OortShippers;
+    get oortTaskGroups(): OortTaskGroups;
+    get orgs(): Orgs;
+    get payments(): Payments;
+    get profiles(): Profiles;
+    get root(): Root;
+    get users(): Users;
+    get mirror(): Mirror;
+    get oortCourierPayDriverRate(): OortCourierPayDriverRate;
+}

package/dist/cjs/Client.js

@@ -0,0 +1,149 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChrtClient = void 0;
+const core = __importStar(require("./core/index.js"));
+const headers_js_1 = require("./core/headers.js");
+const Client_js_1 = require("./api/resources/dev/client/Client.js");
+const Client_js_2 = require("./api/resources/directory/client/Client.js");
+const Client_js_3 = require("./api/resources/messages/client/Client.js");
+const Client_js_4 = require("./api/resources/oortDrivers/client/Client.js");
+const Client_js_5 = require("./api/resources/oortHandles/client/Client.js");
+const Client_js_6 = require("./api/resources/oortMilestones/client/Client.js");
+const Client_js_7 = require("./api/resources/oortOrgProfiles/client/Client.js");
+const Client_js_8 = require("./api/resources/oortOrders/client/Client.js");
+const Client_js_9 = require("./api/resources/oortRateSheets/client/Client.js");
+const Client_js_10 = require("./api/resources/oortRoutes/client/Client.js");
+const Client_js_11 = require("./api/resources/oortShippers/client/Client.js");
+const Client_js_12 = require("./api/resources/oortTaskGroups/client/Client.js");
+const Client_js_13 = require("./api/resources/orgs/client/Client.js");
+const Client_js_14 = require("./api/resources/payments/client/Client.js");
+const Client_js_15 = require("./api/resources/profiles/client/Client.js");
+const Client_js_16 = require("./api/resources/root/client/Client.js");
+const Client_js_17 = require("./api/resources/users/client/Client.js");
+const Client_js_18 = require("./api/resources/mirror/client/Client.js");
+const Client_js_19 = require("./api/resources/oortCourierPayDriverRate/client/Client.js");
+class ChrtClient {
+    constructor(_options = {}) {
+        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": "0.1.0-beta1",
+                "User-Agent": "@chrt-inc/typescript-sdk/0.1.0-beta1",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get dev() {
+        var _a;
+        return ((_a = this._dev) !== null && _a !== void 0 ? _a : (this._dev = new Client_js_1.Dev(this._options)));
+    }
+    get directory() {
+        var _a;
+        return ((_a = this._directory) !== null && _a !== void 0 ? _a : (this._directory = new Client_js_2.Directory(this._options)));
+    }
+    get messages() {
+        var _a;
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_3.Messages(this._options)));
+    }
+    get oortDrivers() {
+        var _a;
+        return ((_a = this._oortDrivers) !== null && _a !== void 0 ? _a : (this._oortDrivers = new Client_js_4.OortDrivers(this._options)));
+    }
+    get oortHandles() {
+        var _a;
+        return ((_a = this._oortHandles) !== null && _a !== void 0 ? _a : (this._oortHandles = new Client_js_5.OortHandles(this._options)));
+    }
+    get oortMilestones() {
+        var _a;
+        return ((_a = this._oortMilestones) !== null && _a !== void 0 ? _a : (this._oortMilestones = new Client_js_6.OortMilestones(this._options)));
+    }
+    get oortOrgProfiles() {
+        var _a;
+        return ((_a = this._oortOrgProfiles) !== null && _a !== void 0 ? _a : (this._oortOrgProfiles = new Client_js_7.OortOrgProfiles(this._options)));
+    }
+    get oortOrders() {
+        var _a;
+        return ((_a = this._oortOrders) !== null && _a !== void 0 ? _a : (this._oortOrders = new Client_js_8.OortOrders(this._options)));
+    }
+    get oortRateSheets() {
+        var _a;
+        return ((_a = this._oortRateSheets) !== null && _a !== void 0 ? _a : (this._oortRateSheets = new Client_js_9.OortRateSheets(this._options)));
+    }
+    get oortRoutes() {
+        var _a;
+        return ((_a = this._oortRoutes) !== null && _a !== void 0 ? _a : (this._oortRoutes = new Client_js_10.OortRoutes(this._options)));
+    }
+    get oortShippers() {
+        var _a;
+        return ((_a = this._oortShippers) !== null && _a !== void 0 ? _a : (this._oortShippers = new Client_js_11.OortShippers(this._options)));
+    }
+    get oortTaskGroups() {
+        var _a;
+        return ((_a = this._oortTaskGroups) !== null && _a !== void 0 ? _a : (this._oortTaskGroups = new Client_js_12.OortTaskGroups(this._options)));
+    }
+    get orgs() {
+        var _a;
+        return ((_a = this._orgs) !== null && _a !== void 0 ? _a : (this._orgs = new Client_js_13.Orgs(this._options)));
+    }
+    get payments() {
+        var _a;
+        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_14.Payments(this._options)));
+    }
+    get profiles() {
+        var _a;
+        return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_js_15.Profiles(this._options)));
+    }
+    get root() {
+        var _a;
+        return ((_a = this._root) !== null && _a !== void 0 ? _a : (this._root = new Client_js_16.Root(this._options)));
+    }
+    get users() {
+        var _a;
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_17.Users(this._options)));
+    }
+    get mirror() {
+        var _a;
+        return ((_a = this._mirror) !== null && _a !== void 0 ? _a : (this._mirror = new Client_js_18.Mirror(this._options)));
+    }
+    get oortCourierPayDriverRate() {
+        var _a;
+        return ((_a = this._oortCourierPayDriverRate) !== null && _a !== void 0 ? _a : (this._oortCourierPayDriverRate = new Client_js_19.OortCourierPayDriverRate(this._options)));
+    }
+}
+exports.ChrtClient = ChrtClient;

package/dist/cjs/api/errors/UnprocessableEntityError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.js";
+import * as Chrt from "../index.js";
+import * as core from "../../core/index.js";
+export declare class UnprocessableEntityError extends errors.ChrtError {
+    constructor(body: Chrt.HttpValidationError, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/UnprocessableEntityError.js

@@ -0,0 +1,52 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnprocessableEntityError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class UnprocessableEntityError extends errors.ChrtError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnprocessableEntityError",
+            statusCode: 422,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;

package/dist/cjs/api/errors/index.d.ts

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

package/dist/cjs/api/errors/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("./UnprocessableEntityError.js"), exports);

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

@@ -0,0 +1,3 @@
+export * from "./resources/index.js";
+export * from "./types/index.js";
+export * from "./errors/index.js";

package/dist/cjs/api/index.js

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

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

@@ -0,0 +1,79 @@
+/**
+ * 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 Dev {
+    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 Dev {
+    protected readonly _options: Dev.Options;
+    constructor(_options?: Dev.Options);
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getUserId()
+     */
+    getUserId(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
+    private __getUserId;
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getDecodedJwt()
+     */
+    getDecodedJwt(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Chrt.DecodedJwtWithOrgAndUserId>;
+    private __getDecodedJwt;
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getEmail()
+     */
+    getEmail(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
+    private __getEmail;
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getTemplate()
+     */
+    getTemplate(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
+    private __getTemplate;
+    /**
+     * @param {Chrt.TemplateReq} request
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.dev.postTemplate({
+     *         message: "message",
+     *         number: 1,
+     *         timestamp: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    postTemplate(request: Chrt.TemplateReq, requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Chrt.TemplateRes>;
+    private __postTemplate;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}