@chrt-inc/typescript-sdk 1.303.0 → 1.304.0

package/README.md

@@ -1,604 +0,0 @@
-# Chrt TypeScript Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fchrt-inc%2Ftypescript-sdk)
-[![npm shield](https://img.shields.io/npm/v/@chrt-inc/typescript-sdk)](https://www.npmjs.com/package/@chrt-inc/typescript-sdk)
-
-The Chrt TypeScript library provides convenient access to the Chrt APIs from TypeScript.
-
-## 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)
-    - [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)
-
-## Installation
-
-```sh
-npm i -s @chrt-inc/typescript-sdk
-```
-
-## Reference
-
-A full reference for this library is available [here](https://github.com/chrt-inc/typescript-sdk/blob/HEAD/./reference.md).
-
-## Usage
-
-Instantiate and use the client with the following:
-
-```typescript
-import { ChrtClient } from "@chrt-inc/typescript-sdk";
-
-const client = new ChrtClient({ token: "YOUR_TOKEN" });
-await client.payments.generateInvoiceV1({
-    shipper_pay_courier_statement_id: "shipper_pay_courier_statement_id",
-});
-```
-
-## Request and Response Types
-
-The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
-following namespace:
-
-```typescript
-import { Chrt } from "@chrt-inc/typescript-sdk";
-
-const request: Chrt.GenerateInvoiceReq = {
-    ...
-};
-```
-
-## Exception Handling
-
-When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
-will be thrown.
-
-```typescript
-import { ChrtError } from "@chrt-inc/typescript-sdk";
-
-try {
-    await client.payments.generateInvoiceV1(...);
-} catch (err) {
-    if (err instanceof ChrtError) {
-        console.log(err.statusCode);
-        console.log(err.message);
-        console.log(err.body);
-        console.log(err.rawResponse);
-    }
-}
-```
-
-## 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:
-
-```typescript
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-const stream = response.stream();
-await Bun.write('path/to/file', stream);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ArrayBuffer</summary>
-
-```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
-
-const arrayBuffer = await response.arrayBuffer();
-await Bun.write('path/to/file', arrayBuffer);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Blob</summary>
-
-```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-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.taskArtifacts.images.getByMetadataIdV1(...);
-
-const stream = response.stream();
-const text = await new Response(stream).text();
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>ArrayBuffer</summary>
-
-```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
-
-const arrayBuffer = await response.arrayBuffer();
-const text = new TextDecoder().decode(arrayBuffer);
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Blob</summary>
-
-```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
-
-const blob = await response.blob();
-const text = await blob.text();
-```
-
-</details>
-</blockquote>
-
-<blockquote>
-<details>
-<summary>Bytes (UIntArray8)</summary>
-
-```ts
-const response = await client.taskArtifacts.images.getByMetadataIdV1(...);
-
-const bytes = await response.bytes();
-const text = new TextDecoder().decode(bytes);
-```
-
-</details>
-</blockquote>
-
-</details>

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.304.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.304.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.