@lorikeetai/node-sdk 0.1.0-alpha.1 → 0.1.0-alpha.10

package/src/error.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { castToError, Headers } from './core';
+import { castToError, Headers } from './core'
 
 export class LorikeetError extends Error {}
 
 export class APIError extends LorikeetError {
-  readonly status: number | undefined;
-  readonly headers: Headers | undefined;
-  readonly error: Object | undefined;
+  readonly status: number | undefined
+  readonly headers: Headers | undefined
+  readonly error: Object | undefined
 
   constructor(
     status: number | undefined,
@@ -15,10 +15,10 @@ export class APIError extends LorikeetError {
     message: string | undefined,
     headers: Headers | undefined,
   ) {
-    super(`${APIError.makeMessage(status, error, message)}`);
-    this.status = status;
-    this.headers = headers;
-    this.error = error;
+    super(`${APIError.makeMessage(status, error, message)}`)
+    this.status = status
+    this.headers = headers
+    this.error = error
   }
 
   private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
@@ -28,18 +28,18 @@ export class APIError extends LorikeetError {
           error.message
         : JSON.stringify(error.message)
       : error ? JSON.stringify(error)
-      : message;
+      : message
 
     if (status && msg) {
-      return `${status} ${msg}`;
+      return `${status} ${msg}`
     }
     if (status) {
-      return `${status} status code (no body)`;
+      return `${status} status code (no body)`
     }
     if (msg) {
-      return msg;
+      return msg
     }
-    return '(no status code or body)';
+    return '(no status code or body)'
   }
 
   static generate(
@@ -49,98 +49,98 @@ export class APIError extends LorikeetError {
     headers: Headers | undefined,
   ) {
     if (!status) {
-      return new APIConnectionError({ message, cause: castToError(errorResponse) });
+      return new APIConnectionError({ message, cause: castToError(errorResponse) })
     }
 
-    const error = errorResponse as Record<string, any>;
+    const error = errorResponse as Record<string, any>
 
     if (status === 400) {
-      return new BadRequestError(status, error, message, headers);
+      return new BadRequestError(status, error, message, headers)
     }
 
     if (status === 401) {
-      return new AuthenticationError(status, error, message, headers);
+      return new AuthenticationError(status, error, message, headers)
     }
 
     if (status === 403) {
-      return new PermissionDeniedError(status, error, message, headers);
+      return new PermissionDeniedError(status, error, message, headers)
     }
 
     if (status === 404) {
-      return new NotFoundError(status, error, message, headers);
+      return new NotFoundError(status, error, message, headers)
     }
 
     if (status === 409) {
-      return new ConflictError(status, error, message, headers);
+      return new ConflictError(status, error, message, headers)
     }
 
     if (status === 422) {
-      return new UnprocessableEntityError(status, error, message, headers);
+      return new UnprocessableEntityError(status, error, message, headers)
     }
 
     if (status === 429) {
-      return new RateLimitError(status, error, message, headers);
+      return new RateLimitError(status, error, message, headers)
     }
 
     if (status >= 500) {
-      return new InternalServerError(status, error, message, headers);
+      return new InternalServerError(status, error, message, headers)
     }
 
-    return new APIError(status, error, message, headers);
+    return new APIError(status, error, message, headers)
   }
 }
 
 export class APIUserAbortError extends APIError {
-  override readonly status: undefined = undefined;
+  override readonly status: undefined = undefined
 
   constructor({ message }: { message?: string } = {}) {
-    super(undefined, undefined, message || 'Request was aborted.', undefined);
+    super(undefined, undefined, message || 'Request was aborted.', undefined)
   }
 }
 
 export class APIConnectionError extends APIError {
-  override readonly status: undefined = undefined;
+  override readonly status: undefined = undefined
 
   constructor({ message, cause }: { message?: string | undefined; cause?: Error | undefined }) {
-    super(undefined, undefined, message || 'Connection error.', undefined);
+    super(undefined, undefined, message || 'Connection error.', undefined)
     // in some environments the 'cause' property is already declared
     // @ts-ignore
-    if (cause) this.cause = cause;
+    if (cause) this.cause = cause
   }
 }
 
 export class APIConnectionTimeoutError extends APIConnectionError {
   constructor({ message }: { message?: string } = {}) {
-    super({ message: message ?? 'Request timed out.' });
+    super({ message: message ?? 'Request timed out.' })
   }
 }
 
 export class BadRequestError extends APIError {
-  override readonly status: 400 = 400;
+  override readonly status: 400 = 400
 }
 
 export class AuthenticationError extends APIError {
-  override readonly status: 401 = 401;
+  override readonly status: 401 = 401
 }
 
 export class PermissionDeniedError extends APIError {
-  override readonly status: 403 = 403;
+  override readonly status: 403 = 403
 }
 
 export class NotFoundError extends APIError {
-  override readonly status: 404 = 404;
+  override readonly status: 404 = 404
 }
 
 export class ConflictError extends APIError {
-  override readonly status: 409 = 409;
+  override readonly status: 409 = 409
 }
 
 export class UnprocessableEntityError extends APIError {
-  override readonly status: 422 = 422;
+  override readonly status: 422 = 422
 }
 
 export class RateLimitError extends APIError {
-  override readonly status: 429 = 429;
+  override readonly status: 429 = 429
 }
 
 export class InternalServerError extends APIError {}

package/src/index.ts

@@ -1,28 +1,29 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Errors from './error';
-import * as Uploads from './uploads';
-import { type Agent } from './_shims/index';
-import * as Core from './core';
-import * as API from './resources/index';
+import * as Errors from './error'
+import * as Uploads from './uploads'
+import { type Agent } from './_shims/index'
+import * as qs from './internal/qs'
+import * as Core from './core'
+import * as API from './resources/index'
 
 export interface ClientOptions {
   /**
-   * The client ID associated with your account.
+   * client identifier authentication associated with the account.
    */
-  bearerToken?: string | null | undefined;
+  clientId?: string | undefined
 
   /**
-   * The signature of the webhook - should be generated as a SHA256 hash of the payload and the secret key.
+   * Secret key pulled from the Lorikeet App
    */
-  apiKey?: string | null | undefined;
+  clientSecret?: string | undefined
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
    * Defaults to process.env['LORIKEET_BASE_URL'].
    */
-  baseURL?: string | null | undefined;
+  baseURL?: string | null | undefined
 
   /**
    * The maximum amount of time (in milliseconds) that the client should wait for a response
@@ -31,7 +32,7 @@ export interface ClientOptions {
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
    */
-  timeout?: number;
+  timeout?: number
 
   /**
    * An HTTP agent used to manage HTTP(S) connections.
@@ -39,7 +40,7 @@ export interface ClientOptions {
    * If not provided, an agent will be constructed by default in the Node.js environment,
    * otherwise no agent is used.
    */
-  httpAgent?: Agent;
+  httpAgent?: Agent
 
   /**
    * Specify a custom `fetch` function implementation.
@@ -47,7 +48,7 @@ export interface ClientOptions {
    * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
    * defined globally.
    */
-  fetch?: Core.Fetch | undefined;
+  fetch?: Core.Fetch | undefined
 
   /**
    * The maximum number of times that the client will retry a request in case of a
@@ -55,7 +56,7 @@ export interface ClientOptions {
    *
    * @default 2
    */
-  maxRetries?: number;
+  maxRetries?: number
 
   /**
    * Default headers to include with every request to the API.
@@ -63,7 +64,7 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * header to `undefined` or `null` in request options.
    */
-  defaultHeaders?: Core.Headers;
+  defaultHeaders?: Core.Headers
 
   /**
    * Default query parameters to include with every request to the API.
@@ -71,24 +72,24 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * param to `undefined` in request options.
    */
-  defaultQuery?: Core.DefaultQuery;
+  defaultQuery?: Core.DefaultQuery
 }
 
 /**
  * API Client for interfacing with the Lorikeet API.
  */
 export class Lorikeet extends Core.APIClient {
-  bearerToken: string | null;
-  apiKey: string | null;
+  clientId: string
+  clientSecret: string
 
-  private _options: ClientOptions;
+  private _options: ClientOptions
 
   /**
    * API Client for interfacing with the Lorikeet API.
    *
-   * @param {string | null | undefined} [opts.bearerToken=process.env['LORIKEET_CLIENT_ID'] ?? null]
-   * @param {string | null | undefined} [opts.apiKey]
-   * @param {string} [opts.baseURL=process.env['LORIKEET_BASE_URL'] ?? http://api.lorikeetcx.ai] - Override the default base URL for the API.
+   * @param {string | undefined} [opts.clientId=process.env['LORIKEET_CLIENT_ID'] ?? undefined]
+   * @param {string | undefined} [opts.clientSecret=process.env['LORIKEET_CLIENT_SECRET'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['LORIKEET_BASE_URL'] ?? https://api.lorikeetcx.ai] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
    * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -98,16 +99,27 @@ export class Lorikeet extends Core.APIClient {
    */
   constructor({
     baseURL = Core.readEnv('LORIKEET_BASE_URL'),
-    bearerToken = Core.readEnv('LORIKEET_CLIENT_ID') ?? null,
-    apiKey = null,
+    clientId = Core.readEnv('LORIKEET_CLIENT_ID'),
+    clientSecret = Core.readEnv('LORIKEET_CLIENT_SECRET'),
     ...opts
   }: ClientOptions = {}) {
+    if (clientId === undefined) {
+      throw new Errors.LorikeetError(
+        "The LORIKEET_CLIENT_ID environment variable is missing or empty; either provide it, or instantiate the Lorikeet client with an clientId option, like new Lorikeet({ clientId: 'My Client ID' }).",
+      )
+    }
+    if (clientSecret === undefined) {
+      throw new Errors.LorikeetError(
+        "The LORIKEET_CLIENT_SECRET environment variable is missing or empty; either provide it, or instantiate the Lorikeet client with an clientSecret option, like new Lorikeet({ clientSecret: 'My Client Secret' }).",
+      )
+    }
+
     const options: ClientOptions = {
-      bearerToken,
-      apiKey,
+      clientId,
+      clientSecret,
       ...opts,
-      baseURL: baseURL || `http://api.lorikeetcx.ai`,
-    };
+      baseURL: baseURL || `https://api.lorikeetcx.ai`,
+    }
 
     super({
       baseURL: options.baseURL!,
@@ -115,95 +127,62 @@ export class Lorikeet extends Core.APIClient {
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
       fetch: options.fetch,
-    });
+    })
 
-    this._options = options;
+    this._options = options
 
-    this.bearerToken = bearerToken;
-    this.apiKey = apiKey;
+    this.clientId = clientId
+    this.clientSecret = clientSecret
   }
 
-  conversation: API.Conversation = new API.Conversation(this);
-  ingest: API.Ingest = new API.Ingest(this);
+  conversation: API.Conversation = new API.Conversation(this)
+  token: API.Token = new API.Token(this)
+  ingest: API.Ingest = new API.Ingest(this)
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
-    return this._options.defaultQuery;
+    return this._options.defaultQuery
   }
 
   protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
     return {
       ...super.defaultHeaders(opts),
       ...this._options.defaultHeaders,
-    };
-  }
-
-  protected override validateHeaders(headers: Core.Headers, customHeaders: Core.Headers) {
-    if (this.bearerToken && headers['authorization']) {
-      return;
     }
-    if (customHeaders['authorization'] === null) {
-      return;
-    }
-
-    if (this.apiKey && headers['x-optech-webhook-signature']) {
-      return;
-    }
-    if (customHeaders['x-optech-webhook-signature'] === null) {
-      return;
-    }
-
-    throw new Error(
-      'Could not resolve authentication method. Expected either bearerToken or apiKey to be set. Or for one of the "Authorization" or "x-optech-webhook-signature" headers to be explicitly omitted',
-    );
   }
 
   protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
