@scout9/admin 1.0.1 → 1.0.3

package/build/schemas/users/businesses/business.d.ts

@@ -1,32 +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/build/schemas/users/businesses/business.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/businesses/context/context-indexed.d.ts

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

package/build/schemas/users/businesses/context/context-indexed.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/businesses/context/context-saves.d.ts

@@ -1,12 +0,0 @@
-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/build/schemas/users/businesses/context/context-saves.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/businesses/context/context.d.ts

@@ -1,64 +0,0 @@
-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/build/schemas/users/businesses/context/context.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/businesses/context/index.d.ts

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

package/build/schemas/users/businesses/context/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./context"), exports);
-__exportStar(require("./context-indexed"), exports);

package/build/schemas/users/businesses/index.d.ts

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

package/build/schemas/users/businesses/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./business"), exports);
-__exportStar(require("./business-location"), exports);
-__exportStar(require("./agents"), exports);
-__exportStar(require("./thread"), exports);
-__exportStar(require("./notifications"), exports);

package/build/schemas/users/businesses/notifications.d.ts

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

package/build/schemas/users/businesses/notifications.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/businesses/offerings/index.d.ts

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

package/build/schemas/users/businesses/offerings/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./offer"), exports);
-__exportStar(require("./offer-indexed"), exports);

package/build/schemas/users/businesses/offerings/offer-indexed.d.ts

@@ -1,34 +0,0 @@
-/**
- * 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/build/schemas/users/businesses/offerings/offer-indexed.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/businesses/offerings/offer.d.ts

@@ -1,29 +0,0 @@
-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[];
-}

package/build/schemas/users/businesses/offerings/offer.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/businesses/thread.d.ts

@@ -1,44 +0,0 @@
-import { IConversationContextField } from '../../conversations';
-import { IContextDetectionParams } from './context';
-/**
- * Languages we support
- */
-export type ThreadLanguage = 'en' | 'es';
-/**
- * Used to initiate conversations
- * scout9-businesses/{businessId}/threads/{threadId}
- */
-export interface IThread {
-    /**
-     * Name of the thread
-     */
-    name: string;
-    /**
-     * Metadata to be used to detect when this conversation should be initiated
-     */
-    initiators: IContextDetectionParams;
-    /**
-     * Fields to be loaded to a conversation
-     */
-    fields: IConversationContextField[];
-    /**
-     * About this conversation - used as initial context
-     */
-    context: string;
-    /**
-     * Public webhook when thread is created
-     */
-    onCreated?: string;
-    /**
-     * Public webhook when thread is updated
-     */
-    onUpdated?: string;
-    /**
-     * Public webhook when thread is deleted
-     */
-    onDeleted?: string;
-    /**
-     * Public webhook when thread has an error
-     */
-    onError?: string;
-}

package/build/schemas/users/businesses/thread.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/customers/customer.d.ts

@@ -1,35 +0,0 @@
-/**
- * If user is blocked, we can't send messages to them, this could happen if the customer has unsubscribed from the business
- */
-import { Stripe, Timestamp } from '../../common';
-export interface IBlockInfo {
-    message: string;
-    time: Timestamp;
-}
-/**
- * scout9-businesses/{$business}/customers/{customerId}
- *
- * Any information that is specific to a customer (not a businesses), the customerId can be used to get the auth details
- * (email/phone)
- */
-export interface ICustomer extends Partial<Stripe.Address> {
-    firstName: string;
-    lastName: string;
-    img?: string;
-    /**
-     * If this is a temp user, delete them after x days
-     */
-    temp?: boolean;
-    neighborhood?: string;
-    neighborhoodName?: string;
-    address?: string;
-    addressStr?: string;
-    blocked?: IBlockInfo;
-    phone?: string;
-    phoneBlocked?: IBlockInfo;
-    email?: string;
-    emailBlocked?: IBlockInfo;
-    joined?: Timestamp;
-    stripe?: string;
-    stripeDev?: string;
-}

package/build/schemas/users/customers/customer.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/schemas/users/customers/index.d.ts

@@ -1 +0,0 @@
-export * from './customer';

package/build/schemas/users/customers/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./customer"), exports);

package/build/schemas/users/index.d.ts

@@ -1,2 +0,0 @@
-export * from './customers';
-export * from './businesses';

package/build/schemas/users/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./customers"), exports);
-__exportStar(require("./businesses"), exports);