@scout9/admin 1.0.0

package/src/api.ts

@@ -0,0 +1,141 @@
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
+import type { RequestArgs } from './base';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, API_VERSION } from './base';
+import { ICustomer } from './schemas';
+
+export type ICustomerCreateRequest = ICustomer;
+
+export interface ICustomerCreateResponse {
+  success: boolean;
+}
+
+export type ICustomerUpdateRequest = Partial<ICustomer>;
+
+export interface ICustomerUpdateResponse {
+  success: boolean;
+}
+
+export interface ICustomerRemoveRequest {
+  customer: string;
+}
+
+export interface ICustomerRemoveResponse {
+  success: boolean;
+}
+
+export interface ICustomerCreateBulkRequest {
+  customers: ICustomer[];
+}
+
+export interface ICustomerCreateBulkResponse {
+  success: boolean;
+}
+
+export interface ICustomerRemoveBulkRequest {
+  customers: string[];
+}
+
+export interface ICustomerRemoveBulkResponse {
+  success: boolean;
+}
+
+export interface ICustomerUpdateBulkRequest {
+  customers: Partial<ICustomer>[];
+}
+
+export interface ICustomerUpdateBulkResponse {
+  success: boolean;
+}
+
+export const Scout9ApiAxiosParamCreator = function (configuration?: Configuration) {
+  return {
+
+    /**
+     *
+     * @summary Creates a model response for the given chat conversation.
+     * @param {ICustomerCreateRequest} createCustomerRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomer: async (createCustomerRequest: ICustomerCreateRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+      // verify required parameter 'createChatCompletionRequest' is not null or undefined
+      assertParamExists('createCustomer', 'createCustomerRequest', createCustomerRequest);
+      const localVarPath = `${configuration?.apiVersion || ''}-customers-customer-create`;
+      // use dummy base URL string because the URL constructor only accepts absolute URLs.
+      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+      let baseOptions;
+      if (configuration) {
+        baseOptions = configuration.baseOptions;
+      }
+
+      const localVarRequestOptions = {method: 'POST', ...baseOptions, ...options};
+      const localVarHeaderParameter = {} as any;
+      const localVarQueryParameter = {} as any;
+
+      localVarHeaderParameter['Content-Type'] = 'application/json';
+
+      setSearchParams(localVarUrlObj, localVarQueryParameter);
+      let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+      localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+      localVarRequestOptions.data = serializeDataIfNeeded(createCustomerRequest, localVarRequestOptions, configuration);
+
+      return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions,
+      };
+    },
+
+
+  };
+};
+
+/**
+ * Scout9Api - functional programming interface
+ * @export
+ */
+export const Scout9ApiFp = function (configuration?: Configuration) {
+  const localVarAxiosParamCreator = Scout9ApiAxiosParamCreator(configuration);
+  return {
+    /**
+     *
+     * @summary Creates a model response for the given chat conversation.
+     * @param {ICustomerCreateRequest} createCustomerRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async createCustomer(createCustomerRequest: ICustomerCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ICustomerCreateResponse>> {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomer(createCustomerRequest, options);
+      return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+    },
+  };
+};
+
+/**
+ * Scout9Api - object-oriented interface
+ * @export
+ * @class Scout9Api
+ * @extends {BaseAPI}
+ */
+export class Scout9Api extends BaseAPI {
+
+  /**
+   *
+   * @summary Creates a model response for the given chat conversation.
+   * @param {ICustomerCreateRequest} createCustomerRequest
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof Scout9Api
+   */
+  public createCustomer(createCustomerRequest: ICustomerCreateRequest, options?: AxiosRequestConfig) {
+    return Scout9ApiFp(this.configuration)
+      .createCustomer(createCustomerRequest, options)
+      .then((request) => request(this.axios, this.basePath));
+  }
+
+}

package/src/base.ts

@@ -0,0 +1,55 @@
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "https://us-central1-jumpstart.cloudfunctions.net".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+  csv: ",",
+  ssv: " ",
+  tsv: "\t",
+  pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+  url: string;
+  options: AxiosRequestConfig;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+  protected configuration: Configuration | undefined;
+
+  constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+    if (configuration) {
+      this.configuration = configuration;
+      this.basePath = configuration.basePath || this.basePath;
+    }
+  }
+}
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+  constructor(public field: string, msg?: string) {
+    super(msg as string);
+    this.name = "RequiredError"
+  }
+}

package/src/common.ts

@@ -0,0 +1,136 @@
+import { AxiosRequestConfig } from 'axios';
+import type { Configuration } from "./configuration";
+import type { RequestArgs,  } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import {RequiredError} from './base';
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+  if (paramValue === null || paramValue === undefined) {
+    throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+  }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+  if (configuration && configuration.apiKey) {
+    const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+      ? await configuration.apiKey(keyParamName)
+      : await configuration.apiKey;
+    object[keyParamName] = localVarApiKeyValue;
+  }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+  if (configuration && (configuration.username || configuration.password)) {
+    object["auth"] = { username: configuration.username, password: configuration.password };
+  }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+  if (configuration && configuration.accessToken) {
+    const accessToken = typeof configuration.accessToken === 'function'
+      ? await configuration.accessToken()
+      : await configuration.accessToken;
+    object["Authorization"] = "Bearer " + accessToken;
+  }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+  if (configuration && configuration.accessToken) {
+    const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+      ? await configuration.accessToken(name, scopes)
+      : await configuration.accessToken;
+    object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+  }
+}
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+  if (parameter == null) return;
+  if (typeof parameter === "object") {
+    if (Array.isArray(parameter)) {
+      (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+    }
+    else {
+      Object.keys(parameter).forEach(currentKey =>
+        setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+      );
+    }
+  }
+  else {
+    if (urlSearchParams.has(key)) {
+      urlSearchParams.append(key, parameter);
+    }
+    else {
+      urlSearchParams.set(key, parameter);
+    }
+  }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+  const searchParams = new URLSearchParams(url.search);
+  setFlattenedQueryParams(searchParams, objects);
+  url.search = searchParams.toString();
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+  const nonString = typeof value !== 'string';
+  const needsSerialization = nonString && configuration && configuration.isJsonMime
+    ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+    : nonString;
+  return needsSerialization
+    ? JSON.stringify(value !== undefined ? value : {})
+    : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+  return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+  return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+    const axiosRequestArgs: AxiosRequestConfig<any> = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url};
+    return axios.request<T, R>(axiosRequestArgs);
+  };
+}