-    const bearerAuth = this.bearerAuth(opts);
-    const apiKeyAuth = this.apiKeyAuth(opts);
-
-    if (bearerAuth != null && !Core.isEmptyObj(bearerAuth)) {
-      return bearerAuth;
-    }
-
-    if (apiKeyAuth != null && !Core.isEmptyObj(apiKeyAuth)) {
-      return apiKeyAuth;
-    }
-    return {};
-  }
-
-  protected bearerAuth(opts: Core.FinalRequestOptions): Core.Headers {
-    if (this.bearerToken == null) {
-      return {};
+    const signature = generateSignature(opts.body as string, this.clientSecret)
+    return {
+      // backwards compatibility
+      'x-optech-webhook-signature': signature,
+      'x-lorikeet-signature': signature,
+      authorization: `Bearer ${this.clientId}`,
     }
-    return { Authorization: `Bearer ${this.bearerToken}` };
   }
 
-  protected apiKeyAuth(opts: Core.FinalRequestOptions): Core.Headers {
-    if (this.apiKey == null) {
-      return {};
-    }
-    return { 'x-optech-webhook-signature': this.apiKey };
+  protected override stringifyQuery(query: Record<string, unknown>): string {
+    return qs.stringify(query, { arrayFormat: 'comma' })
   }
 
-  static Lorikeet = this;
-  static DEFAULT_TIMEOUT = 60000; // 1 minute
-
-  static LorikeetError = Errors.LorikeetError;
-  static APIError = Errors.APIError;
-  static APIConnectionError = Errors.APIConnectionError;
-  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
-  static APIUserAbortError = Errors.APIUserAbortError;
-  static NotFoundError = Errors.NotFoundError;
-  static ConflictError = Errors.ConflictError;
-  static RateLimitError = Errors.RateLimitError;
-  static BadRequestError = Errors.BadRequestError;
-  static AuthenticationError = Errors.AuthenticationError;
-  static InternalServerError = Errors.InternalServerError;
-  static PermissionDeniedError = Errors.PermissionDeniedError;
-  static UnprocessableEntityError = Errors.UnprocessableEntityError;
-
-  static toFile = Uploads.toFile;
-  static fileFromPath = Uploads.fileFromPath;
+  static Lorikeet = this
+  static DEFAULT_TIMEOUT = 60000 // 1 minute
+
+  static LorikeetError = Errors.LorikeetError
+  static APIError = Errors.APIError
+  static APIConnectionError = Errors.APIConnectionError
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError
+  static APIUserAbortError = Errors.APIUserAbortError
+  static NotFoundError = Errors.NotFoundError
+  static ConflictError = Errors.ConflictError
+  static RateLimitError = Errors.RateLimitError
+  static BadRequestError = Errors.BadRequestError
+  static AuthenticationError = Errors.AuthenticationError
+  static InternalServerError = Errors.InternalServerError
+  static PermissionDeniedError = Errors.PermissionDeniedError
+  static UnprocessableEntityError = Errors.UnprocessableEntityError
+
+  static toFile = Uploads.toFile
+  static fileFromPath = Uploads.fileFromPath
 }
 
 export const {
@@ -220,24 +199,21 @@ export const {
   InternalServerError,
   PermissionDeniedError,
   UnprocessableEntityError,
-} = Errors;
+} = Errors
 
-export import toFile = Uploads.toFile;
-export import fileFromPath = Uploads.fileFromPath;
+export import toFile = Uploads.toFile
+export import fileFromPath = Uploads.fileFromPath
+import { generateSignature } from './lib/generate-signature'
 
 export namespace Lorikeet {
-  export import RequestOptions = Core.RequestOptions;
-
-  export import Conversation = API.Conversation;
-  export import ConversationMessageResponse = API.ConversationMessageResponse;
-  export import ConversationStartResponse = API.ConversationStartResponse;
-  export import ConversationMessageParams = API.ConversationMessageParams;
-
-  export import Ingest = API.Ingest;
-  export import IngestValidateResponse = API.IngestValidateResponse;
-  export import IngestReturnWebhookParams = API.IngestReturnWebhookParams;
-  export import IngestTokenParams = API.IngestTokenParams;
-  export import IngestValidateParams = API.IngestValidateParams;
+  export import RequestOptions = Core.RequestOptions
+
+  export import Conversation = API.Conversation
+
+  export import Token = API.Token
+  export import TokenCreateParams = API.TokenCreateParams
+
+  export import Ingest = API.Ingest
 }
 
-export default Lorikeet;
+export default Lorikeet

package/src/internal/qs/formats.ts

@@ -1,9 +1,9 @@
-import type { Format } from './types';
+import type { Format } from './types'
 
-export const default_format: Format = 'RFC3986';
+export const default_format: Format = 'RFC3986'
 export const formatters: Record<Format, (str: PropertyKey) => string> = {
   RFC1738: (v: PropertyKey) => String(v).replace(/%20/g, '+'),
   RFC3986: (v: PropertyKey) => String(v),
-};
-export const RFC1738 = 'RFC1738';
-export const RFC3986 = 'RFC3986';
+}
+export const RFC1738 = 'RFC1738'
+export const RFC3986 = 'RFC3986'

package/src/internal/qs/index.ts

@@ -1,13 +1,13 @@
-import { default_format, formatters, RFC1738, RFC3986 } from './formats';
+import { default_format, formatters, RFC1738, RFC3986 } from './formats'
 
 const formats = {
   formatters,
   RFC1738,
   RFC3986,
   default: default_format,
-};
+}
 
-export { stringify } from './stringify';
-export { formats };
+export { stringify } from './stringify'
+export { formats }
 
-export type { DefaultDecoder, DefaultEncoder, Format, ParseOptions, StringifyOptions } from './types';
+export type { DefaultDecoder, DefaultEncoder, Format, ParseOptions, StringifyOptions } from './types'