@chrt-inc/typescript-sdk 0.0.2

package/Client.d.ts

@@ -0,0 +1,79 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments";
+import * as core from "./core";
+import { Root } from "./api/resources/root/client/Client";
+import { Mirror } from "./api/resources/mirror/client/Client";
+import { Dev } from "./api/resources/dev/client/Client";
+import { Directory } from "./api/resources/directory/client/Client";
+import { OortConnections } from "./api/resources/oortConnections/client/Client";
+import { OortCourierPayDriverRateSheets } from "./api/resources/oortCourierPayDriverRateSheets/client/Client";
+import { OortDrivers } from "./api/resources/oortDrivers/client/Client";
+import { OortMilestones } from "./api/resources/oortMilestones/client/Client";
+import { OortNotificationPreferences } from "./api/resources/oortNotificationPreferences/client/Client";
+import { OortOrders } from "./api/resources/oortOrders/client/Client";
+import { OortOrgConnectionInfos } from "./api/resources/oortOrgConnectionInfos/client/Client";
+import { OortOrgProfiles } from "./api/resources/oortOrgProfiles/client/Client";
+import { OortShipperUserInfo } from "./api/resources/oortShipperUserInfo/client/Client";
+import { OortTaskGroups } from "./api/resources/oortTaskGroups/client/Client";
+import { Orgs } from "./api/resources/orgs/client/Client";
+import { Payments } from "./api/resources/payments/client/Client";
+import { Users } from "./api/resources/users/client/Client";
+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>;
+        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>;
+    }
+}
+export declare class ChrtClient {
+    protected readonly _options: ChrtClient.Options;
+    protected _root: Root | undefined;
+    protected _mirror: Mirror | undefined;
+    protected _dev: Dev | undefined;
+    protected _directory: Directory | undefined;
+    protected _oortConnections: OortConnections | undefined;
+    protected _oortCourierPayDriverRateSheets: OortCourierPayDriverRateSheets | undefined;
+    protected _oortDrivers: OortDrivers | undefined;
+    protected _oortMilestones: OortMilestones | undefined;
+    protected _oortNotificationPreferences: OortNotificationPreferences | undefined;
+    protected _oortOrders: OortOrders | undefined;
+    protected _oortOrgConnectionInfos: OortOrgConnectionInfos | undefined;
+    protected _oortOrgProfiles: OortOrgProfiles | undefined;
+    protected _oortShipperUserInfo: OortShipperUserInfo | undefined;
+    protected _oortTaskGroups: OortTaskGroups | undefined;
+    protected _orgs: Orgs | undefined;
+    protected _payments: Payments | undefined;
+    protected _users: Users | undefined;
+    constructor(_options?: ChrtClient.Options);
+    get root(): Root;
+    get mirror(): Mirror;
+    get dev(): Dev;
+    get directory(): Directory;
+    get oortConnections(): OortConnections;
+    get oortCourierPayDriverRateSheets(): OortCourierPayDriverRateSheets;
+    get oortDrivers(): OortDrivers;
+    get oortMilestones(): OortMilestones;
+    get oortNotificationPreferences(): OortNotificationPreferences;
+    get oortOrders(): OortOrders;
+    get oortOrgConnectionInfos(): OortOrgConnectionInfos;
+    get oortOrgProfiles(): OortOrgProfiles;
+    get oortShipperUserInfo(): OortShipperUserInfo;
+    get oortTaskGroups(): OortTaskGroups;
+    get orgs(): Orgs;
+    get payments(): Payments;
+    get users(): Users;
+}

package/Client.js