package/src/configuration.ts

@@ -0,0 +1,124 @@
+const packageJson = require("../package.json");
+
+export interface ConfigurationParameters {
+  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+  organization?: string;
+  username?: string;
+  password?: string;
+  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+  basePath?: string;
+  baseOptions?: any;
+  formDataCtor?: new () => any;
+}
+
+export class Configuration {
+  /**
+   * parameter for apiKey security
+   * @param name security name
+   * @memberof Configuration
+   */
+  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+
+  /**
+   * Scout9 organization id
+   *
+   * @type {string}
+   * @memberof Configuration
+   */
+  organization?: string;
+
+  /**
+   * parameter for basic security
+   *
+   * @type {string}
+   * @memberof Configuration
+   */
+  username?: string;
+
+  /**
+   * parameter for basic security
+   *
+   * @type {string}
+   * @memberof Configuration
+   */
+  password?: string;
+
+  /**
+   * parameter for oauth2 security
+   * @param name security name
+   * @param scopes oauth2 scope
+   * @memberof Configuration
+   */
+  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+
+  /**
+   * override base path
+   *
+   * @type {string}
+   * @memberof Configuration
+   */
+  basePath?: string;
+  /**
+   * base options for axios calls
+   *
+   * @type {any}
+   * @memberof Configuration
+   */
+  baseOptions?: any;
+
+  /**
+   * The FormData constructor that will be used to create multipart form data
+   * requests. You can inject this here so that execution environments that
+   * do not support the FormData class can still run the generated client.
+   *
+   * @type {new () => FormData}
+   */
+  formDataCtor?: new () => any;
+
+  /**
+   * The version of the Scout9 API that this client library version is
+   */
+  apiVersion?: string;
+
+  constructor(param: ConfigurationParameters = {}) {
+    this.apiKey = param.apiKey;
+    this.organization = param.organization;
+    this.username = param.username;
+    this.password = param.password;
+    this.accessToken = param.accessToken;
+    this.basePath = param.basePath;
+    this.baseOptions = param.baseOptions;
+    this.formDataCtor = param.formDataCtor;
+    this.apiVersion = 'v' + packageJson.version.split(".")[0];
+
+    if (!this.baseOptions) {
+      this.baseOptions = {};
+    }
+    this.baseOptions.headers = {
+      'User-Agent': `Scout9/NodeJS/${packageJson.version}`,
+      'Authorization': `Bearer ${this.apiKey}`,
+      ...this.baseOptions.headers,
+    }
+    if (this.organization) {
+      this.baseOptions.headers['Scout9-Organization'] = this.organization;
+    }
+    if (!this.formDataCtor) {
+      this.formDataCtor = require("form-data");
+    }
+  }
+
+  /**
+   * Check if the given MIME is a JSON MIME.
+   * JSON MIME examples:
+   *   application/json
+   *   application/json; charset=UTF8
+   *   APPLICATION/JSON
+   *   application/vnd.company+json
+   * @param mime - MIME (Multipurpose Internet Mail Extensions)
+   * @return True if the given MIME is JSON, false otherwise.
+   */
+  public isJsonMime(mime: string): boolean {
+    const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+    return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./api";
+export * from "./configuration";

package/src/schemas/common/algolia.ts

@@ -0,0 +1,24 @@
+/**
+ * Helper schedule to bridge algolia records with internal db
+ */
+export interface IAlgoliaIndexedObject {
+  /**
+   * Where this object is stored in the database
+   */
+  parent: string;
+
+  /**
+   * Algolia objectID required
+   */
+  objectID: string;
+
+
+  /**
+   * Algolia geolocation for a given object
+   */
+  _geoloc?: {
+    lat: number;
+    lng: number;
+  }
+
+}

package/src/schemas/common/contact-map.ts

@@ -0,0 +1,35 @@
+import { EmailServiceType } from '../users';
+
+export interface IContactPath {
+  id: string;
+  path: string;
+}
+/**
+ * A utility helper collection to map contact information to a common format.
+ *
+ * scout9-contact-map/{contact}
+ */
+export interface IContactMap {
+  /**
+   * Can either be the formatted phone number or email address.
+   */
+  contact: string;
+  agentPaths: {
+    businessId: string;
+    agentId: string;
+  }[];
+  customerPaths: {
+    businessId: string;
+    customerId: string;
+  }[];
+
+  programmableEmailProps?: {
+    type: EmailServiceType;
+    /**
+     * If this email is a gmail email, then we can store the refresh token (after they O-Auth) here so that we can run gmail.contacts.watch
+     * @TODO - create a O-Auth flow for this, see scripts/gmail/generate-refresh-token for an example
+     */
+    gmailRefreshToken?: string;
+    gmailWatchExpiration?: string;
+  }
+}

package/src/schemas/common/currency.ts

@@ -0,0 +1 @@
+export type Currency = 'usd' | 'cad';

package/src/schemas/common/index.ts

@@ -0,0 +1,6 @@
+export * from './location';
+export * from './currency';
+export * from './time';
+export * from './task';
+export * from './contact-map';
+export * from './algolia';

package/src/schemas/common/location.ts

@@ -0,0 +1,6 @@
+
+export interface ILocation {
+  placeId: string;
+  lat: number;
+  lng: number;
+}

package/src/schemas/common/task.ts

@@ -0,0 +1,26 @@
+import { Timestamp } from '../common';
+
+export interface ITask {
+  /**
+   * Unique token for processing
+   */
+  token?: string;
+
+  /**
+   * Time when the task was created
+   */
+  time: Timestamp;
+
+
+  /**
+   * When was the task completed
+   */
+  completed?: Timestamp;
+
+  retries?: number;
+}
+
+export interface IQueueTask {
+  token: string;
+  taskPath: string;
+}

package/src/schemas/common/time.ts

@@ -0,0 +1,15 @@
+import moment from 'moment';
+import { ISOString, Timestamp } from '../common';
+
+export interface ITimeRange {
+  from: ISOString;
+  to: ISOString;
+}
+export interface ITimeRangeTimestamp {
+  from: Timestamp;
+  to: Timestamp;
+}
+export interface ITimeRangeMoment {
+  from: moment.Moment;
+  to: moment.Moment;
+}

package/src/schemas/common.ts

@@ -0,0 +1,94 @@
+export type Timestamp = any;
+export type ISOString = string;
+
+export type MessageStatus = 'queued'|'sending'|'sent'|'failed'|'delivered'|'undelivered'|'receiving'|'received'|'accepted'|'scheduled'|'read'|'partially_delivered'|'canceled';
+
+export const ChatCompletionRequestMessageRoleEnum = {
+  System: 'system',
+  User: 'user',
+  Assistant: 'assistant'
+} as const;
+
+export type ChatCompletionRequestMessageRoleEnum = typeof ChatCompletionRequestMessageRoleEnum[keyof typeof ChatCompletionRequestMessageRoleEnum];
+
+
+export interface ChatCompletionRequestMessage {
+  /**
+   * The role of the author of this message.
+   * @type {string}
+   * @memberof ChatCompletionRequestMessage
+   */
+  'role': ChatCompletionRequestMessageRoleEnum;
+  /**
+   * The contents of the message
+   * @type {string}
+   * @memberof ChatCompletionRequestMessage
+   */
+  'content': string;
+  /**
+   * The name of the user in a multi-user chat
+   * @type {string}
+   * @memberof ChatCompletionRequestMessage
+   */
+  'name'?: string;
+}
+
+
+export module Stripe {
+  export interface Address {
+    /**
+     * City/District/Suburb/Town/Village.
+     */
+    city: string | null;
+
+    /**
+     * 2-letter country code.
+     */
+    country: string | null;
+
+    /**
+     * Address line 1 (Street address/PO Box/Company name).
+     */
+    line1: string | null;
+
+    /**
+     * Address line 2 (Apartment/Suite/Unit/Building).
+     */
+    line2: string | null;
+
+    /**
+     * ZIP or postal code.
+     */
+    postal_code: string | null;
+
+    /**
+     * State/County/Province/Region.
+     */
+    state: string | null;
+  }
+}
+
+/**
+ * Helper schedule to bridge algolia records with internal db
+ */
+export interface IAlgoliaIndexedObject {
+  /**
+   * Where this object is stored in the database
+   */
+  parent: string;
+
+  /**
+   * Algolia objectID required
+   */
+  objectID: string;
+
+
+  /**
+   * Algolia geolocation for a given object
+   */
+  _geoloc?: {
+    lat: number;
+    lng: number;
+  }
+
+}