Change Log
0.53.4
Bug Fixes
- We now show additional information when a failure occurs when using {@ArchBaseFlow#checkInAsync}.
0.53.3
Bug Fixes
- We fixed an issue where passing in a value for the creationData parameter on the
ArchFactoryFlows.createFlowFromDefinitionAsync
function for a flow type thatdoes not support creation data
would cause an invalid function error to occur.
0.53.2
Improvements
- Added a
ArchDefinitionFlow#supportsVirtualAgent
property to determine if a flow's definition supports Virtual Agent.
Bug Fixes
-
We fixed an issue where creating an
ArchBaseFlowBot
in memory,exporting the flow
, thenimporting the flow
onto an already existing flow, and finally publishing the flow would not create any new slots that were defined in the flow export. -
We fixed an issue where performing lookups of network entities that did not exist would cause an "UnhandledPromiseRejection" error.
0.53.1
Improvements
- Added a
ArchDefinitionFlow#supportsVirtualAgent
property to determine if a flow's definition supports Virtual Agent.
Bug Fixes
-
We fixed an issue where creating an
ArchBaseFlowBot
in memory,exporting the flow
, thenimporting the flow
onto an already existing flow, and finally publishing the flow would not create any new slots that were defined in the flow export. -
We fixed an issue where performing lookups of network entities that did not exist would cause an "UnhandledPromiseRejection" error.
0.53.0
Improvements
- Added support for
Workitem
flows.
0.52.0
Improvements
-
We added support for configuring
wrap up codes
on a virtual agent enabledbot
ordigital bot
bot
anddigital bot
flows. -
We added support for
knowledge answer highlight
.
0.51.0
Improvements
-
We added support for enabling or disabling automatic hinting in
Bot flows
andDigital Bot flows
via theArchSettingsUserInput#enableIntentClassificationHinting
property. -
We added support for the
ArchActionPlayUserGreeting
andArchActionPlayUserName
actions. -
We added support for
Voice Survey
flows.
0.50.1
Bug Fixes
- We fixed an issue where the language versions of supported languages on a
bot flow
ordigital bot flow
would not be exported to YAML for the Settings Natural Language Understanding configuration.
0.50.0
Improvements
-
We added support for configuring recognition failure and agent escalation within
bot
anddigital bot
flows usingArchSettingsEvenErrorFlowBot#agentEscalationHandling
,ArchSettingsEvenErrorFlowBot#recognitionFailureEventTargetTask
, andArchSettingsEvenErrorFlowBot#agentEscalationTargetTask
. -
We added support for flexible text to speech
engine
selection.
0.49.0
Improvements
-
Added missing documentation for the
ArchActionGetSecuredData
andArchActionSetSecuredData
actions. -
Added missing documentation for the
ArchBaseActionDialogflow#integrationName
property and the integrationName parameter on theArchBaseActionDialogflow#setDialogflowAgentByNameAsync
andArchBaseActionDialogflow#setDialogflowAgentByNameWithEnvironmentAsync
functions. -
Added missing documentation for the
ArchActionAudioMonitoring
action. -
Added missing documentation for the
ArchActionClearUtilizationLabel
,ArchActionFindUtilizationLabel
,ArchActionSetUtilizationLabel
,ArchValueUtilizationLabel
,ArchValueUtilizationLabelCollection
,ArchVariableUtilizationLabel
, andArchVariableUtilizationLabelCollection
actions. -
Improved logging output when an unhandled exception is caught during
ArchSession#startWithClientIdAndSecret
orArchSession#startWithAuthToken
.
Bug Fixes
- We fixed an issue where the knowledge and noIntent
output paths
were not exporting to YAML whenenabled
without actions configured.
0.48.0
Improvements
-
We added documentation for configuring the
ArchSettingsNluKnowledge#knowledgePathMode
and for configuring theArchSettingsNluKNowledge#knowledgeTargetTask
. -
We added documentation for configuring the
ArchSettingsNluKnowledge#knowledgeSettingsMode
, configuring theArchSettingsNluKnowledge#knowledgeCustomTask
, and for theArchActionSendKnowledgeFeedback
action.
0.47.1
Bug Fixes
- We fixed an issue with missing spaces in the logging output when creating a flow.
0.47.0
Improvements
- We added missing documentation for the
ArchBaseActionNoInputNoMatch#customizeNoInput
,ArchBaseActionNoInputNoMatch#customizeNoMatch
,ArchBaseActionNoInputNoMatch#noInputReprompts
, andArchBaseActionNoInputNoMatch#noMatchReprompts
properties.
Bug Fixes
-
We fixed an issue where the
settingsPrompts
property would be exported to YAML in aCommon Module flow
when thecompatible flow types
configured did not support prompts. -
We fixed an incorrect documentation type for the
ArchActionTransferToVoicemail#targetGroup
property.
0.46.0
New Features
-
We added support for the
ArchActionCallAudioConnector
action. -
We added
grammar
support with actions such asArchActionFindGrammar
andArchActionFindGrammarById
as well as configuring the grammar on anArchActionAskForSlot
action using theArchActionAskForSlot#grammar
property.
Bug Fixes
-
We fixed an issue where the
ArchActionCallCommonModule
,ArchActionCallBotFlow
, andArchActionCallDigitalBotFlow
actions would not export the most up to date name of the flow being referenced. -
We fixed an internal error which caused a validation error to appear when a
bot flow
was created without any intents defined.
0.45.0
Miscellaneous
- We added support for the
ArchActionSetPostFlow
andArchActionClearPostFlow
actions.
0.44.3
Bug Fixes
- We fixed an issue where
ArchBaseFlowBotWithKnowledge#botFlowSettings
would return undefined unless the Knowledge functionality is available in a Genesys Cloud organization.
0.44.2
Bug Fixes
- We fixed an issue with YAML export where an
ArchActionAskForIntent
would export an intent output as enabled if the intent no longer existed within the natural language understand settings and there were actions added in the output path for that intent.
0.44.1
New Features
- We added a new
ArchBaseVariable#isSystemVariable
property to return whether anArchBaseVariable
is a system variable or not.
Bug Fixes
-
We fixed an issue with expression validation when running Architect Scripting in a Turkish locale.
-
We fixed an issue where exporting a flow to YAML would not use the most up to date integration names configured in Genesys Cloud.
-
We fixed the return type in the documentation for
ArchFactoryMenus#addMenuJumpToTask
to correctly state it returns anArchMenuJumpToTask
.
0.44.0
Bug Fixes
- We updated the YAML export of the
ArchBaseActionDataAction#processingPrompt
property when set tono value with no fallback
to now export asnoValueWithNoFallback: true
instead of justnoValue: true
.
0.43.2
Bug Fixes
- We fixed an issue where exporting an
ArchActionEndTask
that used the default branch for theArchActionEndTask#targetBranch
could export a localized label for the output name.
0.43.1
Bug Fixes
- We updated YAML export to quote strings that contain tab characters.
0.43.0
New Features
- We added support for the
ArchActionGetRawSIPHeaders
andArchActionGetSIPHeaders
actions.
Improvements
- We added the ability to additionally specify
published
ordebug
for functions such asArchFactoryFlows#loadFlowByFlowIdAsync
for theflowVersion
parameter.
Bug Fixes
- We fixed an issue where loading an
ArchFlowCommonModule
using a function such asArchFactoryFlows#loadFlowByFlowIdAsync
and specifying a version other thanlatest
would cause theArchSettingsCommonModuleFlow#compatibleFlowTypes
to be an empty array even if there were compatible flow types in that version of the flow.
0.42.1
Improvements
- We added the ability to additionally specify
published
ordebug
for functions such asArchFactoryFlows#loadFlowByFlowIdAsync
for theflowVersion
parameter.
Bug Fixes
- We fixed an issue where loading an
ArchFlowCommonModule
using a function such asArchFactoryFlows#loadFlowByFlowIdAsync
and specifying a version other thanlatest
would cause theArchSettingsCommonModuleFlow#compatibleFlowTypes
to be an empty array even if there were compatible flow types in that version of the flow.
0.42.0
New Features
-
We added support for the
Send Notification action
. -
We added support for configuring
quick replies
,cards
, andcarousels
withinDigital Menu
andAsk for Slot
actions withindigital bot
flows.
Improvements
- We updated the minimum Node.js version required to use Architect Scripting to 18.0.0. This is reflected in Architect Scripting's package.json file. Node Package Manager (npm) will use this to check your installed Node.js version when installing the Architect Scripting SDK so when using Node be sure to have 18.0.0 or higher installed. Thanks!
0.41.2
Improvements
- We updated YAML export for the
ArchActionEvaluateSchedule#evaluationTimeZone
property to export alit
orexp
property depending on whether the value is literal or expression mode.
Bug Fixes
- We fixed an issue where importing an
ArchBaseFlowBot
usingArchBaseFlow#importFromContentAsync
orArchBaseFlow#importFromFileAsync
would not correctly update the Natural Language Understanding configuration.
0.41.1
Improvements
- We standardized logging behavior when actions are added to a flow.
Bug Fixes
- We fixed an issue where importing an
ArchBaseFlowBot
usingArchBaseFlow#importFromContentAsync
orArchBaseFlow#importFromFileAsync
did not import the natural language understanding configuration.
0.41.0
Improvements
- We added the ability to configure the suppress recording setting in call flows using
ArchSettingsSpeechRecFlow#suppressRecording
. To check whether a flow can suppress recordings, we also added theArchDefinitionFlow#canSuppressRecording
property.
0.40.2
Bug Fixes
- We fixed an issue where importing a flow using
ArchBaseFlow#importFromContentAsync
orArchBaseFlow#importFromFileAsync
would not correctly configure the language on anArchActionSetLanguage
action on the new flow.
0.40.1
Bug Fixes
- We corrected values reported by the TypeScript definition file.
0.40.0
New Features
- We added support for configuring multi-lingual
Bot
flows andDigital Bot
flows.
Bug Fixes
- We updated handling when loading flows with Evaluate Schedule and Evaluate Schedule Group actions to clean up unused properties in the flow's configuration.
0.39.0
New Features
- We added support for the
ArchActionGetResponse#responseBodyHandling
inBot
andDigital Bot
flows.
Improvements
-
We added additional error logging when flow creation fails.
-
We updated handling to allow for the same name to be used for
ArchMenuTasks
andArchMenuSubMenus
as long as their parentArchMenu
is not the same.
Bug Fixes
- We fixed an issue where the
ArchValidationIssue#warnings
andArchValidationIssue#errors
were returning an array of objects instead of an array of strings like the documentation said for these properties.
0.38.0
New Features
- We added support for the
ArchFactoryActions#addActionGetConversationData
andArchFactoryActions#addActionSetConversationData
action.
Improvements
-
We updated the minimum Node.js version required to use Architect Scripting to 16.0.0. This is reflected in Architect Scripting's package.json file. Node Package Manager (npm) will use this to check your installed Node.js version when installing the Architect Scripting SDK so when using Node be sure to have 16.0.0 or higher installed. Thanks!
-
We updated the the minimum int value for
ArchSettingsUserInput#confirmationRejectionsMax
from 1 to 0 forBot flows
.
Bug Fixes
- We fixed an issue with language tag handling when running Architect Scripting in a Turkish locale.
0.37.0
New Features
- We added support for the
ToCommunicationSsml
expression function withinBot flows
.
Bug Fixes
-
We fixed an issue when adding an
ArchActionTransferToVoicemailAction
using theArchFactoryActions#addActionFromDefinition
function would populate theArchActionTransferToVoicemailAction#voicemailGreeting
with a default PromptSystem.voicemail_greeting when theArchActionTransferVoicemail#transferTargetType
was set to "queue". -
We fixed an issue where error traces could contain extra unneeded periods within the message being logged.
0.36.1
Bug Fixes
-
We fixed an issue when exporting a
Bot flow
orDigital Bot flow
with no intents and one or moredynamic slot types
to YAML would result in the exported file incorrectly containing anone: true
entry in thesettingsBotFlow
configuration when it should not have. -
In Scripting documentation, the
ArchOrganizationInfo#name
andArchOrganizationInfo#id
properties were updated so they now correctly appear underArchOrganizationInfo
instead ofArchSession
. -
We fixed an issue where creating a
Common Module flow
without a default language specified would add theEnglish (United States) language
by default.
0.36.0
New Features
- We added support for the
Encrypt Data action
,Decrypt Data action
,ArchValueJson
data type, andArchValueJsonCollection
data type.
0.35.2
Bug Fixes
- We updated
ArchBaseActionNoInputNoMatch
to extend fromArchBaseActionWithOutputs
so that output lookups could be performed correctly.
0.35.1
Improvements
- We made additional improvements to the Architect Scripting TypeScript declaration file to allow for typing support when using TypeScript.
0.35.0
New Features
-
We added support for the
Call Digital Bot flow
action to use be used withinArchFlowInQueueShortMessage
flows. -
We added support for the
ArchSettingsUserInput#noInputsMaxExceededHandling
,ArchSettingsUserInput#noInputsMax
,ArchSettingsUserInput#noInputApology
,ArchSettingsUserInput#noInputsTimeout
, andArchSettingsUserInput#endOfSessionMessage
properties for configuring no input timeout settings for aDigital Bot flow
. -
We added a new
ArchDefinitionFlow#supportsMoreThanOneSupportedLanguage
property to return whether a flow type supports the ability to add more than one supported language.
Bug Fixes
- We fixed an issue where adding a knowledge base document by name using
ArchValueKnowledgeBaseDocumentCollection.addLiteralByKnowledgeBaseDocumentNameAsync
would fail because the knowledge base id was not being used for the lookup correctly.
0.34.2
New Features
- We added support for adding an individual item to an
ArchBaseNetworkValueCollection
using theArchBaseNetworkValueCollection#addItemToCollection
function.
Bug Fixes
-
We fixed an issue where setting a response which had the same name in different response libraries using the
ArchActionGetResponse#setResponseByNameAsync
function would not be able to find the response correctly on a name lookup. -
We fixed a warning log message when calling
ArchTtsEngines#getEngineByName
when looking up a text to speech engine that is not available within the organization.
0.34.1
Bug Fixes
- We fixed an issue where performing a YAML export of a
Create Callback
action that has a callback script configured with no inputs would be set to null.
0.34.0
New Features
-
We added namespace links for the
ArchActionFindEmergencyGroup
,ArchActionFindSchedule
, andArchActionFindScheduleGroup
actions
, theArchValueEmergencyGroup
,ArchValueEmergencyGroupCollection
,ArchValueSchedule
,ArchValueScheduleCollection
,ArchValueScheduleGroup
, andArchValueScheduleGroupCollection
values
, and theArchVariableEmergencyGroup
,ArchVariableEmergencyGroupCollection
,ArchVariableSchedule
,ArchVariableScheduleCollection
,ArchVariableScheduleGroup
, andArchVariableScheduleGroupCollection
variables
. -
We added support for the
Call Bot Connector
action. -
We added support for the
Call Nuance Mix Bot
action.
0.33.0
New Features
-
We added support for the
ArchFactoryActions#addActionCallDigitalBotFlow
action. -
We added the ability to configure secure variables in
Architect Bot Flows
.
0.32.3
Improvements
- We updated the polling interval time from 1 second to 3 seconds when ensuring flows are searchable by name when performing flow operations such as
ArchBaseFlow#publishAsync
. We also updated the total time allowed for an operation when callingArchAsyncPolling#beginAsyncPolling
from 40 seconds to 80 seconds.
0.32.2
Improvements
- We fixed an issue where the id and name properties on an
Image
data type would not be available to use in an expression.
0.32.1
Bug Fixes
- We fixed an issue where calling
ArchActionCallData#setDataActionByNameAsync
andArchActionCallDataSecure#setDataSecureActionByNameAsync
would not correctly use thecategoryName
parameter to filter down results by the category name provided when multiple data actions had the same name and multiple categories included the category name that was being used for the function call.
0.32.0
New Features
- We added support for the
ArchFlowDigitalBot
flow type.
Improvements
- We added a new
ArchBaseActionDataAction#supportsDataActionOutputsFailure
property to help determine whether failure outputs are supported on this Data Action instance based on the flow type that the Data Action is being used in.
0.31.0
Miscellaneous
- We added a new location string value to
ArchEnums#LOCATIONS
to enable usage of Architect Scripting in the Sao Paulo region ('prod_sa_east_1' ).
0.30.0
New Features
- We added support for configuring
Speech To Text Engines
on a flow'ssupported language
using theArchSettingsSupportedLanguage#setSpeechToTextEngineByNameAsync
andArchSettingsSupportedLanguage#setSpeechToTextEngineByIdAsync
functions if the flow supports speech to text engines, such as thebot flow type
. TheArchDefintionFlow#languagesSupportSpeechToText
property getter can be used to determine if a flow supports speech to text on a supported language.
Bug Fixes
- We added better error handling when providing an invalid location to the
ArchSession#startWithAuthToken
andArchSession#startWithClientIdAndSecret
functions.
0.29.0
New Features
- We added support to get a
dynamic slot type by name
in abot flow's settings
so you can configure dynamic slot type values and synonyms on the returnedArchSettingsNluDynamicSlotType
instance.
0.28.0
Bug Fixes
- We fixed an issue where an error would be thrown saying it could not find a match for a network based object when there was a correct match.
Miscellaneous
- We removed support for the Call Bridge Action since its usage in flows is no longer supported.
0.27.0
New Features
-
We updated the minimum Node version required to use Architect Scripting to 14.0.0. This is reflected in Architect Scripting's package.json file. Node Package Manager (npm) will use this to check your installed Node version when installing the Architect Scripting SDK so when using Node be sure to have 14.0.0 or higher installed. Thanks!
-
We added support for dynamic lookup of
schedules
,schedule groups
, andemergency groups
.
Improvements
- We moved the
valueText
property from theArchValueBasic
class to theArchBaseValueSingleton
class so it is accessible to more scripting classes.
Bug Fixes
- We fixed an issue where an incorrect error could be thrown when
setting a data action by name
if the data action name was the same across multiple categories and there were multiple data action lookups being processed.
0.26.2
Bug Fixes
-
We added a new
ArchSettingsOutboundCallFlow#contactList
property to access theArchValueContactList
that is set on anArchFlowOutboundCall
flow. -
We added support for the FindQueueEstimatedWaitTime and GetQueueEstimatedWaitTime functions within Architect expressions.
-
We added support for the Random and RandomInt functions within Architect expressions.
0.26.1
Improvements
-
We added a note to the documentation's Overview section that Scripting should only be imported/required once within a project.
-
We added additional information to validation issues associated with
ArchAudio
properties to make errors and warnings more descriptive.
Bug Fixes
- We fixed an issue where some action functions that set an item by name were making an additional lookup by the item's id.
0.26.0
New Features
- We added support for the
ArchActionFlushAudio
action.
Improvements
- We added some additional error tracing if fetching the service discovery properties fails during
ArchSession#startWithAuthToken
orArchSession#startWithClientIdAndSecret
function calls.
Bug Fixes
-
We fixed an issue where an error would not be handled correctly when fetching roles and permissions for an OAuth Client when using the
ArchSession#startWithClientIdAndSecret
function. -
We fixed an issue with YAML export where a string value of Null was not being wrapped with quotes.
0.25.0
New Features
- We added support for the
In-Queue Email
andIn-Queue Short Message
flow types.
0.24.0
New Features
- We added support for the
Voicemail flow type
, theClear Voicemail Snippet
action, andProcess Voicemail Snippet
action.
Improvements
- We added new string entries to the
ArchEnums#VARIABLE_SCOPES
enum.
0.23.2
New Features
- We added support for the
ArchActionSetPriority
andArchActionSetSkills
actions which let a flow set a priority and skills on a conversation.
Improvements
- We updated
ArchSettingsUserInput#noInputsMax
andArchSettingsUserInput#noMatchesMax
to allow a value of 0 so a bot will not retry when there is no match or no input from the external participant.
Bug Fixes
- We fixed an issue when validating the
ArchActionExtractSecureData#acknowledgeSecureUsage
property when running the Architect Scripting session as an OAuth Client.
0.23.1
Bug Fixes
- We fixed an issue where using the
ArchActionGetResponse#setResponseByNameAsync
function may not correctly find the canned response when setting the response by name.
0.23.0
New Features
- The Get Journey Sessions By Customer action has been deprecated and support for this action has been removed.
Bug Fixes
- We fixed an issue where using the
ArchActionGetResponse#setResponseByNameAsync
function may not correctly find the canned response when using both a response name and response library name for the lookup.
0.22.0
New Features
- We added support for Architect prompts within bot flows.
Improvements
- We added a new
ArchActionSetLanguage#languageValue
property to set the runtime language to set on the flow to replace the legacy helper propertyArchActionSetLanguage#language
.
0.21.9
Improvements
-
We updated YAML export to always export the preHandlingAudio property in the event handling section for a flow. This is to fix an issue where Archy could write out default TTS instead of empty audio for that property if the property wasn't specified.
-
We now add the isInput and isOutput settings for variables when exporting a flow to YAML to make them explicit on import.
0.21.8
Bug Fixes
-
We fixed an issue where exporting a flow to YAML would not quote "yes" and "no" action outputs.
-
We fixed an issue where publishing a Bot flow could fail if an empty intents array is used within the creation data's
nluDomainVersion
JSON. -
We fixed an issue where traces were being logged for unknown actions.
0.21.7
Improvements
- We added the method
ArchBaseNameValuePairs#getNamedValueByIndex
to get a named value by index. We also added the methodArchBaseNameValuePairs#length
to get the number of items contained within the object
Bug Fixes
- We fixed a problem with the string that is generated for the logging note that is generated when setting the
ArchValueSettings.allowInvalidExpressionText
value.
Miscellaneous
- We added the helper properties
ArchBaseVariable#isReadOnly
andArchBaseVariable#canAssignInitialValue
.
0.21.6
New Features
- We added the helper properties
ArchBaseVariable#isReadOnly
andArchBaseVariable#canAssignInitialValue
.
Bug Fixes
- We fixed documentation for the
ArchDefinitionFlow#getSupportsKnowledge
method so it appears on theArchDefinitionFlow
class as expected.
0.21.5
Improvements
- We added the
ArchDefinitionFlow#supportsDefaultLanguage
property that specifies whether a flow type supports default language selection.
0.21.4
Improvements
- We added new documentation for
ArchEnums#NLU_RESPONSE_BIAS_MODES
andArchEnums#NLU_RESPONSE_BIAS_MODES_ALL
values that can be used for natural language understanding response modes.
Bug Fixes
- We added a new
ArchFlowInfo#isSystem
property that returns whether or not the flow is a system flow.
0.21.3
Bug Fixes
-
We added a new optional parameter
isClientCredentialsOAuthClient
to theArchSession#startWithAuthToken
method to specify if the supplied authToken is for an OAuth client with a client credentials grant. -
We added some internal network call optimizations when multiple instances of the
ArchActionCallCommonModule
are present in a flow that call the same common module to be more efficient when validating the flow. -
We fixed an issue that could cause validation errors to be reported when an
ArchActionCallCommonModule
action referenced acommon module
flow that had a collection input variable defined.
0.21.2
Bug Fixes
- We fixed an issue that could cause validation errors to be reported when using more than one instance of an
ArchActionCallCommonModule
action that referenced the samecommon module
. This could make a flow unpublishable when it should not be.
0.21.1
Improvements
- We added documentation for missing properties for the
ArchFlowCommonModule
flow type.
Bug Fixes
- We added documentation for the
ArchSettingsUserInput#enableBargeIn
property.
0.21.0
New Features
- We added support for
Knowledge settings
inbot flows
. TheArchFlowBot#knowledgeSettings
property provides access to those settings from a bot flow instance. Additionally there is a newArchActionAskForIntent#outputKnowledge
helper property that provides access to the Knowledge action output on theArchActionAskForIntent
action.
Improvements
-
We added support for the
ArchActionSetExternalTag
action. -
We added support for the
ArchActionCallDialogflowCxBot
action. -
We added support for the built-in 'Session.LastCollectionUtterance' String variable in bot flows.
0.20.0
New Features
- We added support for global slots within Architect Bot Flows.
0.19.0
New Features
- We added support for a new
ArchSettingsUserInput#enableBargeIn
setting that controls barge-in behavior of a bot flow at runtime.
Improvements
-
We added a new
ArchActionTransferToAcd#inQueueHandlingFlowType
property that will return the supported flow type to use for theArchActionTransferToAcd#inQueueHandlingFlowInfo
function. -
We added support for a new
ArchSettingsEventErrorFlowBot#enableAgentEscalation
setting that lets you control whether or not a bot flow will listen for requests to speak to a human or not.
Bug Fixes
-
We fixed a problem on bot flow creation in Scripting where the
ArchSettingsEventErrorFlowBot#agentEscalationConfirmation
,ArchSettingsEventErrorFlowBot#agentEscalationHandover
,ArchSettingsEventErrorFlowBot#errorEventHandover
orArchSettingsEventErrorFlowBot#recognitionFailureEventHandover
property communication values were picking up default communication values like what you'd see when creating a bot flow in the Architect UI. In Scripting these values should be left blank on flow creation which they are now. -
We updated internal startup logic shared by the
startWithClientIdAndSecret
andstartWithAuthToken
methods to be more resilient to certain network call failures so that theArchSession
ends properly and does not hang.
0.18.2
Bug Fixes
- We added a new
ArchBaseVariable#description
property that will let you get / set the description on a variable.
0.18.1
Bug Fixes
- We fixed an issue where a Call Common Module action could incorrectly have a validation error saying that it has references that have been deleted.
0.18.0
Improvements
- We added better
async
/await
support to Architect Scripting functions that return a Promise and take a callback as a parameter. Before, some of these functions wouldn't return a value when you usedawait
to call it and assign the promise's return value to a variable. Now, the return value of the promise is assigned correctly.
Bug Fixes
- We have added additional logic to provide better error handling for the
fileName
parameter on theArchBaseFlow#getExportFilePath
andArchBaseFlow#exportToDirAsync
methods to ensure no file path information is specified for the file name.
0.17.2
Improvements
- We added the ability to specify a file name for the
ArchBaseFlow#getExportFilePath
function that will return the file path where a flow export will be written when specifying the directory, flow format, and file name when calling theArchBaseFlow#exportToDirAsync
function.
0.17.1
Improvements
- We added the ability to specify the file name for the
ArchBaseFlow#exportToDirAsync
function that will be used when the exported Architect flow is created.
Bug Fixes
- We are releasing version 0.17.1 of Architect Scripting due to a regression found using the
ArchActionTransferToAcd#inQueueHandlingFlowInfo
property getter when theArchActionTransferToAcd
action is in a common module flow. The notes from version 0.17.0 apply to this release of Architect Scripting.
0.17.0
Improvements
- We added additional logging for when a user or OAuth client does not have the necessary permissions configured to create a flow in a division.
Bug Fixes
-
We fixed an issue where the reported Architect Scripting version would be one version behind when running in verbose mode.
-
We updated retry handling if Architect Scripting receives a 429 HTTP return status code when making calls to the Genesys Cloud Public API so that it now processes the returned retry-after headers.
0.16.0
New Features
- We added support for the
Common Module flow type
and theCall Common Module
action.
Improvements
- We added an
ArchBaseActionBot#intentNames
property which returns a string array of unique intent names configured for the selected bot.
Bug Fixes
-
We updated the inheritance for the
Call Bot Flow
action fromArchBaseActionWithOutputs
toArchBaseAction
because there are no action outputs to work with. -
We fixed an issue where passing in
Draft
as the environment forArchBaseActionDialogflow#setDialogflowAgentByIdWithEnvironmentAsync
would cause an error to be thrown saying that Scripting could not find an environment with the name-
.
0.15.1
Bug Fixes
- We fixed an issue where setting the
ArchAudioCase#enabled
property to true would not persist when loading the flow, when theArchAudioCase
is set to use a custom expression.
0.15.0
New Features
- We added support for the
Call Lex V2 Bot
action.
Bug Fixes
- We fixed an issue where performing a YAML export of a flow that contained an
ArchActionTransferToVoicemail
action with a voicemail script with no inputs would fail.
0.14.0
New Features
- We added support for the
Add Flow Milestone
action.
Improvements
- We added support for a new
ArchBaseActionNoInputNoMatch#voiceEndOfInputTimeout
setting which lets you configure the timeout that should be used by an action when a participant is responding through a voice channel in a bot flow. As an example, you can specify a voice end of input timeout value on theArchActionAskForIntent
andArchActionLoopAnythingElse
actions .
0.13.3
Improvements
- Architect Scripting no longer logs the Buffer() deprecation warning message after calling
ArchSession#startWithClientIdAndSecret
andArchSession#startWithAuthToken
.
0.13.2
Improvements
- We added the
ArchBaseFlow#getExportFilePath
function that will return the file path where a flow export will be written when calling theArchBaseFlow#exportToDirAsync
function for the supplied destination directory and flow format.
0.13.1
Bug Fixes
-
We added the
ArchActionCallBotFlow#inputText
property and fixed a few documentation issues. -
We fixed some missing property and function documentation for the
ArchActionCallLexBot
andArchBaseActionLex
classes.
0.13.0
Improvements
- We updated the minimum Node version required to use Architect Scripting to 12.0.0. This is reflected in Architect Scripting's package.json file. Node Package Manager (npm) will use this to check your installed Node version when installing the Architect Scripting SDK so when using Node be sure to have 12.0.0 or higher installed. Thanks!
Bug Fixes
-
We fixed a problem with the
ArchEnums#FLOW_TYPES
map documentation which incorrectly listed the inboundCall and secureCall keys twice. There were no changes made to the actual enum itself as it was just a documentation fix. -
We fixed an issue with the
ArchBaseActionFlowOutcome#setFlowOutcomeByNameAsync
function that could cause it to error out when searching for a flow outcome by name, saying there are multiple flow outcomes with the same name configured for the organization when there is actually only one flow outcome with that name.
0.12.2
Bug Fixes
- We fixed an issue with the
traverse
method when traversing aSurvey Invite flow
from the root flow level. During processing it would encounter an internal error trying to traverse theArchBaseFlow#settingsSupportedLanguages
property on the flow which is not valid for survey invite flow types.
0.12.1
Bug Fixes
- We removed some instances where customer data could have been included when making calls to Genesys Cloud's logging endpoints. Architect Scripting is built on top of the Architect core framework, which calls these endpoints. This change does not impact
Architect Scripting's logging
functionality, which by default writes to the console.
0.12.0
Improvements
-
We added the ability to set a
flow format type
for theArchBaseFlow#exportToObjectAsync
andArchBaseFlow#exportToDirAsync
functions. If no flow format is used, it will default to the Architect format. -
When
creating a bot flow
and the caller specifies natural language understanding meta data in the creationData parameter, Architect Scripting is now properly ensuring that entity names configured under entityTypeBindings entries in the creationData JSON comply with Architect variable naming rules. For example, you cannot put a space in an entity type name since Architect cannot create a slot variable, or any variable for that matter, whose name has a space in it.
Bug Fixes
- We added a new
ArchDataType#isScriptCreatableForFlow
method which reports whether a data type is script / user createable for a given flow instance. If you have anflow
instance and want to know if a data type is script createable in that flow, we recommend that you switch code to use this method instead ofArchDataType#isScriptCreatableForFlowType
.
0.11.2
New Features
- We added a new
ArchValueSettings.allowInvalidExpressionText
property which if set to true lets code set invalid expression text ( i.e. '3 + ' ) when calling methods that set expression text likeArchBaseValue#setExpression
and it will no longer throw. Obviously if the expression text is invalid there will still be a flow validation error for the expression but the Architect Scripting session will no longer terminate execution because of this and execution will continue.
Improvements
- We updated the documentation for
ArchActionEvaluateSchedule#scheduleTimeZone
to include information about not using the timezone offset when setting the string value on this property.
Bug Fixes
-
We fixed a problem when calling
ArchBaseFlow#addVariable
,ArchState#addVariable
orArchTask#addVariable
where a caller tried to create a variable whose value was a complex collection type. The Architect Scripting bits were incorrectly creating a singleton value for the variable instead of a complex collection which is now fixed. -
We updated the documentation for the
ArchActionSendAutoReply#from
property because its description text incorrectly stated it was an inter-digit duration. -
We fixed an issue where the
ArchSpeechRecTermContainer.containsTerms
function would return the term supplied by the caller to the method if it was found or undefined if not found. The method now correctly returns a boolean true if the term is found and false if not.
0.11.1
Improvements
- We added support for the
Associate External Contact
action.
Bug Fixes
-
We fixed an issue where the return type was showing
ArchActionPlayEstimatedWaitTime
instead ofArchActionPlayAudioOnSilence
for theArchFactoryActions#addActionPlayAudioOnSilence
function. -
We fixed a problem with the
ArchState#addVariable
method that would not let you add a Bot. variable when calling the addVariable method on anArchStateBot
instance in a bot flow. -
We fixed a problem where documentation for the
ArchBaseActionAsk
class andArchActionOutput#enabled
property were not being generated. This missing class caused broken extend links on theArchActionAskForBoolean
,ArchActionLoopAnythingElse
andArchActionAskForIntent
action class documentation which is now fixed. TheArchActionCommunicate
action is now properly documented as inheriting from theArchBaseAction
class as well.
0.11.0
New Features
- We are happy to announce that this version of Architect Scripting adds support for Architect bot flows! If your organization supports bot flows, you'll see that we have a new
ArchFlowBot
flow type, anArchFactoryFlows#createFlowBotAsync
method to create a bot flow, newdate only
andtime only
data types for use in bot flows,ArchVariableDate
andArchVariableTime
variable types, corresponding collection value types / variables, new actions you can use in bot flows likeArchActionAskForIntent
,ArchActionAskForSlot
,ArchActionLoopAnythingElse
,ArchActionLoopUntil
, and more. Enjoy!
Improvements
-
We added a new
ArchActionWait#trimDurationNearMaxRunningTime
property that specifies whether or not the Wait action should trim the wait duration configured on the action at runtime so it does not specify a value that is too long which would end up invoke flow error handling. -
We added an
ArchActionWait#isArchActionWait
property to indicate if an action is an ArchActionWait instance.
Bug Fixes
- We fixed an issue where accessing the
ArchFlowInfo#hasSavedVersion
property would incorrectly throw an error instead of returning a boolean value.
0.10.2
New Features
- We added a new location string value to
ArchEnums#LOCATIONS
to enable usage of Architect Scripting in Mumbai ('prod_ap_south_1').
0.10.1
Improvements
- We added a [dataType]{@linkArchBaseVariable#dataType} property to the
ArchBaseVariable
class that will return the variable's data type.
Bug Fixes
-
We fixed an issue where setting a
ArchMenuSubMenu
as the target menu on anArchActionJumpToMenu
could result in a publish failure. -
We fixed an issue where calling
ArchActionSetFlowOutcome#setFlowOutcomeValue
would log the flow outcome value as being set to undefined. -
We fixed an issue where accessing the
valueText
property on anArchBaseValueCollection
would return duplicate values.
0.10.0
New Features
- We added
eventName
,intentProbability
andsessionVariableOutputs
properties to theArchActionCallDialogflowBot
action. Session input variables remain accessible via theArchBaseActionBot#sessionVariables
property.
Improvements
- We added an
ArchDefinitionFlow#availableLanguages
property that returns an array of the available languages that can be configured as asupported language
on the flow type.
0.9.2
Improvements
- We are releasing version 0.9.2 of Architect Scripting due to problems encountered publishing 0.9.1 to npm. The notes from version 0.9.1 apply to this release of Architect Scripting.
0.9.1
New Features
- We added the functions
ArchActionCallDialogflowBot#setDialogflowAgentByNameWithEnvironmentAsync
andArchActionCallDialogflowBot#setDialogflowAgentByIdWithEnvironmentAsync
to support specifying an environment to use on a Dialogflow agent.
0.9.0
Improvements
-
We updated the minimum Node version required to use Architect Scripting to 10.0.0. This is reflected in Architect Scripting's package.json file. Node Package Manager (npm) will use this to check your installed Node version when installing the Architect Scripting SDK so when using Node be sure to have 10.0.0 or higher installed. Thanks!
-
We updated wording in various places in the Architect Scripting documentation to use Genesys Cloud instead of PureCloud.
Bug Fixes
- We fixed an internal binding issue in the
ArchValueGroupCollection#addLiteralByGroupNameAsync
andArchValueGroupCollection#addLiteralByGroupIdAsync
methods which caused the methods to fail if called.
0.8.8
Improvements
- We added an
ArchDataType#isAnAnyType
property that returns whether or not a data type is an Architect Any data type. For example, if there was a function implementation in the expression help that takes an Any type parameter, if this property returned true that means it is valid to use for that parameter.
0.8.7
Bug Fixes
-
We added a new
ArchValueCurrency#setLiteralAmountAndCode
function that allows you to set a literal currency value by specifying an amount and an optional ISO 4217 currency code. -
We fixed an issue with
ArchSession#startWithAuthToken
where it would not correctly throw an error and exit if an invalid authToken was provided. -
We added the
ArchSettingsMenu#extensionDialingMaxDelay
property so that it's available onArchSettingsMenu
in addition toArchSettingsMenuFlow
. -
We fixed an internal problem with the
ArchBranch
class when accessing theArchBranch#logStr
property that caused Architect Scripting to log an 'object ArchBranch does not implement logStr and a log string is being requested. Returning default string.' error.
0.8.6
Improvements
- We added an
ArchLanguage#getDefaultTtsEngine
method to get the default text to speech engine for the current language and anArchLanguage#getDefaultTtsEngineVoice
to get the default voice for the default text to speech engine.
Bug Fixes
- We fixed an issue where the
ArchTask#addBranch
property would allow duplicate branches to be added to anArchTask
.
0.8.5
Bug Fixes
- We fixed an issue where the
ArchFlowInQueueCall#settingsPrompts
was not able to be configured for anArchFlowInQueueCall
flow.
0.8.4
Improvements
-
We added the
ArchActionHoldMusic#bargeInEnabled
property to allow setting whether or not barge-in should be enabled while hold music is playing. -
We updated the
ArchActionCollectInput
action with two newArchActionCollectInput#acceptJustStar
andArchActionCollectInput#acceptJustPound
properties as well as a new additional optional parameter on theArchActionCollectInput#setDigitsRange
method that lets you specify whether or not to include the terminating DTMF in the returned input data string variable.
Bug Fixes
-
We fixed an issue where the
ArchActionHoldMusic
action did not have anArchActionHoldMusic#isArchActionHoldMusic
property. -
We fixed an issue where the
ArchTask#branchCount
getter would throw an error if accessing it from a task thatdoes not support output branches
. -
We fixed the documentation for the
ArchAsyncTracker#allSettled
function so it will begin showing up on the documentation page forArchAsyncTracker
. -
We updated the documentation for
ArchActionTransferToVoicemail#scriptInputs
method. It now has links that will navigate to the information forArchActionTransferToVoicemail#setScriptByNameAsync
andArchActionTransferToVoicemail#setScriptByIdAsync
. -
We added foundational improvements when searching through large lists of items using async functions such as
ArchActionDataTableLookup#setDataTableByNameAsync
. -
We updated the documentation on the
ArchActionTransferToAcd#addLiteralBySkillNameAsync
method to indicate skill name lookups are performed case sensitively.
0.8.3
Improvements
- We fixed a problem where accessing the
targetTask
property wasn't returning the correctArchTask
unless the setter had been called previously on anArchActionJumpToTask
instance.
Bug Fixes
- We fixed the
ArchMenuTransferToFlowSecure#actionTransferToFlowSecure
property getter documentation so it shows the correct return type ofArchActionTransferToFlowSecure
instead ofArchActionTransferToFlow
.
0.8.2
New Features
- We added a new
ArchFactoryMenus#addMenuReturnToAgent
method that lets you add a Return to Agent menu. It works similarly to theArchFactoryActions#addActionReturnToAgent
method that adds a Return to Agent action to an action container.
Bug Fixes
-
We fixed a problem where accessing the
targetTask
ortargetState
property wasn't returning the correctArchTask
orArchState
unless the setter had been called previously on anArchActionCallTask
orArchActionChangeState
instance. -
We fixed a problem where accessing the
targetBranch
property wasn't returning the correctArchBranch
unless the setter had been called previously on anArchActionEndTask
instance.
0.8.1
Improvements
-
We added the two new properties
ArchBaseAction#parentTask
andArchBaseAction#parentState
to theArchBaseAction
class. These getters return the task or the state that the action belongs to (if applicable). These getters work similarly to theArchBaseAction#parentMenuChoice
property. -
We added a new
ArchTask#getBranchByName
method which will let you get a task branch by its name case-insensitively.
Bug Fixes
-
We updated the Architect Scripting documentation on the
ArchEnums#LOCATIONS
object to fix a duplicatedprod_ap_northeast_1
key so that it now has both aprod_ap_northeast_1
and aprod_ap_northeast_2
key. -
We updated internal asynchronous operation ( promise ) handling in
ArchAsyncTracker
to better handle longer running code that calls asynchronous functions in Architect Scripting while other asynchronous operations are not resolved. This usage pattern could have resulted in the following error, which was not expected behavior:allSettled called more than 50 times waiting for async operation(s) to complete. Not going to wait anymore.
. The operation tracker incorrectly thought that work had stalled because its internal operation bucket had pending operations in it when it checked 50 times in a row and threw the above error, even though the pending operations in the bucket were different and it should have kept waiting and not thrown an error.
0.8.0
Improvements
- We added support for the
ArchActionSearchExternalContacts
action.
Bug Fixes
- We fixed some action output discrepancies when dealing with menu choice actions such as
ArchMenuTransferToAcd#actionTransferToAcd
and accessing action outputs on those actions. Whenever you access outputs on an action associated with a menu choice via theArchBaseActionWithOutputs#outputs
property getter, the returned array was empty as expected. If you accessed theArchBaseActionWithOutputs#outputCount
property, though, it would return a count of 2 in theArchActionTransferToAcd
case, which is not correct and should have been 0. Similarly, accessing thefailure output
would have returned anArchActionOutput
instance, which was also incorrect. Granted, you couldn't add any actions to it, but attempting to get at an action output for a menu choice action will now return nothing. Due to the fact we've now made this behavior consistent across the various properties and action output getters or functions likeArchBaseActionWithOutputs#getOutputById
, we decided to make this a minor version bump to Architect Scripting.
0.7.4
Improvements
- We added a new "found" output ID string value to
ArchEnums#OUTPUT_IDS
.
0.7.3
Improvements
- We added a new
supportsSecureVariables
property to flow definitions that lets you know if a flow type supports secure variables or not.
0.7.2
Improvements
-
We added a new
ArchActionExtractSecureData#statements
property that provides access to the update data statements on this action. -
We added a new location string value to
ArchEnums#LOCATIONS
to enable usage of Architect Scripting in Seoul ( 'prod_ap_northeast_2' ). -
We added a new location string value to
ArchEnums#LOCATIONS
to enable usage of Architect Scripting in Canada ( 'prod_ca_central_1' ). -
We added a new location string value to
ArchEnums#LOCATIONS
to enable usage of Architect Scripting in London ( 'prod_eu_west_2' ).
Bug Fixes
- We fixed an issue where accessing the
ArchActionExtractSecureData#hasSecureDataAcknowledgement
property returned a string value instead of a boolean.
0.7.1
Bug Fixes
- We made a couple flow type availability updates to some complex data types that were incorrectly saying they were available in inbound chat flows when they shouldn't have been.
0.7.0
Improvements
-
We fixed an issue where calling
ArchBaseCoreObject#traverse
can throw an exception in some specific cases. -
We added a new
ArchActionCallDialogflowBot
class which adds support for the Call Dialogflow Bot action in Architect. -
We improved error logging when authenticating using
ArchSession#startWithClientIdAndSecret
andArchSession#startWithAuthToken
to include more information in the event of an authentication failure. -
We added a new
ArchActionCallLexBot#sessionVariables
property that provides access to the session variables on a Call Lex Bot action. -
We added a
canAddAction
method that returns whether or not an action can be added to an action container. -
We added additional properties to the
ArchFlowInfo
class which lets you access information about a flow like whether a flow ischecked in
, itschecked in version
, if a flow islocked
, if it ispublished
and itspublished version
.
0.6.6
Improvements
- We added a new
ArchValueAudio#valueText
property that lets you access the custom expression text for an audio case.
0.6.5
Improvements
- We added a new categoryName optional string parameter to the
ArchActionCallData#setDataActionByNameAsync
andArchActionCallDataSecure#setDataSecureActionByNameAsync
methods that let you specify the name of the category to which the action must belong. This functionality can be used to disambiguate data actions that have the same name but belong to different categories in an organization.
0.6.4
Bug Fixes
-
We fixed an issue with the online documentation that caused it to show some internal Architect Scripting properties in the Global namespace.
-
The
ArchEnums#LOCATIONS
enumeration in Architect Scripting's online documentation was missing an entry for prod_eu_central_1. This is now added. The value itself was in the enum so this is just a documentation update.
0.6.3
Bug Fixes
- We fixed an issue with the
ArchActionCallLexBot
documentation to correctly reflect it extends from theArchBaseActionBot
class. Also, the documentation forArchEnums#EVENTS_FLOW_ERROR_HANDLING
had an incorrect 'transferToTask' key listed when it should have been 'jumpToTask' which is corrected in the documentation as well.
0.6.2
Improvements
- We added a new
ArchLanguage#getTtsEnginesForFlowType
method that lets you get the text to speech engines available for a specified flow type in that language.
0.6.1
Improvements
- We added a new
ArchSettingsEventErrorFlow#isErrorHandlingTypeAvailable
method where you can query whether or not a value fromArchEnums#EVENTS_FLOW_ERROR_HANDLING
is valid to set on theArchSettingsEventErrorFlow#handling
property since setting an invalid value will throw.
0.6.0
New Features
- We're excited to announce Architect Scripting now supports OAuth clients with client credential grants in addition to code authorization grants. Are you tired of starting an Architect Scripting session with a client id and secret where Scripting opens a tab that says "You may close this window now." or asking for a user email and password? Well, you now have an option to use an OAuth client with a client credentials grant on the
ArchSession#startWithClientIdAndSecret
method. It has a new isClientCredentialsOAuthClient boolean parameter where you can pass true if you want the supplied client id and secret to be treated by Architect Scripting as an OAuth client with a client credentials grant. Changes made by client credential OAuth clients will be reflected in Architect as coming from that OAuth client and not a user since there is no user associated with the OAuth client with this grant type. What's nice is this also means that when using a client credentials OAuth client, you no longer have to deal with any kind of UI popping when calling theArchSession#startWithClientIdAndSecret
method. It's very handy for automated environments where you never want any UI, and unlike using an auth token for authorization, the client id and secret for this grant type don't expire after a period of time.
Improvements
- We added a
languagesSupportDefaultLanguageSkill
andlanguagesSupportTtsAndAsr
properties on theArchDefinitionFlow
class that provides metadata about whether or not supported languages have either a default language skill setting or text to speech and speech recognition settings available for a flow type.
0.5.6
Bug Fixes
- We fixed an issue where Architect Scripting would not end the scripting session properly after calling
ArchSession#startWithClientIdAndSecret
orArchSession#startWithAuthToken
when the authenticated user did not have the 'architect:ui:view' permission.
0.5.5
New Features
- We added new
ArchDefinitionValue
andArchDefinitionVariable
classes that can be accessed via theArchBaseValue.definition
andArchBaseVariable.definition
properties.
Improvements
- We added a minimum Node engine version of 8.0.0 to Architect Scripting's package.json file. Node package manager (npm) will use this check your installed Node version when installing the Architect Scripting SDK so when using Node be sure to have 8.0.0 or higher installed. Thanks!
0.5.4
Improvements
- We added an
isComplex
property toArchDataType
which returns whether or not a data type is a complex type.
0.5.3
Improvements
- We added the ability on the
ArchActionGetResponse#setResponseByNameAsync
to specify a response library via. a new optional string responseLibraryName parameter. If a library name is specified, the named response must belong to that library. This additional functionality provides the ability to disambiguate responses that have the same name but reside in different response libraries for an organization.
Bug Fixes
- The
ArchEnums#ERROR_TYPE_LEX_BOT_VALUES
object had an incorrect noLexBotResourceError key value pair. The entry is now corrected to a noResourceValue key value pair.
0.5.2
Bug Fixes
- We fixed up documentation for the
ArchBaseActionWithOutputs#getOutputByIndex
method because it didn't have the index parameter documented properly. TheArchActionEvaluateSchedule
andArchActionEvaluateScheduleGroup
actions now have helper properties to get at outputs such asArchActionEvaluateScheduleGroup#outputOpen
. We also made a couple of other metadata fixes which didn't impact Architect Scripting's runtime code itself but caused some incorrect entries in the Architect Scripting TypeScript definition file.
0.5.1
Improvements
- We added an
ArchBaseFlow#addVariable
method similar to theArchTask#addVariable
andArchState#addVariable
methods which lets you add flow scoped variables directly.ArchBaseVariable
also has a newArchBaseVariable#isFlowVariable
property similar toArchBaseVariable#isTaskVariable
andArchBaseVariable#isStateVariable
that you can call to see if a variable is a flow level variable.
0.5.0
Bug Fixes
- The getter for the action output
id
property was improperly returning an Architect internal output identifier string value for known outputs rather than an output identifier string that comes fromArchEnums#OUTPUT_IDS_ALL
. An example of a known output is one which does not return a guid string identifier such as theyes
output on anArchActionDecision
action. A dynamic output would be an output which does have a guid string identifier such as an output that represents an intent on anArchActionCallLexBot
action.
0.4.0
Improvements
- We made various updates to the Architect Scripting documentation in this release and decided to bump the Architect Scripting version itself to 0.4.0 because the Architect Scripting package itself now contains more metadata about Architect Scripting objects in a TypeScript definition file. Certain development environments can read this metadata and use it to provide a nicer development experience such as providing typeahead suggestions while coding with Architect Scripting objects.
0.3.4
Improvements
- We added a new
ArchActionCallDataSecure#setDataSecureActionByNameAsync
method where you can configure the data action on aCall Secure Data Action
instance.
0.3.3
Improvements
- We added the ability to set the
processing prompt
on aCall Bridge Action
instance.
0.3.2
New Features
- We added a new
ArchActionCallLexBot#setLexBotAliasByNameAsync
method where you can configure the Lex Bot Alias on aCall Lex Bot
instance by its name.
Bug Fixes
- We fixed a problem with the
ArchFlowInfo#isLockedByAnotherUser
property getter always returning false.
0.3.1
Bug Fixes
- We updated our internal documentation generation tool to resolve some issues where generated documentation was not showing the information we expected it to be.
0.3.0
New Features
-
We added an Architect Scripting
Information
instance that provides information about Architect Scripting itself. It only has one property in it right now but you can now access the version of Architect Scripting you are using by accessing theArchScriptingInfo.version
property. -
We added a new
ArchActionGetResponse#setResponseByNameAsync
method where you can configure the response on aGet Response Action
instance by looking up a canned response by name.
Improvements
- When running Architect Scripting under node, we updated the minimum required node runtime version from 4.5.0 to 8.0.0. As with previous versions of Architect Scripting, if this minimum version requirement is not met when running under node, Architect Scripting will exit.
Bug Fixes
- We fixed an issue where Architect Scripting may have reported its version incorrectly when invoking the startWithClientIdAndSecret / auth token session methods.
0.2.9
Improvements
- We added a new
ArchBaseActionFlowOutcome#setFlowOutcomeByNameAsync
method where you can configure the flow outcome the action should use at runtime for either anInitialize Flow Outcome
or aSet Flow Outcome
instance.
Bug Fixes
-
We fixed an issue with Architect Scripting that could cause it not to retry network requests at a later time if it was being rate limited by the Genesys Cloud public api ( 429 handling ).
-
The prompt data type is now available for use in inbound chat flows in Architect Scripting.
0.2.8
Improvements
- We added
ArchActionDataTableLookup#setDataTableByNameAsync
andArchActionDataTableLookup#setDataTableByIdAsync
methods that let you configure the data table on theData Table Lookup
instance. We also added a newArchActionCallData#setDataActionByNameAsync
method where you can configure the data action on aCall Data Action
instance.
Bug Fixes
- We updated the
ArchFactoryStates#addState
andArchFactoryTasks#addTask
methods so that the name parameter is optional instead of required. If no name is specified, a default name will be assigned by Architect Scripting to the newly created state or task. We also added a newArchBaseAction#parentFlow
property on actions which gives access to theparent flow
flow that contains the action.
0.2.7
New Features
- This update adds support for the AWS us-west-2 region in Architect Scripting. We added a new 'prod_us_west_2' entry in the
ArchEnums#LOCATIONS
enum.
Bug Fixes
-
We fixed a problem where the
ArchValueSettings#isInput
andArchValueSettings#isOutput
properties may not return the proper boolean value. -
Fixed an issue where setting the
default menu
on asub-menu
did not set the default menu properly. -
This fixes an issue with the
ArchFactoryMenus#addMenuChoiceFromDefinition
function which was incorrectly always creating ArchMenuSubMenu instances even when the definition was for a different menu choice. -
Fixed an issue setting a literal decimal value to 0.0 using the
ArchValueDecimal#setLiteralDecimal
method which when a flow was loaded would show a validation error even though the literal decimal value looked to be 0 if the flow was opened in the Architect UI.
0.2.6
Bug Fixes
-
Fixed a documentation error in the
ArchFactoryActions#addActionFindUserPrompt
documentation which said it returned a Find System Prompt action when it should have said it returns a Find User Prompt action. -
We fixed a problem with Architect's expression parser when processing the "." property accessor operator which, under some circumstances, was reporting an expression as invalid when it shouldn't have been.
-
Fixes superfluous console error traces with "_setOptionIfSet(setter)" in the string. These traces do not affect functionality but can be numerous especially when using a Switch Action.
0.2.5
Bug Fixes
- Miscellaneous documentation updates
0.2.4
Improvements
-
startWithClientIdAndSecret
andstartWithAuthToken
now return a promise that will resolve when the session's end processing is complete. If theendTerminatesProcess
property is true, this promise will not resolve since the process will be terminated by Architect Scripting during session end processing. -
While it's possible to write your own code to iterate over objects within a flow and may be what you want to do, we wanted to let you know we've added a
ArchBaseCoreObject#traverse
helper method that will iterate over an object and contents within it in a generic fashion. There is additionalfiltering
capabilities that optionally can be used with traversal or on its own to see if an objectmatches
filter criteria.
Bug Fixes
-
Fixed an internal Architect Scripting problem if code attempted to access the
ArchBaseFlowInboundOutboundSecureCall#startUpObject
property on a call flow prior to configuring a startup menu or task. Accessing this property when the flow has no startup menu or task configured now returns null. -
Fixed a problem with the
ArchFactoryActions#addActionHoldMusic
function where the hold music action creation could fail if duration expression text string was specified.
0.2.3
Improvements
- We added
ArchActionCreateCallback#setScriptByIdAsync
,ArchActionSetScreenPop#setScriptByIdAsync
, andArchActionTransferToVoicemail#setScriptByIdAsync
functions which will let you assign a script by a scripts's identifier. Also addedArchActionCallBridge#setBridgeActionByIdAsync
function which will let you assign a Bridge action by its identifier.
Bug Fixes
- Fixed an internal issue with Scripting's asynchronous processing promise handling to address an issue with the Scripting session ending prematurely.
0.2.2
New Features
- Since we use Architect Scripting internally when developing new features and/or beta testing, you'll see that Architect Scripting has a new
inbound chat flow
type. Please note that inbound chat flows are not generally available for use as of 2/13/19.
Improvements
- We added an optional boolean parameter to the
ArchSession#end
function which lets you specify whether or not to wait for any pending asynchronous work to complete before Architect Scripting ends the session. If your code calls the end method directly, current behavior is maintained in that end does not wait for pending work to complete but you can enable that behavior by passing in a true. If Architect Scripting itself is ending the current session, the behavior is that it will wait for any pending work to complete prior to ending the session.
0.2.1
Improvements
-
We added a new
ArchValuePrompt#setLiteralByPromptIdAsync
function which will let you assign a prompt literal to a prompt value by a prompt's identifier. This works for both user and system prompt identifiers. -
We added the
ArchFlowInQueueCall#settingsInQueueCall
property to in-queue call flows that provides access to aArchSettingsInQueueCallFlow
instance which has ahold music
property where you can set the hold music configured for an in-queue call flow via Scripting now. -
We added a new
ArchActionTransferToVoicemail#isTargetTransferTypeAvailable
function to the ArchActionTransferToVoicemail action which can be used to determine voicemail transfer target type availability.
Bug Fixes
- We fixed up the
ArchEnums#FLOW_TYPES_ALL
array so its contents match up with theArchEnums#FLOW_TYPES
map. It had an extra string that shouldn't have been there. Additionally, theArchEnums#ERROR_TYPE_LEX_BOT_VALUES
map had a key with the name of featureNotEnabled which has been updated to featureNotEnabledError to be consistent with the other entries so if you referencedArchEnums#ERROR_TYPE_LEX_BOT_VALUES
.featureNotEnabled you'll want to update your code to useArchEnums#ERROR_TYPE_LEX_BOT_VALUES
.featureNotEnabledError instead. Note that this entry is being kept around for consistency with other Architect core bits but the Call Lex Bot action functionality is now generally available so this error should not be seen at runtime anymore in flow types that support the Call Lex Bot action.
0.2.0
Bug Fixes
-
Fixed a problem with the
ArchFactoryActions#addActionHoldMusic
function where the hold music action creation could fail if duration expression text string was specified. -
Fixed a problem with Architect Scripting at startup where if the Scripting runtime detected it was running under Node ver. 8.0.0 to 8.0.7 you would see a console warning saying you should to upgrade to Node 8.0.0 or higher even though that was already the case.
-
Fixed a problem with the
ArchDefinitionFlow#supportsSupportedLanguages
property not returning the correct value. -
We fixed a problem with the
ArchFactoryFlows.checkoutAndLoadFlowByFlowIdAsync
method which would report a "Error: TypeError: Cannot read property 'exception' of undefined – [ArchAsyncTracker]" error if the flow wasn't already checked out. -
We fixed a problem when calling
ArchSettingsOutboundCallFlow#setContactListLiteralByContactListIdAsync
where execution would encounter an undefined function setLiteralByContactListIdAsync and exit. Note thatArchSettingsOutboundCallFlow#setContactListLiteralByContactListNameAsync
did not have this error. To fix this, we updated theArchValueContactList#setLiteralByContactListIdAsync
andArchValueContactList#setLiteralByContactListNameAsync
methods on the ArchValueContactList class to be consistently cased with other method names so they have a capital C instead of lower case c for ContactList in the method names. -
While it didn't impact the resulting import, we fixed some internal flow cleanup issues when calling
ArchBaseFlow.importFromFileAsync
that could have resulted in console output errors regarding overriding existing event sinks when the import call was made. -
We updated the documentation for the
ArchValueAudio#setExpressionToAudioTTS
andArchValueAudio#setLiteralTTS
methods. -
Documentation Updates - Updated
ArchMenuDialByExtension
class header documentation with some See links similar to what other ArchMenu classes have. We also updated the documentation of some action properties on other ArchMenu classes to properly reflect that they are readonly. The updated readonly updates were made toArchMenuDisconnect#actionDisconnect
,ArchMenuJumpToMenu#actionJumpToMenu
,ArchActionJumpToTask#actionJumpToTask
andArchMenuRepeatMenu#actionRepeatMenu
.
Miscellaneous
- The
ArchActionGetResponse
action was updated so you have access to the success and failure outputs in Scripting.
0.1.0
New Features
- We added a new
settingsSupportedLanguages
property and are deprecating the existinglanguageSettings
property to be consistent with other flow settings related properties. If you were accessing thelanguageSettings
property, please update your code to use the newsettingsSupportedLanguages
property instead. In the meantime, accessing thelanguageSettings
will simply call through to thesettingsSupportedLanguages
property and log a warning. ThesettingsSupportedLanguages
property provides access to flow supported languages and their settings. Asupported language's
settings instance now has adefaultLanguageSkill
language skill value property where you can set the default language skill for a supported language.
Improvements
-
We've added some new definition classes which provide information about flows, actions and menus. For example you can see if an action is available for a particular flow type by accessing the
ArchDefinitionAction#isAvailableForFlowType
without having to have an instance of the action created. Remember that you need to have a connected session when working with definitions since configuration of what is and isn't available to Scripting will be determined by meta data returned from the cloud at session startup. Here is some pseudo code that shows how to access the disconnect action to see if it's available for use in an inbound call flow type:scripting.viewModels.actions.ArchActionDisconnect.definition.isAvailableForFlowType(scripting.enums.archEnums.FLOW_TYPES.inboundCall);
Architect Scripting documentation updates in addition to this include. various inconsistencies in "is" properties documentation was updated to reflect that it's readonly and not static. When running under Node, Architect Scripting is now going to emit a console warning when the version of node is less than 8.0. We're planning to update the minimum Node requirements for Architect Scripting in a future versioned Architect Scripting release but wanted to start getting warning traces out there in the meantime so you can update ahead of time. -
Now that support for dynamic prompt lookups is generally available, we've removed some internal dynamic prompt availability checks in Architect Scripting code.
-
While it's not generally available yet as of Dec. 14th, 2018, we're introducing support in Architect Scripting for internal development purposes to allow specification of additional text to speech engines and voices for supported languages in call flows. Therefore you'll see new classes like
ArchTtsEngines
,ArchTtsEngine
,ArchTtsVoice
in Architect Scripting and new properties that deal with text to speech engines and voices. We have theareTtsEnginesAndVoicesAvailable
property which will let you know if text to speech engine and voices are available for an organization. Stay tuned!
0.0.25
Improvements
- Updated the main Architect Scripting readme.
0.0.23
Improvements
-
Updated documentation in
ArchFactoryFlows
to fix up some missing callback links on flow creation methods as well as added more documentation on non-call flow creation functions when an initial starting state is automatically added by Architect Scripting as part of the creation call. -
We added retry improvements in Architect Scripting to better deal with cases when network calls return a 504 / gateway timeout HTTP error status code.
0.0.21
Bug Fixes
- The
addActionSwitch
method on the ArchFactoryActions instance now allows for an array of strings to be passed in when creating the action to specify expressions for individual cases on the newly created switch action. Similarly, on the ArchActionSwitch class, the setExpressionSwitch also allows for a string array as well as a string to configure expression text on individual cases on the switch action.