@scout9/admin 1.0.0-alpha.0.0.7 → 1.0.0-alpha.0.0.9

package/build/api.d.ts

@@ -2,7 +2,7 @@
  * Scout9 API
  * Scout9 APIs for managing Scout9 users and conversations with your Scout9 agents
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.0-alpha.0.0.9
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -105,6 +105,19 @@ export declare const AgentModelEnum: {
     readonly Null: "null";
 };
 export type AgentModelEnum = typeof AgentModelEnum[keyof typeof AgentModelEnum];
+/**
+ *
+ * @export
+ * @interface AndLogic
+ */
+export interface AndLogic {
+    /**
+     *
+     * @type {Array<Logic>}
+     * @memberof AndLogic
+     */
+    'and': Array<Logic>;
+}
 /**
  * @type AnyValue
  * @export
@@ -170,6 +183,55 @@ export interface BlockInfo {
      */
     'time'?: string;
 }
+/**
+ * @type Condition
+ * @export
+ */
+export type Condition = EqualityCondition | ExistsCondition | RegexCondition;
+/**
+ *
+ * @export
+ * @interface ConditionBase
+ */
+export interface ConditionBase {
+    /**
+     *
+     * @type {string}
+     * @memberof ConditionBase
+     */
+    'path': string;
+    /**
+     *
+     * @type {Operator}
+     * @memberof ConditionBase
+     */
+    'operator': Operator;
+    /**
+     *
+     * @type {any}
+     * @memberof ConditionBase
+     */
+    'value'?: any;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConditionBase
+     */
+    'external'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ConditionLogic
+ */
+export interface ConditionLogic {
+    /**
+     *
+     * @type {Condition}
+     * @memberof ConditionLogic
+     */
+    'condition': Condition;
+}
 /**
  *
  * @export
@@ -200,6 +262,12 @@ export interface Context {
      * @memberof Context
      */
     'detection'?: ContextDetectionParams;
+    /**
+     * The API to use for context detection
+     * @type {string}
+     * @memberof Context
+     */
+    'detectionApi'?: string;
     /**
      * The ID column of the context
      * @type {string}
@@ -218,6 +286,18 @@ export interface Context {
      * @memberof Context
      */
     'requiredColumns'?: Array<string>;
+    /**
+     * Whether or not to force NER
+     * @type {boolean}
+     * @memberof Context
+     */
+    'forceNER'?: boolean;
+    /**
+     *
+     * @type {ContextModel}
+     * @memberof Context
+     */
+    'model'?: ContextModel;
 }
 /**
  *
@@ -227,10 +307,10 @@ export interface Context {
 export interface ContextDetectionDocument {
     /**
      * The languages the entity is available in
-     * @type {Array<string>}
+     * @type {string}
      * @memberof ContextDetectionDocument
      */
-    'languages'?: Array<string>;
+    'language'?: string;
     /**
      *
      * @type {string}
@@ -293,6 +373,12 @@ export interface ContextDetectionParams {
      * @memberof ContextDetectionParams
      */
     'documents': Array<ContextDetectionDocument>;
+    /**
+     * The activation intent of the context
+     * @type {string}
+     * @memberof ContextDetectionParams
+     */
+    'activationIntent'?: string;
     /**
      *
      * @type {Array<ContextDetectionTest>}
@@ -336,13 +422,32 @@ export interface ContextDetectionTestExpected {
      * @type {string}
      * @memberof ContextDetectionTestExpected
      */
-    'intent'?: string;
+    'intent': string;
     /**
      *
      * @type {Array<ParsedContextEntity>}
      * @memberof ContextDetectionTestExpected
      */
-    'entities'?: Array<ParsedContextEntity>;
+    'entities': Array<ParsedContextEntity>;
+}
+/**
+ * The model to use for context detection
+ * @export
+ * @interface ContextModel
+ */
+export interface ContextModel {
+    /**
+     * The last time the model was updated
+     * @type {string}
+     * @memberof ContextModel
+     */
+    'lastUpdate': string;
+    /**
+     * The reference to the model
+     * @type {string}
+     * @memberof ContextModel
+     */
+    'ref': string;
 }
 /**
  * @type ContextRowValue
@@ -529,10 +634,17 @@ export interface ConversationContextField {
      * @memberof ConversationContextField
      */
     'metadata'?: object;
