Package com.mypurecloud.sdk.v2.api

Class IntegrationsApi

java.lang.Object

com.mypurecloud.sdk.v2.api.IntegrationsApi

public class IntegrationsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
IntegrationsApi()
IntegrationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Integration	deleteIntegration(DeleteIntegrationRequest request)	Delete integration.
ApiResponse<Integration>	deleteIntegration(ApiRequest<Void> request)	Delete integration.
Integration	deleteIntegration(String integrationId)	Delete integration.
void	deleteIntegrationsAction(DeleteIntegrationsActionRequest request)	Delete an Action
ApiResponse<Void>	deleteIntegrationsAction(ApiRequest<Void> request)	Delete an Action
void	deleteIntegrationsAction(String actionId)	Delete an Action
void	deleteIntegrationsActionDraft(DeleteIntegrationsActionDraftRequest request)	Delete a Draft
ApiResponse<Void>	deleteIntegrationsActionDraft(ApiRequest<Void> request)	Delete a Draft
void	deleteIntegrationsActionDraft(String actionId)	Delete a Draft
ApiResponse<Void>	deleteIntegrationsActionDraftWithHttpInfo(String actionId)	Delete a Draft
ApiResponse<Void>	deleteIntegrationsActionWithHttpInfo(String actionId)	Delete an Action
void	deleteIntegrationsCredential(DeleteIntegrationsCredentialRequest request)	Delete a set of credentials
ApiResponse<Void>	deleteIntegrationsCredential(ApiRequest<Void> request)	Delete a set of credentials
void	deleteIntegrationsCredential(String credentialId)	Delete a set of credentials
ApiResponse<Void>	deleteIntegrationsCredentialWithHttpInfo(String credentialId)	Delete a set of credentials
ApiResponse<Integration>	deleteIntegrationWithHttpInfo(String integrationId)	Delete integration.
Integration	getIntegration(GetIntegrationRequest request)	Get integration.
ApiResponse<Integration>	getIntegration(ApiRequest<Void> request)	Get integration.
Integration	getIntegration(String integrationId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	Get integration.
IntegrationConfiguration	getIntegrationConfigCurrent(GetIntegrationConfigCurrentRequest request)	Get integration configuration.
ApiResponse<IntegrationConfiguration>	getIntegrationConfigCurrent(ApiRequest<Void> request)	Get integration configuration.
IntegrationConfiguration	getIntegrationConfigCurrent(String integrationId)	Get integration configuration.
ApiResponse<IntegrationConfiguration>	getIntegrationConfigCurrentWithHttpInfo(String integrationId)	Get integration configuration.
IntegrationEntityListing	getIntegrations(GetIntegrationsRequest request)	List integrations
ApiResponse<IntegrationEntityListing>	getIntegrations(ApiRequest<Void> request)	List integrations
IntegrationEntityListing	getIntegrations(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, List<String> ids, String integrationType, String reportedState)	List integrations
Action	getIntegrationsAction(GetIntegrationsActionRequest request)	Retrieves a single Action matching id.
ApiResponse<Action>	getIntegrationsAction(ApiRequest<Void> request)	Retrieves a single Action matching id.
Action	getIntegrationsAction(String actionId, String expand, Boolean flatten, Boolean includeConfig)	Retrieves a single Action matching id.
Action	getIntegrationsActionDraft(GetIntegrationsActionDraftRequest request)	Retrieve a Draft
ApiResponse<Action>	getIntegrationsActionDraft(ApiRequest<Void> request)	Retrieve a Draft
Action	getIntegrationsActionDraft(String actionId, String expand, Boolean flatten, Boolean includeConfig)	Retrieve a Draft
FunctionConfig	getIntegrationsActionDraftFunction(GetIntegrationsActionDraftFunctionRequest request)	Get draft function settings for Action
ApiResponse<FunctionConfig>	getIntegrationsActionDraftFunction(ApiRequest<Void> request)	Get draft function settings for Action
FunctionConfig	getIntegrationsActionDraftFunction(String actionId)	Get draft function settings for Action
ApiResponse<FunctionConfig>	getIntegrationsActionDraftFunctionWithHttpInfo(String actionId)	Get draft function settings for Action
JsonSchemaDocument	getIntegrationsActionDraftSchema(GetIntegrationsActionDraftSchemaRequest request)	Retrieve schema for a Draft based on filename.
ApiResponse<JsonSchemaDocument>	getIntegrationsActionDraftSchema(ApiRequest<Void> request)	Retrieve schema for a Draft based on filename.
JsonSchemaDocument	getIntegrationsActionDraftSchema(String actionId, String fileName, Boolean flatten)	Retrieve schema for a Draft based on filename.
ApiResponse<JsonSchemaDocument>	getIntegrationsActionDraftSchemaWithHttpInfo(String actionId, String fileName, Boolean flatten)	Retrieve schema for a Draft based on filename.
String	getIntegrationsActionDraftTemplate(GetIntegrationsActionDraftTemplateRequest request)	Retrieve templates for a Draft based on filename.
ApiResponse<String>	getIntegrationsActionDraftTemplate(ApiRequest<Void> request)	Retrieve templates for a Draft based on filename.
String	getIntegrationsActionDraftTemplate(String actionId, String fileName)	Retrieve templates for a Draft based on filename.
ApiResponse<String>	getIntegrationsActionDraftTemplateWithHttpInfo(String actionId, String fileName)	Retrieve templates for a Draft based on filename.
DraftValidationResult	getIntegrationsActionDraftValidation(GetIntegrationsActionDraftValidationRequest request)	Validate current Draft configuration.
ApiResponse<DraftValidationResult>	getIntegrationsActionDraftValidation(ApiRequest<Void> request)	Validate current Draft configuration.
DraftValidationResult	getIntegrationsActionDraftValidation(String actionId)	Validate current Draft configuration.
ApiResponse<DraftValidationResult>	getIntegrationsActionDraftValidationWithHttpInfo(String actionId)	Validate current Draft configuration.
ApiResponse<Action>	getIntegrationsActionDraftWithHttpInfo(String actionId, String expand, Boolean flatten, Boolean includeConfig)	Retrieve a Draft
FunctionConfig	getIntegrationsActionFunction(GetIntegrationsActionFunctionRequest request)	Get published function settings for Action
ApiResponse<FunctionConfig>	getIntegrationsActionFunction(ApiRequest<Void> request)	Get published function settings for Action
FunctionConfig	getIntegrationsActionFunction(String actionId)	Get published function settings for Action
ApiResponse<FunctionConfig>	getIntegrationsActionFunctionWithHttpInfo(String actionId)	Get published function settings for Action
ActionEntityListing	getIntegrationsActions(GetIntegrationsActionsRequest request)	Retrieves all actions associated with filters passed in via query param.
ApiResponse<ActionEntityListing>	getIntegrationsActions(ApiRequest<Void> request)	Retrieves all actions associated with filters passed in via query param.
ActionEntityListing	getIntegrationsActions(Integer pageSize, Integer pageNumber, String nextPage, String previousPage, String sortBy, String sortOrder, String category, String name, String ids, String secure, String includeAuthActions, Boolean includeConfig)	Retrieves all actions associated with filters passed in via query param.
CategoryEntityListing	getIntegrationsActionsCategories(GetIntegrationsActionsCategoriesRequest request)	Retrieves all categories of available Actions
ApiResponse<CategoryEntityListing>	getIntegrationsActionsCategories(ApiRequest<Void> request)	Retrieves all categories of available Actions
CategoryEntityListing	getIntegrationsActionsCategories(Integer pageSize, Integer pageNumber, String nextPage, String previousPage, String sortBy, String sortOrder, String secure)	Retrieves all categories of available Actions
ApiResponse<CategoryEntityListing>	getIntegrationsActionsCategoriesWithHttpInfo(Integer pageSize, Integer pageNumber, String nextPage, String previousPage, String sortBy, String sortOrder, String secure)	Retrieves all categories of available Actions
ActionCertificateListing	getIntegrationsActionsCertificates(GetIntegrationsActionsCertificatesRequest request)	Retrieves the available mTLS client certificates in use.
ApiResponse<ActionCertificateListing>	getIntegrationsActionsCertificates(ApiRequest<Void> request)	Retrieves the available mTLS client certificates in use.
ActionCertificateListing	getIntegrationsActionsCertificates(String status, String type)	Retrieves the available mTLS client certificates in use.
TrustedCertificates	getIntegrationsActionsCertificatesTruststore()	Retrieves basic info about trusted root CA certificates
TrustedCertificates	getIntegrationsActionsCertificatesTruststore(GetIntegrationsActionsCertificatesTruststoreRequest request)	Retrieves basic info about trusted root CA certificates
ApiResponse<TrustedCertificates>	getIntegrationsActionsCertificatesTruststore(ApiRequest<Void> request)	Retrieves basic info about trusted root CA certificates
ApiResponse<TrustedCertificates>	getIntegrationsActionsCertificatesTruststoreWithHttpInfo()	Retrieves basic info about trusted root CA certificates
ApiResponse<ActionCertificateListing>	getIntegrationsActionsCertificatesWithHttpInfo(String status, String type)	Retrieves the available mTLS client certificates in use.
JsonSchemaDocument	getIntegrationsActionSchema(GetIntegrationsActionSchemaRequest request)	Retrieve schema for an action based on filename.
ApiResponse<JsonSchemaDocument>	getIntegrationsActionSchema(ApiRequest<Void> request)	Retrieve schema for an action based on filename.
JsonSchemaDocument	getIntegrationsActionSchema(String actionId, String fileName, Boolean flatten)	Retrieve schema for an action based on filename.
ApiResponse<JsonSchemaDocument>	getIntegrationsActionSchemaWithHttpInfo(String actionId, String fileName, Boolean flatten)	Retrieve schema for an action based on filename.
ActionEntityListing	getIntegrationsActionsDrafts(GetIntegrationsActionsDraftsRequest request)	Retrieves all action drafts associated with the filters passed in via query param.
ApiResponse<ActionEntityListing>	getIntegrationsActionsDrafts(ApiRequest<Void> request)	Retrieves all action drafts associated with the filters passed in via query param.
ActionEntityListing	getIntegrationsActionsDrafts(Integer pageSize, Integer pageNumber, String nextPage, String previousPage, String sortBy, String sortOrder, String category, String name, String ids, String secure, String includeAuthActions, Boolean includeConfig)	Retrieves all action drafts associated with the filters passed in via query param.
ApiResponse<ActionEntityListing>	getIntegrationsActionsDraftsWithHttpInfo(Integer pageSize, Integer pageNumber, String nextPage, String previousPage, String sortBy, String sortOrder, String category, String name, String ids, String secure, String includeAuthActions, Boolean includeConfig)	Retrieves all action drafts associated with the filters passed in via query param.
List<FunctionRuntime>	getIntegrationsActionsFunctionsRuntimes()	Get action function settings for Action
List<FunctionRuntime>	getIntegrationsActionsFunctionsRuntimes(GetIntegrationsActionsFunctionsRuntimesRequest request)	Get action function settings for Action
ApiResponse<List<FunctionRuntime>>	getIntegrationsActionsFunctionsRuntimes(ApiRequest<Void> request)	Get action function settings for Action
ApiResponse<List<FunctionRuntime>>	getIntegrationsActionsFunctionsRuntimesWithHttpInfo()	Get action function settings for Action
ApiResponse<ActionEntityListing>	getIntegrationsActionsWithHttpInfo(Integer pageSize, Integer pageNumber, String nextPage, String previousPage, String sortBy, String sortOrder, String category, String name, String ids, String secure, String includeAuthActions, Boolean includeConfig)	Retrieves all actions associated with filters passed in via query param.
String	getIntegrationsActionTemplate(GetIntegrationsActionTemplateRequest request)	Retrieve text of templates for an action based on filename.
ApiResponse<String>	getIntegrationsActionTemplate(ApiRequest<Void> request)	Retrieve text of templates for an action based on filename.
String	getIntegrationsActionTemplate(String actionId, String fileName)	Retrieve text of templates for an action based on filename.
ApiResponse<String>	getIntegrationsActionTemplateWithHttpInfo(String actionId, String fileName)	Retrieve text of templates for an action based on filename.
ApiResponse<Action>	getIntegrationsActionWithHttpInfo(String actionId, String expand, Boolean flatten, Boolean includeConfig)	Retrieves a single Action matching id.
Bot	getIntegrationsBotconnectorBot(GetIntegrationsBotconnectorBotRequest request)	Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
ApiResponse<Bot>	getIntegrationsBotconnectorBot(ApiRequest<Void> request)	Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
Bot	getIntegrationsBotconnectorBot(String integrationId, String botId, String version)	Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
BotListing	getIntegrationsBotconnectorBots(GetIntegrationsBotconnectorBotsRequest request)	Get the list of bots for this integration.
ApiResponse<BotListing>	getIntegrationsBotconnectorBots(ApiRequest<Void> request)	Get the list of bots for this integration.
BotListing	getIntegrationsBotconnectorBots(String integrationId, Integer pageNumber, Integer pageSize)	Get the list of bots for this integration.
BotSummaryEntityListing	getIntegrationsBotconnectorBotsSummaries(GetIntegrationsBotconnectorBotsSummariesRequest request)	Get the summary list of bots for this integration.
ApiResponse<BotSummaryEntityListing>	getIntegrationsBotconnectorBotsSummaries(ApiRequest<Void> request)	Get the summary list of bots for this integration.
BotSummaryEntityListing	getIntegrationsBotconnectorBotsSummaries(String integrationId, Integer pageNumber, Integer pageSize)	Get the summary list of bots for this integration.
ApiResponse<BotSummaryEntityListing>	getIntegrationsBotconnectorBotsSummariesWithHttpInfo(String integrationId, Integer pageNumber, Integer pageSize)	Get the summary list of bots for this integration.
ApiResponse<BotListing>	getIntegrationsBotconnectorBotsWithHttpInfo(String integrationId, Integer pageNumber, Integer pageSize)	Get the list of bots for this integration.
ApiResponse<Bot>	getIntegrationsBotconnectorBotWithHttpInfo(String integrationId, String botId, String version)	Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
BotConnectorBot	getIntegrationsBotconnectorIntegrationIdBot(GetIntegrationsBotconnectorIntegrationIdBotRequest request)	Get a specific botConnector bot, plus versions, for this integration
ApiResponse<BotConnectorBot>	getIntegrationsBotconnectorIntegrationIdBot(ApiRequest<Void> request)	Get a specific botConnector bot, plus versions, for this integration
BotConnectorBot	getIntegrationsBotconnectorIntegrationIdBot(String integrationId, String botId, String version)	Get a specific botConnector bot, plus versions, for this integration
BotList	getIntegrationsBotconnectorIntegrationIdBots(GetIntegrationsBotconnectorIntegrationIdBotsRequest request)	Get a list of botConnector bots for this integration
ApiResponse<BotList>	getIntegrationsBotconnectorIntegrationIdBots(ApiRequest<Void> request)	Get a list of botConnector bots for this integration
BotList	getIntegrationsBotconnectorIntegrationIdBots(String integrationId)	Get a list of botConnector bots for this integration
BotConnectorBotSummaryEntityListing	getIntegrationsBotconnectorIntegrationIdBotsSummaries(GetIntegrationsBotconnectorIntegrationIdBotsSummariesRequest request)	Get a summary list of botConnector bots for this integration
ApiResponse<BotConnectorBotSummaryEntityListing>	getIntegrationsBotconnectorIntegrationIdBotsSummaries(ApiRequest<Void> request)	Get a summary list of botConnector bots for this integration
BotConnectorBotSummaryEntityListing	getIntegrationsBotconnectorIntegrationIdBotsSummaries(String integrationId, Integer pageNumber, Integer pageSize)	Get a summary list of botConnector bots for this integration
ApiResponse<BotConnectorBotSummaryEntityListing>	getIntegrationsBotconnectorIntegrationIdBotsSummariesWithHttpInfo(String integrationId, Integer pageNumber, Integer pageSize)	Get a summary list of botConnector bots for this integration
ApiResponse<BotList>	getIntegrationsBotconnectorIntegrationIdBotsWithHttpInfo(String integrationId)	Get a list of botConnector bots for this integration
BotConnectorBotVersionSummaryEntityListing	getIntegrationsBotconnectorIntegrationIdBotVersions(GetIntegrationsBotconnectorIntegrationIdBotVersionsRequest request)	Get a list of bot versions for a bot
ApiResponse<BotConnectorBotVersionSummaryEntityListing>	getIntegrationsBotconnectorIntegrationIdBotVersions(ApiRequest<Void> request)	Get a list of bot versions for a bot
BotConnectorBotVersionSummaryEntityListing	getIntegrationsBotconnectorIntegrationIdBotVersions(String integrationId, String botId, Integer pageNumber, Integer pageSize)	Get a list of bot versions for a bot
ApiResponse<BotConnectorBotVersionSummaryEntityListing>	getIntegrationsBotconnectorIntegrationIdBotVersionsWithHttpInfo(String integrationId, String botId, Integer pageNumber, Integer pageSize)	Get a list of bot versions for a bot
ApiResponse<BotConnectorBot>	getIntegrationsBotconnectorIntegrationIdBotWithHttpInfo(String integrationId, String botId, String version)	Get a specific botConnector bot, plus versions, for this integration
ClientAppEntityListing	getIntegrationsClientapps(GetIntegrationsClientappsRequest request)	List permitted client app integrations for the logged in user
ApiResponse<ClientAppEntityListing>	getIntegrationsClientapps(ApiRequest<Void> request)	List permitted client app integrations for the logged in user
ClientAppEntityListing	getIntegrationsClientapps(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	List permitted client app integrations for the logged in user
UCIntegrationListing	getIntegrationsClientappsUnifiedcommunications(GetIntegrationsClientappsUnifiedcommunicationsRequest request)	Deprecated.
ApiResponse<UCIntegrationListing>	getIntegrationsClientappsUnifiedcommunications(ApiRequest<Void> request)	Deprecated.
UCIntegrationListing	getIntegrationsClientappsUnifiedcommunications(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	Deprecated.
ApiResponse<UCIntegrationListing>	getIntegrationsClientappsUnifiedcommunicationsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	Deprecated.
ApiResponse<ClientAppEntityListing>	getIntegrationsClientappsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	List permitted client app integrations for the logged in user
Credential	getIntegrationsCredential(GetIntegrationsCredentialRequest request)	Get a single credential with sensitive fields redacted
ApiResponse<Credential>	getIntegrationsCredential(ApiRequest<Void> request)	Get a single credential with sensitive fields redacted
Credential	getIntegrationsCredential(String credentialId)	Get a single credential with sensitive fields redacted
CredentialInfoListing	getIntegrationsCredentials(GetIntegrationsCredentialsRequest request)	Deprecated.
ApiResponse<CredentialInfoListing>	getIntegrationsCredentials(ApiRequest<Void> request)	Deprecated.
CredentialInfoListing	getIntegrationsCredentials(Integer pageNumber, Integer pageSize)	Deprecated.
CredentialInfoCursorListing	getIntegrationsCredentialsListing(GetIntegrationsCredentialsListingRequest request)	List multiple sets of credentials using cursor-based paging
ApiResponse<CredentialInfoCursorListing>	getIntegrationsCredentialsListing(ApiRequest<Void> request)	List multiple sets of credentials using cursor-based paging
CredentialInfoCursorListing	getIntegrationsCredentialsListing(String before, String after, String pageSize)	List multiple sets of credentials using cursor-based paging
ApiResponse<CredentialInfoCursorListing>	getIntegrationsCredentialsListingWithHttpInfo(String before, String after, String pageSize)	List multiple sets of credentials using cursor-based paging
List<CredentialType>	getIntegrationsCredentialsTypes()	List all credential types
List<CredentialType>	getIntegrationsCredentialsTypes(GetIntegrationsCredentialsTypesRequest request)	List all credential types
ApiResponse<List<CredentialType>>	getIntegrationsCredentialsTypes(ApiRequest<Void> request)	List all credential types
ApiResponse<List<CredentialType>>	getIntegrationsCredentialsTypesWithHttpInfo()	List all credential types
ApiResponse<CredentialInfoListing>	getIntegrationsCredentialsWithHttpInfo(Integer pageNumber, Integer pageSize)	Deprecated.
ApiResponse<Credential>	getIntegrationsCredentialWithHttpInfo(String credentialId)	Get a single credential with sensitive fields redacted
AudioConnectorIntegrationEntityListing	getIntegrationsSpeechAudioconnector(GetIntegrationsSpeechAudioconnectorRequest request)	Get a list of Audio Connector integrations
ApiResponse<AudioConnectorIntegrationEntityListing>	getIntegrationsSpeechAudioconnector(ApiRequest<Void> request)	Get a list of Audio Connector integrations
AudioConnectorIntegrationEntityListing	getIntegrationsSpeechAudioconnector(Integer pageNumber, Integer pageSize)	Get a list of Audio Connector integrations
AudioConnectorIntegration	getIntegrationsSpeechAudioconnectorIntegrationId(GetIntegrationsSpeechAudioconnectorIntegrationIdRequest request)	Get an Audio Connector integration
ApiResponse<AudioConnectorIntegration>	getIntegrationsSpeechAudioconnectorIntegrationId(ApiRequest<Void> request)	Get an Audio Connector integration
AudioConnectorIntegration	getIntegrationsSpeechAudioconnectorIntegrationId(String integrationId)	Get an Audio Connector integration
ApiResponse<AudioConnectorIntegration>	getIntegrationsSpeechAudioconnectorIntegrationIdWithHttpInfo(String integrationId)	Get an Audio Connector integration
ApiResponse<AudioConnectorIntegrationEntityListing>	getIntegrationsSpeechAudioconnectorWithHttpInfo(Integer pageNumber, Integer pageSize)	Get a list of Audio Connector integrations
DialogflowAgent	getIntegrationsSpeechDialogflowAgent(GetIntegrationsSpeechDialogflowAgentRequest request)	Get details about a Dialogflow agent
ApiResponse<DialogflowAgent>	getIntegrationsSpeechDialogflowAgent(ApiRequest<Void> request)	Get details about a Dialogflow agent
DialogflowAgent	getIntegrationsSpeechDialogflowAgent(String agentId)	Get details about a Dialogflow agent
DialogflowAgentSummaryEntityListing	getIntegrationsSpeechDialogflowAgents(GetIntegrationsSpeechDialogflowAgentsRequest request)	Get a list of Dialogflow agents in the customers' Google accounts
ApiResponse<DialogflowAgentSummaryEntityListing>	getIntegrationsSpeechDialogflowAgents(ApiRequest<Void> request)	Get a list of Dialogflow agents in the customers' Google accounts
DialogflowAgentSummaryEntityListing	getIntegrationsSpeechDialogflowAgents(Integer pageNumber, Integer pageSize, String name)	Get a list of Dialogflow agents in the customers' Google accounts
ApiResponse<DialogflowAgentSummaryEntityListing>	getIntegrationsSpeechDialogflowAgentsWithHttpInfo(Integer pageNumber, Integer pageSize, String name)	Get a list of Dialogflow agents in the customers' Google accounts
ApiResponse<DialogflowAgent>	getIntegrationsSpeechDialogflowAgentWithHttpInfo(String agentId)	Get details about a Dialogflow agent
DialogflowCXAgent	getIntegrationsSpeechDialogflowcxAgent(GetIntegrationsSpeechDialogflowcxAgentRequest request)	Get details about a Dialogflow CX agent
ApiResponse<DialogflowCXAgent>	getIntegrationsSpeechDialogflowcxAgent(ApiRequest<Void> request)	Get details about a Dialogflow CX agent
DialogflowCXAgent	getIntegrationsSpeechDialogflowcxAgent(String agentId)	Get details about a Dialogflow CX agent
DialogflowCXAgentSummaryEntityListing	getIntegrationsSpeechDialogflowcxAgents(GetIntegrationsSpeechDialogflowcxAgentsRequest request)	Get a list of Dialogflow CX agents in the customers' Google accounts
ApiResponse<DialogflowCXAgentSummaryEntityListing>	getIntegrationsSpeechDialogflowcxAgents(ApiRequest<Void> request)	Get a list of Dialogflow CX agents in the customers' Google accounts
DialogflowCXAgentSummaryEntityListing	getIntegrationsSpeechDialogflowcxAgents(Integer pageNumber, Integer pageSize, String name)	Get a list of Dialogflow CX agents in the customers' Google accounts
ApiResponse<DialogflowCXAgentSummaryEntityListing>	getIntegrationsSpeechDialogflowcxAgentsWithHttpInfo(Integer pageNumber, Integer pageSize, String name)	Get a list of Dialogflow CX agents in the customers' Google accounts
ApiResponse<DialogflowCXAgent>	getIntegrationsSpeechDialogflowcxAgentWithHttpInfo(String agentId)	Get details about a Dialogflow CX agent
LexBotAlias	getIntegrationsSpeechLexBotAlias(GetIntegrationsSpeechLexBotAliasRequest request)	Get details about a Lex bot alias
ApiResponse<LexBotAlias>	getIntegrationsSpeechLexBotAlias(ApiRequest<Void> request)	Get details about a Lex bot alias
LexBotAlias	getIntegrationsSpeechLexBotAlias(String aliasId)	Get details about a Lex bot alias
ApiResponse<LexBotAlias>	getIntegrationsSpeechLexBotAliasWithHttpInfo(String aliasId)	Get details about a Lex bot alias
LexBotAliasEntityListing	getIntegrationsSpeechLexBotBotIdAliases(GetIntegrationsSpeechLexBotBotIdAliasesRequest request)	Get a list of aliases for a bot in the customer's AWS accounts
ApiResponse<LexBotAliasEntityListing>	getIntegrationsSpeechLexBotBotIdAliases(ApiRequest<Void> request)	Get a list of aliases for a bot in the customer's AWS accounts
LexBotAliasEntityListing	getIntegrationsSpeechLexBotBotIdAliases(String botId, Integer pageNumber, Integer pageSize, String status, String name)	Get a list of aliases for a bot in the customer's AWS accounts
ApiResponse<LexBotAliasEntityListing>	getIntegrationsSpeechLexBotBotIdAliasesWithHttpInfo(String botId, Integer pageNumber, Integer pageSize, String status, String name)	Get a list of aliases for a bot in the customer's AWS accounts
LexBotEntityListing	getIntegrationsSpeechLexBots(GetIntegrationsSpeechLexBotsRequest request)	Get a list of Lex bots in the customers' AWS accounts
ApiResponse<LexBotEntityListing>	getIntegrationsSpeechLexBots(ApiRequest<Void> request)	Get a list of Lex bots in the customers' AWS accounts
LexBotEntityListing	getIntegrationsSpeechLexBots(Integer pageNumber, Integer pageSize, String name)	Get a list of Lex bots in the customers' AWS accounts
ApiResponse<LexBotEntityListing>	getIntegrationsSpeechLexBotsWithHttpInfo(Integer pageNumber, Integer pageSize, String name)	Get a list of Lex bots in the customers' AWS accounts
LexV2BotAlias	getIntegrationsSpeechLexv2BotAlias(GetIntegrationsSpeechLexv2BotAliasRequest request)	Get details about a Lex V2 bot alias
ApiResponse<LexV2BotAlias>	getIntegrationsSpeechLexv2BotAlias(ApiRequest<Void> request)	Get details about a Lex V2 bot alias
LexV2BotAlias	getIntegrationsSpeechLexv2BotAlias(String aliasId)	Get details about a Lex V2 bot alias
ApiResponse<LexV2BotAlias>	getIntegrationsSpeechLexv2BotAliasWithHttpInfo(String aliasId)	Get details about a Lex V2 bot alias
LexV2BotAliasEntityListing	getIntegrationsSpeechLexv2BotBotIdAliases(GetIntegrationsSpeechLexv2BotBotIdAliasesRequest request)	Get a list of aliases for a Lex V2 bot
ApiResponse<LexV2BotAliasEntityListing>	getIntegrationsSpeechLexv2BotBotIdAliases(ApiRequest<Void> request)	Get a list of aliases for a Lex V2 bot
LexV2BotAliasEntityListing	getIntegrationsSpeechLexv2BotBotIdAliases(String botId, Integer pageNumber, Integer pageSize, String status, String name)	Get a list of aliases for a Lex V2 bot
ApiResponse<LexV2BotAliasEntityListing>	getIntegrationsSpeechLexv2BotBotIdAliasesWithHttpInfo(String botId, Integer pageNumber, Integer pageSize, String status, String name)	Get a list of aliases for a Lex V2 bot
LexV2BotEntityListing	getIntegrationsSpeechLexv2Bots(GetIntegrationsSpeechLexv2BotsRequest request)	Get a list of Lex V2 bots
ApiResponse<LexV2BotEntityListing>	getIntegrationsSpeechLexv2Bots(ApiRequest<Void> request)	Get a list of Lex V2 bots
LexV2BotEntityListing	getIntegrationsSpeechLexv2Bots(Integer pageNumber, Integer pageSize, String name)	Get a list of Lex V2 bots
ApiResponse<LexV2BotEntityListing>	getIntegrationsSpeechLexv2BotsWithHttpInfo(Integer pageNumber, Integer pageSize, String name)	Get a list of Lex V2 bots
NuanceBot	getIntegrationsSpeechNuanceNuanceIntegrationIdBot(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotRequest request)	Get a Nuance bot in the specified Integration
ApiResponse<NuanceBot>	getIntegrationsSpeechNuanceNuanceIntegrationIdBot(ApiRequest<Void> request)	Get a Nuance bot in the specified Integration
NuanceBot	getIntegrationsSpeechNuanceNuanceIntegrationIdBot(String nuanceIntegrationId, String botId, List<String> expand, String targetChannel)	Get a Nuance bot in the specified Integration
AsyncJob	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotJobRequest request)	Get the status of an asynchronous Nuance bot GET job
ApiResponse<AsyncJob>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(ApiRequest<Void> request)	Get the status of an asynchronous Nuance bot GET job
AsyncJob	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(String nuanceIntegrationId, String botId, String jobId)	Get the status of an asynchronous Nuance bot GET job
NuanceBot	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResultsRequest request)	Get the result of an asynchronous Nuance bot GET job
ApiResponse<NuanceBot>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(ApiRequest<Void> request)	Get the result of an asynchronous Nuance bot GET job
NuanceBot	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(String nuanceIntegrationId, String botId, String jobId)	Get the result of an asynchronous Nuance bot GET job
ApiResponse<NuanceBot>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResultsWithHttpInfo(String nuanceIntegrationId, String botId, String jobId)	Get the result of an asynchronous Nuance bot GET job
ApiResponse<AsyncJob>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobWithHttpInfo(String nuanceIntegrationId, String botId, String jobId)	Get the status of an asynchronous Nuance bot GET job
NuanceBotEntityListing	getIntegrationsSpeechNuanceNuanceIntegrationIdBots(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotsRequest request)	Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.
ApiResponse<NuanceBotEntityListing>	getIntegrationsSpeechNuanceNuanceIntegrationIdBots(ApiRequest<Void> request)	Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.
NuanceBotEntityListing	getIntegrationsSpeechNuanceNuanceIntegrationIdBots(String nuanceIntegrationId, Integer pageNumber, Integer pageSize, Boolean onlyRegisteredBots)	Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.
AsyncJob	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobRequest request)	Get the status of an asynchronous Nuance bots GET job
ApiResponse<AsyncJob>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(ApiRequest<Void> request)	Get the status of an asynchronous Nuance bots GET job
AsyncJob	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(String nuanceIntegrationId, String jobId)	Get the status of an asynchronous Nuance bots GET job
NuanceBotEntityListing	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResultsRequest request)	Get the result of an asynchronous Nuance bots GET job
ApiResponse<NuanceBotEntityListing>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(ApiRequest<Void> request)	Get the result of an asynchronous Nuance bots GET job
NuanceBotEntityListing	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(String nuanceIntegrationId, String jobId)	Get the result of an asynchronous Nuance bots GET job
ApiResponse<NuanceBotEntityListing>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResultsWithHttpInfo(String nuanceIntegrationId, String jobId)	Get the result of an asynchronous Nuance bots GET job
ApiResponse<AsyncJob>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobWithHttpInfo(String nuanceIntegrationId, String jobId)	Get the status of an asynchronous Nuance bots GET job
ApiResponse<NuanceBotEntityListing>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotsWithHttpInfo(String nuanceIntegrationId, Integer pageNumber, Integer pageSize, Boolean onlyRegisteredBots)	Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.
ApiResponse<NuanceBot>	getIntegrationsSpeechNuanceNuanceIntegrationIdBotWithHttpInfo(String nuanceIntegrationId, String botId, List<String> expand, String targetChannel)	Get a Nuance bot in the specified Integration
SttEngineEntity	getIntegrationsSpeechSttEngine(GetIntegrationsSpeechSttEngineRequest request)	Get details about a STT engine
ApiResponse<SttEngineEntity>	getIntegrationsSpeechSttEngine(ApiRequest<Void> request)	Get details about a STT engine
SttEngineEntity	getIntegrationsSpeechSttEngine(String engineId)	Get details about a STT engine
SttEngineEntityListing	getIntegrationsSpeechSttEngines(GetIntegrationsSpeechSttEnginesRequest request)	Get a list of STT engines enabled for org
ApiResponse<SttEngineEntityListing>	getIntegrationsSpeechSttEngines(ApiRequest<Void> request)	Get a list of STT engines enabled for org
SttEngineEntityListing	getIntegrationsSpeechSttEngines(Integer pageNumber, Integer pageSize, String name)	Get a list of STT engines enabled for org
ApiResponse<SttEngineEntityListing>	getIntegrationsSpeechSttEnginesWithHttpInfo(Integer pageNumber, Integer pageSize, String name)	Get a list of STT engines enabled for org
ApiResponse<SttEngineEntity>	getIntegrationsSpeechSttEngineWithHttpInfo(String engineId)	Get details about a STT engine
TtsEngineEntity	getIntegrationsSpeechTtsEngine(GetIntegrationsSpeechTtsEngineRequest request)	Get details about a TTS engine
ApiResponse<TtsEngineEntity>	getIntegrationsSpeechTtsEngine(ApiRequest<Void> request)	Get details about a TTS engine
TtsEngineEntity	getIntegrationsSpeechTtsEngine(String engineId, Boolean includeVoices)	Get details about a TTS engine
TtsEngineEntityListing	getIntegrationsSpeechTtsEngines(GetIntegrationsSpeechTtsEnginesRequest request)	Get a list of TTS engines enabled for org
ApiResponse<TtsEngineEntityListing>	getIntegrationsSpeechTtsEngines(ApiRequest<Void> request)	Get a list of TTS engines enabled for org
TtsEngineEntityListing	getIntegrationsSpeechTtsEngines(Integer pageNumber, Integer pageSize, Boolean includeVoices, String name, String language)	Get a list of TTS engines enabled for org
ApiResponse<TtsEngineEntityListing>	getIntegrationsSpeechTtsEnginesWithHttpInfo(Integer pageNumber, Integer pageSize, Boolean includeVoices, String name, String language)	Get a list of TTS engines enabled for org
TtsVoiceEntity	getIntegrationsSpeechTtsEngineVoice(GetIntegrationsSpeechTtsEngineVoiceRequest request)	Get details about a specific voice for a TTS engine
ApiResponse<TtsVoiceEntity>	getIntegrationsSpeechTtsEngineVoice(ApiRequest<Void> request)	Get details about a specific voice for a TTS engine
TtsVoiceEntity	getIntegrationsSpeechTtsEngineVoice(String engineId, String voiceId)	Get details about a specific voice for a TTS engine
TtsVoiceEntityListing	getIntegrationsSpeechTtsEngineVoices(GetIntegrationsSpeechTtsEngineVoicesRequest request)	Get a list of voices for a TTS engine
ApiResponse<TtsVoiceEntityListing>	getIntegrationsSpeechTtsEngineVoices(ApiRequest<Void> request)	Get a list of voices for a TTS engine
TtsVoiceEntityListing	getIntegrationsSpeechTtsEngineVoices(String engineId, Integer pageNumber, Integer pageSize)	Get a list of voices for a TTS engine
ApiResponse<TtsVoiceEntityListing>	getIntegrationsSpeechTtsEngineVoicesWithHttpInfo(String engineId, Integer pageNumber, Integer pageSize)	Get a list of voices for a TTS engine
ApiResponse<TtsVoiceEntity>	getIntegrationsSpeechTtsEngineVoiceWithHttpInfo(String engineId, String voiceId)	Get details about a specific voice for a TTS engine
ApiResponse<TtsEngineEntity>	getIntegrationsSpeechTtsEngineWithHttpInfo(String engineId, Boolean includeVoices)	Get details about a TTS engine
TtsSettings	getIntegrationsSpeechTtsSettings()	Get TTS settings for an org
TtsSettings	getIntegrationsSpeechTtsSettings(GetIntegrationsSpeechTtsSettingsRequest request)	Get TTS settings for an org
ApiResponse<TtsSettings>	getIntegrationsSpeechTtsSettings(ApiRequest<Void> request)	Get TTS settings for an org
ApiResponse<TtsSettings>	getIntegrationsSpeechTtsSettingsWithHttpInfo()	Get TTS settings for an org
IntegrationType	getIntegrationsType(GetIntegrationsTypeRequest request)	Get integration type.
ApiResponse<IntegrationType>	getIntegrationsType(ApiRequest<Void> request)	Get integration type.
IntegrationType	getIntegrationsType(String typeId)	Get integration type.
JsonSchemaDocument	getIntegrationsTypeConfigschema(GetIntegrationsTypeConfigschemaRequest request)	Get properties config schema for an integration type.
ApiResponse<JsonSchemaDocument>	getIntegrationsTypeConfigschema(ApiRequest<Void> request)	Get properties config schema for an integration type.
JsonSchemaDocument	getIntegrationsTypeConfigschema(String typeId, String configType)	Get properties config schema for an integration type.
ApiResponse<JsonSchemaDocument>	getIntegrationsTypeConfigschemaWithHttpInfo(String typeId, String configType)	Get properties config schema for an integration type.
IntegrationTypeEntityListing	getIntegrationsTypes(GetIntegrationsTypesRequest request)	List integration types
ApiResponse<IntegrationTypeEntityListing>	getIntegrationsTypes(ApiRequest<Void> request)	List integration types
IntegrationTypeEntityListing	getIntegrationsTypes(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	List integration types
ApiResponse<IntegrationTypeEntityListing>	getIntegrationsTypesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	List integration types
ApiResponse<IntegrationType>	getIntegrationsTypeWithHttpInfo(String typeId)	Get integration type.
UnifiedCommunicationsIntegration	getIntegrationsUnifiedcommunicationsClientapp(GetIntegrationsUnifiedcommunicationsClientappRequest request)	UC integration client application configuration.
ApiResponse<UnifiedCommunicationsIntegration>	getIntegrationsUnifiedcommunicationsClientapp(ApiRequest<Void> request)	UC integration client application configuration.
UnifiedCommunicationsIntegration	getIntegrationsUnifiedcommunicationsClientapp(String ucIntegrationId)	UC integration client application configuration.
UnifiedCommunicationsIntegrationListing	getIntegrationsUnifiedcommunicationsClientapps(GetIntegrationsUnifiedcommunicationsClientappsRequest request)	List UC integration client application configurations.
ApiResponse<UnifiedCommunicationsIntegrationListing>	getIntegrationsUnifiedcommunicationsClientapps(ApiRequest<Void> request)	List UC integration client application configurations.
UnifiedCommunicationsIntegrationListing	getIntegrationsUnifiedcommunicationsClientapps(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	List UC integration client application configurations.
ApiResponse<UnifiedCommunicationsIntegrationListing>	getIntegrationsUnifiedcommunicationsClientappsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	List UC integration client application configurations.
ApiResponse<UnifiedCommunicationsIntegration>	getIntegrationsUnifiedcommunicationsClientappWithHttpInfo(String ucIntegrationId)	UC integration client application configuration.
UserAppEntityListing	getIntegrationsUserapps(GetIntegrationsUserappsRequest request)	List permitted user app integrations for the logged in user
ApiResponse<UserAppEntityListing>	getIntegrationsUserapps(ApiRequest<Void> request)	List permitted user app integrations for the logged in user
UserAppEntityListing	getIntegrationsUserapps(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String appHost)	List permitted user app integrations for the logged in user
ApiResponse<UserAppEntityListing>	getIntegrationsUserappsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String appHost)	List permitted user app integrations for the logged in user
ApiResponse<IntegrationEntityListing>	getIntegrationsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, List<String> ids, String integrationType, String reportedState)	List integrations
ApiResponse<Integration>	getIntegrationWithHttpInfo(String integrationId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage)	Get integration.
Integration	patchIntegration(PatchIntegrationRequest request)	Update an integration.
ApiResponse<Integration>	patchIntegration(ApiRequest<Integration> request)	Update an integration.
Integration	patchIntegration(String integrationId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Integration body)	Update an integration.
Action	patchIntegrationsAction(PatchIntegrationsActionRequest request)	Patch an Action
ApiResponse<Action>	patchIntegrationsAction(ApiRequest<UpdateActionInput> request)	Patch an Action
Action	patchIntegrationsAction(String actionId, UpdateActionInput body)	Patch an Action
Action	patchIntegrationsActionDraft(PatchIntegrationsActionDraftRequest request)	Update an existing Draft
ApiResponse<Action>	patchIntegrationsActionDraft(ApiRequest<UpdateDraftInput> request)	Update an existing Draft
Action	patchIntegrationsActionDraft(String actionId, UpdateDraftInput body)	Update an existing Draft
ApiResponse<Action>	patchIntegrationsActionDraftWithHttpInfo(String actionId, UpdateDraftInput body)	Update an existing Draft
ApiResponse<Action>	patchIntegrationsActionWithHttpInfo(String actionId, UpdateActionInput body)	Patch an Action
ApiResponse<Integration>	patchIntegrationWithHttpInfo(String integrationId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Integration body)	Update an integration.
Integration	postIntegrations(PostIntegrationsRequest request)	Create an integration.
ApiResponse<Integration>	postIntegrations(ApiRequest<CreateIntegrationRequest> request)	Create an integration.
Integration	postIntegrations(CreateIntegrationRequest body)	Create an integration.
Action	postIntegrationsActionDraft(PostIntegrationsActionDraftRequest request)	Create a new Draft from existing Action
ApiResponse<Action>	postIntegrationsActionDraft(ApiRequest<Void> request)	Create a new Draft from existing Action
Action	postIntegrationsActionDraft(String actionId)	Create a new Draft from existing Action
FunctionUploadResponse	postIntegrationsActionDraftFunctionUpload(PostIntegrationsActionDraftFunctionUploadRequest request)	Create upload presigned URL for draft function package file.
ApiResponse<FunctionUploadResponse>	postIntegrationsActionDraftFunctionUpload(ApiRequest<FunctionUploadRequest> request)	Create upload presigned URL for draft function package file.
FunctionUploadResponse	postIntegrationsActionDraftFunctionUpload(String actionId, FunctionUploadRequest body)	Create upload presigned URL for draft function package file.
ApiResponse<FunctionUploadResponse>	postIntegrationsActionDraftFunctionUploadWithHttpInfo(String actionId, FunctionUploadRequest body)	Create upload presigned URL for draft function package file.
Action	postIntegrationsActionDraftPublish(PostIntegrationsActionDraftPublishRequest request)	Publish a Draft and make it the active Action configuration
ApiResponse<Action>	postIntegrationsActionDraftPublish(ApiRequest<PublishDraftInput> request)	Publish a Draft and make it the active Action configuration
Action	postIntegrationsActionDraftPublish(String actionId, PublishDraftInput body)	Publish a Draft and make it the active Action configuration
ApiResponse<Action>	postIntegrationsActionDraftPublishWithHttpInfo(String actionId, PublishDraftInput body)	Publish a Draft and make it the active Action configuration
TestExecutionResult	postIntegrationsActionDraftTest(PostIntegrationsActionDraftTestRequest request)	Test the execution of a draft.
ApiResponse<TestExecutionResult>	postIntegrationsActionDraftTest(ApiRequest<Object> request)	Test the execution of a draft.
TestExecutionResult	postIntegrationsActionDraftTest(String actionId, Object body, Boolean flatten)	Test the execution of a draft.
ApiResponse<TestExecutionResult>	postIntegrationsActionDraftTestWithHttpInfo(String actionId, Object body, Boolean flatten)	Test the execution of a draft.
ApiResponse<Action>	postIntegrationsActionDraftWithHttpInfo(String actionId)	Create a new Draft from existing Action
Object	postIntegrationsActionExecute(PostIntegrationsActionExecuteRequest request)	Execute Action and return response from 3rd party.
ApiResponse<Object>	postIntegrationsActionExecute(ApiRequest<Object> request)	Execute Action and return response from 3rd party.
Object	postIntegrationsActionExecute(String actionId, Object body, Boolean flatten)	Execute Action and return response from 3rd party.
ApiResponse<Object>	postIntegrationsActionExecuteWithHttpInfo(String actionId, Object body, Boolean flatten)	Execute Action and return response from 3rd party.
Action	postIntegrationsActions(PostIntegrationsActionsRequest request)	Create a new Action.
ApiResponse<Action>	postIntegrationsActions(ApiRequest<PostActionInput> request)	Create a new Action.
Action	postIntegrationsActions(PostActionInput body)	Create a new Action.
Action	postIntegrationsActionsDrafts(PostIntegrationsActionsDraftsRequest request)	Create a new Draft
ApiResponse<Action>	postIntegrationsActionsDrafts(ApiRequest<PostActionInput> request)	Create a new Draft
Action	postIntegrationsActionsDrafts(PostActionInput body)	Create a new Draft
ApiResponse<Action>	postIntegrationsActionsDraftsWithHttpInfo(PostActionInput body)	Create a new Draft
ApiResponse<Action>	postIntegrationsActionsWithHttpInfo(PostActionInput body)	Create a new Action.
TestExecutionResult	postIntegrationsActionTest(PostIntegrationsActionTestRequest request)	Test the execution of an action.
ApiResponse<TestExecutionResult>	postIntegrationsActionTest(ApiRequest<Object> request)	Test the execution of an action.
TestExecutionResult	postIntegrationsActionTest(String actionId, Object body, Boolean flatten)	Test the execution of an action.
ApiResponse<TestExecutionResult>	postIntegrationsActionTestWithHttpInfo(String actionId, Object body, Boolean flatten)	Test the execution of an action.
IncomingMessageResponse	postIntegrationsBotconnectorsIncomingMessages(PostIntegrationsBotconnectorsIncomingMessagesRequest request)	Send an incoming message to the bot.
ApiResponse<IncomingMessageResponse>	postIntegrationsBotconnectorsIncomingMessages(ApiRequest<IncomingMessageRequest> request)	Send an incoming message to the bot.
IncomingMessageResponse	postIntegrationsBotconnectorsIncomingMessages(IncomingMessageRequest body)	Send an incoming message to the bot.
ApiResponse<IncomingMessageResponse>	postIntegrationsBotconnectorsIncomingMessagesWithHttpInfo(IncomingMessageRequest body)	Send an incoming message to the bot.
OutgoingMessageResponse	postIntegrationsBotconnectorsOutgoingMessages(PostIntegrationsBotconnectorsOutgoingMessagesRequest request)	Send an outgoing message to the end user.
ApiResponse<OutgoingMessageResponse>	postIntegrationsBotconnectorsOutgoingMessages(ApiRequest<OutgoingMessageRequest> request)	Send an outgoing message to the end user.
OutgoingMessageResponse	postIntegrationsBotconnectorsOutgoingMessages(OutgoingMessageRequest body)	Send an outgoing message to the end user.
ApiResponse<OutgoingMessageResponse>	postIntegrationsBotconnectorsOutgoingMessagesWithHttpInfo(OutgoingMessageRequest body)	Send an outgoing message to the end user.
CredentialInfo	postIntegrationsCredentials(PostIntegrationsCredentialsRequest request)	Create a set of credentials
ApiResponse<CredentialInfo>	postIntegrationsCredentials(ApiRequest<Credential> request)	Create a set of credentials
CredentialInfo	postIntegrationsCredentials(Credential body)	Create a set of credentials
ApiResponse<CredentialInfo>	postIntegrationsCredentialsWithHttpInfo(Credential body)	Create a set of credentials
AsyncJob	postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(PostIntegrationsSpeechNuanceNuanceIntegrationIdBotJobsRequest request)	Get a Nuance bot in the specified Integration asynchronously
ApiResponse<AsyncJob>	postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(ApiRequest<String> request)	Get a Nuance bot in the specified Integration asynchronously
AsyncJob	postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(String nuanceIntegrationId, String botId, List<String> expand, String body)	Get a Nuance bot in the specified Integration asynchronously
ApiResponse<AsyncJob>	postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobsWithHttpInfo(String nuanceIntegrationId, String botId, List<String> expand, String body)	Get a Nuance bot in the specified Integration asynchronously
AsyncJob	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(PostIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobsRequest request)	Get a list of Nuance bots in the specified Integration asynchronously
ApiResponse<AsyncJob>	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(ApiRequest<Void> request)	Get a list of Nuance bots in the specified Integration asynchronously
AsyncJob	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(String nuanceIntegrationId, Integer pageNumber, Integer pageSize, Boolean onlyRegisteredBots)	Get a list of Nuance bots in the specified Integration asynchronously
ApiResponse<AsyncJob>	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobsWithHttpInfo(String nuanceIntegrationId, Integer pageNumber, Integer pageSize, Boolean onlyRegisteredBots)	Get a list of Nuance bots in the specified Integration asynchronously
void	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(PostIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidateRequest request)	Try out a single credential for a Nuance bot to know if the secret is correct
ApiResponse<Void>	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(ApiRequest<BotExecutionConfiguration> request)	Try out a single credential for a Nuance bot to know if the secret is correct
void	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(String nuanceIntegrationId, BotExecutionConfiguration settings)	Try out a single credential for a Nuance bot to know if the secret is correct
ApiResponse<Void>	postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidateWithHttpInfo(String nuanceIntegrationId, BotExecutionConfiguration settings)	Try out a single credential for a Nuance bot to know if the secret is correct
WebhookInvocationResponse	postIntegrationsWebhookEvents(PostIntegrationsWebhookEventsRequest request)	Invoke Webhook
ApiResponse<WebhookInvocationResponse>	postIntegrationsWebhookEvents(ApiRequest<Object> request)	Invoke Webhook
WebhookInvocationResponse	postIntegrationsWebhookEvents(String tokenId, Object body)	Invoke Webhook
ApiResponse<WebhookInvocationResponse>	postIntegrationsWebhookEventsWithHttpInfo(String tokenId, Object body)	Invoke Webhook
ApiResponse<Integration>	postIntegrationsWithHttpInfo(CreateIntegrationRequest body)	Create an integration.
IntegrationConfiguration	putIntegrationConfigCurrent(PutIntegrationConfigCurrentRequest request)	Update integration configuration.
ApiResponse<IntegrationConfiguration>	putIntegrationConfigCurrent(ApiRequest<IntegrationConfiguration> request)	Update integration configuration.
IntegrationConfiguration	putIntegrationConfigCurrent(String integrationId, IntegrationConfiguration body)	Update integration configuration.
ApiResponse<IntegrationConfiguration>	putIntegrationConfigCurrentWithHttpInfo(String integrationId, IntegrationConfiguration body)	Update integration configuration.
FunctionConfig	putIntegrationsActionDraftFunction(PutIntegrationsActionDraftFunctionRequest request)	Update draft function settings.
ApiResponse<FunctionConfig>	putIntegrationsActionDraftFunction(ApiRequest<Function> request)	Update draft function settings.
FunctionConfig	putIntegrationsActionDraftFunction(String actionId, Function body)	Update draft function settings.
ApiResponse<FunctionConfig>	putIntegrationsActionDraftFunctionWithHttpInfo(String actionId, Function body)	Update draft function settings.
void	putIntegrationsBotconnectorIntegrationIdBots(PutIntegrationsBotconnectorIntegrationIdBotsRequest request)	Set a list of botConnector bots plus versions for this integration
ApiResponse<Void>	putIntegrationsBotconnectorIntegrationIdBots(ApiRequest<BotList> request)	Set a list of botConnector bots plus versions for this integration
void	putIntegrationsBotconnectorIntegrationIdBots(String integrationId, BotList botList)	Set a list of botConnector bots plus versions for this integration
ApiResponse<Void>	putIntegrationsBotconnectorIntegrationIdBotsWithHttpInfo(String integrationId, BotList botList)	Set a list of botConnector bots plus versions for this integration
CredentialInfo	putIntegrationsCredential(PutIntegrationsCredentialRequest request)	Update a set of credentials
ApiResponse<CredentialInfo>	putIntegrationsCredential(ApiRequest<Credential> request)	Update a set of credentials
CredentialInfo	putIntegrationsCredential(String credentialId, Credential body)	Update a set of credentials
ApiResponse<CredentialInfo>	putIntegrationsCredentialWithHttpInfo(String credentialId, Credential body)	Update a set of credentials
void	putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(PutIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettingsRequest request)	Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
ApiResponse<Void>	putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(ApiRequest<NuanceBotLaunchSettings> request)	Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
void	putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(String nuanceIntegrationId, NuanceBotLaunchSettings settings)	Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
ApiResponse<Void>	putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettingsWithHttpInfo(String nuanceIntegrationId, NuanceBotLaunchSettings settings)	Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
TtsSettings	putIntegrationsSpeechTtsSettings(PutIntegrationsSpeechTtsSettingsRequest request)	Update TTS settings for an org
ApiResponse<TtsSettings>	putIntegrationsSpeechTtsSettings(ApiRequest<TtsSettings> request)	Update TTS settings for an org
TtsSettings	putIntegrationsSpeechTtsSettings(TtsSettings body)	Update TTS settings for an org
ApiResponse<TtsSettings>	putIntegrationsSpeechTtsSettingsWithHttpInfo(TtsSettings body)	Update TTS settings for an org
String	putIntegrationsUnifiedcommunicationThirdpartypresences(PutIntegrationsUnifiedcommunicationThirdpartypresencesRequest request)	Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address.
ApiResponse<String>	putIntegrationsUnifiedcommunicationThirdpartypresences(ApiRequest<List<UCThirdPartyPresence>> request)	Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address.
String	putIntegrationsUnifiedcommunicationThirdpartypresences(String ucIntegrationId, List<UCThirdPartyPresence> body)	Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address.
ApiResponse<String>	putIntegrationsUnifiedcommunicationThirdpartypresencesWithHttpInfo(String ucIntegrationId, List<UCThirdPartyPresence> body)	Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IntegrationsApi

