@scout9/admin 1.0.0-alpha.0.0.30 → 1.0.0-alpha.0.0.32

package/build/api.d.ts

@@ -2475,48 +2475,29 @@ export interface EntitiesBuildConfigInner {
 /**
  *
  * @export
- * @interface EntityApiOutput
+ * @interface Entity
  */
-export interface EntityApiOutput {
+export interface Entity {
     /**
      *
-     * @type {number}
-     * @memberof EntityApiOutput
-     */
-    'ms': number;
-    /**
-     *
-     * @type {object}
-     * @memberof EntityApiOutput
+     * @type {string}
+     * @memberof Entity
      */
-    'data'?: object;
-}
-/**
- *
- * @export
- * @interface EntityApiRequest
- */
-export interface EntityApiRequest {
+    'type': string;
     /**
      *
      * @type {string}
-     * @memberof EntityApiRequest
+     * @memberof Entity
      */
-    'entity': string;
+    'id': string;
     /**
      *
-     * @type {{ [key: string]: string; }}
-     * @memberof EntityApiRequest
+     * @type {{ [key: string]: any; }}
+     * @memberof Entity
      */
-    'params': {
-        [key: string]: string;
+    'data': {
+        [key: string]: any;
     };
-    /**
-     *
-     * @type {object}
-     * @memberof EntityApiRequest
-     */
-    'payload'?: object;
 }
 /**
  *
@@ -2625,6 +2606,21 @@ export interface EntityBuildConfigTrainingInner {
      */
     'intent'?: string;
 }
+/**
+ *
+ * @export
+ * @interface EntityData
+ */
+export interface EntityData {
+    /**
+     * Data of the entity
+     * @type {{ [key: string]: any; }}
+     * @memberof EntityData
+     */
+    'data'?: {
+        [key: string]: any;
+    };
+}
 /**
  *
  * @export
@@ -4673,11 +4669,11 @@ export interface ParseRequest {
      */
     'language'?: string;
     /**
-     * If provided, this will override the organizations saved entities (used for app development)
-     * @type {Array<Array<EntitiesBuildConfigInner>>}
+     *
+     * @type {Array<EntitiesBuildConfigInner>}
      * @memberof ParseRequest
      */
-    'entities'?: Array<Array<EntitiesBuildConfigInner>>;
+    'entities'?: Array<EntitiesBuildConfigInner>;
 }
 /**
  * The parsed message
@@ -6921,69 +6917,20 @@ export declare class CustomContextApi extends BaseAPI {
     contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextTestResponse, any>>;
 }
 /**
- * DefaultApi - axios parameter creator
- * @export
- */
-export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
-     * @param {PingRequest} pingRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    ping: (pingRequest: PingRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * DefaultApi - functional programming interface
- * @export
- */
-export declare const DefaultApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
-     * @param {PingRequest} pingRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PingRequest>>;
-};
-/**
- * DefaultApi - factory interface
- * @export
- */
-export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
-     * @param {PingRequest} pingRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    ping(pingRequest: PingRequest, options?: any): AxiosPromise<PingRequest>;
-};
-/**
- * DefaultApi - object-oriented interface
+ * Scout9Api - axios parameter creator
  * @export
- * @class DefaultApi
- * @extends {BaseAPI}
  */
