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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-flow-scripting-api-sdk-javascript",
3
- "version": "0.60.0",
3
+ "version": "0.61.1",
4
4
  "description": "JavaScript library for creating, editing, and managing Genesys Cloud Architect flows",
5
5
  "main": "build-scripting/release/scripting.bundle.js",
6
6
  "author": "Genesys",
package/types.d.ts CHANGED
@@ -83,6 +83,18 @@ export class ArchDataType extends ArchBaseCoreObject {
83
83
  * Returns a localized displayable name string for the data type.
84
84
  */
85
85
  readonly label: string;
86
+ /**
87
+ * If this data type is a custom JSON type, this will return the namespace
88
+ * for it. If this data type is not a custom JSON type, nothing is returned.
89
+ * Valid custom JSON namespaces that can be returned are {@link ArchEnums#CUSTOM_JSON_NAMESPACES}
90
+ */
91
+ readonly customJsonNamespace: string;
92
+ /**
93
+ * If this data type is a custom JSON type, this will return an Architect data
94
+ * type custom JSON schema for it. If this data type is not a custom JSON type,
95
+ * nothing is returned.
96
+ */
97
+ getCustomJsonSchema(): ArchDataTypeJsonCustomSchema;
86
98
  /**
87
99
  * Returns true indicating that this is an ArchBaseCoreObject instance.
88
100
  */
@@ -228,7 +240,6 @@ export class ArchDataTypes extends ArchBaseObject {
228
240
  * array of each of the supported values for a particular enum in this service.
229
241
  */
230
242
  export class ArchEnums {
231
- // constructor();
232
243
  /**
233
244
  * Returns the display name string of 'ArchEnums'.
234
245
  */
@@ -319,6 +330,33 @@ export class ArchEnums {
319
330
  * Returns a string array that contains all valid chooser mode strings.
320
331
  */
321
332
  readonly CHOOSER_PRESENTATION_MODES_ALL: string[];
333
+ /**
334
+ * Returns a JSON object with these properties for whose values are valid custom JSON schema types:
335
+ * ```
336
+ * {
337
+ *   input: 'input'
338
+ *   output: 'output'
339
+ * }
340
+ * ```
341
+ */
342
+ readonly CUSTOM_JSON_SCHEMA_TYPES: {"input":"input","output":"output","error":"error"};
343
+ /**
344
+ * Returns a string array that contains all valid custom JSON schema types.
345
+ */
346
+ readonly CUSTOM_JSON_SCHEMA_TYPES_ALL: string[];
347
+ /**
348
+ * Returns a JSON object with these properties for whose values are valid custom JSON type namespaces:
349
+ * ```
350
+ * {
351
+ *   decisionTable: 'decisionTable'
352
+ * }
353
+ * ```
354
+ */
355
+ readonly CUSTOM_JSON_TYPE_NAMESPACES: {"architect":"architect","decisionTable":"decisionTable","userDefined":"userDefined","worktype":"worktype"};
356
+ /**
357
+ * Returns a string array that contains all valid custom JSON type namespaces.
358
+ */
359
+ readonly CUSTOM_JSON_TYPE_NAMESPACES_ALL: string[];
322
360
  /**
323
361
  * Returns a string array that contains all valid DTMF terminating character options
324
362
  */
@@ -360,7 +398,7 @@ export class ArchEnums {
360
398
  * }
361
399
  * ```
362
400
  */
363
- readonly ERROR_TYPE_DATA_TABLE_VALUES: {"nternalServerError":"DataTablesInternalServerError","erverTooBusyException":"DataTablesServerTooBusyException","yntaxError":"DataTablesSyntaxError","ableNotFoundException":"DataTablesTableNotFoundException"};
401
+ readonly ERROR_TYPE_DATA_TABLE_VALUES: {"internalServerError":"DataTablesInternalServerError","serverTooBusyException":"DataTablesServerTooBusyException","syntaxError":"DataTablesSyntaxError","tableNotFoundException":"DataTablesTableNotFoundException"};
364
402
  /**
365
403
  * Returns a string array that contains all possible data table lookup errorType failure output string values.
366
404
  */
@@ -415,7 +453,7 @@ export class ArchEnums {
415
453
  * }
416
454
  * ```
417
455
  */
418
- readonly FILTER_CONTAINER_OPERATORS: string[];
456
+ readonly FILTER_CONTAINER_OPERATORS: {"and":"and","or":"or"};
419
457
  /**
420
458
  * Returns a string array that contains all valid filter match styles.
421
459
  */
@@ -429,7 +467,7 @@ export class ArchEnums {
429
467
  * }
430
468
  * ```
431
469
  */
432
- readonly FLOW_OUTCOMES: string[];
470
+ readonly FLOW_OUTCOMES: {"success":"SUCCESS","failure":"FAILURE"};
433
471
  /**
434
472
  * Returns a string array that contains all valid flow outcome values for the Set Flow Outcome actions.
435
473
  */
@@ -549,6 +587,21 @@ export class ArchEnums {
549
587
  * Returns a string array that contains all valid knowledge path mode strings.
550
588
  */
551
589
  readonly KNOWLEDGE_PATH_MODES_ALL: string[];
590
+ /**
591
+ * Returns a JSON object with these properties whose values are valid knowledge answer content type strings:
592
+ * ```
593
+ * {
594
+ *   standard: 'standard',
595
+ *   highlight: 'highlight',
596
+ *   generative: 'generative',
597
+ * }
598
+ * ```
599
+ */
600
+ readonly KNOWLEDGE_ANSWER_CONTENT_TYPES: {"standard":"standard","highlight":"highlight","generative":"generative"};
601
+ /**
602
+ * Returns a string array that contains all valid answer content type strings.
603
+ */
604
+ readonly KNOWLEDGE_ANSWER_CONTENT_TYPES_ALL: string[];
552
605
  /**
553
606
  * Returns a JSON object with these properties whose values are valid knowledge settings mode strings.
554
607
  * ```
@@ -618,10 +671,6 @@ export class ArchEnums {
618
671
  * ```
619
672
  */
620
673
  readonly STRING_BODY_HANDLING_TYPES: {"convertToHtml":"convertToHtml","convertToMarkdown":"convertToMarkdown","none":"none","removeAllFormatting":"removeAllFormatting"};
621
- /**
622
- * Returns a string array that contains all valid response body handling types.
623
- */
624
- readonly STRING_BODY_HANDLING_TYPES_ALL: string[];
625
674
  /**
626
675
  * Returns a JSON object with these properties whose values can be used for natural language
627
676
  * understanding response modes.
@@ -884,7 +933,7 @@ export class ArchEnums {
884
933
  /**
885
934
  * Returns a string array that contains all whose values are valid for a SetUUIData Action
886
935
  */
887
- readonly SET_UUI_DATA_MODES_ALL: any;
936
+ readonly SET_UUI_DATA_MODES_ALL: string[];
888
937
  /**
889
938
  * Returns a JSON object with these properties whose values are valid switch action evaluation style strings:
890
939
  * ```
@@ -1028,10 +1077,24 @@ export class ArchOrganizationInfo extends ArchBaseObject {
1028
1077
  * Returns whether Virtual Agent summarization capabilities are available for the organization.
1029
1078
  */
1030
1079
  readonly virtualAgentSummarizationAvailable: boolean;
1080
+ /**
1081
+ * Returns whether large language model (AI) slots are available for use in bot and digital
1082
+ * bot flows for this organization.
1083
+ */
1084
+ readonly botFlowsLLMPoweredSlot: boolean;
1085
+ /**
1086
+ * Returns whether answer generation from a single or multiple knowledge articles in a bot or digital bot flow
1087
+ * is available for this organization.
1088
+ */
1089
+ readonly botFlowsAnswerGeneration: boolean;
1031
1090
  /**
1032
1091
  * Returns whether the Messaging Rich Media Date Picker is available in digital bot flow.
1033
1092
  */
1034
1093
  readonly botFlowsMessagingDatePicker: boolean;
1094
+ /**
1095
+ * Returns whether enhanced recognition failure handling is available in bot or digital bot flows.
1096
+ */
1097
+ readonly botFlowsEnhancedRecognitionFailureHandling: boolean;
1035
1098
  /**
1036
1099
  * Returns whether virtual agent guide is available in bot or digital bot flows.
1037
1100
  */
@@ -2465,6 +2528,13 @@ export class ArchFactoryActions extends ArchBaseFactory {
2465
2528
  * @param [previousArchAction] - the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
2466
2529
  */
2467
2530
  addActionAskSurveyQuestion(archMultiActionContainer: ArchTask | ArchState | ArchActionOutput, name?: string, previousArchAction?: ArchBaseAction): ArchActionAskSurveyQuestion;
2531
+ /**
2532
+ * Adds a Call Agentic Virtual Agent action to a task, state or action output.
2533
+ * @param archMultiActionContainer - the Architect task, state or action output where the new action should be added.
2534
+ * @param [name] - the name for the new action. If not specified, a name will be auto-generated by Architect Scripting based on the action type being created.
2535
+ * @param [previousArchAction] - the previous Architect action in the task, state or action output where the new action should be added. If undefined, the new action will be appended to the task, state or action output.
2536
+ */
2537
+ addActionCallAgenticVirtualAgent(archMultiActionContainer: ArchTask | ArchState | ArchActionOutput, name?: string, previousArchAction?: ArchBaseAction): ArchActionCallAgenticVirtualAgent;
2468
2538
  /**
2469
2539
  * Adds an Audio Monitoring action to an {@link ArchBaseMultiActionContainer} such as an [action output]{@link ArchActionOutput} or [task]{@link ArchTask}.
2470
2540
  * @param archMultiActionContainer - the Architect multi-action container where the new action should be added. For example, an Architect Scripting task or action output where you want the action added.
@@ -2591,6 +2661,27 @@ export class ArchFactoryActions extends ArchBaseFactory {
2591
2661
  addActionShowKnowledgeArticle(archMultiActionContainer: ArchBaseMultiActionContainer, name?: string, previousArchAction?: ArchBaseAction): ArchActionShowKnowledgeArticle;
2592
2662
  }
2593
2663
 
2664
+ /**
2665
+ * A factory instance that lets you add Architect data types to flows.
2666
+ * Do not attempt to create an instance of this class. Architect Scripting will
2667
+ * create the factory instance as needed.
2668
+ */
2669
+ export class ArchFactoryDataTypes extends ArchBaseFactory {
2670
+ /**
2671
+ * Returns the display type name string 'ArchFactoryDataTypes'.
2672
+ */
2673
+ readonly displayTypeName: string;
2674
+ /**
2675
+ * 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,
2676
+ * it will be created.
2677
+ * @param archBaseFlow - the flow where the data type will be created or retrieved.
2678
+ * @param customJsonNamespace - the custom JSON namespace to use for creating the data type. Allowable values are: {@link ArchEnums#CUSTOM_JSON_TYPE_NAMESPACES}
2679
+ * @param entityName - the name of the entity that is being referenced by the custom JSON namespace.
2680
+ * @param customJsonDataTypeSchemaType - the custom JSON schema types to use for creating the data type. Allowable values are: {@link ArchEnums#CUSTOM_JSON_SCHEMA_TYPES}
2681
+ */
2682
+ getOrCreateCustomJsonDataTypeAsync(archBaseFlow: ArchBaseFlow, customJsonNamespace: string, entityName: string, customJsonDataTypeSchemaType: string): void;
2683
+ }
2684
+
2594
2685
  /**
2595
2686
  * A factory instance that lets you create filters. Filters are used for filtering
2596
2687
  * and matching purposes such as when you want to traverse a flow looking for
@@ -4225,6 +4316,11 @@ export class ArchActionAskForBoolean extends ArchBaseActionAsk {
4225
4316
  * Max No Inputs value is exceeded.
4226
4317
  */
4227
4318
  readonly outputMaxNoInputs: ArchActionOutput;
4319
+ /**
4320
+ * The Max No Matches output for this action which will be taken at runtime if the
4321
+ * Max No Matches value is exceeded.
4322
+ */
4323
+ readonly outputMaxNoMatches: ArchActionOutput;
4228
4324
  }
4229
4325
 
4230
4326
  /**
@@ -4397,6 +4493,11 @@ export class ArchActionAskForSlot extends ArchBaseActionAskNoInputNoMatch {
4397
4493
  * Max No Inputs value is exceeded.
4398
4494
  */
4399
4495
  readonly outputMaxNoInputs: ArchActionOutput;
4496
+ /**
4497
+ * The Max No Matches output for this action which will be taken at runtime if the
4498
+ * Max No Matches value is exceeded.
4499
+ */
4500
+ readonly outputMaxNoMatches: ArchActionOutput;
4400
4501
  /**
4401
4502
  * The continuation prompt will be used when an AI LLM Slot is selected with manually managed prompting.
4402
4503
  */
@@ -8762,6 +8863,11 @@ export class ArchActionDigitalMenu extends ArchBaseActionWithOutputs {
8762
8863
  * Max No Inputs value is exceeded.
8763
8864
  */
8764
8865
  readonly outputMaxNoInputs: ArchActionOutput;
8866
+ /**
8867
+ * The Max No Matches output for this action which will be taken at runtime if the
8868
+ * Max No Matches value is exceeded.
8869
+ */
8870
+ readonly outputMaxNoMatches: ArchActionOutput;
8765
8871
  /**
8766
8872
  * The variable that holds the value of the menu choice chosen by the participant.
8767
8873
  * If no choice is selected by the participant, no updates are
@@ -16835,7 +16941,7 @@ export class ArchBaseFlow extends ArchBaseCoreObjectWithId {
16835
16941
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
16836
16942
  * @param callbackFunction - the function to call back with the export information contained
16837
16943
  * in the parameter passed to it.
16838
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
16944
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
16839
16945
  * it will default to the Architect format.
16840
16946
  */
16841
16947
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -17206,7 +17312,7 @@ export class ArchBaseFlowBotWithKnowledge extends ArchBaseFlowBot {
17206
17312
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
17207
17313
  * @param callbackFunction - the function to call back with the export information contained
17208
17314
  * in the parameter passed to it.
17209
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
17315
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
17210
17316
  * it will default to the Architect format.
17211
17317
  */
17212
17318
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -19300,6 +19406,10 @@ export class ArchDefinitionFlow extends ArchBaseDefinition {
19300
19406
  * Returns whether or not this flow type supports default languages.
19301
19407
  */
19302
19408
  readonly supportsDefaultLanguage: boolean;
19409
+ /**
19410
+ * Returns whether or not this flow type supports intent descriptions.
19411
+ */
19412
+ readonly supportsIntentDescriptions: boolean;
19303
19413
  /**
19304
19414
  * Returns whether or not this flow type supports secure variables.
19305
19415
  */
@@ -19906,7 +20016,7 @@ export class ArchFlowBot extends ArchBaseFlowBotWithKnowledge {
19906
20016
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
19907
20017
  * @param callbackFunction - the function to call back with the export information contained
19908
20018
  * in the parameter passed to it.
19909
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
20019
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
19910
20020
  * it will default to the Architect format.
19911
20021
  */
19912
20022
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -20330,7 +20440,7 @@ export class ArchFlowCommonModule extends ArchBaseFlow {
20330
20440
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
20331
20441
  * @param callbackFunction - the function to call back with the export information contained
20332
20442
  * in the parameter passed to it.
20333
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
20443
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
20334
20444
  * it will default to the Architect format.
20335
20445
  */
20336
20446
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -20805,7 +20915,7 @@ export class ArchFlowDigitalBot extends ArchBaseFlowBotWithKnowledge {
20805
20915
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
20806
20916
  * @param callbackFunction - the function to call back with the export information contained
20807
20917
  * in the parameter passed to it.
20808
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
20918
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
20809
20919
  * it will default to the Architect format.
20810
20920
  */
20811
20921
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -21228,7 +21338,7 @@ export class ArchFlowInQueueCall extends ArchBaseFlow {
21228
21338
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
21229
21339
  * @param callbackFunction - the function to call back with the export information contained
21230
21340
  * in the parameter passed to it.
21231
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
21341
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
21232
21342
  * it will default to the Architect format.
21233
21343
  */
21234
21344
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -21672,7 +21782,7 @@ export class ArchFlowInQueueEmail extends ArchBaseFlowWorkflow {
21672
21782
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
21673
21783
  * @param callbackFunction - the function to call back with the export information contained
21674
21784
  * in the parameter passed to it.
21675
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
21785
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
21676
21786
  * it will default to the Architect format.
21677
21787
  */
21678
21788
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -22116,7 +22226,7 @@ export class ArchFlowInQueueShortMessage extends ArchBaseFlowWorkflow {
22116
22226
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
22117
22227
  * @param callbackFunction - the function to call back with the export information contained
22118
22228
  * in the parameter passed to it.
22119
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
22229
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
22120
22230
  * it will default to the Architect format.
22121
22231
  */
22122
22232
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -22586,7 +22696,7 @@ export class ArchFlowInboundCall extends ArchBaseFlowInboundOutboundSecureCall {
22586
22696
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
22587
22697
  * @param callbackFunction - the function to call back with the export information contained
22588
22698
  * in the parameter passed to it.
22589
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
22699
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
22590
22700
  * it will default to the Architect format.
22591
22701
  */
22592
22702
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -23030,7 +23140,7 @@ export class ArchFlowInboundChat extends ArchBaseFlowWorkflow {
23030
23140
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
23031
23141
  * @param callbackFunction - the function to call back with the export information contained
23032
23142
  * in the parameter passed to it.
23033
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
23143
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
23034
23144
  * it will default to the Architect format.
23035
23145
  */
23036
23146
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -23482,7 +23592,7 @@ export class ArchFlowInboundEmail extends ArchBaseFlowWorkflow {
23482
23592
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
23483
23593
  * @param callbackFunction - the function to call back with the export information contained
23484
23594
  * in the parameter passed to it.
23485
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
23595
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
23486
23596
  * it will default to the Architect format.
23487
23597
  */
23488
23598
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -23926,7 +24036,7 @@ export class ArchFlowInboundShortMessage extends ArchBaseFlowWorkflow {
23926
24036
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
23927
24037
  * @param callbackFunction - the function to call back with the export information contained
23928
24038
  * in the parameter passed to it.
23929
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
24039
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
23930
24040
  * it will default to the Architect format.
23931
24041
  */
23932
24042
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -24743,7 +24853,7 @@ export class ArchFlowOutboundCall extends ArchBaseFlowInboundOutboundSecureCall
24743
24853
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
24744
24854
  * @param callbackFunction - the function to call back with the export information contained
24745
24855
  * in the parameter passed to it.
24746
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
24856
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
24747
24857
  * it will default to the Architect format.
24748
24858
  */
24749
24859
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -25213,7 +25323,7 @@ export class ArchFlowSecureCall extends ArchBaseFlowInboundOutboundSecureCall {
25213
25323
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
25214
25324
  * @param callbackFunction - the function to call back with the export information contained
25215
25325
  * in the parameter passed to it.
25216
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
25326
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
25217
25327
  * it will default to the Architect format.
25218
25328
  */
25219
25329
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -25657,7 +25767,7 @@ export class ArchFlowSurveyInvite extends ArchBaseFlowWorkflow {
25657
25767
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
25658
25768
  * @param callbackFunction - the function to call back with the export information contained
25659
25769
  * in the parameter passed to it.
25660
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
25770
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
25661
25771
  * it will default to the Architect format.
25662
25772
  */
25663
25773
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -26127,7 +26237,7 @@ export class ArchFlowVoiceSurvey extends ArchBaseFlowBot {
26127
26237
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
26128
26238
  * @param callbackFunction - the function to call back with the export information contained
26129
26239
  * in the parameter passed to it.
26130
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
26240
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
26131
26241
  * it will default to the Architect format.
26132
26242
  */
26133
26243
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -26593,7 +26703,7 @@ export class ArchFlowVoicemail extends ArchBaseFlowInboundOutboundSecureCall {
26593
26703
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
26594
26704
  * @param callbackFunction - the function to call back with the export information contained
26595
26705
  * in the parameter passed to it.
26596
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
26706
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
26597
26707
  * it will default to the Architect format.
26598
26708
  */
26599
26709
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -27037,7 +27147,7 @@ export class ArchFlowWorkflow extends ArchBaseFlowWorkflow {
27037
27147
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
27038
27148
  * @param callbackFunction - the function to call back with the export information contained
27039
27149
  * in the parameter passed to it.
27040
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
27150
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
27041
27151
  * it will default to the Architect format.
27042
27152
  */
27043
27153
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -27485,7 +27595,7 @@ export class ArchFlowWorkitem extends ArchBaseFlowWorkflow {
27485
27595
  * export would be written if {@link ArchBaseFlow#exportToDirAsync} is called.
27486
27596
  * @param callbackFunction - the function to call back with the export information contained
27487
27597
  * in the parameter passed to it.
27488
- * @param [flowFormat = ArchEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
27598
+ * @param [flowFormat = archEnums.FLOW_FORMAT_TYPES.architect] - the desired export format to use on an export. See {@link ArchEnums#FLOW_FORMAT_TYPES} for allowable export formats. If no format is used,
27489
27599
  * it will default to the Architect format.
27490
27600
  */
27491
27601
  exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<any>;
@@ -28905,6 +29015,14 @@ export class ArchSettingsBotFlow extends ArchBaseCoreObjectWithId {
28905
29015
  * for Virtual Agent functionality to be used at flow runtime.
28906
29016
  */
28907
29017
  virtualAgentEnabled: boolean;
29018
+ /**
29019
+ * Returns true if Agentic Virtual Agent functionality is enabled for this flow, otherwise false.
29020
+ * This property is automatically set to true when the flow contains Call Guide actions (legacy behavior).
29021
+ * TODO: Add support for Call Agentic Virtual Agent actions
29022
+ * Once set to true, it cannot be set back to false.
29023
+ * To downgrade from an agentic flow back to non-agentic (va flow), you must revert to a previous flow version.
29024
+ */
29025
+ readonly agenticVirtualAgentEnabled: boolean;
28908
29026
  }
28909
29027
 
28910
29028
  /**
@@ -29233,6 +29351,12 @@ export class ArchSettingsEventErrorFlowBot extends ArchSettingsEventErrorFlow {
29233
29351
  * The configured reusable task that the flow will jump to when the agent escalation handling is set to 'Jump to Reusable Task'.
29234
29352
  */
29235
29353
  readonly agentEscalationTargetTask: ArchTask;
29354
+ /**
29355
+ * The subsequent recognition failures configured for the flow. The string values in {@link ArchEnums#SUBSEQUENT_RECOGNITION_FAILURES_MODES}
29356
+ * When set to `executeTask`, the bot will continue to execute the recognition failure task for all subsequent recognition failure events.
29357
+ * When set to `exit`, the bot will exit the flow after the first execution of the recognition failure task.
29358
+ */
29359
+ readonly subsequentRecognitionFailuresHandlingType: ArchValueString;
29236
29360
  }
29237
29361
 
29238
29362
  /**
@@ -29668,6 +29792,25 @@ export class ArchSettingsNluKnowledge extends ArchBaseCoreObject {
29668
29792
  * Helper function to set the knowledge path mode to task.
29669
29793
  */
29670
29794
  setKnowledgePathModeTask(): void;
29795
+ /**
29796
+ * The knowledge answer content type determines what behavior will occur when a knowledge article is matched in a Digital Bot Flow.
29797
+ * There are three options; standard, highlight, and generative. Standard will return the entire matched answer. Highlight will
29798
+ * highlight the answer in the matched answer. Generative will create an AI-generated response to the question from the answer.
29799
+ * The string values in {@link ArchEnums#KNOWLEDGE_ANSWER_CONTENT_TYPES}
29800
+ */
29801
+ readonly knowledgeAnswerContentType: ArchValueString;
29802
+ /**
29803
+ * Helper function to set the knowledge answer content type to standard.
29804
+ */
29805
+ setKnowledgeAnswerContentTypeStandard(): void;
29806
+ /**
29807
+ * Helper function to set the knowledge answer content type to highlight.
29808
+ */
29809
+ setKnowledgeAnswerContentTypeHighlight(): void;
29810
+ /**
29811
+ * Helper function to set the knowledge answer content type to generative.
29812
+ */
29813
+ setKnowledgeAnswerContentTypeGenerative(): void;
29671
29814
  /**
29672
29815
  * Controls how knowledge matches are handled at runtime. The custom setting allows you to choose a reusable task that will
29673
29816
  * be executed when a knowledge match occurs. The string values in {@link ArchEnums#KNOWLEDGE_SETTINGS_MODES} list valid values.
@@ -30867,6 +31010,14 @@ export class ArchSettingsVoiceSurveyFlow extends ArchSettingsBotFlow {
30867
31010
  * for Virtual Agent functionality to be used at flow runtime.
30868
31011
  */
30869
31012
  virtualAgentEnabled: boolean;
31013
+ /**
31014
+ * Returns true if Agentic Virtual Agent functionality is enabled for this flow, otherwise false.
31015
+ * This property is automatically set to true when the flow contains Call Guide actions (legacy behavior).
31016
+ * TODO: Add support for Call Agentic Virtual Agent actions
31017
+ * Once set to true, it cannot be set back to false.
31018
+ * To downgrade from an agentic flow back to non-agentic (va flow), you must revert to a previous flow version.
31019
+ */
31020
+ readonly agenticVirtualAgentEnabled: boolean;
30870
31021
  /**
30871
31022
  * The identifier string for this object.
30872
31023
  */
@@ -32695,13 +32846,13 @@ export class ArchNamedValueList extends ArchBaseValueContainer {
32695
32846
  * For example, to retrieve the first named value, pass in 0 assuming there is at least one named
32696
32847
  * value in this instance.
32697
32848
  */
32698
- getNamedValueByIndex(index: number): ArchNamedValue;
32849
+ getNamedValueByIndex<T extends ArchNamedValue | ArchNamedValueList = ArchNamedValue>(index: number): T;
32699
32850
  /**
32700
32851
  * Gets the named value by its name. This is a case sensitive lookup. If the named value cannot be found,
32701
32852
  * nothing is returned.
32702
32853
  * @param valueName - the name of the value.
32703
32854
  */
32704
- getNamedValueByName(valueName: string): ArchNamedValue | ArchNamedValueList;
32855
+ getNamedValueByName<T extends ArchNamedValue | ArchNamedValueList = ArchNamedValue>(valueName: string): T;
32705
32856
  /**
32706
32857
  * Returns true indicating that this is an ArchNamedValueList instance.
32707
32858
  */
@@ -51795,8 +51946,9 @@ export class ArchValueListPicker extends ArchBaseValueWithAssignableProperties {
51795
51946
  * @param receivedMessageSubtitle - the receivedMessageSubtitle of the listPicker
51796
51947
  * @param replyMessageImage - the name of the replyMessageImage
51797
51948
  * @param replyMessageSubtitle - the replyMessageSubtitle of the listPicker
51949
+ * @param receivedMessageButtonText - the receivedMessageButtonText of the listPicker
51798
51950
  */
51799
- setLiteralListPicker(sections: ArchValueListPickerSectionCollection, receivedMessageImage: string, receivedMessageTitle: string, receivedMessageSubtitle: string, replyMessageImage: string, replyMessageSubtitle: string): void;
51951
+ setLiteralListPicker(sections: ArchValueListPickerSectionCollection, receivedMessageImage: string, receivedMessageTitle: string, receivedMessageSubtitle: string, replyMessageImage: string, replyMessageSubtitle: string, receivedMessageButtonText: string): void;
51800
51952
  /**
51801
51953
  * Sets the value to a literal value.
51802
51954
  */