public IntegrationsApi()

IntegrationsApi

public IntegrationsApi(ApiClient apiClient)

Method Details

deleteIntegration

public Integration deleteIntegration(String integrationId)
                              throws IOException,
ApiException

Delete integration.

Parameters:

integrationId - Integration Id (required)

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegrationWithHttpInfo

public ApiResponse<Integration> deleteIntegrationWithHttpInfo(String integrationId)
                                                       throws IOException

Delete integration.

Parameters:

integrationId - Integration Id (required)

Returns:

Integration

Throws:

IOException - if the request fails to be processed

deleteIntegration

public Integration deleteIntegration(DeleteIntegrationRequest request)
                              throws IOException,
ApiException

Delete integration.

Parameters:

request - The request object

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegration

public ApiResponse<Integration> deleteIntegration(ApiRequest<Void> request)
                                           throws IOException

Delete integration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteIntegrationsAction

public void deleteIntegrationsAction(String actionId)
                              throws IOException,
ApiException

Delete an Action

Parameters:

actionId - actionId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegrationsActionWithHttpInfo

public ApiResponse<Void> deleteIntegrationsActionWithHttpInfo(String actionId)
                                                       throws IOException

Delete an Action

Parameters:

actionId - actionId (required)

Throws:

IOException - if the request fails to be processed

