@chrt-inc/typescript-sdk 1.325.0 → 1.331.0

package/README.md

@@ -84,7 +84,7 @@ try {
 You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
 
 ```typescript
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 const stream: ReadableStream<Uint8Array> = response.stream();
 // const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
 // const blob: Blob = response.blob();
@@ -110,7 +110,7 @@ import { createWriteStream } from 'fs';
 import { Readable } from 'stream';
 import { pipeline } from 'stream/promises';
 
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const stream = response.stream();
 const nodeStream = Readable.fromWeb(stream);
@@ -129,7 +129,7 @@ await pipeline(nodeStream, writeStream);
 ```ts
 import { writeFile } from 'fs/promises';
 
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const arrayBuffer = await response.arrayBuffer();
 await writeFile('path/to/file', Buffer.from(arrayBuffer));
@@ -145,7 +145,7 @@ await writeFile('path/to/file', Buffer.from(arrayBuffer));
 ```ts
 import { writeFile } from 'fs/promises';
 
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const blob = await response.blob();
 const arrayBuffer = await blob.arrayBuffer();
@@ -162,7 +162,7 @@ await writeFile('output.bin', Buffer.from(arrayBuffer));
 ```ts
 import { writeFile } from 'fs/promises';
 
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const bytes = await response.bytes();
 await writeFile('path/to/file', bytes);
@@ -183,7 +183,7 @@ await writeFile('path/to/file', bytes);
 <summary>ReadableStream (most-efficient)</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const stream = response.stream();
 await Bun.write('path/to/file', stream);
@@ -197,7 +197,7 @@ await Bun.write('path/to/file', stream);
 <summary>ArrayBuffer</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const arrayBuffer = await response.arrayBuffer();
 await Bun.write('path/to/file', arrayBuffer);
@@ -211,7 +211,7 @@ await Bun.write('path/to/file', arrayBuffer);
 <summary>Blob</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const blob = await response.blob();
 await Bun.write('path/to/file', blob);
@@ -225,7 +225,7 @@ await Bun.write('path/to/file', blob);
 <summary>Bytes (UIntArray8)</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const bytes = await response.bytes();
 await Bun.write('path/to/file', bytes);
@@ -246,7 +246,7 @@ await Bun.write('path/to/file', bytes);
 <summary>ReadableStream (most-efficient)</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const stream = response.stream();
 const file = await Deno.open('path/to/file', { write: true, create: true });
@@ -261,7 +261,7 @@ await stream.pipeTo(file.writable);
 <summary>ArrayBuffer</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const arrayBuffer = await response.arrayBuffer();
 await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
@@ -275,7 +275,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
 <summary>Blob</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const blob = await response.blob();
 const arrayBuffer = await blob.arrayBuffer();
@@ -290,7 +290,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
 <summary>Bytes (UIntArray8)</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const bytes = await response.bytes();
 await Deno.writeFile('path/to/file', bytes);
@@ -311,7 +311,7 @@ await Deno.writeFile('path/to/file', bytes);
 <summary>Blob (most-efficient)</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const blob = await response.blob();
 const url = URL.createObjectURL(blob);
@@ -332,7 +332,7 @@ URL.revokeObjectURL(url);
 <summary>ReadableStream</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const stream = response.stream();
 const reader = stream.getReader();
@@ -363,7 +363,7 @@ URL.revokeObjectURL(url);
 <summary>ArrayBuffer</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const arrayBuffer = await response.arrayBuffer();
 const blob = new Blob([arrayBuffer]);
@@ -385,7 +385,7 @@ URL.revokeObjectURL(url);
 <summary>Bytes (UIntArray8)</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const bytes = await response.bytes();
 const blob = new Blob([bytes]);
@@ -416,7 +416,7 @@ URL.revokeObjectURL(url);
 <summary>ReadableStream</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const stream = response.stream();
 const text = await new Response(stream).text();
@@ -430,7 +430,7 @@ const text = await new Response(stream).text();
 <summary>ArrayBuffer</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const arrayBuffer = await response.arrayBuffer();
 const text = new TextDecoder().decode(arrayBuffer);
@@ -444,7 +444,7 @@ const text = new TextDecoder().decode(arrayBuffer);
 <summary>Blob</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const blob = await response.blob();
 const text = await blob.text();
@@ -458,7 +458,7 @@ const text = await blob.text();
 <summary>Bytes (UIntArray8)</summary>
 
 ```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
+const response = await client.taskArtifacts.s3Object.getV1(...);
 
 const bytes = await response.bytes();
 const text = new TextDecoder().decode(bytes);

package/dist/cjs/Client.js

@@ -73,8 +73,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.325.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.325.0",
+                "X-Fern-SDK-Version": "1.331.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.331.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/cargos/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class Cargos {
     protected readonly _options: Cargos.Options;
     constructor(_options?: Cargos.Options);
     /**
-     * Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
+     * Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
      *
      * @param {string} cargoId
      * @param {Chrt.CargoClientUpdate1} request

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

@@ -56,7 +56,7 @@ class Cargos {
         this._options = _options;
     }
     /**
-     * Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
+     * Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
      *
      * @param {string} cargoId
      * @param {Chrt.CargoClientUpdate1} request

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

@@ -37,7 +37,7 @@ export declare class CourierPayDriverLineItemGroups {
     get addLineItems(): AddLineItems;
     get removeLineItems(): RemoveLineItems;
     /**
-     * Retrieves a courier driver line item group by its ID.
+     * Retrieves a courier driver line item group by its ID. | () -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} id
      * @param {CourierPayDriverLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,7 +50,7 @@ export declare class CourierPayDriverLineItemGroups {
     getByIdV1(id: string, requestOptions?: CourierPayDriverLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverLineItemGroup1>;
     private __getByIdV1;
     /**
-     * Retrieves a courier driver line item group by its associated task group ID.
+     * Retrieves a courier driver line item group by its associated task group ID. | () -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} taskGroupId
      * @param {CourierPayDriverLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -63,7 +63,7 @@ export declare class CourierPayDriverLineItemGroups {
     byTaskGroupIdV1(taskGroupId: string, requestOptions?: CourierPayDriverLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverLineItemGroup1>;
     private __byTaskGroupIdV1;
     /**
-     * Previews calculated line items for a driver based on a rate sheet and task group. Does not write to the database.
+     * Previews calculated line items for a driver based on a rate sheet and task group. Does not write to the database. | (CourierPayDriverLineItemGroupCreateReq) -> (CourierPayDriverLineItemGroupServerCreate1)
      *
      * @param {string} driverId
      * @param {Chrt.CourierPayDriverLineItemGroupCreateReq} request
@@ -80,7 +80,7 @@ export declare class CourierPayDriverLineItemGroups {
     previewV1(driverId: string, request: Chrt.CourierPayDriverLineItemGroupCreateReq, requestOptions?: CourierPayDriverLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverLineItemGroupServerCreate1>;
     private __previewV1;
     /**
-     * Creates a courier pay driver line item group by calculating items from a rate sheet and task group.
+     * Creates a courier pay driver line item group by calculating items from a rate sheet and task group. | (CourierPayDriverLineItemGroupCreateReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverLineItemGroupCreateReq} request
      * @param {CourierPayDriverLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -66,7 +66,7 @@ class CourierPayDriverLineItemGroups {
         return ((_a = this._removeLineItems) !== null && _a !== void 0 ? _a : (this._removeLineItems = new Client_js_2.RemoveLineItems(this._options)));
     }
     /**
-     * Retrieves a courier driver line item group by its ID.
+     * Retrieves a courier driver line item group by its ID. | () -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} id
      * @param {CourierPayDriverLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -125,7 +125,7 @@ class CourierPayDriverLineItemGroups {
         });
     }
     /**
-     * Retrieves a courier driver line item group by its associated task group ID.
+     * Retrieves a courier driver line item group by its associated task group ID. | () -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} taskGroupId
      * @param {CourierPayDriverLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -184,7 +184,7 @@ class CourierPayDriverLineItemGroups {
         });
     }
     /**
-     * Previews calculated line items for a driver based on a rate sheet and task group. Does not write to the database.
+     * Previews calculated line items for a driver based on a rate sheet and task group. Does not write to the database. | (CourierPayDriverLineItemGroupCreateReq) -> (CourierPayDriverLineItemGroupServerCreate1)
      *
      * @param {string} driverId
      * @param {Chrt.CourierPayDriverLineItemGroupCreateReq} request
@@ -253,7 +253,7 @@ class CourierPayDriverLineItemGroups {
         });
     }
     /**
-     * Creates a courier pay driver line item group by calculating items from a rate sheet and task group.
+     * Creates a courier pay driver line item group by calculating items from a rate sheet and task group. | (CourierPayDriverLineItemGroupCreateReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverLineItemGroupCreateReq} request
      * @param {CourierPayDriverLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class AddLineItems {
     protected readonly _options: AddLineItems.Options;
     constructor(_options?: AddLineItems.Options);
     /**
-     * Adds additional line items to an existing courier driver line item group.
+     * Adds additional line items to an existing courier driver line item group. | (CourierPayDriverLineItemGroupAddLineItemsReq) -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupAddLineItemsReq} request

package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.js

@@ -56,7 +56,7 @@ class AddLineItems {
         this._options = _options;
     }
     /**
-     * Adds additional line items to an existing courier driver line item group.
+     * Adds additional line items to an existing courier driver line item group. | (CourierPayDriverLineItemGroupAddLineItemsReq) -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupAddLineItemsReq} request

package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class RemoveLineItems {
     protected readonly _options: RemoveLineItems.Options;
     constructor(_options?: RemoveLineItems.Options);
     /**
-     * Removes specific line items from a courier driver line item group by their UUID identifiers.
+     * Removes specific line items from a courier driver line item group by their UUID identifiers. | (CourierPayDriverLineItemGroupRemoveLineItemsReq) -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupRemoveLineItemsReq} request

package/dist/cjs/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.js

@@ -56,7 +56,7 @@ class RemoveLineItems {
         this._options = _options;
     }
     /**
-     * Removes specific line items from a courier driver line item group by their UUID identifiers.
+     * Removes specific line items from a courier driver line item group by their UUID identifiers. | (CourierPayDriverLineItemGroupRemoveLineItemsReq) -> (CourierPayDriverLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupRemoveLineItemsReq} request

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

@@ -31,7 +31,7 @@ export declare class CourierPayDriverPayouts {
     protected readonly _options: CourierPayDriverPayouts.Options;
     constructor(_options?: CourierPayDriverPayouts.Options);
     /**
-     * Retrieves a specific courier driver payout by ID for the caller's organization.
+     * Retrieves a specific courier driver payout for the caller's organization. | () -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {CourierPayDriverPayouts.RequestOptions} requestOptions - Request-specific configuration.
@@ -44,7 +44,7 @@ export declare class CourierPayDriverPayouts {
     getByIdV1(id: string, requestOptions?: CourierPayDriverPayouts.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverStatement1>;
     private __getByIdV1;
     /**
-     * Lists all payouts for a specific driver within the caller's organization.
+     * Lists all payouts for a specific driver within the caller's organization. | () -> (list[CourierPayDriverStatement1])
      *
      * @param {string} driverId
      * @param {CourierPayDriverPayouts.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,7 +57,7 @@ export declare class CourierPayDriverPayouts {
     listByDriverIdV1(driverId: string, requestOptions?: CourierPayDriverPayouts.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverStatement1[]>;
     private __listByDriverIdV1;
     /**
-     * Creates a new driver payout from selected line item groups and calculates the total amount.
+     * Creates a new driver payout from selected line item groups and calculates the total amount. | (CourierPayDriverStatementClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverStatementClientCreate1} request
      * @param {CourierPayDriverPayouts.RequestOptions} requestOptions - Request-specific configuration.
@@ -73,7 +73,7 @@ export declare class CourierPayDriverPayouts {
     createV1(request: Chrt.CourierPayDriverStatementClientCreate1, requestOptions?: CourierPayDriverPayouts.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Updates the status of a courier driver payout with validation of allowed state transitions.
+     * Updates the status of a courier driver payout with validation of allowed state transitions. | (CourierPayDriverStatementClientUpdate1) -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {Chrt.CourierPayDriverStatementClientUpdate1} request

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

@@ -56,7 +56,7 @@ class CourierPayDriverPayouts {
         this._options = _options;
     }
     /**
-     * Retrieves a specific courier driver payout by ID for the caller's organization.
+     * Retrieves a specific courier driver payout for the caller's organization. | () -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {CourierPayDriverPayouts.RequestOptions} requestOptions - Request-specific configuration.
@@ -115,7 +115,7 @@ class CourierPayDriverPayouts {
         });
     }
     /**
-     * Lists all payouts for a specific driver within the caller's organization.
+     * Lists all payouts for a specific driver within the caller's organization. | () -> (list[CourierPayDriverStatement1])
      *
      * @param {string} driverId
      * @param {CourierPayDriverPayouts.RequestOptions} requestOptions - Request-specific configuration.
@@ -174,7 +174,7 @@ class CourierPayDriverPayouts {
         });
     }
     /**
-     * Creates a new driver payout from selected line item groups and calculates the total amount.
+     * Creates a new driver payout from selected line item groups and calculates the total amount. | (CourierPayDriverStatementClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverStatementClientCreate1} request
      * @param {CourierPayDriverPayouts.RequestOptions} requestOptions - Request-specific configuration.
@@ -239,7 +239,7 @@ class CourierPayDriverPayouts {
         });
     }
     /**
-     * Updates the status of a courier driver payout with validation of allowed state transitions.
+     * Updates the status of a courier driver payout with validation of allowed state transitions. | (CourierPayDriverStatementClientUpdate1) -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {Chrt.CourierPayDriverStatementClientUpdate1} request

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

@@ -31,7 +31,7 @@ export declare class CourierPayDriverRateSheets {
     protected readonly _options: CourierPayDriverRateSheets.Options;
     constructor(_options?: CourierPayDriverRateSheets.Options);
     /**
-     * Lists all driver rate sheets for the caller's courier organization.
+     * Lists all driver rate sheets for the caller's courier organization. | () -> (list[CourierPayDriverRateSheet1])
      *
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -41,7 +41,7 @@ export declare class CourierPayDriverRateSheets {
     listByCourierOrgIdV1(requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverRateSheet1[]>;
     private __listByCourierOrgIdV1;
     /**
-     * Retrieves all rate sheets assigned to a specific driver.
+     * Retrieves all rate sheets assigned to a specific driver. | () -> (list[CourierPayDriverRateSheet1])
      *
      * @param {string} driverId
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -54,7 +54,7 @@ export declare class CourierPayDriverRateSheets {
     listByDriverIdV1(driverId: string, requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverRateSheet1[]>;
     private __listByDriverIdV1;
     /**
-     * Creates a new driver rate sheet for calculating courier payments.
+     * Creates a new driver rate sheet for calculating courier payments. | (CourierPayDriverRateSheetClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverRateSheetClientCreate1} request
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -83,7 +83,7 @@ export declare class CourierPayDriverRateSheets {
     createV1(request: Chrt.CourierPayDriverRateSheetClientCreate1, requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Retrieves a single rate sheet by its ID.
+     * Retrieves a single rate sheet by its ID. | () -> (CourierPayDriverRateSheet1)
      *
      * @param {string} id
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -96,7 +96,7 @@ export declare class CourierPayDriverRateSheets {
     getV1(id: string, requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverRateSheet1>;
     private __getV1;
     /**
-     * Deletes a driver rate sheet owned by the caller's organization.
+     * Deletes a driver rate sheet owned by the caller's organization. | () -> (bool)
      *
      * @param {string} id
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -109,7 +109,7 @@ export declare class CourierPayDriverRateSheets {
     deleteByIdV1(id: string, requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteByIdV1;
     /**
-     * Updates an existing driver rate sheet owned by the caller's organization.
+     * Updates an existing driver rate sheet owned by the caller's organization. | (CourierPayDriverRateSheetClientUpdate1) -> (CourierPayDriverRateSheet1)
      *
      * @param {string} id
      * @param {Chrt.CourierPayDriverRateSheetClientUpdate1} request

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

@@ -56,7 +56,7 @@ class CourierPayDriverRateSheets {
         this._options = _options;
     }
     /**
-     * Lists all driver rate sheets for the caller's courier organization.
+     * Lists all driver rate sheets for the caller's courier organization. | () -> (list[CourierPayDriverRateSheet1])
      *
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -107,7 +107,7 @@ class CourierPayDriverRateSheets {
         });
     }
     /**
-     * Retrieves all rate sheets assigned to a specific driver.
+     * Retrieves all rate sheets assigned to a specific driver. | () -> (list[CourierPayDriverRateSheet1])
      *
      * @param {string} driverId
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -166,7 +166,7 @@ class CourierPayDriverRateSheets {
         });
     }
     /**
-     * Creates a new driver rate sheet for calculating courier payments.
+     * Creates a new driver rate sheet for calculating courier payments. | (CourierPayDriverRateSheetClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverRateSheetClientCreate1} request
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -244,7 +244,7 @@ class CourierPayDriverRateSheets {
         });
     }
     /**
-     * Retrieves a single rate sheet by its ID.
+     * Retrieves a single rate sheet by its ID. | () -> (CourierPayDriverRateSheet1)
      *
      * @param {string} id
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -303,7 +303,7 @@ class CourierPayDriverRateSheets {
         });
     }
     /**
-     * Deletes a driver rate sheet owned by the caller's organization.
+     * Deletes a driver rate sheet owned by the caller's organization. | () -> (bool)
      *
      * @param {string} id
      * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -362,7 +362,7 @@ class CourierPayDriverRateSheets {
         });
     }
     /**
-     * Updates an existing driver rate sheet owned by the caller's organization.
+     * Updates an existing driver rate sheet owned by the caller's organization. | (CourierPayDriverRateSheetClientUpdate1) -> (CourierPayDriverRateSheet1)
      *
      * @param {string} id
      * @param {Chrt.CourierPayDriverRateSheetClientUpdate1} request

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

@@ -31,7 +31,7 @@ export declare class CourierPayDriverStatements {
     protected readonly _options: CourierPayDriverStatements.Options;
     constructor(_options?: CourierPayDriverStatements.Options);
     /**
-     * Retrieves a specific courier driver statement by ID for the caller's organization.
+     * Retrieves a specific courier driver statement for the caller's organization. | () -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {CourierPayDriverStatements.RequestOptions} requestOptions - Request-specific configuration.
@@ -44,7 +44,7 @@ export declare class CourierPayDriverStatements {
     getByIdV1(id: string, requestOptions?: CourierPayDriverStatements.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverStatement1>;
     private __getByIdV1;
     /**
-     * Lists all statements for a specific driver within the caller's organization.
+     * Lists all statements for a specific driver within the caller's organization. | () -> (list[CourierPayDriverStatement1])
      *
      * @param {string} driverId
      * @param {CourierPayDriverStatements.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,7 +57,7 @@ export declare class CourierPayDriverStatements {
     listByDriverIdV1(driverId: string, requestOptions?: CourierPayDriverStatements.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverStatement1[]>;
     private __listByDriverIdV1;
     /**
-     * Creates a new driver statement from selected line item groups and calculates the total amount.
+     * Creates a new driver statement from selected line item groups and calculates the total amount. | (CourierPayDriverStatementClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverStatementClientCreate1} request
      * @param {CourierPayDriverStatements.RequestOptions} requestOptions - Request-specific configuration.
@@ -73,7 +73,7 @@ export declare class CourierPayDriverStatements {
     createV1(request: Chrt.CourierPayDriverStatementClientCreate1, requestOptions?: CourierPayDriverStatements.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Updates the status of a courier driver statement with validation of allowed state transitions.
+     * Updates the status of a courier driver statement with validation of allowed state transitions. | (CourierPayDriverStatementClientUpdate1) -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {Chrt.CourierPayDriverStatementClientUpdate1} request

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

@@ -56,7 +56,7 @@ class CourierPayDriverStatements {
         this._options = _options;
     }
     /**
-     * Retrieves a specific courier driver statement by ID for the caller's organization.
+     * Retrieves a specific courier driver statement for the caller's organization. | () -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {CourierPayDriverStatements.RequestOptions} requestOptions - Request-specific configuration.
@@ -115,7 +115,7 @@ class CourierPayDriverStatements {
         });
     }
     /**
-     * Lists all statements for a specific driver within the caller's organization.
+     * Lists all statements for a specific driver within the caller's organization. | () -> (list[CourierPayDriverStatement1])
      *
      * @param {string} driverId
      * @param {CourierPayDriverStatements.RequestOptions} requestOptions - Request-specific configuration.
@@ -174,7 +174,7 @@ class CourierPayDriverStatements {
         });
     }
     /**
-     * Creates a new driver statement from selected line item groups and calculates the total amount.
+     * Creates a new driver statement from selected line item groups and calculates the total amount. | (CourierPayDriverStatementClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.CourierPayDriverStatementClientCreate1} request
      * @param {CourierPayDriverStatements.RequestOptions} requestOptions - Request-specific configuration.
@@ -239,7 +239,7 @@ class CourierPayDriverStatements {
         });
     }
     /**
-     * Updates the status of a courier driver statement with validation of allowed state transitions.
+     * Updates the status of a courier driver statement with validation of allowed state transitions. | (CourierPayDriverStatementClientUpdate1) -> (CourierPayDriverStatement1)
      *
      * @param {string} id
      * @param {Chrt.CourierPayDriverStatementClientUpdate1} request

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

@@ -86,7 +86,7 @@ export declare class Drivers {
     listV1(request?: Chrt.DriversListV1Request, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1[]>;
     private __listV1;
     /**
-     * Creates a new driver profile for the caller. Returns existing driver ID if one already exists. Courier orgs only, min role: operator. | (DriverClientCreate1) -> (PydanticObjectId)
+     * Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Courier orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.DriverClientCreate1} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -95,6 +95,7 @@ export declare class Drivers {
      *
      * @example
      *     await client.drivers.createV1({
+     *         target_user_id: "target_user_id",
      *         schema_version: 1
      *     })
      */