@lorikeetai/node-sdk 0.3.0 → 0.4.1

package/resources/workflow.js

@@ -0,0 +1,18 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Workflow = void 0;
+const resource_1 = require("../resource.js");
+class Workflow extends resource_1.APIResource {
+    update(options) {
+        return this._client.post('/v1/workflow', { ...options, headers: { Accept: '*/*', ...options?.headers } });
+    }
+    get(id, options) {
+        return this._client.get(`/v1/workflow/${id}`, {
+            ...options,
+            headers: { Accept: '*/*', ...options?.headers },
+        });
+    }
+}
+exports.Workflow = Workflow;
+//# sourceMappingURL=workflow.js.map

package/resources/workflow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.js","sourceRoot":"","sources":["../src/resources/workflow.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,QAAS,SAAQ,sBAAW;IACvC,MAAM,CAAC,OAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,EAAE;YAC5C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAXD,4BAWC"}

package/resources/workflow.mjs

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../resource.mjs";
+export class Workflow extends APIResource {
+    update(options) {
+        return this._client.post('/v1/workflow', { ...options, headers: { Accept: '*/*', ...options?.headers } });
+    }
+    get(id, options) {
+        return this._client.get(`/v1/workflow/${id}`, {
+            ...options,
+            headers: { Accept: '*/*', ...options?.headers },
+        });
+    }
+}
+//# sourceMappingURL=workflow.mjs.map

package/resources/workflow.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.mjs","sourceRoot":"","sources":["../src/resources/workflow.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC,MAAM,CAAC,OAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,EAAE;YAC5C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/index.ts

@@ -9,11 +9,14 @@ import {
   Customer,
   CustomerCreateParams,
   CustomerCreateResponse,
+  CustomerGetResponse,
   CustomerTokenParams,
   CustomerTokenResponse,
 } from './resources/customer';
 import { Ingest, IngestTestParams } from './resources/ingest';
+import { Workflow } from './resources/workflow';
 import { Conversation } from './resources/conversation/conversation';
+import { generateSignature } from './lib/generate-signature';
 
 export interface ClientOptions {
   /**
@@ -145,6 +148,7 @@ export class Lorikeet extends Core.APIClient {
 
   conversation: API.Conversation = new API.Conversation(this);
   customer: API.Customer = new API.Customer(this);
+  workflow: API.Workflow = new API.Workflow(this);
   ingest: API.Ingest = new API.Ingest(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
@@ -197,30 +201,10 @@ export class Lorikeet extends Core.APIClient {
   static fileFromPath = Uploads.fileFromPath;
 }
 
-export {
-  LorikeetError,
-  APIError,
-  APIConnectionError,
-  APIConnectionTimeoutError,
-  APIUserAbortError,
-  NotFoundError,
-  ConflictError,
-  RateLimitError,
-  BadRequestError,
-  AuthenticationError,
-  InternalServerError,
-  PermissionDeniedError,
-  UnprocessableEntityError,
-} from './error';
-
-export import toFile = Uploads.toFile;
-export import fileFromPath = Uploads.fileFromPath;
-import { generateSignature } from './lib/generate-signature';
-
 Lorikeet.Conversation = Conversation;
 Lorikeet.Customer = Customer;
+Lorikeet.Workflow = Workflow;
 Lorikeet.Ingest = Ingest;
-
 export declare namespace Lorikeet {
   export type RequestOptions = Core.RequestOptions;
 
@@ -229,12 +213,34 @@ export declare namespace Lorikeet {
   export {
     Customer as Customer,
     type CustomerCreateResponse as CustomerCreateResponse,
+    type CustomerGetResponse as CustomerGetResponse,
     type CustomerTokenResponse as CustomerTokenResponse,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerTokenParams as CustomerTokenParams,
   };
 
+  export { Workflow as Workflow };
+
   export { Ingest as Ingest, type IngestTestParams as IngestTestParams };
 }
 
+export { toFile, fileFromPath } from './uploads';
+export {
+  LorikeetError,
+  APIError,
+  APIConnectionError,
+  APIConnectionTimeoutError,
+  APIUserAbortError,
+  NotFoundError,
+  ConflictError,
+  RateLimitError,
+  BadRequestError,
+  AuthenticationError,
+  InternalServerError,
+  PermissionDeniedError,
+  UnprocessableEntityError,
+} from './error';
+
+export { generateSignature } from "./lib/generate-signature";
+
 export default Lorikeet;

package/src/lib/poll-until.ts

@@ -0,0 +1,38 @@
+interface PollUntilOptions<TData> {
+  /**
+   * The maximum time to wait for the condition to be met (ms).
+   */
+  timeout?: number;
+  /**
+   * The interval between each poll (ms).
+   */
+  interval?: number;
+  /**
+   *
+   * @param result The result of the polling function.
+   * @returns
+   */
+  condition: (result: TData) => boolean;
+}
+
+/** Utility function to poll an endpoint. */
+export const pollUntil = async <T>(
+  fn: () => Promise<T>,
+  { condition = (result) => !!result, interval = 3000, timeout = 30000 }: PollUntilOptions<T>,
+): Promise<T> => {
+  const startTime = Date.now();
+
+  if (interval < 1000) {
+    throw new Error(`Polling interval must be at least 1000ms`);
+  }
+
+  while (Date.now() - startTime < timeout) {
+    const result = await fn();
+    if (condition(result)) {
+      return result;
+    }
+    await new Promise((resolve) => setTimeout(resolve, interval));
+  }
+
+  throw new Error(`Polling timed out`);
+};

