@chrt-inc/typescript-sdk 0.0.187 → 0.0.189

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.js

@@ -63,8 +63,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": "0.0.187",
-                "User-Agent": "@chrt-inc/typescript-sdk/0.0.187",
+                "X-Fern-SDK-Version": "0.0.189",
+                "User-Agent": "@chrt-inc/typescript-sdk/0.0.189",
                 "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/milestones/resources/images/client/Client.d.ts

@@ -59,16 +59,9 @@ export declare class Images {
     private __deleteByMetadataId;
     /**
      * Streams a milestone image file from S3 storage.
-     *
-     * @param {string} milestoneS3ObjectMetadataId
-     * @param {Images.RequestOptions} requestOptions - Request-specific configuration.
-     *
      * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id")
      */
-    getByMetadataId(milestoneS3ObjectMetadataId: string, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<unknown>;
+    getByMetadataId(milestoneS3ObjectMetadataId: string, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
     private __getByMetadataId;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/cjs/api/resources/milestones/resources/images/client/Client.js

@@ -185,14 +185,7 @@ class Images {
     }
     /**
      * Streams a milestone image file from S3 storage.
-     *
-     * @param {string} milestoneS3ObjectMetadataId
-     * @param {Images.RequestOptions} requestOptions - Request-specific configuration.
-     *
      * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id")
      */
     getByMetadataId(milestoneS3ObjectMetadataId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__getByMetadataId(milestoneS3ObjectMetadataId, requestOptions));
@@ -204,6 +197,7 @@ class Images {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/milestones/images/${encodeURIComponent(milestoneS3ObjectMetadataId)}`),
                 method: "GET",
                 headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                responseType: "binary-response",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.187";
+export declare const SDK_VERSION = "0.0.189";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.187";
+exports.SDK_VERSION = "0.0.189";

package/dist/esm/Client.mjs

@@ -27,8 +27,8 @@ export class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "0.0.187",
-                "User-Agent": "@chrt-inc/typescript-sdk/0.0.187",
+                "X-Fern-SDK-Version": "0.0.189",
+                "User-Agent": "@chrt-inc/typescript-sdk/0.0.189",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/milestones/resources/images/client/Client.d.mts

@@ -59,16 +59,9 @@ export declare class Images {
     private __deleteByMetadataId;
     /**
      * Streams a milestone image file from S3 storage.
-     *
-     * @param {string} milestoneS3ObjectMetadataId
-     * @param {Images.RequestOptions} requestOptions - Request-specific configuration.
-     *
      * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id")
      */
-    getByMetadataId(milestoneS3ObjectMetadataId: string, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<unknown>;
+    getByMetadataId(milestoneS3ObjectMetadataId: string, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
     private __getByMetadataId;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/esm/api/resources/milestones/resources/images/client/Client.mjs

@@ -149,14 +149,7 @@ export class Images {
     }
     /**
      * Streams a milestone image file from S3 storage.
-     *
-     * @param {string} milestoneS3ObjectMetadataId
-     * @param {Images.RequestOptions} requestOptions - Request-specific configuration.
-     *
      * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id")
      */
     getByMetadataId(milestoneS3ObjectMetadataId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__getByMetadataId(milestoneS3ObjectMetadataId, requestOptions));
@@ -168,6 +161,7 @@ export class Images {
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/milestones/images/${encodeURIComponent(milestoneS3ObjectMetadataId)}`),
                 method: "GET",
                 headers: mergeHeaders((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                responseType: "binary-response",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.187";
+export declare const SDK_VERSION = "0.0.189";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.187";
+export const SDK_VERSION = "0.0.189";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chrt-inc/typescript-sdk",
-    "version": "0.0.187",
+    "version": "0.0.189",
     "private": false,
     "repository": "github:chrt-inc/typescript-sdk",
     "type": "commonjs",

package/reference.md

@@ -5379,69 +5379,6 @@ await client.milestones.images.deleteByMetadataId("milestone_s3_object_metadata_
 </dl>
 </details>
 
-<details><summary><code>client.milestones.images.<a href="/src/api/resources/milestones/resources/images/client/Client.ts">getByMetadataId</a>(milestoneS3ObjectMetadataId) -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Streams a milestone image file from S3 storage.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**milestoneS3ObjectMetadataId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Images.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Milestones Blurhash
 
 <details><summary><code>client.milestones.blurhash.<a href="/src/api/resources/milestones/resources/blurhash/client/Client.ts">getByMetadataId</a>(milestoneS3ObjectMetadataId) -> string</code></summary>