@scout9/admin 1.0.0 → 1.0.2

package/src/schemas/common/algolia.ts

@@ -1,24 +0,0 @@
-/**
- * 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

@@ -1,35 +0,0 @@
-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

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

package/src/schemas/common/index.ts

@@ -1,6 +0,0 @@
-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

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

package/src/schemas/common/task.ts

@@ -1,26 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,94 +0,0 @@
-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;
-  }
-
-}

package/src/schemas/conversations/context.ts

@@ -1,64 +0,0 @@
-import { Timestamp } from '../common';
-import { ConversationParsed } from './parsed';
-
-/**
- * Used to put 'system' messages into the conversation
- * scout9-conversations/{conversationId}/context/{contextId}
- */
-export interface IConversationContextField {
-  id: string;
-  /**
-   * Gets added to the message under role 'system'
-   */
-  time: Timestamp;
-  context: string;
-  note?: string;
-  metadata?: {[key: string]: any};
-
-  /**
-   * Conditional that need to be met in order for this context to be apart of the conversation
-   */
-  conditions?: IConversationContextGroup[];
-
-  /**
-   * If all conditions are met, then it will trigger the following API keys
-   * If [info.triggers[i]] exists, then it should not trigger
-   */
-  triggers?: string[];
-
-}
-
-/**
- * Used to group context fields together
- */
-export interface IConversationContextGroup {
-  conditions: IConversationContextFieldCondition[];
-}
-
-/**
- * Based on the data from scout9-conversations/{uid}/conversations/{convoId}/info/default
- * Checks to see if that data meets the given condition in order to release the API call
- */
-export interface IConversationContextFieldCondition {
-
-  /**
-   * What field in the conversation info is being checked
-   */
-  key: keyof ConversationParsed;
-
-  /**
-   * Operator to evaluate the info[key] against the conditional value
-   */
-  operator: 'eq' | '==' | 'neq' | '!=' | 'gt' | '>' | 'gte' | '>=' | 'lt' | '<' | 'lte' | '<=' | 'in' | 'nin' | 'exists' | '!!' | 'notExists' | '!' | 'contains' | 'notContains' | 'startsWith' | 'endsWith';
-
-  /**
-   * If provided, it will skip operator check and use the regex to check the value
-   */
-  regex?: string;
-
-  /**
-   * What is the value being checked
-   */
-  value: string | number | boolean | null | string[] | number[] | boolean[];
-
-}

package/src/schemas/conversations/conversation.ts

@@ -1,68 +0,0 @@
-import { Timestamp } from '../common';
-import { EmailServiceType, IThread } from '../users';
-import { ConversationEnvironment } from './message';
-
-export interface IConversationEnvironmentProps {
-
-  subject?: string;
-
-  /**
-   * Used to sync email messages with the conversation
-   *
-   */
-  platformEmailThreadId?: string;
-
-}
-/**
- * scout9-conversations/{conversationId}
- *
- * A two way conversation between a customer and a businesses agents
- */
-export interface IConversation extends Pick<IThread, 'onCreated' | 'onDeleted' | 'onUpdated' | 'onError'> {
-
-  /**
-   * Customer this conversation is with
-   * scout9-businesses/{$business}/customers/{$customer}
-   */
-  $customer: string;
-
-  /**
-   * Business this conversation is with
-   * scout9-businesses/{$businesses}
-   */
-  $business: string;
-
-  /**
-   * Agent assigned to this conversation
-   * scout9-businesses/{$businesses}/agents/{$agents}
-   */
-  $agent: string;
-
-  /**
-   * Thread this conversation is in - this determines what context to pull when loading the conversation
-   * scout9-businesses/{$businesses}/threads/{$threads}
-   */
-  $thread: string;
-
-  /**
-   * When the conversation is created, append these contexts to the conversation
-   */
-  initialContexts?: string[];
-
-
-  initiated: Timestamp;
-
-  /**
-   * What parser functions to run for this conversation, by default will parse core fields
-   */
-  parse?: string[];
-
-
-  /**
-   * What this environment is intended for
-   * Defaults to 'web'
-   */
-  environment?: ConversationEnvironment;
-  environmentProps?: IConversationEnvironmentProps;
-
-}

package/src/schemas/conversations/index.ts

@@ -1,6 +0,0 @@
-export * from './conversation';
-export * from './message';
-export * from './context';
-export * from './parsed';
-export * from './webhook';
-export * from './scheduled-conversation';

package/src/schemas/conversations/message.ts