deleteIntegrationsAction

public void deleteIntegrationsAction(DeleteIntegrationsActionRequest request)
                              throws IOException,
ApiException

Delete an Action

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegrationsAction

public ApiResponse<Void> deleteIntegrationsAction(ApiRequest<Void> request)
                                           throws IOException

Delete an Action

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteIntegrationsActionDraft

public void deleteIntegrationsActionDraft(String actionId)
                                   throws IOException,
ApiException

Delete a Draft

Parameters:

actionId - actionId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegrationsActionDraftWithHttpInfo

public ApiResponse<Void> deleteIntegrationsActionDraftWithHttpInfo(String actionId)
                                                            throws IOException

Delete a Draft

Parameters:

actionId - actionId (required)

Throws:

IOException - if the request fails to be processed

deleteIntegrationsActionDraft

public void deleteIntegrationsActionDraft(DeleteIntegrationsActionDraftRequest request)
                                   throws IOException,
ApiException

Delete a Draft

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegrationsActionDraft

public ApiResponse<Void> deleteIntegrationsActionDraft(ApiRequest<Void> request)
                                                throws IOException

Delete a Draft

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteIntegrationsCredential

public void deleteIntegrationsCredential(String credentialId)
                                  throws IOException,
ApiException

Delete a set of credentials

Parameters:

credentialId - Credential ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegrationsCredentialWithHttpInfo

public ApiResponse<Void> deleteIntegrationsCredentialWithHttpInfo(String credentialId)
                                                           throws IOException

Delete a set of credentials

Parameters:

credentialId - Credential ID (required)

Throws:

IOException - if the request fails to be processed

deleteIntegrationsCredential

public void deleteIntegrationsCredential(DeleteIntegrationsCredentialRequest request)
                                  throws IOException,
ApiException

Delete a set of credentials

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteIntegrationsCredential

public ApiResponse<Void> deleteIntegrationsCredential(ApiRequest<Void> request)
                                               throws IOException

Delete a set of credentials

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegration

public Integration getIntegration(String integrationId,
 Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                           throws IOException,
ApiException

Get integration.

Parameters:

integrationId - Integration Id (required)

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationWithHttpInfo

public ApiResponse<Integration> getIntegrationWithHttpInfo(String integrationId,
 Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                    throws IOException

Get integration.

Parameters:

integrationId - Integration Id (required)

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

Integration

Throws:

IOException - if the request fails to be processed

getIntegration

public Integration getIntegration(GetIntegrationRequest request)
                           throws IOException,
ApiException

Get integration.

Parameters:

request - The request object

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegration

public ApiResponse<Integration> getIntegration(ApiRequest<Void> request)
                                        throws IOException

Get integration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationConfigCurrent

public IntegrationConfiguration getIntegrationConfigCurrent(String integrationId)
                                                     throws IOException,
ApiException

Get integration configuration.

Parameters:

integrationId - Integration Id (required)

Returns:

IntegrationConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationConfigCurrentWithHttpInfo

public ApiResponse<IntegrationConfiguration> getIntegrationConfigCurrentWithHttpInfo(String integrationId)
                                                                              throws IOException

Get integration configuration.

Parameters:

integrationId - Integration Id (required)

Returns:

IntegrationConfiguration

Throws:

IOException - if the request fails to be processed

getIntegrationConfigCurrent

public IntegrationConfiguration getIntegrationConfigCurrent(GetIntegrationConfigCurrentRequest request)
                                                     throws IOException,
ApiException

Get integration configuration.

Parameters:

request - The request object

Returns:

IntegrationConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationConfigCurrent

public ApiResponse<IntegrationConfiguration> getIntegrationConfigCurrent(ApiRequest<Void> request)
                                                                  throws IOException

Get integration configuration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrations

public IntegrationEntityListing getIntegrations(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 List<String> ids,
 String integrationType,
 String reportedState)
                                         throws IOException,
ApiException

List integrations

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

ids - Comma-separated list of integration IDs to filter by (max 100) (optional, default to new ArrayList())

integrationType - Filter integrations by integration type ID (optional, default to null)

reportedState - Filter integrations by reported state (case-insensitive) (optional, default to null)

Returns:

IntegrationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsWithHttpInfo

public ApiResponse<IntegrationEntityListing> getIntegrationsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 List<String> ids,
 String integrationType,
 String reportedState)
                                                                  throws IOException

List integrations

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

ids - Comma-separated list of integration IDs to filter by (max 100) (optional, default to new ArrayList())

integrationType - Filter integrations by integration type ID (optional, default to null)

reportedState - Filter integrations by reported state (case-insensitive) (optional, default to null)

Returns:

IntegrationEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrations

public IntegrationEntityListing getIntegrations(GetIntegrationsRequest request)
                                         throws IOException,
ApiException

List integrations

Parameters:

request - The request object

Returns:

IntegrationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrations

public ApiResponse<IntegrationEntityListing> getIntegrations(ApiRequest<Void> request)
                                                      throws IOException

List integrations

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsAction

public Action getIntegrationsAction(String actionId,
 String expand,
 Boolean flatten,
 Boolean includeConfig)
                             throws IOException,
ApiException

Retrieves a single Action matching id.

Parameters:

actionId - actionId (required)

expand - Indicates a field in the response which should be expanded. (optional)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionWithHttpInfo

public ApiResponse<Action> getIntegrationsActionWithHttpInfo(String actionId,
 String expand,
 Boolean flatten,
 Boolean includeConfig)
                                                      throws IOException

Retrieves a single Action matching id.

Parameters:

actionId - actionId (required)

expand - Indicates a field in the response which should be expanded. (optional)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

Action

Throws:

IOException - if the request fails to be processed

getIntegrationsAction

public Action getIntegrationsAction(GetIntegrationsActionRequest request)
                             throws IOException,
ApiException

Retrieves a single Action matching id.

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsAction

public ApiResponse<Action> getIntegrationsAction(ApiRequest<Void> request)
                                          throws IOException

Retrieves a single Action matching id.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraft

public Action getIntegrationsActionDraft(String actionId,
 String expand,
 Boolean flatten,
 Boolean includeConfig)
                                  throws IOException,
ApiException

Retrieve a Draft

Parameters:

actionId - actionId (required)

expand - Indicates a field in the response which should be expanded. (optional)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftWithHttpInfo

public ApiResponse<Action> getIntegrationsActionDraftWithHttpInfo(String actionId,
 String expand,
 Boolean flatten,
 Boolean includeConfig)
                                                           throws IOException

Retrieve a Draft

Parameters:

actionId - actionId (required)

expand - Indicates a field in the response which should be expanded. (optional)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

Action

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraft

public Action getIntegrationsActionDraft(GetIntegrationsActionDraftRequest request)
                                  throws IOException,
ApiException

Retrieve a Draft

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraft

public ApiResponse<Action> getIntegrationsActionDraft(ApiRequest<Void> request)
                                               throws IOException

Retrieve a Draft

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftFunction

public FunctionConfig getIntegrationsActionDraftFunction(String actionId)
                                                  throws IOException,
ApiException

Get draft function settings for Action

Parameters:

actionId - actionId (required)

Returns:

FunctionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftFunctionWithHttpInfo

public ApiResponse<FunctionConfig> getIntegrationsActionDraftFunctionWithHttpInfo(String actionId)
                                                                           throws IOException

Get draft function settings for Action

Parameters:

actionId - actionId (required)

Returns:

FunctionConfig

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftFunction

public FunctionConfig getIntegrationsActionDraftFunction(GetIntegrationsActionDraftFunctionRequest request)
                                                  throws IOException,
ApiException

Get draft function settings for Action

Parameters:

request - The request object

Returns:

FunctionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftFunction

public ApiResponse<FunctionConfig> getIntegrationsActionDraftFunction(ApiRequest<Void> request)
                                                               throws IOException

Get draft function settings for Action

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftSchema

public JsonSchemaDocument getIntegrationsActionDraftSchema(String actionId,
 String fileName,
 Boolean flatten)
                                                    throws IOException,
ApiException

Retrieve schema for a Draft based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of schema file to be retrieved for this draft. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

JsonSchemaDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftSchemaWithHttpInfo

public ApiResponse<JsonSchemaDocument> getIntegrationsActionDraftSchemaWithHttpInfo(String actionId,
 String fileName,
 Boolean flatten)
                                                                             throws IOException

Retrieve schema for a Draft based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of schema file to be retrieved for this draft. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

JsonSchemaDocument

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftSchema

public JsonSchemaDocument getIntegrationsActionDraftSchema(GetIntegrationsActionDraftSchemaRequest request)
                                                    throws IOException,
ApiException

Retrieve schema for a Draft based on filename.

Parameters:

request - The request object

Returns:

JsonSchemaDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftSchema

public ApiResponse<JsonSchemaDocument> getIntegrationsActionDraftSchema(ApiRequest<Void> request)
                                                                 throws IOException

Retrieve schema for a Draft based on filename.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftTemplate

public String getIntegrationsActionDraftTemplate(String actionId,
 String fileName)
                                          throws IOException,
ApiException

Retrieve templates for a Draft based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of template file to be retrieved for this action draft. (required)

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftTemplateWithHttpInfo

public ApiResponse<String> getIntegrationsActionDraftTemplateWithHttpInfo(String actionId,
 String fileName)
                                                                   throws IOException

Retrieve templates for a Draft based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of template file to be retrieved for this action draft. (required)

Returns:

String

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftTemplate

public String getIntegrationsActionDraftTemplate(GetIntegrationsActionDraftTemplateRequest request)
                                          throws IOException,
ApiException

Retrieve templates for a Draft based on filename.

Parameters:

request - The request object

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftTemplate

public ApiResponse<String> getIntegrationsActionDraftTemplate(ApiRequest<Void> request)
                                                       throws IOException

Retrieve templates for a Draft based on filename.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftValidation

public DraftValidationResult getIntegrationsActionDraftValidation(String actionId)
                                                           throws IOException,
ApiException

Validate current Draft configuration.

Parameters:

actionId - actionId (required)

Returns:

DraftValidationResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftValidationWithHttpInfo

public ApiResponse<DraftValidationResult> getIntegrationsActionDraftValidationWithHttpInfo(String actionId)
                                                                                    throws IOException

Validate current Draft configuration.

Parameters:

actionId - actionId (required)

Returns:

DraftValidationResult

Throws:

IOException - if the request fails to be processed

getIntegrationsActionDraftValidation

public DraftValidationResult getIntegrationsActionDraftValidation(GetIntegrationsActionDraftValidationRequest request)
                                                           throws IOException,
ApiException

Validate current Draft configuration.

Parameters:

request - The request object

Returns:

DraftValidationResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionDraftValidation

public ApiResponse<DraftValidationResult> getIntegrationsActionDraftValidation(ApiRequest<Void> request)
                                                                        throws IOException

Validate current Draft configuration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionFunction

public FunctionConfig getIntegrationsActionFunction(String actionId)
                                             throws IOException,
ApiException

Get published function settings for Action

Parameters:

actionId - actionId (required)

Returns:

FunctionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionFunctionWithHttpInfo

public ApiResponse<FunctionConfig> getIntegrationsActionFunctionWithHttpInfo(String actionId)
                                                                      throws IOException

Get published function settings for Action

Parameters:

actionId - actionId (required)

Returns:

FunctionConfig

Throws:

IOException - if the request fails to be processed

getIntegrationsActionFunction

public FunctionConfig getIntegrationsActionFunction(GetIntegrationsActionFunctionRequest request)
                                             throws IOException,
ApiException

Get published function settings for Action

Parameters:

request - The request object

Returns:

FunctionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionFunction

public ApiResponse<FunctionConfig> getIntegrationsActionFunction(ApiRequest<Void> request)
                                                          throws IOException

Get published function settings for Action

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionSchema

public JsonSchemaDocument getIntegrationsActionSchema(String actionId,
 String fileName,
 Boolean flatten)
                                               throws IOException,
ApiException

Retrieve schema for an action based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of schema file to be retrieved for this action. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

JsonSchemaDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionSchemaWithHttpInfo

public ApiResponse<JsonSchemaDocument> getIntegrationsActionSchemaWithHttpInfo(String actionId,
 String fileName,
 Boolean flatten)
                                                                        throws IOException

Retrieve schema for an action based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of schema file to be retrieved for this action. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

JsonSchemaDocument

Throws:

IOException - if the request fails to be processed

getIntegrationsActionSchema

public JsonSchemaDocument getIntegrationsActionSchema(GetIntegrationsActionSchemaRequest request)
                                               throws IOException,
ApiException

Retrieve schema for an action based on filename.

Parameters:

request - The request object

Returns:

JsonSchemaDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionSchema

public ApiResponse<JsonSchemaDocument> getIntegrationsActionSchema(ApiRequest<Void> request)
                                                            throws IOException

Retrieve schema for an action based on filename.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionTemplate

public String getIntegrationsActionTemplate(String actionId,
 String fileName)
                                     throws IOException,
ApiException

Retrieve text of templates for an action based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of template file to be retrieved for this action. (required)

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionTemplateWithHttpInfo

public ApiResponse<String> getIntegrationsActionTemplateWithHttpInfo(String actionId,
 String fileName)
                                                              throws IOException

Retrieve text of templates for an action based on filename.

Parameters:

actionId - actionId (required)

fileName - Name of template file to be retrieved for this action. (required)

Returns:

String

Throws:

IOException - if the request fails to be processed

getIntegrationsActionTemplate

public String getIntegrationsActionTemplate(GetIntegrationsActionTemplateRequest request)
                                     throws IOException,
ApiException

Retrieve text of templates for an action based on filename.

Parameters:

request - The request object

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionTemplate

public ApiResponse<String> getIntegrationsActionTemplate(ApiRequest<Void> request)
                                                  throws IOException

Retrieve text of templates for an action based on filename.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActions

public ActionEntityListing getIntegrationsActions(Integer pageSize,
 Integer pageNumber,
 String nextPage,
 String previousPage,
 String sortBy,
 String sortOrder,
 String category,
 String name,
 String ids,
 String secure,
 String includeAuthActions,
 Boolean includeConfig)
                                           throws IOException,
ApiException

Retrieves all actions associated with filters passed in via query param.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

sortBy - Root level field name to sort on. (optional)

sortOrder - Direction to sort 'sortBy' field. (optional, default to asc)

category - Filter by category name. (optional)

name - Filter by partial or complete action name. (optional)

ids - Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. (optional)

secure - Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. (optional)

includeAuthActions - Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

ActionEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsWithHttpInfo

public ApiResponse<ActionEntityListing> getIntegrationsActionsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String nextPage,
 String previousPage,
 String sortBy,
 String sortOrder,
 String category,
 String name,
 String ids,
 String secure,
 String includeAuthActions,
 Boolean includeConfig)
                                                                    throws IOException

Retrieves all actions associated with filters passed in via query param.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

sortBy - Root level field name to sort on. (optional)

sortOrder - Direction to sort 'sortBy' field. (optional, default to asc)

category - Filter by category name. (optional)

name - Filter by partial or complete action name. (optional)

ids - Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. (optional)

secure - Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. (optional)

includeAuthActions - Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

ActionEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsActions

public ActionEntityListing getIntegrationsActions(GetIntegrationsActionsRequest request)
                                           throws IOException,
ApiException

Retrieves all actions associated with filters passed in via query param.

Parameters:

request - The request object

Returns:

ActionEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActions

public ApiResponse<ActionEntityListing> getIntegrationsActions(ApiRequest<Void> request)
                                                        throws IOException

Retrieves all actions associated with filters passed in via query param.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsCategories

public CategoryEntityListing getIntegrationsActionsCategories(Integer pageSize,
 Integer pageNumber,
 String nextPage,
 String previousPage,
 String sortBy,
 String sortOrder,
 String secure)
                                                       throws IOException,
ApiException

Retrieves all categories of available Actions

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

sortBy - Root level field name to sort on. Only 'name' is supported on this endpoint. (optional)

sortOrder - Direction to sort 'sortBy' field. (optional, default to asc)

secure - Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. (optional)

Returns:

CategoryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsCategoriesWithHttpInfo

public ApiResponse<CategoryEntityListing> getIntegrationsActionsCategoriesWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String nextPage,
 String previousPage,
 String sortBy,
 String sortOrder,
 String secure)
                                                                                throws IOException

Retrieves all categories of available Actions

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

sortBy - Root level field name to sort on. Only 'name' is supported on this endpoint. (optional)

sortOrder - Direction to sort 'sortBy' field. (optional, default to asc)

secure - Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. (optional)

Returns:

CategoryEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsCategories

public CategoryEntityListing getIntegrationsActionsCategories(GetIntegrationsActionsCategoriesRequest request)
                                                       throws IOException,
ApiException

Retrieves all categories of available Actions

Parameters:

request - The request object

Returns:

CategoryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsCategories

public ApiResponse<CategoryEntityListing> getIntegrationsActionsCategories(ApiRequest<Void> request)
                                                                    throws IOException

Retrieves all categories of available Actions

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsCertificates

public ActionCertificateListing getIntegrationsActionsCertificates(String status,
 String type)
                                                            throws IOException,
ApiException

Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.

Parameters:

status - Indicates the validity of the certificate in question. (optional)

type - Indicates the type of the certificate. (optional)

Returns:

ActionCertificateListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsCertificatesWithHttpInfo

public ApiResponse<ActionCertificateListing> getIntegrationsActionsCertificatesWithHttpInfo(String status,
 String type)
                                                                                     throws IOException

Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.

Parameters:

status - Indicates the validity of the certificate in question. (optional)

type - Indicates the type of the certificate. (optional)

Returns:

ActionCertificateListing

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsCertificates

public ActionCertificateListing getIntegrationsActionsCertificates(GetIntegrationsActionsCertificatesRequest request)
                                                            throws IOException,
ApiException

Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.

Parameters:

request - The request object

Returns:

ActionCertificateListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsCertificates

public ApiResponse<ActionCertificateListing> getIntegrationsActionsCertificates(ApiRequest<Void> request)
                                                                         throws IOException

Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsCertificatesTruststore

public TrustedCertificates getIntegrationsActionsCertificatesTruststore()
                                                                 throws IOException,
ApiException

Retrieves basic info about trusted root CA certificates

Returns:

TrustedCertificates

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsCertificatesTruststoreWithHttpInfo

public ApiResponse<TrustedCertificates> getIntegrationsActionsCertificatesTruststoreWithHttpInfo()
                                                                                          throws IOException

Retrieves basic info about trusted root CA certificates

Returns:

TrustedCertificates

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsCertificatesTruststore

public TrustedCertificates getIntegrationsActionsCertificatesTruststore(GetIntegrationsActionsCertificatesTruststoreRequest request)
                                                                 throws IOException,
ApiException

Retrieves basic info about trusted root CA certificates

Parameters:

request - The request object

Returns:

TrustedCertificates

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsCertificatesTruststore

public ApiResponse<TrustedCertificates> getIntegrationsActionsCertificatesTruststore(ApiRequest<Void> request)
                                                                              throws IOException

Retrieves basic info about trusted root CA certificates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsDrafts

public ActionEntityListing getIntegrationsActionsDrafts(Integer pageSize,
 Integer pageNumber,
 String nextPage,
 String previousPage,
 String sortBy,
 String sortOrder,
 String category,
 String name,
 String ids,
 String secure,
 String includeAuthActions,
 Boolean includeConfig)
                                                 throws IOException,
ApiException

Retrieves all action drafts associated with the filters passed in via query param.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

sortBy - Root level field name to sort on. (optional)

sortOrder - Direction to sort 'sortBy' field. (optional, default to asc)

category - Filter by category name. (optional)

name - Filter by partial or complete action name. (optional)

ids - Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. (optional)

secure - Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. (optional)

includeAuthActions - Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

ActionEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsDraftsWithHttpInfo

public ApiResponse<ActionEntityListing> getIntegrationsActionsDraftsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String nextPage,
 String previousPage,
 String sortBy,
 String sortOrder,
 String category,
 String name,
 String ids,
 String secure,
 String includeAuthActions,
 Boolean includeConfig)
                                                                          throws IOException

Retrieves all action drafts associated with the filters passed in via query param.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

sortBy - Root level field name to sort on. (optional)

sortOrder - Direction to sort 'sortBy' field. (optional, default to asc)

category - Filter by category name. (optional)

name - Filter by partial or complete action name. (optional)

ids - Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. (optional)

secure - Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. (optional)

includeAuthActions - Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (optional, default to false)

includeConfig - Return config in response. (optional, default to false)

Returns:

ActionEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsDrafts

public ActionEntityListing getIntegrationsActionsDrafts(GetIntegrationsActionsDraftsRequest request)
                                                 throws IOException,
ApiException

Retrieves all action drafts associated with the filters passed in via query param.

Parameters:

request - The request object

Returns:

ActionEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsDrafts

public ApiResponse<ActionEntityListing> getIntegrationsActionsDrafts(ApiRequest<Void> request)
                                                              throws IOException

Retrieves all action drafts associated with the filters passed in via query param.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsFunctionsRuntimes

public List<FunctionRuntime> getIntegrationsActionsFunctionsRuntimes()
                                                              throws IOException,
ApiException

Get action function settings for Action

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsFunctionsRuntimesWithHttpInfo

public ApiResponse<List<FunctionRuntime>> getIntegrationsActionsFunctionsRuntimesWithHttpInfo()
                                                                                       throws IOException

Get action function settings for Action

