@lorikeetai/node-sdk 0.6.2 → 0.7.0

package/src/error.ts

@@ -4,17 +4,19 @@ 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;
-
-  constructor(
-    status: number | undefined,
-    error: Object | undefined,
-    message: string | undefined,
-    headers: Headers | undefined,
-  ) {
+export class APIError<
+  TStatus extends number | undefined = number | undefined,
+  THeaders extends Headers | undefined = Headers | undefined,
+  TError extends Object | undefined = Object | undefined,
+> extends LorikeetError {
+  /** HTTP status for the response that caused the error */
+  readonly status: TStatus;
+  /** HTTP headers for the response that caused the error */
+  readonly headers: THeaders;
+  /** JSON body of the response that caused the error */
+  readonly error: TError;
+
+  constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders) {
     super(`${APIError.makeMessage(status, error, message)}`);
     this.status = status;
     this.headers = headers;
@@ -48,7 +50,7 @@ export class APIError extends LorikeetError {
     message: string | undefined,
     headers: Headers | undefined,
   ): APIError {
-    if (!status) {
+    if (!status || !headers) {
       return new APIConnectionError({ message, cause: castToError(errorResponse) });
     }
 
@@ -90,17 +92,13 @@ export class APIError extends LorikeetError {
   }
 }
 
-export class APIUserAbortError extends APIError {
-  override readonly status: undefined = undefined;
-
+export class APIUserAbortError extends APIError<undefined, undefined, undefined> {
   constructor({ message }: { message?: string } = {}) {
     super(undefined, undefined, message || 'Request was aborted.', undefined);
   }
 }
 
-export class APIConnectionError extends APIError {
-  override readonly status: undefined = undefined;
-
+export class APIConnectionError extends APIError<undefined, undefined, undefined> {
   constructor({ message, cause }: { message?: string | undefined; cause?: Error | undefined }) {
     super(undefined, undefined, message || 'Connection error.', undefined);
     // in some environments the 'cause' property is already declared
@@ -115,32 +113,18 @@ export class APIConnectionTimeoutError extends APIConnectionError {
   }
 }
 
-export class BadRequestError extends APIError {
-  override readonly status: 400 = 400;
-}
+export class BadRequestError extends APIError<400, Headers> {}
 
-export class AuthenticationError extends APIError {
-  override readonly status: 401 = 401;
-}
+export class AuthenticationError extends APIError<401, Headers> {}
 
-export class PermissionDeniedError extends APIError {
-  override readonly status: 403 = 403;
-}
+export class PermissionDeniedError extends APIError<403, Headers> {}
 
-export class NotFoundError extends APIError {
-  override readonly status: 404 = 404;
-}
+export class NotFoundError extends APIError<404, Headers> {}
 
-export class ConflictError extends APIError {
-  override readonly status: 409 = 409;
-}
+export class ConflictError extends APIError<409, Headers> {}
 
-export class UnprocessableEntityError extends APIError {
-  override readonly status: 422 = 422;
-}
+export class UnprocessableEntityError extends APIError<422, Headers> {}
 
-export class RateLimitError extends APIError {
-  override readonly status: 429 = 429;
-}
+export class RateLimitError extends APIError<429, Headers> {}
 
-export class InternalServerError extends APIError {}
+export class InternalServerError extends APIError<number, Headers> {}

package/src/resources/conversation/chat.ts

@@ -89,13 +89,18 @@ export interface ChatGenerateResponse {
   /**
    * The latest message type - useful for polling
    */
-  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+  latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
 
   /**
    * The full list of messages. This endpoint supports markdown.
    */
   messages: Array<ChatGenerateResponse.Message>;
 
+  /**
+   * The status of the conversation
+   */
+  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+
   /**
    * The timestamp of when the ticket was last updated in our system.
    */
@@ -109,6 +114,11 @@ export namespace ChatGenerateResponse {
      */
     id: string;
 
+    /**
+     * Attachments that were attached to the message
+     */
+    attachments: Array<Message.Attachment>;
+
     /**
      * The content of the message. Markdown on plain text.
      */
@@ -127,7 +137,26 @@ export namespace ChatGenerateResponse {
     /**
      * The type of the message
      */
-    type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+    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;
+    }
   }
 }
 
@@ -145,13 +174,18 @@ export interface ChatGetResponse {
   /**
    * The latest message type - useful for polling
    */
-  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+  latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
 
   /**
    * The full list of messages. This endpoint supports markdown.
    */
   messages: Array<ChatGetResponse.Message>;
 
+  /**
+   * The status of the conversation
+   */
+  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+
   /**
    * The timestamp of when the ticket was last updated in our system.
    */
@@ -165,6 +199,11 @@ export namespace ChatGetResponse {
      */
     id: string;
 
+    /**
+     * Attachments that were attached to the message
+     */
+    attachments: Array<Message.Attachment>;
+
     /**
      * The content of the message. Markdown on plain text.
      */
@@ -183,7 +222,26 @@ export namespace ChatGetResponse {
     /**
      * The type of the message
      */
-    type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+    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;
+    }
   }
 }
 
@@ -197,9 +255,19 @@ export interface ChatStartResponse {
    * The timestamp of the when the conversation was created in our system.
    */
   createdAt: string;
+
+  /**
+   * The status of the conversation
+   */
+  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
 }
 
 export interface ChatGenerateParams {
+  /**
+   * Attachments to be sent with the message
+   */
+  attachments: Array<ChatGenerateParams.Attachment>;
+
   /**
    * The ID of the conversation
    */
@@ -214,7 +282,64 @@ export interface ChatGenerateParams {
    * Any additional customer information, that has changed in the course of the
    * conversation.
    */
-  customer?: unknown;
+  customer?: ChatGenerateParams.Customer;
+}
+
+export namespace ChatGenerateParams {
+  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.
+   */
+  export interface Customer {
+    /**
+     * The display name of the customer
+     */
+    displayName?: 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;
+  }
 }
 
 export interface ChatGetParams {

package/src/resources/conversation/email.ts

@@ -31,13 +31,18 @@ export interface EmailGenerateResponse {
   /**
    * The latest message type - useful for polling
    */
-  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+  latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
 
   /**
    * The full list of messages. This endpoint supports markdown.
    */
   messages: Array<EmailGenerateResponse.Message>;
 
+  /**
+   * The status of the conversation
+   */
+  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+
   /**
    * The timestamp of when the ticket was last updated in our system.
    */
@@ -51,6 +56,11 @@ export namespace EmailGenerateResponse {
      */
     id: string;
 
+    /**
+     * Attachments that were attached to the message
+     */
+    attachments: Array<Message.Attachment>;
+
     /**
      * The content of the message. Markdown on plain text.
      */
@@ -69,7 +79,26 @@ export namespace EmailGenerateResponse {
     /**
      * The type of the message
      */
-    type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+    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;
+    }
   }
 }
 
@@ -87,13 +116,18 @@ export interface EmailGetResponse {
   /**
    * The latest message type - useful for polling
    */
-  latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+  latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
 
   /**
    * The full list of messages. This endpoint supports markdown.
    */
   messages: Array<EmailGetResponse.Message>;
 
+  /**
+   * The status of the conversation
+   */
+  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+
   /**
    * The timestamp of when the ticket was last updated in our system.
    */
@@ -107,6 +141,11 @@ export namespace EmailGetResponse {
      */
     id: string;
 
+    /**
+     * Attachments that were attached to the message
+     */
+    attachments: Array<Message.Attachment>;
+
     /**
      * The content of the message. Markdown on plain text.
      */
@@ -125,7 +164,26 @@ export namespace EmailGetResponse {
     /**
      * The type of the message
      */
-    type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
+    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;
+    }
   }
 }
 
@@ -139,9 +197,19 @@ export interface EmailStartResponse {
    * The timestamp of the when the conversation was created in our system.
    */
   createdAt: string;
+
+  /**
+   * The status of the conversation
+   */
+  status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
 }
 
 export interface EmailGenerateParams {
+  /**
+   * Attachments to be sent with the message
+   */
+  attachments: Array<EmailGenerateParams.Attachment>;
+
   /**
    * The ID of the conversation
    */
@@ -156,7 +224,64 @@ export interface EmailGenerateParams {
    * Any additional customer information, that has changed in the course of the
    * conversation.
    */
-  customer?: unknown;
+  customer?: EmailGenerateParams.Customer;
+}
+
+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.
+   */
+  export interface Customer {
+    /**
+     * The display name of the customer
+     */
+    displayName?: 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;
+  }
 }
 
 export interface EmailGetParams {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.6.2'; // x-release-please-version
+export const VERSION = '0.7.0'; // x-release-please-version

package/version.d.ts

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

package/version.mjs

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