-export declare class DefaultApi extends BaseAPI {
+export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
-     * @param {PingRequest} pingRequest
+     * @summary Create a new entity
+     * @param {string} type
+     * @param {string} id The unique identifier of the entity
+     * @param {EntityData} entityData
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
-    ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PingRequest, any>>;
-}
-/**
- * Scout9Api - axios parameter creator
- * @export
- */
-export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
+    addEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets a agent
@@ -7333,6 +7280,24 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     customersUpdate: (updateCustomersRequest: UpdateCustomersRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes an entity with the specified type and ID.
+     * @summary Delete an entity
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteEntity: (type: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get an entity by type and ID
+     * @param {string} type The type of the entity to fetch
+     * @param {string} id The unique identifier of the entity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    entity: (type: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Returns a file
@@ -7432,6 +7397,14 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     parse: (parseRequest: ParseRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
+     * @param {PingRequest} pingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ping: (pingRequest: PingRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Purchase phone for a given agent.
@@ -7440,6 +7413,16 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     purchasePhone: (purchasePhoneRequest?: PurchasePhoneRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Replaces an existing entity with the specified type and ID with a new entity.
+     * @summary Replace an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Runs your auto-reply app on the Scout9 platform.
@@ -7455,12 +7438,32 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     runPlatformConfig: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates an existing entity with the specified type and ID.
+     * @summary Update an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * Scout9Api - functional programming interface
  * @export
  */
 export declare const Scout9ApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create a new entity
+     * @param {string} type
+     * @param {string} id The unique identifier of the entity
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
     /**
      *
      * @summary Gets a agent
@@ -7810,6 +7813,24 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     customersUpdate(updateCustomersRequest: UpdateCustomersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomersResponse>>;
+    /**
+     * Deletes an entity with the specified type and ID.
+     * @summary Delete an entity
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get an entity by type and ID
+     * @param {string} type The type of the entity to fetch
+     * @param {string} id The unique identifier of the entity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    entity(type: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
     /**
      *
      * @summary Returns a file
@@ -7909,6 +7930,14 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     parse(parseRequest: ParseRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParseResponse>>;
+    /**
+     *
+     * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
+     * @param {PingRequest} pingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PingRequest>>;
     /**
      *
      * @summary Purchase phone for a given agent.
@@ -7917,6 +7946,16 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     purchasePhone(purchasePhoneRequest?: PurchasePhoneRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchasePhoneResponse>>;
+    /**
+     * Replaces an existing entity with the specified type and ID with a new entity.
+     * @summary Replace an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
     /**
      *
      * @summary Runs your auto-reply app on the Scout9 platform.
@@ -7934,12 +7973,32 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
     runPlatformConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
         [key: string]: any;
     }>>;
+    /**
+     * Updates an existing entity with the specified type and ID.
+     * @summary Update an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
 };
 /**
  * Scout9Api - factory interface
  * @export
  */
 export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create a new entity
+     * @param {string} type
+     * @param {string} id The unique identifier of the entity
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
     /**
      *
      * @summary Gets a agent
@@ -8289,6 +8348,24 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     customersUpdate(updateCustomersRequest: UpdateCustomersRequest, options?: any): AxiosPromise<UpdateCustomersResponse>;
+    /**
+     * Deletes an entity with the specified type and ID.
+     * @summary Delete an entity
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteEntity(type: string, id: string, options?: any): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get an entity by type and ID
+     * @param {string} type The type of the entity to fetch
+     * @param {string} id The unique identifier of the entity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    entity(type: string, id: string, options?: any): AxiosPromise<Entity>;
     /**
      *
      * @summary Returns a file
@@ -8388,6 +8465,14 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     parse(parseRequest: ParseRequest, options?: any): AxiosPromise<ParseResponse>;
+    /**
+     *
+     * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
+     * @param {PingRequest} pingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ping(pingRequest: PingRequest, options?: any): AxiosPromise<PingRequest>;
     /**
      *
      * @summary Purchase phone for a given agent.
@@ -8396,6 +8481,16 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     purchasePhone(purchasePhoneRequest?: PurchasePhoneRequest, options?: any): AxiosPromise<PurchasePhoneResponse>;
+    /**
+     * Replaces an existing entity with the specified type and ID with a new entity.
+     * @summary Replace an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    replaceEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
     /**
      *
      * @summary Runs your auto-reply app on the Scout9 platform.
@@ -8413,6 +8508,16 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
     runPlatformConfig(options?: any): AxiosPromise<{
         [key: string]: any;
     }>;
+    /**
+     * Updates an existing entity with the specified type and ID.
+     * @summary Update an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
 };
 /**
  * Scout9Api - object-oriented interface
@@ -8421,6 +8526,17 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
  * @extends {BaseAPI}
  */
 export declare class Scout9Api extends BaseAPI {
+    /**
+     *
+     * @summary Create a new entity
+     * @param {string} type
+     * @param {string} id The unique identifier of the entity
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    addEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
     /**
      *
      * @summary Gets a agent
@@ -8812,6 +8928,26 @@ export declare class Scout9Api extends BaseAPI {
      * @memberof Scout9Api
      */
     customersUpdate(updateCustomersRequest: UpdateCustomersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomersResponse, any>>;
+    /**
+     * Deletes an entity with the specified type and ID.
+     * @summary Delete an entity
+     * @param {string} type
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Get an entity by type and ID
+     * @param {string} type The type of the entity to fetch
+     * @param {string} id The unique identifier of the entity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    entity(type: string, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
     /**
      *
      * @summary Returns a file
@@ -8922,6 +9058,15 @@ export declare class Scout9Api extends BaseAPI {
      * @memberof Scout9Api
      */
     parse(parseRequest: ParseRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ParseResponse, any>>;
+    /**
+     *
+     * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
+     * @param {PingRequest} pingRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PingRequest, any>>;
     /**
      *
      * @summary Purchase phone for a given agent.
@@ -8931,6 +9076,17 @@ export declare class Scout9Api extends BaseAPI {
      * @memberof Scout9Api
      */
     purchasePhone(purchasePhoneRequest?: PurchasePhoneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PurchasePhoneResponse, any>>;
+    /**
+     * Replaces an existing entity with the specified type and ID with a new entity.
+     * @summary Replace an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    replaceEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
     /**
      *
      * @summary Runs your auto-reply app on the Scout9 platform.
@@ -8950,4 +9106,15 @@ export declare class Scout9Api extends BaseAPI {
     runPlatformConfig(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
         [key: string]: any;
     }, any>>;
+    /**
+     * Updates an existing entity with the specified type and ID.
+     * @summary Update an existing entity
+     * @param {string} type
+     * @param {string} id
+     * @param {EntityData} entityData
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
 }