@chrt-inc/typescript-sdk 1.303.0 → 1.305.0

package/README.md

@@ -7,30 +7,12 @@ The Chrt TypeScript library provides convenient access to the Chrt APIs from Typ
 
 ## Table of Contents
 
-- [Table of Contents](#table-of-contents)
 - [Installation](#installation)
 - [Reference](#reference)
 - [Usage](#usage)
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
-- [Advanced](#advanced)
-    - [Additional Headers](#additional-headers)
-    - [Additional Query String Parameters](#additional-query-string-parameters)
-    - [Retries](#retries)
-    - [Timeouts](#timeouts)
-    - [Aborting Requests](#aborting-requests)
-    - [Access Raw Response Data](#access-raw-response-data)
-    - [Runtime Compatibility](#runtime-compatibility)
-- [Contributing](#contributing)
 - [Binary Response](#binary-response)
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Reference](#reference)
-- [Usage](#usage)
-- [Request and Response Types](#request-and-response-types)
-- [Exception Handling](#exception-handling)
 - [Advanced](#advanced)
     - [Additional Headers](#additional-headers)
     - [Additional Query String Parameters](#additional-query-string-parameters)
@@ -40,7 +22,6 @@ The Chrt TypeScript library provides convenient access to the Chrt APIs from Typ
     - [Access Raw Response Data](#access-raw-response-data)
     - [Runtime Compatibility](#runtime-compatibility)
 - [Contributing](#contributing)
-- [Binary Response](#binary-response)
 
 ## Installation
 
@@ -98,121 +79,6 @@ try {
 }
 ```
 
-## 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.payments.generateInvoiceV1(..., {
-    headers: {
-        'X-Custom-Header': 'custom value'
-    }
-});
-```
-
-### Additional Query String Parameters
-
-If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
-
-```typescript
-const response = await client.payments.generateInvoiceV1(..., {
-    queryParams: {
-        'customQueryParamKey': 'custom query param value'
-    }
-});
-```
-
-### Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-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 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)
-- [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.payments.generateInvoiceV1(..., {
-    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.payments.generateInvoiceV1(..., {
-    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.payments.generateInvoiceV1(..., {
-    abortSignal: controller.signal
-});
-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.payments.generateInvoiceV1(...).withRawResponse();
-
-console.log(data);
-console.log(rawResponse.headers['X-My-Header']);
-```
-
-### Runtime Compatibility
-
-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 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
-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!
-
 ## Binary Response
 
 You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
@@ -602,3 +468,118 @@ const text = new TextDecoder().decode(bytes);
 </blockquote>
 
 </details>
+
+## 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.payments.generateInvoiceV1(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
+### Additional Query String Parameters
+
+If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
+
+```typescript
+const response = await client.payments.generateInvoiceV1(..., {
+    queryParams: {
+        'customQueryParamKey': 'custom query param value'
+    }
+});
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+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 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)
+- [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.payments.generateInvoiceV1(..., {
+    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.payments.generateInvoiceV1(..., {
+    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.payments.generateInvoiceV1(..., {
+    abortSignal: controller.signal
+});
+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.payments.generateInvoiceV1(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
+### Runtime Compatibility
+
+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 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
+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/dist/cjs/Client.js

@@ -71,8 +71,8 @@ class ChrtClient {
         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": "1.303.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.303.0",
+                "X-Fern-SDK-Version": "1.305.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.305.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -40,7 +40,7 @@ export declare class Connections {
     get connectionToShipper(): ConnectionToShipper;
     get connectionToForwarder(): ConnectionToForwarder;
     /**
-     * Lists shipper organizations based on the authenticated organization type. Couriers see connected shippers, forwarders see connected shippers.
+     * Lists shipper organizations based on the authenticated organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (list[ShipperConnectionRes])
      *
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -50,7 +50,7 @@ export declare class Connections {
     listShippersV1(requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShipperConnectionRes[]>;
     private __listShippersV1;
     /**
-     * Lists courier organizations based on the authenticated organization type. Shippers see connected couriers, forwarders see connected couriers.
+     * Lists courier organizations based on the authenticated organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (list[CourierConnectionRes])
      *
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -60,7 +60,7 @@ export declare class Connections {
     listCouriersV1(requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.CourierConnectionRes[]>;
     private __listCouriersV1;
     /**
-     * Lists forwarder organizations based on the authenticated organization type. Shippers see connected forwarders, couriers see connected forwarders.
+     * Lists forwarder organizations based on the authenticated organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (list[ForwarderConnectionRes])
      *
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -70,7 +70,7 @@ class Connections {
         return ((_a = this._connectionToForwarder) !== null && _a !== void 0 ? _a : (this._connectionToForwarder = new Client_js_3.ConnectionToForwarder(this._options)));
     }
     /**
-     * Lists shipper organizations based on the authenticated organization type. Couriers see connected shippers, forwarders see connected shippers.
+     * Lists shipper organizations based on the authenticated organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (list[ShipperConnectionRes])
      *
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -121,7 +121,7 @@ class Connections {
         });
     }
     /**
-     * Lists courier organizations based on the authenticated organization type. Shippers see connected couriers, forwarders see connected couriers.
+     * Lists courier organizations based on the authenticated organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (list[CourierConnectionRes])
      *
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -172,7 +172,7 @@ class Connections {
         });
     }
     /**
-     * Lists forwarder organizations based on the authenticated organization type. Shippers see connected forwarders, couriers see connected forwarders.
+     * Lists forwarder organizations based on the authenticated organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (list[ForwarderConnectionRes])
      *
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class ConnectionToCourier {
     protected readonly _options: ConnectionToCourier.Options;
     constructor(_options?: ConnectionToCourier.Options);
     /**
-     * Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers.
+     * Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {ConnectionToCourier.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.js

@@ -56,7 +56,7 @@ class ConnectionToCourier {
         this._options = _options;
     }
     /**
-     * Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers.
+     * Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {ConnectionToCourier.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/connections/resources/connectionToForwarder/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class ConnectionToForwarder {
     protected readonly _options: ConnectionToForwarder.Options;
     constructor(_options?: ConnectionToForwarder.Options);
     /**
-     * Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders.
+     * Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {ConnectionToForwarder.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/connections/resources/connectionToForwarder/client/Client.js

@@ -56,7 +56,7 @@ class ConnectionToForwarder {
         this._options = _options;
     }
     /**
-     * Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders.
+     * Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {ConnectionToForwarder.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/connections/resources/connectionToShipper/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class ConnectionToShipper {
     protected readonly _options: ConnectionToShipper.Options;
     constructor(_options?: ConnectionToShipper.Options);
     /**
-     * Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers.
+     * Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {ConnectionToShipper.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/connections/resources/connectionToShipper/client/Client.js

@@ -56,7 +56,7 @@ class ConnectionToShipper {
         this._options = _options;
     }
     /**
-     * Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers.
+     * Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {ConnectionToShipper.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -31,7 +31,7 @@ export declare class Dev {
     protected readonly _options: Dev.Options;
     constructor(_options?: Dev.Options);
     /**
-     * Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes.
+     * Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -41,7 +41,7 @@ export declare class Dev {
     getAgentV1(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getAgentV1;
     /**
-     * (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token.
+     * (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -51,7 +51,7 @@ export declare class Dev {
     getUserIdV1(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getUserIdV1;
     /**
-     * Extracts and returns the user ID from the authenticated request's JWT token.
+     * Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -61,7 +61,7 @@ export declare class Dev {
     getUserIdV2(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getUserIdV2;
     /**
-     * Returns the complete decoded JWT token information for development purposes.
+     * Returns the complete decoded JWT token information for development purposes. | () -> (DecodedJWTWithOrgAndUserId)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -71,7 +71,7 @@ export declare class Dev {
     getDecodedJwtV1(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Chrt.DecodedJwtWithOrgAndUserId>;
     private __getDecodedJwtV1;
     /**
-     * Retrieves the primary email address for the authenticated user from the authentication service.
+     * Retrieves the primary email address for the authenticated user from the authentication service. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -81,7 +81,7 @@ export declare class Dev {
     getEmailV1(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getEmailV1;
     /**
-     * Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes.
+     * Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes. | () -> (dict[str, Any])
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -91,7 +91,7 @@ export declare class Dev {
     getDurableV1(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
     private __getDurableV1;
     /**
-     * Development template endpoint that returns the authenticated user's ID for testing.
+     * Development template endpoint that returns the authenticated user's ID for testing. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -101,7 +101,7 @@ export declare class Dev {
     getTemplateV1(requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<string>;
     private __getTemplateV1;
     /**
-     * Development template endpoint that demonstrates transaction handling and request mirroring.
+     * Development template endpoint that demonstrates transaction handling and request mirroring. | (TemplateReq) -> (TemplateRes)
      *
      * @param {Chrt.TemplateReq} request
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
@@ -118,7 +118,7 @@ export declare class Dev {
     createTemplateV1(request: Chrt.TemplateReq, requestOptions?: Dev.RequestOptions): core.HttpResponsePromise<Chrt.TemplateRes>;
     private __createTemplateV1;
     /**
-     * Returns the current GitHub PR number and commit hash for the deployment.
+     * Returns the current GitHub PR number and commit hash for the deployment. | () -> (dict[str, str])
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -56,7 +56,7 @@ class Dev {
         this._options = _options;
     }
     /**
-     * Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes.
+     * Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -107,7 +107,7 @@ class Dev {
         });
     }
     /**
-     * (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token.
+     * (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -158,7 +158,7 @@ class Dev {
         });
     }
     /**
-     * Extracts and returns the user ID from the authenticated request's JWT token.
+     * Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -209,7 +209,7 @@ class Dev {
         });
     }
     /**
-     * Returns the complete decoded JWT token information for development purposes.
+     * Returns the complete decoded JWT token information for development purposes. | () -> (DecodedJWTWithOrgAndUserId)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -260,7 +260,7 @@ class Dev {
         });
     }
     /**
-     * Retrieves the primary email address for the authenticated user from the authentication service.
+     * Retrieves the primary email address for the authenticated user from the authentication service. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -311,7 +311,7 @@ class Dev {
         });
     }
     /**
-     * Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes.
+     * Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes. | () -> (dict[str, Any])
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -362,7 +362,7 @@ class Dev {
         });
     }
     /**
-     * Development template endpoint that returns the authenticated user's ID for testing.
+     * Development template endpoint that returns the authenticated user's ID for testing. | () -> (str)
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -413,7 +413,7 @@ class Dev {
         });
     }
     /**
-     * Development template endpoint that demonstrates transaction handling and request mirroring.
+     * Development template endpoint that demonstrates transaction handling and request mirroring. | (TemplateReq) -> (TemplateRes)
      *
      * @param {Chrt.TemplateReq} request
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
@@ -479,7 +479,7 @@ class Dev {
         });
     }
     /**
-     * Returns the current GitHub PR number and commit hash for the deployment.
+     * Returns the current GitHub PR number and commit hash for the deployment. | () -> (dict[str, str])
      *
      * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -31,7 +31,7 @@ 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.
+     * Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -41,7 +41,7 @@ export declare class Drivers {
     listOrgMembersAndDriversV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.OrgMembersAndDrivers[]>;
     private __listOrgMembersAndDriversV1;
     /**
-     * Lists all drivers belonging to the authenticated organization.
+     * Lists all drivers belonging to the authenticated organization. | () -> (list[Driver1])
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -51,7 +51,7 @@ export declare class Drivers {
     listV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1[]>;
     private __listV1;
     /**
-     * Creates a new driver profile for an organization member with optional vehicle type assignments.
+     * Creates a new driver profile for an organization member with optional vehicle type assignments. | (DriverCreateReq) -> (PydanticObjectId)
      *
      * @param {Chrt.DriverCreateReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,7 +69,7 @@ export declare class Drivers {
     createV1(request: Chrt.DriverCreateReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Retrieves driver information for the authenticated user within their organization.
+     * Retrieves driver information for the authenticated user within their organization. | () -> (Driver1)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -79,7 +79,7 @@ export declare class Drivers {
     getV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
     private __getV1;
     /**
-     * Retrieves detailed driver information by driver ID within the organization.
+     * Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
      *
      * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -92,7 +92,7 @@ export declare class Drivers {
     getByDriverIdV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
     private __getByDriverIdV1;
     /**
-     * Deletes a driver from the organization and removes them from associated rate sheets.
+     * Deletes a driver from the organization and removes them from associated rate sheets. | () -> (bool)
      *
      * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -105,7 +105,7 @@ export declare class Drivers {
     deleteV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteV1;
     /**
-     * Sets the activation status of a driver (active/inactive) within the organization.
+     * Sets the activation status of a driver (active/inactive) within the organization. | (SetDriverActivationReq) -> (bool)
      *
      * @param {Chrt.SetDriverActivationReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -121,7 +121,7 @@ export declare class Drivers {
     setActivationV1(request: Chrt.SetDriverActivationReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setActivationV1;
     /**
-     * Updates the driver's last known location and timestamp for tracking purposes.
+     * Updates the driver's last known location and timestamp for tracking purposes. | (DriverLastSeenReq) -> (bool)
      *
      * @param {Chrt.DriverLastSeenReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -145,7 +145,7 @@ export declare class Drivers {
     lastSeenV1(request: Chrt.DriverLastSeenReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __lastSeenV1;
     /**
-     * Clears the driver's last known location and timestamp.
+     * Clears the driver's last known location and timestamp. | () -> (bool)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -155,7 +155,7 @@ export declare class Drivers {
     lastSeenClearV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __lastSeenClearV1;
     /**
-     * Updates driver contact details and vehicle type assignments within the organization.
+     * Updates driver contact details and vehicle type assignments within the organization. | (UpdateDriverDetailsReq) -> (bool)
      *
      * @param {Chrt.UpdateDriverDetailsReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.