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

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

@@ -0,0 +1,66 @@
+/**
+ * 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 OortRateSheets {
+    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 OortRateSheets {
+    protected readonly _options: OortRateSheets.Options;
+    constructor(_options?: OortRateSheets.Options);
+    /**
+     * This is for creating a rate sheet
+     *
+     * @param {Chrt.RateSheetClientCreate1} request
+     * @param {OortRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.oortRateSheets.postCreateRateSheet({
+     *         schema_version: 1,
+     *         base_mileage_distance_miles: 1.1,
+     *         base_mileage_rate_usd_per_instance: 1.1,
+     *         additional_mileage_rate_usd_per_mile: 1.1,
+     *         long_distance_surcharge_miles_before_surcharge: 1.1,
+     *         long_distance_surcharge_rate_usd_per_mile: 1.1,
+     *         fuel_surchage_rate_usd_per_mile: 1.1,
+     *         wait_time_before_charge_minutes: 1.1,
+     *         wait_time_rate_usd_per_minute: 1.1,
+     *         extra_stop_rate_usd: 1.1,
+     *         dangerous_goods_rate_usd_per_instance: 1.1,
+     *         after_hours: 1.1,
+     *         weekend: 1.1,
+     *         holiday: 1.1
+     *     })
+     */
+    postCreateRateSheet(request: Chrt.RateSheetClientCreate1, requestOptions?: OortRateSheets.RequestOptions): Promise<string>;
+    /**
+     * This is for getting a list of all rate sheets by shipper org id from the JWT
+     *
+     * @param {OortRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.oortRateSheets.getRateSheetsByShipperOrgId()
+     */
+    getRateSheetsByShipperOrgId(requestOptions?: OortRateSheets.RequestOptions): Promise<Chrt.RateSheet1[]>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}

package/api/resources/{oortNotificationPreferences → oortRateSheets}/client/Client.js

@@ -48,31 +48,52 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OortNotificationPreferences = void 0;
+exports.OortRateSheets = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const Chrt = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
-class OortNotificationPreferences {
+class OortRateSheets {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * @param {OortNotificationPreferences.RequestOptions} requestOptions - Request-specific configuration.
+     * This is for creating a rate sheet
+     *
+     * @param {Chrt.RateSheetClientCreate1} request
+     * @param {OortRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.oortNotificationPreferences.getNotificationPreferencesByOrgId()
+     *     await client.oortRateSheets.postCreateRateSheet({
+     *         schema_version: 1,
+     *         base_mileage_distance_miles: 1.1,
+     *         base_mileage_rate_usd_per_instance: 1.1,
+     *         additional_mileage_rate_usd_per_mile: 1.1,
+     *         long_distance_surcharge_miles_before_surcharge: 1.1,
+     *         long_distance_surcharge_rate_usd_per_mile: 1.1,
+     *         fuel_surchage_rate_usd_per_mile: 1.1,
+     *         wait_time_before_charge_minutes: 1.1,
+     *         wait_time_rate_usd_per_minute: 1.1,
+     *         extra_stop_rate_usd: 1.1,
+     *         dangerous_goods_rate_usd_per_instance: 1.1,
+     *         after_hours: 1.1,
+     *         weekend: 1.1,
+     *         holiday: 1.1
+     *     })
      */
-    getNotificationPreferencesByOrgId(requestOptions) {
+    postCreateRateSheet(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_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, "oort/notification_preferences/by_org_id"),
-                method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk", "X-Fern-SDK-Version": "0.0.162", "User-Agent": "@chrt-inc/typescript-sdk/0.0.162", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                url: (0, url_join_1.default)((_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, "oort/rate_sheets/create"),
+                method: "POST",
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk", "X-Fern-SDK-Version": "0.1.0-beta0", "User-Agent": "@chrt-inc/typescript-sdk/0.1.0-beta0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
+                body: request,
                 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,
@@ -81,10 +102,15 @@ class OortNotificationPreferences {
                 return _response.body;
             }
             if (_response.error.reason === "status-code") {
-                throw new errors.ChrtError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                });
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body);
+                    default:
+                        throw new errors.ChrtError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
             }
             switch (_response.error.reason) {
                 case "non-json":
@@ -93,7 +119,7 @@ class OortNotificationPreferences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/notification_preferences/by_org_id.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/rate_sheets/create.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -102,26 +128,22 @@ class OortNotificationPreferences {
         });
     }
     /**
-     * @param {Chrt.NotificationPreferencesClientCreate1} request
-     * @param {OortNotificationPreferences.RequestOptions} requestOptions - Request-specific configuration.
+     * This is for getting a list of all rate sheets by shipper org id from the JWT
      *
-     * @throws {@link Chrt.UnprocessableEntityError}
+     * @param {OortRateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.oortNotificationPreferences.postNotificationPreferencesCreate({
-     *         schema_version: 1
-     *     })
+     *     await client.oortRateSheets.getRateSheetsByShipperOrgId()
      */