@@ -0,0 +1,97 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChrtClient = void 0;
+const Client_1 = require("./api/resources/root/client/Client");
+const Client_2 = require("./api/resources/mirror/client/Client");
+const Client_3 = require("./api/resources/dev/client/Client");
+const Client_4 = require("./api/resources/directory/client/Client");
+const Client_5 = require("./api/resources/oortConnections/client/Client");
+const Client_6 = require("./api/resources/oortCourierPayDriverRateSheets/client/Client");
+const Client_7 = require("./api/resources/oortDrivers/client/Client");
+const Client_8 = require("./api/resources/oortMilestones/client/Client");
+const Client_9 = require("./api/resources/oortNotificationPreferences/client/Client");
+const Client_10 = require("./api/resources/oortOrders/client/Client");
+const Client_11 = require("./api/resources/oortOrgConnectionInfos/client/Client");
+const Client_12 = require("./api/resources/oortOrgProfiles/client/Client");
+const Client_13 = require("./api/resources/oortShipperUserInfo/client/Client");
+const Client_14 = require("./api/resources/oortTaskGroups/client/Client");
+const Client_15 = require("./api/resources/orgs/client/Client");
+const Client_16 = require("./api/resources/payments/client/Client");
+const Client_17 = require("./api/resources/users/client/Client");
+class ChrtClient {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get root() {
+        var _a;
+        return ((_a = this._root) !== null && _a !== void 0 ? _a : (this._root = new Client_1.Root(this._options)));
+    }
+    get mirror() {
+        var _a;
+        return ((_a = this._mirror) !== null && _a !== void 0 ? _a : (this._mirror = new Client_2.Mirror(this._options)));
+    }
+    get dev() {
+        var _a;
+        return ((_a = this._dev) !== null && _a !== void 0 ? _a : (this._dev = new Client_3.Dev(this._options)));
+    }
+    get directory() {
+        var _a;
+        return ((_a = this._directory) !== null && _a !== void 0 ? _a : (this._directory = new Client_4.Directory(this._options)));
+    }
+    get oortConnections() {
+        var _a;
+        return ((_a = this._oortConnections) !== null && _a !== void 0 ? _a : (this._oortConnections = new Client_5.OortConnections(this._options)));
+    }
+    get oortCourierPayDriverRateSheets() {
+        var _a;
+        return ((_a = this._oortCourierPayDriverRateSheets) !== null && _a !== void 0 ? _a : (this._oortCourierPayDriverRateSheets = new Client_6.OortCourierPayDriverRateSheets(this._options)));
+    }
+    get oortDrivers() {
+        var _a;
+        return ((_a = this._oortDrivers) !== null && _a !== void 0 ? _a : (this._oortDrivers = new Client_7.OortDrivers(this._options)));
+    }
+    get oortMilestones() {
+        var _a;
+        return ((_a = this._oortMilestones) !== null && _a !== void 0 ? _a : (this._oortMilestones = new Client_8.OortMilestones(this._options)));
+    }
+    get oortNotificationPreferences() {
+        var _a;
+        return ((_a = this._oortNotificationPreferences) !== null && _a !== void 0 ? _a : (this._oortNotificationPreferences = new Client_9.OortNotificationPreferences(this._options)));
+    }
+    get oortOrders() {
+        var _a;
+        return ((_a = this._oortOrders) !== null && _a !== void 0 ? _a : (this._oortOrders = new Client_10.OortOrders(this._options)));
+    }
+    get oortOrgConnectionInfos() {
+        var _a;
+        return ((_a = this._oortOrgConnectionInfos) !== null && _a !== void 0 ? _a : (this._oortOrgConnectionInfos = new Client_11.OortOrgConnectionInfos(this._options)));
+    }
+    get oortOrgProfiles() {
+        var _a;
+        return ((_a = this._oortOrgProfiles) !== null && _a !== void 0 ? _a : (this._oortOrgProfiles = new Client_12.OortOrgProfiles(this._options)));
+    }
+    get oortShipperUserInfo() {
+        var _a;
+        return ((_a = this._oortShipperUserInfo) !== null && _a !== void 0 ? _a : (this._oortShipperUserInfo = new Client_13.OortShipperUserInfo(this._options)));
+    }
+    get oortTaskGroups() {
+        var _a;
+        return ((_a = this._oortTaskGroups) !== null && _a !== void 0 ? _a : (this._oortTaskGroups = new Client_14.OortTaskGroups(this._options)));
+    }
+    get orgs() {
+        var _a;
+        return ((_a = this._orgs) !== null && _a !== void 0 ? _a : (this._orgs = new Client_15.Orgs(this._options)));
+    }
+    get payments() {
+        var _a;
+        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_16.Payments(this._options)));
+    }
+    get users() {
+        var _a;
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_17.Users(this._options)));
+    }
+}
+exports.ChrtClient = ChrtClient;

package/README.md

@@ -0,0 +1,151 @@
+# Chrt TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Ffern-demo%2Fchrt-typescript-sdk)
+[![npm shield](https://img.shields.io/npm/v/@chrt-inc/typescript-sdk)](https://www.npmjs.com/package/@chrt-inc/typescript-sdk)
+
+The Chrt TypeScript library provides convenient access to the Chrt API from TypeScript.
+
+## Installation
+
+```sh
+npm i -s @chrt-inc/typescript-sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/fern-demo/chrt-typescript-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { ChrtClient } from "@chrt-inc/typescript-sdk";
+
+const client = new ChrtClient({ token: "YOUR_TOKEN" });
+await client.root.postAuthd();
+```
+
+## Request And Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { Chrt } from "@chrt-inc/typescript-sdk";
+
+const request: Chrt.TemplateReq = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { ChrtError } from "@chrt-inc/typescript-sdk";
+
+try {
+    await client.root.postAuthd(...);
+} catch (err) {
+    if (err instanceof ChrtError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+    }
+}
+```
+
+## Advanced
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `headers` request option.
+
+```typescript
+const response = await client.root.postAuthd(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
+### 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
+retry limit (default: 2).
+
+A request is deemed retriable 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)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.root.postAuthd(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.root.postAuthd(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.root.postAuthd(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your 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
+import { ChrtClient } from "@chrt-inc/typescript-sdk";
+
+const client = new ChrtClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/api/errors/UnprocessableEntityError.d.ts

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

package/api/errors/UnprocessableEntityError.js

@@ -0,0 +1,51 @@
+"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"));
+class UnprocessableEntityError extends errors.ChrtError {
+    constructor(body) {
+        super({
+            message: "UnprocessableEntityError",
+            statusCode: 422,
+            body: body,
+        });
+        Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;

package/api/errors/index.d.ts

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

package/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"), exports);

package/api/index.d.ts

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

package/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"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);

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

@@ -0,0 +1,72 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Chrt from "../../../index";
+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>;
+        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>;
+    }
+}
+export declare class Dev {
+    protected readonly _options: Dev.Options;
+    constructor(_options?: Dev.Options);
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getDecodedJwt()
+     */
+    getDecodedJwt(requestOptions?: Dev.RequestOptions): Promise<Chrt.DecodedJwtWithOrgAndUserId>;
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getEmail()
+     */
+    getEmail(requestOptions?: Dev.RequestOptions): Promise<string>;
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getTemplate()
+     */
+    getTemplate(requestOptions?: Dev.RequestOptions): Promise<string>;
+    /**
+     * @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): Promise<Chrt.TemplateRes>;
+    /**
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getUserId()
+     */
+    getUserId(requestOptions?: Dev.RequestOptions): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}