@chrt-inc/typescript-sdk 1.1025.0 → 1.1027.0

package/README.md

@@ -41,9 +41,12 @@ Instantiate and use the client with the following:
 import { ChrtClient } from "@chrt-inc/typescript-sdk";
 
 const client = new ChrtClient({ token: "YOUR_TOKEN" });
-await client.chrtGpt.messageV1({
+const response = await client.chrtGpt.postV1({
     message: "message",
 });
+for await (const item of response) {
+    console.log(item);
+}
 ```
 
 ## Request and Response Types
@@ -54,7 +57,7 @@ following namespace:
 ```typescript
 import { Chrt } from "@chrt-inc/typescript-sdk";
 
-const request: Chrt.ChrtGptMessageReq = {
+const request: Chrt.ChrtGptReq = {
     ...
 };
 ```
@@ -68,7 +71,7 @@ will be thrown.
 import { ChrtError } from "@chrt-inc/typescript-sdk";
 
 try {
-    await client.chrtGpt.messageV1(...);
+    await client.chrtGpt.postV1(...);
 } catch (err) {
     if (err instanceof ChrtError) {
         console.log(err.statusCode);
@@ -476,7 +479,7 @@ const text = new TextDecoder().decode(bytes);
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.chrtGpt.messageV1(..., {
+const response = await client.chrtGpt.postV1(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -488,7 +491,7 @@ const response = await client.chrtGpt.messageV1(..., {
 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.chrtGpt.messageV1(..., {
+const response = await client.chrtGpt.postV1(..., {
     queryParams: {
         'customQueryParamKey': 'custom query param value'
     }
@@ -510,7 +513,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.chrtGpt.messageV1(..., {
+const response = await client.chrtGpt.postV1(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -520,7 +523,7 @@ const response = await client.chrtGpt.messageV1(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.chrtGpt.messageV1(..., {
+const response = await client.chrtGpt.postV1(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -531,7 +534,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.chrtGpt.messageV1(..., {
+const response = await client.chrtGpt.postV1(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -543,7 +546,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.chrtGpt.messageV1(...).withRawResponse();
+const { data, rawResponse } = await client.chrtGpt.postV1(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);

package/dist/cjs/Client.js

@@ -62,8 +62,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.1025.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.1025.0",
+                "X-Fern-SDK-Version": "1.1027.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.1027.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/chrtGpt/client/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "../../../../environments.js";
 import * as core from "../../../../core/index.js";
 import * as Chrt from "../../../index.js";
+import { Conversations } from "../resources/conversations/client/Client.js";
 export declare namespace ChrtGpt {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
@@ -29,21 +30,13 @@ export declare namespace ChrtGpt {
 }
 export declare class ChrtGpt {
     protected readonly _options: ChrtGpt.Options;
+    protected _conversations: Conversations | undefined;
     constructor(_options?: ChrtGpt.Options);
+    get conversations(): Conversations;
     /**
-     * Sends a message to ChrtGPT and returns its reply, starting a new conversation when no conversation_id is given. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTMessageReq) -> (ChrtGPTMessageRes)
-     *
-     * @param {Chrt.ChrtGptMessageReq} request
-     * @param {ChrtGpt.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.chrtGpt.messageV1({
-     *         message: "message"
-     *     })
+     * Sends a message to ChrtGPT and streams its reply, starting a new conversation when no conversation_id is given. In the background, retitles the conversation after each of its first 3 turns and updates its summary and order identifiers after every turn. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTReq) -> (stream[ChrtGPTEvent])
      */
-    messageV1(request: Chrt.ChrtGptMessageReq, requestOptions?: ChrtGpt.RequestOptions): core.HttpResponsePromise<Chrt.ChrtGptMessageRes>;
-    private __messageV1;
+    postV1(request: Chrt.ChrtGptReq, requestOptions?: ChrtGpt.RequestOptions): core.HttpResponsePromise<core.Stream<Chrt.ChrtGptEvent>>;
+    private __postV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -51,44 +51,51 @@ const core = __importStar(require("../../../../core/index.js"));
 const Chrt = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
+const Client_js_1 = require("../resources/conversations/client/Client.js");
 class ChrtGpt {
     constructor(_options = {}) {
         this._options = _options;
     }
+    get conversations() {
+        var _a;
+        return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Client_js_1.Conversations(this._options)));
+    }
     /**
-     * Sends a message to ChrtGPT and returns its reply, starting a new conversation when no conversation_id is given. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTMessageReq) -> (ChrtGPTMessageRes)
-     *
-     * @param {Chrt.ChrtGptMessageReq} request
-     * @param {ChrtGpt.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.chrtGpt.messageV1({
-     *         message: "message"
-     *     })
+     * Sends a message to ChrtGPT and streams its reply, starting a new conversation when no conversation_id is given. In the background, retitles the conversation after each of its first 3 turns and updates its summary and order identifiers after every turn. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTReq) -> (stream[ChrtGPTEvent])
      */
-    messageV1(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__messageV1(request, requestOptions));
+    postV1(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__postV1(request, requestOptions));
     }
-    __messageV1(request, requestOptions) {
+    __postV1(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "chrt_gpt/message/v1"),
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "chrt_gpt/v1"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
+                responseType: "sse",
                 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,
             });
             if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
+                return {
+                    data: new core.Stream({
+                        stream: _response.body,
+                        parse: (data) => data,
+                        signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                        eventShape: {
+                            type: "sse",
+                            streamTerminator: "[DONE]",
+                        },
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -110,7 +117,7 @@ class ChrtGpt {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /chrt_gpt/message/v1.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /chrt_gpt/v1.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

package/dist/cjs/api/resources/chrtGpt/client/requests/ChrtGptReq.d.ts

@@ -0,0 +1,38 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         message: "message"
+ *     }
+ */
+export interface ChrtGptReq {
+    /** Omit to start a new conversation. */
+    conversation_id?: string | null;
+    message: string;
+    /** How much ChrtGPT reasons before answering this message. Higher is slower and more thorough. */
+    reasoning_effort?: ChrtGptReq.ReasoningEffort;
+    /** How long and detailed ChrtGPT's reply is. */
+    verbosity?: ChrtGptReq.Verbosity;
+}
+export declare namespace ChrtGptReq {
+    /**
+     * How much ChrtGPT reasons before answering this message. Higher is slower and more thorough.
+     */
+    type ReasoningEffort = "low" | "medium" | "high";
+    const ReasoningEffort: {
+        readonly Low: "low";
+        readonly Medium: "medium";
+        readonly High: "high";
+    };
+    /**
+     * How long and detailed ChrtGPT's reply is.
+     */
+    type Verbosity = "low" | "medium" | "high";
+    const Verbosity: {
+        readonly Low: "low";
+        readonly Medium: "medium";
+        readonly High: "high";
+    };
+}

package/dist/cjs/api/resources/chrtGpt/client/requests/ChrtGptReq.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChrtGptReq = void 0;
+var ChrtGptReq;
+(function (ChrtGptReq) {
+    ChrtGptReq.ReasoningEffort = {
+        Low: "low",
+        Medium: "medium",
+        High: "high",
+    };
+    ChrtGptReq.Verbosity = {
+        Low: "low",
+        Medium: "medium",
+        High: "high",
+    };
+})(ChrtGptReq || (exports.ChrtGptReq = ChrtGptReq = {}));

package/dist/cjs/api/resources/chrtGpt/client/requests/index.d.ts

@@ -1 +1 @@
-export { type ChrtGptMessageReq } from "./ChrtGptMessageReq.js";
+export { type ChrtGptReq } from "./ChrtGptReq.js";

package/dist/cjs/api/resources/chrtGpt/index.d.ts

@@ -1 +1,2 @@
 export * from "./client/index.js";
+export * from "./resources/index.js";

package/dist/cjs/api/resources/chrtGpt/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/Client.d.ts

@@ -0,0 +1,96 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.js";
+import * as core from "../../../../../../core/index.js";
+import * as Chrt from "../../../../../index.js";
+export declare namespace Conversations {
+    interface Options {
+        environment?: core.Supplier<environments.ChrtEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Conversations {
+    protected readonly _options: Conversations.Options;
+    constructor(_options?: Conversations.Options);
+    /**
+     * Permanently deletes the caller's ChrtGPT conversations and their history, skipping IDs that don't exist or aren't the caller's. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTConversationsDeleteManyReq) -> (ChrtGPTConversationsDeleteManyRes)
+     *
+     * @param {Chrt.chrtGpt.ChrtGptConversationsDeleteManyReq} request
+     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chrtGpt.conversations.deleteManyV1({
+     *         conversation_ids: ["conversation_ids"]
+     *     })
+     */
+    deleteManyV1(request: Chrt.chrtGpt.ChrtGptConversationsDeleteManyReq, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Chrt.ChrtGptConversationsDeleteManyRes>;
+    private __deleteManyV1;
+    /**
+     * Lists the caller's ChrtGPT conversations, most recently active first by default. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | () -> (ChrtGPTConversationListRes)
+     *
+     * @param {Chrt.chrtGpt.ConversationsListV1Request} request
+     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chrtGpt.conversations.listV1({
+     *         sort_by: "updated_at",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1
+     *     })
+     */
+    listV1(request?: Chrt.chrtGpt.ConversationsListV1Request, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Chrt.ChrtGptConversationListRes>;
+    private __listV1;
+    /**
+     * Renames one of the caller's ChrtGPT conversations; ChrtGPT never retitles it after that. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTConversationsUpdateTitleReq) -> (ChrtGPTConversation1)
+     *
+     * @param {string} conversationId
+     * @param {Chrt.chrtGpt.ChrtGptConversationsUpdateTitleReq} request
+     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chrtGpt.conversations.updateTitleV1("conversation_id", {
+     *         title: "title"
+     *     })
+     */
+    updateTitleV1(conversationId: string, request: Chrt.chrtGpt.ChrtGptConversationsUpdateTitleReq, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Chrt.ChrtGptConversation1>;
+    private __updateTitleV1;
+    /**
+     * Gets one of the caller's ChrtGPT conversations with its history of messages, tool calls, and web searches. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | () -> (ChrtGPTConversationRes)
+     *
+     * @param {string} conversationId
+     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.chrtGpt.conversations.getV1("conversation_id")
+     */
+    getV1(conversationId: string, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Chrt.ChrtGptConversationRes>;
+    private __getV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}