purecloud-flow-scripting-api-sdk-javascript 0.60.0 → 0.61.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "purecloud-flow-scripting-api-sdk-javascript",
-    "version": "0.60.0",
+    "version": "0.61.0",
     "description": "JavaScript library for creating, editing, and managing Genesys Cloud Architect flows",
     "main": "build-scripting/release/scripting.bundle.js",
     "author": "Genesys",

package/types.d.ts

@@ -83,6 +83,18 @@ export class ArchDataType extends ArchBaseCoreObject {
      * Returns a localized displayable name string for the data type.
      */
     readonly label: string;
+    /**
+     * If this data type is a custom JSON type, this will return the namespace
+     * for it.  If this data type is not a custom JSON type, nothing is returned.
+     * Valid custom JSON namespaces that can be returned are {@link ArchEnums#CUSTOM_JSON_NAMESPACES}
+     */
+    readonly customJsonNamespace: string;
+    /**
+     * If this data type is a custom JSON type, this will return an Architect data
+     * type custom JSON schema for it.  If this data type is not a custom JSON type,
+     * nothing is returned.
+     */
+    getCustomJsonSchema(): ArchDataTypeJsonCustomSchema;
     /**
      * Returns true indicating that this is an ArchBaseCoreObject instance.
      */
@@ -319,6 +331,33 @@ export class ArchEnums {
      * Returns a string array that contains all valid chooser mode strings.
      */
     readonly CHOOSER_PRESENTATION_MODES_ALL: string[];
+    /**
+     * Returns a JSON object with these properties for whose values are valid custom JSON schema types:
+     * ```
+     * {
+     *   input: 'input'
+     *   output: 'output'
+     * }
+     * ```
+     */
+    readonly CUSTOM_JSON_SCHEMA_TYPES: {"input":"input","output":"output","error":"error"};
+    /**
+     * Returns a string array that contains all valid custom JSON schema types.
+     */
+    readonly CUSTOM_JSON_SCHEMA_TYPES_ALL: string[];
+    /**
+     * Returns a JSON object with these properties for whose values are valid custom JSON type namespaces:
+     * ```
+     * {
+     *   decisionTable: 'decisionTable'
+     * }
+     * ```
+     */
+    readonly CUSTOM_JSON_TYPE_NAMESPACES: {"architect":"architect","decisionTable":"decisionTable","userDefined":"userDefined","worktype":"worktype"};
+    /**
+     * Returns a string array that contains all valid custom JSON type namespaces.
+     */
+    readonly CUSTOM_JSON_TYPE_NAMESPACES_ALL: string[];
     /**
      * Returns a string array that contains all valid DTMF terminating character options
      */
@@ -549,6 +588,21 @@ export class ArchEnums {
      * Returns a string array that contains all valid knowledge path mode strings.
      */
     readonly KNOWLEDGE_PATH_MODES_ALL: string[];
+    /**
+     * Returns a JSON object with these properties whose values are valid knowledge answer content type strings:
+     * ```
+     * {
+     *   standard:   'standard',
+     *   highlight:  'highlight',
+     *   generative: 'generative',
+     * }
+     * ```
+     */
+    readonly KNOWLEDGE_ANSWER_CONTENT_TYPES: {"standard":"standard","highlight":"highlight","generative":"generative"};
+    /**
+     * Returns a string array that contains all valid answer content type strings.
+     */
+    readonly KNOWLEDGE_ANSWER_CONTENT_TYPES_ALL: string[];
     /**
      * Returns a JSON object with these properties whose values are valid knowledge settings mode strings.
      * ```
@@ -1020,6 +1074,10 @@ export class ArchOrganizationInfo extends ArchBaseObject {
      * Returns true indicating that this is an ArchOrganizationInfo instance.
      */
     readonly isArchOrganizationInfo: boolean;
+    /**
+     * Returns true indicating that agentic virtual agent is available for this ArchOrganizationInfo instance.
+     */
+    readonly agenticVirtualAgentAvailable: boolean;
     /**
      * Returns true indicating that virtual agent is available for this ArchOrganizationInfo instance.
      */
@@ -1028,10 +1086,24 @@ export class ArchOrganizationInfo extends ArchBaseObject {
      * Returns whether Virtual Agent summarization capabilities are available for the organization.
      */
     readonly virtualAgentSummarizationAvailable: boolean;
+    /**
+     * Returns whether large language model (AI) slots are available for use in bot and digital
+     * bot flows for this organization.
+     */
+    readonly botFlowsLLMPoweredSlot: boolean;
+    /**
+     * Returns whether answer generation from a single or multiple knowledge articles in a bot or digital bot flow
+     * is available for this organization.
+     */
+    readonly botFlowsAnswerGeneration: boolean;
     /**
      * Returns whether the Messaging Rich Media Date Picker is available in digital bot flow.
      */
     readonly botFlowsMessagingDatePicker: boolean;
+    /**
+     * Returns whether enhanced recognition failure handling is available in bot or digital bot flows.
+     */
+    readonly botFlowsEnhancedRecognitionFailureHandling: boolean;
     /**
      * Returns whether virtual agent guide is available in bot or digital bot flows.
      */
@@ -2591,6 +2663,27 @@ export class ArchFactoryActions extends ArchBaseFactory {
     addActionShowKnowledgeArticle(archMultiActionContainer: ArchBaseMultiActionContainer, name?: string, previousArchAction?: ArchBaseAction): ArchActionShowKnowledgeArticle;
 }
 
+/**
+ * A factory instance that lets you add Architect data types to flows.
+ * Do not attempt to create an instance of this class.  Architect Scripting will
+ * create the factory instance as needed.
+ */
+export class ArchFactoryDataTypes extends ArchBaseFactory {
+    /**
+     * Returns the display type name string 'ArchFactoryDataTypes'.
+     */
+    readonly displayTypeName: string;
+    /**
+     * Returns the custom JSON data type that is associated with the given [custom JSON namespace]{@link ArchEnums#CUSTOM_JSON_TYPE_NAMESPACES} and entity name. If the data type does not exist within the flow,
+     * it will be created.
+     * @param archBaseFlow - the flow where the data type will be created or retrieved.
+     * @param customJsonNamespace - the custom JSON namespace to use for creating the data type. Allowable values are: {@link ArchEnums#CUSTOM_JSON_TYPE_NAMESPACES}
+     * @param entityName - the name of the entity that is being referenced by the custom JSON namespace.
+     * @param customJsonDataTypeSchemaType - the custom JSON schema types to use for creating the data type. Allowable values are: {@link ArchEnums#CUSTOM_JSON_SCHEMA_TYPES}
+     */
+    getOrCreateCustomJsonDataTypeAsync(archBaseFlow: ArchBaseFlow, customJsonNamespace: string, entityName: string, customJsonDataTypeSchemaType: string): void;
+}
+
 /**
  * A factory instance that lets you create filters.  Filters are used for filtering
  * and matching purposes such as when you want to traverse a flow looking for
@@ -4225,6 +4318,11 @@ export class ArchActionAskForBoolean extends ArchBaseActionAsk {
      * Max No Inputs value is exceeded.
      */
     readonly outputMaxNoInputs: ArchActionOutput;
+    /**
+     * The Max No Matches output for this action which will be taken at runtime if the
+     * Max No Matches value is exceeded.
+     */
+    readonly outputMaxNoMatches: ArchActionOutput;
 }
 
 /**
@@ -4397,6 +4495,11 @@ export class ArchActionAskForSlot extends ArchBaseActionAskNoInputNoMatch {
      * Max No Inputs value is exceeded.
      */
     readonly outputMaxNoInputs: ArchActionOutput;
+    /**
+     * The Max No Matches output for this action which will be taken at runtime if the
+     * Max No Matches value is exceeded.
+     */
+    readonly outputMaxNoMatches: ArchActionOutput;
     /**
      * The continuation prompt will be used when an AI LLM Slot is selected with manually managed prompting.
      */
@@ -8762,6 +8865,11 @@ export class ArchActionDigitalMenu extends ArchBaseActionWithOutputs {
      * Max No Inputs value is exceeded.
      */
     readonly outputMaxNoInputs: ArchActionOutput;
+    /**
+     * The Max No Matches output for this action which will be taken at runtime if the
+     * Max No Matches value is exceeded.
+     */
+    readonly outputMaxNoMatches: ArchActionOutput;
     /**
      * The variable that holds the value of the menu choice chosen by the participant.
      * If no choice is selected by the participant, no updates are
@@ -19300,6 +19408,10 @@ export class ArchDefinitionFlow extends ArchBaseDefinition {
      * Returns whether or not this flow type supports default languages.
      */
     readonly supportsDefaultLanguage: boolean;
+    /**
+     * Returns whether or not this flow type supports intent descriptions.
+     */
+    readonly supportsIntentDescriptions: boolean;
     /**
      * Returns whether or not this flow type supports secure variables.
      */
@@ -28905,6 +29017,12 @@ export class ArchSettingsBotFlow extends ArchBaseCoreObjectWithId {
      * for Virtual Agent functionality to be used at flow runtime.
      */
     virtualAgentEnabled: boolean;
+    /**
+     * Returns true if Agentic Virtual Agent functionality is enabled for this flow, otherwise false.
+     * This property is automatically set to true when the flow contains Call Guide actions and cannot be set back to false.
+     * To downgrade from an agentic flow back to non-agentic (va flow), you must revert to a previous flow version.
+     */
+    readonly agenticVirtualAgentEnabled: boolean;
 }
 
 /**
@@ -29233,6 +29351,12 @@ export class ArchSettingsEventErrorFlowBot extends ArchSettingsEventErrorFlow {
      * The configured reusable task that the flow will jump to when the agent escalation handling is set to 'Jump to Reusable Task'.
      */
     readonly agentEscalationTargetTask: ArchTask;
+    /**
+     * The subsequent recognition failures configured for the flow. The string values in {@link ArchEnums#SUBSEQUENT_RECOGNITION_FAILURES_MODES}
+     * When set to `executeTask`, the bot will continue to execute the recognition failure task for all subsequent recognition failure events.
+     * When set to `exit`, the bot will exit the flow after the first execution of the recognition failure task.
+     */
+    readonly subsequentRecognitionFailuresHandlingType: ArchValueString;
 }
 
 /**
@@ -29668,6 +29792,25 @@ export class ArchSettingsNluKnowledge extends ArchBaseCoreObject {
      * Helper function to set the knowledge path mode to task.
      */
     setKnowledgePathModeTask(): void;
+    /**
+     * The knowledge answer content type determines what behavior will occur when a knowledge article is matched in a Digital Bot Flow.
+     * There are three options; standard, highlight, and generative. Standard will return the entire matched answer. Highlight will
+     * highlight the answer in the matched answer. Generative will create an AI-generated response to the question from the answer.
+     * The string values in {@link ArchEnums#KNOWLEDGE_ANSWER_CONTENT_TYPES}
+     */
+    readonly knowledgeAnswerContentType: ArchValueString;
+    /**
+     * Helper function to set the knowledge answer content type to standard.
+     */
+    setKnowledgeAnswerContentTypeStandard(): void;
+    /**
+     * Helper function to set the knowledge answer content type to highlight.
+     */
+    setKnowledgeAnswerContentTypeHighlight(): void;
+    /**
+     * Helper function to set the knowledge answer content type to generative.
+     */
+    setKnowledgeAnswerContentTypeGenerative(): void;
     /**
      * Controls how knowledge matches are handled at runtime. The custom setting allows you to choose a reusable task that will
      * be executed when a knowledge match occurs. The string values in {@link ArchEnums#KNOWLEDGE_SETTINGS_MODES} list valid values.
@@ -30867,6 +31010,12 @@ export class ArchSettingsVoiceSurveyFlow extends ArchSettingsBotFlow {
      * for Virtual Agent functionality to be used at flow runtime.
      */
     virtualAgentEnabled: boolean;
+    /**
+     * Returns true if Agentic Virtual Agent functionality is enabled for this flow, otherwise false.
+     * This property is automatically set to true when the flow contains Call Guide actions and cannot be set back to false.
+     * To downgrade from an agentic flow back to non-agentic (va flow), you must revert to a previous flow version.
+     */
+    readonly agenticVirtualAgentEnabled: boolean;
     /**
      * The identifier string for this object.
      */
@@ -32695,13 +32844,13 @@ export class ArchNamedValueList extends ArchBaseValueContainer {
      *                         For example, to retrieve the first named value, pass in 0 assuming there is at least one named
      *                         value in this instance.
      */
-    getNamedValueByIndex(index: number): ArchNamedValue;
+    getNamedValueByIndex<T extends ArchNamedValue | ArchNamedValueList = ArchNamedValue>(index: number): T;
     /**
      * Gets the named value by its name.  This is a case sensitive lookup.  If the named value cannot be found,
      * nothing is returned.
      * @param valueName - the name of the value.
      */
-    getNamedValueByName(valueName: string): ArchNamedValue | ArchNamedValueList;
+    getNamedValueByName<T extends ArchNamedValue | ArchNamedValueList = ArchNamedValue>(valueName: string): T;
     /**
      * Returns true indicating that this is an ArchNamedValueList instance.
      */