-    postNotificationPreferencesCreate(request, requestOptions) {
+    getRateSheetsByShipperOrgId(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_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, "oort/notification_preferences/create"),
-                method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk", "X-Fern-SDK-Version": "0.0.162", "User-Agent": "@chrt-inc/typescript-sdk/0.0.162", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                url: (0, url_join_1.default)((_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, "oort/rate_sheets/by_shipper_org_id"),
+                method: "GET",
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk", "X-Fern-SDK-Version": "0.1.0-beta0", "User-Agent": "@chrt-inc/typescript-sdk/0.1.0-beta0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
-                body: request,
                 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,
@@ -130,15 +152,10 @@ class OortNotificationPreferences {
                 return _response.body;
             }
             if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Chrt.UnprocessableEntityError(_response.error.body);
-                    default:
-                        throw new errors.ChrtError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                        });
-                }
+                throw new errors.ChrtError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
             }
             switch (_response.error.reason) {
                 case "non-json":
@@ -147,7 +164,7 @@ class OortNotificationPreferences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/notification_preferences/create.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/rate_sheets/by_shipper_org_id.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -165,4 +182,4 @@ class OortNotificationPreferences {
         });
     }
 }
-exports.OortNotificationPreferences = OortNotificationPreferences;
+exports.OortRateSheets = OortRateSheets;

package/{dist/api/resources/oortCourierPayDriverRate/client/requests/CourierPayDriverRateSheetClientCreate1.d.ts → api/resources/oortRateSheets/client/requests/RateSheetClientCreate1.d.ts}

@@ -5,46 +5,45 @@ import * as Chrt from "../../../../index";
 /**
  * @example
  *     {
- *         additional_mileage_rate_usd_per_mile: 1.1,
- *         after_hours: 1.1,
+ *         schema_version: 1,
  *         base_mileage_distance_miles: 1.1,
  *         base_mileage_rate_usd_per_instance: 1.1,
- *         courier_org_id: "courier_org_id",
- *         dangerous_goods_rate_usd_per_instance: 1.1,
- *         extra_stop_rate_usd: 1.1,
- *         fuel_surchage_rate_usd_per_mile: 1.1,
- *         holiday: 1.1,
+ *         additional_mileage_rate_usd_per_mile: 1.1,
  *         long_distance_surcharge_miles_before_surcharge: 1.1,
  *         long_distance_surcharge_rate_usd_per_mile: 1.1,
- *         schema_version: 1,
+ *         fuel_surchage_rate_usd_per_mile: 1.1,
  *         wait_time_before_charge_minutes: 1.1,
  *         wait_time_rate_usd_per_minute: 1.1,
- *         weekend: 1.1
+ *         extra_stop_rate_usd: 1.1,
+ *         dangerous_goods_rate_usd_per_instance: 1.1,
+ *         after_hours: 1.1,
+ *         weekend: 1.1,
+ *         holiday: 1.1
  *     }
  */