@@ -1,78 +0,0 @@
-import { ChatCompletionRequestMessage, MessageStatus, Timestamp } from '../common';
-import { IConversationContextField } from './context';
-import { ConversationParsed } from './parsed';
-
-export type ConversationEnvironment = 'phone' | 'web' | 'email';
-
-export interface IConversationMessageEmailProps {
-  /**
-   * The platform that this message was sent from the assigned agent in the conversation
-   * (this is used to help with sync/identification mainly getting the global Message-ID)
-   */
-  platformMessageId?: string;
-
-  /**
-   * The global message id that this message states in email headers 'Message-ID'
-   */
-  globalMessageId?: string;
-}
-
-
-export interface IConversationMessage extends ChatCompletionRequestMessage {
-
-  time: Timestamp;
-
-  contentHtml?: string;
-
-  /**
-   * When the message is created we parse the message for relevant fields
-   */
-  parsed?: ConversationParsed;
-  /**
-   * Time at which the parsed information was processed
-   */
-  parsedLoaded?: Timestamp;
-
-  /**
-   * The message we are replying to
-   */
-  replyTo?: string;
-
-  emailEnvironmentProps?: IConversationMessageEmailProps;
-  smsEnvironmentProps?: {
-    twilioMessageId: string;
-  }
-  /**
-   * @TODO the existence of this field being being perceived as an indication that the message
-   * was recived by the client, this should be changed and handled properly
-   */
-  receipt?: IConversationMessageReceipt;
-
-  /**
-   * @TODO remove this in production as it will bloat the database
-   */
-  context?: IConversationContextField[];
-}
-
-export interface IConversationMessageReceipt {
-  environment: {
-    type: 'phone';
-
-    /**
-     * Twilio message id
-     */
-    sid: string
-    status: MessageStatus;
-  } | {
-    type: 'web';
-  } | {
-    type: 'email';
-
-    status: 'sent' | 'received';
-  };
-  time: Timestamp;
-
-  // Errors
-  error?: string;
-  errorCode?: string;
-}

package/src/schemas/conversations/parsed.ts

@@ -1,5 +0,0 @@
-/**
- * Data gets saved in
- * scout9-conversations/{conversationId}/parsed/default
- */
-export type ConversationParsed = {[field: string]: any}

package/src/schemas/conversations/scheduled-conversation.ts

@@ -1,35 +0,0 @@
-import { Timestamp } from '../common';
-import { IConversation } from './conversation';
-import { ConversationEnvironment } from './message';
-
-/**
- * scout9-scheduled-conversations/{conversationId}
- * When a conversation is scheduled to be sent at a later time
- */
-export interface IScheduledConversation extends IConversation {
-  scheduled: Timestamp;
-  initialMessage: string;
-  initialMessageHtml?: string;
-  sent?: Timestamp;
-
-  /**
-   * Attached to a schedule group
-   * scout9-scheduled-conversation-groups/{groupId}
-   */
-  $group?: string;
-}
-
-/**
- * scout9-scheduled-conversation-groups/{groupId}
- */
-export interface IScheduledGroupConversation extends Omit<IScheduledConversation, '$customer' | 'environment' | '$group'> {
-  customers: {
-    environment: ConversationEnvironment;
-    id: string;
-  }[];
-
-  /**
-   * How much we should delay between schedules, defaults to 15000 (15 seconds)
-   */
-  delay?: number;
-}

package/src/schemas/conversations/webhook.ts

@@ -1,10 +0,0 @@
-import { IConversationMessage } from './message';
-import { ConversationParsed } from './parsed';
-
-export type MessageWebhookType = 'conversation.scheduled' | 'conversation.created' | 'conversation.updated' | 'conversation.deleted' | 'conversation.error' | 'conversation.message.created' | 'conversation.message.updated' | 'conversation.message.deleted' | 'conversation.message.error';
-
-export interface IMessageWebhookResponse {
-  type: MessageWebhookType;
-  parsed?: ConversationParsed;
-  message?: IConversationMessage;
-}

package/src/schemas/index.ts

@@ -1,3 +0,0 @@
-export * from './users';
-export * from './conversations';
-export * from './common';

package/src/schemas/users/businesses/agents/agent.ts

@@ -1,107 +0,0 @@
-/**
- * scout9-businesses/{businessId}/agents/{agentId}
- *
- * An agents is a person who works for a businesses
- */
-export type EmailServiceType = 'sendgrid' | 'gmail' | 'outlook';
-export interface IAgent {
-
-  img?: string;
-  firstName: string;
-  lastName: string;
-
-  inactive?: boolean;
-
-  /**
-   * Programmable phone number from Twilio
-   */
-  programmablePhoneNumber?: string;
-  programmablePhoneNumberSid?: string;
-
-  /**
-   * Email address from Scout9 gmail subdomain
-   */
-  programmableEmail?: 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;
-  // }
-
-  forwardEmail?: string;
-
-  /**
-   * All agents must have a phone number (used to login)
-   */
-  forwardPhone: string;
-
-  /**
-   * Whether or not this agent has been verified by the business.
-   */
-  // verified?: boolean;
-
-  /**
-   * Title of the agent, defaults to "Agent"
-   */
-  title: string;
-
-  /**
-   * In 1 sentence, what does this agent do for customers.
-   */
-  context: string;
-
-  // /**
-  //  * What business does this agents work for?
-  //  * scout9-businesses/{$business}
-  //  */
-  // $business: string;
-
-  /**
-   * If provided, this means they are part of these office locations. If not provided and excludedLocations not
-   * provided, we assume this agents can support all locations.
-   * scout9-businesses/{businessId}/locations/{...includedLocations}
-   */
-  includedLocations?: string[];
-
-  /**
-   * If provided, this will take precedence over includedLocations.
-   * scout9-businesses/{businessId}/locations/{...excludedLocations}
-   */
-  excludedLocations?: string[];
-
-
-  /**
-   * A base64 large string object of the transcript, for example if the agents name is "Jeff", then the decoded transcript would be:
-   *
-   * Format 1:
-   *
-   * Jeff: Hey Bill, so you need help with you car?
-   *
-   * Bill: Yes, I need to get my car fixed
-   *
-   * Jeff: Ok, what's the problem?
-   *
-   * Format 2:
-   *
-   * [Jeff] Hey Bill, so you need help with you car?
-   *
-   * [Bill] Yes, I need to get my car fixed
-   *
-   * [Jeff] Ok, what's the problem?
-   *
-   *
-   *
-   * The agents name "Jeff" must match exact the agents name in the database, otherwise it won't work.
-   */
-  transcript?: string;
-
-  /**
-   * Firebase storage reference to the audio file if available
-   */
-  audioRef?: string;
-
-}

package/src/schemas/users/businesses/agents/auth.ts

@@ -1,8 +0,0 @@
-import { Timestamp } from '../../../common';
-import { ConversationEnvironment } from '../../../conversations';
-
-export interface IAgentReAuth {
-  time: Timestamp;
-  platform: ConversationEnvironment;
-  sent?: Timestamp;
-}

package/src/schemas/users/businesses/agents/index.ts

@@ -1,2 +0,0 @@
-export * from './agent';
-export * from './auth';

package/src/schemas/users/businesses/business-location.ts

@@ -1,15 +0,0 @@
-import { Stripe } from '../../common';
-import { ILocation } from '../../common/location';
-
-
-/**
- * scout9-businesses/{businessId}/locations/{locationId}
- */
-export interface IBusinessLocation extends ILocation, Stripe.Address {
-  name: string;
-
-  areaCodes?: number[] | null;
-
-  twilioAddressSid?: string;
-
-}

package/src/schemas/users/businesses/business.ts

@@ -1,43 +0,0 @@
-/**
- * scout9-businesses/{businessId}
- */
-export interface IBusiness {
-  name: string;
-
-  logo?: string;
-  icon?: string;
-
-  /**
-   * User id of the owner of this account
-   */
-  $owner: string;
-  phone: string;
-  email: string;
-
-  /**
-   * 1 sentence what does this business do?
-   */
-  context: string;
-
-  apiKey?: string;
-
-  website?: string;
-
-  webhookUrl?: string;
-
-
-  /**
-   * Stripe customer ids for charging subscriptions
-   */
-  stripeCustomer?: string;
-  stripeCustomerDev?: string;
-
-  /**
-   * Stripe connect ids for charging customers on behalf of Scout9
-   */
-  stripeConnect?: string;
-  stripeConnectDev?: string;
-
-  twilioAddressSid?: string;
-
-}

package/src/schemas/users/businesses/context/context-indexed.ts

@@ -1,11 +0,0 @@
-import { IAlgoliaIndexedObject } from '../../../common';
-import { IContext } from './context';
-
-/**
- * scout9-businesses/{businessId}/context-indexed/{context}
- * An auto generated context, when a context category is created it will be indexed in a collection, resolving all stripe and
- * algolia references.
- */
-export interface IContextIndexed extends IContext, IAlgoliaIndexedObject {
-
-}