Returns:

List

Throws:

IOException - if the request fails to be processed

getIntegrationsActionsFunctionsRuntimes

public List<FunctionRuntime> getIntegrationsActionsFunctionsRuntimes(GetIntegrationsActionsFunctionsRuntimesRequest request)
                                                              throws IOException,
ApiException

Get action function settings for Action

Parameters:

request - The request object

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsActionsFunctionsRuntimes

public ApiResponse<List<FunctionRuntime>> getIntegrationsActionsFunctionsRuntimes(ApiRequest<Void> request)
                                                                           throws IOException

Get action function settings for Action

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorBot

public Bot getIntegrationsBotconnectorBot(String integrationId,
 String botId,
 String version)
                                   throws IOException,
ApiException

Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

integrationId - The integration ID for this group of bots (required)

botId - The bot ID for this bot (required)

version - Specific Version (optional)

Returns:

Bot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorBotWithHttpInfo

public ApiResponse<Bot> getIntegrationsBotconnectorBotWithHttpInfo(String integrationId,
 String botId,
 String version)
                                                            throws IOException

Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

integrationId - The integration ID for this group of bots (required)

botId - The bot ID for this bot (required)

version - Specific Version (optional)

Returns:

Bot

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorBot

public Bot getIntegrationsBotconnectorBot(GetIntegrationsBotconnectorBotRequest request)
                                   throws IOException,
ApiException

Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

Bot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorBot

public ApiResponse<Bot> getIntegrationsBotconnectorBot(ApiRequest<Void> request)
                                                throws IOException

Get a specific Bot details getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorBots

public BotListing getIntegrationsBotconnectorBots(String integrationId,
 Integer pageNumber,
 Integer pageSize)
                                           throws IOException,
ApiException

Get the list of bots for this integration. getIntegrationsBotconnectorBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

