@lorikeetai/node-sdk 0.13.2 → 1.0.1

package/src/internal/qs/utils.ts

@@ -0,0 +1,265 @@
+import { RFC1738 } from './formats';
+import type { DefaultEncoder, Format } from './types';
+
+const has = Object.prototype.hasOwnProperty;
+const is_array = Array.isArray;
+
+const hex_table = (() => {
+  const array = [];
+  for (let i = 0; i < 256; ++i) {
+    array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
+  }
+
+  return array;
+})();
+
+function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; prop: string }>) {
+  while (queue.length > 1) {
+    const item = queue.pop();
+    if (!item) continue;
+
+    const obj = item.obj[item.prop];
+
+    if (is_array(obj)) {
+      const compacted: unknown[] = [];
+
+      for (let j = 0; j < obj.length; ++j) {
+        if (typeof obj[j] !== 'undefined') {
+          compacted.push(obj[j]);
+        }
+      }
+
+      // @ts-ignore
+      item.obj[item.prop] = compacted;
+    }
+  }
+}
+
+function array_to_object(source: any[], options: { plainObjects: boolean }) {
+  const obj = options && options.plainObjects ? Object.create(null) : {};
+  for (let i = 0; i < source.length; ++i) {
+    if (typeof source[i] !== 'undefined') {
+      obj[i] = source[i];
+    }
+  }
+
+  return obj;
+}
+
+export function merge(
+  target: any,
+  source: any,
+  options: { plainObjects?: boolean; allowPrototypes?: boolean } = {},
+) {
+  if (!source) {
+    return target;
+  }
+
+  if (typeof source !== 'object') {
+    if (is_array(target)) {
+      target.push(source);
+    } else if (target && typeof target === 'object') {
+      if (
+        (options && (options.plainObjects || options.allowPrototypes)) ||
+        !has.call(Object.prototype, source)
+      ) {
+        target[source] = true;
+      }
+    } else {
+      return [target, source];
+    }
+
+    return target;
+  }
+
+  if (!target || typeof target !== 'object') {
+    return [target].concat(source);
+  }
+
+  let mergeTarget = target;
+  if (is_array(target) && !is_array(source)) {
+    // @ts-ignore
+    mergeTarget = array_to_object(target, options);
+  }
+
+  if (is_array(target) && is_array(source)) {
+    source.forEach(function (item, i) {
+      if (has.call(target, i)) {
+        const targetItem = target[i];
+        if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
+          target[i] = merge(targetItem, item, options);
+        } else {
+          target.push(item);
+        }
+      } else {
+        target[i] = item;
+      }
+    });
+    return target;
+  }
+
+  return Object.keys(source).reduce(function (acc, key) {
+    const value = source[key];
+
+    if (has.call(acc, key)) {
+      acc[key] = merge(acc[key], value, options);
+    } else {
+      acc[key] = value;
+    }
+    return acc;
+  }, mergeTarget);
+}
+
+export function assign_single_source(target: any, source: any) {
+  return Object.keys(source).reduce(function (acc, key) {
+    acc[key] = source[key];
+    return acc;
+  }, target);
+}
+
+export function decode(str: string, _: any, charset: string) {
+  const strWithoutPlus = str.replace(/\+/g, ' ');
+  if (charset === 'iso-8859-1') {
+    // unescape never throws, no try...catch needed:
+    return strWithoutPlus.replace(/%[0-9a-f]{2}/gi, unescape);
+  }
+  // utf-8
+  try {
+    return decodeURIComponent(strWithoutPlus);
+  } catch (e) {
+    return strWithoutPlus;
+  }
+}
+
+const limit = 1024;
+
+export const encode: (
+  str: any,
+  defaultEncoder: DefaultEncoder,
+  charset: string,
+  type: 'key' | 'value',
+  format: Format,
+) => string = (str, _defaultEncoder, charset, _kind, format: Format) => {
+  // This code was originally written by Brian White for the io.js core querystring library.
+  // It has been adapted here for stricter adherence to RFC 3986
+  if (str.length === 0) {
+    return str;
+  }
+
+  let string = str;
+  if (typeof str === 'symbol') {
+    string = Symbol.prototype.toString.call(str);
+  } else if (typeof str !== 'string') {
+    string = String(str);
+  }
+
+  if (charset === 'iso-8859-1') {
+    return escape(string).replace(/%u[0-9a-f]{4}/gi, function ($0) {
+      return '%26%23' + parseInt($0.slice(2), 16) + '%3B';
+    });
+  }
+
+  let out = '';
+  for (let j = 0; j < string.length; j += limit) {
+    const segment = string.length >= limit ? string.slice(j, j + limit) : string;
+    const arr = [];
+
+    for (let i = 0; i < segment.length; ++i) {
+      let c = segment.charCodeAt(i);
+      if (
+        c === 0x2d || // -
+        c === 0x2e || // .
+        c === 0x5f || // _
+        c === 0x7e || // ~
+        (c >= 0x30 && c <= 0x39) || // 0-9
+        (c >= 0x41 && c <= 0x5a) || // a-z
+        (c >= 0x61 && c <= 0x7a) || // A-Z
+        (format === RFC1738 && (c === 0x28 || c === 0x29)) // ( )
+      ) {
+        arr[arr.length] = segment.charAt(i);
+        continue;
+      }
+
+      if (c < 0x80) {
+        arr[arr.length] = hex_table[c];
+        continue;
+      }
+
+      if (c < 0x800) {
+        arr[arr.length] = hex_table[0xc0 | (c >> 6)]! + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      if (c < 0xd800 || c >= 0xe000) {
+        arr[arr.length] =
+          hex_table[0xe0 | (c >> 12)]! + hex_table[0x80 | ((c >> 6) & 0x3f)] + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      i += 1;
+      c = 0x10000 + (((c & 0x3ff) << 10) | (segment.charCodeAt(i) & 0x3ff));
+
+      arr[arr.length] =
+        hex_table[0xf0 | (c >> 18)]! +
+        hex_table[0x80 | ((c >> 12) & 0x3f)] +
+        hex_table[0x80 | ((c >> 6) & 0x3f)] +
+        hex_table[0x80 | (c & 0x3f)];
+    }
+
+    out += arr.join('');
+  }
+
+  return out;
+};
+
+export function compact(value: any) {
+  const queue = [{ obj: { o: value }, prop: 'o' }];
+  const refs = [];
+
+  for (let i = 0; i < queue.length; ++i) {
+    const item = queue[i];
+    // @ts-ignore
+    const obj = item.obj[item.prop];
+
+    const keys = Object.keys(obj);
+    for (let j = 0; j < keys.length; ++j) {
+      const key = keys[j]!;
+      const val = obj[key];
+      if (typeof val === 'object' && val !== null && refs.indexOf(val) === -1) {
+        queue.push({ obj: obj, prop: key });
+        refs.push(val);
+      }
+    }
+  }
+
+  compact_queue(queue);
+
+  return value;
+}
+
+export function is_regexp(obj: any) {
+  return Object.prototype.toString.call(obj) === '[object RegExp]';
+}
+
+export function is_buffer(obj: any) {
+  if (!obj || typeof obj !== 'object') {
+    return false;
+  }
+
+  return !!(obj.constructor && obj.constructor.isBuffer && obj.constructor.isBuffer(obj));
+}
+
+export function combine(a: any, b: any) {
+  return [].concat(a, b);
+}
+
+export function maybe_map<T>(val: T[], fn: (v: T) => T) {
+  if (is_array(val)) {
+    const mapped = [];
+    for (let i = 0; i < val.length; i += 1) {
+      mapped.push(fn(val[i]!));
+    }
+    return mapped;
+  }
+  return fn(val);
+}

package/src/resource.ts

@@ -2,7 +2,7 @@
 
 import type { Lorikeet } from './index';
 
-export class APIResource {
+export abstract class APIResource {
   protected _client: Lorikeet;
 
   constructor(client: Lorikeet) {

package/src/resources/conversation/chat.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 Chat extends APIResource {
   /**
@@ -140,7 +141,7 @@ export interface ChatGenerateResponse {
    * The events that have occurred in the conversation. Can be used for deriving more
    * information about the conversation.
    */
-  events: Array<ChatGenerateResponse.Event>;
+  events: Array<ConversationAPI.TicketEvent>;
 
   /**
    * The latest message type - useful for polling
@@ -155,101 +156,24 @@ export interface ChatGenerateResponse {
   /**
    * The full list of messages. This endpoint supports markdown.
    */
-  messages: Array<ChatGenerateResponse.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 ChatGenerateResponse {
-  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 ChatGetResponse {
   /**
    * The ID of the conversation
@@ -265,7 +189,7 @@ export interface ChatGetResponse {
    * The events that have occurred in the conversation. Can be used for deriving more
    * information about the conversation.
    */
-  events: Array<ChatGetResponse.Event>;
+  events: Array<ConversationAPI.TicketEvent>;
 
   /**
    * The latest message type - useful for polling
@@ -280,101 +204,24 @@ export interface ChatGetResponse {
   /**
    * The full list of messages. This endpoint supports markdown.
    */
-  messages: Array<ChatGetResponse.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 ChatGetResponse {
-  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 ChatStartResponse {
   /**
    * The ID of the conversation
@@ -390,7 +237,7 @@ export interface ChatStartResponse {
    * The events that have occurred in the conversation. Can be used for deriving more
    * information about the conversation.
    */
-  events: Array<ChatStartResponse.Event>;
+  events: Array<ConversationAPI.TicketEvent>;
 
   /**
    * The url of the conversation in the Lorikeet dashboard
@@ -401,44 +248,18 @@ export interface ChatStartResponse {
    * The status of the conversation
    */
   status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
-}
-
-export namespace ChatStartResponse {
-  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 ChatGenerateParams {
   /**
    * Attachments to be sent with the message
    */
-  attachments: Array<ChatGenerateParams.Attachment>;
+  attachments: Array<ConversationAPI.AttachmentDto>;
 
   /**
    * The ID of the conversation
@@ -458,23 +279,6 @@ export interface ChatGenerateParams {
 }
 
 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.