+    /**
+     *
+     * @type {Logic}
+     * @memberof ConversationContextField
+     */
+    'logic'?: Logic;
     /**
      * The conditions of the conversation
      * @type {Array<ConversationContextGroup>}
      * @memberof ConversationContextField
+     * @deprecated
      */
     'conditions'?: Array<ConversationContextGroup>;
     /**
@@ -1431,6 +1543,12 @@ export interface CreateContextRequest {
      * @memberof CreateContextRequest
      */
     'detection'?: ContextDetectionParams;
+    /**
+     * The API to use for context detection
+     * @type {string}
+     * @memberof CreateContextRequest
+     */
+    'detectionApi'?: string;
     /**
      * The ID column of the context
      * @type {string}
@@ -1449,6 +1567,18 @@ export interface CreateContextRequest {
      * @memberof CreateContextRequest
      */
     'requiredColumns'?: Array<string>;
+    /**
+     * Whether or not to force NER
+     * @type {boolean}
+     * @memberof CreateContextRequest
+     */
+    'forceNER'?: boolean;
+    /**
+     *
+     * @type {ContextModel}
+     * @memberof CreateContextRequest
+     */
+    'model'?: ContextModel;
 }
 /**
  *
@@ -1518,6 +1648,12 @@ export interface CreateContextsRequestContextsInner {
      * @memberof CreateContextsRequestContextsInner
      */
     'detection'?: ContextDetectionParams;
+    /**
+     * The API to use for context detection
+     * @type {string}
+     * @memberof CreateContextsRequestContextsInner
+     */
+    'detectionApi'?: string;
     /**
      * The ID column of the context
      * @type {string}
@@ -1536,6 +1672,18 @@ export interface CreateContextsRequestContextsInner {
      * @memberof CreateContextsRequestContextsInner
      */
     'requiredColumns'?: Array<string>;
+    /**
+     * Whether or not to force NER
+     * @type {boolean}
+     * @memberof CreateContextsRequestContextsInner
+     */
+    'forceNER'?: boolean;
+    /**
+     *
+     * @type {ContextModel}
+     * @memberof CreateContextsRequestContextsInner
+     */
+    'model'?: ContextModel;
 }
 /**
  *
@@ -1830,6 +1978,31 @@ export interface CreateCustomersResponse {
      */
     '$operation': string;
 }
+/**
+ *
+ * @export
+ * @interface CreateFileRequestWithStringPurpose
+ */
+export interface CreateFileRequestWithStringPurpose {
+    /**
+     *
+     * @type {File}
+     * @memberof CreateFileRequestWithStringPurpose
+     */
+    'file': File | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateFileRequestWithStringPurpose
+     */
+    'purpose': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateFileRequestWithStringPurpose
+     */
+    'entity': string;
+}
 /**
  *
  * @export
@@ -1884,6 +2057,12 @@ export interface CreateWorkflowRequest {
      * @memberof CreateWorkflowRequest
      */
     'onError'?: string;
+    /**
+     * The priority of the workflow in relation to other workflows (determines activation order)
+     * @type {number}
+     * @memberof CreateWorkflowRequest
+     */
+    'priority': number;
 }
 /**
  *
@@ -1977,6 +2156,12 @@ export interface CreateWorkflowsRequestWorkflowsInner {
      * @memberof CreateWorkflowsRequestWorkflowsInner
      */
     'onError'?: string;
+    /**
+     * The priority of the workflow in relation to other workflows (determines activation order)
+     * @type {number}
+     * @memberof CreateWorkflowsRequestWorkflowsInner
+     */
+    'priority': number;
 }
 /**
  *
@@ -2458,6 +2643,78 @@ export interface DeleteWorkflowsResponse {
      */
     '$operation': string;
 }
+/**
+ *
+ * @export
+ * @interface EqualityCondition
+ */
+export interface EqualityCondition {
+    /**
+     *
+     * @type {string}
+     * @memberof EqualityCondition
+     */
+    'path': string;
+    /**
+     *
+     * @type {EqualityOperator}
+     * @memberof EqualityCondition
+     */
+    'operator': EqualityOperator;
+    /**
+     *
+     * @type {any}
+     * @memberof EqualityCondition
+     */
+    'value': any;
+    /**
+     *
+     * @type {boolean}
+     * @memberof EqualityCondition
+     */
+    'external'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface EqualityConditionAllOf
+ */
+export interface EqualityConditionAllOf {
+    /**
+     *
+     * @type {EqualityOperator}
+     * @memberof EqualityConditionAllOf
+     */
+    'operator': EqualityOperator;
+    /**
+     *
+     * @type {any}
+     * @memberof EqualityConditionAllOf
+     */
+    'value': any;
+}
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const EqualityOperator: {
+    readonly Eq: "eq";
+    readonly Neq: "neq";
+    readonly Gt: "gt";
+    readonly Gte: "gte";
+    readonly Lt: "lt";
+    readonly Lte: "lte";
+    readonly In: "in";
+    readonly Nin: "nin";
+    readonly Contains: "contains";
+    readonly NotContains: "notContains";
+    readonly StartsWith: "startsWith";
+    readonly EndsWith: "endsWith";
+    readonly ArrayContainsAny: "arrayContainsAny";
+    readonly ArrayContains: "arrayContains";
+};
+export type EqualityOperator = typeof EqualityOperator[keyof typeof EqualityOperator];
 /**
  *
  * @export
@@ -2471,6 +2728,60 @@ export interface ErrorResponse {
      */
     'error': Error;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const ExistenceOperator: {
+    readonly Exists: "exists";
+    readonly NotExists: "notExists";
+};
+export type ExistenceOperator = typeof ExistenceOperator[keyof typeof ExistenceOperator];
+/**
+ *
+ * @export
+ * @interface ExistsCondition
+ */
+export interface ExistsCondition {
+    /**
+     *
+     * @type {string}
+     * @memberof ExistsCondition
+     */
+    'path': string;
+    /**
+     *
+     * @type {ExistenceOperator}
+     * @memberof ExistsCondition
+     */
+    'operator': ExistenceOperator;
+    /**
+     *
+     * @type {any}
+     * @memberof ExistsCondition
+     */
+    'value'?: any;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ExistsCondition
+     */
+    'external'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ExistsConditionAllOf
+ */
+export interface ExistsConditionAllOf {
+    /**
+     *
+     * @type {ExistenceOperator}
+     * @memberof ExistsConditionAllOf
+     */
+    'operator': ExistenceOperator;
+}
 /**
  *
  * @export
@@ -2808,6 +3119,12 @@ export interface GetContextResponse {
      * @memberof GetContextResponse
      */
     'detection'?: ContextDetectionParams;
+    /**
+     * The API to use for context detection
+     * @type {string}
+     * @memberof GetContextResponse
+     */
+    'detectionApi'?: string;
     /**
      * The ID column of the context
      * @type {string}
@@ -2826,6 +3143,18 @@ export interface GetContextResponse {
      * @memberof GetContextResponse
      */
     'requiredColumns'?: Array<string>;
+    /**
+     * Whether or not to force NER
+     * @type {boolean}
+     * @memberof GetContextResponse
+     */
+    'forceNER'?: boolean;
+    /**
+     *
+     * @type {ContextModel}
+     * @memberof GetContextResponse
+     */
+    'model'?: ContextModel;
     /**
      * The ID of the context
      * @type {string}
@@ -3098,6 +3427,12 @@ export interface GetWorkflowResponse {
      * @memberof GetWorkflowResponse
      */
     'onError'?: string;
+    /**
+     * The priority of the workflow in relation to other workflows (determines activation order)
+     * @type {number}
+     * @memberof GetWorkflowResponse
+     */
+    'priority': number;
     /**
      * The ID of the workflow
      * @type {string}
@@ -3318,6 +3653,12 @@ export interface ListContextsResponseInner {
      * @memberof ListContextsResponseInner
      */
     'detection'?: ContextDetectionParams;
+    /**
+     * The API to use for context detection
+     * @type {string}
+     * @memberof ListContextsResponseInner
+     */
+    'detectionApi'?: string;
     /**
      * The ID column of the context
      * @type {string}
@@ -3336,6 +3677,18 @@ export interface ListContextsResponseInner {
      * @memberof ListContextsResponseInner
      */
     'requiredColumns'?: Array<string>;
+    /**
+     * Whether or not to force NER
+     * @type {boolean}
+     * @memberof ListContextsResponseInner
+     */
+    'forceNER'?: boolean;
+    /**
+     *
+     * @type {ContextModel}
+     * @memberof ListContextsResponseInner
+     */
+    'model'?: ContextModel;
     /**
      * The ID of the context
      * @type {string}
@@ -3572,6 +3925,12 @@ export interface ListFilesResponse {
      * @memberof ListFilesResponse
      */
     'data': Array<Scout9File>;
+    /**
+     *
+     * @type {PurposeEnum}
+     * @memberof ListFilesResponse
+     */
+    'purpose'?: PurposeEnum;
 }
 /**
  *
@@ -3676,6 +4035,12 @@ export interface ListWorkflowsResponseInner {
      * @memberof ListWorkflowsResponseInner
      */
     'onError'?: string;
+    /**
+     * The priority of the workflow in relation to other workflows (determines activation order)
+     * @type {number}
+     * @memberof ListWorkflowsResponseInner
+     */
+    'priority': number;
     /**
      * The ID of the workflow
      * @type {string}
@@ -3696,6 +4061,11 @@ export interface ListWorkflowsResponseInnerAllOf {
      */
     '$id': string;
 }
+/**
+ * @type Logic
+ * @export
+ */
+export type Logic = AndLogic | ConditionLogic | NotLogic | OrLogic;
 /**
  *
  * @export
@@ -3926,6 +4296,19 @@ export interface ModelError {
      */
     'code': string | null;
 }
+/**
+ *
+ * @export
+ * @interface NotLogic
+ */
+export interface NotLogic {
+    /**
+     *
+     * @type {Logic}
+     * @memberof NotLogic
+     */
+    'not': Logic;
+}
 /**
  *
  * @export
@@ -4003,29 +4386,23 @@ export interface OperationResponse {
     'error'?: Error;
 }
 /**
- * The operator of the condition or query
+ * @type Operator
  * @export
- * @enum {string}
  */
-export declare const Operator: {
-    readonly Eq: "eq";
-    readonly Equal: "equal";
-    readonly Ne: "ne";
-    readonly NotEquals: "not-equals";
-    readonly Gt: "gt";
-    readonly GreaterThan: "greater-than";
-    readonly Gte: "gte";
-    readonly GreaterThanEquals: "greater-than-equals";
-    readonly Lt: "lt";
-    readonly LessThan: "less-than";
-    readonly Lte: "lte";
-    readonly LessThanEquals: "less-than-equals";
-    readonly ArrayContains: "array-contains";
-    readonly In: "in";
-    readonly ArrayContainsAny: "array-contains-any";
-    readonly NotIn: "not-in";
-};
-export type Operator = typeof Operator[keyof typeof Operator];
+export type Operator = EqualityOperator | ExistenceOperator;
+/**
+ *
+ * @export
+ * @interface OrLogic
+ */
+export interface OrLogic {
+    /**
+     *
+     * @type {Array<Logic>}
+     * @memberof OrLogic
+     */
+    'or': Array<Logic>;
+}
 /**
  * @type ParsedContextEntity
  * @export
@@ -4033,6 +4410,42 @@ export type Operator = typeof Operator[keyof typeof Operator];
 export type ParsedContextEntity = string | {
     [key: string]: any;
 };
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const PurposeEnum: {
+    readonly Context: "context";
+    readonly AgentAudio: "agent-audio";
+    readonly AgentTranscript: "agent-transcript";
+};
+export type PurposeEnum = typeof PurposeEnum[keyof typeof PurposeEnum];
+/**
+ *
+ * @export
+ * @interface RegexCondition
+ */
+export interface RegexCondition {
+    /**
+     *
+     * @type {string}
+     * @memberof RegexCondition
+     */
+    'path': string;
+    /**
+     *
+     * @type {string}
+     * @memberof RegexCondition
+     */
+    'regex': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RegexCondition
+     */
+    'external'?: boolean;
+}
 /**
  *
  * @export
@@ -5271,6 +5684,12 @@ export interface UpdateContextRequest {
      * @memberof UpdateContextRequest
      */
     'detection'?: ContextDetectionParams;