integrationId - The integration ID for this group of bots. (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorBotsWithHttpInfo

public ApiResponse<BotListing> getIntegrationsBotconnectorBotsWithHttpInfo(String integrationId,
 Integer pageNumber,
 Integer pageSize)
                                                                    throws IOException

Get the list of bots for this integration. getIntegrationsBotconnectorBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

integrationId - The integration ID for this group of bots. (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotListing

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorBots

public BotListing getIntegrationsBotconnectorBots(GetIntegrationsBotconnectorBotsRequest request)
                                           throws IOException,
ApiException

Get the list of bots for this integration. getIntegrationsBotconnectorBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

BotListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorBots

public ApiResponse<BotListing> getIntegrationsBotconnectorBots(ApiRequest<Void> request)
                                                        throws IOException

Get the list of bots for this integration. getIntegrationsBotconnectorBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorBotsSummaries

public BotSummaryEntityListing getIntegrationsBotconnectorBotsSummaries(String integrationId,
 Integer pageNumber,
 Integer pageSize)
                                                                 throws IOException,
ApiException

Get the summary list of bots for this integration. getIntegrationsBotconnectorBotsSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

integrationId - The integration ID for this group of bots. (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorBotsSummariesWithHttpInfo

public ApiResponse<BotSummaryEntityListing> getIntegrationsBotconnectorBotsSummariesWithHttpInfo(String integrationId,
 Integer pageNumber,
 Integer pageSize)
                                                                                          throws IOException

Get the summary list of bots for this integration. getIntegrationsBotconnectorBotsSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

integrationId - The integration ID for this group of bots. (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotSummaryEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorBotsSummaries

public BotSummaryEntityListing getIntegrationsBotconnectorBotsSummaries(GetIntegrationsBotconnectorBotsSummariesRequest request)
                                                                 throws IOException,
ApiException

Get the summary list of bots for this integration. getIntegrationsBotconnectorBotsSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

BotSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorBotsSummaries

public ApiResponse<BotSummaryEntityListing> getIntegrationsBotconnectorBotsSummaries(ApiRequest<Void> request)
                                                                              throws IOException

Get the summary list of bots for this integration. getIntegrationsBotconnectorBotsSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBot

public BotConnectorBot getIntegrationsBotconnectorIntegrationIdBot(String integrationId,
 String botId,
 String version)
                                                            throws IOException,
ApiException

Get a specific botConnector bot, plus versions, for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

botId - The botID for this bot (required)

version - Specific Version (optional)

Returns:

BotConnectorBot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotWithHttpInfo

public ApiResponse<BotConnectorBot> getIntegrationsBotconnectorIntegrationIdBotWithHttpInfo(String integrationId,
 String botId,
 String version)
                                                                                     throws IOException

Get a specific botConnector bot, plus versions, for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

botId - The botID for this bot (required)

version - Specific Version (optional)

Returns:

BotConnectorBot

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBot

public BotConnectorBot getIntegrationsBotconnectorIntegrationIdBot(GetIntegrationsBotconnectorIntegrationIdBotRequest request)
                                                            throws IOException,
ApiException

Get a specific botConnector bot, plus versions, for this integration

Parameters:

request - The request object

Returns:

BotConnectorBot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBot

public ApiResponse<BotConnectorBot> getIntegrationsBotconnectorIntegrationIdBot(ApiRequest<Void> request)
                                                                         throws IOException

Get a specific botConnector bot, plus versions, for this integration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotVersions

public BotConnectorBotVersionSummaryEntityListing getIntegrationsBotconnectorIntegrationIdBotVersions(String integrationId,
 String botId,
 Integer pageNumber,
 Integer pageSize)
                                                                                               throws IOException,
ApiException

Get a list of bot versions for a bot

Parameters:

integrationId - The integration ID for this bot group (required)

botId - The botID for this bot (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotConnectorBotVersionSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotVersionsWithHttpInfo

public ApiResponse<BotConnectorBotVersionSummaryEntityListing> getIntegrationsBotconnectorIntegrationIdBotVersionsWithHttpInfo(String integrationId,
 String botId,
 Integer pageNumber,
 Integer pageSize)
                                                                                                                        throws IOException

Get a list of bot versions for a bot

Parameters:

integrationId - The integration ID for this bot group (required)

botId - The botID for this bot (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotConnectorBotVersionSummaryEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotVersions

public BotConnectorBotVersionSummaryEntityListing getIntegrationsBotconnectorIntegrationIdBotVersions(GetIntegrationsBotconnectorIntegrationIdBotVersionsRequest request)
                                                                                               throws IOException,
ApiException

Get a list of bot versions for a bot

Parameters:

request - The request object

Returns:

BotConnectorBotVersionSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotVersions

public ApiResponse<BotConnectorBotVersionSummaryEntityListing> getIntegrationsBotconnectorIntegrationIdBotVersions(ApiRequest<Void> request)
                                                                                                            throws IOException

Get a list of bot versions for a bot

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBots

public BotList getIntegrationsBotconnectorIntegrationIdBots(String integrationId)
                                                     throws IOException,
ApiException

Get a list of botConnector bots for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

Returns:

BotList

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotsWithHttpInfo

public ApiResponse<BotList> getIntegrationsBotconnectorIntegrationIdBotsWithHttpInfo(String integrationId)
                                                                              throws IOException

Get a list of botConnector bots for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

Returns:

BotList

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBots

public BotList getIntegrationsBotconnectorIntegrationIdBots(GetIntegrationsBotconnectorIntegrationIdBotsRequest request)
                                                     throws IOException,
ApiException

Get a list of botConnector bots for this integration

Parameters:

request - The request object

Returns:

BotList

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBots

public ApiResponse<BotList> getIntegrationsBotconnectorIntegrationIdBots(ApiRequest<Void> request)
                                                                  throws IOException

Get a list of botConnector bots for this integration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotsSummaries

public BotConnectorBotSummaryEntityListing getIntegrationsBotconnectorIntegrationIdBotsSummaries(String integrationId,
 Integer pageNumber,
 Integer pageSize)
                                                                                          throws IOException,
ApiException

Get a summary list of botConnector bots for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotConnectorBotSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotsSummariesWithHttpInfo

public ApiResponse<BotConnectorBotSummaryEntityListing> getIntegrationsBotconnectorIntegrationIdBotsSummariesWithHttpInfo(String integrationId,
 Integer pageNumber,
 Integer pageSize)
                                                                                                                   throws IOException

Get a summary list of botConnector bots for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

BotConnectorBotSummaryEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotsSummaries

public BotConnectorBotSummaryEntityListing getIntegrationsBotconnectorIntegrationIdBotsSummaries(GetIntegrationsBotconnectorIntegrationIdBotsSummariesRequest request)
                                                                                          throws IOException,
ApiException

Get a summary list of botConnector bots for this integration

Parameters:

request - The request object

Returns:

BotConnectorBotSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsBotconnectorIntegrationIdBotsSummaries

public ApiResponse<BotConnectorBotSummaryEntityListing> getIntegrationsBotconnectorIntegrationIdBotsSummaries(ApiRequest<Void> request)
                                                                                                       throws IOException

Get a summary list of botConnector bots for this integration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsClientapps

public ClientAppEntityListing getIntegrationsClientapps(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                 throws IOException,
ApiException

List permitted client app integrations for the logged in user

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

ClientAppEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsClientappsWithHttpInfo

public ApiResponse<ClientAppEntityListing> getIntegrationsClientappsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                                          throws IOException

List permitted client app integrations for the logged in user

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

ClientAppEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsClientapps

public ClientAppEntityListing getIntegrationsClientapps(GetIntegrationsClientappsRequest request)
                                                 throws IOException,
ApiException

List permitted client app integrations for the logged in user

Parameters:

request - The request object

Returns:

ClientAppEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsClientapps

public ApiResponse<ClientAppEntityListing> getIntegrationsClientapps(ApiRequest<Void> request)
                                                              throws IOException

List permitted client app integrations for the logged in user

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsClientappsUnifiedcommunications

public UCIntegrationListing getIntegrationsClientappsUnifiedcommunications(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                                    throws IOException,
ApiException

Deprecated.

UC integration client application configuration. Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

UCIntegrationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsClientappsUnifiedcommunicationsWithHttpInfo

public ApiResponse<UCIntegrationListing> getIntegrationsClientappsUnifiedcommunicationsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                                                             throws IOException

Deprecated.

UC integration client application configuration. Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

UCIntegrationListing

Throws:

IOException - if the request fails to be processed

getIntegrationsClientappsUnifiedcommunications

public UCIntegrationListing getIntegrationsClientappsUnifiedcommunications(GetIntegrationsClientappsUnifiedcommunicationsRequest request)
                                                                    throws IOException,
ApiException

Deprecated.

UC integration client application configuration. Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.

Parameters:

request - The request object

Returns:

UCIntegrationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsClientappsUnifiedcommunications

public ApiResponse<UCIntegrationListing> getIntegrationsClientappsUnifiedcommunications(ApiRequest<Void> request)
                                                                                 throws IOException

Deprecated.

UC integration client application configuration. Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsCredential

public Credential getIntegrationsCredential(String credentialId)
                                     throws IOException,
ApiException

Get a single credential with sensitive fields redacted

Parameters:

credentialId - Credential ID (required)

Returns:

Credential

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredentialWithHttpInfo

public ApiResponse<Credential> getIntegrationsCredentialWithHttpInfo(String credentialId)
                                                              throws IOException

Get a single credential with sensitive fields redacted

Parameters:

credentialId - Credential ID (required)

Returns:

Credential

Throws:

IOException - if the request fails to be processed

getIntegrationsCredential

public Credential getIntegrationsCredential(GetIntegrationsCredentialRequest request)
                                     throws IOException,
ApiException

Get a single credential with sensitive fields redacted

Parameters:

request - The request object

Returns:

Credential

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredential

public ApiResponse<Credential> getIntegrationsCredential(ApiRequest<Void> request)
                                                  throws IOException

Get a single credential with sensitive fields redacted

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsCredentials

public CredentialInfoListing getIntegrationsCredentials(Integer pageNumber,
 Integer pageSize)
                                                 throws IOException,
ApiException

Deprecated.

List multiple sets of credentials This endpoint is deprecated. Please see the Listing API (GET /api/v2/integrations/credentials/listing)

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

CredentialInfoListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredentialsWithHttpInfo

public ApiResponse<CredentialInfoListing> getIntegrationsCredentialsWithHttpInfo(Integer pageNumber,
 Integer pageSize)
                                                                          throws IOException

Deprecated.

List multiple sets of credentials This endpoint is deprecated. Please see the Listing API (GET /api/v2/integrations/credentials/listing)

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

CredentialInfoListing

Throws:

IOException - if the request fails to be processed

getIntegrationsCredentials

public CredentialInfoListing getIntegrationsCredentials(GetIntegrationsCredentialsRequest request)
                                                 throws IOException,
ApiException

Deprecated.

List multiple sets of credentials This endpoint is deprecated. Please see the Listing API (GET /api/v2/integrations/credentials/listing)

Parameters:

request - The request object

Returns:

CredentialInfoListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredentials

public ApiResponse<CredentialInfoListing> getIntegrationsCredentials(ApiRequest<Void> request)
                                                              throws IOException

Deprecated.

List multiple sets of credentials This endpoint is deprecated. Please see the Listing API (GET /api/v2/integrations/credentials/listing)

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsCredentialsListing

public CredentialInfoCursorListing getIntegrationsCredentialsListing(String before,
 String after,
 String pageSize)
                                                              throws IOException,
ApiException

List multiple sets of credentials using cursor-based paging

Parameters:

before - The cursor that points to the start of the set of entities that has been returned. (optional)

after - The cursor that points to the end of the set of entities that has been returned. (optional)

pageSize - Number of entities to return. Maximum of 200. (optional)

Returns:

CredentialInfoCursorListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredentialsListingWithHttpInfo

public ApiResponse<CredentialInfoCursorListing> getIntegrationsCredentialsListingWithHttpInfo(String before,
 String after,
 String pageSize)
                                                                                       throws IOException

List multiple sets of credentials using cursor-based paging

Parameters:

before - The cursor that points to the start of the set of entities that has been returned. (optional)

after - The cursor that points to the end of the set of entities that has been returned. (optional)

pageSize - Number of entities to return. Maximum of 200. (optional)

Returns:

CredentialInfoCursorListing

Throws:

IOException - if the request fails to be processed

getIntegrationsCredentialsListing

public CredentialInfoCursorListing getIntegrationsCredentialsListing(GetIntegrationsCredentialsListingRequest request)
                                                              throws IOException,
ApiException

List multiple sets of credentials using cursor-based paging

Parameters:

request - The request object

Returns:

CredentialInfoCursorListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredentialsListing

public ApiResponse<CredentialInfoCursorListing> getIntegrationsCredentialsListing(ApiRequest<Void> request)
                                                                           throws IOException

List multiple sets of credentials using cursor-based paging

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsCredentialsTypes

public List<CredentialType> getIntegrationsCredentialsTypes()
                                                     throws IOException,
ApiException

List all credential types

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredentialsTypesWithHttpInfo

public ApiResponse<List<CredentialType>> getIntegrationsCredentialsTypesWithHttpInfo()
                                                                              throws IOException

List all credential types

Returns:

List

Throws:

IOException - if the request fails to be processed

getIntegrationsCredentialsTypes

public List<CredentialType> getIntegrationsCredentialsTypes(GetIntegrationsCredentialsTypesRequest request)
                                                     throws IOException,
ApiException

List all credential types

Parameters:

request - The request object

Returns:

List

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsCredentialsTypes

public ApiResponse<List<CredentialType>> getIntegrationsCredentialsTypes(ApiRequest<Void> request)
                                                                  throws IOException

List all credential types

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnector

public AudioConnectorIntegrationEntityListing getIntegrationsSpeechAudioconnector(Integer pageNumber,
 Integer pageSize)
                                                                           throws IOException,
ApiException

Get a list of Audio Connector integrations

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

AudioConnectorIntegrationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnectorWithHttpInfo

public ApiResponse<AudioConnectorIntegrationEntityListing> getIntegrationsSpeechAudioconnectorWithHttpInfo(Integer pageNumber,
 Integer pageSize)
                                                                                                    throws IOException

Get a list of Audio Connector integrations

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

AudioConnectorIntegrationEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnector

public AudioConnectorIntegrationEntityListing getIntegrationsSpeechAudioconnector(GetIntegrationsSpeechAudioconnectorRequest request)
                                                                           throws IOException,
ApiException

Get a list of Audio Connector integrations

Parameters:

request - The request object

Returns:

AudioConnectorIntegrationEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnector

public ApiResponse<AudioConnectorIntegrationEntityListing> getIntegrationsSpeechAudioconnector(ApiRequest<Void> request)
                                                                                        throws IOException

Get a list of Audio Connector integrations

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnectorIntegrationId

public AudioConnectorIntegration getIntegrationsSpeechAudioconnectorIntegrationId(String integrationId)
                                                                           throws IOException,
ApiException

Get an Audio Connector integration

Parameters:

integrationId - The integration ID (required)

Returns:

AudioConnectorIntegration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnectorIntegrationIdWithHttpInfo

public ApiResponse<AudioConnectorIntegration> getIntegrationsSpeechAudioconnectorIntegrationIdWithHttpInfo(String integrationId)
                                                                                                    throws IOException

Get an Audio Connector integration

Parameters:

integrationId - The integration ID (required)

Returns:

AudioConnectorIntegration

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnectorIntegrationId

public AudioConnectorIntegration getIntegrationsSpeechAudioconnectorIntegrationId(GetIntegrationsSpeechAudioconnectorIntegrationIdRequest request)
                                                                           throws IOException,
ApiException

Get an Audio Connector integration

Parameters:

request - The request object

Returns:

AudioConnectorIntegration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechAudioconnectorIntegrationId

public ApiResponse<AudioConnectorIntegration> getIntegrationsSpeechAudioconnectorIntegrationId(ApiRequest<Void> request)
                                                                                        throws IOException

Get an Audio Connector integration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgent

public DialogflowAgent getIntegrationsSpeechDialogflowAgent(String agentId)
                                                     throws IOException,
ApiException

Get details about a Dialogflow agent

Parameters:

agentId - The agent ID (required)

Returns:

DialogflowAgent

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgentWithHttpInfo

public ApiResponse<DialogflowAgent> getIntegrationsSpeechDialogflowAgentWithHttpInfo(String agentId)
                                                                              throws IOException

Get details about a Dialogflow agent

Parameters:

agentId - The agent ID (required)

Returns:

DialogflowAgent

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgent

public DialogflowAgent getIntegrationsSpeechDialogflowAgent(GetIntegrationsSpeechDialogflowAgentRequest request)
                                                     throws IOException,
ApiException

Get details about a Dialogflow agent

Parameters:

request - The request object

Returns:

DialogflowAgent

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgent

public ApiResponse<DialogflowAgent> getIntegrationsSpeechDialogflowAgent(ApiRequest<Void> request)
                                                                  throws IOException

Get details about a Dialogflow agent

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgents

public DialogflowAgentSummaryEntityListing getIntegrationsSpeechDialogflowAgents(Integer pageNumber,
 Integer pageSize,
 String name)
                                                                          throws IOException,
ApiException

Get a list of Dialogflow agents in the customers' Google accounts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on agent name (optional)

Returns:

DialogflowAgentSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgentsWithHttpInfo

public ApiResponse<DialogflowAgentSummaryEntityListing> getIntegrationsSpeechDialogflowAgentsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String name)
                                                                                                   throws IOException

Get a list of Dialogflow agents in the customers' Google accounts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on agent name (optional)

Returns:

DialogflowAgentSummaryEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgents

public DialogflowAgentSummaryEntityListing getIntegrationsSpeechDialogflowAgents(GetIntegrationsSpeechDialogflowAgentsRequest request)
                                                                          throws IOException,
ApiException

Get a list of Dialogflow agents in the customers' Google accounts

Parameters:

request - The request object

Returns:

DialogflowAgentSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowAgents

public ApiResponse<DialogflowAgentSummaryEntityListing> getIntegrationsSpeechDialogflowAgents(ApiRequest<Void> request)
                                                                                       throws IOException

Get a list of Dialogflow agents in the customers' Google accounts

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgent

public DialogflowCXAgent getIntegrationsSpeechDialogflowcxAgent(String agentId)
                                                         throws IOException,
ApiException

Get details about a Dialogflow CX agent

Parameters:

agentId - The agent ID (required)

Returns:

DialogflowCXAgent

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgentWithHttpInfo

public ApiResponse<DialogflowCXAgent> getIntegrationsSpeechDialogflowcxAgentWithHttpInfo(String agentId)
                                                                                  throws IOException

Get details about a Dialogflow CX agent

Parameters:

agentId - The agent ID (required)

Returns:

DialogflowCXAgent

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgent

public DialogflowCXAgent getIntegrationsSpeechDialogflowcxAgent(GetIntegrationsSpeechDialogflowcxAgentRequest request)
                                                         throws IOException,
ApiException

Get details about a Dialogflow CX agent

Parameters:

request - The request object

Returns:

DialogflowCXAgent

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgent

public ApiResponse<DialogflowCXAgent> getIntegrationsSpeechDialogflowcxAgent(ApiRequest<Void> request)
                                                                      throws IOException

Get details about a Dialogflow CX agent

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgents

public DialogflowCXAgentSummaryEntityListing getIntegrationsSpeechDialogflowcxAgents(Integer pageNumber,
 Integer pageSize,
 String name)
                                                                              throws IOException,
ApiException

Get a list of Dialogflow CX agents in the customers' Google accounts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on agent name (optional)

Returns:

DialogflowCXAgentSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgentsWithHttpInfo

public ApiResponse<DialogflowCXAgentSummaryEntityListing> getIntegrationsSpeechDialogflowcxAgentsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String name)
                                                                                                       throws IOException

Get a list of Dialogflow CX agents in the customers' Google accounts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on agent name (optional)

Returns:

DialogflowCXAgentSummaryEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgents

public DialogflowCXAgentSummaryEntityListing getIntegrationsSpeechDialogflowcxAgents(GetIntegrationsSpeechDialogflowcxAgentsRequest request)
                                                                              throws IOException,
ApiException

Get a list of Dialogflow CX agents in the customers' Google accounts

Parameters:

request - The request object

Returns:

DialogflowCXAgentSummaryEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechDialogflowcxAgents

public ApiResponse<DialogflowCXAgentSummaryEntityListing> getIntegrationsSpeechDialogflowcxAgents(ApiRequest<Void> request)
                                                                                           throws IOException

Get a list of Dialogflow CX agents in the customers' Google accounts

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotAlias

public LexBotAlias getIntegrationsSpeechLexBotAlias(String aliasId)
                                             throws IOException,
ApiException

Get details about a Lex bot alias

Parameters:

aliasId - The alias ID (required)

Returns:

LexBotAlias

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotAliasWithHttpInfo

public ApiResponse<LexBotAlias> getIntegrationsSpeechLexBotAliasWithHttpInfo(String aliasId)
                                                                      throws IOException

Get details about a Lex bot alias

Parameters:

aliasId - The alias ID (required)

Returns:

LexBotAlias

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotAlias

public LexBotAlias getIntegrationsSpeechLexBotAlias(GetIntegrationsSpeechLexBotAliasRequest request)
                                             throws IOException,
ApiException

Get details about a Lex bot alias

Parameters:

request - The request object

Returns:

LexBotAlias

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotAlias

public ApiResponse<LexBotAlias> getIntegrationsSpeechLexBotAlias(ApiRequest<Void> request)
                                                          throws IOException

Get details about a Lex bot alias

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotBotIdAliases

public LexBotAliasEntityListing getIntegrationsSpeechLexBotBotIdAliases(String botId,
 Integer pageNumber,
 Integer pageSize,
 String status,
 String name)
                                                                 throws IOException,
ApiException

Get a list of aliases for a bot in the customer's AWS accounts

Parameters:

botId - The bot ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

status - Filter on alias status (optional)

name - Filter on alias name (optional)

Returns:

LexBotAliasEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotBotIdAliasesWithHttpInfo

public ApiResponse<LexBotAliasEntityListing> getIntegrationsSpeechLexBotBotIdAliasesWithHttpInfo(String botId,
 Integer pageNumber,
 Integer pageSize,
 String status,
 String name)
                                                                                          throws IOException

Get a list of aliases for a bot in the customer's AWS accounts

Parameters:

botId - The bot ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

status - Filter on alias status (optional)

name - Filter on alias name (optional)

Returns:

LexBotAliasEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotBotIdAliases

public LexBotAliasEntityListing getIntegrationsSpeechLexBotBotIdAliases(GetIntegrationsSpeechLexBotBotIdAliasesRequest request)
                                                                 throws IOException,
ApiException

Get a list of aliases for a bot in the customer's AWS accounts

Parameters:

request - The request object

Returns:

LexBotAliasEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotBotIdAliases

public ApiResponse<LexBotAliasEntityListing> getIntegrationsSpeechLexBotBotIdAliases(ApiRequest<Void> request)
                                                                              throws IOException

Get a list of aliases for a bot in the customer's AWS accounts

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexBots

public LexBotEntityListing getIntegrationsSpeechLexBots(Integer pageNumber,
 Integer pageSize,
 String name)
                                                 throws IOException,
ApiException

Get a list of Lex bots in the customers' AWS accounts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on bot name (optional)

Returns:

LexBotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexBotsWithHttpInfo

public ApiResponse<LexBotEntityListing> getIntegrationsSpeechLexBotsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String name)
                                                                          throws IOException

Get a list of Lex bots in the customers' AWS accounts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on bot name (optional)

Returns:

LexBotEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexBots

public LexBotEntityListing getIntegrationsSpeechLexBots(GetIntegrationsSpeechLexBotsRequest request)
                                                 throws IOException,
ApiException

Get a list of Lex bots in the customers' AWS accounts

Parameters:

request - The request object

Returns:

LexBotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexBots

public ApiResponse<LexBotEntityListing> getIntegrationsSpeechLexBots(ApiRequest<Void> request)
                                                              throws IOException

Get a list of Lex bots in the customers' AWS accounts

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotAlias

public LexV2BotAlias getIntegrationsSpeechLexv2BotAlias(String aliasId)
                                                 throws IOException,
ApiException

Get details about a Lex V2 bot alias

Parameters:

aliasId - The Alias ID (required)

Returns:

LexV2BotAlias

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotAliasWithHttpInfo

public ApiResponse<LexV2BotAlias> getIntegrationsSpeechLexv2BotAliasWithHttpInfo(String aliasId)
                                                                          throws IOException

Get details about a Lex V2 bot alias

Parameters:

aliasId - The Alias ID (required)

Returns:

LexV2BotAlias

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotAlias

public LexV2BotAlias getIntegrationsSpeechLexv2BotAlias(GetIntegrationsSpeechLexv2BotAliasRequest request)
                                                 throws IOException,
ApiException

Get details about a Lex V2 bot alias

Parameters:

request - The request object

Returns:

LexV2BotAlias

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotAlias

public ApiResponse<LexV2BotAlias> getIntegrationsSpeechLexv2BotAlias(ApiRequest<Void> request)
                                                              throws IOException

Get details about a Lex V2 bot alias

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotBotIdAliases

public LexV2BotAliasEntityListing getIntegrationsSpeechLexv2BotBotIdAliases(String botId,
 Integer pageNumber,
 Integer pageSize,
 String status,
 String name)
                                                                     throws IOException,
ApiException

Get a list of aliases for a Lex V2 bot

Parameters:

botId - The Bot ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

status - Filter on alias status (optional)

name - Filter on alias name (optional)

Returns:

LexV2BotAliasEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotBotIdAliasesWithHttpInfo

public ApiResponse<LexV2BotAliasEntityListing> getIntegrationsSpeechLexv2BotBotIdAliasesWithHttpInfo(String botId,
 Integer pageNumber,
 Integer pageSize,
 String status,
 String name)
                                                                                              throws IOException

Get a list of aliases for a Lex V2 bot

Parameters:

botId - The Bot ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

status - Filter on alias status (optional)

name - Filter on alias name (optional)

Returns:

LexV2BotAliasEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotBotIdAliases

public LexV2BotAliasEntityListing getIntegrationsSpeechLexv2BotBotIdAliases(GetIntegrationsSpeechLexv2BotBotIdAliasesRequest request)
                                                                     throws IOException,
ApiException

Get a list of aliases for a Lex V2 bot

Parameters:

request - The request object

Returns:

LexV2BotAliasEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotBotIdAliases

public ApiResponse<LexV2BotAliasEntityListing> getIntegrationsSpeechLexv2BotBotIdAliases(ApiRequest<Void> request)
                                                                                  throws IOException

Get a list of aliases for a Lex V2 bot

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2Bots

public LexV2BotEntityListing getIntegrationsSpeechLexv2Bots(Integer pageNumber,
 Integer pageSize,
 String name)
                                                     throws IOException,
ApiException

Get a list of Lex V2 bots

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on bot name (optional)

Returns:

LexV2BotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2BotsWithHttpInfo

public ApiResponse<LexV2BotEntityListing> getIntegrationsSpeechLexv2BotsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String name)
                                                                              throws IOException

Get a list of Lex V2 bots

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on bot name (optional)

Returns:

LexV2BotEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2Bots

public LexV2BotEntityListing getIntegrationsSpeechLexv2Bots(GetIntegrationsSpeechLexv2BotsRequest request)
                                                     throws IOException,
ApiException

Get a list of Lex V2 bots

Parameters:

request - The request object

Returns:

LexV2BotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechLexv2Bots

public ApiResponse<LexV2BotEntityListing> getIntegrationsSpeechLexv2Bots(ApiRequest<Void> request)
                                                                  throws IOException

Get a list of Lex V2 bots

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBot

public NuanceBot getIntegrationsSpeechNuanceNuanceIntegrationIdBot(String nuanceIntegrationId,
 String botId,
 List<String> expand,
 String targetChannel)
                                                            throws IOException,
ApiException

Get a Nuance bot in the specified Integration

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID to get (required)

expand - expand (optional)

targetChannel - targetChannel (optional)

Returns:

NuanceBot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotWithHttpInfo

public ApiResponse<NuanceBot> getIntegrationsSpeechNuanceNuanceIntegrationIdBotWithHttpInfo(String nuanceIntegrationId,
 String botId,
 List<String> expand,
 String targetChannel)
                                                                                     throws IOException

Get a Nuance bot in the specified Integration

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID to get (required)

expand - expand (optional)

targetChannel - targetChannel (optional)

Returns:

NuanceBot

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBot

public NuanceBot getIntegrationsSpeechNuanceNuanceIntegrationIdBot(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotRequest request)
                                                            throws IOException,
ApiException

Get a Nuance bot in the specified Integration

Parameters:

request - The request object

Returns:

NuanceBot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBot

public ApiResponse<NuanceBot> getIntegrationsSpeechNuanceNuanceIntegrationIdBot(ApiRequest<Void> request)
                                                                         throws IOException

Get a Nuance bot in the specified Integration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob

public AsyncJob getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(String nuanceIntegrationId,
 String botId,
 String jobId)
                                                              throws IOException,
ApiException

Get the status of an asynchronous Nuance bot GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID (required)

jobId - The asynchronous job ID (required)

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobWithHttpInfo

public ApiResponse<AsyncJob> getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobWithHttpInfo(String nuanceIntegrationId,
 String botId,
 String jobId)
                                                                                       throws IOException

Get the status of an asynchronous Nuance bot GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID (required)

jobId - The asynchronous job ID (required)

Returns:

AsyncJob

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob

public AsyncJob getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotJobRequest request)
                                                              throws IOException,
ApiException

Get the status of an asynchronous Nuance bot GET job

Parameters:

request - The request object

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob

public ApiResponse<AsyncJob> getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(ApiRequest<Void> request)
                                                                           throws IOException

Get the status of an asynchronous Nuance bot GET job

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults

public NuanceBot getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(String nuanceIntegrationId,
 String botId,
 String jobId)
                                                                      throws IOException,
ApiException

Get the result of an asynchronous Nuance bot GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID (required)

jobId - The asynchronous job ID (required)

Returns:

NuanceBot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResultsWithHttpInfo

public ApiResponse<NuanceBot> getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResultsWithHttpInfo(String nuanceIntegrationId,
 String botId,
 String jobId)
                                                                                               throws IOException

Get the result of an asynchronous Nuance bot GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID (required)

jobId - The asynchronous job ID (required)

Returns:

NuanceBot

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults

public NuanceBot getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResultsRequest request)
                                                                      throws IOException,
ApiException

Get the result of an asynchronous Nuance bot GET job

Parameters:

request - The request object

Returns:

NuanceBot

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults

public ApiResponse<NuanceBot> getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(ApiRequest<Void> request)
                                                                                   throws IOException

Get the result of an asynchronous Nuance bot GET job

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBots

public NuanceBotEntityListing getIntegrationsSpeechNuanceNuanceIntegrationIdBots(String nuanceIntegrationId,
 Integer pageNumber,
 Integer pageSize,
 Boolean onlyRegisteredBots)
                                                                          throws IOException,
ApiException

Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

onlyRegisteredBots - Limit bots to the ones configured for Genesys Cloud usage (optional, default to true)

Returns:

NuanceBotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsWithHttpInfo

public ApiResponse<NuanceBotEntityListing> getIntegrationsSpeechNuanceNuanceIntegrationIdBotsWithHttpInfo(String nuanceIntegrationId,
 Integer pageNumber,
 Integer pageSize,
 Boolean onlyRegisteredBots)
                                                                                                   throws IOException

Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

onlyRegisteredBots - Limit bots to the ones configured for Genesys Cloud usage (optional, default to true)

Returns:

NuanceBotEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBots

public NuanceBotEntityListing getIntegrationsSpeechNuanceNuanceIntegrationIdBots(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotsRequest request)
                                                                          throws IOException,
ApiException

Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.

Parameters:

request - The request object

Returns:

NuanceBotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBots

public ApiResponse<NuanceBotEntityListing> getIntegrationsSpeechNuanceNuanceIntegrationIdBots(ApiRequest<Void> request)
                                                                                       throws IOException

Get a list of Nuance bots available in the specified Integration If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob

public AsyncJob getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(String nuanceIntegrationId,
 String jobId)
                                                               throws IOException,
ApiException

Get the status of an asynchronous Nuance bots GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

jobId - The asynchronous job ID (required)

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobWithHttpInfo

public ApiResponse<AsyncJob> getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobWithHttpInfo(String nuanceIntegrationId,
 String jobId)
                                                                                        throws IOException

Get the status of an asynchronous Nuance bots GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

jobId - The asynchronous job ID (required)

Returns:

AsyncJob

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob

public AsyncJob getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobRequest request)
                                                               throws IOException,
ApiException

Get the status of an asynchronous Nuance bots GET job

Parameters:

request - The request object

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob

public ApiResponse<AsyncJob> getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(ApiRequest<Void> request)
                                                                            throws IOException

Get the status of an asynchronous Nuance bots GET job

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults

public NuanceBotEntityListing getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(String nuanceIntegrationId,
 String jobId)
                                                                                    throws IOException,
ApiException

Get the result of an asynchronous Nuance bots GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

jobId - The asynchronous job ID (required)

Returns:

NuanceBotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResultsWithHttpInfo

public ApiResponse<NuanceBotEntityListing> getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResultsWithHttpInfo(String nuanceIntegrationId,
 String jobId)
                                                                                                             throws IOException

Get the result of an asynchronous Nuance bots GET job

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

jobId - The asynchronous job ID (required)

Returns:

NuanceBotEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults

public NuanceBotEntityListing getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(GetIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResultsRequest request)
                                                                                    throws IOException,
ApiException

Get the result of an asynchronous Nuance bots GET job

Parameters:

request - The request object

Returns:

NuanceBotEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults

public ApiResponse<NuanceBotEntityListing> getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(ApiRequest<Void> request)
                                                                                                 throws IOException

Get the result of an asynchronous Nuance bots GET job

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechSttEngine

public SttEngineEntity getIntegrationsSpeechSttEngine(String engineId)
                                               throws IOException,
ApiException

Get details about a STT engine

Parameters:

engineId - The engine ID (required)

Returns:

SttEngineEntity

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechSttEngineWithHttpInfo

public ApiResponse<SttEngineEntity> getIntegrationsSpeechSttEngineWithHttpInfo(String engineId)
                                                                        throws IOException

Get details about a STT engine

Parameters:

engineId - The engine ID (required)

Returns:

SttEngineEntity

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechSttEngine

public SttEngineEntity getIntegrationsSpeechSttEngine(GetIntegrationsSpeechSttEngineRequest request)
                                               throws IOException,
ApiException

Get details about a STT engine

Parameters:

request - The request object

Returns:

SttEngineEntity

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechSttEngine

public ApiResponse<SttEngineEntity> getIntegrationsSpeechSttEngine(ApiRequest<Void> request)
                                                            throws IOException

Get details about a STT engine

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechSttEngines

public SttEngineEntityListing getIntegrationsSpeechSttEngines(Integer pageNumber,
 Integer pageSize,
 String name)
                                                       throws IOException,
ApiException

Get a list of STT engines enabled for org

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on engine name (optional)

Returns:

SttEngineEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechSttEnginesWithHttpInfo

public ApiResponse<SttEngineEntityListing> getIntegrationsSpeechSttEnginesWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String name)
                                                                                throws IOException

Get a list of STT engines enabled for org

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Filter on engine name (optional)

Returns:

SttEngineEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechSttEngines

public SttEngineEntityListing getIntegrationsSpeechSttEngines(GetIntegrationsSpeechSttEnginesRequest request)
                                                       throws IOException,
ApiException

Get a list of STT engines enabled for org

Parameters:

request - The request object

Returns:

SttEngineEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechSttEngines

public ApiResponse<SttEngineEntityListing> getIntegrationsSpeechSttEngines(ApiRequest<Void> request)
                                                                    throws IOException

Get a list of STT engines enabled for org

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngine

public TtsEngineEntity getIntegrationsSpeechTtsEngine(String engineId,
 Boolean includeVoices)
                                               throws IOException,
ApiException

Get details about a TTS engine

Parameters:

engineId - The engine ID (required)

includeVoices - Include voices for the engine (optional, default to false)

Returns:

TtsEngineEntity

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineWithHttpInfo

public ApiResponse<TtsEngineEntity> getIntegrationsSpeechTtsEngineWithHttpInfo(String engineId,
 Boolean includeVoices)
                                                                        throws IOException

Get details about a TTS engine

Parameters:

engineId - The engine ID (required)

includeVoices - Include voices for the engine (optional, default to false)

Returns:

TtsEngineEntity

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngine

public TtsEngineEntity getIntegrationsSpeechTtsEngine(GetIntegrationsSpeechTtsEngineRequest request)
                                               throws IOException,
ApiException

