@lorikeetai/node-sdk 2.2.0 → 2.3.0

package/src/client.ts

@@ -12,6 +12,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
@@ -206,6 +207,18 @@ export class Lorikeet {
     this.fetch = options.fetch ?? Shims.getDefaultFetch();
     this.#encoder = Opts.FallbackEncoder;
 
+    const customHeadersEnv = readEnv('LORIKEET_CUSTOM_HEADERS');
+    if (customHeadersEnv) {
+      const parsed: Record<string, string> = {};
+      for (const line of customHeadersEnv.split('\n')) {
+        const colon = line.indexOf(':');
+        if (colon >= 0) {
+          parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
+        }
+      }
+      options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
+    }
+
     this._options = options;
 
     this.clientID = clientID;
@@ -259,21 +272,8 @@ export class Lorikeet {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.LorikeetError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -305,12 +305,13 @@ export class Lorikeet {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -626,9 +627,9 @@ export class Lorikeet {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -760,7 +761,7 @@ export class Lorikeet {
     ) {
       return {
         bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
-        body: this.stringifyQuery(body as Record<string, unknown>),
+        body: this.stringifyQuery(body),
       };
     } else {
       return this.#encoder({ body, headers });
@@ -787,7 +788,13 @@ export class Lorikeet {
   static toFile = Uploads.toFile;
 
   conversation: API.Conversation = new API.Conversation(this);
+  /**
+   * Endpoints related to customer data
+   */
   customer: API.Customer = new API.Customer(this);
+  /**
+   * Endpoints for ingesting subscriber data
+   */
   ingest: API.Ingest = new API.Ingest(this);
   apiKeys: API.APIKeys = new API.APIKeys(this);
 }

package/src/internal/utils/env.ts

@@ -9,10 +9,10 @@
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    return (globalThis as any).process.env?.[env]?.trim() || undefined;
   }
   if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
+    return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
   }
   return undefined;
 };

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { LorikeetError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new LorikeetError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/conversation/chat.ts

@@ -8,6 +8,9 @@ import { pollUntil } from '../../lib/poll-until';
 import { DeferredAsyncIterable } from '../../lib/promise';
 import { EventSource } from 'eventsource';
 
+/**
+ * Endpoints for managing conversations
+ */
 export class Chat extends APIResource {
   /**
    * @example
@@ -191,7 +194,19 @@ export interface ChatGenerateResponse {
   /**
    * The status of the conversation
    */
-  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+  status:
+    | 'Unprocessed'
+    | 'Processing'
+    | 'Unhandled'
+    | 'Triaged'
+    | 'DraftResponse'
+    | 'Responded'
+    | 'Error'
+    | 'Escalated'
+    | 'EscalatedFailed'
+    | 'Processed'
+    | 'Ignored'
+    | 'Tagged';
 
   /**
    * The tags of the conversation
@@ -239,7 +254,19 @@ export interface ChatGetResponse {
   /**
    * The status of the conversation
    */
-  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+  status:
+    | 'Unprocessed'
+    | 'Processing'
+    | 'Unhandled'
+    | 'Triaged'
+    | 'DraftResponse'
+    | 'Responded'
+    | 'Error'
+    | 'Escalated'
+    | 'EscalatedFailed'
+    | 'Processed'
+    | 'Ignored'
+    | 'Tagged';
 
   /**
    * The tags of the conversation
@@ -277,7 +304,19 @@ export interface ChatStartResponse {
   /**
    * The status of the conversation
    */
-  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+  status:
+    | 'Unprocessed'
+    | 'Processing'
+    | 'Unhandled'
+    | 'Triaged'
+    | 'DraftResponse'
+    | 'Responded'
+    | 'Error'
+    | 'Escalated'
+    | 'EscalatedFailed'
+    | 'Processed'
+    | 'Ignored'
+    | 'Tagged';
 
   /**
    * The tags of the conversation

package/src/resources/conversation/conversation.ts

@@ -22,7 +22,7 @@ import {
   EmailStartResponse,
 } from './email';
 import * as VoiceAPI from './voice';
-import { Voice, VoiceOutboundParams } from './voice';
+import { Voice, VoiceOutboundParams, VoiceOutboundResponse } from './voice';
 
 export class Conversation extends APIResource {
   email: EmailAPI.Email = new EmailAPI.Email(this._client);
@@ -140,5 +140,9 @@ export declare namespace Conversation {
     type ChatStartParams as ChatStartParams,
   };
 
-  export { Voice as Voice, type VoiceOutboundParams as VoiceOutboundParams };
+  export {
+    Voice as Voice,
+    type VoiceOutboundResponse as VoiceOutboundResponse,
+    type VoiceOutboundParams as VoiceOutboundParams,
+  };
 }

package/src/resources/conversation/email.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { pollUntil } from '../../lib/poll-until';
 
+/**
+ * Endpoints for managing conversations
+ */
 export class Email extends APIResource {
   /**
    * @example
@@ -118,7 +121,19 @@ export interface EmailGenerateResponse {
   /**
    * The status of the conversation
    */
-  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+  status:
+    | 'Unprocessed'
+    | 'Processing'
+    | 'Unhandled'
+    | 'Triaged'
+    | 'DraftResponse'
+    | 'Responded'
+    | 'Error'
+    | 'Escalated'
+    | 'EscalatedFailed'
+    | 'Processed'
+    | 'Ignored'
+    | 'Tagged';
 
   /**
    * The tags of the conversation
@@ -166,7 +181,19 @@ export interface EmailGetResponse {
   /**
    * The status of the conversation
    */
-  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+  status:
+    | 'Unprocessed'
+    | 'Processing'
+    | 'Unhandled'
+    | 'Triaged'
+    | 'DraftResponse'
+    | 'Responded'
+    | 'Error'
+    | 'Escalated'
+    | 'EscalatedFailed'
+    | 'Processed'
+    | 'Ignored'
+    | 'Tagged';
 
   /**
    * The tags of the conversation
@@ -204,7 +231,19 @@ export interface EmailStartResponse {
   /**
    * The status of the conversation
    */
-  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+  status:
+    | 'Unprocessed'
+    | 'Processing'
+    | 'Unhandled'
+    | 'Triaged'
+    | 'DraftResponse'
+    | 'Responded'
+    | 'Error'
+    | 'Escalated'
+    | 'EscalatedFailed'
+    | 'Processed'
+    | 'Ignored'
+    | 'Tagged';
 
   /**
    * The tags of the conversation

package/src/resources/conversation/index.ts

@@ -24,4 +24,4 @@ export {
   type EmailGetParams,
   type EmailStartParams,
 } from './email';
-export { Voice, type VoiceOutboundParams } from './voice';
+export { Voice, type VoiceOutboundResponse, type VoiceOutboundParams } from './voice';

package/src/resources/conversation/voice.ts

@@ -2,27 +2,32 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Endpoints for managing conversations
+ */
 export class Voice extends APIResource {
   /**
    * @example
    * ```ts
-   * await client.conversation.voice.outbound({
+   * const response = await client.conversation.voice.outbound({
    *   phoneNumber: '+61400000000',
    * });
    * ```
    */
-  outbound(body: VoiceOutboundParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/v1/conversation/voice/outbound', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  outbound(body: VoiceOutboundParams, options?: RequestOptions): APIPromise<VoiceOutboundResponse> {
+    return this._client.post('/v1/conversation/voice/outbound', { body, ...options });
   }
 }
 
+export interface VoiceOutboundResponse {
+  /**
+   * The ID of the conversation that was created
+   */
+  conversationId: string;
+}
+
 export interface VoiceOutboundParams {
   /**
    * The phone number to call in E.164 format. If a customer ID is not provided, the
@@ -31,11 +36,22 @@ export interface VoiceOutboundParams {
    */
   phoneNumber: string;
 
+  /**
+   * The ID of the agent to use for the call. Cannot be combined with workflowId.
+   */
+  agentId?: string;
+
   /**
    * The ID of the brand to make the call from
    */
   brandId?: string;
 
+  /**
+   * The ID of the channel config to use for the call. If not provided, the first
+   * active voice channel config will be used.
+   */
+  channelConfigId?: string;
+
   /**
    * The ID of the customer to call. If not provided, the customer will be looked up
    * by phone number. If no customer is found, a new customer will be created.
@@ -50,11 +66,14 @@ export interface VoiceOutboundParams {
   inputData?: unknown;
 
   /**
-   * The ID of the workflow to use for the call
+   * The ID of the workflow to use for the call. Cannot be combined with agentId.
    */
   workflowId?: string;
 }
 
 export declare namespace Voice {
-  export { type VoiceOutboundParams as VoiceOutboundParams };
+  export {
+    type VoiceOutboundResponse as VoiceOutboundResponse,
+    type VoiceOutboundParams as VoiceOutboundParams,
+  };
 }

package/src/resources/customer/customer.ts

@@ -9,6 +9,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to customer data
+ */
 export class Customer extends APIResource {
   remote: RemoteAPI.Remote = new RemoteAPI.Remote(this._client);
   profile: ProfileAPI.Profile = new ProfileAPI.Profile(this._client);
@@ -346,6 +349,11 @@ export interface CustomerUpdateParams {
 }
 
 export interface CustomerGetParams {
+  /**
+   * The email address of the customer
+   */
+  email?: string;
+
   /**
    * The phone number of the customer
    */
@@ -355,6 +363,11 @@ export interface CustomerGetParams {
    * The remote id of the customer in your system
    */
   remoteId?: string;
+
+  /**
+   * The id of the customer in your own primary database or a unique identifier
+   */
+  subscriberCustomerId?: string;
 }
 
 export interface CustomerTokenParams {

package/src/resources/customer/profile.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to customer data
+ */
 export class Profile extends APIResource {
   /**
    * @example

package/src/resources/customer/remote.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints related to customer data
+ */
 export class Remote extends APIResource {
   /**
    * @example
@@ -188,7 +191,7 @@ export interface RemoteUpdateParams {
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
    */
-  body_remoteId?: string;
+  remoteId?: string;
 
   /**
    * The id of the customer in your own primary database or a unique identifier, for

package/src/resources/ingest.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Endpoints for ingesting subscriber data
+ */
 export class Ingest extends APIResource {
   submit(workflowID: string, params: IngestSubmitParams, options?: RequestOptions): APIPromise<void> {
     const { toolId, ticketId, inputHash } = params;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.2.0'; // x-release-please-version
+export const VERSION = '2.3.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.2.0";
+export declare const VERSION = "2.3.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.2.0";
+export declare const VERSION = "2.3.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 = '2.2.0'; // x-release-please-version
+exports.VERSION = '2.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.2.0'; // x-release-please-version
+export const VERSION = '2.3.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map