@lorikeetai/node-sdk 1.8.1 → 2.0.0

package/src/resources/conversation/conversation.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
+import { APIResource } from '../../core/resource';
 import * as ChatAPI from './chat';
 import {
   Chat,

package/src/resources/conversation/email.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import { pollUntil } from "../../lib/poll-until";
+import { APIResource } from '../../core/resource';
 import * as ConversationAPI from './conversation';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { pollUntil } from '../../lib/poll-until';
 
 export class Email extends APIResource {
   /**
@@ -22,7 +23,7 @@ export class Email extends APIResource {
    * });
    * ```
    */
-  generate(body: EmailGenerateParams, options?: Core.RequestOptions): Core.APIPromise<EmailGenerateResponse> {
+  generate(body: EmailGenerateParams, options?: RequestOptions): APIPromise<EmailGenerateResponse> {
     return this._client.post('/v1/conversation/email/message', { body, ...options });
   }
 
@@ -34,7 +35,7 @@ export class Email extends APIResource {
    * });
    * ```
    */
-  get(query: EmailGetParams, options?: Core.RequestOptions): Core.APIPromise<EmailGetResponse> {
+  get(query: EmailGetParams, options?: RequestOptions): APIPromise<EmailGetResponse> {
     return this._client.get('/v1/conversation/email/message', { query, ...options });
   }
 
@@ -47,23 +48,23 @@ export class Email extends APIResource {
    * });
    * ```
    */
-  start(body: EmailStartParams, options?: Core.RequestOptions): Core.APIPromise<EmailStartResponse> {
+  start(body: EmailStartParams, options?: RequestOptions): APIPromise<EmailStartResponse> {
     return this._client.post('/v1/conversation/email/create', { body, ...options });
   }
 
   /**
-   * __chat.get__
+   * Poll until the conversation has a bot response ready.
    *
-   * Polls until it returns a BOT chat message for a conversation.
+   * Stops when `latestMessageType` is `BOT_RESPONSE` or `PENDING_RESPONSE`,
+   * or when `status` is `Escalated` or `Error`.
    */
-  poll(query: EmailGetParams, options?: Core.RequestOptions): Core.APIPromise<EmailGetResponse> {
+  poll(query: EmailGetParams, options?: RequestOptions): APIPromise<EmailGetResponse> {
     return pollUntil<EmailGetResponse>(
-      () => this._client.get('/v1/conversation/chat/message', { query, ...options }),
+      () => this._client.get('/v1/conversation/email/message', { query, ...options }),
       {
         timeout: options?.timeout || 180_000,
         interval: 2_000,
         condition: (conversation) => {
-          // Don't poll if the conversation is escalated or in error
           if (conversation.status === 'Escalated' || conversation.status === 'Error') {
             return true;
           }
@@ -78,7 +79,7 @@ export class Email extends APIResource {
           return false;
         },
       },
-    ) as Core.APIPromise<EmailGetResponse>;
+    ) as APIPromise<EmailGetResponse>;
   }
 }
 

package/src/resources/conversation/index.ts

@@ -8,6 +8,11 @@ export {
   type ChatGenerateParams,
   type ChatGetParams,
   type ChatStartParams,
+  type ChatStreamParams,
+  type ChatStreamEvent,
+  type ChatStreamNewMessageEvent,
+  type ChatStreamMessageChunkEvent,
+  type ChatStreamMessageCompleteEvent,
 } from './chat';
 export { Conversation, type AttachmentDto, type TicketEvent, type TicketMessageDto } from './conversation';
 export {

package/src/resources/conversation/voice.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Voice extends APIResource {
   /**
@@ -12,11 +14,11 @@ export class Voice extends APIResource {
    * });
    * ```
    */
-  outbound(body: VoiceOutboundParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+  outbound(body: VoiceOutboundParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/v1/conversation/voice/outbound', {
       body,
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }

package/src/resources/customer/customer.ts

@@ -1,12 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as ProfileAPI from './profile';
 import { Profile, ProfileSyncParams, ProfileSyncResponse } from './profile';
 import * as RemoteAPI from './remote';
 import { Remote, RemoteGetResponse, RemoteUpdateParams, RemoteUpdateResponse } from './remote';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Customer extends APIResource {
   remote: RemoteAPI.Remote = new RemoteAPI.Remote(this._client);
@@ -18,7 +19,7 @@ export class Customer extends APIResource {
    * const customer = await client.customer.create();
    * ```
    */
-  create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomerCreateResponse> {
+  create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerCreateResponse> {
     return this._client.post('/v1/customer', { body, ...options });
   }
 
@@ -33,9 +34,9 @@ export class Customer extends APIResource {
   update(
     id: string,
     body: CustomerUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CustomerUpdateResponse> {
-    return this._client.put(`/v1/customer/${id}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<CustomerUpdateResponse> {
+    return this._client.put(path`/v1/customer/${id}`, { body, ...options });
   }
 
   /**
@@ -44,15 +45,10 @@ export class Customer extends APIResource {
    * const customer = await client.customer.get();
    * ```
    */
-  get(query?: CustomerGetParams, options?: Core.RequestOptions): Core.APIPromise<CustomerGetResponse>;
-  get(options?: Core.RequestOptions): Core.APIPromise<CustomerGetResponse>;
   get(
-    query: CustomerGetParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CustomerGetResponse> {
-    if (isRequestOptions(query)) {
-      return this.get({}, query);
-    }
+    query: CustomerGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerGetResponse> {
     return this._client.get('/v1/customer', { query, ...options });
   }
 
@@ -62,7 +58,7 @@ export class Customer extends APIResource {
    * const response = await client.customer.token();
    * ```
    */
-  token(body: CustomerTokenParams, options?: Core.RequestOptions): Core.APIPromise<string> {
+  token(body: CustomerTokenParams, options?: RequestOptions): APIPromise<string> {
     return this._client.post('/v1/customer/token', { body, ...options });
   }
 }

package/src/resources/customer/profile.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Profile extends APIResource {
   /**
@@ -13,12 +15,8 @@ export class Profile extends APIResource {
    * );
    * ```
    */
-  sync(
-    id: string,
-    body: ProfileSyncParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ProfileSyncResponse> {
-    return this._client.put(`/v1/customer/profile/${id}`, { body, ...options });
+  sync(id: string, body: ProfileSyncParams, options?: RequestOptions): APIPromise<ProfileSyncResponse> {
+    return this._client.put(path`/v1/customer/profile/${id}`, { body, ...options });
   }
 }
 

package/src/resources/customer/remote.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Remote extends APIResource {
   /**
@@ -13,11 +15,11 @@ export class Remote extends APIResource {
    * ```
    */
   update(
-    pathRemoteId: string,
+    remoteID: string,
     body: RemoteUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RemoteUpdateResponse> {
-    return this._client.patch(`/v1/customer/remote/${pathRemoteId}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<RemoteUpdateResponse> {
+    return this._client.patch(path`/v1/customer/remote/${remoteID}`, { body, ...options });
   }
 
   /**
@@ -26,8 +28,8 @@ export class Remote extends APIResource {
    * const remote = await client.customer.remote.get('remoteId');
    * ```
    */
-  get(remoteId: string, options?: Core.RequestOptions): Core.APIPromise<RemoteGetResponse> {
-    return this._client.get(`/v1/customer/remote/${remoteId}`, options);
+  get(remoteID: string, options?: RequestOptions): APIPromise<RemoteGetResponse> {
+    return this._client.get(path`/v1/customer/remote/${remoteID}`, options);
   }
 }
 

package/src/resources/index.ts

@@ -24,4 +24,4 @@ export {
   type CustomerGetParams,
   type CustomerTokenParams,
 } from './customer/customer';
-export { Ingest, type IngestTestParams } from './ingest';
+export { Ingest, type IngestSubmitParams, type IngestTestParams } from './ingest';

package/src/resources/ingest.ts

@@ -1,38 +1,44 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class Ingest extends APIResource {
-  submit(
-    toolId: string,
-    ticketId: string,
-    inputHash: string,
-    workflowId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<void> {
-    return this._client.post(`/ingest/${toolId}/${ticketId}/${inputHash}/${workflowId}`, {
+  submit(workflowID: string, params: IngestSubmitParams, options?: RequestOptions): APIPromise<void> {
+    const { toolId, ticketId, inputHash } = params;
+    return this._client.post(path`/ingest/${toolId}/${ticketId}/${inputHash}/${workflowID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  test(toolId: unknown, body: IngestTestParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post(`/ingest/test/${toolId}`, {
+  test(toolID: string, body: IngestTestParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/ingest/test/${toolID}`, {
       body,
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  validate(options?: Core.RequestOptions): Core.APIPromise<void> {
+  validate(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/ingest/validate', {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
 
+export interface IngestSubmitParams {
+  toolId: string;
+
+  ticketId: string;
+
+  inputHash: string;
+}
+
 export interface IngestTestParams {
   /**
    * The input data to simulate a test response for.
@@ -46,5 +52,5 @@ export interface IngestTestParams {
 }
 
 export declare namespace Ingest {
-  export { type IngestTestParams as IngestTestParams };
+  export { type IngestSubmitParams as IngestSubmitParams, type IngestTestParams as IngestTestParams };
 }

package/src/tsconfig.json

@@ -4,8 +4,8 @@
   // via declaration maps
   "include": ["index.ts"],
   "compilerOptions": {
-    "target": "es2015",
-    "lib": ["DOM"],
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
     "moduleResolution": "node"
   }
 }

package/src/uploads.ts

@@ -1,256 +1,2 @@
-import { type RequestOptions } from './core';
-import {
-  FormData,
-  File,
-  type Blob,
-  type FilePropertyBag,
-  getMultipartRequestOptions,
-  type FsReadStream,
-  isFsReadStream,
-} from './_shims/index';
-import { MultipartBody } from './_shims/MultipartBody';
-export { fileFromPath } from './_shims/index';
-
-type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
-export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
-
-/**
- * Typically, this is a native "File" class.
- *
- * We provide the {@link toFile} utility to convert a variety of objects
- * into the File class.
- *
- * For convenience, you can also pass a fetch Response, or in Node,
- * the result of fs.createReadStream().
- */
-export type Uploadable = FileLike | ResponseLike | FsReadStream;
-
-/**
- * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
- */
-export interface BlobLike {
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
-  readonly size: number;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
-  readonly type: string;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
-  text(): Promise<string>;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
-  slice(start?: number, end?: number): BlobLike;
-  // unfortunately @types/node-fetch@^2.6.4 doesn't type the arrayBuffer method
-}
-
-/**
- * Intended to match web.File, node.File, node-fetch.File, etc.
- */
-export interface FileLike extends BlobLike {
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
-  readonly lastModified: number;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
-  readonly name: string;
-}
-
-/**
- * Intended to match web.Response, node.Response, node-fetch.Response, etc.
- */
-export interface ResponseLike {
-  url: string;
-  blob(): Promise<BlobLike>;
-}
-
-export const isResponseLike = (value: any): value is ResponseLike =>
-  value != null &&
-  typeof value === 'object' &&
-  typeof value.url === 'string' &&
-  typeof value.blob === 'function';
-
-export const isFileLike = (value: any): value is FileLike =>
-  value != null &&
-  typeof value === 'object' &&
-  typeof value.name === 'string' &&
-  typeof value.lastModified === 'number' &&
-  isBlobLike(value);
-
-/**
- * The BlobLike type omits arrayBuffer() because @types/node-fetch@^2.6.4 lacks it; but this check
- * adds the arrayBuffer() method type because it is available and used at runtime
- */
-export const isBlobLike = (value: any): value is BlobLike & { arrayBuffer(): Promise<ArrayBuffer> } =>
-  value != null &&
-  typeof value === 'object' &&
-  typeof value.size === 'number' &&
-  typeof value.type === 'string' &&
-  typeof value.text === 'function' &&
-  typeof value.slice === 'function' &&
-  typeof value.arrayBuffer === 'function';
-
-export const isUploadable = (value: any): value is Uploadable => {
-  return isFileLike(value) || isResponseLike(value) || isFsReadStream(value);
-};
-
-export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
-
-/**
- * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
- * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
- * @param {Object=} options additional properties
- * @param {string=} options.type the MIME type of the content
- * @param {number=} options.lastModified the last modified timestamp
- * @returns a {@link File} with the given properties
- */
-export async function toFile(
-  value: ToFileInput | PromiseLike<ToFileInput>,
-  name?: string | null | undefined,
-  options?: FilePropertyBag | undefined,
-): Promise<FileLike> {
-  // If it's a promise, resolve it.
-  value = await value;
-
-  // If we've been given a `File` we don't need to do anything
-  if (isFileLike(value)) {
-    return value;
-  }
-
-  if (isResponseLike(value)) {
-    const blob = await value.blob();
-    name ||= new URL(value.url).pathname.split(/[\\/]/).pop() ?? 'unknown_file';
-
-    // we need to convert the `Blob` into an array buffer because the `Blob` class
-    // that `node-fetch` defines is incompatible with the web standard which results
-    // in `new File` interpreting it as a string instead of binary data.
-    const data = isBlobLike(blob) ? [(await blob.arrayBuffer()) as any] : [blob];
-
-    return new File(data, name, options);
-  }
-
-  const bits = await getBytes(value);
-
-  name ||= getName(value) ?? 'unknown_file';
-
-  if (!options?.type) {
-    const type = (bits[0] as any)?.type;
-    if (typeof type === 'string') {
-      options = { ...options, type };
-    }
-  }
-
-  return new File(bits, name, options);
-}
-
-async function getBytes(value: ToFileInput): Promise<Array<BlobPart>> {
-  let parts: Array<BlobPart> = [];
-  if (
-    typeof value === 'string' ||
-    ArrayBuffer.isView(value) || // includes Uint8Array, Buffer, etc.
-    value instanceof ArrayBuffer
-  ) {
-    parts.push(value);
-  } else if (isBlobLike(value)) {
-    parts.push(await value.arrayBuffer());
-  } else if (
-    isAsyncIterableIterator(value) // includes Readable, ReadableStream, etc.
-  ) {
-    for await (const chunk of value) {
-      parts.push(chunk as BlobPart); // TODO, consider validating?
-    }
-  } else {
-    throw new Error(
-      `Unexpected data type: ${typeof value}; constructor: ${
-        value?.constructor?.name
-      }; props: ${propsForError(value)}`,
-    );
-  }
-
-  return parts;
-}
-
-function propsForError(value: any): string {
-  const props = Object.getOwnPropertyNames(value);
-  return `[${props.map((p) => `"${p}"`).join(', ')}]`;
-}
-
-function getName(value: any): string | undefined {
-  return (
-    getStringFromMaybeBuffer(value.name) ||
-    getStringFromMaybeBuffer(value.filename) ||
-    // For fs.ReadStream
-    getStringFromMaybeBuffer(value.path)?.split(/[\\/]/).pop()
-  );
-}
-
-const getStringFromMaybeBuffer = (x: string | Buffer | unknown): string | undefined => {
-  if (typeof x === 'string') return x;
-  if (typeof Buffer !== 'undefined' && x instanceof Buffer) return String(x);
-  return undefined;
-};
-
-const isAsyncIterableIterator = (value: any): value is AsyncIterableIterator<unknown> =>
-  value != null && typeof value === 'object' && typeof value[Symbol.asyncIterator] === 'function';
-
-export const isMultipartBody = (body: any): body is MultipartBody =>
-  body && typeof body === 'object' && body.body && body[Symbol.toStringTag] === 'MultipartBody';
-
-/**
- * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
- * Otherwise returns the request as is.
- */
-export const maybeMultipartFormRequestOptions = async <T = Record<string, unknown>>(
-  opts: RequestOptions<T>,
-): Promise<RequestOptions<T | MultipartBody>> => {
-  if (!hasUploadableValue(opts.body)) return opts;
-
-  const form = await createForm(opts.body);
-  return getMultipartRequestOptions(form, opts);
-};
-
-export const multipartFormRequestOptions = async <T = Record<string, unknown>>(
-  opts: RequestOptions<T>,
-): Promise<RequestOptions<T | MultipartBody>> => {
-  const form = await createForm(opts.body);
-  return getMultipartRequestOptions(form, opts);
-};
-
-export const createForm = async <T = Record<string, unknown>>(body: T | undefined): Promise<FormData> => {
-  const form = new FormData();
-  await Promise.all(Object.entries(body || {}).map(([key, value]) => addFormValue(form, key, value)));
-  return form;
-};
-
-const hasUploadableValue = (value: unknown): boolean => {
-  if (isUploadable(value)) return true;
-  if (Array.isArray(value)) return value.some(hasUploadableValue);
-  if (value && typeof value === 'object') {
-    for (const k in value) {
-      if (hasUploadableValue((value as any)[k])) return true;
-    }
-  }
-  return false;
-};
-
-const addFormValue = async (form: FormData, key: string, value: unknown): Promise<void> => {
-  if (value === undefined) return;
-  if (value == null) {
-    throw new TypeError(
-      `Received null for "${key}"; to pass null in FormData, you must use the string 'null'`,
-    );
-  }
-
-  // TODO: make nested formats configurable
-  if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-    form.append(key, String(value));
-  } else if (isUploadable(value)) {
-    const file = await toFile(value);
-    form.append(key, file as File);
-  } else if (Array.isArray(value)) {
-    await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
-  } else if (typeof value === 'object') {
-    await Promise.all(
-      Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
-    );
-  } else {
-    throw new TypeError(
-      `Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
-    );
-  }
-};
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.8.1'; // x-release-please-version
+export const VERSION = '0.1.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}