-export interface CourierPayDriverRateSheetClientCreate1 {
-    /** applies only to the additional miles */
-    additional_mileage_rate_usd_per_mile: number;
-    after_hours: number;
+export interface RateSheetClientCreate1 {
+    schema_version: number;
+    name?: string;
+    shipper_org_id?: string[];
+    shipper_contact_id?: string[];
+    cargo_type?: Chrt.CargoTypeEnum1[];
+    vehicle_type?: string[];
+    route_type?: Chrt.RouteTypeEnum1[];
+    driver_id?: string[];
+    comments?: string;
     base_mileage_distance_miles: number;
     base_mileage_rate_usd_per_instance: number;
-    cargo_types?: Chrt.CargoTypeEnum1[];
-    comments?: string;
-    /** Must be a string starting with `org_` */
-    courier_org_id: string;
-    dangerous_goods_rate_usd_per_instance: number;
-    driver_ids?: string[];
-    extra_stop_rate_usd: number;
-    fuel_surchage_rate_usd_per_mile: number;
-    holiday: number;
+    /** applies only to the additional miles */
+    additional_mileage_rate_usd_per_mile: number;
     long_distance_surcharge_miles_before_surcharge: number;
     /** applies only to the additional miles */
     long_distance_surcharge_rate_usd_per_mile: number;
-    name?: string;
-    route_types?: Chrt.RouteTypeEnum1[];
-    schema_version: number;
-    vehicle_types?: Chrt.VehicleTypeEnum[];
+    fuel_surchage_rate_usd_per_mile: number;
     wait_time_before_charge_minutes: number;
     wait_time_rate_usd_per_minute: number;
+    extra_stop_rate_usd: number;
+    dangerous_goods_rate_usd_per_instance: number;
+    after_hours: number;
     weekend: number;
+    holiday: number;
 }

package/api/resources/oortRateSheets/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type RateSheetClientCreate1 } from "./RateSheetClientCreate1";

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

@@ -0,0 +1,103 @@
+/**
+ * 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 OortRoutes {
+    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 OortRoutes {
+    protected readonly _options: OortRoutes.Options;
+    constructor(_options?: OortRoutes.Options);
+    /**
+     * @param {string} driverId
+     * @param {OortRoutes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.oortRoutes.getRoutesListByDriverId("driver_id")
+     */
+    getRoutesListByDriverId(driverId: string, requestOptions?: OortRoutes.RequestOptions): Promise<Chrt.Route1[]>;
+    /**
+     * @param {string} orderIdOrShortId
+     * @param {OortRoutes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.oortRoutes.getOortRoutesListByOrderIdOrShortId("order_id_or_short_id")
+     */
+    getOortRoutesListByOrderIdOrShortId(orderIdOrShortId: string, requestOptions?: OortRoutes.RequestOptions): Promise<Chrt.Route1[]>;
+    /**
+     * Uses the org_id from the JWT
+     *
+     * @param {OortRoutes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.oortRoutes.getRoutesListByCourierOrgId()
+     */
+    getRoutesListByCourierOrgId(requestOptions?: OortRoutes.RequestOptions): Promise<Chrt.Route1[]>;
+    /**
+     * @param {Chrt.UpdateRouteReq} request
+     * @param {OortRoutes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.oortRoutes.postOortRoutesUpdate({
+     *         route_id: "route_id"
+     *     })
+     */
+    postOortRoutesUpdate(request: Chrt.UpdateRouteReq, requestOptions?: OortRoutes.RequestOptions): Promise<Chrt.UpdateRouteRes>;
+    /**
+     * @param {string} routeId
+     * @param {OortRoutes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.oortRoutes.deleteOortRoutes("route_id")
+     */
+    deleteOortRoutes(routeId: string, requestOptions?: OortRoutes.RequestOptions): Promise<boolean>;
+    /**
+     * @param {Chrt.RouteByIdEnum} idType
+     * @param {string} id
+     * @param {Chrt.GetOortRoutesByIdRequest} request
+     * @param {OortRoutes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.oortRoutes.getOortRoutesById("route_id", "id")
+     */
+    getOortRoutesById(idType: Chrt.RouteByIdEnum, id: string, request?: Chrt.GetOortRoutesByIdRequest, requestOptions?: OortRoutes.RequestOptions): Promise<Chrt.RouteDetailRes>;
+    /**
+     * @param {Chrt.RouteCreateReq} request
+     * @param {OortRoutes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.oortRoutes.postOortRoutesCreate()
+     */
+    postOortRoutesCreate(request?: Chrt.RouteCreateReq, requestOptions?: OortRoutes.RequestOptions): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}