@lorikeetai/node-sdk 0.3.1 → 0.5.0

package/src/index.ts

@@ -9,10 +9,12 @@ 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';
 
@@ -146,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 {
@@ -200,6 +203,7 @@ export class Lorikeet extends Core.APIClient {
 
 Lorikeet.Conversation = Conversation;
 Lorikeet.Customer = Customer;
+Lorikeet.Workflow = Workflow;
 Lorikeet.Ingest = Ingest;
 export declare namespace Lorikeet {
   export type RequestOptions = Core.RequestOptions;
@@ -209,15 +213,18 @@ 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 { toFile, fileFromPath } from './uploads';
 export {
   LorikeetError,
   APIError,
@@ -232,7 +239,7 @@ export {
   InternalServerError,
   PermissionDeniedError,
   UnprocessableEntityError,
-} from "./error";
+} from './error';
 
 export { generateSignature } from "./lib/generate-signature";
 

package/src/lib/poll-until.ts

@@ -1,10 +1,12 @@
 interface PollUntilOptions<TData> {
-  /** The maximum time to wait for the condition to be met. */
+  /**
+   * The maximum time to wait for the condition to be met (ms).
+   */
   timeout?: number;
-
-  /** The interval between each poll. */
+  /**
+   * The interval between each poll (ms).
+   */
   interval?: number;
-
   /**
    *
    * @param result The result of the polling function.
@@ -16,10 +18,14 @@ interface PollUntilOptions<TData> {
 /** Utility function to poll an endpoint. */
 export const pollUntil = async <T>(
   fn: () => Promise<T>,
-  { condition = (result) => !!result, interval = 100, timeout = 5000 }: PollUntilOptions<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)) {

package/src/resources/conversation/chat.ts

@@ -5,24 +5,71 @@ 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> {
-    const start = new Date().toISOString();
     return pollUntil<ChatGetResponse>(
       () => this._client.get('/v1/conversation/chat/message', { query, ...options }),
       {
-        condition: (conversation) => conversation.createdAt > start,
+        timeout: 180_000,
+        interval: 5_000,
+        condition: (conversation) => conversation.latestMessageType === 'BOT_RESPONSE',
       },
     ) as Core.APIPromise<ChatGetResponse>;
   }
@@ -32,17 +79,22 @@ export interface ChatGenerateResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown;
+  conversationId: string;
 
   /**
-   * The timestamp of when the last 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
+   */
+  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+
+  /**
+   * The full list of messages. This endpoint supports markdown.
    */
-  message: ChatGenerateResponse.Message;
+  messages: Array<ChatGenerateResponse.Message>;
 
   /**
    * The timestamp of when the ticket was last updated in our system.
@@ -51,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
@@ -65,6 +114,11 @@ export namespace ChatGenerateResponse {
      */
     content: string;
 
+    /**
+     * The timestamp of the message.
+     */
+    createdAt: string;
+
     /**
      * The raw content of the message. Usually HTML.
      */
@@ -81,17 +135,22 @@ export interface ChatGetResponse {
   /**
    * The ID of the conversation
    */
-  conversationId: unknown;
+  conversationId: string;
 
   /**
-   * The timestamp of when the last 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.
@@ -100,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
@@ -114,6 +170,11 @@ export namespace ChatGetResponse {
      */
     content: string;
 
+    /**
+     * The timestamp of the message.
+     */
+    createdAt: string;
+
     /**
      * The raw content of the message. Usually HTML.
      */
@@ -130,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.
@@ -142,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.
@@ -161,7 +222,7 @@ 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

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,30 @@ 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
@@ -39,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,
@@ -43,10 +47,61 @@ export interface CustomerCreateResponse {
    */
   lastName: string;
 
+  /**
+   * The id of the customer in the ticketing system. For the SDK this needs to be
+   * stable and unique
+   */
+  remoteId: string;
+
+  /**
+   * The id of the customer in your own primary database or a unique identifier, for
+   * example a cookie
+   */
+  subscriberCustomerId: string;
+
+  /**
+   * The display name of the customer
+   */
+  displayName?: string;
+}
+
+export interface CustomerGetResponse {
   /**
    * The id of the customer in the subscriber system
    */
-  remoteId: unknown;
+  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 ticketing system. For the SDK this needs to be
+   * stable and unique
+   */
+  remoteId: string;
+
+  /**
+   * The id of the customer in your own primary database or a unique identifier, for
+   * example a cookie
+   */
+  subscriberCustomerId: string;
 
   /**
    * The display name of the customer
@@ -73,9 +128,16 @@ export interface CustomerCreateParams {
   lastName: string;
 
   /**
-   * The id of the customer in the subscriber system
+   * The id of the customer in the ticketing system. For the SDK this needs to be
+   * stable and unique
    */
-  remoteId: unknown;
+  remoteId: string;
+
+  /**
+   * The id of the customer in your own primary database or a unique identifier, for
+   * example a cookie
+   */
+  subscriberCustomerId: string;
 
   /**
    * The display name of the customer
@@ -85,29 +147,42 @@ export interface CustomerCreateParams {
 
 export interface CustomerTokenParams {
   /**
-   * The email of the user.
+   * The email of the customer
    */
   email: string;
 
   /**
-   * The first name of the user.
+   * The first name of the customer
    */
   firstName: string;
 
   /**
-   * The last name of the user.
+   * The last name of the customer
    */
   lastName: string;
 
   /**
-   * The unique identifier of the user in your ticketing system.
+   * The id of the customer in the ticketing system. For the SDK this needs to be
+   * stable and unique
    */
   remoteId: string;
+
+  /**
+   * The id of the customer in your own primary database or a unique identifier, for
+   * example a cookie
+   */
+  subscriberCustomerId: string;
+
+  /**
+   * The display name of the customer
+   */
+  displayName?: string;
 }
 
 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';

package/src/resources/workflow.ts

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class Workflow extends APIResource {
+  update(options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/v1/workflow', { ...options, headers: { Accept: '*/*', ...options?.headers } });
+  }
+
+  get(id: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.get(`/v1/workflow/${id}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.1'; // x-release-please-version
+export const VERSION = '0.5.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.1";
+export declare const VERSION = "0.5.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.3.1'; // x-release-please-version
+exports.VERSION = '0.5.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map