purecloud-flow-scripting-api-sdk-javascript 0.62.0 → 0.62.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/build-scripting/release/scripting.bundle.js +1 -1
- package/package.json +1 -1
- package/types.d.ts +332 -117
package/types.d.ts
CHANGED
|
@@ -86,7 +86,7 @@ export class ArchDataType extends ArchBaseCoreObject {
|
|
|
86
86
|
/**
|
|
87
87
|
* If this data type is a custom JSON type, this will return the namespace
|
|
88
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#
|
|
89
|
+
* Valid custom JSON namespaces that can be returned are {@link ArchEnums#CUSTOM_JSON_TYPE_NAMESPACES}
|
|
90
90
|
*/
|
|
91
91
|
readonly customJsonNamespace: string;
|
|
92
92
|
/**
|
|
@@ -357,6 +357,15 @@ export class ArchEnums {
|
|
|
357
357
|
* Returns a string array that contains all valid custom JSON type namespaces.
|
|
358
358
|
*/
|
|
359
359
|
readonly CUSTOM_JSON_TYPE_NAMESPACES_ALL: string[];
|
|
360
|
+
/**
|
|
361
|
+
* Returns a JSON object with these properties for whose values are valid deflect types:
|
|
362
|
+
* ```
|
|
363
|
+
* {
|
|
364
|
+
* SMS: 'SMS'
|
|
365
|
+
* }
|
|
366
|
+
* ```
|
|
367
|
+
*/
|
|
368
|
+
readonly DEFLECT_TYPES: {"sMS":"SMS"};
|
|
360
369
|
/**
|
|
361
370
|
* Returns a string array that contains all valid DTMF terminating character options
|
|
362
371
|
*/
|
|
@@ -2975,7 +2984,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
2975
2984
|
* configuration will be used by Architect Scripting.
|
|
2976
2985
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowBot} instance.
|
|
2977
2986
|
*/
|
|
2978
|
-
createFlowBotAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowBot, flowDivision?: ArchDivision, creationData?: any): Promise<
|
|
2987
|
+
createFlowBotAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowBot, flowDivision?: ArchDivision, creationData?: any): Promise<ArchFlowBot>;
|
|
2979
2988
|
/**
|
|
2980
2989
|
* Creates a new [digital bot flow]{@link ArchFlowBot} flow in memory.
|
|
2981
2990
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3005,7 +3014,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3005
3014
|
* configuration will be used by Architect Scripting.
|
|
3006
3015
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowDigitalBot} instance.
|
|
3007
3016
|
*/
|
|
3008
|
-
createFlowDigitalBotAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowDigitalBot, flowDivision?: ArchDivision, creationData?: any): Promise<
|
|
3017
|
+
createFlowDigitalBotAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowDigitalBot, flowDivision?: ArchDivision, creationData?: any): Promise<ArchFlowDigitalBot>;
|
|
3009
3018
|
/**
|
|
3010
3019
|
* Creates a new [common module]{@link ArchFlowCommonModule} flow in memory.
|
|
3011
3020
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3022,9 +3031,9 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3022
3031
|
* the division's {@link ArchDivision#canAddFlow} property returns true. If not specified,
|
|
3023
3032
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3024
3033
|
* @param [compatibleFlowTypes] - the flow types that can call the common module using a Call Common Module action.
|
|
3025
|
-
* @returns - While this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link
|
|
3034
|
+
* @returns - While this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowCommonModule} instance.
|
|
3026
3035
|
*/
|
|
3027
|
-
createFlowCommonModuleAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowCommonModule, flowDivision?: ArchDivision, compatibleFlowTypes?: string[]): Promise<
|
|
3036
|
+
createFlowCommonModuleAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowCommonModule, flowDivision?: ArchDivision, compatibleFlowTypes?: string[]): Promise<ArchFlowCommonModule>;
|
|
3028
3037
|
/**
|
|
3029
3038
|
* Creates a new [inbound call]{@link ArchFlowInboundCall} flow in memory.
|
|
3030
3039
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3042,7 +3051,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3042
3051
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3043
3052
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowInboundCall} instance.
|
|
3044
3053
|
*/
|
|
3045
|
-
createFlowInboundCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundCall, flowDivision?: ArchDivision): Promise<
|
|
3054
|
+
createFlowInboundCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundCall, flowDivision?: ArchDivision): Promise<ArchFlowInboundCall>;
|
|
3046
3055
|
/**
|
|
3047
3056
|
* Creates a new [outbound call]{@link ArchFlowOutboundCall} flow in memory.
|
|
3048
3057
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3060,7 +3069,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3060
3069
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3061
3070
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowOutboundCall} instance.
|
|
3062
3071
|
*/
|
|
3063
|
-
createFlowOutboundCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowOutboundCall, flowDivision?: ArchDivision): Promise<
|
|
3072
|
+
createFlowOutboundCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowOutboundCall, flowDivision?: ArchDivision): Promise<ArchFlowOutboundCall>;
|
|
3064
3073
|
/**
|
|
3065
3074
|
* Creates a new [in-queue call]{@link ArchFlowInQueueCall} flow in memory.
|
|
3066
3075
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3078,7 +3087,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3078
3087
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3079
3088
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowInQueueCall} instance.
|
|
3080
3089
|
*/
|
|
3081
|
-
createFlowInQueueCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInQueueCall, flowDivision?: ArchDivision): Promise<
|
|
3090
|
+
createFlowInQueueCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInQueueCall, flowDivision?: ArchDivision): Promise<ArchFlowInQueueCall>;
|
|
3082
3091
|
/**
|
|
3083
3092
|
* Creates a new [in-queue email]{@link ArchFlowInQueueEmail} flow in memory.
|
|
3084
3093
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3096,7 +3105,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3096
3105
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3097
3106
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowInQueueEmail} instance.
|
|
3098
3107
|
*/
|
|
3099
|
-
createFlowInQueueEmailAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInQueueEmail, flowDivision?: ArchDivision): Promise<
|
|
3108
|
+
createFlowInQueueEmailAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInQueueEmail, flowDivision?: ArchDivision): Promise<ArchFlowInQueueEmail>;
|
|
3100
3109
|
/**
|
|
3101
3110
|
* Creates a new [in-queue short message]{@link ArchFlowInQueueShortMessage} flow in memory.
|
|
3102
3111
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3114,7 +3123,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3114
3123
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3115
3124
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowInQueueShortMessage} instance.
|
|
3116
3125
|
*/
|
|
3117
|
-
createFlowInQueueShortMessageAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInQueueShortMessage, flowDivision?: ArchDivision): Promise<
|
|
3126
|
+
createFlowInQueueShortMessageAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInQueueShortMessage, flowDivision?: ArchDivision): Promise<ArchFlowInQueueShortMessage>;
|
|
3118
3127
|
/**
|
|
3119
3128
|
* Creates a new [secure call]{@link ArchFlowSecureCall} flow in memory.
|
|
3120
3129
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3132,7 +3141,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3132
3141
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3133
3142
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowSecureCall} instance.
|
|
3134
3143
|
*/
|
|
3135
|
-
createFlowSecureCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowSecureCall, flowDivision?: ArchDivision): Promise<
|
|
3144
|
+
createFlowSecureCallAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowSecureCall, flowDivision?: ArchDivision): Promise<ArchFlowSecureCall>;
|
|
3136
3145
|
/**
|
|
3137
3146
|
* Creates a new [inbound email]{@link ArchFlowInboundEmail} flow in memory.
|
|
3138
3147
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3153,7 +3162,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3153
3162
|
* @param [creationData] - additional creation data that should be used on the flow creation call.
|
|
3154
3163
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowInboundEmail} instance.
|
|
3155
3164
|
*/
|
|
3156
|
-
createFlowInboundEmailAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundEmail, flowDivision?: ArchDivision, creationData?: any): Promise<
|
|
3165
|
+
createFlowInboundEmailAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundEmail, flowDivision?: ArchDivision, creationData?: any): Promise<ArchFlowInboundEmail>;
|
|
3157
3166
|
/**
|
|
3158
3167
|
* Creates a new [inbound message]{@link ArchFlowInboundShortMessage} flow in memory.
|
|
3159
3168
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3174,7 +3183,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3174
3183
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3175
3184
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the newly created {@link ArchFlowInboundShortMessage} object instance.
|
|
3176
3185
|
*/
|
|
3177
|
-
createFlowInboundShortMessageAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundShortMessage, flowDivision?: ArchDivision): Promise<
|
|
3186
|
+
createFlowInboundShortMessageAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundShortMessage, flowDivision?: ArchDivision): Promise<ArchFlowInboundShortMessage>;
|
|
3178
3187
|
/**
|
|
3179
3188
|
* Creates a new [survey invite]{@link ArchFlowSurveyInvite} flow in memory.
|
|
3180
3189
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3194,7 +3203,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3194
3203
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3195
3204
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowSurveyInvite} instance.
|
|
3196
3205
|
*/
|
|
3197
|
-
createFlowSurveyInviteAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowSurveyInvite, flowDivision?: ArchDivision): Promise<
|
|
3206
|
+
createFlowSurveyInviteAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowSurveyInvite, flowDivision?: ArchDivision): Promise<ArchFlowSurveyInvite>;
|
|
3198
3207
|
/**
|
|
3199
3208
|
* Creates a new [inbound chat]{@link ArchFlowInboundChat} flow in memory.
|
|
3200
3209
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3215,7 +3224,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3215
3224
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3216
3225
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the newly created {@link ArchFlowInboundChat} object instance.
|
|
3217
3226
|
*/
|
|
3218
|
-
createFlowInboundChatAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundChat, flowDivision?: ArchDivision): Promise<
|
|
3227
|
+
createFlowInboundChatAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowInboundChat, flowDivision?: ArchDivision): Promise<ArchFlowInboundChat>;
|
|
3219
3228
|
/**
|
|
3220
3229
|
* Creates a new [voicemail flow]{@link ArchFlowVoicemail} in memory. Upon successful creation the callback function that's
|
|
3221
3230
|
* passed in will be called with the newly created Architect flow scripting object. The voicemail flow will have
|
|
@@ -3234,7 +3243,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3234
3243
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3235
3244
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowVoicemail} instance.
|
|
3236
3245
|
*/
|
|
3237
|
-
createFlowVoicemailAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowVoicemail, flowDivision?: ArchDivision): Promise<
|
|
3246
|
+
createFlowVoicemailAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowVoicemail, flowDivision?: ArchDivision): Promise<ArchFlowVoicemail>;
|
|
3238
3247
|
/**
|
|
3239
3248
|
* Creates a new [voiceSurvey]{@link ArchFlowVoiceSurvey} flow in memory.
|
|
3240
3249
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3291,7 +3300,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3291
3300
|
* the division stored in the {@link ArchFactoryFlows#defaultFlowCreationDivision} will be used.
|
|
3292
3301
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchFlowWorkflow} instance.
|
|
3293
3302
|
*/
|
|
3294
|
-
createFlowWorkflowAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowWorkflow, flowDivision?: ArchDivision): Promise<
|
|
3303
|
+
createFlowWorkflowAsync(flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchFlowWorkflow, flowDivision?: ArchDivision): Promise<ArchFlowWorkflow>;
|
|
3295
3304
|
/**
|
|
3296
3305
|
* Creates a new [workitem]{@link ArchFlowWorkitem} flow in memory.
|
|
3297
3306
|
* Upon successful creation the callback function that's passed in will be called with the newly
|
|
@@ -3354,7 +3363,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3354
3363
|
* flow instance.
|
|
3355
3364
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchBaseFlow} instance.
|
|
3356
3365
|
*/
|
|
3357
|
-
loadFlowByFlowNameAsync(flowName: string, flowType: string, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<
|
|
3366
|
+
loadFlowByFlowNameAsync<T extends ArchBaseFlow = ArchBaseFlow>(flowName: string, flowType: string, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<T>;
|
|
3358
3367
|
/**
|
|
3359
3368
|
* Loads a flow with a given id and if found returns an ArchBaseFlow instance for it to the supplied callback function.
|
|
3360
3369
|
* @param flowId - the flow identifier.
|
|
@@ -3367,7 +3376,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3367
3376
|
* flow instance.
|
|
3368
3377
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the ArchBaseFlow instance.
|
|
3369
3378
|
*/
|
|
3370
|
-
loadFlowByFlowIdAsync(flowId: string, flowType: string, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<
|
|
3379
|
+
loadFlowByFlowIdAsync<T extends ArchBaseFlow = ArchBaseFlow>(flowId: string, flowType: string, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<T>;
|
|
3371
3380
|
/**
|
|
3372
3381
|
* Loads the default in-queue call flow and if successful returns an ArchFlowInQueueCall instance for it to the supplied callback function.
|
|
3373
3382
|
* @param [flowVersion = "latest"] - the version of the default in-queue flow to get. Valid values are "latest" to get the latest saved configuration of a flow,
|
|
@@ -3378,7 +3387,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3378
3387
|
* flow instance.
|
|
3379
3388
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the ArchFlowInQueueCall instance.
|
|
3380
3389
|
*/
|
|
3381
|
-
loadFlowDefaultInQueueCallAsync(flowVersion?: string, callbackFunction?: callbackArchFlowInQueueCall): Promise<
|
|
3390
|
+
loadFlowDefaultInQueueCallAsync(flowVersion?: string, callbackFunction?: callbackArchFlowInQueueCall): Promise<ArchFlowInQueueCall>;
|
|
3382
3391
|
/**
|
|
3383
3392
|
* Loads the default voicemail flow and if successful returns an ArchFlowVoicemail instance for it to the supplied callback function.
|
|
3384
3393
|
* @param [flowVersion = "latest"] - the version of the flow to get. Valid values are "latest" to get the latest saved configuration of a flow,
|
|
@@ -3387,9 +3396,9 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3387
3396
|
* @param [callbackFunction] - a callback function to call if the flow can be found on the server by id and type.
|
|
3388
3397
|
* The first parameter passed to the callback function will be the Architect Scripting
|
|
3389
3398
|
* flow instance.
|
|
3390
|
-
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the
|
|
3399
|
+
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the {@link ArchFlowVoicemail} instance.
|
|
3391
3400
|
*/
|
|
3392
|
-
loadFlowDefaultVoicemailAsync(flowVersion?: string, callbackFunction?: callbackArchFlowVoicemail): Promise<
|
|
3401
|
+
loadFlowDefaultVoicemailAsync(flowVersion?: string, callbackFunction?: callbackArchFlowVoicemail): Promise<ArchFlowVoicemail>;
|
|
3393
3402
|
/**
|
|
3394
3403
|
* Loads a flow given an ArchFlowInfo and returns an ArchBaseFlow instance for it to the supplied callback function.
|
|
3395
3404
|
* @param archFlowInfo - flow information for the flow which you wish to load.
|
|
@@ -3401,7 +3410,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3401
3410
|
* flow instance.
|
|
3402
3411
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchBaseFlow} instance.
|
|
3403
3412
|
*/
|
|
3404
|
-
loadFlowByFlowInfoAsync(archFlowInfo: ArchFlowInfo, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<
|
|
3413
|
+
loadFlowByFlowInfoAsync<T extends ArchBaseFlow = ArchBaseFlow>(archFlowInfo: ArchFlowInfo, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<T>;
|
|
3405
3414
|
/**
|
|
3406
3415
|
* Check out a flow with a given name to the current user.
|
|
3407
3416
|
* This function passes an {@link ArchFlowInfoBasic} instance for it to the supplied callback function.
|
|
@@ -3413,7 +3422,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3413
3422
|
* [flow basic information]{@link ArchFlowInfoBasic} instance.
|
|
3414
3423
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchFlowInfoBasic} instance.
|
|
3415
3424
|
*/
|
|
3416
|
-
checkoutFlowByFlowNameAsync(flowName: string, flowType: string, forceUnlock?: boolean, callbackFunction?: callbackArchFlowInfoBasic): Promise<
|
|
3425
|
+
checkoutFlowByFlowNameAsync(flowName: string, flowType: string, forceUnlock?: boolean, callbackFunction?: callbackArchFlowInfoBasic): Promise<ArchFlowInfoBasic>;
|
|
3417
3426
|
/**
|
|
3418
3427
|
* Check out the flow for the given flow id to the current user.
|
|
3419
3428
|
* This function passes an {@link ArchFlowInfoBasic} instance for it to the supplied callback function.
|
|
@@ -3425,7 +3434,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3425
3434
|
* [flow basic information]{@link ArchFlowInfoBasic} instance.
|
|
3426
3435
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchFlowInfoBasic} instance.
|
|
3427
3436
|
*/
|
|
3428
|
-
checkoutFlowByFlowIdAsync(flowId: string, flowType: string, forceUnlock?: boolean, callbackFunction?: callbackArchFlowInfoBasic): Promise<
|
|
3437
|
+
checkoutFlowByFlowIdAsync(flowId: string, flowType: string, forceUnlock?: boolean, callbackFunction?: callbackArchFlowInfoBasic): Promise<ArchFlowInfoBasic>;
|
|
3429
3438
|
/**
|
|
3430
3439
|
* Check out a flow for the supplied flow info to the current user.
|
|
3431
3440
|
* This function passes an {@link ArchFlowInfoBasic} instance for it to the supplied callback function.
|
|
@@ -3436,7 +3445,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3436
3445
|
* [flow basic information]{@link ArchFlowInfoBasic} instance.
|
|
3437
3446
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchFlowInfoBasic} instance.
|
|
3438
3447
|
*/
|
|
3439
|
-
checkoutFlowByFlowInfoAsync(archFlowInfo: ArchFlowInfo, forceUnlock?: boolean, callbackFunction?: callbackArchFlowInfoBasic): Promise<
|
|
3448
|
+
checkoutFlowByFlowInfoAsync(archFlowInfo: ArchFlowInfo, forceUnlock?: boolean, callbackFunction?: callbackArchFlowInfoBasic): Promise<ArchFlowInfoBasic>;
|
|
3440
3449
|
/**
|
|
3441
3450
|
* Unlock a flow for the given flow name.
|
|
3442
3451
|
* This function passes an {@link ArchFlowInfoBasic} instance for it to the supplied callback function.
|
|
@@ -3447,7 +3456,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3447
3456
|
* [flow basic information]{@link ArchFlowInfoBasic} instance.
|
|
3448
3457
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchFlowInfoBasic} instance.
|
|
3449
3458
|
*/
|
|
3450
|
-
unlockFlowByFlowNameAsync(flowName: string, flowType: string, callbackFunction?: callbackArchFlowInfoBasic): Promise<
|
|
3459
|
+
unlockFlowByFlowNameAsync(flowName: string, flowType: string, callbackFunction?: callbackArchFlowInfoBasic): Promise<ArchFlowInfoBasic>;
|
|
3451
3460
|
/**
|
|
3452
3461
|
* Unlock a flow with a given id.
|
|
3453
3462
|
* This function passes an {@link ArchFlowInfoBasic} instance for it to the supplied callback function.
|
|
@@ -3458,7 +3467,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3458
3467
|
* [flow basic information]{@link ArchFlowInfoBasic} instance.
|
|
3459
3468
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchFlowInfoBasic} instance.
|
|
3460
3469
|
*/
|
|
3461
|
-
unlockFlowByFlowIdAsync(flowId: string, flowType: string, callbackFunction?: callbackArchFlowInfoBasic): Promise<
|
|
3470
|
+
unlockFlowByFlowIdAsync(flowId: string, flowType: string, callbackFunction?: callbackArchFlowInfoBasic): Promise<ArchFlowInfoBasic>;
|
|
3462
3471
|
/**
|
|
3463
3472
|
* Unlock the flow for a given [flow info basic]{@link ArchFlowInfoBasic} object.
|
|
3464
3473
|
* This function passes an {@link ArchFlowInfoBasic} instance for it to the supplied callback function.
|
|
@@ -3468,7 +3477,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3468
3477
|
* [flow basic information]{@link ArchFlowInfoBasic} instance.
|
|
3469
3478
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchFlowInfoBasic} instance.
|
|
3470
3479
|
*/
|
|
3471
|
-
unlockFlowByFlowInfoAsync(archFlowInfo: ArchFlowInfo, callbackFunction?: callbackArchFlowInfoBasic): Promise<
|
|
3480
|
+
unlockFlowByFlowInfoAsync(archFlowInfo: ArchFlowInfo, callbackFunction?: callbackArchFlowInfoBasic): Promise<ArchFlowInfoBasic>;
|
|
3472
3481
|
/**
|
|
3473
3482
|
* Checkout and load a flow for the given flow name and type to the current user.
|
|
3474
3483
|
* @param flowName - name of the flow.
|
|
@@ -3482,7 +3491,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3482
3491
|
* flow instance.
|
|
3483
3492
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the {@link ArchBaseFlow} instance.
|
|
3484
3493
|
*/
|
|
3485
|
-
checkoutAndLoadFlowByFlowNameAsync(flowName: string, flowType: string, forceUnlock?: boolean, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<
|
|
3494
|
+
checkoutAndLoadFlowByFlowNameAsync<T extends ArchBaseFlow = ArchBaseFlow>(flowName: string, flowType: string, forceUnlock?: boolean, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<T>;
|
|
3486
3495
|
/**
|
|
3487
3496
|
* Check out and load the flow for the given flow id to the current user.
|
|
3488
3497
|
* @param flowId - the flow identifier.
|
|
@@ -3496,7 +3505,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3496
3505
|
* flow instance.
|
|
3497
3506
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because that callback will be passed the ArchBaseFlow instance.
|
|
3498
3507
|
*/
|
|
3499
|
-
checkoutAndLoadFlowByFlowIdAsync(flowId: string, flowType: string, forceUnlock?: boolean, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<
|
|
3508
|
+
checkoutAndLoadFlowByFlowIdAsync<T extends ArchBaseFlow = ArchBaseFlow>(flowId: string, flowType: string, forceUnlock?: boolean, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<T>;
|
|
3500
3509
|
/**
|
|
3501
3510
|
* Check out and load the flow for a given [flow info]{@link ArchFlowInfo} object to the current user.
|
|
3502
3511
|
* @param archFlowInfo - flow information for the flow which you wish to load and edit.
|
|
@@ -3509,7 +3518,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3509
3518
|
* flow instance.
|
|
3510
3519
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the {@link ArchBaseFlow} instance.
|
|
3511
3520
|
*/
|
|
3512
|
-
checkoutAndLoadFlowByFlowInfoAsync(archFlowInfo: ArchFlowInfo, forceUnlock?: boolean, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<
|
|
3521
|
+
checkoutAndLoadFlowByFlowInfoAsync<T extends ArchBaseFlow = ArchBaseFlow>(archFlowInfo: ArchFlowInfo, forceUnlock?: boolean, flowVersion?: string, callbackFunction?: callbackArchBaseFlow): Promise<T>;
|
|
3513
3522
|
/**
|
|
3514
3523
|
* Creates a new flow instance in memory from the specified flow definition. Calling operations such as {@link ArchBaseFlow#saveAsync} and
|
|
3515
3524
|
* {@link ArchBaseFlow#publishAsync} will create these flows in the cloud. Use the {@link ArchBaseFlow#isCreated}
|
|
@@ -3536,7 +3545,7 @@ export class ArchFactoryFlows extends ArchBaseFactory {
|
|
|
3536
3545
|
* @param [createNluFromSurveyForm] - Whether to auto-generate the NLU domain version from the supplied survey form.
|
|
3537
3546
|
* @returns - while this method returns a promise, you should use the callback function to perform any processing because the callback will be passed the newly created {@link ArchBaseFlow} instance.
|
|
3538
3547
|
*/
|
|
3539
|
-
createFlowFromDefinitionAsync(archDefinitionFlow: ArchDefinitionFlow, flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchBaseFlow, flowDivision?: ArchDivision, creationData?: any, compatibleFlowTypes?: string[], createNluFromSurveyForm?: boolean): Promise<
|
|
3548
|
+
createFlowFromDefinitionAsync<T extends ArchBaseFlow = ArchBaseFlow>(archDefinitionFlow: ArchDefinitionFlow, flowName: string, flowDescription?: string, defaultSupportedLanguage?: ArchLanguage, callbackFunction?: callbackArchBaseFlow, flowDivision?: ArchDivision, creationData?: any, compatibleFlowTypes?: string[], createNluFromSurveyForm?: boolean): Promise<T>;
|
|
3540
3549
|
}
|
|
3541
3550
|
|
|
3542
3551
|
/**
|
|
@@ -16853,7 +16862,17 @@ export class ArchBaseFilterClausePropertyValue extends ArchBaseFilterClause {
|
|
|
16853
16862
|
* and a fileName property that holds the file name that would be used if saved
|
|
16854
16863
|
* from {@link ArchBaseFlow#exportToDirAsync}.
|
|
16855
16864
|
*/
|
|
16856
|
-
declare type callbackExportObject = (exportObject:
|
|
16865
|
+
declare type callbackExportObject = (exportObject: ExportInfoType) => void;
|
|
16866
|
+
|
|
16867
|
+
/**
|
|
16868
|
+
* The type definition for a name and id object for export information.
|
|
16869
|
+
* @property content - the flow export contents
|
|
16870
|
+
* @property fileName - the file name that would be used if saved from {@link ArchBaseFlow#exportToDirAsync}.
|
|
16871
|
+
*/
|
|
16872
|
+
declare type ExportInfoType = {
|
|
16873
|
+
content: string;
|
|
16874
|
+
fileName: string;
|
|
16875
|
+
};
|
|
16857
16876
|
|
|
16858
16877
|
/**
|
|
16859
16878
|
* This callback function type is invoked by Architect Scripting where the callback function is passed a string that
|
|
@@ -16981,7 +17000,7 @@ export class ArchBaseFlow extends ArchBaseCoreObjectWithId {
|
|
|
16981
17000
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
16982
17001
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
16983
17002
|
*/
|
|
16984
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
17003
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
16985
17004
|
/**
|
|
16986
17005
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
16987
17006
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -16992,7 +17011,7 @@ export class ArchBaseFlow extends ArchBaseCoreObjectWithId {
|
|
|
16992
17011
|
* @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,
|
|
16993
17012
|
* it will default to the Architect format.
|
|
16994
17013
|
*/
|
|
16995
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
17014
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
16996
17015
|
/**
|
|
16997
17016
|
* The type of the flow. The string
|
|
16998
17017
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -17022,13 +17041,13 @@ export class ArchBaseFlow extends ArchBaseCoreObjectWithId {
|
|
|
17022
17041
|
* If the variable name cannot be found, nothing is returned.
|
|
17023
17042
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
17024
17043
|
*/
|
|
17025
|
-
getVariableById(variableId: string):
|
|
17044
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
17026
17045
|
/**
|
|
17027
17046
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
17028
17047
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
17029
17048
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
17030
17049
|
*/
|
|
17031
|
-
getVariableByName(variableName: string):
|
|
17050
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
17032
17051
|
/**
|
|
17033
17052
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
17034
17053
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -17352,7 +17371,7 @@ export class ArchBaseFlowBotWithKnowledge extends ArchBaseFlowBot {
|
|
|
17352
17371
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
17353
17372
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
17354
17373
|
*/
|
|
17355
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
17374
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
17356
17375
|
/**
|
|
17357
17376
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
17358
17377
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -17363,7 +17382,7 @@ export class ArchBaseFlowBotWithKnowledge extends ArchBaseFlowBot {
|
|
|
17363
17382
|
* @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,
|
|
17364
17383
|
* it will default to the Architect format.
|
|
17365
17384
|
*/
|
|
17366
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
17385
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
17367
17386
|
/**
|
|
17368
17387
|
* The type of the flow. The string
|
|
17369
17388
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -17393,13 +17412,13 @@ export class ArchBaseFlowBotWithKnowledge extends ArchBaseFlowBot {
|
|
|
17393
17412
|
* If the variable name cannot be found, nothing is returned.
|
|
17394
17413
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
17395
17414
|
*/
|
|
17396
|
-
getVariableById(variableId: string):
|
|
17415
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
17397
17416
|
/**
|
|
17398
17417
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
17399
17418
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
17400
17419
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
17401
17420
|
*/
|
|
17402
|
-
getVariableByName(variableName: string):
|
|
17421
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
17403
17422
|
/**
|
|
17404
17423
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
17405
17424
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -24371,7 +24390,7 @@ export class ArchFlowBot extends ArchBaseFlowBotWithKnowledge {
|
|
|
24371
24390
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
24372
24391
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
24373
24392
|
*/
|
|
24374
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
24393
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
24375
24394
|
/**
|
|
24376
24395
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
24377
24396
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -24382,7 +24401,7 @@ export class ArchFlowBot extends ArchBaseFlowBotWithKnowledge {
|
|
|
24382
24401
|
* @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,
|
|
24383
24402
|
* it will default to the Architect format.
|
|
24384
24403
|
*/
|
|
24385
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
24404
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
24386
24405
|
/**
|
|
24387
24406
|
* The type of the flow. The string
|
|
24388
24407
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -24412,13 +24431,13 @@ export class ArchFlowBot extends ArchBaseFlowBotWithKnowledge {
|
|
|
24412
24431
|
* If the variable name cannot be found, nothing is returned.
|
|
24413
24432
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
24414
24433
|
*/
|
|
24415
|
-
getVariableById(variableId: string):
|
|
24434
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
24416
24435
|
/**
|
|
24417
24436
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
24418
24437
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
24419
24438
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
24420
24439
|
*/
|
|
24421
|
-
getVariableByName(variableName: string):
|
|
24440
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
24422
24441
|
/**
|
|
24423
24442
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
24424
24443
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -24795,7 +24814,7 @@ export class ArchFlowCommonModule extends ArchBaseFlow {
|
|
|
24795
24814
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
24796
24815
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
24797
24816
|
*/
|
|
24798
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
24817
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
24799
24818
|
/**
|
|
24800
24819
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
24801
24820
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -24806,7 +24825,7 @@ export class ArchFlowCommonModule extends ArchBaseFlow {
|
|
|
24806
24825
|
* @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,
|
|
24807
24826
|
* it will default to the Architect format.
|
|
24808
24827
|
*/
|
|
24809
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
24828
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
24810
24829
|
/**
|
|
24811
24830
|
* The type of the flow. The string
|
|
24812
24831
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -24836,13 +24855,13 @@ export class ArchFlowCommonModule extends ArchBaseFlow {
|
|
|
24836
24855
|
* If the variable name cannot be found, nothing is returned.
|
|
24837
24856
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
24838
24857
|
*/
|
|
24839
|
-
getVariableById(variableId: string):
|
|
24858
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
24840
24859
|
/**
|
|
24841
24860
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
24842
24861
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
24843
24862
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
24844
24863
|
*/
|
|
24845
|
-
getVariableByName(variableName: string):
|
|
24864
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
24846
24865
|
/**
|
|
24847
24866
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
24848
24867
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -25270,7 +25289,7 @@ export class ArchFlowDigitalBot extends ArchBaseFlowBotWithKnowledge {
|
|
|
25270
25289
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
25271
25290
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
25272
25291
|
*/
|
|
25273
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
25292
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
25274
25293
|
/**
|
|
25275
25294
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
25276
25295
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -25281,7 +25300,7 @@ export class ArchFlowDigitalBot extends ArchBaseFlowBotWithKnowledge {
|
|
|
25281
25300
|
* @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,
|
|
25282
25301
|
* it will default to the Architect format.
|
|
25283
25302
|
*/
|
|
25284
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
25303
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
25285
25304
|
/**
|
|
25286
25305
|
* The type of the flow. The string
|
|
25287
25306
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -25311,13 +25330,13 @@ export class ArchFlowDigitalBot extends ArchBaseFlowBotWithKnowledge {
|
|
|
25311
25330
|
* If the variable name cannot be found, nothing is returned.
|
|
25312
25331
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
25313
25332
|
*/
|
|
25314
|
-
getVariableById(variableId: string):
|
|
25333
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
25315
25334
|
/**
|
|
25316
25335
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
25317
25336
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
25318
25337
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
25319
25338
|
*/
|
|
25320
|
-
getVariableByName(variableName: string):
|
|
25339
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
25321
25340
|
/**
|
|
25322
25341
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
25323
25342
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -25693,7 +25712,7 @@ export class ArchFlowInQueueCall extends ArchBaseFlow {
|
|
|
25693
25712
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
25694
25713
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
25695
25714
|
*/
|
|
25696
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
25715
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
25697
25716
|
/**
|
|
25698
25717
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
25699
25718
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -25704,7 +25723,7 @@ export class ArchFlowInQueueCall extends ArchBaseFlow {
|
|
|
25704
25723
|
* @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,
|
|
25705
25724
|
* it will default to the Architect format.
|
|
25706
25725
|
*/
|
|
25707
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
25726
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
25708
25727
|
/**
|
|
25709
25728
|
* The type of the flow. The string
|
|
25710
25729
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -25734,13 +25753,13 @@ export class ArchFlowInQueueCall extends ArchBaseFlow {
|
|
|
25734
25753
|
* If the variable name cannot be found, nothing is returned.
|
|
25735
25754
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
25736
25755
|
*/
|
|
25737
|
-
getVariableById(variableId: string):
|
|
25756
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
25738
25757
|
/**
|
|
25739
25758
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
25740
25759
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
25741
25760
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
25742
25761
|
*/
|
|
25743
|
-
getVariableByName(variableName: string):
|
|
25762
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
25744
25763
|
/**
|
|
25745
25764
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
25746
25765
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -26148,7 +26167,7 @@ export class ArchFlowInQueueEmail extends ArchBaseFlowInQueueWorkflow {
|
|
|
26148
26167
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
26149
26168
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
26150
26169
|
*/
|
|
26151
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
26170
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
26152
26171
|
/**
|
|
26153
26172
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
26154
26173
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -26159,7 +26178,7 @@ export class ArchFlowInQueueEmail extends ArchBaseFlowInQueueWorkflow {
|
|
|
26159
26178
|
* @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,
|
|
26160
26179
|
* it will default to the Architect format.
|
|
26161
26180
|
*/
|
|
26162
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
26181
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
26163
26182
|
/**
|
|
26164
26183
|
* The type of the flow. The string
|
|
26165
26184
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -26189,13 +26208,13 @@ export class ArchFlowInQueueEmail extends ArchBaseFlowInQueueWorkflow {
|
|
|
26189
26208
|
* If the variable name cannot be found, nothing is returned.
|
|
26190
26209
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
26191
26210
|
*/
|
|
26192
|
-
getVariableById(variableId: string):
|
|
26211
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
26193
26212
|
/**
|
|
26194
26213
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
26195
26214
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
26196
26215
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
26197
26216
|
*/
|
|
26198
|
-
getVariableByName(variableName: string):
|
|
26217
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
26199
26218
|
/**
|
|
26200
26219
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
26201
26220
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -26603,7 +26622,7 @@ export class ArchFlowInQueueShortMessage extends ArchBaseFlowInQueueWorkflow {
|
|
|
26603
26622
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
26604
26623
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
26605
26624
|
*/
|
|
26606
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
26625
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
26607
26626
|
/**
|
|
26608
26627
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
26609
26628
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -26614,7 +26633,7 @@ export class ArchFlowInQueueShortMessage extends ArchBaseFlowInQueueWorkflow {
|
|
|
26614
26633
|
* @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,
|
|
26615
26634
|
* it will default to the Architect format.
|
|
26616
26635
|
*/
|
|
26617
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
26636
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
26618
26637
|
/**
|
|
26619
26638
|
* The type of the flow. The string
|
|
26620
26639
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -26644,13 +26663,13 @@ export class ArchFlowInQueueShortMessage extends ArchBaseFlowInQueueWorkflow {
|
|
|
26644
26663
|
* If the variable name cannot be found, nothing is returned.
|
|
26645
26664
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
26646
26665
|
*/
|
|
26647
|
-
getVariableById(variableId: string):
|
|
26666
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
26648
26667
|
/**
|
|
26649
26668
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
26650
26669
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
26651
26670
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
26652
26671
|
*/
|
|
26653
|
-
getVariableByName(variableName: string):
|
|
26672
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
26654
26673
|
/**
|
|
26655
26674
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
26656
26675
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -27073,7 +27092,7 @@ export class ArchFlowInboundCall extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
27073
27092
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
27074
27093
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
27075
27094
|
*/
|
|
27076
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
27095
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
27077
27096
|
/**
|
|
27078
27097
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
27079
27098
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -27084,7 +27103,7 @@ export class ArchFlowInboundCall extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
27084
27103
|
* @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,
|
|
27085
27104
|
* it will default to the Architect format.
|
|
27086
27105
|
*/
|
|
27087
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
27106
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
27088
27107
|
/**
|
|
27089
27108
|
* The type of the flow. The string
|
|
27090
27109
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -27114,13 +27133,13 @@ export class ArchFlowInboundCall extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
27114
27133
|
* If the variable name cannot be found, nothing is returned.
|
|
27115
27134
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
27116
27135
|
*/
|
|
27117
|
-
getVariableById(variableId: string):
|
|
27136
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
27118
27137
|
/**
|
|
27119
27138
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
27120
27139
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
27121
27140
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
27122
27141
|
*/
|
|
27123
|
-
getVariableByName(variableName: string):
|
|
27142
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
27124
27143
|
/**
|
|
27125
27144
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
27126
27145
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -27517,7 +27536,7 @@ export class ArchFlowInboundChat extends ArchBaseFlowWorkflow {
|
|
|
27517
27536
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
27518
27537
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
27519
27538
|
*/
|
|
27520
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
27539
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
27521
27540
|
/**
|
|
27522
27541
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
27523
27542
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -27528,7 +27547,7 @@ export class ArchFlowInboundChat extends ArchBaseFlowWorkflow {
|
|
|
27528
27547
|
* @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,
|
|
27529
27548
|
* it will default to the Architect format.
|
|
27530
27549
|
*/
|
|
27531
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
27550
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
27532
27551
|
/**
|
|
27533
27552
|
* The type of the flow. The string
|
|
27534
27553
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -27558,13 +27577,13 @@ export class ArchFlowInboundChat extends ArchBaseFlowWorkflow {
|
|
|
27558
27577
|
* If the variable name cannot be found, nothing is returned.
|
|
27559
27578
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
27560
27579
|
*/
|
|
27561
|
-
getVariableById(variableId: string):
|
|
27580
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
27562
27581
|
/**
|
|
27563
27582
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
27564
27583
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
27565
27584
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
27566
27585
|
*/
|
|
27567
|
-
getVariableByName(variableName: string):
|
|
27586
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
27568
27587
|
/**
|
|
27569
27588
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
27570
27589
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -27969,7 +27988,7 @@ export class ArchFlowInboundEmail extends ArchBaseFlowWorkflow {
|
|
|
27969
27988
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
27970
27989
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
27971
27990
|
*/
|
|
27972
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
27991
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
27973
27992
|
/**
|
|
27974
27993
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
27975
27994
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -27980,7 +27999,7 @@ export class ArchFlowInboundEmail extends ArchBaseFlowWorkflow {
|
|
|
27980
27999
|
* @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,
|
|
27981
28000
|
* it will default to the Architect format.
|
|
27982
28001
|
*/
|
|
27983
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
28002
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
27984
28003
|
/**
|
|
27985
28004
|
* The type of the flow. The string
|
|
27986
28005
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -28010,13 +28029,13 @@ export class ArchFlowInboundEmail extends ArchBaseFlowWorkflow {
|
|
|
28010
28029
|
* If the variable name cannot be found, nothing is returned.
|
|
28011
28030
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
28012
28031
|
*/
|
|
28013
|
-
getVariableById(variableId: string):
|
|
28032
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
28014
28033
|
/**
|
|
28015
28034
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
28016
28035
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
28017
28036
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
28018
28037
|
*/
|
|
28019
|
-
getVariableByName(variableName: string):
|
|
28038
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
28020
28039
|
/**
|
|
28021
28040
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
28022
28041
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -28413,7 +28432,7 @@ export class ArchFlowInboundShortMessage extends ArchBaseFlowWorkflow {
|
|
|
28413
28432
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
28414
28433
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
28415
28434
|
*/
|
|
28416
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
28435
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
28417
28436
|
/**
|
|
28418
28437
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
28419
28438
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -28424,7 +28443,7 @@ export class ArchFlowInboundShortMessage extends ArchBaseFlowWorkflow {
|
|
|
28424
28443
|
* @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,
|
|
28425
28444
|
* it will default to the Architect format.
|
|
28426
28445
|
*/
|
|
28427
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
28446
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
28428
28447
|
/**
|
|
28429
28448
|
* The type of the flow. The string
|
|
28430
28449
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -28454,13 +28473,13 @@ export class ArchFlowInboundShortMessage extends ArchBaseFlowWorkflow {
|
|
|
28454
28473
|
* If the variable name cannot be found, nothing is returned.
|
|
28455
28474
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
28456
28475
|
*/
|
|
28457
|
-
getVariableById(variableId: string):
|
|
28476
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
28458
28477
|
/**
|
|
28459
28478
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
28460
28479
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
28461
28480
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
28462
28481
|
*/
|
|
28463
|
-
getVariableByName(variableName: string):
|
|
28482
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
28464
28483
|
/**
|
|
28465
28484
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
28466
28485
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -29230,7 +29249,7 @@ export class ArchFlowOutboundCall extends ArchBaseFlowInboundOutboundSecureCall
|
|
|
29230
29249
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
29231
29250
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
29232
29251
|
*/
|
|
29233
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
29252
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
29234
29253
|
/**
|
|
29235
29254
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
29236
29255
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -29241,7 +29260,7 @@ export class ArchFlowOutboundCall extends ArchBaseFlowInboundOutboundSecureCall
|
|
|
29241
29260
|
* @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,
|
|
29242
29261
|
* it will default to the Architect format.
|
|
29243
29262
|
*/
|
|
29244
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
29263
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
29245
29264
|
/**
|
|
29246
29265
|
* The type of the flow. The string
|
|
29247
29266
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -29271,13 +29290,13 @@ export class ArchFlowOutboundCall extends ArchBaseFlowInboundOutboundSecureCall
|
|
|
29271
29290
|
* If the variable name cannot be found, nothing is returned.
|
|
29272
29291
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
29273
29292
|
*/
|
|
29274
|
-
getVariableById(variableId: string):
|
|
29293
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
29275
29294
|
/**
|
|
29276
29295
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
29277
29296
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
29278
29297
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
29279
29298
|
*/
|
|
29280
|
-
getVariableByName(variableName: string):
|
|
29299
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
29281
29300
|
/**
|
|
29282
29301
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
29283
29302
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -29700,7 +29719,7 @@ export class ArchFlowSecureCall extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
29700
29719
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
29701
29720
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
29702
29721
|
*/
|
|
29703
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
29722
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
29704
29723
|
/**
|
|
29705
29724
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
29706
29725
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -29711,7 +29730,7 @@ export class ArchFlowSecureCall extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
29711
29730
|
* @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,
|
|
29712
29731
|
* it will default to the Architect format.
|
|
29713
29732
|
*/
|
|
29714
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
29733
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
29715
29734
|
/**
|
|
29716
29735
|
* The type of the flow. The string
|
|
29717
29736
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -29741,13 +29760,13 @@ export class ArchFlowSecureCall extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
29741
29760
|
* If the variable name cannot be found, nothing is returned.
|
|
29742
29761
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
29743
29762
|
*/
|
|
29744
|
-
getVariableById(variableId: string):
|
|
29763
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
29745
29764
|
/**
|
|
29746
29765
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
29747
29766
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
29748
29767
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
29749
29768
|
*/
|
|
29750
|
-
getVariableByName(variableName: string):
|
|
29769
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
29751
29770
|
/**
|
|
29752
29771
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
29753
29772
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -30144,7 +30163,7 @@ export class ArchFlowSurveyInvite extends ArchBaseFlowWorkflow {
|
|
|
30144
30163
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
30145
30164
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
30146
30165
|
*/
|
|
30147
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
30166
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
30148
30167
|
/**
|
|
30149
30168
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
30150
30169
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -30155,7 +30174,7 @@ export class ArchFlowSurveyInvite extends ArchBaseFlowWorkflow {
|
|
|
30155
30174
|
* @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,
|
|
30156
30175
|
* it will default to the Architect format.
|
|
30157
30176
|
*/
|
|
30158
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
30177
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
30159
30178
|
/**
|
|
30160
30179
|
* The type of the flow. The string
|
|
30161
30180
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -30185,13 +30204,13 @@ export class ArchFlowSurveyInvite extends ArchBaseFlowWorkflow {
|
|
|
30185
30204
|
* If the variable name cannot be found, nothing is returned.
|
|
30186
30205
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
30187
30206
|
*/
|
|
30188
|
-
getVariableById(variableId: string):
|
|
30207
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
30189
30208
|
/**
|
|
30190
30209
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
30191
30210
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
30192
30211
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
30193
30212
|
*/
|
|
30194
|
-
getVariableByName(variableName: string):
|
|
30213
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
30195
30214
|
/**
|
|
30196
30215
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
30197
30216
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -30614,7 +30633,7 @@ export class ArchFlowVoiceSurvey extends ArchBaseFlowBot {
|
|
|
30614
30633
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
30615
30634
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
30616
30635
|
*/
|
|
30617
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
30636
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
30618
30637
|
/**
|
|
30619
30638
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
30620
30639
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -30625,7 +30644,7 @@ export class ArchFlowVoiceSurvey extends ArchBaseFlowBot {
|
|
|
30625
30644
|
* @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,
|
|
30626
30645
|
* it will default to the Architect format.
|
|
30627
30646
|
*/
|
|
30628
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
30647
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
30629
30648
|
/**
|
|
30630
30649
|
* The type of the flow. The string
|
|
30631
30650
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -30655,13 +30674,13 @@ export class ArchFlowVoiceSurvey extends ArchBaseFlowBot {
|
|
|
30655
30674
|
* If the variable name cannot be found, nothing is returned.
|
|
30656
30675
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
30657
30676
|
*/
|
|
30658
|
-
getVariableById(variableId: string):
|
|
30677
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
30659
30678
|
/**
|
|
30660
30679
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
30661
30680
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
30662
30681
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
30663
30682
|
*/
|
|
30664
|
-
getVariableByName(variableName: string):
|
|
30683
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
30665
30684
|
/**
|
|
30666
30685
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
30667
30686
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -31080,7 +31099,7 @@ export class ArchFlowVoicemail extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
31080
31099
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
31081
31100
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
31082
31101
|
*/
|
|
31083
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
31102
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
31084
31103
|
/**
|
|
31085
31104
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
31086
31105
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -31091,7 +31110,7 @@ export class ArchFlowVoicemail extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
31091
31110
|
* @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,
|
|
31092
31111
|
* it will default to the Architect format.
|
|
31093
31112
|
*/
|
|
31094
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
31113
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
31095
31114
|
/**
|
|
31096
31115
|
* The type of the flow. The string
|
|
31097
31116
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -31121,13 +31140,13 @@ export class ArchFlowVoicemail extends ArchBaseFlowInboundOutboundSecureCall {
|
|
|
31121
31140
|
* If the variable name cannot be found, nothing is returned.
|
|
31122
31141
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
31123
31142
|
*/
|
|
31124
|
-
getVariableById(variableId: string):
|
|
31143
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
31125
31144
|
/**
|
|
31126
31145
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
31127
31146
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
31128
31147
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
31129
31148
|
*/
|
|
31130
|
-
getVariableByName(variableName: string):
|
|
31149
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
31131
31150
|
/**
|
|
31132
31151
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
31133
31152
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -31524,7 +31543,7 @@ export class ArchFlowWorkflow extends ArchBaseFlowWorkflow {
|
|
|
31524
31543
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
31525
31544
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
31526
31545
|
*/
|
|
31527
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
31546
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
31528
31547
|
/**
|
|
31529
31548
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
31530
31549
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -31535,7 +31554,7 @@ export class ArchFlowWorkflow extends ArchBaseFlowWorkflow {
|
|
|
31535
31554
|
* @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,
|
|
31536
31555
|
* it will default to the Architect format.
|
|
31537
31556
|
*/
|
|
31538
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
31557
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
31539
31558
|
/**
|
|
31540
31559
|
* The type of the flow. The string
|
|
31541
31560
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -31565,13 +31584,13 @@ export class ArchFlowWorkflow extends ArchBaseFlowWorkflow {
|
|
|
31565
31584
|
* If the variable name cannot be found, nothing is returned.
|
|
31566
31585
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
31567
31586
|
*/
|
|
31568
|
-
getVariableById(variableId: string):
|
|
31587
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
31569
31588
|
/**
|
|
31570
31589
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
31571
31590
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
31572
31591
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
31573
31592
|
*/
|
|
31574
|
-
getVariableByName(variableName: string):
|
|
31593
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
31575
31594
|
/**
|
|
31576
31595
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
31577
31596
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -31972,7 +31991,7 @@ export class ArchFlowWorkitem extends ArchBaseFlowWorkflow {
|
|
|
31972
31991
|
* for a flow type and access the [fileExtension]{@link ArchDefinitionFlow#fileExtension} property to get the value. If an extension is found on the file name other than what is
|
|
31973
31992
|
* expected, the correct extension will be appended to the end of the exported file as per the logic described previously.
|
|
31974
31993
|
*/
|
|
31975
|
-
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<
|
|
31994
|
+
exportToDirAsync(destinationDir?: string, callbackFunction?: callbackExportFullPath, flowFormat?: string, fileName?: string): Promise<string>;
|
|
31976
31995
|
/**
|
|
31977
31996
|
* Exports the flow to a JSON object. The object passed back in the callback function
|
|
31978
31997
|
* will be a JSON object with a content and fileName property where the content holds
|
|
@@ -31983,7 +32002,7 @@ export class ArchFlowWorkitem extends ArchBaseFlowWorkflow {
|
|
|
31983
32002
|
* @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,
|
|
31984
32003
|
* it will default to the Architect format.
|
|
31985
32004
|
*/
|
|
31986
|
-
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<
|
|
32005
|
+
exportToObjectAsync(callbackFunction: callbackExportObject, flowFormat?: string): Promise<ExportInfoType>;
|
|
31987
32006
|
/**
|
|
31988
32007
|
* The type of the flow. The string
|
|
31989
32008
|
* values in {@link ArchEnums#FLOW_TYPES} lists valid flow type values.
|
|
@@ -32013,13 +32032,13 @@ export class ArchFlowWorkitem extends ArchBaseFlowWorkflow {
|
|
|
32013
32032
|
* If the variable name cannot be found, nothing is returned.
|
|
32014
32033
|
* @param variableId - the supllied variable identifier to look up such as __CALL_ANI__.
|
|
32015
32034
|
*/
|
|
32016
|
-
getVariableById(variableId: string):
|
|
32035
|
+
getVariableById<T extends ArchBaseVariable = ArchBaseVariable>(variableId: string): T;
|
|
32017
32036
|
/**
|
|
32018
32037
|
* Returns the flow scoped variable for the supplied fully scoped variable name ( if it exists ). Remember, looking
|
|
32019
32038
|
* up variables by name is case insensitive. If the variable name cannot be found, nothing is returned.
|
|
32020
32039
|
* @param variableName - the fully scoped variable name to look up such as Flow.MyVar.
|
|
32021
32040
|
*/
|
|
32022
|
-
getVariableByName(variableName: string):
|
|
32041
|
+
getVariableByName<T extends ArchBaseVariable = ArchBaseVariable>(variableName: string): T;
|
|
32023
32042
|
/**
|
|
32024
32043
|
* Imports the flow content from the supplied content string. This content string should be for a flow of the
|
|
32025
32044
|
* same type as the one you're importing in to. Upon successful import, the callback function passed in
|
|
@@ -33799,7 +33818,7 @@ export class ArchSettingsEventErrorFlowBot extends ArchSettingsEventErrorFlow {
|
|
|
33799
33818
|
*/
|
|
33800
33819
|
readonly agentEscalationTargetTask: ArchTask;
|
|
33801
33820
|
/**
|
|
33802
|
-
* The subsequent recognition failures configured for the flow. The string values in {@link ArchEnums#
|
|
33821
|
+
* The subsequent recognition failures configured for the flow. The string values in {@link ArchEnums#SUBSEQUENT_RECOGNITION_FAILURES_HANDLING}
|
|
33803
33822
|
* When set to `executeTask`, the bot will continue to execute the recognition failure task for all subsequent recognition failure events.
|
|
33804
33823
|
* When set to `exit`, the bot will exit the flow after the first execution of the recognition failure task.
|
|
33805
33824
|
*/
|
|
@@ -34209,6 +34228,16 @@ export class ArchSettingsNluKnowledge extends ArchBaseCoreObject {
|
|
|
34209
34228
|
* nothing is returned.
|
|
34210
34229
|
*/
|
|
34211
34230
|
readonly knowledgeBaseId: string;
|
|
34231
|
+
/**
|
|
34232
|
+
* Returns the knowledge setting name if there is one set on this ArchActionSettingsNluKnowledge instance. If there is not one set,
|
|
34233
|
+
* nothing is returned.
|
|
34234
|
+
*/
|
|
34235
|
+
readonly knowledgeSettingName: string;
|
|
34236
|
+
/**
|
|
34237
|
+
* Returns the knowledge setting id if there is one set on this ArchActionSettingsNluKnowledge instance. If there is not one set,
|
|
34238
|
+
* nothing is returned.
|
|
34239
|
+
*/
|
|
34240
|
+
readonly knowledgeSettingId: string;
|
|
34212
34241
|
/**
|
|
34213
34242
|
* Returns the knowledge base welcome article name if there is one set on this ArchActionSettingsNluKnowledge instance. If there is not one set,
|
|
34214
34243
|
* nothing is returned.
|
|
@@ -34314,6 +34343,14 @@ export class ArchSettingsNluKnowledge extends ArchBaseCoreObject {
|
|
|
34314
34343
|
* A boolean value which, if it evaluates to true, will enable generating answers from multiple kb articles.
|
|
34315
34344
|
*/
|
|
34316
34345
|
readonly knowledgeMultiArticleSource: ArchValueBoolean;
|
|
34346
|
+
/**
|
|
34347
|
+
* A boolean value which, if it evaluates to true, will enable knowledge context search.
|
|
34348
|
+
*/
|
|
34349
|
+
readonly knowledgeContextSearch: ArchValueBoolean;
|
|
34350
|
+
/**
|
|
34351
|
+
* The knowledge version
|
|
34352
|
+
*/
|
|
34353
|
+
readonly knowledgeVersion: ArchValueString;
|
|
34317
34354
|
/**
|
|
34318
34355
|
* The text on the label to view the full article
|
|
34319
34356
|
*/
|
|
@@ -34338,6 +34375,22 @@ export class ArchSettingsNluKnowledge extends ArchBaseCoreObject {
|
|
|
34338
34375
|
* callback function will be this Architect NLU Knowledge Settings instance.
|
|
34339
34376
|
*/
|
|
34340
34377
|
setKnowledgeBaseByNameAsync(knowledgeBaseName: string, callbackFunction?: (...params: any[]) => any): Promise<ArchSettingsNluKnowledge>;
|
|
34378
|
+
/**
|
|
34379
|
+
* This sets the knowledge setting that will be used for use at runtime by the knowledge setting id.
|
|
34380
|
+
* @param knowledgeSettingId - the id of the Knowledge Setting to set.
|
|
34381
|
+
* @param [callbackFunction] - a callback function to call if the Knowledge Setting is successfully
|
|
34382
|
+
* looked up and configured on this action. The first parameter passed to the
|
|
34383
|
+
* callback function will be this Architect NLU Knowledge Settings instance.
|
|
34384
|
+
*/
|
|
34385
|
+
setKnowledgeSettingByIdAsync(knowledgeSettingId: string, callbackFunction?: (...params: any[]) => any): Promise<ArchSettingsNluKnowledge>;
|
|
34386
|
+
/**
|
|
34387
|
+
* This sets the knowledge setting that will be used for use at runtime by the knowledge setting name.
|
|
34388
|
+
* @param knowledgeSettingName - the name of the Knowledge Setting to set. Knowledge Setting names are looked up case insensitively.
|
|
34389
|
+
* @param [callbackFunction] - a callback function to call if the Knowledge Setting is successfully
|
|
34390
|
+
* looked up and configured on this action. The first parameter passed to the
|
|
34391
|
+
* callback function will be this Architect NLU Knowledge Settings instance.
|
|
34392
|
+
*/
|
|
34393
|
+
setKnowledgeSettingByNameAsync(knowledgeSettingName: string, callbackFunction?: (...params: any[]) => any): Promise<ArchSettingsNluKnowledge>;
|
|
34341
34394
|
/**
|
|
34342
34395
|
* This sets the welcome article that will be used by the bot at runtime by the knowledge base document's identifier.
|
|
34343
34396
|
* Remember that prior to setting a knowledge base document as the welcome article that the knowledge base must
|
|
@@ -35047,10 +35100,15 @@ export class ArchSettingsSupportedLanguage extends ArchBaseCoreObject {
|
|
|
35047
35100
|
*/
|
|
35048
35101
|
readonly knowledgeBaseId: string;
|
|
35049
35102
|
/**
|
|
35050
|
-
* Returns the knowledge
|
|
35051
|
-
*
|
|
35103
|
+
* Returns the knowledge setting name for this supported language setting. If this is the default language,
|
|
35104
|
+
* we return the knowledge setting name of the flow's default knowledge setting.
|
|
35052
35105
|
*/
|
|
35053
|
-
readonly
|
|
35106
|
+
readonly knowledgeSettingName: string;
|
|
35107
|
+
/**
|
|
35108
|
+
* Returns the knowledge setting id for this supported language setting. If this supported language setting's language
|
|
35109
|
+
* is the default language, we return the knowledge setting id of the flow's default knowledge setting.
|
|
35110
|
+
*/
|
|
35111
|
+
readonly knowledgeSettingId: string;
|
|
35054
35112
|
/**
|
|
35055
35113
|
* This sets the knowledge base for this supported language setting by the knowledge base id.
|
|
35056
35114
|
* @param knowledgeBaseId - the id of the Knowledge Base to set.
|
|
@@ -35067,6 +35125,22 @@ export class ArchSettingsSupportedLanguage extends ArchBaseCoreObject {
|
|
|
35067
35125
|
* callback function will be this supported language instance.
|
|
35068
35126
|
*/
|
|
35069
35127
|
setKnowledgeBaseByNameAsync(knowledgeBaseName: string, callbackFunction?: callbackArchSettingsSupportedLanguage): Promise<ArchSettingsSupportedLanguage>;
|
|
35128
|
+
/**
|
|
35129
|
+
* This sets the knowledge setting for this supported language setting by the knowledge setting id.
|
|
35130
|
+
* @param knowledgeSettingId - the id of the Knowledge Setting to set.
|
|
35131
|
+
* @param [callbackFunction] - a callback function to call if the Knowledge Setting is successfully
|
|
35132
|
+
* looked up and configured on this action. The first parameter passed to the
|
|
35133
|
+
* callback function will be this supported language instance.
|
|
35134
|
+
*/
|
|
35135
|
+
setKnowledgeSettingByIdAsync(knowledgeSettingId: string, callbackFunction?: callbackArchSettingsSupportedLanguage): Promise<ArchSettingsSupportedLanguage>;
|
|
35136
|
+
/**
|
|
35137
|
+
* This sets the knowledge setting for this supported language setting by the knowledge setting name.
|
|
35138
|
+
* @param knowledgeSettingName - the name of the Knowledge Setting to set.
|
|
35139
|
+
* @param [callbackFunction] - a callback function to call if the Knowledge Setting is successfully
|
|
35140
|
+
* looked up and configured on this action. The first parameter passed to the
|
|
35141
|
+
* callback function will be this supported language instance.
|
|
35142
|
+
*/
|
|
35143
|
+
setKnowledgeSettingByNameAsync(knowledgeSettingName: string, callbackFunction?: callbackArchSettingsSupportedLanguage): Promise<ArchSettingsSupportedLanguage>;
|
|
35070
35144
|
}
|
|
35071
35145
|
|
|
35072
35146
|
/**
|
|
@@ -62631,7 +62705,7 @@ export class ArchValueSettings extends ArchBaseObject {
|
|
|
62631
62705
|
* scripting.viewModels.values.ArchValueSettings.allowInvalidExpressionText = true;
|
|
62632
62706
|
* ```
|
|
62633
62707
|
*/
|
|
62634
|
-
|
|
62708
|
+
allowInvalidExpressionText: boolean;
|
|
62635
62709
|
/**
|
|
62636
62710
|
* This is a string suitable for logging information about this object where it's just the object's type. This is normally used
|
|
62637
62711
|
* when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal
|
|
@@ -85299,7 +85373,28 @@ declare module 'purecloud-flow-scripting-api-sdk-javascript' {
|
|
|
85299
85373
|
/**
|
|
85300
85374
|
* This namespace contains Architect Scripting flow related view models.
|
|
85301
85375
|
*/
|
|
85302
|
-
namespace flows {
|
|
85376
|
+
namespace flows {
|
|
85377
|
+
let ArchFlowBot: ArchFlowBot;
|
|
85378
|
+
let ArchFlowCommonModule: ArchFlowCommonModule;
|
|
85379
|
+
let ArchFlowDigitalBot: ArchFlowDigitalBot;
|
|
85380
|
+
let ArchFlowInboundCall: ArchFlowInboundCall;
|
|
85381
|
+
let ArchFlowInboundChat: ArchFlowInboundChat;
|
|
85382
|
+
let ArchFlowInfo: ArchFlowInfo;
|
|
85383
|
+
let ArchFlowInfoVersion: ArchFlowInfoVersion;
|
|
85384
|
+
let ArchFlowInfoBasic: ArchFlowInfoBasic;
|
|
85385
|
+
let ArchFlowInQueueCall: ArchFlowInQueueCall;
|
|
85386
|
+
let ArchFlowInQueueEmail: ArchFlowInQueueEmail;
|
|
85387
|
+
let ArchFlowInQueueShortMessage: ArchFlowInQueueShortMessage;
|
|
85388
|
+
let ArchFlowOutboundCall: ArchFlowOutboundCall;
|
|
85389
|
+
let ArchFlowSecureCall: ArchFlowSecureCall;
|
|
85390
|
+
let ArchFlowInboundEmail: ArchFlowInboundEmail;
|
|
85391
|
+
let ArchFlowInboundShortMessage: ArchFlowInboundShortMessage;
|
|
85392
|
+
let ArchFlowSurveyInvite: ArchFlowSurveyInvite;
|
|
85393
|
+
let ArchFlowVoicemail: ArchFlowVoicemail;
|
|
85394
|
+
let ArchFlowVoiceSurvey: ArchFlowVoiceSurvey;
|
|
85395
|
+
let ArchFlowWorkflow: ArchFlowWorkflow;
|
|
85396
|
+
let ArchFlowWorkitem: ArchFlowWorkitem;
|
|
85397
|
+
}
|
|
85303
85398
|
/**
|
|
85304
85399
|
* This namespace contains Architect Scripting menu related view models.
|
|
85305
85400
|
*/
|
|
@@ -85418,7 +85513,109 @@ declare module 'purecloud-flow-scripting-api-sdk-javascript' {
|
|
|
85418
85513
|
* This namespace contains Architect Scripting value related view models. The main Architect
|
|
85419
85514
|
* Scripting readme page has more information about values and what they are in Architect Scripting.
|
|
85420
85515
|
*/
|
|
85421
|
-
namespace values {
|
|
85516
|
+
namespace values {
|
|
85517
|
+
let ArchChoice: ArchChoice;
|
|
85518
|
+
let ArchValueAgentScorePair: ArchValueAgentScorePair;
|
|
85519
|
+
let ArchValueAgentScorePairCollection: ArchValueAgentScorePairCollection;
|
|
85520
|
+
let ArchNamedValue: ArchNamedValue;
|
|
85521
|
+
let ArchNamedValueList: ArchNamedValueList;
|
|
85522
|
+
let ArchValueAny: ArchValueAny;
|
|
85523
|
+
let ArchValueAnyCollection: ArchValueAnyCollection;
|
|
85524
|
+
let ArchValueAudio: ArchValueAudio;
|
|
85525
|
+
let ArchValueBoolean: ArchValueBoolean;
|
|
85526
|
+
let ArchValueBooleanCollection: ArchValueBooleanCollection;
|
|
85527
|
+
let ArchValueCard: ArchValueCard;
|
|
85528
|
+
let ArchValueCardCollection: ArchValueCardCollection;
|
|
85529
|
+
let ArchValueCarousel: ArchValueCarousel;
|
|
85530
|
+
let ArchValueChooser: ArchValueChooser;
|
|
85531
|
+
let ArchValueContactList: ArchValueContactList;
|
|
85532
|
+
let ArchValueChoice: ArchValueChoice;
|
|
85533
|
+
let ArchValueChoiceCollection: ArchValueChoiceCollection;
|
|
85534
|
+
let ArchValueCommunication: ArchValueCommunication;
|
|
85535
|
+
let ArchValueCommunicationCollection: ArchValueCommunicationCollection;
|
|
85536
|
+
let ArchValueCurrency: ArchValueCurrency;
|
|
85537
|
+
let ArchValueCurrencyCollection: ArchValueCurrencyCollection;
|
|
85538
|
+
let ArchValueDate: ArchValueDate;
|
|
85539
|
+
let ArchValueDateCollection: ArchValueDateCollection;
|
|
85540
|
+
let ArchValueDateTime: ArchValueDateTime;
|
|
85541
|
+
let ArchValueDateTimeCollection: ArchValueDateTimeCollection;
|
|
85542
|
+
let ArchValueDecimal: ArchValueDecimal;
|
|
85543
|
+
let ArchValueDecimalCollection: ArchValueDecimalCollection;
|
|
85544
|
+
let ArchValueDuration: ArchValueDuration;
|
|
85545
|
+
let ArchValueDurationCollection: ArchValueDurationCollection;
|
|
85546
|
+
let ArchValueEmailAddress: ArchValueEmailAddress;
|
|
85547
|
+
let ArchValueEmailAddressCollection: ArchValueEmailAddressCollection;
|
|
85548
|
+
let ArchValueEmergencyGroup: ArchValueEmergencyGroup;
|
|
85549
|
+
let ArchValueEmergencyGroupCollection: ArchValueEmergencyGroupCollection;
|
|
85550
|
+
let ArchValueExternalContact: ArchValueExternalContact;
|
|
85551
|
+
let ArchValueExternalContactCollection: ArchValueExternalContactCollection;
|
|
85552
|
+
let ArchValueExternalOrganization: ArchValueExternalOrganization;
|
|
85553
|
+
let ArchValueExternalOrganizationCollection: ArchValueExternalOrganizationCollection;
|
|
85554
|
+
let ArchValueGrammar: ArchValueGrammar;
|
|
85555
|
+
let ArchValueGrammarCollection: ArchValueGrammarCollection;
|
|
85556
|
+
let ArchValueGroup: ArchValueGroup;
|
|
85557
|
+
let ArchValueGroupCollection: ArchValueGroupCollection;
|
|
85558
|
+
let ArchValueImage: ArchValueImage;
|
|
85559
|
+
let ArchValueImageCollection: ArchValueImageCollection;
|
|
85560
|
+
let ArchValueInteger: ArchValueInteger;
|
|
85561
|
+
let ArchValueIntegerCollection: ArchValueIntegerCollection;
|
|
85562
|
+
let ArchValueJourneyOutcome: ArchValueJourneyOutcome;
|
|
85563
|
+
let ArchValueJourneyOutcomeScore: ArchValueJourneyOutcomeScore;
|
|
85564
|
+
let ArchValueJourneyOutcomeScoreCollection: ArchValueJourneyOutcomeScoreCollection;
|
|
85565
|
+
let ArchValueJourneySegment: ArchValueJourneySegment;
|
|
85566
|
+
let ArchValueJourneySession: ArchValueJourneySession;
|
|
85567
|
+
let ArchValueJourneySessionCollection: ArchValueJourneySessionCollection;
|
|
85568
|
+
let ArchValueJson: ArchValueJson;
|
|
85569
|
+
let ArchValueJsonCollection: ArchValueJsonCollection;
|
|
85570
|
+
let ArchValueKnowledgeBaseDocument: ArchValueKnowledgeBaseDocument;
|
|
85571
|
+
let ArchValueKnowledgeBaseDocumentCollection: ArchValueKnowledgeBaseDocumentCollection;
|
|
85572
|
+
let ArchValueLanguageSkill: ArchValueLanguageSkill;
|
|
85573
|
+
let ArchValueLanguageSkillCollection: ArchValueLanguageSkillCollection;
|
|
85574
|
+
let ArchValueListPicker: ArchValueListPicker;
|
|
85575
|
+
let ArchValueListPickerItem: ArchValueListPickerItem;
|
|
85576
|
+
let ArchValueListPickerItemCollection: ArchValueListPickerItemCollection;
|
|
85577
|
+
let ArchValueListPickerSection: ArchValueListPickerSection;
|
|
85578
|
+
let ArchValueListPickerSectionCollection: ArchValueListPickerSectionCollection;
|
|
85579
|
+
let ArchValuePhoneNumber: ArchValuePhoneNumber;
|
|
85580
|
+
let ArchValuePhoneNumberCollection: ArchValuePhoneNumberCollection;
|
|
85581
|
+
let ArchValuePrompt: ArchValuePrompt;
|
|
85582
|
+
let ArchValuePromptCollection: ArchValuePromptCollection;
|
|
85583
|
+
let ArchValueQueue: ArchValueQueue;
|
|
85584
|
+
let ArchValueQueueCollection: ArchValueQueueCollection;
|
|
85585
|
+
let ArchValueQuickReplies: ArchValueQuickReplies;
|
|
85586
|
+
let ArchValueSchedule: ArchValueSchedule;
|
|
85587
|
+
let ArchValueScheduleCollection: ArchValueScheduleCollection;
|
|
85588
|
+
let ArchValueScheduleGroup: ArchValueScheduleGroup;
|
|
85589
|
+
let ArchValueScheduleGroupCollection: ArchValueScheduleGroupCollection;
|
|
85590
|
+
let ArchValueSettings: ArchValueSettings;
|
|
85591
|
+
let ArchValueSkill: ArchValueSkill;
|
|
85592
|
+
let ArchValueSkillCollection: ArchValueSkillCollection;
|
|
85593
|
+
let ArchValueString: ArchValueString;
|
|
85594
|
+
let ArchValueStringCollection: ArchValueStringCollection;
|
|
85595
|
+
let ArchValueSurveyAnswerOption: ArchValueSurveyAnswerOption;
|
|
85596
|
+
let ArchValueSurveyAnswerOptionCollection: ArchValueSurveyAnswerOptionCollection;
|
|
85597
|
+
let ArchValueSurveyForm: ArchValueSurveyForm;
|
|
85598
|
+
let ArchValueSurveyQuestion: ArchValueSurveyQuestion;
|
|
85599
|
+
let ArchValueSurveyQuestionCollection: ArchValueSurveyQuestionCollection;
|
|
85600
|
+
let ArchValueSurveyQuestionGroup: ArchValueSurveyQuestionGroup;
|
|
85601
|
+
let ArchValueSurveyQuestionGroupCollection: ArchValueSurveyQuestionGroupCollection;
|
|
85602
|
+
let ArchValueTime: ArchValueTime;
|
|
85603
|
+
let ArchValueTimeCollection: ArchValueTimeCollection;
|
|
85604
|
+
let ArchValueTimePicker: ArchValueTimePicker;
|
|
85605
|
+
let ArchValueTimeslot: ArchValueTimeslot;
|
|
85606
|
+
let ArchValueTimeslotCollection: ArchValueTimeslotCollection;
|
|
85607
|
+
let ArchValueUser: ArchValueUser;
|
|
85608
|
+
let ArchValueUserCollection: ArchValueUserCollection;
|
|
85609
|
+
let ArchValueUtilizationLabel: ArchValueUtilizationLabel;
|
|
85610
|
+
let ArchValueUtilizationLabelCollection: ArchValueUtilizationLabelCollection;
|
|
85611
|
+
let ArchValueWorkbin: ArchValueWorkbin;
|
|
85612
|
+
let ArchValueWorkbinCollection: ArchValueWorkbinCollection;
|
|
85613
|
+
let ArchValueWorkitem: ArchValueWorkitem;
|
|
85614
|
+
let ArchValueWorktypeStatus: ArchValueWorktypeStatus;
|
|
85615
|
+
let ArchValueWorktypeStatusCollection: ArchValueWorktypeStatusCollection;
|
|
85616
|
+
let ArchValueWrapupCode: ArchValueWrapupCode;
|
|
85617
|
+
let ArchValueWrapupCodeCollection: ArchValueWrapupCodeCollection;
|
|
85618
|
+
}
|
|
85422
85619
|
/**
|
|
85423
85620
|
* This namespace contains Architect Scripting flow variable related view models.
|
|
85424
85621
|
*/
|
|
@@ -85516,5 +85713,23 @@ declare module 'purecloud-flow-scripting-api-sdk-javascript' {
|
|
|
85516
85713
|
let ArchVariableWrapupCodeCollection: ArchVariableWrapupCodeCollection;
|
|
85517
85714
|
}
|
|
85518
85715
|
}
|
|
85716
|
+
/**
|
|
85717
|
+
* Type alias for the entire Architect Scripting SDK module.
|
|
85718
|
+
* Use this type when you need to type a variable that holds the entire SDK object.
|
|
85719
|
+
* @example
|
|
85720
|
+
* ```typescript
|
|
85721
|
+
* import type { ArchitectScripting } from 'purecloud-flow-scripting-api-sdk-javascript';
|
|
85722
|
+
* const scripting: ArchitectScripting = require('purecloud-flow-scripting-api-sdk-javascript');
|
|
85723
|
+
* ```
|
|
85724
|
+
*/
|
|
85725
|
+
export type ArchitectScripting = {
|
|
85726
|
+
dataTypes: typeof dataTypes;
|
|
85727
|
+
environment: typeof environment;
|
|
85728
|
+
enums: typeof enums;
|
|
85729
|
+
factories: typeof factories;
|
|
85730
|
+
languages: typeof languages;
|
|
85731
|
+
services: typeof services;
|
|
85732
|
+
viewModels: typeof viewModels;
|
|
85733
|
+
};
|
|
85519
85734
|
}
|
|
85520
85735
|
|