package/src/resources/conversation/chat.ts

@@ -2,36 +2,99 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
+import { pollUntil } from "../../lib/poll-until";
 
 export class Chat extends APIResource {
+  /**
+   * __chat.generate__
+   *
+   * Generate a chat message for a conversation. This endpoint will return immediately, polling will be required to get the response.
+   *
+   * The `latestMessageType` field in the response can be used to determine if the response is ready.
+   *
+   * If the `latestMessageType` is `BOT_RESPONSE`, the response is ready.
+   * For a more ergonomic way to poll, use the `message` method.
+   *
+   * ** WARNING ** This endpoint is not idempotent. If you call it multiple times, you will generate multiple messages.
+   *
+   * @see {@link Chat.message}
+   */
   generate(body: ChatGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ChatGenerateResponse> {
     return this._client.post('/v1/conversation/chat/message', { body, ...options });
   }
 
+  /**
+   * __chat.get__
+   *
+   * Returns a chat message for a conversation. This endpoint will return the latest state of the conversation.
+   */
   get(query: ChatGetParams, options?: Core.RequestOptions): Core.APIPromise<ChatGetResponse> {
     return this._client.get('/v1/conversation/chat/message', { query, ...options });
   }
 
+  /**
+   * __chat.start__
+   *
+   * Start a chat conversation. This endpoint will return immediately.
+   *
+   * The `conversationId` field in the response can be used to generate messages.
+   *
+   * ** WARNING ** This endpoint is not idempotent. If you call it multiple times, you will generate multiple conversations.
+   */
   start(body: ChatStartParams, options?: Core.RequestOptions): Core.APIPromise<ChatStartResponse> {
     return this._client.post('/v1/conversation/chat/create', { body, ...options });
   }
+
+  /**
+   * Returns a chat message for a conversation. This endpoint will poll until a response is ready.
+   *
+   * When it return the response is the latest message type that is of type `BOT_RESPONSE`.
+   *
+   * @see {@link Chat.poll}
+   */
+  message(body: ChatGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ChatGetResponse> {
+    return this.generate(body, options).then((response) =>
+      this.poll({ conversationId: response.conversationId }, options),
+    ) as Core.APIPromise<ChatGetResponse>;
+  }
+
+  /**
+   * __chat.get__
+   *
+   * Polls until it returns a BOT chat message for a conversation.
+   */
+  poll(query: ChatGetParams, options?: Core.RequestOptions): Core.APIPromise<ChatGetResponse> {
+    return pollUntil<ChatGetResponse>(
+      () => this._client.get('/v1/conversation/chat/message', { query, ...options }),
+      {
+        timeout: 180_000,
+        interval: 5_000,
+        condition: (conversation) => conversation.latestMessageType === 'BOT_RESPONSE',
+      },
+    ) as Core.APIPromise<ChatGetResponse>;
+  }
 }
 
 export interface ChatGenerateResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown;
+  conversationId: string;
 
   /**
-   * The timestamp of when the message was created in our system.
+   * The timestamp of the when the conversation was created in our system.
    */
   createdAt: string;
 
   /**
-   * The created message. This endpoint supports markdown.
+   * The latest message type - useful for polling
    */
-  message: ChatGenerateResponse.Message;
+  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+
+  /**
+   * The full list of messages. This endpoint supports markdown.
+   */
+  messages: Array<ChatGenerateResponse.Message>;
 
   /**
    * The timestamp of when the ticket was last updated in our system.
@@ -40,9 +103,6 @@ export interface ChatGenerateResponse {
 }
 
 export namespace ChatGenerateResponse {
-  /**
-   * The created message. This endpoint supports markdown.
-   */
   export interface Message {
     /**
      * The ID of the conversation message
@@ -54,6 +114,11 @@ export namespace ChatGenerateResponse {
      */
     content: string;
 
+    /**
+     * The timestamp of the message.
+     */
+    createdAt: string;
+
     /**
      * The raw content of the message. Usually HTML.
      */
@@ -70,17 +135,22 @@ export interface ChatGetResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown;
+  conversationId: string;
 
   /**
-   * The timestamp of when the message was created in our system.
+   * The timestamp of the when the conversation was created in our system.
    */
   createdAt: string;
 
   /**
-   * The created message. This endpoint supports markdown.
+   * The latest message type - useful for polling
    */
-  message: ChatGetResponse.Message;
+  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+
+  /**
+   * The full list of messages. This endpoint supports markdown.
+   */
+  messages: Array<ChatGetResponse.Message>;
 
   /**
    * The timestamp of when the ticket was last updated in our system.
@@ -89,9 +159,6 @@ export interface ChatGetResponse {
 }
 
 export namespace ChatGetResponse {
-  /**
-   * The created message. This endpoint supports markdown.
-   */
   export interface Message {
     /**
      * The ID of the conversation message
@@ -103,6 +170,11 @@ export namespace ChatGetResponse {
      */
     content: string;
 
+    /**
+     * The timestamp of the message.
+     */
+    createdAt: string;
+
     /**
      * The raw content of the message. Usually HTML.
      */
@@ -119,7 +191,7 @@ export interface ChatStartResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown;
+  conversationId: string;
 
   /**
    * The timestamp of the when the conversation was created in our system.
@@ -131,7 +203,7 @@ export interface ChatGenerateParams {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown;
+  conversationId: string;
 
   /**
    * The message to be sent to the user. This endpoint supports markdown.
@@ -150,7 +222,12 @@ export interface ChatStartParams {
   /**
    * The ID of the customer. If omitted, a new customer will be created.
    */
-  customerId: unknown;
+  customerId: string;
+
+  /**
+   * The public key associated with this agent
+   */
+  publicKey: string;
 
   /**
    * The timestamp of the when the conversation was created in our system.

package/src/resources/conversation/conversation.ts

@@ -12,7 +12,15 @@ import {
   ChatStartResponse,
 } from './chat';
 import * as EmailAPI from './email';
-import { Email, EmailStartParams, EmailStartResponse } from './email';
+import {
+  Email,
+  EmailGenerateParams,
+  EmailGenerateResponse,
+  EmailGetParams,
+  EmailGetResponse,
+  EmailStartParams,
+  EmailStartResponse,
+} from './email';
 
 export class Conversation extends APIResource {
   email: EmailAPI.Email = new EmailAPI.Email(this._client);
@@ -25,7 +33,11 @@ Conversation.Chat = Chat;
 export declare namespace Conversation {
   export {
     Email as Email,
+    type EmailGenerateResponse as EmailGenerateResponse,
+    type EmailGetResponse as EmailGetResponse,
     type EmailStartResponse as EmailStartResponse,
+    type EmailGenerateParams as EmailGenerateParams,
+    type EmailGetParams as EmailGetParams,
     type EmailStartParams as EmailStartParams,
   };
 

package/src/resources/conversation/email.ts

@@ -4,16 +4,136 @@ import { APIResource } from '../../resource';
 import * as Core from '../../core';
 
 export class Email extends APIResource {
+  generate(body: EmailGenerateParams, options?: Core.RequestOptions): Core.APIPromise<EmailGenerateResponse> {
+    return this._client.post('/v1/conversation/email/message', { body, ...options });
+  }
+
+  get(query: EmailGetParams, options?: Core.RequestOptions): Core.APIPromise<EmailGetResponse> {
+    return this._client.get('/v1/conversation/email/message', { query, ...options });
+  }
+
   start(body: EmailStartParams, options?: Core.RequestOptions): Core.APIPromise<EmailStartResponse> {
     return this._client.post('/v1/conversation/email/create', { body, ...options });
   }
 }
 
+export interface EmailGenerateResponse {
+  /**
+   * The ID of the conversation
+   */
+  conversationId: string;
+
+  /**
+   * The timestamp of the when the conversation was created in our system.
+   */
+  createdAt: string;
+
+  /**
+   * The latest message type - useful for polling
+   */
+  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+
+  /**
+   * The full list of messages. This endpoint supports markdown.
+   */
+  messages: Array<EmailGenerateResponse.Message>;
+
+  /**
+   * The timestamp of when the ticket was last updated in our system.
+   */
+  updatedAt: string;
+}
+
+export namespace EmailGenerateResponse {
+  export interface Message {
+    /**
+     * The ID of the conversation message
+     */
+    id: string;
+
+    /**
+     * The content of the message. Markdown on plain text.
+     */
+    content: string;
+
+    /**
+     * The timestamp of the message.
+     */
+    createdAt: 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 EmailGetResponse {
+  /**
+   * The ID of the conversation
+   */
+  conversationId: string;
+
+  /**
+   * The timestamp of the when the conversation was created in our system.
+   */
+  createdAt: string;
+
+  /**
+   * The latest message type - useful for polling
+   */
+  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+
+  /**
+   * The full list of messages. This endpoint supports markdown.
+   */
+  messages: Array<EmailGetResponse.Message>;
+
+  /**
+   * The timestamp of when the ticket was last updated in our system.
+   */
+  updatedAt: string;
+}
+
+export namespace EmailGetResponse {
+  export interface Message {
+    /**
+     * The ID of the conversation message
+     */
+    id: string;
+
+    /**
+     * The content of the message. Markdown on plain text.
+     */
+    content: string;
+
+    /**
+     * The timestamp of the message.
+     */
+    createdAt: 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 EmailStartResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown;
+  conversationId: string;
 
   /**
    * The timestamp of the when the conversation was created in our system.
@@ -21,11 +141,35 @@ export interface EmailStartResponse {
   createdAt: string;
 }
 
+export interface EmailGenerateParams {
+  /**
+   * The ID of the conversation
+   */
+  conversationId: string;
+
+  /**
+   * The message to be sent to the user. This endpoint supports markdown.
+   */
+  message: string;
+}
+
+export interface EmailGetParams {
+  /**
+   * The ID of the conversation you need to poll.
+   */
+  conversationId: string;
+}
+
 export interface EmailStartParams {
   /**
    * The ID of the customer. If omitted, a new customer will be created.
    */
-  customerId: unknown;
+  customerId: string;
+
+  /**
+   * The public key associated with this agent
+   */
+  publicKey: string;
 
   /**
    * The timestamp of the when the conversation was created in our system.
@@ -34,5 +178,12 @@ export interface EmailStartParams {
 }
 
 export declare namespace Email {
-  export { type EmailStartResponse as EmailStartResponse, type EmailStartParams as EmailStartParams };
+  export {
+    type EmailGenerateResponse as EmailGenerateResponse,
+    type EmailGetResponse as EmailGetResponse,
+    type EmailStartResponse as EmailStartResponse,
+    type EmailGenerateParams as EmailGenerateParams,
+    type EmailGetParams as EmailGetParams,
+    type EmailStartParams as EmailStartParams,
+  };
 }

package/src/resources/conversation/index.ts

@@ -10,4 +10,12 @@ export {
   type ChatStartParams,
 } from './chat';
 export { Conversation } from './conversation';
-export { Email, type EmailStartResponse, type EmailStartParams } from './email';
+export {
+  Email,
+  type EmailGenerateResponse,
+  type EmailGetResponse,
+  type EmailStartResponse,
+  type EmailGenerateParams,
+  type EmailGetParams,
+  type EmailStartParams,
+} from './email';

package/src/resources/customer.ts

@@ -8,6 +8,10 @@ export class Customer extends APIResource {
     return this._client.post('/v1/customer', { body, ...options });
   }
 
+  get(id: string, options?: Core.RequestOptions): Core.APIPromise<CustomerGetResponse> {
+    return this._client.get(`/v1/customer/${id}`, options);
+  }
+
   token(body: CustomerTokenParams, options?: Core.RequestOptions): Core.APIPromise<string> {
     return this._client.post('/v1/customer/token', {
       body,
@@ -46,7 +50,44 @@ export interface CustomerCreateResponse {
   /**
    * The id of the customer in the subscriber system
    */
-  remoteId: unknown;
+  remoteId: string;
+
+  /**
+   * The display name of the customer
+   */
+  displayName?: string;
+}
+
+export interface CustomerGetResponse {
+  /**
+   * The id of the customer in the subscriber system
+   */
+  id: unknown;
+
+  /**
+   * The timestamp of the when the customer was created in our system
+   */
+  createdAt: string;
+
+  /**
+   * The email of the customer
+   */
+  email: string;
+
+  /**
+   * The first name of the customer
+   */
+  firstName: string;
+
+  /**
+   * The last name of the customer
+   */
+  lastName: string;
+
+  /**
+   * The id of the customer in the subscriber system
+   */
+  remoteId: string;
 
   /**
    * The display name of the customer
@@ -75,7 +116,7 @@ export interface CustomerCreateParams {
   /**
    * The id of the customer in the subscriber system
    */
-  remoteId: unknown;
+  remoteId: string;
 
   /**
    * The display name of the customer
@@ -108,6 +149,7 @@ export interface CustomerTokenParams {
 export declare namespace Customer {
   export {
     type CustomerCreateResponse as CustomerCreateResponse,
+    type CustomerGetResponse as CustomerGetResponse,
     type CustomerTokenResponse as CustomerTokenResponse,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerTokenParams as CustomerTokenParams,

package/src/resources/index.ts

@@ -4,8 +4,10 @@ export { Conversation } from './conversation/conversation';
 export {
   Customer,
   type CustomerCreateResponse,
+  type CustomerGetResponse,
   type CustomerTokenResponse,
   type CustomerCreateParams,
   type CustomerTokenParams,
 } from './customer';
 export { Ingest, type IngestTestParams } from './ingest';
+export { Workflow } from './workflow';