@chrt-inc/typescript-sdk 0.0.184 → 0.0.185

package/README.md

@@ -166,3 +166,393 @@ a proof of concept, but know that we will not be able to merge it as-is. We sugg
 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:
+
+```typescript
+const response = await client.milestones.images.getByMetadataId(...);
+const stream: ReadableStream<Uint8Array> = response.stream();
+// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
+// const blob: Blob = response.blob();
+// const bytes: Uint8Array = response.bytes();
+// You can only use the response body once, so you must choose one of the above methods.
+// If you want to check if the response body has been used, you can use the following property.
+const bodyUsed = response.bodyUsed;
+```
+
+<details>
+<summary>Save binary response to a file</summary>
+
+<blockquote>
+<details>
+<summary>Node.js</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+import { createWriteStream } from 'fs';
+import { Readable } from 'stream';
+import { pipeline } from 'stream/promises';
+
+const response = await client.milestones.images.getByMetadataId(...);
+
+const stream = response.stream();
+const nodeStream = Readable.fromWeb(stream);
+const writeStream = createWriteStream('path/to/file');
+
+await pipeline(nodeStream, writeStream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.milestones.images.getByMetadataId(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await writeFile('path/to/file', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.milestones.images.getByMetadataId(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await writeFile('output.bin', Buffer.from(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+import { writeFile } from 'fs/promises';
+
+const response = await client.milestones.images.getByMetadataId(...);
+
+const bytes = await response.bytes();
+await writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bun</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const stream = response.stream();
+await Bun.write('path/to/file', stream);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Bun.write('path/to/file', arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const blob = await response.blob();
+await Bun.write('path/to/file', blob);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const bytes = await response.bytes();
+await Bun.write('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Deno</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream (most-efficient)</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const stream = response.stream();
+const file = await Deno.open('path/to/file', { write: true, create: true });
+await stream.pipeTo(file.writable);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const arrayBuffer = await response.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const blob = await response.blob();
+const arrayBuffer = await blob.arrayBuffer();
+await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const bytes = await response.bytes();
+await Deno.writeFile('path/to/file', bytes);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Browser</summary>
+
+<blockquote>
+<details>
+<summary>Blob (most-efficient)</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const blob = await response.blob();
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const stream = response.stream();
+const reader = stream.getReader();
+const chunks = [];
+
+while (true) {
+  const { done, value } = await reader.read();
+  if (done) break;
+  chunks.push(value);
+}
+
+const blob = new Blob(chunks);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const blob = new Blob([arrayBuffer]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const bytes = await response.bytes();
+const blob = new Blob([bytes]);
+const url = URL.createObjectURL(blob);
+
+// trigger download
+const a = document.createElement('a');
+a.href = url;
+a.download = 'filename';
+a.click();
+URL.revokeObjectURL(url);
+```
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+</details>
+</blockquote>
+
+<details>
+<summary>Convert binary response to text</summary>
+
+<blockquote>
+<details>
+<summary>ReadableStream</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const stream = response.stream();
+const text = await new Response(stream).text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>ArrayBuffer</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const arrayBuffer = await response.arrayBuffer();
+const text = new TextDecoder().decode(arrayBuffer);
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Blob</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const blob = await response.blob();
+const text = await blob.text();
+```
+
+</details>
+</blockquote>
+
+<blockquote>
+<details>
+<summary>Bytes (UIntArray8)</summary>
+
+```ts
+const response = await client.milestones.images.getByMetadataId(...);
+
+const bytes = await response.bytes();
+const text = new TextDecoder().decode(bytes);
+```
+
+</details>
+</blockquote>
+
+</details>

package/dist/cjs/Client.d.ts

@@ -10,7 +10,10 @@ import { OffChrtShipperOrgConnectionInfo } from "./api/resources/offChrtShipperO
 import { OrgProfiles } from "./api/resources/orgProfiles/client/Client.js";
 import { Orders } from "./api/resources/orders/client/Client.js";
 import { CourierPayDriverRateSheets } from "./api/resources/courierPayDriverRateSheets/client/Client.js";
+import { ShipperPayCourierRateSheets } from "./api/resources/shipperPayCourierRateSheets/client/Client.js";
 import { CourierPayDriverLineItemGroup } from "./api/resources/courierPayDriverLineItemGroup/client/Client.js";
+import { ShipperPayCourierLineItemGroup } from "./api/resources/shipperPayCourierLineItemGroup/client/Client.js";
+import { ShipperPayCourierPayments } from "./api/resources/shipperPayCourierPayments/client/Client.js";
 import { CourierPayDriverPayouts } from "./api/resources/courierPayDriverPayouts/client/Client.js";
 import { Connections } from "./api/resources/connections/client/Client.js";
 import { TaskGroups } from "./api/resources/taskGroups/client/Client.js";
@@ -52,7 +55,10 @@ export declare class ChrtClient {
     protected _orgProfiles: OrgProfiles | undefined;
     protected _orders: Orders | undefined;
     protected _courierPayDriverRateSheets: CourierPayDriverRateSheets | undefined;
+    protected _shipperPayCourierRateSheets: ShipperPayCourierRateSheets | undefined;
     protected _courierPayDriverLineItemGroup: CourierPayDriverLineItemGroup | undefined;
+    protected _shipperPayCourierLineItemGroup: ShipperPayCourierLineItemGroup | undefined;
+    protected _shipperPayCourierPayments: ShipperPayCourierPayments | undefined;
     protected _courierPayDriverPayouts: CourierPayDriverPayouts | undefined;
     protected _connections: Connections | undefined;
     protected _taskGroups: TaskGroups | undefined;
@@ -72,7 +78,10 @@ export declare class ChrtClient {
     get orgProfiles(): OrgProfiles;
     get orders(): Orders;
     get courierPayDriverRateSheets(): CourierPayDriverRateSheets;
+    get shipperPayCourierRateSheets(): ShipperPayCourierRateSheets;
     get courierPayDriverLineItemGroup(): CourierPayDriverLineItemGroup;
+    get shipperPayCourierLineItemGroup(): ShipperPayCourierLineItemGroup;
+    get shipperPayCourierPayments(): ShipperPayCourierPayments;
     get courierPayDriverPayouts(): CourierPayDriverPayouts;
     get connections(): Connections;
     get taskGroups(): TaskGroups;

package/dist/cjs/Client.js

@@ -46,25 +46,28 @@ const Client_js_4 = require("./api/resources/offChrtShipperOrgConnectionInfo/cli
 const Client_js_5 = require("./api/resources/orgProfiles/client/Client.js");
 const Client_js_6 = require("./api/resources/orders/client/Client.js");
 const Client_js_7 = require("./api/resources/courierPayDriverRateSheets/client/Client.js");
-const Client_js_8 = require("./api/resources/courierPayDriverLineItemGroup/client/Client.js");
-const Client_js_9 = require("./api/resources/courierPayDriverPayouts/client/Client.js");
-const Client_js_10 = require("./api/resources/connections/client/Client.js");
-const Client_js_11 = require("./api/resources/taskGroups/client/Client.js");
-const Client_js_12 = require("./api/resources/shipperContactInfo/client/Client.js");
-const Client_js_13 = require("./api/resources/milestoneNotifications/client/Client.js");
-const Client_js_14 = require("./api/resources/orgs/client/Client.js");
-const Client_js_15 = require("./api/resources/payments/client/Client.js");
-const Client_js_16 = require("./api/resources/root/client/Client.js");
-const Client_js_17 = require("./api/resources/users/client/Client.js");
-const Client_js_18 = require("./api/resources/notifications/client/Client.js");
-const Client_js_19 = require("./api/resources/orgConnectionInfos/client/Client.js");
+const Client_js_8 = require("./api/resources/shipperPayCourierRateSheets/client/Client.js");
+const Client_js_9 = require("./api/resources/courierPayDriverLineItemGroup/client/Client.js");
+const Client_js_10 = require("./api/resources/shipperPayCourierLineItemGroup/client/Client.js");
+const Client_js_11 = require("./api/resources/shipperPayCourierPayments/client/Client.js");
+const Client_js_12 = require("./api/resources/courierPayDriverPayouts/client/Client.js");
+const Client_js_13 = require("./api/resources/connections/client/Client.js");
+const Client_js_14 = require("./api/resources/taskGroups/client/Client.js");
+const Client_js_15 = require("./api/resources/shipperContactInfo/client/Client.js");
+const Client_js_16 = require("./api/resources/milestoneNotifications/client/Client.js");
+const Client_js_17 = require("./api/resources/orgs/client/Client.js");
+const Client_js_18 = require("./api/resources/payments/client/Client.js");
+const Client_js_19 = require("./api/resources/root/client/Client.js");
+const Client_js_20 = require("./api/resources/users/client/Client.js");
+const Client_js_21 = require("./api/resources/notifications/client/Client.js");
+const Client_js_22 = require("./api/resources/orgConnectionInfos/client/Client.js");
 class ChrtClient {
     constructor(_options = {}) {
         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": "0.0.184",
-                "User-Agent": "@chrt-inc/typescript-sdk/0.0.184",
+                "X-Fern-SDK-Version": "0.0.185",
+                "User-Agent": "@chrt-inc/typescript-sdk/0.0.185",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -97,53 +100,65 @@ class ChrtClient {
         var _a;
         return ((_a = this._courierPayDriverRateSheets) !== null && _a !== void 0 ? _a : (this._courierPayDriverRateSheets = new Client_js_7.CourierPayDriverRateSheets(this._options)));
     }
+    get shipperPayCourierRateSheets() {
+        var _a;
+        return ((_a = this._shipperPayCourierRateSheets) !== null && _a !== void 0 ? _a : (this._shipperPayCourierRateSheets = new Client_js_8.ShipperPayCourierRateSheets(this._options)));
+    }
     get courierPayDriverLineItemGroup() {
         var _a;
-        return ((_a = this._courierPayDriverLineItemGroup) !== null && _a !== void 0 ? _a : (this._courierPayDriverLineItemGroup = new Client_js_8.CourierPayDriverLineItemGroup(this._options)));
+        return ((_a = this._courierPayDriverLineItemGroup) !== null && _a !== void 0 ? _a : (this._courierPayDriverLineItemGroup = new Client_js_9.CourierPayDriverLineItemGroup(this._options)));
+    }
+    get shipperPayCourierLineItemGroup() {
+        var _a;
+        return ((_a = this._shipperPayCourierLineItemGroup) !== null && _a !== void 0 ? _a : (this._shipperPayCourierLineItemGroup = new Client_js_10.ShipperPayCourierLineItemGroup(this._options)));
+    }
+    get shipperPayCourierPayments() {
+        var _a;
+        return ((_a = this._shipperPayCourierPayments) !== null && _a !== void 0 ? _a : (this._shipperPayCourierPayments = new Client_js_11.ShipperPayCourierPayments(this._options)));
     }
     get courierPayDriverPayouts() {
         var _a;
-        return ((_a = this._courierPayDriverPayouts) !== null && _a !== void 0 ? _a : (this._courierPayDriverPayouts = new Client_js_9.CourierPayDriverPayouts(this._options)));
+        return ((_a = this._courierPayDriverPayouts) !== null && _a !== void 0 ? _a : (this._courierPayDriverPayouts = new Client_js_12.CourierPayDriverPayouts(this._options)));
     }
     get connections() {
         var _a;
-        return ((_a = this._connections) !== null && _a !== void 0 ? _a : (this._connections = new Client_js_10.Connections(this._options)));
+        return ((_a = this._connections) !== null && _a !== void 0 ? _a : (this._connections = new Client_js_13.Connections(this._options)));
     }
     get taskGroups() {
         var _a;
-        return ((_a = this._taskGroups) !== null && _a !== void 0 ? _a : (this._taskGroups = new Client_js_11.TaskGroups(this._options)));
+        return ((_a = this._taskGroups) !== null && _a !== void 0 ? _a : (this._taskGroups = new Client_js_14.TaskGroups(this._options)));
     }
     get shipperContactInfo() {
         var _a;
-        return ((_a = this._shipperContactInfo) !== null && _a !== void 0 ? _a : (this._shipperContactInfo = new Client_js_12.ShipperContactInfo(this._options)));
+        return ((_a = this._shipperContactInfo) !== null && _a !== void 0 ? _a : (this._shipperContactInfo = new Client_js_15.ShipperContactInfo(this._options)));
     }
     get milestoneNotifications() {
         var _a;
-        return ((_a = this._milestoneNotifications) !== null && _a !== void 0 ? _a : (this._milestoneNotifications = new Client_js_13.MilestoneNotifications(this._options)));
+        return ((_a = this._milestoneNotifications) !== null && _a !== void 0 ? _a : (this._milestoneNotifications = new Client_js_16.MilestoneNotifications(this._options)));
     }
     get orgs() {
         var _a;
-        return ((_a = this._orgs) !== null && _a !== void 0 ? _a : (this._orgs = new Client_js_14.Orgs(this._options)));
+        return ((_a = this._orgs) !== null && _a !== void 0 ? _a : (this._orgs = new Client_js_17.Orgs(this._options)));
     }
     get payments() {
         var _a;
-        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_15.Payments(this._options)));
+        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_18.Payments(this._options)));
     }
     get root() {
         var _a;
-        return ((_a = this._root) !== null && _a !== void 0 ? _a : (this._root = new Client_js_16.Root(this._options)));
+        return ((_a = this._root) !== null && _a !== void 0 ? _a : (this._root = new Client_js_19.Root(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_17.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_20.Users(this._options)));
     }
     get notifications() {
         var _a;
-        return ((_a = this._notifications) !== null && _a !== void 0 ? _a : (this._notifications = new Client_js_18.Notifications(this._options)));
+        return ((_a = this._notifications) !== null && _a !== void 0 ? _a : (this._notifications = new Client_js_21.Notifications(this._options)));
     }
     get orgConnectionInfos() {
         var _a;
-        return ((_a = this._orgConnectionInfos) !== null && _a !== void 0 ? _a : (this._orgConnectionInfos = new Client_js_19.OrgConnectionInfos(this._options)));
+        return ((_a = this._orgConnectionInfos) !== null && _a !== void 0 ? _a : (this._orgConnectionInfos = new Client_js_22.OrgConnectionInfos(this._options)));
     }
 }
 exports.ChrtClient = ChrtClient;

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

@@ -37,7 +37,7 @@ export declare class CourierPayDriverLineItemGroup {
     /**
      * Previews calculated line items for a driver based on rate sheet and task group without creating the group.
      *
-     * @param {Chrt.CourierPayDriverLineItemGroupPreviewRequest} request
+     * @param {Chrt.CourierPayDriverLineItemGroupPreviewReq} request
      * @param {CourierPayDriverLineItemGroup.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -45,10 +45,11 @@ export declare class CourierPayDriverLineItemGroup {
      * @example
      *     await client.courierPayDriverLineItemGroup.preview({
      *         courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
-     *         task_group_id: "task_group_id"
+     *         task_group_id: "task_group_id",
+     *         driver_id: "driver_id"
      *     })
      */
-    preview(request: Chrt.CourierPayDriverLineItemGroupPreviewRequest, requestOptions?: CourierPayDriverLineItemGroup.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverLineItemGroupClientCreate1>;
+    preview(request: Chrt.CourierPayDriverLineItemGroupPreviewReq, requestOptions?: CourierPayDriverLineItemGroup.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverLineItemGroupClientCreate1>;
     private __preview;
     /**
      * Retrieves a courier driver line item group by its ID.
@@ -79,7 +80,7 @@ export declare class CourierPayDriverLineItemGroup {
     /**
      * Creates a courier driver line item group by calculating items from rate sheet and task group.
      *
-     * @param {Chrt.CourierPayDriverLineItemGroupCreateRequest} request
+     * @param {Chrt.CourierPayDriverLineItemGroupCreateReq} request
      * @param {CourierPayDriverLineItemGroup.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -90,7 +91,7 @@ export declare class CourierPayDriverLineItemGroup {
      *         task_group_id: "task_group_id"
      *     })
      */
-    create(request: Chrt.CourierPayDriverLineItemGroupCreateRequest, requestOptions?: CourierPayDriverLineItemGroup.RequestOptions): core.HttpResponsePromise<string>;
+    create(request: Chrt.CourierPayDriverLineItemGroupCreateReq, requestOptions?: CourierPayDriverLineItemGroup.RequestOptions): core.HttpResponsePromise<string>;
     private __create;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }