@scout9/admin 1.0.1 → 1.0.3

package/build/api.d.ts

@@ -1,78 +0,0 @@
-import type { Configuration } from './configuration';
-import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import type { RequestArgs } from './base';
-import { BaseAPI } 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 declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Creates a model response for the given chat conversation.
-     * @param {ICustomerCreateRequest} createCustomerRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createCustomer: (createCustomerRequest: ICustomerCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * Scout9Api - functional programming interface
- * @export
- */
-export declare const Scout9ApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Creates a model response for the given chat conversation.
-     * @param {ICustomerCreateRequest} createCustomerRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createCustomer(createCustomerRequest: ICustomerCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ICustomerCreateResponse>>;
-};
-/**
- * Scout9Api - object-oriented interface
- * @export
- * @class Scout9Api
- * @extends {BaseAPI}
- */
-export declare 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
-     */
-    createCustomer(createCustomerRequest: ICustomerCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ICustomerCreateResponse, any>>;
-}

package/build/api.js

@@ -1,90 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Scout9Api = exports.Scout9ApiFp = exports.Scout9ApiAxiosParamCreator = void 0;
-const axios_1 = __importDefault(require("axios"));
-// Some imports not used depending on template conditions
-// @ts-ignore
-const common_1 = require("./common");
-// @ts-ignore
-const base_1 = require("./base");
-const Scout9ApiAxiosParamCreator = function (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, options = {}) => {
-            // verify required parameter 'createChatCompletionRequest' is not null or undefined
-            (0, common_1.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, common_1.DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
-            const localVarHeaderParameter = {};
-            const localVarQueryParameter = {};
-            localVarHeaderParameter['Content-Type'] = 'application/json';
-            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
-            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createCustomerRequest, localVarRequestOptions, configuration);
-            return {
-                url: (0, common_1.toPathString)(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-    };
-};
-exports.Scout9ApiAxiosParamCreator = Scout9ApiAxiosParamCreator;
-/**
- * Scout9Api - functional programming interface
- * @export
- */
-const Scout9ApiFp = function (configuration) {
-    const localVarAxiosParamCreator = (0, exports.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, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomer(createCustomerRequest, options);
-            return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
-        },
-    };
-};
-exports.Scout9ApiFp = Scout9ApiFp;
-/**
- * Scout9Api - object-oriented interface
- * @export
- * @class Scout9Api
- * @extends {BaseAPI}
- */
-class Scout9Api extends base_1.BaseAPI {
-    /**
-     *
-     * @summary Creates a model response for the given chat conversation.
-     * @param {ICustomerCreateRequest} createCustomerRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof Scout9Api
-     */
-    createCustomer(createCustomerRequest, options) {
-        return (0, exports.Scout9ApiFp)(this.configuration)
-            .createCustomer(createCustomerRequest, options)
-            .then((request) => request(this.axios, this.basePath));
-    }
-}
-exports.Scout9Api = Scout9Api;

package/build/base.d.ts

@@ -1,43 +0,0 @@
-import type { Configuration } from './configuration';
-import type { AxiosInstance, AxiosRequestConfig } from 'axios';
-export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: AxiosRequestConfig;
-}
-/**
- *
- * @export
- * @class BaseAPI
- */
-export declare class BaseAPI {
-    protected basePath: string;
-    protected axios: AxiosInstance;
-    protected configuration: Configuration | undefined;
-    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
-}
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export declare class RequiredError extends Error {
-    field: string;
-    constructor(field: string, msg?: string);
-}

package/build/base.js

@@ -1,52 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
-const axios_1 = __importDefault(require("axios"));
-exports.BASE_PATH = "https://us-central1-jumpstart.cloudfunctions.net".replace(/\/+$/, "");
-/**
- *
- * @export
- */
-exports.COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-/**
- *
- * @export
- * @class BaseAPI
- */
-class BaseAPI {
-    basePath;
-    axios;
-    configuration;
-    constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
-        this.basePath = basePath;
-        this.axios = axios;
-        if (configuration) {
-            this.configuration = configuration;
-            this.basePath = configuration.basePath || this.basePath;
-        }
-    }
-}
-exports.BaseAPI = BaseAPI;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-class RequiredError extends Error {
-    field;
-    constructor(field, msg) {
-        super(msg);
-        this.field = field;
-        this.name = "RequiredError";
-    }
-}
-exports.RequiredError = RequiredError;

