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

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

@@ -0,0 +1,425 @@
+"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;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CourierPayDriverRateSheets = void 0;
+const environments = __importStar(require("../../../../environments.js"));
+const core = __importStar(require("../../../../core/index.js"));
+const Chrt = __importStar(require("../../../index.js"));
+const headers_js_1 = require("../../../../core/headers.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+class CourierPayDriverRateSheets {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Lists all driver rate sheets for the authenticated courier organization.
+     *
+     * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.courierPayDriverRateSheets.listByCourierOrgId()
+     */
+    listByCourierOrgId(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listByCourierOrgId(requestOptions));
+    }
+    __listByCourierOrgId(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, "oort/courier_pay_driver_rate_sheets/list"),
+                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 /oort/courier_pay_driver_rate_sheets/list.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieves all rate sheets assigned to a specific driver.
+     *
+     * @param {string} driverId
+     * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.courierPayDriverRateSheets.listByDriverId("driver_id")
+     */
+    listByDriverId(driverId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listByDriverId(driverId, requestOptions));
+    }
+    __listByDriverId(driverId, 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, `oort/courier_pay_driver_rate_sheets/by_driver_id/${encodeURIComponent(driverId)}`),
+                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") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        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 /oort/courier_pay_driver_rate_sheets/by_driver_id/{driver_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Creates a new driver rate sheet for calculating courier payments.
+     *
+     * @param {Chrt.CourierPayDriverRateSheetClientCreate1} request
+     * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.courierPayDriverRateSheets.create({
+     *         schema_version: 1,
+     *         courier_org_id: "courier_org_id",
+     *         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_surcharge_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
+     *     })
+     */
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    }
+    __create(request, 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, "oort/courier_pay_driver_rate_sheets/create"),
+                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),
+                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,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        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 /oort/courier_pay_driver_rate_sheets/create.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieves a single rate sheet by its ID.
+     *
+     * @param {string} id
+     * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.courierPayDriverRateSheets.get("id")
+     */
+    get(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(id, requestOptions));
+    }
+    __get(id, 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, `oort/courier_pay_driver_rate_sheets/${encodeURIComponent(id)}`),
+                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") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        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 /oort/courier_pay_driver_rate_sheets/{id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Deletes a driver rate sheet owned by the authenticated organization.
+     *
+     * @param {string} id
+     * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.courierPayDriverRateSheets.deleteById("id")
+     */
+    deleteById(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteById(id, requestOptions));
+    }
+    __deleteById(id, 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, `oort/courier_pay_driver_rate_sheets/${encodeURIComponent(id)}`),
+                method: "DELETE",
+                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") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        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 DELETE /oort/courier_pay_driver_rate_sheets/{id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Updates an existing driver rate sheet owned by the authenticated organization.
+     *
+     * @param {string} id
+     * @param {Chrt.CourierPayDriverRateSheetClientUpdate1} request
+     * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.courierPayDriverRateSheets.updateById("id")
+     */
+    updateById(id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateById(id, request, requestOptions));
+    }
+    __updateById(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
+            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, `oort/courier_pay_driver_rate_sheets/${encodeURIComponent(id)}`),
+                method: "PATCH",
+                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),
+                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,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        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 PATCH /oort/courier_pay_driver_rate_sheets/{id}.");
+                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);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
+        });
+    }
+}
+exports.CourierPayDriverRateSheets = CourierPayDriverRateSheets;

package/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetClientCreate1.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         schema_version: 1,
+ *         courier_org_id: "courier_org_id",
+ *         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_surcharge_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
+ *     }
+ */
+export interface CourierPayDriverRateSheetClientCreate1 {
+    schema_version: number;
+    name?: string | null;
+    cargo_types?: Chrt.CargoTypeEnum1[] | null;
+    vehicle_types?: Chrt.VehicleTypeEnum[] | null;
+    route_types?: Chrt.RouteTypeEnum1[] | null;
+    driver_ids?: string[] | null;
+    /** Must be a string starting with `org_` */
+    courier_org_id: string;
+    comments?: string | null;
+    base_mileage_distance_miles: number;
+    base_mileage_rate_usd_per_instance: 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;
+    fuel_surcharge_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/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetClientUpdate1.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface CourierPayDriverRateSheetClientUpdate1 {
+    name?: string | null;
+    cargo_types?: Chrt.CargoTypeEnum1[] | null;
+    vehicle_types?: Chrt.VehicleTypeEnum[] | null;
+    route_types?: Chrt.RouteTypeEnum1[] | null;
+    driver_ids?: string[] | null;
+    comments?: string | null;
+    base_mileage_distance_miles?: number | null;
+    base_mileage_rate_usd_per_instance?: number | null;
+    additional_mileage_rate_usd_per_mile?: number | null;
+    long_distance_surcharge_miles_before_surcharge?: number | null;
+    long_distance_surcharge_rate_usd_per_mile?: number | null;
+    fuel_surcharge_rate_usd_per_mile?: number | null;
+    wait_time_before_charge_minutes?: number | null;
+    wait_time_rate_usd_per_minute?: number | null;
+    extra_stop_rate_usd?: number | null;
+    dangerous_goods_rate_usd_per_instance?: number | null;
+    after_hours?: number | null;
+    weekend?: number | null;
+    holiday?: number | null;
+}

package/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { type CourierPayDriverRateSheetClientCreate1 } from "./CourierPayDriverRateSheetClientCreate1.js";
+export { type CourierPayDriverRateSheetClientUpdate1 } from "./CourierPayDriverRateSheetClientUpdate1.js";

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

@@ -29,6 +29,8 @@ export declare class Dev {
     protected readonly _options: Dev.Options;
     constructor(_options?: Dev.Options);
     /**
+     * Get the user id from the jwt: This is in the description
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -37,6 +39,8 @@ export declare class Dev {
     getUserId(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getUserId;
     /**
+     * Returns the complete decoded JWT token information for development purposes.
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -45,6 +49,8 @@ export declare class Dev {
     getDecodedJwt(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Chrt.DecodedJwtWithOrgAndUserId>;
     private __getDecodedJwt;
     /**
+     * Retrieves the primary email address for the authenticated user from the authentication service.
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -53,6 +59,8 @@ export declare class Dev {
     getEmail(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getEmail;
     /**
+     * Development template endpoint that returns the authenticated user's ID for testing.
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -61,19 +69,31 @@ export declare class Dev {
     getTemplate(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getTemplate;
     /**
+     * Development template endpoint that demonstrates transaction handling and request mirroring.
+     *
      * @param {Chrt.TemplateReq} request
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.dev.postTemplate({
+     *     await client.dev.createTemplate({
      *         message: "message",
      *         number: 1,
      *         timestamp: "2024-01-15T09:30:00Z"
      *     })
      */
-    postTemplate(request: Chrt.TemplateReq, requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Chrt.TemplateRes>;
-    private __postTemplate;
+    createTemplate(request: Chrt.TemplateReq, requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Chrt.TemplateRes>;
+    private __createTemplate;
+    /**
+     * Returns the current GitHub PR number and commit hash for the deployment.
+     *
+     * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dev.getGitInfo()
+     */
+    getGitInfo(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Record<string, string>>;
+    private __getGitInfo;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }