@lorikeetai/node-sdk 0.13.2 → 0.14.0

package/src/resources/conversation/conversation.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
 import * as ChatAPI from './chat';
 import {
   Chat,
@@ -25,12 +26,186 @@ import {
 export class Conversation extends APIResource {
   email: EmailAPI.Email = new EmailAPI.Email(this._client);
   chat: ChatAPI.Chat = new ChatAPI.Chat(this._client);
+
+  /**
+   * @example
+   * ```ts
+   * const conversation = await client.conversation.create({
+   *   customerId: '1234567890',
+   *   phoneNumber: '0412745903',
+   *   'x-lorikeet-voice-public-key':
+   *     'x-lorikeet-voice-public-key',
+   * });
+   * ```
+   */
+  create(
+    params: ConversationCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ConversationCreateResponse> {
+    const { 'x-lorikeet-voice-public-key': xLorikeetVoicePublicKey, ...body } = params;
+    return this._client.post('/v1/conversation/new', {
+      body,
+      ...options,
+      headers: { 'x-lorikeet-voice-public-key': xLorikeetVoicePublicKey, ...options?.headers },
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * const response =
+   *   await client.conversation.retrieveTranscript('ticketId', {
+   *     'x-lorikeet-voice-public-key':
+   *       'x-lorikeet-voice-public-key',
+   *   });
+   * ```
+   */
+  retrieveTranscript(
+    ticketId: string,
+    params: ConversationRetrieveTranscriptParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ConversationRetrieveTranscriptResponse> {
+    const { 'x-lorikeet-voice-public-key': xLorikeetVoicePublicKey } = params;
+    return this._client.get(`/v1/conversation/transcript/${ticketId}`, {
+      ...options,
+      headers: { 'x-lorikeet-voice-public-key': xLorikeetVoicePublicKey, ...options?.headers },
+    });
+  }
+}
+
+export interface AttachmentDto {
+  /**
+   * The name of the attachment
+   */
+  name: string;
+
+  /**
+   * The type of the attachment
+   */
+  type: string;
+
+  /**
+   * The URL of the attachment
+   */
+  url: string;
+}
+
+export interface TicketEvent {
+  /**
+   * The ID of the event
+   */
+  id: string;
+
+  /**
+   * The timestamp of the event
+   */
+  createdAt: string;
+
+  /**
+   * Any specific data associated with the event
+   */
+  data: unknown;
+
+  /**
+   * The type of the event
+   */
+  type:
+    | 'ASSIGNED'
+    | 'CLOSED'
+    | 'ESCALATED'
+    | 'ESCALATION_REQUEST'
+    | 'PROCESSING_CANCELLED'
+    | 'HOSTILE_MESSAGE'
+    | 'NEW_TICKET'
+    | 'CALL_ENDED';
+}
+
+export interface TicketMessageDto {
+  /**
+   * The ID of the conversation message
+   */
+  id: string;
+
+  /**
+   * Attachments that were attached to the message
+   */
+  attachments: Array<AttachmentDto>;
+
+  /**
+   * 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' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
+}
+
+export interface ConversationCreateResponse {
+  /**
+   * The id of the ticket created
+   */
+  ticketId: string;
+}
+
+export interface ConversationRetrieveTranscriptResponse {
+  /**
+   * The custom attributes of the conversation
+   */
+  customAttributes: unknown;
+
+  /**
+   * The transcript of the conversation
+   */
+  transcript: string;
+}
+
+export interface ConversationCreateParams {
+  /**
+   * Body param: The id of the customer in the ticketing system
+   */
+  customerId: string;
+
+  /**
+   * Body param: The phone number of the customer
+   */
+  phoneNumber: string;
+
+  /**
+   * Header param:
+   */
+  'x-lorikeet-voice-public-key': string;
+}
+
+export interface ConversationRetrieveTranscriptParams {
+  'x-lorikeet-voice-public-key': string;
 }
 
 Conversation.Email = Email;
 Conversation.Chat = Chat;
 
 export declare namespace Conversation {
+  export {
+    type AttachmentDto as AttachmentDto,
+    type TicketEvent as TicketEvent,
+    type TicketMessageDto as TicketMessageDto,
+    type ConversationCreateResponse as ConversationCreateResponse,
+    type ConversationRetrieveTranscriptResponse as ConversationRetrieveTranscriptResponse,
+    type ConversationCreateParams as ConversationCreateParams,
+    type ConversationRetrieveTranscriptParams as ConversationRetrieveTranscriptParams,
+  };
+
   export {
     Email as Email,
     type EmailGenerateResponse as EmailGenerateResponse,

package/src/resources/conversation/email.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import { pollUntil } from "../../lib/poll-until";
+import * as ConversationAPI from './conversation';
 
 export class Email extends APIResource {
   /**
@@ -96,7 +97,7 @@ export interface EmailGenerateResponse {
    * The events that have occurred in the conversation. Can be used for deriving more
    * information about the conversation.
    */
-  events: Array<EmailGenerateResponse.Event>;
+  events: Array<ConversationAPI.TicketEvent>;
 
   /**
    * The latest message type - useful for polling
@@ -111,101 +112,24 @@ export interface EmailGenerateResponse {
   /**
    * The full list of messages. This endpoint supports markdown.
    */
-  messages: Array<EmailGenerateResponse.Message>;
+  messages: Array<ConversationAPI.TicketMessageDto>;
 
   /**
    * The status of the conversation
    */
   status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
 
+  /**
+   * The tags of the conversation
+   */
+  tags: Array<string>;
+
   /**
    * The timestamp of when the ticket was last updated in our system.
    */
   updatedAt: string;
 }
 
-export namespace EmailGenerateResponse {
-  export interface Event {
-    /**
-     * The ID of the event
-     */
-    id: string;
-
-    /**
-     * The timestamp of the event
-     */
-    createdAt: string;
-
-    /**
-     * Any specific data associated with the event
-     */
-    data: unknown;
-
-    /**
-     * The type of the event
-     */
-    type:
-      | 'ASSIGNED'
-      | 'CLOSED'
-      | 'ESCALATED'
-      | 'ESCALATION_REQUEST'
-      | 'PROCESSING_CANCELLED'
-      | 'HOSTILE_MESSAGE'
-      | 'NEW_TICKET';
-  }
-
-  export interface Message {
-    /**
-     * The ID of the conversation message
-     */
-    id: string;
-
-    /**
-     * Attachments that were attached to the message
-     */
-    attachments: Array<Message.Attachment>;
-
-    /**
-     * 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' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
-  }
-
-  export namespace Message {
-    export interface Attachment {
-      /**
-       * The name of the attachment
-       */
-      name: string;
-
-      /**
-       * The type of the attachment
-       */
-      type: string;
-
-      /**
-       * The URL of the attachment
-       */
-      url: string;
-    }
-  }
-}
-
 export interface EmailGetResponse {
   /**
    * The ID of the conversation
@@ -221,7 +145,7 @@ export interface EmailGetResponse {
    * The events that have occurred in the conversation. Can be used for deriving more
    * information about the conversation.
    */
-  events: Array<EmailGetResponse.Event>;
+  events: Array<ConversationAPI.TicketEvent>;
 
   /**
    * The latest message type - useful for polling
@@ -236,101 +160,24 @@ export interface EmailGetResponse {
   /**
    * The full list of messages. This endpoint supports markdown.
    */
-  messages: Array<EmailGetResponse.Message>;
+  messages: Array<ConversationAPI.TicketMessageDto>;
 
   /**
    * The status of the conversation
    */
   status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
 
+  /**
+   * The tags of the conversation
+   */
+  tags: Array<string>;
+
   /**
    * The timestamp of when the ticket was last updated in our system.
    */
   updatedAt: string;
 }
 
-export namespace EmailGetResponse {
-  export interface Event {
-    /**
-     * The ID of the event
-     */
-    id: string;
-
-    /**
-     * The timestamp of the event
-     */
-    createdAt: string;
-
-    /**
-     * Any specific data associated with the event
-     */
-    data: unknown;
-
-    /**
-     * The type of the event
-     */
-    type:
-      | 'ASSIGNED'
-      | 'CLOSED'
-      | 'ESCALATED'
-      | 'ESCALATION_REQUEST'
-      | 'PROCESSING_CANCELLED'
-      | 'HOSTILE_MESSAGE'
-      | 'NEW_TICKET';
-  }
-
-  export interface Message {
-    /**
-     * The ID of the conversation message
-     */
-    id: string;
-
-    /**
-     * Attachments that were attached to the message
-     */
-    attachments: Array<Message.Attachment>;
-
-    /**
-     * 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' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
-  }
-
-  export namespace Message {
-    export interface Attachment {
-      /**
-       * The name of the attachment
-       */
-      name: string;
-
-      /**
-       * The type of the attachment
-       */
-      type: string;
-
-      /**
-       * The URL of the attachment
-       */
-      url: string;
-    }
-  }
-}
-
 export interface EmailStartResponse {
   /**
    * The ID of the conversation
@@ -346,7 +193,7 @@ export interface EmailStartResponse {
    * The events that have occurred in the conversation. Can be used for deriving more
    * information about the conversation.
    */
-  events: Array<EmailStartResponse.Event>;
+  events: Array<ConversationAPI.TicketEvent>;
 
   /**
    * The url of the conversation in the Lorikeet dashboard
@@ -357,44 +204,18 @@ export interface EmailStartResponse {
    * The status of the conversation
    */
   status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
-}
-
-export namespace EmailStartResponse {
-  export interface Event {
-    /**
-     * The ID of the event
-     */
-    id: string;
-
-    /**
-     * The timestamp of the event
-     */
-    createdAt: string;
 
-    /**
-     * Any specific data associated with the event
-     */
-    data: unknown;
-
-    /**
-     * The type of the event
-     */
-    type:
-      | 'ASSIGNED'
-      | 'CLOSED'
-      | 'ESCALATED'
-      | 'ESCALATION_REQUEST'
-      | 'PROCESSING_CANCELLED'
-      | 'HOSTILE_MESSAGE'
-      | 'NEW_TICKET';
-  }
+  /**
+   * The tags of the conversation
+   */
+  tags: Array<string>;
 }
 
 export interface EmailGenerateParams {
   /**
    * Attachments to be sent with the message
    */
-  attachments: Array<EmailGenerateParams.Attachment>;
+  attachments: Array<ConversationAPI.AttachmentDto>;
 
   /**
    * The ID of the conversation
@@ -414,23 +235,6 @@ export interface EmailGenerateParams {
 }
 
 export namespace EmailGenerateParams {
-  export interface Attachment {
-    /**
-     * The name of the attachment
-     */
-    name: string;
-
-    /**
-     * The type of the attachment
-     */
-    type: string;
-
-    /**
-     * The URL of the attachment
-     */
-    url: string;
-  }
-
   /**
    * Any additional customer information, that has changed in the course of the
    * conversation.

package/src/resources/conversation/index.ts

@@ -9,7 +9,16 @@ export {
   type ChatGetParams,
   type ChatStartParams,
 } from './chat';
-export { Conversation } from './conversation';
+export {
+  Conversation,
+  type AttachmentDto,
+  type TicketEvent,
+  type TicketMessageDto,
+  type ConversationCreateResponse,
+  type ConversationRetrieveTranscriptResponse,
+  type ConversationCreateParams,
+  type ConversationRetrieveTranscriptParams,
+} from './conversation';
 export {
   Email,
   type EmailGenerateResponse,