package/build/common.d.ts

@@ -1,54 +0,0 @@
-import type { Configuration } from "./configuration";
-import type { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
-export declare const DUMMY_BASE_URL = "https://example.com";
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
-export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
-export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
-export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
-export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/build/common.js

@@ -1,132 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
-const base_1 = require("./base");
-/**
- *
- * @export
- */
-exports.DUMMY_BASE_URL = 'https://example.com';
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-const assertParamExists = function (functionName, paramName, paramValue) {
-    if (paramValue === null || paramValue === undefined) {
-        throw new base_1.RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
-    }
-};
-exports.assertParamExists = assertParamExists;
-/**
- *
- * @export
- */
-const setApiKeyToObject = async function (object, keyParamName, configuration) {
-    if (configuration && configuration.apiKey) {
-        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
-            ? await configuration.apiKey(keyParamName)
-            : await configuration.apiKey;
-        object[keyParamName] = localVarApiKeyValue;
-    }
-};
-exports.setApiKeyToObject = setApiKeyToObject;
-/**
- *
- * @export
- */
-const setBasicAuthToObject = function (object, configuration) {
-    if (configuration && (configuration.username || configuration.password)) {
-        object["auth"] = { username: configuration.username, password: configuration.password };
-    }
-};
-exports.setBasicAuthToObject = setBasicAuthToObject;
-/**
- *
- * @export
- */
-const setBearerAuthToObject = async function (object, configuration) {
-    if (configuration && configuration.accessToken) {
-        const accessToken = typeof configuration.accessToken === 'function'
-            ? await configuration.accessToken()
-            : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + accessToken;
-    }
-};
-exports.setBearerAuthToObject = setBearerAuthToObject;
-/**
- *
- * @export
- */
-const setOAuthToObject = async function (object, name, scopes, configuration) {
-    if (configuration && configuration.accessToken) {
-        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
-            ? await configuration.accessToken(name, scopes)
-            : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
-    }
-};
-exports.setOAuthToObject = setOAuthToObject;
-function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
-    if (parameter == null)
-        return;
-    if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
-            parameter.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
- */
-const setSearchParams = function (url, ...objects) {
-    const searchParams = new URLSearchParams(url.search);
-    setFlattenedQueryParams(searchParams, objects);
-    url.search = searchParams.toString();
-};
-exports.setSearchParams = setSearchParams;
-/**
- *
- * @export
- */
-const serializeDataIfNeeded = function (value, requestOptions, 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 || "");
-};
-exports.serializeDataIfNeeded = serializeDataIfNeeded;
-/**
- *
- * @export
- */
-const toPathString = function (url) {
-    return url.pathname + url.search + url.hash;
-};
-exports.toPathString = toPathString;
-/**
- *
- * @export
- */
-const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
-    return (axios = globalAxios, basePath = BASE_PATH) => {
-        const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url };
-        return axios.request(axiosRequestArgs);
-    };
-};
-exports.createRequestFunction = createRequestFunction;

package/build/configuration.d.ts

@@ -1,84 +0,0 @@
-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 declare 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);
-    /**
-     * 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.
-     */
-    isJsonMime(mime: string): boolean;
-}

package/build/configuration.js

@@ -1,106 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = void 0;
-const packageJson = require("../package.json");
-class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey;
-    /**
-     * Scout9 organization id
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    organization;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken;
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions;
-    /**
-     * 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;
-    /**
-     * The version of the Scout9 API that this client library version is
-     */
-    apiVersion;
-    constructor(param = {}) {
-        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.
-     */
-    isJsonMime(mime) {
-        const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-    }
-}
-exports.Configuration = Configuration;

package/build/index.d.ts

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

package/build/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("./api"), exports);
-__exportStar(require("./configuration"), exports);

package/build/schemas/common/algolia.d.ts

@@ -1,20 +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/build/schemas/common/algolia.js

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