Get details about a TTS engine

Parameters:

request - The request object

Returns:

TtsEngineEntity

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngine

public ApiResponse<TtsEngineEntity> getIntegrationsSpeechTtsEngine(ApiRequest<Void> request)
                                                            throws IOException

Get details about a TTS engine

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoice

public TtsVoiceEntity getIntegrationsSpeechTtsEngineVoice(String engineId,
 String voiceId)
                                                   throws IOException,
ApiException

Get details about a specific voice for a TTS engine

Parameters:

engineId - The engine ID (required)

voiceId - The voice ID (required)

Returns:

TtsVoiceEntity

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoiceWithHttpInfo

public ApiResponse<TtsVoiceEntity> getIntegrationsSpeechTtsEngineVoiceWithHttpInfo(String engineId,
 String voiceId)
                                                                            throws IOException

Get details about a specific voice for a TTS engine

Parameters:

engineId - The engine ID (required)

voiceId - The voice ID (required)

Returns:

TtsVoiceEntity

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoice

public TtsVoiceEntity getIntegrationsSpeechTtsEngineVoice(GetIntegrationsSpeechTtsEngineVoiceRequest request)
                                                   throws IOException,
ApiException

Get details about a specific voice for a TTS engine

Parameters:

request - The request object

Returns:

TtsVoiceEntity

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoice

public ApiResponse<TtsVoiceEntity> getIntegrationsSpeechTtsEngineVoice(ApiRequest<Void> request)
                                                                throws IOException

Get details about a specific voice for a TTS engine

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoices

public TtsVoiceEntityListing getIntegrationsSpeechTtsEngineVoices(String engineId,
 Integer pageNumber,
 Integer pageSize)
                                                           throws IOException,
ApiException

Get a list of voices for a TTS engine

Parameters:

engineId - The engine ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

TtsVoiceEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoicesWithHttpInfo

public ApiResponse<TtsVoiceEntityListing> getIntegrationsSpeechTtsEngineVoicesWithHttpInfo(String engineId,
 Integer pageNumber,
 Integer pageSize)
                                                                                    throws IOException

Get a list of voices for a TTS engine

Parameters:

engineId - The engine ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

TtsVoiceEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoices

public TtsVoiceEntityListing getIntegrationsSpeechTtsEngineVoices(GetIntegrationsSpeechTtsEngineVoicesRequest request)
                                                           throws IOException,
ApiException

Get a list of voices for a TTS engine

Parameters:

request - The request object

Returns:

TtsVoiceEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngineVoices

public ApiResponse<TtsVoiceEntityListing> getIntegrationsSpeechTtsEngineVoices(ApiRequest<Void> request)
                                                                        throws IOException

Get a list of voices for a TTS engine

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngines

public TtsEngineEntityListing getIntegrationsSpeechTtsEngines(Integer pageNumber,
 Integer pageSize,
 Boolean includeVoices,
 String name,
 String language)
                                                       throws IOException,
ApiException

Get a list of TTS engines enabled for org

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

includeVoices - Include voices for the engine (optional, default to false)

name - Filter on engine name (optional)

language - Filter on supported language. If includeVoices=true then the voices are also filtered. (optional)

Returns:

TtsEngineEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEnginesWithHttpInfo

public ApiResponse<TtsEngineEntityListing> getIntegrationsSpeechTtsEnginesWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 Boolean includeVoices,
 String name,
 String language)
                                                                                throws IOException

Get a list of TTS engines enabled for org

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

includeVoices - Include voices for the engine (optional, default to false)

name - Filter on engine name (optional)

language - Filter on supported language. If includeVoices=true then the voices are also filtered. (optional)

Returns:

TtsEngineEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngines

public TtsEngineEntityListing getIntegrationsSpeechTtsEngines(GetIntegrationsSpeechTtsEnginesRequest request)
                                                       throws IOException,
ApiException

Get a list of TTS engines enabled for org

Parameters:

request - The request object

Returns:

TtsEngineEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsEngines

public ApiResponse<TtsEngineEntityListing> getIntegrationsSpeechTtsEngines(ApiRequest<Void> request)
                                                                    throws IOException

Get a list of TTS engines enabled for org

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsSettings

public TtsSettings getIntegrationsSpeechTtsSettings()
                                             throws IOException,
ApiException

Get TTS settings for an org

Returns:

TtsSettings

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsSettingsWithHttpInfo

public ApiResponse<TtsSettings> getIntegrationsSpeechTtsSettingsWithHttpInfo()
                                                                      throws IOException

Get TTS settings for an org

Returns:

TtsSettings

Throws:

IOException - if the request fails to be processed

getIntegrationsSpeechTtsSettings

public TtsSettings getIntegrationsSpeechTtsSettings(GetIntegrationsSpeechTtsSettingsRequest request)
                                             throws IOException,
ApiException

Get TTS settings for an org

Parameters:

request - The request object

Returns:

TtsSettings

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsSpeechTtsSettings

public ApiResponse<TtsSettings> getIntegrationsSpeechTtsSettings(ApiRequest<Void> request)
                                                          throws IOException

Get TTS settings for an org

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsType

public IntegrationType getIntegrationsType(String typeId)
                                    throws IOException,
ApiException

Get integration type.

Parameters:

typeId - Integration Type Id (required)

Returns:

IntegrationType

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsTypeWithHttpInfo

public ApiResponse<IntegrationType> getIntegrationsTypeWithHttpInfo(String typeId)
                                                             throws IOException

Get integration type.

Parameters:

typeId - Integration Type Id (required)

Returns:

IntegrationType

Throws:

IOException - if the request fails to be processed

getIntegrationsType

public IntegrationType getIntegrationsType(GetIntegrationsTypeRequest request)
                                    throws IOException,
ApiException

Get integration type.

Parameters:

request - The request object

Returns:

IntegrationType

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsType

public ApiResponse<IntegrationType> getIntegrationsType(ApiRequest<Void> request)
                                                 throws IOException

Get integration type.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsTypeConfigschema

public JsonSchemaDocument getIntegrationsTypeConfigschema(String typeId,
 String configType)
                                                   throws IOException,
ApiException

Get properties config schema for an integration type.

Parameters:

typeId - Integration Type Id (required)

configType - Config schema type (required)

Returns:

JsonSchemaDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsTypeConfigschemaWithHttpInfo

public ApiResponse<JsonSchemaDocument> getIntegrationsTypeConfigschemaWithHttpInfo(String typeId,
 String configType)
                                                                            throws IOException

Get properties config schema for an integration type.

Parameters:

typeId - Integration Type Id (required)

configType - Config schema type (required)

Returns:

JsonSchemaDocument

Throws:

IOException - if the request fails to be processed

getIntegrationsTypeConfigschema

public JsonSchemaDocument getIntegrationsTypeConfigschema(GetIntegrationsTypeConfigschemaRequest request)
                                                   throws IOException,
ApiException

Get properties config schema for an integration type.

Parameters:

request - The request object

Returns:

JsonSchemaDocument

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsTypeConfigschema

public ApiResponse<JsonSchemaDocument> getIntegrationsTypeConfigschema(ApiRequest<Void> request)
                                                                throws IOException

Get properties config schema for an integration type.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsTypes

public IntegrationTypeEntityListing getIntegrationsTypes(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                  throws IOException,
ApiException

List integration types

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

IntegrationTypeEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsTypesWithHttpInfo

public ApiResponse<IntegrationTypeEntityListing> getIntegrationsTypesWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                                           throws IOException

List integration types

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

IntegrationTypeEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsTypes

public IntegrationTypeEntityListing getIntegrationsTypes(GetIntegrationsTypesRequest request)
                                                  throws IOException,
ApiException

List integration types

Parameters:

request - The request object

Returns:

IntegrationTypeEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsTypes

public ApiResponse<IntegrationTypeEntityListing> getIntegrationsTypes(ApiRequest<Void> request)
                                                               throws IOException

List integration types

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientapp

public UnifiedCommunicationsIntegration getIntegrationsUnifiedcommunicationsClientapp(String ucIntegrationId)
                                                                               throws IOException,
ApiException

UC integration client application configuration. This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.

Parameters:

ucIntegrationId - 3rd Party Service Type (required)

Returns:

UnifiedCommunicationsIntegration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientappWithHttpInfo

public ApiResponse<UnifiedCommunicationsIntegration> getIntegrationsUnifiedcommunicationsClientappWithHttpInfo(String ucIntegrationId)
                                                                                                        throws IOException

UC integration client application configuration. This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.

Parameters:

ucIntegrationId - 3rd Party Service Type (required)

Returns:

UnifiedCommunicationsIntegration

Throws:

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientapp

public UnifiedCommunicationsIntegration getIntegrationsUnifiedcommunicationsClientapp(GetIntegrationsUnifiedcommunicationsClientappRequest request)
                                                                               throws IOException,
ApiException

UC integration client application configuration. This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.

Parameters:

request - The request object

Returns:

UnifiedCommunicationsIntegration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientapp

public ApiResponse<UnifiedCommunicationsIntegration> getIntegrationsUnifiedcommunicationsClientapp(ApiRequest<Void> request)
                                                                                            throws IOException

UC integration client application configuration. This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientapps

public UnifiedCommunicationsIntegrationListing getIntegrationsUnifiedcommunicationsClientapps(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                                                       throws IOException,
ApiException

List UC integration client application configurations. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

UnifiedCommunicationsIntegrationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientappsWithHttpInfo

public ApiResponse<UnifiedCommunicationsIntegrationListing> getIntegrationsUnifiedcommunicationsClientappsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage)
                                                                                                                throws IOException

List UC integration client application configurations. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

Returns:

UnifiedCommunicationsIntegrationListing

Throws:

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientapps

public UnifiedCommunicationsIntegrationListing getIntegrationsUnifiedcommunicationsClientapps(GetIntegrationsUnifiedcommunicationsClientappsRequest request)
                                                                                       throws IOException,
ApiException

List UC integration client application configurations. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.

Parameters:

request - The request object

Returns:

UnifiedCommunicationsIntegrationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsUnifiedcommunicationsClientapps

public ApiResponse<UnifiedCommunicationsIntegrationListing> getIntegrationsUnifiedcommunicationsClientapps(ApiRequest<Void> request)
                                                                                                    throws IOException

List UC integration client application configurations. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getIntegrationsUserapps

public UserAppEntityListing getIntegrationsUserapps(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 String appHost)
                                             throws IOException,
ApiException

List permitted user app integrations for the logged in user

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

appHost - The type of UserApp to filter by (optional)

Returns:

UserAppEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsUserappsWithHttpInfo

public ApiResponse<UserAppEntityListing> getIntegrationsUserappsWithHttpInfo(Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 String appHost)
                                                                      throws IOException

List permitted user app integrations for the logged in user

Parameters:

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

appHost - The type of UserApp to filter by (optional)

Returns:

UserAppEntityListing

Throws:

IOException - if the request fails to be processed

getIntegrationsUserapps

public UserAppEntityListing getIntegrationsUserapps(GetIntegrationsUserappsRequest request)
                                             throws IOException,
ApiException

List permitted user app integrations for the logged in user

Parameters:

request - The request object

Returns:

UserAppEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getIntegrationsUserapps

public ApiResponse<UserAppEntityListing> getIntegrationsUserapps(ApiRequest<Void> request)
                                                          throws IOException

List permitted user app integrations for the logged in user

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchIntegration

public Integration patchIntegration(String integrationId,
 Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 Integration body)
                             throws IOException,
ApiException

Update an integration.

Parameters:

integrationId - Integration Id (required)

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

body - Integration Update (optional)

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchIntegrationWithHttpInfo

public ApiResponse<Integration> patchIntegrationWithHttpInfo(String integrationId,
 Integer pageSize,
 Integer pageNumber,
 String sortBy,
 List<String> expand,
 String nextPage,
 String previousPage,
 Integration body)
                                                      throws IOException

Update an integration.

Parameters:

integrationId - Integration Id (required)

pageSize - The total page size requested (optional, default to 25)

pageNumber - The page number requested (optional, default to 1)

sortBy - variable name requested to sort by (optional)

expand - variable name requested by expand list (optional)

nextPage - next page token (optional)

previousPage - Previous page token (optional)

body - Integration Update (optional)

Returns:

Integration

Throws:

IOException - if the request fails to be processed

patchIntegration

public Integration patchIntegration(PatchIntegrationRequest request)
                             throws IOException,
ApiException

Update an integration.

Parameters:

request - The request object

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchIntegration

public ApiResponse<Integration> patchIntegration(ApiRequest<Integration> request)
                                          throws IOException

Update an integration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchIntegrationsAction

public Action patchIntegrationsAction(String actionId,
 UpdateActionInput body)
                               throws IOException,
ApiException

Patch an Action

Parameters:

actionId - actionId (required)

body - Input used to patch the Action. (required)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchIntegrationsActionWithHttpInfo

public ApiResponse<Action> patchIntegrationsActionWithHttpInfo(String actionId,
 UpdateActionInput body)
                                                        throws IOException

Patch an Action

Parameters:

actionId - actionId (required)

body - Input used to patch the Action. (required)

Returns:

Action

Throws:

IOException - if the request fails to be processed

patchIntegrationsAction

public Action patchIntegrationsAction(PatchIntegrationsActionRequest request)
                               throws IOException,
ApiException

Patch an Action

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchIntegrationsAction

public ApiResponse<Action> patchIntegrationsAction(ApiRequest<UpdateActionInput> request)
                                            throws IOException

Patch an Action

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchIntegrationsActionDraft

public Action patchIntegrationsActionDraft(String actionId,
 UpdateDraftInput body)
                                    throws IOException,
ApiException

Update an existing Draft

Parameters:

actionId - actionId (required)

body - Input used to patch the Action Draft. (required)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchIntegrationsActionDraftWithHttpInfo

public ApiResponse<Action> patchIntegrationsActionDraftWithHttpInfo(String actionId,
 UpdateDraftInput body)
                                                             throws IOException

Update an existing Draft

Parameters:

actionId - actionId (required)

body - Input used to patch the Action Draft. (required)

Returns:

Action

Throws:

IOException - if the request fails to be processed

patchIntegrationsActionDraft

public Action patchIntegrationsActionDraft(PatchIntegrationsActionDraftRequest request)
                                    throws IOException,
ApiException

Update an existing Draft

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchIntegrationsActionDraft

public ApiResponse<Action> patchIntegrationsActionDraft(ApiRequest<UpdateDraftInput> request)
                                                 throws IOException

Update an existing Draft

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrations

public Integration postIntegrations(CreateIntegrationRequest body)
                             throws IOException,
ApiException

Create an integration.

Parameters:

body - Integration (optional)

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsWithHttpInfo

public ApiResponse<Integration> postIntegrationsWithHttpInfo(CreateIntegrationRequest body)
                                                      throws IOException

Create an integration.

Parameters:

body - Integration (optional)

Returns:

Integration

Throws:

IOException - if the request fails to be processed

postIntegrations

public Integration postIntegrations(PostIntegrationsRequest request)
                             throws IOException,
ApiException

Create an integration.

Parameters:

request - The request object

Returns:

Integration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrations

public ApiResponse<Integration> postIntegrations(ApiRequest<CreateIntegrationRequest> request)
                                          throws IOException

Create an integration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraft

public Action postIntegrationsActionDraft(String actionId)
                                   throws IOException,
ApiException

Create a new Draft from existing Action

Parameters:

actionId - actionId (required)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraftWithHttpInfo

public ApiResponse<Action> postIntegrationsActionDraftWithHttpInfo(String actionId)
                                                            throws IOException

Create a new Draft from existing Action

Parameters:

actionId - actionId (required)

Returns:

Action

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraft

public Action postIntegrationsActionDraft(PostIntegrationsActionDraftRequest request)
                                   throws IOException,
ApiException

Create a new Draft from existing Action

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraft

public ApiResponse<Action> postIntegrationsActionDraft(ApiRequest<Void> request)
                                                throws IOException

Create a new Draft from existing Action

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraftFunctionUpload

public FunctionUploadResponse postIntegrationsActionDraftFunctionUpload(String actionId,
 FunctionUploadRequest body)
                                                                 throws IOException,
ApiException

Create upload presigned URL for draft function package file.

Parameters:

actionId - actionId (required)

body - Input used to request URL upload. (required)

Returns:

FunctionUploadResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraftFunctionUploadWithHttpInfo

public ApiResponse<FunctionUploadResponse> postIntegrationsActionDraftFunctionUploadWithHttpInfo(String actionId,
 FunctionUploadRequest body)
                                                                                          throws IOException

Create upload presigned URL for draft function package file.

Parameters:

actionId - actionId (required)

body - Input used to request URL upload. (required)

Returns:

FunctionUploadResponse

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraftFunctionUpload

public FunctionUploadResponse postIntegrationsActionDraftFunctionUpload(PostIntegrationsActionDraftFunctionUploadRequest request)
                                                                 throws IOException,
ApiException

Create upload presigned URL for draft function package file.

Parameters:

request - The request object

Returns:

FunctionUploadResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraftFunctionUpload

public ApiResponse<FunctionUploadResponse> postIntegrationsActionDraftFunctionUpload(ApiRequest<FunctionUploadRequest> request)
                                                                              throws IOException

Create upload presigned URL for draft function package file.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraftPublish

public Action postIntegrationsActionDraftPublish(String actionId,
 PublishDraftInput body)
                                          throws IOException,
ApiException

Publish a Draft and make it the active Action configuration

Parameters:

actionId - actionId (required)

body - Input used to patch the Action. (required)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraftPublishWithHttpInfo

public ApiResponse<Action> postIntegrationsActionDraftPublishWithHttpInfo(String actionId,
 PublishDraftInput body)
                                                                   throws IOException

Publish a Draft and make it the active Action configuration

Parameters:

actionId - actionId (required)

body - Input used to patch the Action. (required)

Returns:

Action

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraftPublish

public Action postIntegrationsActionDraftPublish(PostIntegrationsActionDraftPublishRequest request)
                                          throws IOException,
ApiException

Publish a Draft and make it the active Action configuration

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraftPublish

public ApiResponse<Action> postIntegrationsActionDraftPublish(ApiRequest<PublishDraftInput> request)
                                                       throws IOException

Publish a Draft and make it the active Action configuration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraftTest

public TestExecutionResult postIntegrationsActionDraftTest(String actionId,
 Object body,
 Boolean flatten)
                                                    throws IOException,
ApiException

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

actionId - actionId (required)

body - Map of parameters used for variable substitution. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

TestExecutionResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraftTestWithHttpInfo

public ApiResponse<TestExecutionResult> postIntegrationsActionDraftTestWithHttpInfo(String actionId,
 Object body,
 Boolean flatten)
                                                                             throws IOException

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

actionId - actionId (required)

body - Map of parameters used for variable substitution. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

TestExecutionResult

Throws:

IOException - if the request fails to be processed

postIntegrationsActionDraftTest

public TestExecutionResult postIntegrationsActionDraftTest(PostIntegrationsActionDraftTestRequest request)
                                                    throws IOException,
ApiException

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

request - The request object

Returns:

TestExecutionResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionDraftTest

public ApiResponse<TestExecutionResult> postIntegrationsActionDraftTest(ApiRequest<Object> request)
                                                                 throws IOException

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActionExecute

public Object postIntegrationsActionExecute(String actionId,
 Object body,
 Boolean flatten)
                                     throws IOException,
ApiException

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

Parameters:

actionId - actionId (required)

body - Map of parameters used for variable substitution. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

Object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionExecuteWithHttpInfo

public ApiResponse<Object> postIntegrationsActionExecuteWithHttpInfo(String actionId,
 Object body,
 Boolean flatten)
                                                              throws IOException

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

Parameters:

actionId - actionId (required)

body - Map of parameters used for variable substitution. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

Object

Throws:

IOException - if the request fails to be processed

postIntegrationsActionExecute

public Object postIntegrationsActionExecute(PostIntegrationsActionExecuteRequest request)
                                     throws IOException,
ApiException

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

Parameters:

request - The request object

Returns:

Object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionExecute

public ApiResponse<Object> postIntegrationsActionExecute(ApiRequest<Object> request)
                                                  throws IOException

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActionTest

public TestExecutionResult postIntegrationsActionTest(String actionId,
 Object body,
 Boolean flatten)
                                               throws IOException,
ApiException

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

actionId - actionId (required)

body - Map of parameters used for variable substitution. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

TestExecutionResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionTestWithHttpInfo

public ApiResponse<TestExecutionResult> postIntegrationsActionTestWithHttpInfo(String actionId,
 Object body,
 Boolean flatten)
                                                                        throws IOException

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

actionId - actionId (required)

body - Map of parameters used for variable substitution. (required)

flatten - Indicates the response should be reformatted, based on Architect's flattening format. (optional, default to false)

Returns:

TestExecutionResult

Throws:

IOException - if the request fails to be processed

postIntegrationsActionTest

public TestExecutionResult postIntegrationsActionTest(PostIntegrationsActionTestRequest request)
                                               throws IOException,
ApiException

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

request - The request object

Returns:

TestExecutionResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionTest

public ApiResponse<TestExecutionResult> postIntegrationsActionTest(ApiRequest<Object> request)
                                                            throws IOException

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActions

public Action postIntegrationsActions(PostActionInput body)
                               throws IOException,
ApiException

Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.

Parameters:

body - Input used to create Action. (required)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionsWithHttpInfo

public ApiResponse<Action> postIntegrationsActionsWithHttpInfo(PostActionInput body)
                                                        throws IOException

Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.

Parameters:

body - Input used to create Action. (required)

Returns:

Action

Throws:

IOException - if the request fails to be processed

postIntegrationsActions

public Action postIntegrationsActions(PostIntegrationsActionsRequest request)
                               throws IOException,
ApiException

Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActions

public ApiResponse<Action> postIntegrationsActions(ApiRequest<PostActionInput> request)
                                            throws IOException

Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsActionsDrafts

public Action postIntegrationsActionsDrafts(PostActionInput body)
                                     throws IOException,
ApiException

Create a new Draft

Parameters:

body - Input used to create Action Draft. (required)

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionsDraftsWithHttpInfo

public ApiResponse<Action> postIntegrationsActionsDraftsWithHttpInfo(PostActionInput body)
                                                              throws IOException

Create a new Draft

Parameters:

body - Input used to create Action Draft. (required)

Returns:

Action

Throws:

IOException - if the request fails to be processed

postIntegrationsActionsDrafts

public Action postIntegrationsActionsDrafts(PostIntegrationsActionsDraftsRequest request)
                                     throws IOException,
ApiException

Create a new Draft

Parameters:

request - The request object

Returns:

Action

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsActionsDrafts

public ApiResponse<Action> postIntegrationsActionsDrafts(ApiRequest<PostActionInput> request)
                                                  throws IOException

Create a new Draft

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsBotconnectorsIncomingMessages

public IncomingMessageResponse postIntegrationsBotconnectorsIncomingMessages(IncomingMessageRequest body)
                                                                      throws IOException,
ApiException

Send an incoming message to the bot. postIntegrationsBotconnectorsIncomingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

body - Incoming Message Request (required)

Returns:

IncomingMessageResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsBotconnectorsIncomingMessagesWithHttpInfo

public ApiResponse<IncomingMessageResponse> postIntegrationsBotconnectorsIncomingMessagesWithHttpInfo(IncomingMessageRequest body)
                                                                                               throws IOException

Send an incoming message to the bot. postIntegrationsBotconnectorsIncomingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

body - Incoming Message Request (required)

Returns:

IncomingMessageResponse

Throws:

IOException - if the request fails to be processed

postIntegrationsBotconnectorsIncomingMessages

public IncomingMessageResponse postIntegrationsBotconnectorsIncomingMessages(PostIntegrationsBotconnectorsIncomingMessagesRequest request)
                                                                      throws IOException,
ApiException

Send an incoming message to the bot. postIntegrationsBotconnectorsIncomingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

IncomingMessageResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsBotconnectorsIncomingMessages

public ApiResponse<IncomingMessageResponse> postIntegrationsBotconnectorsIncomingMessages(ApiRequest<IncomingMessageRequest> request)
                                                                                   throws IOException

Send an incoming message to the bot. postIntegrationsBotconnectorsIncomingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsBotconnectorsOutgoingMessages

public OutgoingMessageResponse postIntegrationsBotconnectorsOutgoingMessages(OutgoingMessageRequest body)
                                                                      throws IOException,
ApiException

Send an outgoing message to the end user. postIntegrationsBotconnectorsOutgoingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

body - Outgoing Message Request (required)

Returns:

OutgoingMessageResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsBotconnectorsOutgoingMessagesWithHttpInfo

public ApiResponse<OutgoingMessageResponse> postIntegrationsBotconnectorsOutgoingMessagesWithHttpInfo(OutgoingMessageRequest body)
                                                                                               throws IOException

Send an outgoing message to the end user. postIntegrationsBotconnectorsOutgoingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

body - Outgoing Message Request (required)

Returns:

OutgoingMessageResponse

Throws:

IOException - if the request fails to be processed

postIntegrationsBotconnectorsOutgoingMessages

public OutgoingMessageResponse postIntegrationsBotconnectorsOutgoingMessages(PostIntegrationsBotconnectorsOutgoingMessagesRequest request)
                                                                      throws IOException,
ApiException

Send an outgoing message to the end user. postIntegrationsBotconnectorsOutgoingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

OutgoingMessageResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsBotconnectorsOutgoingMessages

public ApiResponse<OutgoingMessageResponse> postIntegrationsBotconnectorsOutgoingMessages(ApiRequest<OutgoingMessageRequest> request)
                                                                                   throws IOException

Send an outgoing message to the end user. postIntegrationsBotconnectorsOutgoingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsCredentials

public CredentialInfo postIntegrationsCredentials(Credential body)
                                           throws IOException,
ApiException

Create a set of credentials

Parameters:

body - Credential (optional)

Returns:

CredentialInfo

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsCredentialsWithHttpInfo

public ApiResponse<CredentialInfo> postIntegrationsCredentialsWithHttpInfo(Credential body)
                                                                    throws IOException

Create a set of credentials

Parameters:

body - Credential (optional)

Returns:

CredentialInfo

Throws:

IOException - if the request fails to be processed

postIntegrationsCredentials

public CredentialInfo postIntegrationsCredentials(PostIntegrationsCredentialsRequest request)
                                           throws IOException,
ApiException

Create a set of credentials

Parameters:

request - The request object

Returns:

CredentialInfo

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsCredentials

public ApiResponse<CredentialInfo> postIntegrationsCredentials(ApiRequest<Credential> request)
                                                        throws IOException

Create a set of credentials

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs

public AsyncJob postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(String nuanceIntegrationId,
 String botId,
 List<String> expand,
 String body)
                                                                throws IOException,
ApiException

Get a Nuance bot in the specified Integration asynchronously

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID (required)

expand - expand (optional)

body - targetChannel (optional)

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobsWithHttpInfo

public ApiResponse<AsyncJob> postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobsWithHttpInfo(String nuanceIntegrationId,
 String botId,
 List<String> expand,
 String body)
                                                                                         throws IOException

Get a Nuance bot in the specified Integration asynchronously

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

botId - The Nuance bot ID (required)

expand - expand (optional)

body - targetChannel (optional)

Returns:

AsyncJob

Throws:

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs

public AsyncJob postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(PostIntegrationsSpeechNuanceNuanceIntegrationIdBotJobsRequest request)
                                                                throws IOException,
ApiException

Get a Nuance bot in the specified Integration asynchronously

Parameters:

request - The request object

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs

public ApiResponse<AsyncJob> postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(ApiRequest<String> request)
                                                                             throws IOException

Get a Nuance bot in the specified Integration asynchronously

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs

public AsyncJob postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(String nuanceIntegrationId,
 Integer pageNumber,
 Integer pageSize,
 Boolean onlyRegisteredBots)
                                                                 throws IOException,
ApiException

Get a list of Nuance bots in the specified Integration asynchronously

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

onlyRegisteredBots - Limit bots to the ones configured for Genesys Cloud usage (optional, default to true)

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobsWithHttpInfo

public ApiResponse<AsyncJob> postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobsWithHttpInfo(String nuanceIntegrationId,
 Integer pageNumber,
 Integer pageSize,
 Boolean onlyRegisteredBots)
                                                                                          throws IOException

Get a list of Nuance bots in the specified Integration asynchronously

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

onlyRegisteredBots - Limit bots to the ones configured for Genesys Cloud usage (optional, default to true)

Returns:

AsyncJob

Throws:

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs

public AsyncJob postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(PostIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobsRequest request)
                                                                 throws IOException,
ApiException

Get a list of Nuance bots in the specified Integration asynchronously

Parameters:

request - The request object

Returns:

AsyncJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs

public ApiResponse<AsyncJob> postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(ApiRequest<Void> request)
                                                                              throws IOException

Get a list of Nuance bots in the specified Integration asynchronously

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate

public void postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(String nuanceIntegrationId,
 BotExecutionConfiguration settings)
                                                                       throws IOException,
ApiException

Try out a single credential for a Nuance bot to know if the secret is correct

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

settings - (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidateWithHttpInfo

public ApiResponse<Void> postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidateWithHttpInfo(String nuanceIntegrationId,
 BotExecutionConfiguration settings)
                                                                                                throws IOException

Try out a single credential for a Nuance bot to know if the secret is correct

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

settings - (required)

Throws:

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate

public void postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(PostIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidateRequest request)
                                                                       throws IOException,
ApiException

Try out a single credential for a Nuance bot to know if the secret is correct

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate

public ApiResponse<Void> postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(ApiRequest<BotExecutionConfiguration> request)
                                                                                    throws IOException

Try out a single credential for a Nuance bot to know if the secret is correct

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postIntegrationsWebhookEvents

public WebhookInvocationResponse postIntegrationsWebhookEvents(String tokenId,
 Object body)
                                                        throws IOException,
ApiException

Invoke Webhook

Parameters:

tokenId - The token of the webhook to be invoked (required)

body - Webhook Invocation Payload (required)

Returns:

WebhookInvocationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsWebhookEventsWithHttpInfo

public ApiResponse<WebhookInvocationResponse> postIntegrationsWebhookEventsWithHttpInfo(String tokenId,
 Object body)
                                                                                 throws IOException

Invoke Webhook

Parameters:

tokenId - The token of the webhook to be invoked (required)

body - Webhook Invocation Payload (required)

Returns:

WebhookInvocationResponse

Throws:

IOException - if the request fails to be processed

postIntegrationsWebhookEvents

public WebhookInvocationResponse postIntegrationsWebhookEvents(PostIntegrationsWebhookEventsRequest request)
                                                        throws IOException,
ApiException

Invoke Webhook

Parameters:

request - The request object

Returns:

WebhookInvocationResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postIntegrationsWebhookEvents

public ApiResponse<WebhookInvocationResponse> postIntegrationsWebhookEvents(ApiRequest<Object> request)
                                                                     throws IOException

Invoke Webhook

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putIntegrationConfigCurrent

public IntegrationConfiguration putIntegrationConfigCurrent(String integrationId,
 IntegrationConfiguration body)
                                                     throws IOException,
ApiException

Update integration configuration.

Parameters:

integrationId - Integration Id (required)

body - Integration Configuration (optional)

Returns:

IntegrationConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationConfigCurrentWithHttpInfo

public ApiResponse<IntegrationConfiguration> putIntegrationConfigCurrentWithHttpInfo(String integrationId,
 IntegrationConfiguration body)
                                                                              throws IOException

Update integration configuration.

Parameters:

integrationId - Integration Id (required)

body - Integration Configuration (optional)

Returns:

IntegrationConfiguration

Throws:

IOException - if the request fails to be processed

putIntegrationConfigCurrent

public IntegrationConfiguration putIntegrationConfigCurrent(PutIntegrationConfigCurrentRequest request)
                                                     throws IOException,
ApiException

Update integration configuration.

Parameters:

request - The request object

Returns:

IntegrationConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationConfigCurrent

public ApiResponse<IntegrationConfiguration> putIntegrationConfigCurrent(ApiRequest<IntegrationConfiguration> request)
                                                                  throws IOException

Update integration configuration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putIntegrationsActionDraftFunction

public FunctionConfig putIntegrationsActionDraftFunction(String actionId,
 Function body)
                                                  throws IOException,
ApiException

Update draft function settings.

Parameters:

actionId - actionId (required)

body - Input used to update function settings. (required)

Returns:

FunctionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsActionDraftFunctionWithHttpInfo

public ApiResponse<FunctionConfig> putIntegrationsActionDraftFunctionWithHttpInfo(String actionId,
 Function body)
                                                                           throws IOException

Update draft function settings.

Parameters:

actionId - actionId (required)

body - Input used to update function settings. (required)

Returns:

FunctionConfig

Throws:

IOException - if the request fails to be processed

putIntegrationsActionDraftFunction

public FunctionConfig putIntegrationsActionDraftFunction(PutIntegrationsActionDraftFunctionRequest request)
                                                  throws IOException,
ApiException

Update draft function settings.

Parameters:

request - The request object

Returns:

FunctionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsActionDraftFunction

public ApiResponse<FunctionConfig> putIntegrationsActionDraftFunction(ApiRequest<Function> request)
                                                               throws IOException

Update draft function settings.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putIntegrationsBotconnectorIntegrationIdBots

public void putIntegrationsBotconnectorIntegrationIdBots(String integrationId,
 BotList botList)
                                                  throws IOException,
ApiException

Set a list of botConnector bots plus versions for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

botList - (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsBotconnectorIntegrationIdBotsWithHttpInfo

public ApiResponse<Void> putIntegrationsBotconnectorIntegrationIdBotsWithHttpInfo(String integrationId,
 BotList botList)
                                                                           throws IOException

Set a list of botConnector bots plus versions for this integration

Parameters:

integrationId - The integration ID for this group of bots (required)

botList - (required)

Throws:

IOException - if the request fails to be processed

putIntegrationsBotconnectorIntegrationIdBots

public void putIntegrationsBotconnectorIntegrationIdBots(PutIntegrationsBotconnectorIntegrationIdBotsRequest request)
                                                  throws IOException,
ApiException

Set a list of botConnector bots plus versions for this integration

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsBotconnectorIntegrationIdBots

public ApiResponse<Void> putIntegrationsBotconnectorIntegrationIdBots(ApiRequest<BotList> request)
                                                               throws IOException

Set a list of botConnector bots plus versions for this integration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putIntegrationsCredential

public CredentialInfo putIntegrationsCredential(String credentialId,
 Credential body)
                                         throws IOException,
ApiException

Update a set of credentials

Parameters:

credentialId - Credential ID (required)

body - Credential (optional)

Returns:

CredentialInfo

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsCredentialWithHttpInfo

public ApiResponse<CredentialInfo> putIntegrationsCredentialWithHttpInfo(String credentialId,
 Credential body)
                                                                  throws IOException

Update a set of credentials

Parameters:

credentialId - Credential ID (required)

body - Credential (optional)

Returns:

CredentialInfo

Throws:

IOException - if the request fails to be processed

putIntegrationsCredential

public CredentialInfo putIntegrationsCredential(PutIntegrationsCredentialRequest request)
                                         throws IOException,
ApiException

Update a set of credentials

Parameters:

request - The request object

Returns:

CredentialInfo

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsCredential

public ApiResponse<CredentialInfo> putIntegrationsCredential(ApiRequest<Credential> request)
                                                      throws IOException

Update a set of credentials

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings

public void putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(String nuanceIntegrationId,
 NuanceBotLaunchSettings settings)
                                                                      throws IOException,
ApiException

Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

settings - (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettingsWithHttpInfo

public ApiResponse<Void> putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettingsWithHttpInfo(String nuanceIntegrationId,
 NuanceBotLaunchSettings settings)
                                                                                               throws IOException

Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration

Parameters:

nuanceIntegrationId - The integration ID for this group of bots (required)

settings - (required)

Throws:

IOException - if the request fails to be processed

putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings

public void putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(PutIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettingsRequest request)
                                                                      throws IOException,
ApiException

Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings

public ApiResponse<Void> putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(ApiRequest<NuanceBotLaunchSettings> request)
                                                                                   throws IOException

Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putIntegrationsSpeechTtsSettings

public TtsSettings putIntegrationsSpeechTtsSettings(TtsSettings body)
                                             throws IOException,
ApiException

Update TTS settings for an org

Parameters:

body - Updated TtsSettings (required)

Returns:

TtsSettings

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsSpeechTtsSettingsWithHttpInfo

public ApiResponse<TtsSettings> putIntegrationsSpeechTtsSettingsWithHttpInfo(TtsSettings body)
                                                                      throws IOException

Update TTS settings for an org

Parameters:

body - Updated TtsSettings (required)

Returns:

TtsSettings

Throws:

IOException - if the request fails to be processed

putIntegrationsSpeechTtsSettings

public TtsSettings putIntegrationsSpeechTtsSettings(PutIntegrationsSpeechTtsSettingsRequest request)
                                             throws IOException,
ApiException

Update TTS settings for an org

Parameters:

request - The request object

Returns:

TtsSettings

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsSpeechTtsSettings

public ApiResponse<TtsSettings> putIntegrationsSpeechTtsSettings(ApiRequest<TtsSettings> request)
                                                          throws IOException

Update TTS settings for an org

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putIntegrationsUnifiedcommunicationThirdpartypresences

public String putIntegrationsUnifiedcommunicationThirdpartypresences(String ucIntegrationId,
 List<UCThirdPartyPresence> body)
                                                              throws IOException,
ApiException

Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.

Parameters:

ucIntegrationId - UC Integration ID (required)

body - List of User presences (required)

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsUnifiedcommunicationThirdpartypresencesWithHttpInfo

public ApiResponse<String> putIntegrationsUnifiedcommunicationThirdpartypresencesWithHttpInfo(String ucIntegrationId,
 List<UCThirdPartyPresence> body)
                                                                                       throws IOException

Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.

Parameters:

ucIntegrationId - UC Integration ID (required)

body - List of User presences (required)

Returns:

String

Throws:

IOException - if the request fails to be processed

putIntegrationsUnifiedcommunicationThirdpartypresences

public String putIntegrationsUnifiedcommunicationThirdpartypresences(PutIntegrationsUnifiedcommunicationThirdpartypresencesRequest request)
                                                              throws IOException,
ApiException

Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.

Parameters:

request - The request object

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putIntegrationsUnifiedcommunicationThirdpartypresences

public ApiResponse<String> putIntegrationsUnifiedcommunicationThirdpartypresences(ApiRequest<List<UCThirdPartyPresence>> request)
                                                                           throws IOException

Bulk integration presence ingestion This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed