@scout9/admin 1.0.0

package/src/schemas/conversations/context.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+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 {
+
+}

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

@@ -0,0 +1,14 @@
+import { Timestamp } from '../../../common';
+
+/**
+ * When a context field receives uploaded bulk data (csv/excel/json)
+ * scout9-businesses/{businessId}/context/{context}/saves/{save_time}
+ */
+export interface IContextSaves {
+
+  /**
+   * Where the file was saved
+   */
+  ref: string;
+  time: Timestamp
+}

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

@@ -0,0 +1,76 @@
+import { ThreadLanguage } from '../thread';
+
+/**
+ * Used to build NLP models to detect context invocation
+ */
+export interface IContextDetectionParams {
+
+  /**
+   * Key word entities to detect in a contacts message
+   */
+  entities: {
+    /**
+     * @deprecated
+     */
+    utteranceId?: string;
+    option: string;
+    languages: ThreadLanguage[];
+    text: string[];
+  }[];
+
+  /**
+   * Documents or phrases to train the model
+   */
+  documents: {
+    language: ThreadLanguage;
+    text: string;
+    id: string;
+  }[];
+}
+
+/**
+ * scout9-businesses/{businessId}/context/{$id}
+ *
+ * Context field to be used for conversation context and workflows
+ */
+export interface IContext {
+
+  /**
+   * Context $id - this is used to store the context data under the given collection
+   * scout9-businesses/{businessId}/{$id}/{row}
+   */
+  $id: string;
+
+  /**
+   * Name of the context
+   */
+  name: string;
+
+  modifiable: boolean;
+
+  /**
+   * Description of the context
+   */
+  description?: string;
+
+  /**
+   * If provided, this can be used to detect if a given message is invoking this context
+   */
+  detection?: IContextDetectionParams;
+
+  /**
+   * The column that represents the id of a given context row
+   */
+  idColumn: string;
+
+  /**
+   * Column fields that could exist in the context
+   */
+  columns: string[];
+
+  /**
+   * If provided this will enforce that the given columns are required
+   * NOTE: idColumn by default is required
+   */
+  requiredColumns?: string[];
+}

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

@@ -0,0 +1,2 @@
+export * from './context';
+export * from './context-indexed';

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

@@ -0,0 +1,6 @@
+export * from './business';
+export * from './business-location';
+export * from './agents';
+export * from './thread';
+export * from './notifications';
+

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

@@ -0,0 +1,12 @@
+import { Timestamp } from '../../common';
+
+export interface INotification {
+
+  time: Timestamp;
+  read?: Timestamp;
+
+  content: string;
+
+  href: string;
+
+}

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

@@ -0,0 +1,2 @@
+export * from './offer';
+export * from './offer-indexed';

package/src/schemas/users/businesses/offerings/offer-indexed.ts

@@ -0,0 +1,42 @@
+/**
+ * scout9-businesses/{businessId}/offers-indexed/{offerId}
+ * An auto generated offer, when an offer is created it will be indexed in a collection, resolving all stripe and
+ * algolia references.
+ */
+import { IOffer } from './offer';
+
+/**
+ * @deprecated - use Context
+ */
+export interface IOfferIndexed extends IOffer {
+
+  /**
+   * scout9-businesses/{businessId}/offers/{parent}
+   */
+  parent: string;
+
+  /**
+   * Algolia objectID
+   */
+  objectID: string;
+
+
+  /**
+   * Stripe product ID
+   */
+  stripe?: string;
+
+  /**
+   * Stripe product ID for dev
+   */
+  stripeDev?: string;
+
+  /**
+   * Algolia geolocation for the offer, offer is limited to this location at some distance
+   */
+  _geoloc?: {
+    lat: number;
+    lng: number;
+  }
+
+}

package/src/schemas/users/businesses/offerings/offer.ts

@@ -0,0 +1,39 @@
+import { Currency } from '../../../common/currency';
+
+/**
+ * scout9-businesses/{businessId}/offers/{offerId}
+ *
+ * What do you offer to your customers? How can your agents help them?
+ * @deprecated - use Context
+ */
+export interface IOffer {
+  name: string;
+  description: string;
+
+  /**
+   * Tags for the offer to be captured by the AI
+   */
+  tags: string[];
+
+  /**
+   * The price of the offer is either a fixed price or an estimated price range
+   */
+  price: number | [number, number];
+  currency: Currency;
+
+  /**
+   * Media urls for the offer
+   */
+  media?: string[];
+
+  /**
+   * scout9-businesses/{businessId}/locations/{locationId}
+   * If provided, the offer is only limited to these locations.
+   */
+  locations?: string[];
+
+
+  // Stripe IDs for processing payments
+  // stripe?: string;
+  // stripeDev?: string;
+}