@lorikeetai/node-sdk 1.3.0 → 1.8.1

package/resources/ingest.js

@@ -4,9 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Ingest = void 0;
 const resource_1 = require("../resource.js");
 class Ingest extends resource_1.APIResource {
-    retrieve(options) {
-        return this._client.get('/v1/ingest', { ...options, headers: { Accept: '*/*', ...options?.headers } });
-    }
     submit(toolId, ticketId, inputHash, workflowId, options) {
         return this._client.post(`/ingest/${toolId}/${ticketId}/${inputHash}/${workflowId}`, {
             ...options,

package/resources/ingest.js.map

@@ -1 +1 @@
-{"version":3,"file":"ingest.js","sourceRoot":"","sources":["../src/resources/ingest.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,MAAO,SAAQ,sBAAW;IACrC,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,MAAM,CACJ,MAAc,EACd,QAAgB,EAChB,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,MAAM,IAAI,QAAQ,IAAI,SAAS,IAAI,UAAU,EAAE,EAAE;YACnF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAe,EAAE,IAAsB,EAAE,OAA6B;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAhCD,wBAgCC"}
+{"version":3,"file":"ingest.js","sourceRoot":"","sources":["../src/resources/ingest.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,MAAO,SAAQ,sBAAW;IACrC,MAAM,CACJ,MAAc,EACd,QAAgB,EAChB,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,MAAM,IAAI,QAAQ,IAAI,SAAS,IAAI,UAAU,EAAE,EAAE;YACnF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAe,EAAE,IAAsB,EAAE,OAA6B;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,wBA4BC"}

package/resources/ingest.mjs

@@ -1,9 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../resource.mjs";
 export class Ingest extends APIResource {
-    retrieve(options) {
-        return this._client.get('/v1/ingest', { ...options, headers: { Accept: '*/*', ...options?.headers } });
-    }
     submit(toolId, ticketId, inputHash, workflowId, options) {
         return this._client.post(`/ingest/${toolId}/${ticketId}/${inputHash}/${workflowId}`, {
             ...options,

package/resources/ingest.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ingest.mjs","sourceRoot":"","sources":["../src/resources/ingest.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,MAAM,CACJ,MAAc,EACd,QAAgB,EAChB,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,MAAM,IAAI,QAAQ,IAAI,SAAS,IAAI,UAAU,EAAE,EAAE;YACnF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAe,EAAE,IAAsB,EAAE,OAA6B;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"ingest.mjs","sourceRoot":"","sources":["../src/resources/ingest.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC,MAAM,CACJ,MAAc,EACd,QAAgB,EAChB,SAAiB,EACjB,UAAkB,EAClB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,MAAM,IAAI,QAAQ,IAAI,SAAS,IAAI,UAAU,EAAE,EAAE;YACnF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAe,EAAE,IAAsB,EAAE,OAA6B;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE;YACjD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}

package/src/core.ts

@@ -70,6 +70,12 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   const mediaType = contentType?.split(';')[0]?.trim();
   const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
   if (isJSON) {
+    const contentLength = response.headers.get('content-length');
+    if (contentLength === '0') {
+      // if there is no content we can't do anything
+      return undefined as T;
+    }
+
     const json = await response.json();
 
     debug('response', response.status, response.url, response.headers, json);
@@ -735,9 +741,9 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
  *    }
  */
 export class PagePromise<
-    PageClass extends AbstractPage<Item>,
-    Item = ReturnType<PageClass['getPaginatedItems']>[number],
-  >
+  PageClass extends AbstractPage<Item>,
+  Item = ReturnType<PageClass['getPaginatedItems']>[number],
+>
   extends APIPromise<PageClass>
   implements AsyncIterable<Item>
 {

package/src/index.ts

@@ -5,18 +5,17 @@ import * as Core from './core';
 import * as Errors from './error';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
-import { File } from './resources/file';
+import {
+  APIKeyCreateParams,
+  APIKeyCreateResponse,
+  APIKeyGetResponse,
+  APIKeyListResponse,
+  APIKeys,
+} from './resources/api-keys';
 import { Ingest, IngestTestParams } from './resources/ingest';
-import { Suggestion } from './resources/suggestion';
-import { Webhooks } from './resources/webhooks';
-import { Workflow } from './resources/workflow';
 import {
   AttachmentDto,
   Conversation,
-  ConversationCreateParams,
-  ConversationCreateResponse,
-  ConversationRetrieveTranscriptParams,
-  ConversationRetrieveTranscriptResponse,
   TicketEvent,
   TicketMessageDto,
 } from './resources/conversation/conversation';
@@ -25,13 +24,13 @@ import {
   Customer,
   CustomerCreateParams,
   CustomerCreateResponse,
+  CustomerGetParams,
   CustomerGetResponse,
   CustomerTokenParams,
   CustomerTokenResponse,
   CustomerUpdateParams,
   CustomerUpdateResponse,
 } from './resources/customer/customer';
-import { OAuth, OAuthAuthorizeParams, OAuthCallbackParams } from './resources/oauth/oauth';
 
 export interface ClientOptions {
   /**
@@ -166,12 +165,8 @@ 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);
-  file: API.File = new API.File(this);
-  suggestion: API.Suggestion = new API.Suggestion(this);
-  oauth: API.OAuth = new API.OAuth(this);
-  webhooks: API.Webhooks = new API.Webhooks(this);
+  apiKeys: API.APIKeys = new API.APIKeys(this);
 
   /**
    * Check whether the base URL is set to its default.
@@ -180,10 +175,6 @@ export class Lorikeet extends Core.APIClient {
     return this.baseURL !== 'https://api.lorikeetcx.ai';
   }
 
-  retrieve(options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this.get('/', { ...options, headers: { Accept: '*/*', ...options?.headers } });
-  }
-
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
   }
@@ -243,12 +234,8 @@ export class Lorikeet extends Core.APIClient {
 
 Lorikeet.Conversation = Conversation;
 Lorikeet.Customer = Customer;
-Lorikeet.Workflow = Workflow;
 Lorikeet.Ingest = Ingest;
-Lorikeet.File = File;
-Lorikeet.Suggestion = Suggestion;
-Lorikeet.OAuth = OAuth;
-Lorikeet.Webhooks = Webhooks;
+Lorikeet.APIKeys = APIKeys;
 
 export declare namespace Lorikeet {
   export type RequestOptions = Core.RequestOptions;
@@ -258,10 +245,6 @@ export declare namespace Lorikeet {
     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 {
@@ -272,24 +255,19 @@ export declare namespace Lorikeet {
     type CustomerTokenResponse as CustomerTokenResponse,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
+    type CustomerGetParams as CustomerGetParams,
     type CustomerTokenParams as CustomerTokenParams,
   };
 
-  export { Workflow as Workflow };
-
   export { Ingest as Ingest, type IngestTestParams as IngestTestParams };
 
-  export { File as File };
-
-  export { Suggestion as Suggestion };
-
   export {
-    OAuth as OAuth,
-    type OAuthAuthorizeParams as OAuthAuthorizeParams,
-    type OAuthCallbackParams as OAuthCallbackParams,
+    APIKeys as APIKeys,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyGetResponse as APIKeyGetResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
   };
-
-  export { Webhooks as Webhooks };
 }
 
 export { toFile, fileFromPath } from './uploads';

package/src/resources/api-keys.ts

@@ -0,0 +1,168 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class APIKeys extends APIResource {
+  /**
+   * Generate a new API key pair (clientId + clientSecret) for the authenticated
+   * subscriber. The clientSecret is only returned once on creation.
+   *
+   * @example
+   * ```ts
+   * const apiKey = await client.apiKeys.create();
+   * ```
+   */
+  create(body: APIKeyCreateParams, options?: Core.RequestOptions): Core.APIPromise<APIKeyCreateResponse> {
+    return this._client.post('/v1/api-keys', { body, ...options });
+  }
+
+  /**
+   * List all API keys for the authenticated subscriber. Secrets are masked.
+   *
+   * @example
+   * ```ts
+   * const apiKeys = await client.apiKeys.list();
+   * ```
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<APIKeyListResponse> {
+    return this._client.get('/v1/api-keys', options);
+  }
+
+  /**
+   * Permanently delete an API key. This action cannot be undone.
+   *
+   * @example
+   * ```ts
+   * await client.apiKeys.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/api-keys/${id}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Get details of a specific API key. Secret is masked.
+   *
+   * @example
+   * ```ts
+   * const apiKey = await client.apiKeys.get(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  get(id: string, options?: Core.RequestOptions): Core.APIPromise<APIKeyGetResponse> {
+    return this._client.get(`/v1/api-keys/${id}`, options);
+  }
+}
+
+export interface APIKeyCreateResponse {
+  /**
+   * Unique identifier for the API key
+   */
+  id: string;
+
+  /**
+   * Public client ID used in API requests
+   */
+  clientId: string;
+
+  /**
+   * Secret key for signing requests. Only returned on creation - store securely.
+   */
+  clientSecret: string;
+
+  /**
+   * Timestamp when the API key was created
+   */
+  createdAt: string;
+
+  /**
+   * Environment label for the API key
+   */
+  env: string;
+}
+
+export interface APIKeyListResponse {
+  /**
+   * List of API keys
+   */
+  keys: Array<APIKeyListResponse.Key>;
+}
+
+export namespace APIKeyListResponse {
+  export interface Key {
+    /**
+     * Unique identifier for the API key
+     */
+    id: string;
+
+    /**
+     * Public client ID used in API requests
+     */
+    clientId: string;
+
+    /**
+     * Masked preview of the secret key
+     */
+    clientSecretPreview: string;
+
+    /**
+     * Timestamp when the API key was created
+     */
+    createdAt: string;
+
+    /**
+     * Environment label for the API key
+     */
+    env: string;
+  }
+}
+
+export interface APIKeyGetResponse {
+  /**
+   * Unique identifier for the API key
+   */
+  id: string;
+
+  /**
+   * Public client ID used in API requests
+   */
+  clientId: string;
+
+  /**
+   * Masked preview of the secret key
+   */
+  clientSecretPreview: string;
+
+  /**
+   * Timestamp when the API key was created
+   */
+  createdAt: string;
+
+  /**
+   * Environment label for the API key
+   */
+  env: string;
+}
+
+export interface APIKeyCreateParams {
+  /**
+   * Environment label for the API key (e.g., "api", "production", "staging")
+   */
+  env?: string;
+}
+
+export declare namespace APIKeys {
+  export {
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyGetResponse as APIKeyGetResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+  };
+}

package/src/resources/conversation/chat.ts

@@ -380,6 +380,11 @@ export interface ChatGenerateParams {
    * be omitted if the message is sent by the agent to the customer.
    */
   customer?: ChatGenerateParams.Customer;
+
+  /**
+   * The variables to be passed to the conversation - this can be used by workflows
+   */
+  variables?: { [key: string]: unknown };
 }
 
 export namespace ChatGenerateParams {
@@ -414,6 +419,11 @@ export namespace ChatGenerateParams {
      */
     lastName?: string;
 
+    /**
+     * The phone number of the customer (in international / E.164 format)
+     */
+    phoneNumber?: string;
+
     /**
      * The id of the customer in the ticketing system. For the SDK this needs to be
      * stable and unique
@@ -453,9 +463,14 @@ export interface ChatStartParams {
   publicKey: string;
 
   /**
-   * The timestamp of the when the conversation was created in our system.
+   * The subject of the conversation.
    */
   subject?: string;
+
+  /**
+   * The UUID of the workflow to trigger.
+   */
+  workflowId?: string;
 }
 
 export interface ChatStreamParams {

package/src/resources/conversation/conversation.ts

@@ -1,7 +1,6 @@
 // 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,
@@ -29,51 +28,6 @@ export class Conversation extends APIResource {
   email: EmailAPI.Email = new EmailAPI.Email(this._client);
   chat: ChatAPI.Chat = new ChatAPI.Chat(this._client);
   voice: VoiceAPI.Voice = new VoiceAPI.Voice(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 {
@@ -155,46 +109,6 @@ export interface TicketMessageDto {
   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;
 Conversation.Voice = Voice;
@@ -204,10 +118,6 @@ export declare namespace Conversation {
     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 {

package/src/resources/conversation/email.ts

@@ -234,6 +234,11 @@ export interface EmailGenerateParams {
    * be omitted if the message is sent by the agent to the customer.
    */
   customer?: EmailGenerateParams.Customer;
+
+  /**
+   * The variables to be passed to the conversation - this can be used by workflows
+   */
+  variables?: { [key: string]: unknown };
 }
 
 export namespace EmailGenerateParams {
@@ -268,6 +273,11 @@ export namespace EmailGenerateParams {
      */
     lastName?: string;
 
+    /**
+     * The phone number of the customer (in international / E.164 format)
+     */
+    phoneNumber?: string;
+
     /**
      * The id of the customer in the ticketing system. For the SDK this needs to be
      * stable and unique
@@ -307,9 +317,14 @@ export interface EmailStartParams {
   publicKey: string;
 
   /**
-   * The timestamp of the when the conversation was created in our system.
+   * The subject of the conversation.
    */
   subject?: string;
+
+  /**
+   * The UUID of the workflow to trigger.
+   */
+  workflowId?: string;
 }
 
 export declare namespace Email {

package/src/resources/conversation/index.ts

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

package/src/resources/conversation/voice.ts

@@ -41,7 +41,9 @@ export interface VoiceOutboundParams {
   customerId?: string;
 
   /**
-   * The input data to pass to the workflow. Only used if a workflow is specified.
+   * Input data to pass to workflows. Should include values for input fields defined
+   * by both the chosen opening workflow and - if configured - the voicemail detected
+   * workflow.
    */
   inputData?: unknown;