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

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

@@ -56,6 +56,8 @@ class Dev {
         this._options = _options;
     }
     /**
+     * Get the user id from the jwt: This is in the description
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -103,6 +105,8 @@ class Dev {
         });
     }
     /**
+     * Returns the complete decoded JWT token information for development purposes.
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -150,6 +154,8 @@ class Dev {
         });
     }
     /**
+     * Retrieves the primary email address for the authenticated user from the authentication service.
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -197,6 +203,8 @@ class Dev {
         });
     }
     /**
+     * Development template endpoint that returns the authenticated user's ID for testing.
+     *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -244,22 +252,24 @@ class Dev {
         });
     }
     /**
+     * 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, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__postTemplate(request, requestOptions));
+    createTemplate(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createTemplate(request, requestOptions));
     }
-    __postTemplate(request, requestOptions) {
+    __createTemplate(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)({
@@ -305,6 +315,55 @@ class Dev {
             }
         });
     }
+    /**
+     * 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) {
+        return core.HttpResponsePromise.fromPromise(this.__getGitInfo(requestOptions));
+    }
+    __getGitInfo(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, "dev/git_info"),
+                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 /dev/git_info.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
             const bearer = yield core.Supplier.get(this._options.token);

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

@@ -0,0 +1,154 @@
+/**
+ * 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 Drivers {
+    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 Drivers {
+    protected readonly _options: Drivers.Options;
+    constructor(_options?: Drivers.Options);
+    /**
+     * Lists all organization members paired with their driver information if they are drivers.
+     *
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.drivers.listOrgMembersAndDrivers()
+     */
+    listOrgMembersAndDrivers(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.OrgMembersAndDrivers[]>;
+    private __listOrgMembersAndDrivers;
+    /**
+     * Lists all drivers belonging to the authenticated organization.
+     *
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.drivers.list()
+     */
+    list(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1[]>;
+    private __list;
+    /**
+     * Creates a new driver profile for an organization member with optional vehicle type assignments.
+     *
+     * @param {Chrt.DriverCreateReq} request
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.drivers.create({
+     *         org_member: {
+     *             role: "role",
+     *             user_id: "user_id"
+     *         }
+     *     })
+     */
+    create(request: Chrt.DriverCreateReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<string>;
+    private __create;
+    /**
+     * Retrieves driver information for the authenticated user within their organization.
+     *
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.drivers.get()
+     */
+    get(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
+    private __get;
+    /**
+     * Retrieves detailed driver information by driver ID within the organization.
+     *
+     * @param {string} driverId
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.drivers.getByDriverId("driver_id")
+     */
+    getByDriverId(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
+    private __getByDriverId;
+    /**
+     * Deletes a driver from the organization and removes them from associated rate sheets.
+     *
+     * @param {string} driverId
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.drivers.delete("driver_id")
+     */
+    delete(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __delete;
+    /**
+     * Sets the activation status of a driver (active/inactive) within the organization.
+     *
+     * @param {Chrt.SetDriverActivationReq} request
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.drivers.setActivation({
+     *         driver_object_id: "driver_object_id",
+     *         active: true
+     *     })
+     */
+    setActivation(request: Chrt.SetDriverActivationReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setActivation;
+    /**
+     * Updates the driver's last known location and timestamp for tracking purposes.
+     *
+     * @param {Chrt.DriverLastSeenReq} request
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.drivers.lastSeen({
+     *         location: {
+     *             type: "Feature"
+     *         }
+     *     })
+     */
+    lastSeen(request: Chrt.DriverLastSeenReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __lastSeen;
+    /**
+     * Updates driver contact details and vehicle type assignments within the organization.
+     *
+     * @param {Chrt.UpdateDriverDetailsReq} request
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.drivers.updateDriver({
+     *         driver_object_id: "driver_object_id"
+     *     })
+     */
+    updateDriver(request: Chrt.UpdateDriverDetailsReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateDriver;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}