@lorikeetai/node-sdk 0.1.0 → 0.3.0

package/src/error.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { castToError, Headers } from './core'
+import { castToError, Headers } from './core';
 
 export class LorikeetError extends Error {}
 
 export class APIError extends LorikeetError {
-  readonly status: number | undefined
-  readonly headers: Headers | undefined
-  readonly error: Object | undefined
+  readonly status: number | undefined;
+  readonly headers: Headers | undefined;
+  readonly error: Object | undefined;
 
   constructor(
     status: number | undefined,
@@ -15,10 +15,10 @@ export class APIError extends LorikeetError {
     message: string | undefined,
     headers: Headers | undefined,
   ) {
-    super(`${APIError.makeMessage(status, error, message)}`)
-    this.status = status
-    this.headers = headers
-    this.error = error
+    super(`${APIError.makeMessage(status, error, message)}`);
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
   }
 
   private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
@@ -28,18 +28,18 @@ export class APIError extends LorikeetError {
           error.message
         : JSON.stringify(error.message)
       : error ? JSON.stringify(error)
-      : message
+      : message;
 
     if (status && msg) {
-      return `${status} ${msg}`
+      return `${status} ${msg}`;
     }
     if (status) {
-      return `${status} status code (no body)`
+      return `${status} status code (no body)`;
     }
     if (msg) {
-      return msg
+      return msg;
     }
-    return '(no status code or body)'
+    return '(no status code or body)';
   }
 
   static generate(
@@ -49,98 +49,98 @@ export class APIError extends LorikeetError {
     headers: Headers | undefined,
   ): APIError {
     if (!status) {
-      return new APIConnectionError({ message, cause: castToError(errorResponse) })
+      return new APIConnectionError({ message, cause: castToError(errorResponse) });
     }
 
-    const error = errorResponse as Record<string, any>
+    const error = errorResponse as Record<string, any>;
 
     if (status === 400) {
-      return new BadRequestError(status, error, message, headers)
+      return new BadRequestError(status, error, message, headers);
     }
 
     if (status === 401) {
-      return new AuthenticationError(status, error, message, headers)
+      return new AuthenticationError(status, error, message, headers);
     }
 
     if (status === 403) {
-      return new PermissionDeniedError(status, error, message, headers)
+      return new PermissionDeniedError(status, error, message, headers);
     }
 
     if (status === 404) {
-      return new NotFoundError(status, error, message, headers)
+      return new NotFoundError(status, error, message, headers);
     }
 
     if (status === 409) {
-      return new ConflictError(status, error, message, headers)
+      return new ConflictError(status, error, message, headers);
     }
 
     if (status === 422) {
-      return new UnprocessableEntityError(status, error, message, headers)
+      return new UnprocessableEntityError(status, error, message, headers);
     }
 
     if (status === 429) {
-      return new RateLimitError(status, error, message, headers)
+      return new RateLimitError(status, error, message, headers);
     }
 
     if (status >= 500) {
-      return new InternalServerError(status, error, message, headers)
+      return new InternalServerError(status, error, message, headers);
     }
 
-    return new APIError(status, error, message, headers)
+    return new APIError(status, error, message, headers);
   }
 }
 
 export class APIUserAbortError extends APIError {
-  override readonly status: undefined = undefined
+  override readonly status: undefined = undefined;
 
   constructor({ message }: { message?: string } = {}) {
-    super(undefined, undefined, message || 'Request was aborted.', undefined)
+    super(undefined, undefined, message || 'Request was aborted.', undefined);
   }
 }
 
 export class APIConnectionError extends APIError {
-  override readonly status: undefined = undefined
+  override readonly status: undefined = undefined;
 
   constructor({ message, cause }: { message?: string | undefined; cause?: Error | undefined }) {
-    super(undefined, undefined, message || 'Connection error.', undefined)
+    super(undefined, undefined, message || 'Connection error.', undefined);
     // in some environments the 'cause' property is already declared
     // @ts-ignore
-    if (cause) this.cause = cause
+    if (cause) this.cause = cause;
   }
 }
 
 export class APIConnectionTimeoutError extends APIConnectionError {
   constructor({ message }: { message?: string } = {}) {
-    super({ message: message ?? 'Request timed out.' })
+    super({ message: message ?? 'Request timed out.' });
   }
 }
 
 export class BadRequestError extends APIError {
-  override readonly status: 400 = 400
+  override readonly status: 400 = 400;
 }
 
 export class AuthenticationError extends APIError {
-  override readonly status: 401 = 401
+  override readonly status: 401 = 401;
 }
 
 export class PermissionDeniedError extends APIError {
-  override readonly status: 403 = 403
+  override readonly status: 403 = 403;
 }
 
 export class NotFoundError extends APIError {
-  override readonly status: 404 = 404
+  override readonly status: 404 = 404;
 }
 
 export class ConflictError extends APIError {
-  override readonly status: 409 = 409
+  override readonly status: 409 = 409;
 }
 
 export class UnprocessableEntityError extends APIError {
-  override readonly status: 422 = 422
+  override readonly status: 422 = 422;
 }
 
 export class RateLimitError extends APIError {
-  override readonly status: 429 = 429
+  override readonly status: 429 = 429;
 }
 
 export class InternalServerError extends APIError {}

package/src/index.ts

@@ -1,32 +1,37 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type Agent } from './_shims/index'
-import * as Core from './core'
-import * as Errors from './error'
-import * as Uploads from './uploads'
-import * as API from './resources/index'
-import { Customer, CustomerCreateParams, CustomerCreateResponse } from './resources/customer'
-import { Ingest, IngestTestParams } from './resources/ingest'
-import { Token, TokenCreateParams, TokenCreateResponse } from './resources/token'
-import { Conversation } from './resources/conversation/conversation'
+import { type Agent } from './_shims/index';
+import * as Core from './core';
+import * as Errors from './error';
+import * as Uploads from './uploads';
+import * as API from './resources/index';
+import {
+  Customer,
+  CustomerCreateParams,
+  CustomerCreateResponse,
+  CustomerTokenParams,
+  CustomerTokenResponse,
+} from './resources/customer';
+import { Ingest, IngestTestParams } from './resources/ingest';
+import { Conversation } from './resources/conversation/conversation';
 
 export interface ClientOptions {
   /**
    * client identifier authentication associated with the account.
    */
-  clientId?: string | undefined
+  clientId?: string | undefined;
 
   /**
    * Secret key pulled from the Lorikeet App
    */
-  clientSecret?: string | undefined
+  clientSecret?: string | undefined;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
    * Defaults to process.env['LORIKEET_BASE_URL'].
    */
-  baseURL?: string | null | undefined
+  baseURL?: string | null | undefined;
 
   /**
    * The maximum amount of time (in milliseconds) that the client should wait for a response
@@ -35,7 +40,7 @@ export interface ClientOptions {
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
    */
-  timeout?: number
+  timeout?: number;
 
   /**
    * An HTTP agent used to manage HTTP(S) connections.
@@ -43,7 +48,7 @@ export interface ClientOptions {
    * If not provided, an agent will be constructed by default in the Node.js environment,
    * otherwise no agent is used.
    */
-  httpAgent?: Agent
+  httpAgent?: Agent;
 
   /**
    * Specify a custom `fetch` function implementation.
@@ -51,7 +56,7 @@ export interface ClientOptions {
    * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
    * defined globally.
    */
-  fetch?: Core.Fetch | undefined
+  fetch?: Core.Fetch | undefined;
 
   /**
    * The maximum number of times that the client will retry a request in case of a
@@ -59,7 +64,7 @@ export interface ClientOptions {
    *
    * @default 2
    */
-  maxRetries?: number
+  maxRetries?: number;
 
   /**
    * Default headers to include with every request to the API.
@@ -67,7 +72,7 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * header to `undefined` or `null` in request options.
    */
-  defaultHeaders?: Core.Headers
+  defaultHeaders?: Core.Headers;
 
   /**
    * Default query parameters to include with every request to the API.
@@ -75,17 +80,17 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * param to `undefined` in request options.
    */
-  defaultQuery?: Core.DefaultQuery
+  defaultQuery?: Core.DefaultQuery;
 }
 
 /**
  * API Client for interfacing with the Lorikeet API.
  */
 export class Lorikeet extends Core.APIClient {
-  clientId: string
-  clientSecret: string
+  clientId: string;
+  clientSecret: string;
 
-  private _options: ClientOptions
+  private _options: ClientOptions;
 
   /**
    * API Client for interfacing with the Lorikeet API.
@@ -109,12 +114,12 @@ export class Lorikeet extends Core.APIClient {
     if (clientId === undefined) {
       throw new Errors.LorikeetError(
         "The LORIKEET_CLIENT_ID environment variable is missing or empty; either provide it, or instantiate the Lorikeet client with an clientId option, like new Lorikeet({ clientId: 'My Client ID' }).",
-      )
+      );
     }
     if (clientSecret === undefined) {
       throw new Errors.LorikeetError(
         "The LORIKEET_CLIENT_SECRET environment variable is missing or empty; either provide it, or instantiate the Lorikeet client with an clientSecret option, like new Lorikeet({ clientSecret: 'My Client Secret' }).",
-      )
+      );
     }
 
     const options: ClientOptions = {
@@ -122,7 +127,7 @@ export class Lorikeet extends Core.APIClient {
       clientSecret,
       ...opts,
       baseURL: baseURL || `https://api.lorikeetcx.ai`,
-    }
+    };
 
     super({
       baseURL: options.baseURL!,
@@ -130,28 +135,27 @@ export class Lorikeet extends Core.APIClient {
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
       fetch: options.fetch,
-    })
+    });
 
-    this._options = options
+    this._options = options;
 
-    this.clientId = clientId
-    this.clientSecret = clientSecret
+    this.clientId = clientId;
+    this.clientSecret = clientSecret;
   }
 
-  conversation: API.Conversation = new API.Conversation(this)
-  token: API.Token = new API.Token(this)
-  customer: API.Customer = new API.Customer(this)
-  ingest: API.Ingest = new API.Ingest(this)
+  conversation: API.Conversation = new API.Conversation(this);
+  customer: API.Customer = new API.Customer(this);
+  ingest: API.Ingest = new API.Ingest(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
-    return this._options.defaultQuery
+    return this._options.defaultQuery;
   }
 
   protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
     return {
       ...super.defaultHeaders(opts),
       ...this._options.defaultHeaders,
-    }
+    };
   }
 
   protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
@@ -163,34 +167,34 @@ export class Lorikeet extends Core.APIClient {
         : JSON.stringify(opts.body, null, 2)
       : '',
       this.clientSecret,
-    )
+    );
     return {
       // backwards compatibility
       'x-optech-webhook-signature': signature,
       'x-lorikeet-signature': signature,
       authorization: `Bearer ${this.clientId}`,
-    }
+    };
   }
 
-  static Lorikeet = this
-  static DEFAULT_TIMEOUT = 60000 // 1 minute
-
-  static LorikeetError = Errors.LorikeetError
-  static APIError = Errors.APIError
-  static APIConnectionError = Errors.APIConnectionError
-  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError
-  static APIUserAbortError = Errors.APIUserAbortError
-  static NotFoundError = Errors.NotFoundError
-  static ConflictError = Errors.ConflictError
-  static RateLimitError = Errors.RateLimitError
-  static BadRequestError = Errors.BadRequestError
-  static AuthenticationError = Errors.AuthenticationError
-  static InternalServerError = Errors.InternalServerError
-  static PermissionDeniedError = Errors.PermissionDeniedError
-  static UnprocessableEntityError = Errors.UnprocessableEntityError
-
-  static toFile = Uploads.toFile
-  static fileFromPath = Uploads.fileFromPath
+  static Lorikeet = this;
+  static DEFAULT_TIMEOUT = 60000; // 1 minute
+
+  static LorikeetError = Errors.LorikeetError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+
+  static toFile = Uploads.toFile;
+  static fileFromPath = Uploads.fileFromPath;
 }
 
 export {
@@ -207,35 +211,30 @@ export {
   InternalServerError,
   PermissionDeniedError,
   UnprocessableEntityError,
-} from './error'
+} from './error';
 
-export import toFile = Uploads.toFile
-export import fileFromPath = Uploads.fileFromPath
-import { generateSignature } from './lib/generate-signature'
+export import toFile = Uploads.toFile;
+export import fileFromPath = Uploads.fileFromPath;
+import { generateSignature } from './lib/generate-signature';
 
-Lorikeet.Conversation = Conversation
-Lorikeet.Token = Token
-Lorikeet.Customer = Customer
-Lorikeet.Ingest = Ingest
+Lorikeet.Conversation = Conversation;
+Lorikeet.Customer = Customer;
+Lorikeet.Ingest = Ingest;
 
 export declare namespace Lorikeet {
-  export type RequestOptions = Core.RequestOptions
+  export type RequestOptions = Core.RequestOptions;
 
-  export { Conversation as Conversation }
-
-  export {
-    Token as Token,
-    type TokenCreateResponse as TokenCreateResponse,
-    type TokenCreateParams as TokenCreateParams,
-  }
+  export { Conversation as Conversation };
 
   export {
     Customer as Customer,
     type CustomerCreateResponse as CustomerCreateResponse,
+    type CustomerTokenResponse as CustomerTokenResponse,
     type CustomerCreateParams as CustomerCreateParams,
-  }
+    type CustomerTokenParams as CustomerTokenParams,
+  };
 
-  export { Ingest as Ingest, type IngestTestParams as IngestTestParams }
+  export { Ingest as Ingest, type IngestTestParams as IngestTestParams };
 }
 
-export default Lorikeet
+export default Lorikeet;

package/src/lib/generate-signature.ts

@@ -1,4 +1,4 @@
-import crypto from 'crypto'
+import crypto from 'crypto';
 
 /**
  * Generate a signature for a given payload using a secret key.
@@ -7,7 +7,7 @@ import crypto from 'crypto'
  */
 export function generateSignature(payload: Buffer | string | undefined, secret: string) {
   if (!payload) {
-    return crypto.createHmac('sha256', secret).digest('base64').replace(/\+/g, '-').replace(/\//g, '_')
+    return crypto.createHmac('sha256', secret).digest('base64').replace(/\+/g, '-').replace(/\//g, '_');
   }
 
   return crypto
@@ -15,5 +15,5 @@ export function generateSignature(payload: Buffer | string | undefined, secret:
     .update(payload)
     .digest('base64')
     .replace(/\+/g, '-')
-    .replace(/\//g, '_')
+    .replace(/\//g, '_');
 }

package/src/resource.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import type { Lorikeet } from './index'
+import type { Lorikeet } from './index';
 
 export class APIResource {
-  protected _client: Lorikeet
+  protected _client: Lorikeet;
 
   constructor(client: Lorikeet) {
-    this._client = client
+    this._client = client;
   }
 }

package/src/resources/conversation/chat.ts

@@ -1,19 +1,19 @@
 // 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 '../../resource';
+import * as Core from '../../core';
 
 export class Chat extends APIResource {
   generate(body: ChatGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ChatGenerateResponse> {
-    return this._client.post('/v1/conversation/chat/message', { body, ...options })
+    return this._client.post('/v1/conversation/chat/message', { body, ...options });
   }
 
   get(query: ChatGetParams, options?: Core.RequestOptions): Core.APIPromise<ChatGetResponse> {
-    return this._client.get('/v1/conversation/chat/message', { query, ...options })
+    return this._client.get('/v1/conversation/chat/message', { query, ...options });
   }
 
   start(body: ChatStartParams, options?: Core.RequestOptions): Core.APIPromise<ChatStartResponse> {
-    return this._client.post('/v1/conversation/chat/create', { body, ...options })
+    return this._client.post('/v1/conversation/chat/create', { body, ...options });
   }
 }
 
@@ -21,79 +21,141 @@ export interface ChatGenerateResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown
+  conversationId: unknown;
 
   /**
    * The timestamp of when the message was created in our system.
    */
-  createdAt: string
+  createdAt: string;
 
   /**
-   * The message to be sent back to the user. If empty, the message is still being
-   * processed.
+   * The created message. This endpoint supports markdown.
    */
-  message: string
+  message: ChatGenerateResponse.Message;
+
+  /**
+   * The timestamp of when the ticket was last updated in our system.
+   */
+  updatedAt: string;
+}
+
+export namespace ChatGenerateResponse {
+  /**
+   * The created message. This endpoint supports markdown.
+   */
+  export interface Message {
+    /**
+     * The ID of the conversation message
+     */
+    id: string;
+
+    /**
+     * The content of the message. Markdown on plain text.
+     */
+    content: string;
+
+    /**
+     * The raw content of the message. Usually HTML.
+     */
+    rawContent: string;
+
+    /**
+     * The type of the message
+     */
+    type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+  }
 }
 
 export interface ChatGetResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown
+  conversationId: unknown;
 
   /**
    * The timestamp of when the message was created in our system.
    */
-  createdAt: string
+  createdAt: string;
 
   /**
-   * The message to be sent back to the user. If empty, the message is still being
-   * processed.
+   * The created message. This endpoint supports markdown.
    */
-  message: string
+  message: ChatGetResponse.Message;
+
+  /**
+   * The timestamp of when the ticket was last updated in our system.
+   */
+  updatedAt: string;
+}
+
+export namespace ChatGetResponse {
+  /**
+   * The created message. This endpoint supports markdown.
+   */
+  export interface Message {
+    /**
+     * The ID of the conversation message
+     */
+    id: string;
+
+    /**
+     * The content of the message. Markdown on plain text.
+     */
+    content: string;
+
+    /**
+     * The raw content of the message. Usually HTML.
+     */
+    rawContent: string;
+
+    /**
+     * The type of the message
+     */
+    type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+  }
 }
 
 export interface ChatStartResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown
+  conversationId: unknown;
 
   /**
    * The timestamp of the when the conversation was created in our system.
    */
-  createdAt: string
+  createdAt: string;
 }
 
 export interface ChatGenerateParams {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown
+  conversationId: unknown;
 
   /**
    * The message to be sent to the user. This endpoint supports markdown.
    */
-  message: string
+  message: string;
 }
 
 export interface ChatGetParams {
   /**
    * The ID of the conversation you need to poll.
    */
-  conversationId: string
+  conversationId: string;
 }
 
 export interface ChatStartParams {
   /**
    * The ID of the customer. If omitted, a new customer will be created.
    */
-  customerId: unknown
+  customerId: unknown;
 
   /**
    * The timestamp of the when the conversation was created in our system.
    */
-  subject?: string
+  subject?: string;
 }
 
 export declare namespace Chat {
@@ -104,5 +166,5 @@ export declare namespace Chat {
     type ChatGenerateParams as ChatGenerateParams,
     type ChatGetParams as ChatGetParams,
     type ChatStartParams as ChatStartParams,
-  }
+  };
 }