+    /**
+     * The API to use for context detection
+     * @type {string}
+     * @memberof UpdateContextRequest
+     */
+    'detectionApi'?: string;
     /**
      * The ID column of the context
      * @type {string}
@@ -5289,6 +5708,18 @@ export interface UpdateContextRequest {
      * @memberof UpdateContextRequest
      */
     'requiredColumns'?: Array<string>;
+    /**
+     * Whether or not to force NER
+     * @type {boolean}
+     * @memberof UpdateContextRequest
+     */
+    'forceNER'?: boolean;
+    /**
+     *
+     * @type {ContextModel}
+     * @memberof UpdateContextRequest
+     */
+    'model'?: ContextModel;
     /**
      * The ID of the context to update
      * @type {string}
@@ -5684,30 +6115,36 @@ export interface UpdateCustomersResponse {
  * @interface UpdateWorkflowRequest
  */
 export interface UpdateWorkflowRequest {
+    /**
+     * The ID of the workflow to update
+     * @type {string}
+     * @memberof UpdateWorkflowRequest
+     */
+    '$id': string;
     /**
      * The name of the workflow
      * @type {string}
      * @memberof UpdateWorkflowRequest
      */
-    'name': string;
+    'name'?: string;
     /**
      *
      * @type {ContextDetectionParams}
      * @memberof UpdateWorkflowRequest
      */
-    'initiators': ContextDetectionParams;
+    'initiators'?: ContextDetectionParams;
     /**
      * The fields of the workflow
      * @type {Array<ConversationContextField>}
      * @memberof UpdateWorkflowRequest
      */
-    'fields': Array<ConversationContextField>;
+    'fields'?: Array<ConversationContextField>;
     /**
      * About this conversation - used as initial context
      * @type {string}
      * @memberof UpdateWorkflowRequest
      */
-    'context': string;
+    'context'?: string;
     /**
      * The webhook to call when a workflow is created
      * @type {string}
@@ -5733,11 +6170,11 @@ export interface UpdateWorkflowRequest {
      */
     'onError'?: string;
     /**
-     * The ID of the workflow to update
-     * @type {string}
+     * The priority of the workflow in relation to other workflows (determines activation order)
+     * @type {number}
      * @memberof UpdateWorkflowRequest
      */
-    '$id': string;
+    'priority'?: number;
 }
 /**
  *
@@ -5863,6 +6300,73 @@ export interface Workflow {
      * @memberof Workflow
      */
     'onError'?: string;
+    /**
+     * The priority of the workflow in relation to other workflows (determines activation order)
+     * @type {number}
+     * @memberof Workflow
+     */
+    'priority': number;
+}
+/**
+ *
+ * @export
+ * @interface WorkflowPartial
+ */
+export interface WorkflowPartial {
+    /**
+     * The name of the workflow
+     * @type {string}
+     * @memberof WorkflowPartial
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {ContextDetectionParams}
+     * @memberof WorkflowPartial
+     */
+    'initiators'?: ContextDetectionParams;
+    /**
+     * The fields of the workflow
+     * @type {Array<ConversationContextField>}
+     * @memberof WorkflowPartial
+     */
+    'fields'?: Array<ConversationContextField>;
+    /**
+     * About this conversation - used as initial context
+     * @type {string}
+     * @memberof WorkflowPartial
+     */
+    'context'?: string;
+    /**
+     * The webhook to call when a workflow is created
+     * @type {string}
+     * @memberof WorkflowPartial
+     */
+    'onCreated'?: string;
+    /**
+     * The webhook to call when a workflow is updated
+     * @type {string}
+     * @memberof WorkflowPartial
+     */
+    'onUpdated'?: string;
+    /**
+     * The webhook to call when a workflow is deleted
+     * @type {string}
+     * @memberof WorkflowPartial
+     */
+    'onDeleted'?: string;
+    /**
+     * The webhook to call when a workflow has an error
+     * @type {string}
+     * @memberof WorkflowPartial
+     */
+    'onError'?: string;
+    /**
+     * The priority of the workflow in relation to other workflows (determines activation order)
+     * @type {number}
+     * @memberof WorkflowPartial
+     */
+    'priority'?: number;
 }
 /**
  * CustomContextApi - axios parameter creator
@@ -6058,7 +6562,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      */
     contextTest: (contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Update a context
      * @summary Update a context
      * @param {UpdateContextRequest} updateContextRequest
      * @param {*} [options] Override http request option.
@@ -6272,11 +6776,12 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      *
      * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
      * @param {File} file
-     * @param {string} [purpose] The intended purpose of the uploaded documents.  This allows us to validate the format of the uploaded file.
+     * @param {PurposeEnum} [purpose]
+     * @param {string} [entity]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    fileCreate: (file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    fileCreate: (file: File | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob, purpose?: PurposeEnum, entity?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Delete a file.
@@ -6607,7 +7112,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      */
     contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextTestResponse>>;
     /**
-     *
+     * Update a context
      * @summary Update a context
      * @param {UpdateContextRequest} updateContextRequest
      * @param {*} [options] Override http request option.
@@ -6821,11 +7326,12 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      *
      * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
      * @param {File} file
-     * @param {string} [purpose] The intended purpose of the uploaded documents.  This allows us to validate the format of the uploaded file.
+     * @param {PurposeEnum} [purpose]
+     * @param {string} [entity]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>>;
+    fileCreate(file: File | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob, purpose?: PurposeEnum, entity?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>>;
     /**
      *
      * @summary Delete a file.
@@ -7156,7 +7662,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      */
     contextTest(contextTestRequest: ContextTestRequest, options?: any): AxiosPromise<ContextTestResponse>;
     /**
-     *
+     * Update a context
      * @summary Update a context
      * @param {UpdateContextRequest} updateContextRequest
      * @param {*} [options] Override http request option.
@@ -7370,11 +7876,12 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      *
      * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
      * @param {File} file
-     * @param {string} [purpose] The intended purpose of the uploaded documents.  This allows us to validate the format of the uploaded file.
+     * @param {PurposeEnum} [purpose]
+     * @param {string} [entity]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    fileCreate(file: File | Buffer | Blob, purpose?: string, options?: any): AxiosPromise<Scout9File>;
+    fileCreate(file: File | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob, purpose?: PurposeEnum, entity?: string, options?: any): AxiosPromise<Scout9File>;
     /**
      *
      * @summary Delete a file.
@@ -7723,7 +8230,7 @@ export declare class Scout9Api extends BaseAPI {
      */
     contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextTestResponse, any>>;
     /**
-     *
+     * Update a context
      * @summary Update a context
      * @param {UpdateContextRequest} updateContextRequest
      * @param {*} [options] Override http request option.
@@ -7963,12 +8470,13 @@ export declare class Scout9Api extends BaseAPI {
      *
      * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
      * @param {File} file
-     * @param {string} [purpose] The intended purpose of the uploaded documents.  This allows us to validate the format of the uploaded file.
+     * @param {PurposeEnum} [purpose]
+     * @param {string} [entity]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof Scout9Api
      */
-    fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
+    fileCreate(file: File | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob | Buffer | Blob, purpose?: PurposeEnum, entity?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
     /**
      *
      * @summary Delete a file.