Package com.mypurecloud.sdk.v2.api

Class ArchitectApi

java.lang.Object

com.mypurecloud.sdk.v2.api.ArchitectApi

public class ArchitectApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ArchitectApi()
ArchitectApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteArchitectEmergencygroup(DeleteArchitectEmergencygroupRequest request)	Deletes a emergency group by ID
ApiResponse<Void>	deleteArchitectEmergencygroup(ApiRequest<Void> request)	Deletes a emergency group by ID
void	deleteArchitectEmergencygroup(String emergencyGroupId)	Deletes a emergency group by ID
ApiResponse<Void>	deleteArchitectEmergencygroupWithHttpInfo(String emergencyGroupId)	Deletes a emergency group by ID
Empty	deleteArchitectGrammar(DeleteArchitectGrammarRequest request)	Delete a grammar.
ApiResponse<Empty>	deleteArchitectGrammar(ApiRequest<Void> request)	Delete a grammar.
Empty	deleteArchitectGrammar(String grammarId)	Delete a grammar.
void	deleteArchitectGrammarLanguage(DeleteArchitectGrammarLanguageRequest request)	Delete specified grammar language
ApiResponse<Void>	deleteArchitectGrammarLanguage(ApiRequest<Void> request)	Delete specified grammar language
void	deleteArchitectGrammarLanguage(String grammarId, String languageCode)	Delete specified grammar language
void	deleteArchitectGrammarLanguageFilesDtmf(DeleteArchitectGrammarLanguageFilesDtmfRequest request)	Clear the DTMF mode file for the grammar language if there is one
ApiResponse<Void>	deleteArchitectGrammarLanguageFilesDtmf(ApiRequest<Void> request)	Clear the DTMF mode file for the grammar language if there is one
void	deleteArchitectGrammarLanguageFilesDtmf(String grammarId, String languageCode)	Clear the DTMF mode file for the grammar language if there is one
ApiResponse<Void>	deleteArchitectGrammarLanguageFilesDtmfWithHttpInfo(String grammarId, String languageCode)	Clear the DTMF mode file for the grammar language if there is one
void	deleteArchitectGrammarLanguageFilesVoice(DeleteArchitectGrammarLanguageFilesVoiceRequest request)	Clear the voice mode file for the grammar language if there is one
ApiResponse<Void>	deleteArchitectGrammarLanguageFilesVoice(ApiRequest<Void> request)	Clear the voice mode file for the grammar language if there is one
void	deleteArchitectGrammarLanguageFilesVoice(String grammarId, String languageCode)	Clear the voice mode file for the grammar language if there is one
ApiResponse<Void>	deleteArchitectGrammarLanguageFilesVoiceWithHttpInfo(String grammarId, String languageCode)	Clear the voice mode file for the grammar language if there is one
ApiResponse<Void>	deleteArchitectGrammarLanguageWithHttpInfo(String grammarId, String languageCode)	Delete specified grammar language
ApiResponse<Empty>	deleteArchitectGrammarWithHttpInfo(String grammarId)	Delete a grammar.
void	deleteArchitectIvr(DeleteArchitectIvrRequest request)	Delete an IVR Config.
ApiResponse<Void>	deleteArchitectIvr(ApiRequest<Void> request)	Delete an IVR Config.
void	deleteArchitectIvr(String ivrId)	Delete an IVR Config.
ApiResponse<Void>	deleteArchitectIvrWithHttpInfo(String ivrId)	Delete an IVR Config.
void	deleteArchitectPrompt(DeleteArchitectPromptRequest request)	Delete specified user prompt
ApiResponse<Void>	deleteArchitectPrompt(ApiRequest<Void> request)	Delete specified user prompt
void	deleteArchitectPrompt(String promptId, Boolean allResources)	Delete specified user prompt
void	deleteArchitectPromptResource(DeleteArchitectPromptResourceRequest request)	Delete specified user prompt resource
ApiResponse<Void>	deleteArchitectPromptResource(ApiRequest<Void> request)	Delete specified user prompt resource
void	deleteArchitectPromptResource(String promptId, String languageCode)	Delete specified user prompt resource
void	deleteArchitectPromptResourceAudio(DeleteArchitectPromptResourceAudioRequest request)	Delete specified user prompt resource audio
ApiResponse<Void>	deleteArchitectPromptResourceAudio(ApiRequest<Void> request)	Delete specified user prompt resource audio
void	deleteArchitectPromptResourceAudio(String promptId, String languageCode)	Delete specified user prompt resource audio
ApiResponse<Void>	deleteArchitectPromptResourceAudioWithHttpInfo(String promptId, String languageCode)	Delete specified user prompt resource audio
ApiResponse<Void>	deleteArchitectPromptResourceWithHttpInfo(String promptId, String languageCode)	Delete specified user prompt resource
Operation	deleteArchitectPrompts(DeleteArchitectPromptsRequest request)	Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted.
ApiResponse<Operation>	deleteArchitectPrompts(ApiRequest<Void> request)	Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted.
Operation	deleteArchitectPrompts(List<String> id)	Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted.
ApiResponse<Operation>	deleteArchitectPromptsWithHttpInfo(List<String> id)	Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted.
ApiResponse<Void>	deleteArchitectPromptWithHttpInfo(String promptId, Boolean allResources)	Delete specified user prompt
void	deleteArchitectSchedule(DeleteArchitectScheduleRequest request)	Delete a schedule by id
ApiResponse<Void>	deleteArchitectSchedule(ApiRequest<Void> request)	Delete a schedule by id
void	deleteArchitectSchedule(String scheduleId)	Delete a schedule by id
void	deleteArchitectSchedulegroup(DeleteArchitectSchedulegroupRequest request)	Deletes a schedule group by ID
ApiResponse<Void>	deleteArchitectSchedulegroup(ApiRequest<Void> request)	Deletes a schedule group by ID
void	deleteArchitectSchedulegroup(String scheduleGroupId)	Deletes a schedule group by ID
ApiResponse<Void>	deleteArchitectSchedulegroupWithHttpInfo(String scheduleGroupId)	Deletes a schedule group by ID
ApiResponse<Void>	deleteArchitectScheduleWithHttpInfo(String scheduleId)	Delete a schedule by id
void	deleteArchitectSystempromptResource(DeleteArchitectSystempromptResourceRequest request)	Delete a system prompt resource override.
ApiResponse<Void>	deleteArchitectSystempromptResource(ApiRequest<Void> request)	Delete a system prompt resource override.
void	deleteArchitectSystempromptResource(String promptId, String languageCode)	Delete a system prompt resource override.
ApiResponse<Void>	deleteArchitectSystempromptResourceWithHttpInfo(String promptId, String languageCode)	Delete a system prompt resource override.
void	deleteFlow(DeleteFlowRequest request)	Delete flow
ApiResponse<Void>	deleteFlow(ApiRequest<Void> request)	Delete flow
void	deleteFlow(String flowId)	Delete flow
void	deleteFlowInstancesSettingsLoglevels(DeleteFlowInstancesSettingsLoglevelsRequest request)	Deletes a log level for a flow by flow id.
ApiResponse<Void>	deleteFlowInstancesSettingsLoglevels(ApiRequest<Void> request)	Deletes a log level for a flow by flow id.
void	deleteFlowInstancesSettingsLoglevels(String flowId)	Deletes a log level for a flow by flow id.
ApiResponse<Void>	deleteFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId)	Deletes a log level for a flow by flow id.
Operation	deleteFlows(DeleteFlowsRequest request)	Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted.
ApiResponse<Operation>	deleteFlows(ApiRequest<Void> request)	Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted.
Operation	deleteFlows(List<String> id)	Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted.
void	deleteFlowsDatatable(DeleteFlowsDatatableRequest request)	deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId
ApiResponse<Void>	deleteFlowsDatatable(ApiRequest<Void> request)	deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId
void	deleteFlowsDatatable(String datatableId, Boolean force)	deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId
void	deleteFlowsDatatableRow(DeleteFlowsDatatableRowRequest request)	Delete a row entry Deletes a row with a given rowId (the value of the key field).
ApiResponse<Void>	deleteFlowsDatatableRow(ApiRequest<Void> request)	Delete a row entry Deletes a row with a given rowId (the value of the key field).
void	deleteFlowsDatatableRow(String datatableId, String rowId)	Delete a row entry Deletes a row with a given rowId (the value of the key field).
ApiResponse<Void>	deleteFlowsDatatableRowWithHttpInfo(String datatableId, String rowId)	Delete a row entry Deletes a row with a given rowId (the value of the key field).
ApiResponse<Void>	deleteFlowsDatatableWithHttpInfo(String datatableId, Boolean force)	deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId
void	deleteFlowsInstancesSettingsLoglevelsDefault()	Resets the org log level to default, base Resets the org log level to default, base
void	deleteFlowsInstancesSettingsLoglevelsDefault(DeleteFlowsInstancesSettingsLoglevelsDefaultRequest request)	Resets the org log level to default, base Resets the org log level to default, base
ApiResponse<Void>	deleteFlowsInstancesSettingsLoglevelsDefault(ApiRequest<Void> request)	Resets the org log level to default, base Resets the org log level to default, base
ApiResponse<Void>	deleteFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo()	Resets the org log level to default, base Resets the org log level to default, base
Empty	deleteFlowsMilestone(DeleteFlowsMilestoneRequest request)	Delete a flow milestone.
ApiResponse<Empty>	deleteFlowsMilestone(ApiRequest<Void> request)	Delete a flow milestone.
Empty	deleteFlowsMilestone(String milestoneId)	Delete a flow milestone.
ApiResponse<Empty>	deleteFlowsMilestoneWithHttpInfo(String milestoneId)	Delete a flow milestone.
ApiResponse<Operation>	deleteFlowsWithHttpInfo(List<String> id)	Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted.
ApiResponse<Void>	deleteFlowWithHttpInfo(String flowId)	Delete flow
DependencyObjectEntityListing	getArchitectDependencytracking(GetArchitectDependencytrackingRequest request)	Get Dependency Tracking objects that have a given display name
ApiResponse<DependencyObjectEntityListing>	getArchitectDependencytracking(ApiRequest<Void> request)	Get Dependency Tracking objects that have a given display name
DependencyObjectEntityListing	getArchitectDependencytracking(String name, Integer pageNumber, Integer pageSize, List<String> objectType, Boolean consumedResources, Boolean consumingResources, List<String> consumedResourceType, List<String> consumingResourceType)	Get Dependency Tracking objects that have a given display name
DependencyStatus	getArchitectDependencytrackingBuild()	Get Dependency Tracking build status for an organization
DependencyStatus	getArchitectDependencytrackingBuild(GetArchitectDependencytrackingBuildRequest request)	Get Dependency Tracking build status for an organization
ApiResponse<DependencyStatus>	getArchitectDependencytrackingBuild(ApiRequest<Void> request)	Get Dependency Tracking build status for an organization
ApiResponse<DependencyStatus>	getArchitectDependencytrackingBuildWithHttpInfo()	Get Dependency Tracking build status for an organization
ConsumedResourcesEntityListing	getArchitectDependencytrackingConsumedresources(GetArchitectDependencytrackingConsumedresourcesRequest request)	Get resources that are consumed by a given Dependency Tracking object
ApiResponse<ConsumedResourcesEntityListing>	getArchitectDependencytrackingConsumedresources(ApiRequest<Void> request)	Get resources that are consumed by a given Dependency Tracking object
ConsumedResourcesEntityListing	getArchitectDependencytrackingConsumedresources(String id, String version, String objectType, List<String> resourceType, Integer pageNumber, Integer pageSize)	Get resources that are consumed by a given Dependency Tracking object
ApiResponse<ConsumedResourcesEntityListing>	getArchitectDependencytrackingConsumedresourcesWithHttpInfo(String id, String version, String objectType, List<String> resourceType, Integer pageNumber, Integer pageSize)	Get resources that are consumed by a given Dependency Tracking object
ConsumingResourcesEntityListing	getArchitectDependencytrackingConsumingresources(GetArchitectDependencytrackingConsumingresourcesRequest request)	Get resources that consume a given Dependency Tracking object
ApiResponse<ConsumingResourcesEntityListing>	getArchitectDependencytrackingConsumingresources(ApiRequest<Void> request)	Get resources that consume a given Dependency Tracking object
ConsumingResourcesEntityListing	getArchitectDependencytrackingConsumingresources(String id, String objectType, List<String> resourceType, String version, Integer pageNumber, Integer pageSize, String flowFilter)	Get resources that consume a given Dependency Tracking object
ApiResponse<ConsumingResourcesEntityListing>	getArchitectDependencytrackingConsumingresourcesWithHttpInfo(String id, String objectType, List<String> resourceType, String version, Integer pageNumber, Integer pageSize, String flowFilter)	Get resources that consume a given Dependency Tracking object
DependencyObjectEntityListing	getArchitectDependencytrackingDeletedresourceconsumers(GetArchitectDependencytrackingDeletedresourceconsumersRequest request)	Get Dependency Tracking objects that consume deleted resources
ApiResponse<DependencyObjectEntityListing>	getArchitectDependencytrackingDeletedresourceconsumers(ApiRequest<Void> request)	Get Dependency Tracking objects that consume deleted resources
DependencyObjectEntityListing	getArchitectDependencytrackingDeletedresourceconsumers(String name, List<String> objectType, String flowFilter, Boolean consumedResources, List<String> consumedResourceType, Integer pageNumber, Integer pageSize)	Get Dependency Tracking objects that consume deleted resources
ApiResponse<DependencyObjectEntityListing>	getArchitectDependencytrackingDeletedresourceconsumersWithHttpInfo(String name, List<String> objectType, String flowFilter, Boolean consumedResources, List<String> consumedResourceType, Integer pageNumber, Integer pageSize)	Get Dependency Tracking objects that consume deleted resources
DependencyObject	getArchitectDependencytrackingObject(GetArchitectDependencytrackingObjectRequest request)	Get a Dependency Tracking object
ApiResponse<DependencyObject>	getArchitectDependencytrackingObject(ApiRequest<Void> request)	Get a Dependency Tracking object
DependencyObject	getArchitectDependencytrackingObject(String id, String version, String objectType, Boolean consumedResources, Boolean consumingResources, List<String> consumedResourceType, List<String> consumingResourceType, Boolean consumedResourceRequest)	Get a Dependency Tracking object
ApiResponse<DependencyObject>	getArchitectDependencytrackingObjectWithHttpInfo(String id, String version, String objectType, Boolean consumedResources, Boolean consumingResources, List<String> consumedResourceType, List<String> consumingResourceType, Boolean consumedResourceRequest)	Get a Dependency Tracking object
DependencyType	getArchitectDependencytrackingType(GetArchitectDependencytrackingTypeRequest request)	Get a Dependency Tracking type.
ApiResponse<DependencyType>	getArchitectDependencytrackingType(ApiRequest<Void> request)	Get a Dependency Tracking type.
DependencyType	getArchitectDependencytrackingType(String typeId)	Get a Dependency Tracking type.
DependencyTypeEntityListing	getArchitectDependencytrackingTypes(GetArchitectDependencytrackingTypesRequest request)	Get Dependency Tracking types.
ApiResponse<DependencyTypeEntityListing>	getArchitectDependencytrackingTypes(ApiRequest<Void> request)	Get Dependency Tracking types.
DependencyTypeEntityListing	getArchitectDependencytrackingTypes(Integer pageNumber, Integer pageSize)	Get Dependency Tracking types.
ApiResponse<DependencyTypeEntityListing>	getArchitectDependencytrackingTypesWithHttpInfo(Integer pageNumber, Integer pageSize)	Get Dependency Tracking types.
ApiResponse<DependencyType>	getArchitectDependencytrackingTypeWithHttpInfo(String typeId)	Get a Dependency Tracking type.
DependencyObjectEntityListing	getArchitectDependencytrackingUpdatedresourceconsumers(GetArchitectDependencytrackingUpdatedresourceconsumersRequest request)	Get Dependency Tracking objects that depend on updated resources
ApiResponse<DependencyObjectEntityListing>	getArchitectDependencytrackingUpdatedresourceconsumers(ApiRequest<Void> request)	Get Dependency Tracking objects that depend on updated resources
DependencyObjectEntityListing	getArchitectDependencytrackingUpdatedresourceconsumers(String name, List<String> objectType, Boolean consumedResources, List<String> consumedResourceType, Integer pageNumber, Integer pageSize)	Get Dependency Tracking objects that depend on updated resources
ApiResponse<DependencyObjectEntityListing>	getArchitectDependencytrackingUpdatedresourceconsumersWithHttpInfo(String name, List<String> objectType, Boolean consumedResources, List<String> consumedResourceType, Integer pageNumber, Integer pageSize)	Get Dependency Tracking objects that depend on updated resources
ApiResponse<DependencyObjectEntityListing>	getArchitectDependencytrackingWithHttpInfo(String name, Integer pageNumber, Integer pageSize, List<String> objectType, Boolean consumedResources, Boolean consumingResources, List<String> consumedResourceType, List<String> consumingResourceType)	Get Dependency Tracking objects that have a given display name
EmergencyGroup	getArchitectEmergencygroup(GetArchitectEmergencygroupRequest request)	Gets a emergency group by ID
ApiResponse<EmergencyGroup>	getArchitectEmergencygroup(ApiRequest<Void> request)	Gets a emergency group by ID
EmergencyGroup	getArchitectEmergencygroup(String emergencyGroupId)	Gets a emergency group by ID
EmergencyGroupListing	getArchitectEmergencygroups(GetArchitectEmergencygroupsRequest request)	Get a list of emergency groups.
ApiResponse<EmergencyGroupListing>	getArchitectEmergencygroups(ApiRequest<Void> request)	Get a list of emergency groups.
EmergencyGroupListing	getArchitectEmergencygroups(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name)	Get a list of emergency groups.
EmergencyGroupDivisionViewEntityListing	getArchitectEmergencygroupsDivisionviews(GetArchitectEmergencygroupsDivisionviewsRequest request)	Get a pageable list of basic emergency group objects filterable by query parameters.
ApiResponse<EmergencyGroupDivisionViewEntityListing>	getArchitectEmergencygroupsDivisionviews(ApiRequest<Void> request)	Get a pageable list of basic emergency group objects filterable by query parameters.
EmergencyGroupDivisionViewEntityListing	getArchitectEmergencygroupsDivisionviews(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic emergency group objects filterable by query parameters.
ApiResponse<EmergencyGroupDivisionViewEntityListing>	getArchitectEmergencygroupsDivisionviewsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic emergency group objects filterable by query parameters.
ApiResponse<EmergencyGroupListing>	getArchitectEmergencygroupsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name)	Get a list of emergency groups.
ApiResponse<EmergencyGroup>	getArchitectEmergencygroupWithHttpInfo(String emergencyGroupId)	Gets a emergency group by ID
Grammar	getArchitectGrammar(GetArchitectGrammarRequest request)	Get a grammar Returns a specified grammar
ApiResponse<Grammar>	getArchitectGrammar(ApiRequest<Void> request)	Get a grammar Returns a specified grammar
Grammar	getArchitectGrammar(String grammarId, Boolean includeFileUrls)	Get a grammar Returns a specified grammar
GrammarLanguage	getArchitectGrammarLanguage(GetArchitectGrammarLanguageRequest request)	Get a grammar language.
ApiResponse<GrammarLanguage>	getArchitectGrammarLanguage(ApiRequest<Void> request)	Get a grammar language.
GrammarLanguage	getArchitectGrammarLanguage(String grammarId, String languageCode)	Get a grammar language.
ApiResponse<GrammarLanguage>	getArchitectGrammarLanguageWithHttpInfo(String grammarId, String languageCode)	Get a grammar language.
GrammarListing	getArchitectGrammars(GetArchitectGrammarsRequest request)	Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
ApiResponse<GrammarListing>	getArchitectGrammars(ApiRequest<Void> request)	Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
GrammarListing	getArchitectGrammars(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, Boolean includeFileUrls)	Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
ApiResponse<GrammarListing>	getArchitectGrammarsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, Boolean includeFileUrls)	Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
ApiResponse<Grammar>	getArchitectGrammarWithHttpInfo(String grammarId, Boolean includeFileUrls)	Get a grammar Returns a specified grammar
IVR	getArchitectIvr(GetArchitectIvrRequest request)	Get an IVR config.
ApiResponse<IVR>	getArchitectIvr(ApiRequest<Void> request)	Get an IVR config.
IVR	getArchitectIvr(String ivrId)	Get an IVR config.
IVRIdentityResolutionConfig	getArchitectIvrIdentityresolution(GetArchitectIvrIdentityresolutionRequest request)	Get an IVR IdentityResolutionConfig.
ApiResponse<IVRIdentityResolutionConfig>	getArchitectIvrIdentityresolution(ApiRequest<Void> request)	Get an IVR IdentityResolutionConfig.
IVRIdentityResolutionConfig	getArchitectIvrIdentityresolution(String ivrId)	Get an IVR IdentityResolutionConfig.
ApiResponse<IVRIdentityResolutionConfig>	getArchitectIvrIdentityresolutionWithHttpInfo(String ivrId)	Get an IVR IdentityResolutionConfig.
IVREntityListing	getArchitectIvrs(GetArchitectIvrsRequest request)	Get IVR configs.
ApiResponse<IVREntityListing>	getArchitectIvrs(ApiRequest<Void> request)	Get IVR configs.
IVREntityListing	getArchitectIvrs(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, String dnis, String scheduleGroup, List<String> expand)	Get IVR configs.
IVRDivisionViewEntityListing	getArchitectIvrsDivisionviews(GetArchitectIvrsDivisionviewsRequest request)	Get a pageable list of basic ivr configuration information objects filterable by query parameters.
ApiResponse<IVRDivisionViewEntityListing>	getArchitectIvrsDivisionviews(ApiRequest<Void> request)	Get a pageable list of basic ivr configuration information objects filterable by query parameters.
IVRDivisionViewEntityListing	getArchitectIvrsDivisionviews(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic ivr configuration information objects filterable by query parameters.
ApiResponse<IVRDivisionViewEntityListing>	getArchitectIvrsDivisionviewsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic ivr configuration information objects filterable by query parameters.
ApiResponse<IVREntityListing>	getArchitectIvrsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, String dnis, String scheduleGroup, List<String> expand)	Get IVR configs.
ApiResponse<IVR>	getArchitectIvrWithHttpInfo(String ivrId)	Get an IVR config.
Prompt	getArchitectPrompt(GetArchitectPromptRequest request)	Get specified user prompt
ApiResponse<Prompt>	getArchitectPrompt(ApiRequest<Void> request)	Get specified user prompt
Prompt	getArchitectPrompt(String promptId, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get specified user prompt
HistoryListing	getArchitectPromptHistoryHistoryId(GetArchitectPromptHistoryHistoryIdRequest request)	Get generated prompt history
ApiResponse<HistoryListing>	getArchitectPromptHistoryHistoryId(ApiRequest<Void> request)	Get generated prompt history
HistoryListing	getArchitectPromptHistoryHistoryId(String promptId, String historyId, Integer pageNumber, Integer pageSize, String sortOrder, String sortBy, List<String> action)	Get generated prompt history
ApiResponse<HistoryListing>	getArchitectPromptHistoryHistoryIdWithHttpInfo(String promptId, String historyId, Integer pageNumber, Integer pageSize, String sortOrder, String sortBy, List<String> action)	Get generated prompt history
PromptAsset	getArchitectPromptResource(GetArchitectPromptResourceRequest request)	Get specified user prompt resource
ApiResponse<PromptAsset>	getArchitectPromptResource(ApiRequest<Void> request)	Get specified user prompt resource
PromptAsset	getArchitectPromptResource(String promptId, String languageCode)	Get specified user prompt resource
PromptAssetEntityListing	getArchitectPromptResources(GetArchitectPromptResourcesRequest request)	Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.
ApiResponse<PromptAssetEntityListing>	getArchitectPromptResources(ApiRequest<Void> request)	Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.
PromptAssetEntityListing	getArchitectPromptResources(String promptId, Integer pageNumber, Integer pageSize)	Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.
ApiResponse<PromptAssetEntityListing>	getArchitectPromptResourcesWithHttpInfo(String promptId, Integer pageNumber, Integer pageSize)	Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.
ApiResponse<PromptAsset>	getArchitectPromptResourceWithHttpInfo(String promptId, String languageCode)	Get specified user prompt resource
PromptEntityListing	getArchitectPrompts(GetArchitectPromptsRequest request)	Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering.
ApiResponse<PromptEntityListing>	getArchitectPrompts(ApiRequest<Void> request)	Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering.
PromptEntityListing	getArchitectPrompts(Integer pageNumber, Integer pageSize, List<String> name, String description, String nameOrDescription, String sortBy, String sortOrder, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering.
ApiResponse<PromptEntityListing>	getArchitectPromptsWithHttpInfo(Integer pageNumber, Integer pageSize, List<String> name, String description, String nameOrDescription, String sortBy, String sortOrder, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering.
ApiResponse<Prompt>	getArchitectPromptWithHttpInfo(String promptId, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get specified user prompt
Schedule	getArchitectSchedule(GetArchitectScheduleRequest request)	Get a schedule by ID
ApiResponse<Schedule>	getArchitectSchedule(ApiRequest<Void> request)	Get a schedule by ID
Schedule	getArchitectSchedule(String scheduleId)	Get a schedule by ID
ScheduleGroup	getArchitectSchedulegroup(GetArchitectSchedulegroupRequest request)	Gets a schedule group by ID
ApiResponse<ScheduleGroup>	getArchitectSchedulegroup(ApiRequest<Void> request)	Gets a schedule group by ID
ScheduleGroup	getArchitectSchedulegroup(String scheduleGroupId)	Gets a schedule group by ID
ScheduleGroupEntityListing	getArchitectSchedulegroups(GetArchitectSchedulegroupsRequest request)	Get a list of schedule groups.
ApiResponse<ScheduleGroupEntityListing>	getArchitectSchedulegroups(ApiRequest<Void> request)	Get a list of schedule groups.
ScheduleGroupEntityListing	getArchitectSchedulegroups(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, String scheduleIds, List<String> divisionId)	Get a list of schedule groups.
ScheduleGroupDivisionViewEntityListing	getArchitectSchedulegroupsDivisionviews(GetArchitectSchedulegroupsDivisionviewsRequest request)	Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
ApiResponse<ScheduleGroupDivisionViewEntityListing>	getArchitectSchedulegroupsDivisionviews(ApiRequest<Void> request)	Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
ScheduleGroupDivisionViewEntityListing	getArchitectSchedulegroupsDivisionviews(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
ApiResponse<ScheduleGroupDivisionViewEntityListing>	getArchitectSchedulegroupsDivisionviewsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
ApiResponse<ScheduleGroupEntityListing>	getArchitectSchedulegroupsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, String scheduleIds, List<String> divisionId)	Get a list of schedule groups.
ApiResponse<ScheduleGroup>	getArchitectSchedulegroupWithHttpInfo(String scheduleGroupId)	Gets a schedule group by ID
ScheduleEntityListing	getArchitectSchedules(GetArchitectSchedulesRequest request)	Get a list of schedules.
ApiResponse<ScheduleEntityListing>	getArchitectSchedules(ApiRequest<Void> request)	Get a list of schedules.
ScheduleEntityListing	getArchitectSchedules(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, List<String> divisionId)	Get a list of schedules.
ScheduleDivisionViewEntityListing	getArchitectSchedulesDivisionviews(GetArchitectSchedulesDivisionviewsRequest request)	Get a pageable list of basic schedule configuration information objects filterable by query parameters.
ApiResponse<ScheduleDivisionViewEntityListing>	getArchitectSchedulesDivisionviews(ApiRequest<Void> request)	Get a pageable list of basic schedule configuration information objects filterable by query parameters.
ScheduleDivisionViewEntityListing	getArchitectSchedulesDivisionviews(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic schedule configuration information objects filterable by query parameters.
ApiResponse<ScheduleDivisionViewEntityListing>	getArchitectSchedulesDivisionviewsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic schedule configuration information objects filterable by query parameters.
ApiResponse<ScheduleEntityListing>	getArchitectSchedulesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, List<String> divisionId)	Get a list of schedules.
ApiResponse<Schedule>	getArchitectScheduleWithHttpInfo(String scheduleId)	Get a schedule by ID
SystemPrompt	getArchitectSystemprompt(GetArchitectSystempromptRequest request)	Get a system prompt
ApiResponse<SystemPrompt>	getArchitectSystemprompt(ApiRequest<Void> request)	Get a system prompt
SystemPrompt	getArchitectSystemprompt(String promptId, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get a system prompt
HistoryListing	getArchitectSystempromptHistoryHistoryId(GetArchitectSystempromptHistoryHistoryIdRequest request)	Get generated prompt history
ApiResponse<HistoryListing>	getArchitectSystempromptHistoryHistoryId(ApiRequest<Void> request)	Get generated prompt history
HistoryListing	getArchitectSystempromptHistoryHistoryId(String promptId, String historyId, Integer pageNumber, Integer pageSize, String sortOrder, String sortBy, List<String> action)	Get generated prompt history
ApiResponse<HistoryListing>	getArchitectSystempromptHistoryHistoryIdWithHttpInfo(String promptId, String historyId, Integer pageNumber, Integer pageSize, String sortOrder, String sortBy, List<String> action)	Get generated prompt history
SystemPromptAsset	getArchitectSystempromptResource(GetArchitectSystempromptResourceRequest request)	Get a system prompt resource.
ApiResponse<SystemPromptAsset>	getArchitectSystempromptResource(ApiRequest<Void> request)	Get a system prompt resource.
SystemPromptAsset	getArchitectSystempromptResource(String promptId, String languageCode)	Get a system prompt resource.
SystemPromptAssetEntityListing	getArchitectSystempromptResources(GetArchitectSystempromptResourcesRequest request)	Get system prompt resources.
ApiResponse<SystemPromptAssetEntityListing>	getArchitectSystempromptResources(ApiRequest<Void> request)	Get system prompt resources.
SystemPromptAssetEntityListing	getArchitectSystempromptResources(String promptId, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder)	Get system prompt resources.
ApiResponse<SystemPromptAssetEntityListing>	getArchitectSystempromptResourcesWithHttpInfo(String promptId, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder)	Get system prompt resources.
ApiResponse<SystemPromptAsset>	getArchitectSystempromptResourceWithHttpInfo(String promptId, String languageCode)	Get a system prompt resource.
SystemPromptEntityListing	getArchitectSystemprompts(GetArchitectSystempromptsRequest request)	Get System Prompts
ApiResponse<SystemPromptEntityListing>	getArchitectSystemprompts(ApiRequest<Void> request)	Get System Prompts
SystemPromptEntityListing	getArchitectSystemprompts(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, String description, String nameOrDescription, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get System Prompts
ApiResponse<SystemPromptEntityListing>	getArchitectSystempromptsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, String name, String description, String nameOrDescription, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get System Prompts
ApiResponse<SystemPrompt>	getArchitectSystempromptWithHttpInfo(String promptId, Boolean includeMediaUris, Boolean includeResources, List<String> language)	Get a system prompt
Flow	getFlow(GetFlowRequest request)	Get flow
ApiResponse<Flow>	getFlow(ApiRequest<Void> request)	Get flow
Flow	getFlow(String flowId, Boolean deleted)	Get flow
HistoryListing	getFlowHistoryHistoryId(GetFlowHistoryHistoryIdRequest request)	Get generated flow history
ApiResponse<HistoryListing>	getFlowHistoryHistoryId(ApiRequest<Void> request)	Get generated flow history
HistoryListing	getFlowHistoryHistoryId(String flowId, String historyId, Integer pageNumber, Integer pageSize, String sortOrder, String sortBy, List<String> action)	Get generated flow history
ApiResponse<HistoryListing>	getFlowHistoryHistoryIdWithHttpInfo(String flowId, String historyId, Integer pageNumber, Integer pageSize, String sortOrder, String sortBy, List<String> action)	Get generated flow history
FlowSettingsResponse	getFlowInstancesSettingsLoglevels(GetFlowInstancesSettingsLoglevelsRequest request)	Retrieves the log level for a flow by flow id.
ApiResponse<FlowSettingsResponse>	getFlowInstancesSettingsLoglevels(ApiRequest<Void> request)	Retrieves the log level for a flow by flow id.
FlowSettingsResponse	getFlowInstancesSettingsLoglevels(String flowId, List<String> expand)	Retrieves the log level for a flow by flow id.
ApiResponse<FlowSettingsResponse>	getFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId, List<String> expand)	Retrieves the log level for a flow by flow id.
Object	getFlowLatestconfiguration(GetFlowLatestconfigurationRequest request)	Get the latest configuration for flow
ApiResponse<Object>	getFlowLatestconfiguration(ApiRequest<Void> request)	Get the latest configuration for flow
Object	getFlowLatestconfiguration(String flowId, Boolean deleted)	Get the latest configuration for flow
ApiResponse<Object>	getFlowLatestconfigurationWithHttpInfo(String flowId, Boolean deleted)	Get the latest configuration for flow
FlowEntityListing	getFlows(GetFlowsRequest request)	Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
ApiResponse<FlowEntityListing>	getFlows(ApiRequest<Void> request)	Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
FlowEntityListing	getFlows(List<String> type, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, String publishVersionId, String editableBy, String lockedBy, String lockedByClientId, String secure, Boolean deleted, Boolean includeSchemas, Boolean virtualAgentEnabled, String publishedAfter, String publishedBefore, List<String> divisionId)	Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
DataTable	getFlowsDatatable(GetFlowsDatatableRequest request)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
ApiResponse<DataTable>	getFlowsDatatable(ApiRequest<Void> request)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
DataTable	getFlowsDatatable(String datatableId, String expand)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
DataTableExportJob	getFlowsDatatableExportJob(GetFlowsDatatableExportJobRequest request)	Returns the state information about an export job Returns the state information about an export job.
ApiResponse<DataTableExportJob>	getFlowsDatatableExportJob(ApiRequest<Void> request)	Returns the state information about an export job Returns the state information about an export job.
DataTableExportJob	getFlowsDatatableExportJob(String datatableId, String exportJobId)	Returns the state information about an export job Returns the state information about an export job.
ApiResponse<DataTableExportJob>	getFlowsDatatableExportJobWithHttpInfo(String datatableId, String exportJobId)	Returns the state information about an export job Returns the state information about an export job.
DataTableImportJob	getFlowsDatatableImportJob(GetFlowsDatatableImportJobRequest request)	Returns the state information about an import job Returns the state information about an import job.
ApiResponse<DataTableImportJob>	getFlowsDatatableImportJob(ApiRequest<Void> request)	Returns the state information about an import job Returns the state information about an import job.
DataTableImportJob	getFlowsDatatableImportJob(String datatableId, String importJobId)	Returns the state information about an import job Returns the state information about an import job.
DataTableImportEntityListing	getFlowsDatatableImportJobs(GetFlowsDatatableImportJobsRequest request)	Get all recent import jobs Get all recent import jobs
ApiResponse<DataTableImportEntityListing>	getFlowsDatatableImportJobs(ApiRequest<Void> request)	Get all recent import jobs Get all recent import jobs
DataTableImportEntityListing	getFlowsDatatableImportJobs(String datatableId, Integer pageNumber, Integer pageSize)	Get all recent import jobs Get all recent import jobs
ApiResponse<DataTableImportEntityListing>	getFlowsDatatableImportJobsWithHttpInfo(String datatableId, Integer pageNumber, Integer pageSize)	Get all recent import jobs Get all recent import jobs
ApiResponse<DataTableImportJob>	getFlowsDatatableImportJobWithHttpInfo(String datatableId, String importJobId)	Returns the state information about an import job Returns the state information about an import job.
Map<String,Object>	getFlowsDatatableRow(GetFlowsDatatableRowRequest request)	Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
ApiResponse<Map<String,Object>>	getFlowsDatatableRow(ApiRequest<Void> request)	Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
Map<String,Object>	getFlowsDatatableRow(String datatableId, String rowId, Boolean showbrief)	Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
DataTableRowEntityListing	getFlowsDatatableRows(GetFlowsDatatableRowsRequest request)	Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId.
ApiResponse<DataTableRowEntityListing>	getFlowsDatatableRows(ApiRequest<Void> request)	Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId.
DataTableRowEntityListing	getFlowsDatatableRows(String datatableId, Integer pageNumber, Integer pageSize, Boolean showbrief, String sortOrder)	Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId.
ApiResponse<DataTableRowEntityListing>	getFlowsDatatableRowsWithHttpInfo(String datatableId, Integer pageNumber, Integer pageSize, Boolean showbrief, String sortOrder)	Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId.
ApiResponse<Map<String,Object>>	getFlowsDatatableRowWithHttpInfo(String datatableId, String rowId, Boolean showbrief)	Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.
DataTablesDomainEntityListing	getFlowsDatatables(GetFlowsDatatablesRequest request)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
ApiResponse<DataTablesDomainEntityListing>	getFlowsDatatables(ApiRequest<Void> request)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
DataTablesDomainEntityListing	getFlowsDatatables(String expand, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> divisionId, String name)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
DataTable	getFlowsDatatablesDivisionview(GetFlowsDatatablesDivisionviewRequest request)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
ApiResponse<DataTable>	getFlowsDatatablesDivisionview(ApiRequest<Void> request)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
DataTable	getFlowsDatatablesDivisionview(String datatableId, String expand)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
DataTablesDomainEntityListing	getFlowsDatatablesDivisionviews(GetFlowsDatatablesDivisionviewsRequest request)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
ApiResponse<DataTablesDomainEntityListing>	getFlowsDatatablesDivisionviews(ApiRequest<Void> request)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
DataTablesDomainEntityListing	getFlowsDatatablesDivisionviews(String expand, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> divisionId, String name)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
ApiResponse<DataTablesDomainEntityListing>	getFlowsDatatablesDivisionviewsWithHttpInfo(String expand, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> divisionId, String name)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
ApiResponse<DataTable>	getFlowsDatatablesDivisionviewWithHttpInfo(String datatableId, String expand)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
ApiResponse<DataTablesDomainEntityListing>	getFlowsDatatablesWithHttpInfo(String expand, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> divisionId, String name)	Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.
ApiResponse<DataTable>	getFlowsDatatableWithHttpInfo(String datatableId, String expand)	Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.
FlowDivisionViewEntityListing	getFlowsDivisionviews(GetFlowsDivisionviewsRequest request)	Get a pageable list of basic flow information objects filterable by query parameters.
ApiResponse<FlowDivisionViewEntityListing>	getFlowsDivisionviews(ApiRequest<Void> request)	Get a pageable list of basic flow information objects filterable by query parameters.
FlowDivisionViewEntityListing	getFlowsDivisionviews(List<String> type, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String publishVersionId, String publishedAfter, String publishedBefore, List<String> divisionId, Boolean includeSchemas)	Get a pageable list of basic flow information objects filterable by query parameters.
ApiResponse<FlowDivisionViewEntityListing>	getFlowsDivisionviewsWithHttpInfo(List<String> type, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String publishVersionId, String publishedAfter, String publishedBefore, List<String> divisionId, Boolean includeSchemas)	Get a pageable list of basic flow information objects filterable by query parameters.
FlowRuntimeExecution	getFlowsExecution(GetFlowsExecutionRequest request)	Get a flow execution's details.
ApiResponse<FlowRuntimeExecution>	getFlowsExecution(ApiRequest<Void> request)	Get a flow execution's details.
FlowRuntimeExecution	getFlowsExecution(String flowExecutionId)	Get a flow execution's details.
ApiResponse<FlowRuntimeExecution>	getFlowsExecutionWithHttpInfo(String flowExecutionId)	Get a flow execution's details.
ArchitectExportJobStateResponse	getFlowsExportJob(GetFlowsExportJobRequest request)	Fetch Architect Export Job Status
ApiResponse<ArchitectExportJobStateResponse>	getFlowsExportJob(ApiRequest<Void> request)	Fetch Architect Export Job Status
ArchitectExportJobStateResponse	getFlowsExportJob(String jobId, List<String> expand)	Fetch Architect Export Job Status
ApiResponse<ArchitectExportJobStateResponse>	getFlowsExportJobWithHttpInfo(String jobId, List<String> expand)	Fetch Architect Export Job Status
GetFlowExecutionDataJobResult	getFlowsInstance(GetFlowsInstanceRequest request)	Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
ApiResponse<GetFlowExecutionDataJobResult>	getFlowsInstance(ApiRequest<Void> request)	Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
GetFlowExecutionDataJobResult	getFlowsInstance(String instanceId, String expand)	Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
GetFlowExecutionDataJobResult	getFlowsInstancesJob(GetFlowsInstancesJobRequest request)	Get the status and/or results of an asynchronous flow execution data retrieval job
ApiResponse<GetFlowExecutionDataJobResult>	getFlowsInstancesJob(ApiRequest<Void> request)	Get the status and/or results of an asynchronous flow execution data retrieval job
GetFlowExecutionDataJobResult	getFlowsInstancesJob(String jobId)	Get the status and/or results of an asynchronous flow execution data retrieval job
ApiResponse<GetFlowExecutionDataJobResult>	getFlowsInstancesJobWithHttpInfo(String jobId)	Get the status and/or results of an asynchronous flow execution data retrieval job
FlowsQueryCriteriaResponse	getFlowsInstancesQuerycapabilities(GetFlowsInstancesQuerycapabilitiesRequest request)	Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.
ApiResponse<FlowsQueryCriteriaResponse>	getFlowsInstancesQuerycapabilities(ApiRequest<Void> request)	Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.
FlowsQueryCriteriaResponse	getFlowsInstancesQuerycapabilities(String expand)	Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.
ApiResponse<FlowsQueryCriteriaResponse>	getFlowsInstancesQuerycapabilitiesWithHttpInfo(String expand)	Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.
ExecutionDataFlowSettingsResponse	getFlowsInstancesSettingsExecutiondata()	Get the execution history enabled setting.
ExecutionDataFlowSettingsResponse	getFlowsInstancesSettingsExecutiondata(GetFlowsInstancesSettingsExecutiondataRequest request)	Get the execution history enabled setting.
ApiResponse<ExecutionDataFlowSettingsResponse>	getFlowsInstancesSettingsExecutiondata(ApiRequest<Void> request)	Get the execution history enabled setting.
ApiResponse<ExecutionDataFlowSettingsResponse>	getFlowsInstancesSettingsExecutiondataWithHttpInfo()	Get the execution history enabled setting.
FlowSettingsResponseEntityListing	getFlowsInstancesSettingsLoglevels(GetFlowsInstancesSettingsLoglevelsRequest request)	Retrieve a list of LogLevels for the organization.
ApiResponse<FlowSettingsResponseEntityListing>	getFlowsInstancesSettingsLoglevels(ApiRequest<Void> request)	Retrieve a list of LogLevels for the organization.
FlowSettingsResponseEntityListing	getFlowsInstancesSettingsLoglevels(List<String> expand, Integer pageNumber, Integer pageSize)	Retrieve a list of LogLevels for the organization.
FlowLogLevelCharacteristicsDefinitions	getFlowsInstancesSettingsLoglevelsCharacteristics()	Gets the available flow log level characteristics for this organization.
FlowLogLevelCharacteristicsDefinitions	getFlowsInstancesSettingsLoglevelsCharacteristics(GetFlowsInstancesSettingsLoglevelsCharacteristicsRequest request)	Gets the available flow log level characteristics for this organization.
ApiResponse<FlowLogLevelCharacteristicsDefinitions>	getFlowsInstancesSettingsLoglevelsCharacteristics(ApiRequest<Void> request)	Gets the available flow log level characteristics for this organization.
ApiResponse<FlowLogLevelCharacteristicsDefinitions>	getFlowsInstancesSettingsLoglevelsCharacteristicsWithHttpInfo()	Gets the available flow log level characteristics for this organization.
FlowSettingsResponse	getFlowsInstancesSettingsLoglevelsDefault(GetFlowsInstancesSettingsLoglevelsDefaultRequest request)	Returns the flow default log level.
ApiResponse<FlowSettingsResponse>	getFlowsInstancesSettingsLoglevelsDefault(ApiRequest<Void> request)	Returns the flow default log level.
FlowSettingsResponse	getFlowsInstancesSettingsLoglevelsDefault(List<String> expand)	Returns the flow default log level.
ApiResponse<FlowSettingsResponse>	getFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo(List<String> expand)	Returns the flow default log level.
ApiResponse<FlowSettingsResponseEntityListing>	getFlowsInstancesSettingsLoglevelsWithHttpInfo(List<String> expand, Integer pageNumber, Integer pageSize)	Retrieve a list of LogLevels for the organization.
ApiResponse<GetFlowExecutionDataJobResult>	getFlowsInstanceWithHttpInfo(String instanceId, String expand)	Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
ArchitectJobStateResponse	getFlowsJob(GetFlowsJobRequest request)	Fetch Architect Job Status
ApiResponse<ArchitectJobStateResponse>	getFlowsJob(ApiRequest<Void> request)	Fetch Architect Job Status
ArchitectJobStateResponse	getFlowsJob(String jobId, List<String> expand)	Fetch Architect Job Status
ApiResponse<ArchitectJobStateResponse>	getFlowsJobWithHttpInfo(String jobId, List<String> expand)	Fetch Architect Job Status
FlowMilestone	getFlowsMilestone(GetFlowsMilestoneRequest request)	Get a flow milestone Returns a specified flow milestone
ApiResponse<FlowMilestone>	getFlowsMilestone(ApiRequest<Void> request)	Get a flow milestone Returns a specified flow milestone
FlowMilestone	getFlowsMilestone(String milestoneId)	Get a flow milestone Returns a specified flow milestone
FlowMilestoneListing	getFlowsMilestones(GetFlowsMilestonesRequest request)	Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.
ApiResponse<FlowMilestoneListing>	getFlowsMilestones(ApiRequest<Void> request)	Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.
FlowMilestoneListing	getFlowsMilestones(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, List<String> divisionId)	Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.
FlowMilestoneDivisionViewEntityListing	getFlowsMilestonesDivisionviews(GetFlowsMilestonesDivisionviewsRequest request)	Get a pageable list of basic flow milestone information objects filterable by query parameters.
ApiResponse<FlowMilestoneDivisionViewEntityListing>	getFlowsMilestonesDivisionviews(ApiRequest<Void> request)	Get a pageable list of basic flow milestone information objects filterable by query parameters.
FlowMilestoneDivisionViewEntityListing	getFlowsMilestonesDivisionviews(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic flow milestone information objects filterable by query parameters.
ApiResponse<FlowMilestoneDivisionViewEntityListing>	getFlowsMilestonesDivisionviewsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic flow milestone information objects filterable by query parameters.
ApiResponse<FlowMilestoneListing>	getFlowsMilestonesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, List<String> divisionId)	Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.
ApiResponse<FlowMilestone>	getFlowsMilestoneWithHttpInfo(String milestoneId)	Get a flow milestone Returns a specified flow milestone
FlowOutcome	getFlowsOutcome(GetFlowsOutcomeRequest request)	Get a flow outcome Returns a specified flow outcome
ApiResponse<FlowOutcome>	getFlowsOutcome(ApiRequest<Void> request)	Get a flow outcome Returns a specified flow outcome
FlowOutcome	getFlowsOutcome(String flowOutcomeId)	Get a flow outcome Returns a specified flow outcome
FlowOutcomeListing	getFlowsOutcomes(GetFlowsOutcomesRequest request)	Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.
ApiResponse<FlowOutcomeListing>	getFlowsOutcomes(ApiRequest<Void> request)	Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.
FlowOutcomeListing	getFlowsOutcomes(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, List<String> divisionId)	Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.
FlowOutcomeDivisionViewEntityListing	getFlowsOutcomesDivisionviews(GetFlowsOutcomesDivisionviewsRequest request)	Get a pageable list of basic flow outcome information objects filterable by query parameters.
ApiResponse<FlowOutcomeDivisionViewEntityListing>	getFlowsOutcomesDivisionviews(ApiRequest<Void> request)	Get a pageable list of basic flow outcome information objects filterable by query parameters.
FlowOutcomeDivisionViewEntityListing	getFlowsOutcomesDivisionviews(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic flow outcome information objects filterable by query parameters.
ApiResponse<FlowOutcomeDivisionViewEntityListing>	getFlowsOutcomesDivisionviewsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, List<String> divisionId)	Get a pageable list of basic flow outcome information objects filterable by query parameters.
ApiResponse<FlowOutcomeListing>	getFlowsOutcomesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, List<String> divisionId)	Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.
ApiResponse<FlowOutcome>	getFlowsOutcomeWithHttpInfo(String flowOutcomeId)	Get a flow outcome Returns a specified flow outcome
ApiResponse<FlowEntityListing>	getFlowsWithHttpInfo(List<String> type, Integer pageNumber, Integer pageSize, String sortBy, String sortOrder, List<String> id, String name, String description, String nameOrDescription, String publishVersionId, String editableBy, String lockedBy, String lockedByClientId, String secure, Boolean deleted, Boolean includeSchemas, Boolean virtualAgentEnabled, String publishedAfter, String publishedBefore, List<String> divisionId)	Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
FlowVersion	getFlowVersion(GetFlowVersionRequest request)	Get flow version
ApiResponse<FlowVersion>	getFlowVersion(ApiRequest<Void> request)	Get flow version
FlowVersion	getFlowVersion(String flowId, String versionId, String deleted)	Get flow version
Object	getFlowVersionConfiguration(GetFlowVersionConfigurationRequest request)	Get flow version configuration
ApiResponse<Object>	getFlowVersionConfiguration(ApiRequest<Void> request)	Get flow version configuration
Object	getFlowVersionConfiguration(String flowId, String versionId, String deleted)	Get flow version configuration
ApiResponse<Object>	getFlowVersionConfigurationWithHttpInfo(String flowId, String versionId, String deleted)	Get flow version configuration
FlowHealth	getFlowVersionHealth(GetFlowVersionHealthRequest request)	Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
ApiResponse<FlowHealth>	getFlowVersionHealth(ApiRequest<Void> request)	Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
FlowHealth	getFlowVersionHealth(String flowId, String versionId, String language)	Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
ApiResponse<FlowHealth>	getFlowVersionHealthWithHttpInfo(String flowId, String versionId, String language)	Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
FlowHealthIntent	getFlowVersionIntentHealth(GetFlowVersionIntentHealthRequest request)	Get health scores and other health metrics for a specific intent.
ApiResponse<FlowHealthIntent>	getFlowVersionIntentHealth(ApiRequest<Void> request)	Get health scores and other health metrics for a specific intent.
FlowHealthIntent	getFlowVersionIntentHealth(String flowId, String versionId, String intentId, String language)	Get health scores and other health metrics for a specific intent.
ApiResponse<FlowHealthIntent>	getFlowVersionIntentHealthWithHttpInfo(String flowId, String versionId, String intentId, String language)	Get health scores and other health metrics for a specific intent.
FlowHealthUtterance	getFlowVersionIntentUtteranceHealth(GetFlowVersionIntentUtteranceHealthRequest request)	Get health metrics associated with a specific utterance of an intent.
ApiResponse<FlowHealthUtterance>	getFlowVersionIntentUtteranceHealth(ApiRequest<Void> request)	Get health metrics associated with a specific utterance of an intent.
FlowHealthUtterance	getFlowVersionIntentUtteranceHealth(String flowId, String versionId, String intentId, String utteranceId, String language)	Get health metrics associated with a specific utterance of an intent.
ApiResponse<FlowHealthUtterance>	getFlowVersionIntentUtteranceHealthWithHttpInfo(String flowId, String versionId, String intentId, String utteranceId, String language)	Get health metrics associated with a specific utterance of an intent.
FlowVersionEntityListing	getFlowVersions(GetFlowVersionsRequest request)	Get flow version list
ApiResponse<FlowVersionEntityListing>	getFlowVersions(ApiRequest<Void> request)	Get flow version list
FlowVersionEntityListing	getFlowVersions(String flowId, Integer pageNumber, Integer pageSize, Boolean deleted)	Get flow version list
ApiResponse<FlowVersionEntityListing>	getFlowVersionsWithHttpInfo(String flowId, Integer pageNumber, Integer pageSize, Boolean deleted)	Get flow version list
ApiResponse<FlowVersion>	getFlowVersionWithHttpInfo(String flowId, String versionId, String deleted)	Get flow version
ApiResponse<Flow>	getFlowWithHttpInfo(String flowId, Boolean deleted)	Get flow
Grammar	patchArchitectGrammar(PatchArchitectGrammarRequest request)	Updates a grammar
ApiResponse<Grammar>	patchArchitectGrammar(ApiRequest<Grammar> request)	Updates a grammar
Grammar	patchArchitectGrammar(String grammarId, Grammar body)	Updates a grammar
GrammarLanguage	patchArchitectGrammarLanguage(PatchArchitectGrammarLanguageRequest request)	Updates a grammar language
ApiResponse<GrammarLanguage>	patchArchitectGrammarLanguage(ApiRequest<GrammarLanguageUpdate> request)	Updates a grammar language
GrammarLanguage	patchArchitectGrammarLanguage(String grammarId, String languageCode, GrammarLanguageUpdate body)	Updates a grammar language
ApiResponse<GrammarLanguage>	patchArchitectGrammarLanguageWithHttpInfo(String grammarId, String languageCode, GrammarLanguageUpdate body)	Updates a grammar language
ApiResponse<Grammar>	patchArchitectGrammarWithHttpInfo(String grammarId, Grammar body)	Updates a grammar
ExecutionDataFlowSettingsResponse	patchFlowsInstancesSettingsExecutiondata(PatchFlowsInstancesSettingsExecutiondataRequest request)	Edit the execution history enabled setting.
ApiResponse<ExecutionDataFlowSettingsResponse>	patchFlowsInstancesSettingsExecutiondata(ApiRequest<ExecutionDataSettingsRequest> request)	Edit the execution history enabled setting.
ExecutionDataFlowSettingsResponse	patchFlowsInstancesSettingsExecutiondata(ExecutionDataSettingsRequest body)	Edit the execution history enabled setting.
ApiResponse<ExecutionDataFlowSettingsResponse>	patchFlowsInstancesSettingsExecutiondataWithHttpInfo(ExecutionDataSettingsRequest body)	Edit the execution history enabled setting.
void	postArchitectDependencytrackingBuild()	Rebuild Dependency Tracking data for an organization Asynchronous.
void	postArchitectDependencytrackingBuild(PostArchitectDependencytrackingBuildRequest request)	Rebuild Dependency Tracking data for an organization Asynchronous.
ApiResponse<Void>	postArchitectDependencytrackingBuild(ApiRequest<Void> request)	Rebuild Dependency Tracking data for an organization Asynchronous.
ApiResponse<Void>	postArchitectDependencytrackingBuildWithHttpInfo()	Rebuild Dependency Tracking data for an organization Asynchronous.
EmergencyGroup	postArchitectEmergencygroups(PostArchitectEmergencygroupsRequest request)	Creates a new emergency group
ApiResponse<EmergencyGroup>	postArchitectEmergencygroups(ApiRequest<EmergencyGroup> request)	Creates a new emergency group
EmergencyGroup	postArchitectEmergencygroups(EmergencyGroup body)	Creates a new emergency group
ApiResponse<EmergencyGroup>	postArchitectEmergencygroupsWithHttpInfo(EmergencyGroup body)	Creates a new emergency group
UploadUrlResponse	postArchitectGrammarLanguageFilesDtmf(PostArchitectGrammarLanguageFilesDtmfRequest request)	Creates a presigned URL for uploading a grammar DTMF mode file
ApiResponse<UploadUrlResponse>	postArchitectGrammarLanguageFilesDtmf(ApiRequest<GrammarFileUploadRequest> request)	Creates a presigned URL for uploading a grammar DTMF mode file
UploadUrlResponse	postArchitectGrammarLanguageFilesDtmf(String grammarId, String languageCode, GrammarFileUploadRequest body)	Creates a presigned URL for uploading a grammar DTMF mode file
ApiResponse<UploadUrlResponse>	postArchitectGrammarLanguageFilesDtmfWithHttpInfo(String grammarId, String languageCode, GrammarFileUploadRequest body)	Creates a presigned URL for uploading a grammar DTMF mode file
UploadUrlResponse	postArchitectGrammarLanguageFilesVoice(PostArchitectGrammarLanguageFilesVoiceRequest request)	Creates a presigned URL for uploading a grammar voice mode file
ApiResponse<UploadUrlResponse>	postArchitectGrammarLanguageFilesVoice(ApiRequest<GrammarFileUploadRequest> request)	Creates a presigned URL for uploading a grammar voice mode file
UploadUrlResponse	postArchitectGrammarLanguageFilesVoice(String grammarId, String languageCode, GrammarFileUploadRequest body)	Creates a presigned URL for uploading a grammar voice mode file
ApiResponse<UploadUrlResponse>	postArchitectGrammarLanguageFilesVoiceWithHttpInfo(String grammarId, String languageCode, GrammarFileUploadRequest body)	Creates a presigned URL for uploading a grammar voice mode file
GrammarLanguage	postArchitectGrammarLanguages(PostArchitectGrammarLanguagesRequest request)	Create a new language for a given grammar
ApiResponse<GrammarLanguage>	postArchitectGrammarLanguages(ApiRequest<GrammarLanguage> request)	Create a new language for a given grammar
GrammarLanguage	postArchitectGrammarLanguages(String grammarId, GrammarLanguage body)	Create a new language for a given grammar
ApiResponse<GrammarLanguage>	postArchitectGrammarLanguagesWithHttpInfo(String grammarId, GrammarLanguage body)	Create a new language for a given grammar
Grammar	postArchitectGrammars(PostArchitectGrammarsRequest request)	Create a new grammar
ApiResponse<Grammar>	postArchitectGrammars(ApiRequest<Grammar> request)	Create a new grammar
Grammar	postArchitectGrammars(Grammar body)	Create a new grammar
ApiResponse<Grammar>	postArchitectGrammarsWithHttpInfo(Grammar body)	Create a new grammar
IVR	postArchitectIvrs(PostArchitectIvrsRequest request)	Create IVR config.
ApiResponse<IVR>	postArchitectIvrs(ApiRequest<IVR> request)	Create IVR config.
IVR	postArchitectIvrs(IVR body)	Create IVR config.
ApiResponse<IVR>	postArchitectIvrsWithHttpInfo(IVR body)	Create IVR config.
Operation	postArchitectPromptHistory(PostArchitectPromptHistoryRequest request)	Generate prompt history Asynchronous.
ApiResponse<Operation>	postArchitectPromptHistory(ApiRequest<Void> request)	Generate prompt history Asynchronous.
Operation	postArchitectPromptHistory(String promptId)	Generate prompt history Asynchronous.
ApiResponse<Operation>	postArchitectPromptHistoryWithHttpInfo(String promptId)	Generate prompt history Asynchronous.
PromptAsset	postArchitectPromptResources(PostArchitectPromptResourcesRequest request)	Create a new user prompt resource
ApiResponse<PromptAsset>	postArchitectPromptResources(ApiRequest<PromptAssetCreate> request)	Create a new user prompt resource
PromptAsset	postArchitectPromptResources(String promptId, PromptAssetCreate body)	Create a new user prompt resource
ApiResponse<PromptAsset>	postArchitectPromptResourcesWithHttpInfo(String promptId, PromptAssetCreate body)	Create a new user prompt resource
PromptAssetUpload	postArchitectPromptResourceUploads(PostArchitectPromptResourceUploadsRequest request)	Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
ApiResponse<PromptAssetUpload>	postArchitectPromptResourceUploads(ApiRequest<Void> request)	Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
PromptAssetUpload	postArchitectPromptResourceUploads(String promptId, String languageCode)	Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
ApiResponse<PromptAssetUpload>	postArchitectPromptResourceUploadsWithHttpInfo(String promptId, String languageCode)	Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
Prompt	postArchitectPrompts(PostArchitectPromptsRequest request)	Create a new user prompt
ApiResponse<Prompt>	postArchitectPrompts(ApiRequest<Prompt> request)	Create a new user prompt
Prompt	postArchitectPrompts(Prompt body)	Create a new user prompt
ApiResponse<Prompt>	postArchitectPromptsWithHttpInfo(Prompt body)	Create a new user prompt
ScheduleGroup	postArchitectSchedulegroups(PostArchitectSchedulegroupsRequest request)	Creates a new schedule group
ApiResponse<ScheduleGroup>	postArchitectSchedulegroups(ApiRequest<ScheduleGroup> request)	Creates a new schedule group
ScheduleGroup	postArchitectSchedulegroups(ScheduleGroup body)	Creates a new schedule group
ApiResponse<ScheduleGroup>	postArchitectSchedulegroupsWithHttpInfo(ScheduleGroup body)	Creates a new schedule group
Schedule	postArchitectSchedules(PostArchitectSchedulesRequest request)	Create a new schedule.
ApiResponse<Schedule>	postArchitectSchedules(ApiRequest<Schedule> request)	Create a new schedule.
Schedule	postArchitectSchedules(Schedule body)	Create a new schedule.
ApiResponse<Schedule>	postArchitectSchedulesWithHttpInfo(Schedule body)	Create a new schedule.
Operation	postArchitectSystempromptHistory(PostArchitectSystempromptHistoryRequest request)	Generate system prompt history Asynchronous.
ApiResponse<Operation>	postArchitectSystempromptHistory(ApiRequest<Void> request)	Generate system prompt history Asynchronous.
Operation	postArchitectSystempromptHistory(String promptId)	Generate system prompt history Asynchronous.
ApiResponse<Operation>	postArchitectSystempromptHistoryWithHttpInfo(String promptId)	Generate system prompt history Asynchronous.
SystemPromptAsset	postArchitectSystempromptResources(PostArchitectSystempromptResourcesRequest request)	Create system prompt resource override.
ApiResponse<SystemPromptAsset>	postArchitectSystempromptResources(ApiRequest<SystemPromptAsset> request)	Create system prompt resource override.
SystemPromptAsset	postArchitectSystempromptResources(String promptId, SystemPromptAsset body)	Create system prompt resource override.
ApiResponse<SystemPromptAsset>	postArchitectSystempromptResourcesWithHttpInfo(String promptId, SystemPromptAsset body)	Create system prompt resource override.
PromptAssetUpload	postArchitectSystempromptResourceUploads(PostArchitectSystempromptResourceUploadsRequest request)	Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
ApiResponse<PromptAssetUpload>	postArchitectSystempromptResourceUploads(ApiRequest<Void> request)	Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
PromptAssetUpload	postArchitectSystempromptResourceUploads(String promptId, String languageCode)	Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
ApiResponse<PromptAssetUpload>	postArchitectSystempromptResourceUploadsWithHttpInfo(String promptId, String languageCode)	Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
Operation	postFlowHistory(PostFlowHistoryRequest request)	Generate flow history Asynchronous.
ApiResponse<Operation>	postFlowHistory(ApiRequest<Void> request)	Generate flow history Asynchronous.
Operation	postFlowHistory(String flowId)	Generate flow history Asynchronous.
ApiResponse<Operation>	postFlowHistoryWithHttpInfo(String flowId)	Generate flow history Asynchronous.
FlowSettingsResponse	postFlowInstancesSettingsLoglevels(PostFlowInstancesSettingsLoglevelsRequest request)	Set the logLevel for a particular flow id Assigns a new loglevel to a flow id
ApiResponse<FlowSettingsResponse>	postFlowInstancesSettingsLoglevels(ApiRequest<FlowLogLevelRequest> request)	Set the logLevel for a particular flow id Assigns a new loglevel to a flow id
FlowSettingsResponse	postFlowInstancesSettingsLoglevels(String flowId, FlowLogLevelRequest body, List<String> expand)	Set the logLevel for a particular flow id Assigns a new loglevel to a flow id
ApiResponse<FlowSettingsResponse>	postFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId, FlowLogLevelRequest body, List<String> expand)	Set the logLevel for a particular flow id Assigns a new loglevel to a flow id
Flow	postFlows(PostFlowsRequest request)	Create flow
ApiResponse<Flow>	postFlows(ApiRequest<Flow> request)	Create flow
Flow	postFlows(Flow body, String language)	Create flow
Operation	postFlowsActionsCheckin(PostFlowsActionsCheckinRequest request)	Check-in flow Asynchronous.
ApiResponse<Operation>	postFlowsActionsCheckin(ApiRequest<Void> request)	Check-in flow Asynchronous.
Operation	postFlowsActionsCheckin(String flow)	Check-in flow Asynchronous.
ApiResponse<Operation>	postFlowsActionsCheckinWithHttpInfo(String flow)	Check-in flow Asynchronous.
Flow	postFlowsActionsCheckout(PostFlowsActionsCheckoutRequest request)	Check-out flow
ApiResponse<Flow>	postFlowsActionsCheckout(ApiRequest<Void> request)	Check-out flow
Flow	postFlowsActionsCheckout(String flow)	Check-out flow
ApiResponse<Flow>	postFlowsActionsCheckoutWithHttpInfo(String flow)	Check-out flow
Flow	postFlowsActionsDeactivate(PostFlowsActionsDeactivateRequest request)	Deactivate flow
ApiResponse<Flow>	postFlowsActionsDeactivate(ApiRequest<Void> request)	Deactivate flow
Flow	postFlowsActionsDeactivate(String flow)	Deactivate flow
ApiResponse<Flow>	postFlowsActionsDeactivateWithHttpInfo(String flow)	Deactivate flow
Operation	postFlowsActionsPublish(PostFlowsActionsPublishRequest request)	Publish flow Asynchronous.
ApiResponse<Operation>	postFlowsActionsPublish(ApiRequest<Void> request)	Publish flow Asynchronous.
Operation	postFlowsActionsPublish(String flow, String version)	Publish flow Asynchronous.
ApiResponse<Operation>	postFlowsActionsPublishWithHttpInfo(String flow, String version)	Publish flow Asynchronous.
Flow	postFlowsActionsRevert(PostFlowsActionsRevertRequest request)	Revert flow
ApiResponse<Flow>	postFlowsActionsRevert(ApiRequest<Void> request)	Revert flow
Flow	postFlowsActionsRevert(String flow)	Revert flow
ApiResponse<Flow>	postFlowsActionsRevertWithHttpInfo(String flow)	Revert flow
Flow	postFlowsActionsUnlock(PostFlowsActionsUnlockRequest request)	Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow.
ApiResponse<Flow>	postFlowsActionsUnlock(ApiRequest<Void> request)	Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow.
Flow	postFlowsActionsUnlock(String flow)	Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow.
ApiResponse<Flow>	postFlowsActionsUnlockWithHttpInfo(String flow)	Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow.
DataTableExportJob	postFlowsDatatableExportJobs(PostFlowsDatatableExportJobsRequest request)	Begin an export process for exporting all rows from a datatable Create an export job for exporting rows.
ApiResponse<DataTableExportJob>	postFlowsDatatableExportJobs(ApiRequest<Void> request)	Begin an export process for exporting all rows from a datatable Create an export job for exporting rows.
DataTableExportJob	postFlowsDatatableExportJobs(String datatableId)	Begin an export process for exporting all rows from a datatable Create an export job for exporting rows.
ApiResponse<DataTableExportJob>	postFlowsDatatableExportJobsWithHttpInfo(String datatableId)	Begin an export process for exporting all rows from a datatable Create an export job for exporting rows.
DataTableImportJob	postFlowsDatatableImportCsvJobs(PostFlowsDatatableImportCsvJobsRequest request)	Begin an import process for importing rows from a CSV file into a datatable.
ApiResponse<DataTableImportJob>	postFlowsDatatableImportCsvJobs(ApiRequest<DataTableImportJob> request)	Begin an import process for importing rows from a CSV file into a datatable.
DataTableImportJob	postFlowsDatatableImportCsvJobs(String datatableId, DataTableImportJob body)	Begin an import process for importing rows from a CSV file into a datatable.
ApiResponse<DataTableImportJob>	postFlowsDatatableImportCsvJobsWithHttpInfo(String datatableId, DataTableImportJob body)	Begin an import process for importing rows from a CSV file into a datatable.
DataTableImportJob	postFlowsDatatableImportJobs(PostFlowsDatatableImportJobsRequest request)	Deprecated.
ApiResponse<DataTableImportJob>	postFlowsDatatableImportJobs(ApiRequest<DataTableImportJob> request)	Deprecated.
DataTableImportJob	postFlowsDatatableImportJobs(String datatableId, DataTableImportJob body)	Deprecated.
ApiResponse<DataTableImportJob>	postFlowsDatatableImportJobsWithHttpInfo(String datatableId, DataTableImportJob body)	Deprecated.
Map<String,Object>	postFlowsDatatableRows(PostFlowsDatatableRowsRequest request)	Create a new row entry for the datatable.
ApiResponse<Map<String,Object>>	postFlowsDatatableRows(ApiRequest<Object> request)	Create a new row entry for the datatable.
Map<String,Object>	postFlowsDatatableRows(String datatableId, Object dataTableRow)	Create a new row entry for the datatable.
ApiResponse<Map<String,Object>>	postFlowsDatatableRowsWithHttpInfo(String datatableId, Object dataTableRow)	Create a new row entry for the datatable.
DataTable	postFlowsDatatables(PostFlowsDatatablesRequest request)	Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema.
ApiResponse<DataTable>	postFlowsDatatables(ApiRequest<DataTable> request)	Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema.
DataTable	postFlowsDatatables(DataTable body)	Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema.
ApiResponse<DataTable>	postFlowsDatatablesWithHttpInfo(DataTable body)	Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema.
FlowExecutionLaunchResponse	postFlowsExecutions(PostFlowsExecutionsRequest request)	Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
ApiResponse<FlowExecutionLaunchResponse>	postFlowsExecutions(ApiRequest<FlowExecutionLaunchRequest> request)	Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
FlowExecutionLaunchResponse	postFlowsExecutions(FlowExecutionLaunchRequest flowLaunchRequest)	Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
ApiResponse<FlowExecutionLaunchResponse>	postFlowsExecutionsWithHttpInfo(FlowExecutionLaunchRequest flowLaunchRequest)	Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
RegisterArchitectExportJobResponse	postFlowsExportJobs(PostFlowsExportJobsRequest request)	Register Architect Export Job
ApiResponse<RegisterArchitectExportJobResponse>	postFlowsExportJobs(ApiRequest<RegisterArchitectExportJob> request)	Register Architect Export Job
RegisterArchitectExportJobResponse	postFlowsExportJobs(RegisterArchitectExportJob body)	Register Architect Export Job
ApiResponse<RegisterArchitectExportJobResponse>	postFlowsExportJobsWithHttpInfo(RegisterArchitectExportJob body)	Register Architect Export Job
GetFlowExecutionDataJobResult	postFlowsInstancesJobs(PostFlowsInstancesJobsRequest request)	Start a process (job) that will prepare a list of execution data IDs for download.
ApiResponse<GetFlowExecutionDataJobResult>	postFlowsInstancesJobs(ApiRequest<ExecutionDataRequest> request)	Start a process (job) that will prepare a list of execution data IDs for download.
GetFlowExecutionDataJobResult	postFlowsInstancesJobs(ExecutionDataRequest body, String expand)	Start a process (job) that will prepare a list of execution data IDs for download.
ApiResponse<GetFlowExecutionDataJobResult>	postFlowsInstancesJobsWithHttpInfo(ExecutionDataRequest body, String expand)	Start a process (job) that will prepare a list of execution data IDs for download.
FlowResultEntityListing	postFlowsInstancesQuery(PostFlowsInstancesQueryRequest request)	Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.
ApiResponse<FlowResultEntityListing>	postFlowsInstancesQuery(ApiRequest<CriteriaQuery> request)	Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.
FlowResultEntityListing	postFlowsInstancesQuery(CriteriaQuery body, Boolean indexOnly, Integer pageSize)	Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.
ApiResponse<FlowResultEntityListing>	postFlowsInstancesQueryWithHttpInfo(CriteriaQuery body, Boolean indexOnly, Integer pageSize)	Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.
RegisterArchitectJobResponse	postFlowsJobs(PostFlowsJobsRequest request)	Register Architect Job.
ApiResponse<RegisterArchitectJobResponse>	postFlowsJobs(ApiRequest<Object> request)	Register Architect Job.
RegisterArchitectJobResponse	postFlowsJobs(Object body)	Register Architect Job.
ApiResponse<RegisterArchitectJobResponse>	postFlowsJobsWithHttpInfo(Object body)	Register Architect Job.
FlowMilestone	postFlowsMilestones(PostFlowsMilestonesRequest request)	Create a flow milestone
ApiResponse<FlowMilestone>	postFlowsMilestones(ApiRequest<FlowMilestone> request)	Create a flow milestone
FlowMilestone	postFlowsMilestones(FlowMilestone body)	Create a flow milestone
ApiResponse<FlowMilestone>	postFlowsMilestonesWithHttpInfo(FlowMilestone body)	Create a flow milestone
FlowOutcome	postFlowsOutcomes(PostFlowsOutcomesRequest request)	Create a flow outcome Asynchronous.
ApiResponse<FlowOutcome>	postFlowsOutcomes(ApiRequest<FlowOutcome> request)	Create a flow outcome Asynchronous.
FlowOutcome	postFlowsOutcomes(FlowOutcome body)	Create a flow outcome Asynchronous.
ApiResponse<FlowOutcome>	postFlowsOutcomesWithHttpInfo(FlowOutcome body)	Create a flow outcome Asynchronous.
ApiResponse<Flow>	postFlowsWithHttpInfo(Flow body, String language)	Create flow
FlowVersion	postFlowVersions(PostFlowVersionsRequest request)	Create flow version
ApiResponse<FlowVersion>	postFlowVersions(ApiRequest<Object> request)	Create flow version
FlowVersion	postFlowVersions(String flowId, Object body)	Create flow version
ApiResponse<FlowVersion>	postFlowVersionsWithHttpInfo(String flowId, Object body)	Create flow version
EmergencyGroup	putArchitectEmergencygroup(PutArchitectEmergencygroupRequest request)	Updates a emergency group by ID
ApiResponse<EmergencyGroup>	putArchitectEmergencygroup(ApiRequest<EmergencyGroup> request)	Updates a emergency group by ID
EmergencyGroup	putArchitectEmergencygroup(String emergencyGroupId, EmergencyGroup body)	Updates a emergency group by ID
ApiResponse<EmergencyGroup>	putArchitectEmergencygroupWithHttpInfo(String emergencyGroupId, EmergencyGroup body)	Updates a emergency group by ID
IVR	putArchitectIvr(PutArchitectIvrRequest request)	Update an IVR Config.
ApiResponse<IVR>	putArchitectIvr(ApiRequest<IVR> request)	Update an IVR Config.
IVR	putArchitectIvr(String ivrId, IVR body)	Update an IVR Config.
IVRIdentityResolutionConfig	putArchitectIvrIdentityresolution(PutArchitectIvrIdentityresolutionRequest request)	Update an IVR IdentityResolutionConfig.
ApiResponse<IVRIdentityResolutionConfig>	putArchitectIvrIdentityresolution(ApiRequest<IVRIdentityResolutionConfig> request)	Update an IVR IdentityResolutionConfig.
IVRIdentityResolutionConfig	putArchitectIvrIdentityresolution(String ivrId, IVRIdentityResolutionConfig body)	Update an IVR IdentityResolutionConfig.
ApiResponse<IVRIdentityResolutionConfig>	putArchitectIvrIdentityresolutionWithHttpInfo(String ivrId, IVRIdentityResolutionConfig body)	Update an IVR IdentityResolutionConfig.
ApiResponse<IVR>	putArchitectIvrWithHttpInfo(String ivrId, IVR body)	Update an IVR Config.
Prompt	putArchitectPrompt(PutArchitectPromptRequest request)	Update specified user prompt
ApiResponse<Prompt>	putArchitectPrompt(ApiRequest<Prompt> request)	Update specified user prompt
Prompt	putArchitectPrompt(String promptId, Prompt body)	Update specified user prompt
PromptAsset	putArchitectPromptResource(PutArchitectPromptResourceRequest request)	Update specified user prompt resource
ApiResponse<PromptAsset>	putArchitectPromptResource(ApiRequest<PromptAsset> request)	Update specified user prompt resource
PromptAsset	putArchitectPromptResource(String promptId, String languageCode, PromptAsset body)	Update specified user prompt resource
ApiResponse<PromptAsset>	putArchitectPromptResourceWithHttpInfo(String promptId, String languageCode, PromptAsset body)	Update specified user prompt resource
ApiResponse<Prompt>	putArchitectPromptWithHttpInfo(String promptId, Prompt body)	Update specified user prompt
Schedule	putArchitectSchedule(PutArchitectScheduleRequest request)	Update schedule by ID
ApiResponse<Schedule>	putArchitectSchedule(ApiRequest<Schedule> request)	Update schedule by ID
Schedule	putArchitectSchedule(String scheduleId, Schedule body)	Update schedule by ID
ScheduleGroup	putArchitectSchedulegroup(PutArchitectSchedulegroupRequest request)	Updates a schedule group by ID
ApiResponse<ScheduleGroup>	putArchitectSchedulegroup(ApiRequest<ScheduleGroup> request)	Updates a schedule group by ID
ScheduleGroup	putArchitectSchedulegroup(String scheduleGroupId, ScheduleGroup body)	Updates a schedule group by ID
ApiResponse<ScheduleGroup>	putArchitectSchedulegroupWithHttpInfo(String scheduleGroupId, ScheduleGroup body)	Updates a schedule group by ID
ApiResponse<Schedule>	putArchitectScheduleWithHttpInfo(String scheduleId, Schedule body)	Update schedule by ID
SystemPromptAsset	putArchitectSystempromptResource(PutArchitectSystempromptResourceRequest request)	Updates a system prompt resource override.
ApiResponse<SystemPromptAsset>	putArchitectSystempromptResource(ApiRequest<SystemPromptAsset> request)	Updates a system prompt resource override.
SystemPromptAsset	putArchitectSystempromptResource(String promptId, String languageCode, SystemPromptAsset body)	Updates a system prompt resource override.
ApiResponse<SystemPromptAsset>	putArchitectSystempromptResourceWithHttpInfo(String promptId, String languageCode, SystemPromptAsset body)	Updates a system prompt resource override.
Flow	putFlow(PutFlowRequest request)	Update flow
ApiResponse<Flow>	putFlow(ApiRequest<Flow> request)	Update flow
Flow	putFlow(String flowId, Flow body)	Update flow
FlowSettingsResponse	putFlowInstancesSettingsLoglevels(PutFlowInstancesSettingsLoglevelsRequest request)	Edit the logLevel for a particular flow id Updates the loglevel for a flow id
ApiResponse<FlowSettingsResponse>	putFlowInstancesSettingsLoglevels(ApiRequest<FlowLogLevelRequest> request)	Edit the logLevel for a particular flow id Updates the loglevel for a flow id
FlowSettingsResponse	putFlowInstancesSettingsLoglevels(String flowId, FlowLogLevelRequest body, List<String> expand)	Edit the logLevel for a particular flow id Updates the loglevel for a flow id
ApiResponse<FlowSettingsResponse>	putFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId, FlowLogLevelRequest body, List<String> expand)	Edit the logLevel for a particular flow id Updates the loglevel for a flow id
DataTable	putFlowsDatatable(PutFlowsDatatableRequest request)	Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
ApiResponse<DataTable>	putFlowsDatatable(ApiRequest<DataTable> request)	Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
DataTable	putFlowsDatatable(String datatableId, DataTable body, String expand)	Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
Map<String,Object>	putFlowsDatatableRow(PutFlowsDatatableRowRequest request)	Update a row entry Updates a row with the given rowId (the value of the key field) to the new values.
ApiResponse<Map<String,Object>>	putFlowsDatatableRow(ApiRequest<Object> request)	Update a row entry Updates a row with the given rowId (the value of the key field) to the new values.
Map<String,Object>	putFlowsDatatableRow(String datatableId, String rowId, Object body)	Update a row entry Updates a row with the given rowId (the value of the key field) to the new values.
ApiResponse<Map<String,Object>>	putFlowsDatatableRowWithHttpInfo(String datatableId, String rowId, Object body)	Update a row entry Updates a row with the given rowId (the value of the key field) to the new values.
ApiResponse<DataTable>	putFlowsDatatableWithHttpInfo(String datatableId, DataTable body, String expand)	Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
FlowSettingsResponse	putFlowsInstancesSettingsLoglevelsDefault(PutFlowsInstancesSettingsLoglevelsDefaultRequest request)	Edit the flow default log level.
ApiResponse<FlowSettingsResponse>	putFlowsInstancesSettingsLoglevelsDefault(ApiRequest<FlowLogLevelRequest> request)	Edit the flow default log level.
FlowSettingsResponse	putFlowsInstancesSettingsLoglevelsDefault(FlowLogLevelRequest body, List<String> expand)	Edit the flow default log level.
ApiResponse<FlowSettingsResponse>	putFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo(FlowLogLevelRequest body, List<String> expand)	Edit the flow default log level.
FlowMilestone	putFlowsMilestone(PutFlowsMilestoneRequest request)	Updates a flow milestone
ApiResponse<FlowMilestone>	putFlowsMilestone(ApiRequest<FlowMilestone> request)	Updates a flow milestone
FlowMilestone	putFlowsMilestone(String milestoneId, FlowMilestone body)	Updates a flow milestone
ApiResponse<FlowMilestone>	putFlowsMilestoneWithHttpInfo(String milestoneId, FlowMilestone body)	Updates a flow milestone
Operation	putFlowsOutcome(PutFlowsOutcomeRequest request)	Updates a flow outcome Updates a flow outcome.
ApiResponse<Operation>	putFlowsOutcome(ApiRequest<FlowOutcome> request)	Updates a flow outcome Updates a flow outcome.
Operation	putFlowsOutcome(String flowOutcomeId, FlowOutcome body)	Updates a flow outcome Updates a flow outcome.
ApiResponse<Operation>	putFlowsOutcomeWithHttpInfo(String flowOutcomeId, FlowOutcome body)	Updates a flow outcome Updates a flow outcome.
ApiResponse<Flow>	putFlowWithHttpInfo(String flowId, Flow body)	Update flow

Methods inherited from class java.lang.Object

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

Constructor Details

ArchitectApi

public ArchitectApi()

ArchitectApi

public ArchitectApi(ApiClient apiClient)

Method Details

deleteArchitectEmergencygroup

public void deleteArchitectEmergencygroup(String emergencyGroupId)
                                   throws IOException,
ApiException

Deletes a emergency group by ID

Parameters:

emergencyGroupId - Emergency group ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectEmergencygroupWithHttpInfo

public ApiResponse<Void> deleteArchitectEmergencygroupWithHttpInfo(String emergencyGroupId)
                                                            throws IOException

Deletes a emergency group by ID

Parameters:

emergencyGroupId - Emergency group ID (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectEmergencygroup

public void deleteArchitectEmergencygroup(DeleteArchitectEmergencygroupRequest request)
                                   throws IOException,
ApiException

Deletes a emergency group by ID

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectEmergencygroup

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

Deletes a emergency group by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammar

public Empty deleteArchitectGrammar(String grammarId)
                             throws IOException,
ApiException

Delete a grammar.

Parameters:

grammarId - grammar ID (required)

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammarWithHttpInfo

public ApiResponse<Empty> deleteArchitectGrammarWithHttpInfo(String grammarId)
                                                      throws IOException

Delete a grammar.

Parameters:

grammarId - grammar ID (required)

Returns:

Empty

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammar

public Empty deleteArchitectGrammar(DeleteArchitectGrammarRequest request)
                             throws IOException,
ApiException

Delete a grammar.

Parameters:

request - The request object

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammar

public ApiResponse<Empty> deleteArchitectGrammar(ApiRequest<Void> request)
                                          throws IOException

Delete a grammar.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammarLanguage

public void deleteArchitectGrammarLanguage(String grammarId,
 String languageCode)
                                    throws IOException,
ApiException

Delete specified grammar language

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageWithHttpInfo

public ApiResponse<Void> deleteArchitectGrammarLanguageWithHttpInfo(String grammarId,
 String languageCode)
                                                             throws IOException

Delete specified grammar language

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammarLanguage

public void deleteArchitectGrammarLanguage(DeleteArchitectGrammarLanguageRequest request)
                                    throws IOException,
ApiException

Delete specified grammar language

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammarLanguage

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

Delete specified grammar language

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesDtmf

public void deleteArchitectGrammarLanguageFilesDtmf(String grammarId,
 String languageCode)
                                             throws IOException,
ApiException

Clear the DTMF mode file for the grammar language if there is one

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesDtmfWithHttpInfo

public ApiResponse<Void> deleteArchitectGrammarLanguageFilesDtmfWithHttpInfo(String grammarId,
 String languageCode)
                                                                      throws IOException

Clear the DTMF mode file for the grammar language if there is one

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesDtmf

public void deleteArchitectGrammarLanguageFilesDtmf(DeleteArchitectGrammarLanguageFilesDtmfRequest request)
                                             throws IOException,
ApiException

Clear the DTMF mode file for the grammar language if there is one

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesDtmf

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

Clear the DTMF mode file for the grammar language if there is one

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesVoice

public void deleteArchitectGrammarLanguageFilesVoice(String grammarId,
 String languageCode)
                                              throws IOException,
ApiException

Clear the voice mode file for the grammar language if there is one

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesVoiceWithHttpInfo

public ApiResponse<Void> deleteArchitectGrammarLanguageFilesVoiceWithHttpInfo(String grammarId,
 String languageCode)
                                                                       throws IOException

Clear the voice mode file for the grammar language if there is one

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesVoice

public void deleteArchitectGrammarLanguageFilesVoice(DeleteArchitectGrammarLanguageFilesVoiceRequest request)
                                              throws IOException,
ApiException

Clear the voice mode file for the grammar language if there is one

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectGrammarLanguageFilesVoice

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

Clear the voice mode file for the grammar language if there is one

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectIvr

public void deleteArchitectIvr(String ivrId)
                        throws IOException,
ApiException

Delete an IVR Config.

Parameters:

ivrId - IVR id (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectIvrWithHttpInfo

public ApiResponse<Void> deleteArchitectIvrWithHttpInfo(String ivrId)
                                                 throws IOException

Delete an IVR Config.

Parameters:

ivrId - IVR id (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectIvr

public void deleteArchitectIvr(DeleteArchitectIvrRequest request)
                        throws IOException,
ApiException

Delete an IVR Config.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectIvr

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

Delete an IVR Config.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectPrompt

public void deleteArchitectPrompt(String promptId,
 Boolean allResources)
                           throws IOException,
ApiException

Delete specified user prompt

Parameters:

promptId - Prompt ID (required)

allResources - Whether or not to delete all the prompt resources (optional)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPromptWithHttpInfo

public ApiResponse<Void> deleteArchitectPromptWithHttpInfo(String promptId,
 Boolean allResources)
                                                    throws IOException

Delete specified user prompt

Parameters:

promptId - Prompt ID (required)

allResources - Whether or not to delete all the prompt resources (optional)

Throws:

IOException - if the request fails to be processed

deleteArchitectPrompt

public void deleteArchitectPrompt(DeleteArchitectPromptRequest request)
                           throws IOException,
ApiException

Delete specified user prompt

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPrompt

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

Delete specified user prompt

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectPromptResource

public void deleteArchitectPromptResource(String promptId,
 String languageCode)
                                   throws IOException,
ApiException

Delete specified user prompt resource

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPromptResourceWithHttpInfo

public ApiResponse<Void> deleteArchitectPromptResourceWithHttpInfo(String promptId,
 String languageCode)
                                                            throws IOException

Delete specified user prompt resource

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectPromptResource

public void deleteArchitectPromptResource(DeleteArchitectPromptResourceRequest request)
                                   throws IOException,
ApiException

Delete specified user prompt resource

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPromptResource

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

Delete specified user prompt resource

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectPromptResourceAudio

public void deleteArchitectPromptResourceAudio(String promptId,
 String languageCode)
                                        throws IOException,
ApiException

Delete specified user prompt resource audio

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPromptResourceAudioWithHttpInfo

public ApiResponse<Void> deleteArchitectPromptResourceAudioWithHttpInfo(String promptId,
 String languageCode)
                                                                 throws IOException

Delete specified user prompt resource audio

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectPromptResourceAudio

public void deleteArchitectPromptResourceAudio(DeleteArchitectPromptResourceAudioRequest request)
                                        throws IOException,
ApiException

Delete specified user prompt resource audio

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPromptResourceAudio

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

Delete specified user prompt resource audio

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectPrompts

public Operation deleteArchitectPrompts(List<String> id)
                                 throws IOException,
ApiException

Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

id - List of Prompt IDs (required)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPromptsWithHttpInfo

public ApiResponse<Operation> deleteArchitectPromptsWithHttpInfo(List<String> id)
                                                          throws IOException

Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

id - List of Prompt IDs (required)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

deleteArchitectPrompts

public Operation deleteArchitectPrompts(DeleteArchitectPromptsRequest request)
                                 throws IOException,
ApiException

Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectPrompts

public ApiResponse<Operation> deleteArchitectPrompts(ApiRequest<Void> request)
                                              throws IOException

Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectSchedule

public void deleteArchitectSchedule(String scheduleId)
                             throws IOException,
ApiException

Delete a schedule by id

Parameters:

scheduleId - Schedule ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectScheduleWithHttpInfo

public ApiResponse<Void> deleteArchitectScheduleWithHttpInfo(String scheduleId)
                                                      throws IOException

Delete a schedule by id

Parameters:

scheduleId - Schedule ID (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectSchedule

public void deleteArchitectSchedule(DeleteArchitectScheduleRequest request)
                             throws IOException,
ApiException

Delete a schedule by id

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectSchedule

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

Delete a schedule by id

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectSchedulegroup

public void deleteArchitectSchedulegroup(String scheduleGroupId)
                                  throws IOException,
ApiException

Deletes a schedule group by ID

Parameters:

scheduleGroupId - Schedule group ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectSchedulegroupWithHttpInfo

public ApiResponse<Void> deleteArchitectSchedulegroupWithHttpInfo(String scheduleGroupId)
                                                           throws IOException

Deletes a schedule group by ID

Parameters:

scheduleGroupId - Schedule group ID (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectSchedulegroup

public void deleteArchitectSchedulegroup(DeleteArchitectSchedulegroupRequest request)
                                  throws IOException,
ApiException

Deletes a schedule group by ID

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectSchedulegroup

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

Deletes a schedule group by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteArchitectSystempromptResource

public void deleteArchitectSystempromptResource(String promptId,
 String languageCode)
                                         throws IOException,
ApiException

Delete a system prompt resource override.

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectSystempromptResourceWithHttpInfo

public ApiResponse<Void> deleteArchitectSystempromptResourceWithHttpInfo(String promptId,
 String languageCode)
                                                                  throws IOException

Delete a system prompt resource override.

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Throws:

IOException - if the request fails to be processed

deleteArchitectSystempromptResource

public void deleteArchitectSystempromptResource(DeleteArchitectSystempromptResourceRequest request)
                                         throws IOException,
ApiException

Delete a system prompt resource override.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteArchitectSystempromptResource

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

Delete a system prompt resource override.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteFlow

public void deleteFlow(String flowId)
                throws IOException,
ApiException

Delete flow

Parameters:

flowId - Flow ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowWithHttpInfo

public ApiResponse<Void> deleteFlowWithHttpInfo(String flowId)
                                         throws IOException

Delete flow

Parameters:

flowId - Flow ID (required)

Throws:

IOException - if the request fails to be processed

deleteFlow

public void deleteFlow(DeleteFlowRequest request)
                throws IOException,
ApiException

Delete flow

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlow

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

Delete flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteFlowInstancesSettingsLoglevels

public void deleteFlowInstancesSettingsLoglevels(String flowId)
                                          throws IOException,
ApiException

Deletes a log level for a flow by flow id. Deletes the associated log level for a flow by flow id

Parameters:

flowId - The flow id to delete the loglevel for (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowInstancesSettingsLoglevelsWithHttpInfo

public ApiResponse<Void> deleteFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId)
                                                                   throws IOException

Deletes a log level for a flow by flow id. Deletes the associated log level for a flow by flow id

Parameters:

flowId - The flow id to delete the loglevel for (required)

Throws:

IOException - if the request fails to be processed

deleteFlowInstancesSettingsLoglevels

public void deleteFlowInstancesSettingsLoglevels(DeleteFlowInstancesSettingsLoglevelsRequest request)
                                          throws IOException,
ApiException

Deletes a log level for a flow by flow id. Deletes the associated log level for a flow by flow id

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowInstancesSettingsLoglevels

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

Deletes a log level for a flow by flow id. Deletes the associated log level for a flow by flow id

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteFlows

public Operation deleteFlows(List<String> id)
                      throws IOException,
ApiException

Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

id - List of Flow IDs (required)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsWithHttpInfo

public ApiResponse<Operation> deleteFlowsWithHttpInfo(List<String> id)
                                               throws IOException

Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

id - List of Flow IDs (required)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

deleteFlows

public Operation deleteFlows(DeleteFlowsRequest request)
                      throws IOException,
ApiException

Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlows

public ApiResponse<Operation> deleteFlows(ApiRequest<Void> request)
                                   throws IOException

Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteFlowsDatatable

public void deleteFlowsDatatable(String datatableId,
 Boolean force)
                          throws IOException,
ApiException

deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId

Parameters:

datatableId - id of datatable (required)

force - force delete, even if in use (optional, default to false)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsDatatableWithHttpInfo

public ApiResponse<Void> deleteFlowsDatatableWithHttpInfo(String datatableId,
 Boolean force)
                                                   throws IOException

deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId

Parameters:

datatableId - id of datatable (required)

force - force delete, even if in use (optional, default to false)

Throws:

IOException - if the request fails to be processed

deleteFlowsDatatable

public void deleteFlowsDatatable(DeleteFlowsDatatableRequest request)
                          throws IOException,
ApiException

deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsDatatable

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

deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteFlowsDatatableRow

public void deleteFlowsDatatableRow(String datatableId,
 String rowId)
                             throws IOException,
ApiException

Delete a row entry Deletes a row with a given rowId (the value of the key field).

Parameters:

datatableId - id of datatable (required)

rowId - the key for the row (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsDatatableRowWithHttpInfo

public ApiResponse<Void> deleteFlowsDatatableRowWithHttpInfo(String datatableId,
 String rowId)
                                                      throws IOException

Delete a row entry Deletes a row with a given rowId (the value of the key field).

Parameters:

datatableId - id of datatable (required)

rowId - the key for the row (required)

Throws:

IOException - if the request fails to be processed

deleteFlowsDatatableRow

public void deleteFlowsDatatableRow(DeleteFlowsDatatableRowRequest request)
                             throws IOException,
ApiException

Delete a row entry Deletes a row with a given rowId (the value of the key field).

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsDatatableRow

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

Delete a row entry Deletes a row with a given rowId (the value of the key field).

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteFlowsInstancesSettingsLoglevelsDefault

public void deleteFlowsInstancesSettingsLoglevelsDefault()
                                                  throws IOException,
ApiException

Resets the org log level to default, base Resets the org log level to default, base

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo

public ApiResponse<Void> deleteFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo()
                                                                           throws IOException

Resets the org log level to default, base Resets the org log level to default, base

Throws:

IOException - if the request fails to be processed

deleteFlowsInstancesSettingsLoglevelsDefault

public void deleteFlowsInstancesSettingsLoglevelsDefault(DeleteFlowsInstancesSettingsLoglevelsDefaultRequest request)
                                                  throws IOException,
ApiException

Resets the org log level to default, base Resets the org log level to default, base

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsInstancesSettingsLoglevelsDefault

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

Resets the org log level to default, base Resets the org log level to default, base

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteFlowsMilestone

public Empty deleteFlowsMilestone(String milestoneId)
                           throws IOException,
ApiException

Delete a flow milestone.

Parameters:

milestoneId - flow milestone ID (required)

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsMilestoneWithHttpInfo

public ApiResponse<Empty> deleteFlowsMilestoneWithHttpInfo(String milestoneId)
                                                    throws IOException

Delete a flow milestone.

Parameters:

milestoneId - flow milestone ID (required)

Returns:

Empty

Throws:

IOException - if the request fails to be processed

deleteFlowsMilestone

public Empty deleteFlowsMilestone(DeleteFlowsMilestoneRequest request)
                           throws IOException,
ApiException

Delete a flow milestone.

Parameters:

request - The request object

Returns:

Empty

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteFlowsMilestone

public ApiResponse<Empty> deleteFlowsMilestone(ApiRequest<Void> request)
                                        throws IOException

Delete a flow milestone.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytracking

public DependencyObjectEntityListing getArchitectDependencytracking(String name,
 Integer pageNumber,
 Integer pageSize,
 List<String> objectType,
 Boolean consumedResources,
 Boolean consumingResources,
 List<String> consumedResourceType,
 List<String> consumingResourceType)
                                                             throws IOException,
ApiException

Get Dependency Tracking objects that have a given display name

Parameters:

name - Object name to search for (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

objectType - Object type(s) to search for (optional)

consumedResources - Include resources each result item consumes (optional)

consumingResources - Include resources that consume each result item (optional)

consumedResourceType - Types of consumed resources to return, if consumed resources are requested (optional)

consumingResourceType - Types of consuming resources to return, if consuming resources are requested (optional)

Returns:

DependencyObjectEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingWithHttpInfo

public ApiResponse<DependencyObjectEntityListing> getArchitectDependencytrackingWithHttpInfo(String name,
 Integer pageNumber,
 Integer pageSize,
 List<String> objectType,
 Boolean consumedResources,
 Boolean consumingResources,
 List<String> consumedResourceType,
 List<String> consumingResourceType)
                                                                                      throws IOException

Get Dependency Tracking objects that have a given display name

Parameters:

name - Object name to search for (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

objectType - Object type(s) to search for (optional)

consumedResources - Include resources each result item consumes (optional)

consumingResources - Include resources that consume each result item (optional)

consumedResourceType - Types of consumed resources to return, if consumed resources are requested (optional)

consumingResourceType - Types of consuming resources to return, if consuming resources are requested (optional)

Returns:

DependencyObjectEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectDependencytracking

public DependencyObjectEntityListing getArchitectDependencytracking(GetArchitectDependencytrackingRequest request)
                                                             throws IOException,
ApiException

Get Dependency Tracking objects that have a given display name

Parameters:

request - The request object

Returns:

DependencyObjectEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytracking

public ApiResponse<DependencyObjectEntityListing> getArchitectDependencytracking(ApiRequest<Void> request)
                                                                          throws IOException

Get Dependency Tracking objects that have a given display name

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingBuild

public DependencyStatus getArchitectDependencytrackingBuild()
                                                     throws IOException,
ApiException

Get Dependency Tracking build status for an organization

Returns:

DependencyStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingBuildWithHttpInfo

public ApiResponse<DependencyStatus> getArchitectDependencytrackingBuildWithHttpInfo()
                                                                              throws IOException

Get Dependency Tracking build status for an organization

Returns:

DependencyStatus

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingBuild

public DependencyStatus getArchitectDependencytrackingBuild(GetArchitectDependencytrackingBuildRequest request)
                                                     throws IOException,
ApiException

Get Dependency Tracking build status for an organization

Parameters:

request - The request object

Returns:

DependencyStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingBuild

public ApiResponse<DependencyStatus> getArchitectDependencytrackingBuild(ApiRequest<Void> request)
                                                                  throws IOException

Get Dependency Tracking build status for an organization

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumedresources

public ConsumedResourcesEntityListing getArchitectDependencytrackingConsumedresources(String id,
 String version,
 String objectType,
 List<String> resourceType,
 Integer pageNumber,
 Integer pageSize)
                                                                               throws IOException,
ApiException

Get resources that are consumed by a given Dependency Tracking object

Parameters:

id - Consuming object ID (required)

version - Consuming object version (required)

objectType - Consuming object type. Only versioned types are allowed here. (required)

resourceType - Types of consumed resources to show. (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

ConsumedResourcesEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumedresourcesWithHttpInfo

public ApiResponse<ConsumedResourcesEntityListing> getArchitectDependencytrackingConsumedresourcesWithHttpInfo(String id,
 String version,
 String objectType,
 List<String> resourceType,
 Integer pageNumber,
 Integer pageSize)
                                                                                                        throws IOException

Get resources that are consumed by a given Dependency Tracking object

Parameters:

id - Consuming object ID (required)

version - Consuming object version (required)

objectType - Consuming object type. Only versioned types are allowed here. (required)

resourceType - Types of consumed resources to show. (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

ConsumedResourcesEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumedresources

public ConsumedResourcesEntityListing getArchitectDependencytrackingConsumedresources(GetArchitectDependencytrackingConsumedresourcesRequest request)
                                                                               throws IOException,
ApiException

Get resources that are consumed by a given Dependency Tracking object

Parameters:

request - The request object

Returns:

ConsumedResourcesEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumedresources

public ApiResponse<ConsumedResourcesEntityListing> getArchitectDependencytrackingConsumedresources(ApiRequest<Void> request)
                                                                                            throws IOException

Get resources that are consumed by a given Dependency Tracking object

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumingresources

public ConsumingResourcesEntityListing getArchitectDependencytrackingConsumingresources(String id,
 String objectType,
 List<String> resourceType,
 String version,
 Integer pageNumber,
 Integer pageSize,
 String flowFilter)
                                                                                 throws IOException,
ApiException

Get resources that consume a given Dependency Tracking object

Parameters:

id - Consumed object ID (required)

objectType - Consumed object type (required)

resourceType - Types of consuming resources to show. Only versioned types are allowed here. (optional)

version - Object version (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

flowFilter - Show only checkedIn or published flows (optional)

Returns:

ConsumingResourcesEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumingresourcesWithHttpInfo

public ApiResponse<ConsumingResourcesEntityListing> getArchitectDependencytrackingConsumingresourcesWithHttpInfo(String id,
 String objectType,
 List<String> resourceType,
 String version,
 Integer pageNumber,
 Integer pageSize,
 String flowFilter)
                                                                                                          throws IOException

Get resources that consume a given Dependency Tracking object

Parameters:

id - Consumed object ID (required)

objectType - Consumed object type (required)

resourceType - Types of consuming resources to show. Only versioned types are allowed here. (optional)

version - Object version (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

flowFilter - Show only checkedIn or published flows (optional)

Returns:

ConsumingResourcesEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumingresources

public ConsumingResourcesEntityListing getArchitectDependencytrackingConsumingresources(GetArchitectDependencytrackingConsumingresourcesRequest request)
                                                                                 throws IOException,
ApiException

Get resources that consume a given Dependency Tracking object

Parameters:

request - The request object

Returns:

ConsumingResourcesEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingConsumingresources

public ApiResponse<ConsumingResourcesEntityListing> getArchitectDependencytrackingConsumingresources(ApiRequest<Void> request)
                                                                                              throws IOException

Get resources that consume a given Dependency Tracking object

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingDeletedresourceconsumers

public DependencyObjectEntityListing getArchitectDependencytrackingDeletedresourceconsumers(String name,
 List<String> objectType,
 String flowFilter,
 Boolean consumedResources,
 List<String> consumedResourceType,
 Integer pageNumber,
 Integer pageSize)
                                                                                     throws IOException,
ApiException

Get Dependency Tracking objects that consume deleted resources

Parameters:

name - Name to search for (optional)

objectType - Object type(s) to search for (optional)

flowFilter - Show only checkedIn or published flows (optional)

consumedResources - Return consumed resources? (optional, default to false)

consumedResourceType - Resource type(s) to return (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DependencyObjectEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingDeletedresourceconsumersWithHttpInfo

public ApiResponse<DependencyObjectEntityListing> getArchitectDependencytrackingDeletedresourceconsumersWithHttpInfo(String name,
 List<String> objectType,
 String flowFilter,
 Boolean consumedResources,
 List<String> consumedResourceType,
 Integer pageNumber,
 Integer pageSize)
                                                                                                              throws IOException

Get Dependency Tracking objects that consume deleted resources

Parameters:

name - Name to search for (optional)

objectType - Object type(s) to search for (optional)

flowFilter - Show only checkedIn or published flows (optional)

consumedResources - Return consumed resources? (optional, default to false)

consumedResourceType - Resource type(s) to return (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DependencyObjectEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingDeletedresourceconsumers

public DependencyObjectEntityListing getArchitectDependencytrackingDeletedresourceconsumers(GetArchitectDependencytrackingDeletedresourceconsumersRequest request)
                                                                                     throws IOException,
ApiException

Get Dependency Tracking objects that consume deleted resources

Parameters:

request - The request object

Returns:

DependencyObjectEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingDeletedresourceconsumers

public ApiResponse<DependencyObjectEntityListing> getArchitectDependencytrackingDeletedresourceconsumers(ApiRequest<Void> request)
                                                                                                  throws IOException

Get Dependency Tracking objects that consume deleted resources

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingObject

public DependencyObject getArchitectDependencytrackingObject(String id,
 String version,
 String objectType,
 Boolean consumedResources,
 Boolean consumingResources,
 List<String> consumedResourceType,
 List<String> consumingResourceType,
 Boolean consumedResourceRequest)
                                                      throws IOException,
ApiException

Get a Dependency Tracking object

Parameters:

id - Object ID (required)

version - Object version (optional)

objectType - Object type (optional)

consumedResources - Include resources this item consumes (optional)

consumingResources - Include resources that consume this item (optional)

consumedResourceType - Types of consumed resources to return, if consumed resources are requested (optional)

consumingResourceType - Types of consuming resources to return, if consuming resources are requested (optional)

consumedResourceRequest - Indicate that this is going to look up a consumed resource object (optional)

Returns:

DependencyObject

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingObjectWithHttpInfo

public ApiResponse<DependencyObject> getArchitectDependencytrackingObjectWithHttpInfo(String id,
 String version,
 String objectType,
 Boolean consumedResources,
 Boolean consumingResources,
 List<String> consumedResourceType,
 List<String> consumingResourceType,
 Boolean consumedResourceRequest)
                                                                               throws IOException

Get a Dependency Tracking object

Parameters:

id - Object ID (required)

version - Object version (optional)

objectType - Object type (optional)

consumedResources - Include resources this item consumes (optional)

consumingResources - Include resources that consume this item (optional)

consumedResourceType - Types of consumed resources to return, if consumed resources are requested (optional)

consumingResourceType - Types of consuming resources to return, if consuming resources are requested (optional)

consumedResourceRequest - Indicate that this is going to look up a consumed resource object (optional)

Returns:

DependencyObject

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingObject

public DependencyObject getArchitectDependencytrackingObject(GetArchitectDependencytrackingObjectRequest request)
                                                      throws IOException,
ApiException

Get a Dependency Tracking object

Parameters:

request - The request object

Returns:

DependencyObject

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingObject

public ApiResponse<DependencyObject> getArchitectDependencytrackingObject(ApiRequest<Void> request)
                                                                   throws IOException

Get a Dependency Tracking object

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingType

public DependencyType getArchitectDependencytrackingType(String typeId)
                                                  throws IOException,
ApiException

Get a Dependency Tracking type.

Parameters:

typeId - Type ID (required)

Returns:

DependencyType

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingTypeWithHttpInfo

public ApiResponse<DependencyType> getArchitectDependencytrackingTypeWithHttpInfo(String typeId)
                                                                           throws IOException

Get a Dependency Tracking type.

Parameters:

typeId - Type ID (required)

Returns:

DependencyType

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingType

public DependencyType getArchitectDependencytrackingType(GetArchitectDependencytrackingTypeRequest request)
                                                  throws IOException,
ApiException

Get a Dependency Tracking type.

Parameters:

request - The request object

Returns:

DependencyType

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingType

public ApiResponse<DependencyType> getArchitectDependencytrackingType(ApiRequest<Void> request)
                                                               throws IOException

Get a Dependency Tracking type.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingTypes

public DependencyTypeEntityListing getArchitectDependencytrackingTypes(Integer pageNumber,
 Integer pageSize)
                                                                throws IOException,
ApiException

Get Dependency Tracking types.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DependencyTypeEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingTypesWithHttpInfo

public ApiResponse<DependencyTypeEntityListing> getArchitectDependencytrackingTypesWithHttpInfo(Integer pageNumber,
 Integer pageSize)
                                                                                         throws IOException

Get Dependency Tracking types.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DependencyTypeEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingTypes

public DependencyTypeEntityListing getArchitectDependencytrackingTypes(GetArchitectDependencytrackingTypesRequest request)
                                                                throws IOException,
ApiException

Get Dependency Tracking types.

Parameters:

request - The request object

Returns:

DependencyTypeEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingTypes

public ApiResponse<DependencyTypeEntityListing> getArchitectDependencytrackingTypes(ApiRequest<Void> request)
                                                                             throws IOException

Get Dependency Tracking types.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingUpdatedresourceconsumers

public DependencyObjectEntityListing getArchitectDependencytrackingUpdatedresourceconsumers(String name,
 List<String> objectType,
 Boolean consumedResources,
 List<String> consumedResourceType,
 Integer pageNumber,
 Integer pageSize)
                                                                                     throws IOException,
ApiException

Get Dependency Tracking objects that depend on updated resources

Parameters:

name - Name to search for (optional)

objectType - Object type(s) to search for (optional)

consumedResources - Return consumed resources? (optional, default to false)

consumedResourceType - Resource type(s) to return (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DependencyObjectEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingUpdatedresourceconsumersWithHttpInfo

public ApiResponse<DependencyObjectEntityListing> getArchitectDependencytrackingUpdatedresourceconsumersWithHttpInfo(String name,
 List<String> objectType,
 Boolean consumedResources,
 List<String> consumedResourceType,
 Integer pageNumber,
 Integer pageSize)
                                                                                                              throws IOException

Get Dependency Tracking objects that depend on updated resources

Parameters:

name - Name to search for (optional)

objectType - Object type(s) to search for (optional)

consumedResources - Return consumed resources? (optional, default to false)

consumedResourceType - Resource type(s) to return (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DependencyObjectEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectDependencytrackingUpdatedresourceconsumers

public DependencyObjectEntityListing getArchitectDependencytrackingUpdatedresourceconsumers(GetArchitectDependencytrackingUpdatedresourceconsumersRequest request)
                                                                                     throws IOException,
ApiException

Get Dependency Tracking objects that depend on updated resources

Parameters:

request - The request object

Returns:

DependencyObjectEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectDependencytrackingUpdatedresourceconsumers

public ApiResponse<DependencyObjectEntityListing> getArchitectDependencytrackingUpdatedresourceconsumers(ApiRequest<Void> request)
                                                                                                  throws IOException

Get Dependency Tracking objects that depend on updated resources

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectEmergencygroup

public EmergencyGroup getArchitectEmergencygroup(String emergencyGroupId)
                                          throws IOException,
ApiException

Gets a emergency group by ID

Parameters:

emergencyGroupId - Emergency group ID (required)

Returns:

EmergencyGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectEmergencygroupWithHttpInfo

public ApiResponse<EmergencyGroup> getArchitectEmergencygroupWithHttpInfo(String emergencyGroupId)
                                                                   throws IOException

Gets a emergency group by ID

Parameters:

emergencyGroupId - Emergency group ID (required)

Returns:

EmergencyGroup

Throws:

IOException - if the request fails to be processed

getArchitectEmergencygroup

public EmergencyGroup getArchitectEmergencygroup(GetArchitectEmergencygroupRequest request)
                                          throws IOException,
ApiException

Gets a emergency group by ID

Parameters:

request - The request object

Returns:

EmergencyGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectEmergencygroup

public ApiResponse<EmergencyGroup> getArchitectEmergencygroup(ApiRequest<Void> request)
                                                       throws IOException

Gets a emergency group by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectEmergencygroups

public EmergencyGroupListing getArchitectEmergencygroups(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name)
                                                  throws IOException,
ApiException

Get a list of emergency groups.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

name - Name of the Emergency Group to filter by. (optional)

Returns:

EmergencyGroupListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectEmergencygroupsWithHttpInfo

public ApiResponse<EmergencyGroupListing> getArchitectEmergencygroupsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name)
                                                                           throws IOException

Get a list of emergency groups.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

name - Name of the Emergency Group to filter by. (optional)

Returns:

EmergencyGroupListing

Throws:

IOException - if the request fails to be processed

getArchitectEmergencygroups

public EmergencyGroupListing getArchitectEmergencygroups(GetArchitectEmergencygroupsRequest request)
                                                  throws IOException,
ApiException

Get a list of emergency groups.

Parameters:

request - The request object

Returns:

EmergencyGroupListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectEmergencygroups

public ApiResponse<EmergencyGroupListing> getArchitectEmergencygroups(ApiRequest<Void> request)
                                                               throws IOException

Get a list of emergency groups.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectEmergencygroupsDivisionviews

public EmergencyGroupDivisionViewEntityListing getArchitectEmergencygroupsDivisionviews(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                                 throws IOException,
ApiException

Get a pageable list of basic emergency group objects filterable by query parameters. This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the Emergency Groups to filter by. (optional)

name - Name of the Emergency Group to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

EmergencyGroupDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectEmergencygroupsDivisionviewsWithHttpInfo

public ApiResponse<EmergencyGroupDivisionViewEntityListing> getArchitectEmergencygroupsDivisionviewsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                                                          throws IOException

Get a pageable list of basic emergency group objects filterable by query parameters. This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the Emergency Groups to filter by. (optional)

name - Name of the Emergency Group to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

EmergencyGroupDivisionViewEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectEmergencygroupsDivisionviews

public EmergencyGroupDivisionViewEntityListing getArchitectEmergencygroupsDivisionviews(GetArchitectEmergencygroupsDivisionviewsRequest request)
                                                                                 throws IOException,
ApiException

Get a pageable list of basic emergency group objects filterable by query parameters. This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

EmergencyGroupDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectEmergencygroupsDivisionviews

public ApiResponse<EmergencyGroupDivisionViewEntityListing> getArchitectEmergencygroupsDivisionviews(ApiRequest<Void> request)
                                                                                              throws IOException

Get a pageable list of basic emergency group objects filterable by query parameters. This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectGrammar

public Grammar getArchitectGrammar(String grammarId,
 Boolean includeFileUrls)
                            throws IOException,
ApiException

Get a grammar Returns a specified grammar

Parameters:

grammarId - grammar ID (required)

includeFileUrls - Include grammar language file URLs (optional)

Returns:

Grammar

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectGrammarWithHttpInfo

public ApiResponse<Grammar> getArchitectGrammarWithHttpInfo(String grammarId,
 Boolean includeFileUrls)
                                                     throws IOException

Get a grammar Returns a specified grammar

Parameters:

grammarId - grammar ID (required)

includeFileUrls - Include grammar language file URLs (optional)

Returns:

Grammar

Throws:

IOException - if the request fails to be processed

getArchitectGrammar

public Grammar getArchitectGrammar(GetArchitectGrammarRequest request)
                            throws IOException,
ApiException

Get a grammar Returns a specified grammar

Parameters:

request - The request object

Returns:

Grammar

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectGrammar

public ApiResponse<Grammar> getArchitectGrammar(ApiRequest<Void> request)
                                         throws IOException

Get a grammar Returns a specified grammar

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectGrammarLanguage

public GrammarLanguage getArchitectGrammarLanguage(String grammarId,
 String languageCode)
                                            throws IOException,
ApiException

Get a grammar language.

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Returns:

GrammarLanguage

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectGrammarLanguageWithHttpInfo

public ApiResponse<GrammarLanguage> getArchitectGrammarLanguageWithHttpInfo(String grammarId,
 String languageCode)
                                                                     throws IOException

Get a grammar language.

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

Returns:

GrammarLanguage

Throws:

IOException - if the request fails to be processed

getArchitectGrammarLanguage

public GrammarLanguage getArchitectGrammarLanguage(GetArchitectGrammarLanguageRequest request)
                                            throws IOException,
ApiException

Get a grammar language.

Parameters:

request - The request object

Returns:

GrammarLanguage

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectGrammarLanguage

public ApiResponse<GrammarLanguage> getArchitectGrammarLanguage(ApiRequest<Void> request)
                                                         throws IOException

Get a grammar language.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectGrammars

public GrammarListing getArchitectGrammars(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 Boolean includeFileUrls)
                                    throws IOException,
ApiException

Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

includeFileUrls - Include grammar language file URLs (optional)

Returns:

GrammarListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectGrammarsWithHttpInfo

public ApiResponse<GrammarListing> getArchitectGrammarsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 Boolean includeFileUrls)
                                                             throws IOException

Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

includeFileUrls - Include grammar language file URLs (optional)

Returns:

GrammarListing

Throws:

IOException - if the request fails to be processed

getArchitectGrammars

public GrammarListing getArchitectGrammars(GetArchitectGrammarsRequest request)
                                    throws IOException,
ApiException

Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.

Parameters:

request - The request object

Returns:

GrammarListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectGrammars

public ApiResponse<GrammarListing> getArchitectGrammars(ApiRequest<Void> request)
                                                 throws IOException

Get a pageable list of grammars, filtered by query parameters Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectIvr

public IVR getArchitectIvr(String ivrId)
                    throws IOException,
ApiException

Get an IVR config.

Parameters:

ivrId - IVR id (required)

Returns:

IVR

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvrWithHttpInfo

public ApiResponse<IVR> getArchitectIvrWithHttpInfo(String ivrId)
                                             throws IOException

Get an IVR config.

Parameters:

ivrId - IVR id (required)

Returns:

IVR

Throws:

IOException - if the request fails to be processed

getArchitectIvr

public IVR getArchitectIvr(GetArchitectIvrRequest request)
                    throws IOException,
ApiException

Get an IVR config.

Parameters:

request - The request object

Returns:

IVR

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvr

public ApiResponse<IVR> getArchitectIvr(ApiRequest<Void> request)
                                 throws IOException

Get an IVR config.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectIvrIdentityresolution

public IVRIdentityResolutionConfig getArchitectIvrIdentityresolution(String ivrId)
                                                              throws IOException,
ApiException

Get an IVR IdentityResolutionConfig.

Parameters:

ivrId - IVR id (required)

Returns:

IVRIdentityResolutionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvrIdentityresolutionWithHttpInfo

public ApiResponse<IVRIdentityResolutionConfig> getArchitectIvrIdentityresolutionWithHttpInfo(String ivrId)
                                                                                       throws IOException

Get an IVR IdentityResolutionConfig.

Parameters:

ivrId - IVR id (required)

Returns:

IVRIdentityResolutionConfig

Throws:

IOException - if the request fails to be processed

getArchitectIvrIdentityresolution

public IVRIdentityResolutionConfig getArchitectIvrIdentityresolution(GetArchitectIvrIdentityresolutionRequest request)
                                                              throws IOException,
ApiException

Get an IVR IdentityResolutionConfig.

Parameters:

request - The request object

Returns:

IVRIdentityResolutionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvrIdentityresolution

public ApiResponse<IVRIdentityResolutionConfig> getArchitectIvrIdentityresolution(ApiRequest<Void> request)
                                                                           throws IOException

Get an IVR IdentityResolutionConfig.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectIvrs

public IVREntityListing getArchitectIvrs(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 String dnis,
 String scheduleGroup,
 List<String> expand)
                                  throws IOException,
ApiException

Get IVR configs.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

name - Name of the IVR to filter by. (optional)

dnis - The phone number of the IVR to filter by. (optional)

scheduleGroup - The Schedule Group of the IVR to filter by. (optional)

expand - Which fields, if any, to expand (optional)

Returns:

IVREntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvrsWithHttpInfo

public ApiResponse<IVREntityListing> getArchitectIvrsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 String dnis,
 String scheduleGroup,
 List<String> expand)
                                                           throws IOException

Get IVR configs.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

name - Name of the IVR to filter by. (optional)

dnis - The phone number of the IVR to filter by. (optional)

scheduleGroup - The Schedule Group of the IVR to filter by. (optional)

expand - Which fields, if any, to expand (optional)

Returns:

IVREntityListing

Throws:

IOException - if the request fails to be processed

getArchitectIvrs

public IVREntityListing getArchitectIvrs(GetArchitectIvrsRequest request)
                                  throws IOException,
ApiException

Get IVR configs.

Parameters:

request - The request object

Returns:

IVREntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvrs

public ApiResponse<IVREntityListing> getArchitectIvrs(ApiRequest<Void> request)
                                               throws IOException

Get IVR configs.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectIvrsDivisionviews

public IVRDivisionViewEntityListing getArchitectIvrsDivisionviews(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                           throws IOException,
ApiException

Get a pageable list of basic ivr configuration information objects filterable by query parameters.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the IVR to filter by. (optional)

name - Name of the IVR to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

IVRDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvrsDivisionviewsWithHttpInfo

public ApiResponse<IVRDivisionViewEntityListing> getArchitectIvrsDivisionviewsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                                    throws IOException

Get a pageable list of basic ivr configuration information objects filterable by query parameters.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the IVR to filter by. (optional)

name - Name of the IVR to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

IVRDivisionViewEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectIvrsDivisionviews

public IVRDivisionViewEntityListing getArchitectIvrsDivisionviews(GetArchitectIvrsDivisionviewsRequest request)
                                                           throws IOException,
ApiException

Get a pageable list of basic ivr configuration information objects filterable by query parameters.

Parameters:

request - The request object

Returns:

IVRDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectIvrsDivisionviews

public ApiResponse<IVRDivisionViewEntityListing> getArchitectIvrsDivisionviews(ApiRequest<Void> request)
                                                                        throws IOException

Get a pageable list of basic ivr configuration information objects filterable by query parameters.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectPrompt

public Prompt getArchitectPrompt(String promptId,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                          throws IOException,
ApiException

Get specified user prompt

Parameters:

promptId - Prompt ID (required)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

Prompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptWithHttpInfo

public ApiResponse<Prompt> getArchitectPromptWithHttpInfo(String promptId,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                                                   throws IOException

Get specified user prompt

Parameters:

promptId - Prompt ID (required)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

Prompt

Throws:

IOException - if the request fails to be processed

getArchitectPrompt

public Prompt getArchitectPrompt(GetArchitectPromptRequest request)
                          throws IOException,
ApiException

Get specified user prompt

Parameters:

request - The request object

Returns:

Prompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPrompt

public ApiResponse<Prompt> getArchitectPrompt(ApiRequest<Void> request)
                                       throws IOException

Get specified user prompt

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectPromptHistoryHistoryId

public HistoryListing getArchitectPromptHistoryHistoryId(String promptId,
 String historyId,
 Integer pageNumber,
 Integer pageSize,
 String sortOrder,
 String sortBy,
 List<String> action)
                                                  throws IOException,
ApiException

Get generated prompt history

Parameters:

promptId - Prompt ID (required)

historyId - History request ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortOrder - Sort order (optional, default to desc)

sortBy - Sort by (optional, default to timestamp)

action - Flow actions to include (omit to include all) (optional)

Returns:

HistoryListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptHistoryHistoryIdWithHttpInfo

public ApiResponse<HistoryListing> getArchitectPromptHistoryHistoryIdWithHttpInfo(String promptId,
 String historyId,
 Integer pageNumber,
 Integer pageSize,
 String sortOrder,
 String sortBy,
 List<String> action)
                                                                           throws IOException

Get generated prompt history

Parameters:

promptId - Prompt ID (required)

historyId - History request ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortOrder - Sort order (optional, default to desc)

sortBy - Sort by (optional, default to timestamp)

action - Flow actions to include (omit to include all) (optional)

Returns:

HistoryListing

Throws:

IOException - if the request fails to be processed

getArchitectPromptHistoryHistoryId

public HistoryListing getArchitectPromptHistoryHistoryId(GetArchitectPromptHistoryHistoryIdRequest request)
                                                  throws IOException,
ApiException

Get generated prompt history

Parameters:

request - The request object

Returns:

HistoryListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptHistoryHistoryId

public ApiResponse<HistoryListing> getArchitectPromptHistoryHistoryId(ApiRequest<Void> request)
                                                               throws IOException

Get generated prompt history

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectPromptResource

public PromptAsset getArchitectPromptResource(String promptId,
 String languageCode)
                                       throws IOException,
ApiException

Get specified user prompt resource

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

PromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptResourceWithHttpInfo

public ApiResponse<PromptAsset> getArchitectPromptResourceWithHttpInfo(String promptId,
 String languageCode)
                                                                throws IOException

Get specified user prompt resource

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

PromptAsset

Throws:

IOException - if the request fails to be processed

getArchitectPromptResource

public PromptAsset getArchitectPromptResource(GetArchitectPromptResourceRequest request)
                                       throws IOException,
ApiException

Get specified user prompt resource

Parameters:

request - The request object

Returns:

PromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptResource

public ApiResponse<PromptAsset> getArchitectPromptResource(ApiRequest<Void> request)
                                                    throws IOException

Get specified user prompt resource

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectPromptResources

public PromptAssetEntityListing getArchitectPromptResources(String promptId,
 Integer pageNumber,
 Integer pageSize)
                                                     throws IOException,
ApiException

Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.

Parameters:

promptId - Prompt ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

PromptAssetEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptResourcesWithHttpInfo

public ApiResponse<PromptAssetEntityListing> getArchitectPromptResourcesWithHttpInfo(String promptId,
 Integer pageNumber,
 Integer pageSize)
                                                                              throws IOException

Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.

Parameters:

promptId - Prompt ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

PromptAssetEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectPromptResources

public PromptAssetEntityListing getArchitectPromptResources(GetArchitectPromptResourcesRequest request)
                                                     throws IOException,
ApiException

Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.

Parameters:

request - The request object

Returns:

PromptAssetEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptResources

public ApiResponse<PromptAssetEntityListing> getArchitectPromptResources(ApiRequest<Void> request)
                                                                  throws IOException

Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectPrompts

public PromptEntityListing getArchitectPrompts(Integer pageNumber,
 Integer pageSize,
 List<String> name,
 String description,
 String nameOrDescription,
 String sortBy,
 String sortOrder,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                                        throws IOException,
ApiException

Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

PromptEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPromptsWithHttpInfo

public ApiResponse<PromptEntityListing> getArchitectPromptsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 List<String> name,
 String description,
 String nameOrDescription,
 String sortBy,
 String sortOrder,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                                                                 throws IOException

Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

PromptEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectPrompts

public PromptEntityListing getArchitectPrompts(GetArchitectPromptsRequest request)
                                        throws IOException,
ApiException

Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

Parameters:

request - The request object

Returns:

PromptEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectPrompts

public ApiResponse<PromptEntityListing> getArchitectPrompts(ApiRequest<Void> request)
                                                     throws IOException

Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSchedule

public Schedule getArchitectSchedule(String scheduleId)
                              throws IOException,
ApiException

Get a schedule by ID

Parameters:

scheduleId - Schedule ID (required)

Returns:

Schedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectScheduleWithHttpInfo

public ApiResponse<Schedule> getArchitectScheduleWithHttpInfo(String scheduleId)
                                                       throws IOException

Get a schedule by ID

Parameters:

scheduleId - Schedule ID (required)

Returns:

Schedule

Throws:

IOException - if the request fails to be processed

getArchitectSchedule

public Schedule getArchitectSchedule(GetArchitectScheduleRequest request)
                              throws IOException,
ApiException

Get a schedule by ID

Parameters:

request - The request object

Returns:

Schedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedule

public ApiResponse<Schedule> getArchitectSchedule(ApiRequest<Void> request)
                                           throws IOException

Get a schedule by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSchedulegroup

public ScheduleGroup getArchitectSchedulegroup(String scheduleGroupId)
                                        throws IOException,
ApiException

Gets a schedule group by ID

Parameters:

scheduleGroupId - Schedule group ID (required)

Returns:

ScheduleGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulegroupWithHttpInfo

public ApiResponse<ScheduleGroup> getArchitectSchedulegroupWithHttpInfo(String scheduleGroupId)
                                                                 throws IOException

Gets a schedule group by ID

Parameters:

scheduleGroupId - Schedule group ID (required)

Returns:

ScheduleGroup

Throws:

IOException - if the request fails to be processed

getArchitectSchedulegroup

public ScheduleGroup getArchitectSchedulegroup(GetArchitectSchedulegroupRequest request)
                                        throws IOException,
ApiException

Gets a schedule group by ID

Parameters:

request - The request object

Returns:

ScheduleGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulegroup

public ApiResponse<ScheduleGroup> getArchitectSchedulegroup(ApiRequest<Void> request)
                                                     throws IOException

Gets a schedule group by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSchedulegroups

public ScheduleGroupEntityListing getArchitectSchedulegroups(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 String scheduleIds,
 List<String> divisionId)
                                                      throws IOException,
ApiException

Get a list of schedule groups.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

name - Name of the Schedule Group to filter by. (optional)

scheduleIds - A comma-delimited list of Schedule IDs to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleGroupEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulegroupsWithHttpInfo

public ApiResponse<ScheduleGroupEntityListing> getArchitectSchedulegroupsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 String scheduleIds,
 List<String> divisionId)
                                                                               throws IOException

Get a list of schedule groups.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

name - Name of the Schedule Group to filter by. (optional)

scheduleIds - A comma-delimited list of Schedule IDs to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleGroupEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectSchedulegroups

public ScheduleGroupEntityListing getArchitectSchedulegroups(GetArchitectSchedulegroupsRequest request)
                                                      throws IOException,
ApiException

Get a list of schedule groups.

Parameters:

request - The request object

Returns:

ScheduleGroupEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulegroups

public ApiResponse<ScheduleGroupEntityListing> getArchitectSchedulegroups(ApiRequest<Void> request)
                                                                   throws IOException

Get a list of schedule groups.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSchedulegroupsDivisionviews

public ScheduleGroupDivisionViewEntityListing getArchitectSchedulegroupsDivisionviews(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                               throws IOException,
ApiException

Get a pageable list of basic schedule group configuration information objects filterable by query parameters.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the schedule group to filter by. (optional)

name - Name of the schedule group to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleGroupDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulegroupsDivisionviewsWithHttpInfo

public ApiResponse<ScheduleGroupDivisionViewEntityListing> getArchitectSchedulegroupsDivisionviewsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                                                        throws IOException

Get a pageable list of basic schedule group configuration information objects filterable by query parameters.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the schedule group to filter by. (optional)

name - Name of the schedule group to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleGroupDivisionViewEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectSchedulegroupsDivisionviews

public ScheduleGroupDivisionViewEntityListing getArchitectSchedulegroupsDivisionviews(GetArchitectSchedulegroupsDivisionviewsRequest request)
                                                                               throws IOException,
ApiException

Get a pageable list of basic schedule group configuration information objects filterable by query parameters.

Parameters:

request - The request object

Returns:

ScheduleGroupDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulegroupsDivisionviews

public ApiResponse<ScheduleGroupDivisionViewEntityListing> getArchitectSchedulegroupsDivisionviews(ApiRequest<Void> request)
                                                                                            throws IOException

Get a pageable list of basic schedule group configuration information objects filterable by query parameters.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSchedules

public ScheduleEntityListing getArchitectSchedules(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 List<String> divisionId)
                                            throws IOException,
ApiException

Get a list of schedules.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to asc)

name - Name of the Schedule to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulesWithHttpInfo

public ApiResponse<ScheduleEntityListing> getArchitectSchedulesWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 List<String> divisionId)
                                                                     throws IOException

Get a list of schedules.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to asc)

name - Name of the Schedule to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectSchedules

public ScheduleEntityListing getArchitectSchedules(GetArchitectSchedulesRequest request)
                                            throws IOException,
ApiException

Get a list of schedules.

Parameters:

request - The request object

Returns:

ScheduleEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedules

public ApiResponse<ScheduleEntityListing> getArchitectSchedules(ApiRequest<Void> request)
                                                         throws IOException

Get a list of schedules.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSchedulesDivisionviews

public ScheduleDivisionViewEntityListing getArchitectSchedulesDivisionviews(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                     throws IOException,
ApiException

Get a pageable list of basic schedule configuration information objects filterable by query parameters.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the schedule group to filter by. (optional)

name - Name of the schedule group to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulesDivisionviewsWithHttpInfo

public ApiResponse<ScheduleDivisionViewEntityListing> getArchitectSchedulesDivisionviewsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                                              throws IOException

Get a pageable list of basic schedule configuration information objects filterable by query parameters.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to name)

sortOrder - Sort order (optional, default to ASC)

id - ID of the schedule group to filter by. (optional)

name - Name of the schedule group to filter by. (optional)

divisionId - List of divisionIds on which to filter. (optional)

Returns:

ScheduleDivisionViewEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectSchedulesDivisionviews

public ScheduleDivisionViewEntityListing getArchitectSchedulesDivisionviews(GetArchitectSchedulesDivisionviewsRequest request)
                                                                     throws IOException,
ApiException

Get a pageable list of basic schedule configuration information objects filterable by query parameters.

Parameters:

request - The request object

Returns:

ScheduleDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSchedulesDivisionviews

public ApiResponse<ScheduleDivisionViewEntityListing> getArchitectSchedulesDivisionviews(ApiRequest<Void> request)
                                                                                  throws IOException

Get a pageable list of basic schedule configuration information objects filterable by query parameters.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSystemprompt

public SystemPrompt getArchitectSystemprompt(String promptId,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                                      throws IOException,
ApiException

Get a system prompt

Parameters:

promptId - promptId (required)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

SystemPrompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptWithHttpInfo

public ApiResponse<SystemPrompt> getArchitectSystempromptWithHttpInfo(String promptId,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                                                               throws IOException

Get a system prompt

Parameters:

promptId - promptId (required)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

SystemPrompt

Throws:

IOException - if the request fails to be processed

getArchitectSystemprompt

public SystemPrompt getArchitectSystemprompt(GetArchitectSystempromptRequest request)
                                      throws IOException,
ApiException

Get a system prompt

Parameters:

request - The request object

Returns:

SystemPrompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystemprompt

public ApiResponse<SystemPrompt> getArchitectSystemprompt(ApiRequest<Void> request)
                                                   throws IOException

Get a system prompt

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSystempromptHistoryHistoryId

public HistoryListing getArchitectSystempromptHistoryHistoryId(String promptId,
 String historyId,
 Integer pageNumber,
 Integer pageSize,
 String sortOrder,
 String sortBy,
 List<String> action)
                                                        throws IOException,
ApiException

Get generated prompt history

Parameters:

promptId - promptId (required)

historyId - History request ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortOrder - Sort order (optional, default to desc)

sortBy - Sort by (optional, default to timestamp)

action - Flow actions to include (omit to include all) (optional)

Returns:

HistoryListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptHistoryHistoryIdWithHttpInfo

public ApiResponse<HistoryListing> getArchitectSystempromptHistoryHistoryIdWithHttpInfo(String promptId,
 String historyId,
 Integer pageNumber,
 Integer pageSize,
 String sortOrder,
 String sortBy,
 List<String> action)
                                                                                 throws IOException

Get generated prompt history

Parameters:

promptId - promptId (required)

historyId - History request ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortOrder - Sort order (optional, default to desc)

sortBy - Sort by (optional, default to timestamp)

action - Flow actions to include (omit to include all) (optional)

Returns:

HistoryListing

Throws:

IOException - if the request fails to be processed

getArchitectSystempromptHistoryHistoryId

public HistoryListing getArchitectSystempromptHistoryHistoryId(GetArchitectSystempromptHistoryHistoryIdRequest request)
                                                        throws IOException,
ApiException

Get generated prompt history

Parameters:

request - The request object

Returns:

HistoryListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptHistoryHistoryId

public ApiResponse<HistoryListing> getArchitectSystempromptHistoryHistoryId(ApiRequest<Void> request)
                                                                     throws IOException

Get generated prompt history

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSystempromptResource

public SystemPromptAsset getArchitectSystempromptResource(String promptId,
 String languageCode)
                                                   throws IOException,
ApiException

Get a system prompt resource.

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

SystemPromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptResourceWithHttpInfo

public ApiResponse<SystemPromptAsset> getArchitectSystempromptResourceWithHttpInfo(String promptId,
 String languageCode)
                                                                            throws IOException

Get a system prompt resource.

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

SystemPromptAsset

Throws:

IOException - if the request fails to be processed

getArchitectSystempromptResource

public SystemPromptAsset getArchitectSystempromptResource(GetArchitectSystempromptResourceRequest request)
                                                   throws IOException,
ApiException

Get a system prompt resource.

Parameters:

request - The request object

Returns:

SystemPromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptResource

public ApiResponse<SystemPromptAsset> getArchitectSystempromptResource(ApiRequest<Void> request)
                                                                throws IOException

Get a system prompt resource.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSystempromptResources

public SystemPromptAssetEntityListing getArchitectSystempromptResources(String promptId,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder)
                                                                 throws IOException,
ApiException

Get system prompt resources.

Parameters:

promptId - Prompt ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

Returns:

SystemPromptAssetEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptResourcesWithHttpInfo

public ApiResponse<SystemPromptAssetEntityListing> getArchitectSystempromptResourcesWithHttpInfo(String promptId,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder)
                                                                                          throws IOException

Get system prompt resources.

Parameters:

promptId - Prompt ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

Returns:

SystemPromptAssetEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectSystempromptResources

public SystemPromptAssetEntityListing getArchitectSystempromptResources(GetArchitectSystempromptResourcesRequest request)
                                                                 throws IOException,
ApiException

Get system prompt resources.

Parameters:

request - The request object

Returns:

SystemPromptAssetEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptResources

public ApiResponse<SystemPromptAssetEntityListing> getArchitectSystempromptResources(ApiRequest<Void> request)
                                                                              throws IOException

Get system prompt resources.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getArchitectSystemprompts

public SystemPromptEntityListing getArchitectSystemprompts(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 String description,
 String nameOrDescription,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                                                    throws IOException,
ApiException

Get System Prompts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

SystemPromptEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystempromptsWithHttpInfo

public ApiResponse<SystemPromptEntityListing> getArchitectSystempromptsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 String name,
 String description,
 String nameOrDescription,
 Boolean includeMediaUris,
 Boolean includeResources,
 List<String> language)
                                                                             throws IOException

Get System Prompts

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

includeMediaUris - Include the media URIs for each resource (optional, default to true)

includeResources - Include the resources for each system prompt (optional, default to true)

language - Filter the resources down to the provided languages (optional)

Returns:

SystemPromptEntityListing

Throws:

IOException - if the request fails to be processed

getArchitectSystemprompts

public SystemPromptEntityListing getArchitectSystemprompts(GetArchitectSystempromptsRequest request)
                                                    throws IOException,
ApiException

Get System Prompts

Parameters:

request - The request object

Returns:

SystemPromptEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getArchitectSystemprompts

public ApiResponse<SystemPromptEntityListing> getArchitectSystemprompts(ApiRequest<Void> request)
                                                                 throws IOException

Get System Prompts

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlow

public Flow getFlow(String flowId,
 Boolean deleted)
             throws IOException,
ApiException

Get flow

Parameters:

flowId - Flow ID (required)

deleted - Deleted flows (optional, default to false)

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowWithHttpInfo

public ApiResponse<Flow> getFlowWithHttpInfo(String flowId,
 Boolean deleted)
                                      throws IOException

Get flow

Parameters:

flowId - Flow ID (required)

deleted - Deleted flows (optional, default to false)

Returns:

Flow

Throws:

IOException - if the request fails to be processed

getFlow

public Flow getFlow(GetFlowRequest request)
             throws IOException,
ApiException

Get flow

Parameters:

request - The request object

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlow

public ApiResponse<Flow> getFlow(ApiRequest<Void> request)
                          throws IOException

Get flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowHistoryHistoryId

public HistoryListing getFlowHistoryHistoryId(String flowId,
 String historyId,
 Integer pageNumber,
 Integer pageSize,
 String sortOrder,
 String sortBy,
 List<String> action)
                                       throws IOException,
ApiException

Get generated flow history

Parameters:

flowId - Flow ID (required)

historyId - History request ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortOrder - Sort order (optional, default to desc)

sortBy - Sort by (optional, default to timestamp)

action - Flow actions to include (omit to include all) (optional)

Returns:

HistoryListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowHistoryHistoryIdWithHttpInfo

public ApiResponse<HistoryListing> getFlowHistoryHistoryIdWithHttpInfo(String flowId,
 String historyId,
 Integer pageNumber,
 Integer pageSize,
 String sortOrder,
 String sortBy,
 List<String> action)
                                                                throws IOException

Get generated flow history

Parameters:

flowId - Flow ID (required)

historyId - History request ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortOrder - Sort order (optional, default to desc)

sortBy - Sort by (optional, default to timestamp)

action - Flow actions to include (omit to include all) (optional)

Returns:

HistoryListing

Throws:

IOException - if the request fails to be processed

getFlowHistoryHistoryId

public HistoryListing getFlowHistoryHistoryId(GetFlowHistoryHistoryIdRequest request)
                                       throws IOException,
ApiException

Get generated flow history

Parameters:

request - The request object

Returns:

HistoryListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowHistoryHistoryId

public ApiResponse<HistoryListing> getFlowHistoryHistoryId(ApiRequest<Void> request)
                                                    throws IOException

Get generated flow history

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowInstancesSettingsLoglevels

public FlowSettingsResponse getFlowInstancesSettingsLoglevels(String flowId,
 List<String> expand)
                                                       throws IOException,
ApiException

Retrieves the log level for a flow by flow id. Retrieves the log level for a flow by flow id.

Parameters:

flowId - The flow id to get the loglevel for (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowInstancesSettingsLoglevelsWithHttpInfo

public ApiResponse<FlowSettingsResponse> getFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId,
 List<String> expand)
                                                                                throws IOException

Retrieves the log level for a flow by flow id. Retrieves the log level for a flow by flow id.

Parameters:

flowId - The flow id to get the loglevel for (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

IOException - if the request fails to be processed

getFlowInstancesSettingsLoglevels

public FlowSettingsResponse getFlowInstancesSettingsLoglevels(GetFlowInstancesSettingsLoglevelsRequest request)
                                                       throws IOException,
ApiException

Retrieves the log level for a flow by flow id. Retrieves the log level for a flow by flow id.

Parameters:

request - The request object

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowInstancesSettingsLoglevels

public ApiResponse<FlowSettingsResponse> getFlowInstancesSettingsLoglevels(ApiRequest<Void> request)
                                                                    throws IOException

Retrieves the log level for a flow by flow id. Retrieves the log level for a flow by flow id.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowLatestconfiguration

public Object getFlowLatestconfiguration(String flowId,
 Boolean deleted)
                                  throws IOException,
ApiException

Get the latest configuration for flow

Parameters:

flowId - Flow ID (required)

deleted - Deleted flows (optional, default to false)

Returns:

Object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowLatestconfigurationWithHttpInfo

public ApiResponse<Object> getFlowLatestconfigurationWithHttpInfo(String flowId,
 Boolean deleted)
                                                           throws IOException

Get the latest configuration for flow

Parameters:

flowId - Flow ID (required)

deleted - Deleted flows (optional, default to false)

Returns:

Object

Throws:

IOException - if the request fails to be processed

getFlowLatestconfiguration

public Object getFlowLatestconfiguration(GetFlowLatestconfigurationRequest request)
                                  throws IOException,
ApiException

Get the latest configuration for flow

Parameters:

request - The request object

Returns:

Object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowLatestconfiguration

public ApiResponse<Object> getFlowLatestconfiguration(ApiRequest<Void> request)
                                               throws IOException

Get the latest configuration for flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowVersion

public FlowVersion getFlowVersion(String flowId,
 String versionId,
 String deleted)
                           throws IOException,
ApiException

Get flow version

Parameters:

flowId - Flow ID (required)

versionId - Version ID (required)

deleted - Deleted flows (optional)

Returns:

FlowVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionWithHttpInfo

public ApiResponse<FlowVersion> getFlowVersionWithHttpInfo(String flowId,
 String versionId,
 String deleted)
                                                    throws IOException

Get flow version

Parameters:

flowId - Flow ID (required)

versionId - Version ID (required)

deleted - Deleted flows (optional)

Returns:

FlowVersion

Throws:

IOException - if the request fails to be processed

getFlowVersion

public FlowVersion getFlowVersion(GetFlowVersionRequest request)
                           throws IOException,
ApiException

Get flow version

Parameters:

request - The request object

Returns:

FlowVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersion

public ApiResponse<FlowVersion> getFlowVersion(ApiRequest<Void> request)
                                        throws IOException

Get flow version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowVersionConfiguration

public Object getFlowVersionConfiguration(String flowId,
 String versionId,
 String deleted)
                                   throws IOException,
ApiException

Get flow version configuration

Parameters:

flowId - Flow ID (required)

versionId - Version ID (required)

deleted - Deleted flows (optional)

Returns:

Object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionConfigurationWithHttpInfo

public ApiResponse<Object> getFlowVersionConfigurationWithHttpInfo(String flowId,
 String versionId,
 String deleted)
                                                            throws IOException

Get flow version configuration

Parameters:

flowId - Flow ID (required)

versionId - Version ID (required)

deleted - Deleted flows (optional)

Returns:

Object

Throws:

IOException - if the request fails to be processed

getFlowVersionConfiguration

public Object getFlowVersionConfiguration(GetFlowVersionConfigurationRequest request)
                                   throws IOException,
ApiException

Get flow version configuration

Parameters:

request - The request object

Returns:

Object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionConfiguration

public ApiResponse<Object> getFlowVersionConfiguration(ApiRequest<Void> request)
                                                throws IOException

Get flow version configuration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowVersionHealth

public FlowHealth getFlowVersionHealth(String flowId,
 String versionId,
 String language)
                                throws IOException,
ApiException

Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.

Parameters:

flowId - Flow ID. (required)

versionId - Version ID. (required)

language - Language to filter for (optional)

Returns:

FlowHealth

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionHealthWithHttpInfo

public ApiResponse<FlowHealth> getFlowVersionHealthWithHttpInfo(String flowId,
 String versionId,
 String language)
                                                         throws IOException

Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.

Parameters:

flowId - Flow ID. (required)

versionId - Version ID. (required)

language - Language to filter for (optional)

Returns:

FlowHealth

Throws:

IOException - if the request fails to be processed

getFlowVersionHealth

public FlowHealth getFlowVersionHealth(GetFlowVersionHealthRequest request)
                                throws IOException,
ApiException

Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.

Parameters:

request - The request object

Returns:

FlowHealth

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionHealth

public ApiResponse<FlowHealth> getFlowVersionHealth(ApiRequest<Void> request)
                                             throws IOException

Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowVersionIntentHealth

public FlowHealthIntent getFlowVersionIntentHealth(String flowId,
 String versionId,
 String intentId,
 String language)
                                            throws IOException,
ApiException

Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.

Parameters:

flowId - Flow ID. (required)

versionId - Version ID. (required)

intentId - Intent ID. (required)

language - Language to filter for (required)

Returns:

FlowHealthIntent

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionIntentHealthWithHttpInfo

public ApiResponse<FlowHealthIntent> getFlowVersionIntentHealthWithHttpInfo(String flowId,
 String versionId,
 String intentId,
 String language)
                                                                     throws IOException

Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.

Parameters:

flowId - Flow ID. (required)

versionId - Version ID. (required)

intentId - Intent ID. (required)

language - Language to filter for (required)

Returns:

FlowHealthIntent

Throws:

IOException - if the request fails to be processed

getFlowVersionIntentHealth

public FlowHealthIntent getFlowVersionIntentHealth(GetFlowVersionIntentHealthRequest request)
                                            throws IOException,
ApiException

Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.

Parameters:

request - The request object

Returns:

FlowHealthIntent

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionIntentHealth

public ApiResponse<FlowHealthIntent> getFlowVersionIntentHealth(ApiRequest<Void> request)
                                                         throws IOException

Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowVersionIntentUtteranceHealth

public FlowHealthUtterance getFlowVersionIntentUtteranceHealth(String flowId,
 String versionId,
 String intentId,
 String utteranceId,
 String language)
                                                        throws IOException,
ApiException

Get health metrics associated with a specific utterance of an intent.

Parameters:

flowId - Flow ID. (required)

versionId - Version ID. (required)

intentId - Intent ID. (required)

utteranceId - Utterance ID. (required)

language - Language to filter for (required)

Returns:

FlowHealthUtterance

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionIntentUtteranceHealthWithHttpInfo

public ApiResponse<FlowHealthUtterance> getFlowVersionIntentUtteranceHealthWithHttpInfo(String flowId,
 String versionId,
 String intentId,
 String utteranceId,
 String language)
                                                                                 throws IOException

Get health metrics associated with a specific utterance of an intent.

Parameters:

flowId - Flow ID. (required)

versionId - Version ID. (required)

intentId - Intent ID. (required)

utteranceId - Utterance ID. (required)

language - Language to filter for (required)

Returns:

FlowHealthUtterance

Throws:

IOException - if the request fails to be processed

getFlowVersionIntentUtteranceHealth

public FlowHealthUtterance getFlowVersionIntentUtteranceHealth(GetFlowVersionIntentUtteranceHealthRequest request)
                                                        throws IOException,
ApiException

Get health metrics associated with a specific utterance of an intent.

Parameters:

request - The request object

Returns:

FlowHealthUtterance

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionIntentUtteranceHealth

public ApiResponse<FlowHealthUtterance> getFlowVersionIntentUtteranceHealth(ApiRequest<Void> request)
                                                                     throws IOException

Get health metrics associated with a specific utterance of an intent.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowVersions

public FlowVersionEntityListing getFlowVersions(String flowId,
 Integer pageNumber,
 Integer pageSize,
 Boolean deleted)
                                         throws IOException,
ApiException

Get flow version list

Parameters:

flowId - Flow ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

deleted - Include Deleted flows (optional)

Returns:

FlowVersionEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersionsWithHttpInfo

public ApiResponse<FlowVersionEntityListing> getFlowVersionsWithHttpInfo(String flowId,
 Integer pageNumber,
 Integer pageSize,
 Boolean deleted)
                                                                  throws IOException

Get flow version list

Parameters:

flowId - Flow ID (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

deleted - Include Deleted flows (optional)

Returns:

FlowVersionEntityListing

Throws:

IOException - if the request fails to be processed

getFlowVersions

public FlowVersionEntityListing getFlowVersions(GetFlowVersionsRequest request)
                                         throws IOException,
ApiException

Get flow version list

Parameters:

request - The request object

Returns:

FlowVersionEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowVersions

public ApiResponse<FlowVersionEntityListing> getFlowVersions(ApiRequest<Void> request)
                                                      throws IOException

Get flow version list

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlows

public FlowEntityListing getFlows(List<String> type,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 String publishVersionId,
 String editableBy,
 String lockedBy,
 String lockedByClientId,
 String secure,
 Boolean deleted,
 Boolean includeSchemas,
 Boolean virtualAgentEnabled,
 String publishedAfter,
 String publishedBefore,
 List<String> divisionId)
                           throws IOException,
ApiException

Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

type - Type (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

publishVersionId - Publish version ID (optional)

editableBy - Editable by (optional)

lockedBy - Locked by (optional)

lockedByClientId - Locked by client ID (optional)

secure - Secure (optional)

deleted - Include deleted (optional, default to false)

includeSchemas - Include variable schemas (optional, default to false)

virtualAgentEnabled - Include/exclude virtual agent flows (optional)

publishedAfter - Published after (optional, default to null)

publishedBefore - Published before (optional, default to null)

divisionId - division ID(s) (optional)

Returns:

FlowEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsWithHttpInfo

public ApiResponse<FlowEntityListing> getFlowsWithHttpInfo(List<String> type,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 String publishVersionId,
 String editableBy,
 String lockedBy,
 String lockedByClientId,
 String secure,
 Boolean deleted,
 Boolean includeSchemas,
 Boolean virtualAgentEnabled,
 String publishedAfter,
 String publishedBefore,
 List<String> divisionId)
                                                    throws IOException

Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

type - Type (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

publishVersionId - Publish version ID (optional)

editableBy - Editable by (optional)

lockedBy - Locked by (optional)

lockedByClientId - Locked by client ID (optional)

secure - Secure (optional)

deleted - Include deleted (optional, default to false)

includeSchemas - Include variable schemas (optional, default to false)

virtualAgentEnabled - Include/exclude virtual agent flows (optional)

publishedAfter - Published after (optional, default to null)

publishedBefore - Published before (optional, default to null)

divisionId - division ID(s) (optional)

Returns:

FlowEntityListing

Throws:

IOException - if the request fails to be processed

getFlows

public FlowEntityListing getFlows(GetFlowsRequest request)
                           throws IOException,
ApiException

Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

FlowEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlows

public ApiResponse<FlowEntityListing> getFlows(ApiRequest<Void> request)
                                        throws IOException

Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatable

public DataTable getFlowsDatatable(String datatableId,
 String expand)
                            throws IOException,
ApiException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

datatableId - id of datatable (required)

expand - Expand instructions for the result (optional)

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableWithHttpInfo

public ApiResponse<DataTable> getFlowsDatatableWithHttpInfo(String datatableId,
 String expand)
                                                     throws IOException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

datatableId - id of datatable (required)

expand - Expand instructions for the result (optional)

Returns:

DataTable

Throws:

IOException - if the request fails to be processed

getFlowsDatatable

public DataTable getFlowsDatatable(GetFlowsDatatableRequest request)
                            throws IOException,
ApiException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

request - The request object

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatable

public ApiResponse<DataTable> getFlowsDatatable(ApiRequest<Void> request)
                                         throws IOException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatableExportJob

public DataTableExportJob getFlowsDatatableExportJob(String datatableId,
 String exportJobId)
                                              throws IOException,
ApiException

Returns the state information about an export job Returns the state information about an export job.

Parameters:

datatableId - id of datatable (required)

exportJobId - id of export job (required)

Returns:

DataTableExportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableExportJobWithHttpInfo

public ApiResponse<DataTableExportJob> getFlowsDatatableExportJobWithHttpInfo(String datatableId,
 String exportJobId)
                                                                       throws IOException

Returns the state information about an export job Returns the state information about an export job.

Parameters:

datatableId - id of datatable (required)

exportJobId - id of export job (required)

Returns:

DataTableExportJob

Throws:

IOException - if the request fails to be processed

getFlowsDatatableExportJob

public DataTableExportJob getFlowsDatatableExportJob(GetFlowsDatatableExportJobRequest request)
                                              throws IOException,
ApiException

Returns the state information about an export job Returns the state information about an export job.

Parameters:

request - The request object

Returns:

DataTableExportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableExportJob

public ApiResponse<DataTableExportJob> getFlowsDatatableExportJob(ApiRequest<Void> request)
                                                           throws IOException

Returns the state information about an export job Returns the state information about an export job.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatableImportJob

public DataTableImportJob getFlowsDatatableImportJob(String datatableId,
 String importJobId)
                                              throws IOException,
ApiException

Returns the state information about an import job Returns the state information about an import job.

Parameters:

datatableId - id of datatable (required)

importJobId - id of import job (required)

Returns:

DataTableImportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableImportJobWithHttpInfo

public ApiResponse<DataTableImportJob> getFlowsDatatableImportJobWithHttpInfo(String datatableId,
 String importJobId)
                                                                       throws IOException

Returns the state information about an import job Returns the state information about an import job.

Parameters:

datatableId - id of datatable (required)

importJobId - id of import job (required)

Returns:

DataTableImportJob

Throws:

IOException - if the request fails to be processed

getFlowsDatatableImportJob

public DataTableImportJob getFlowsDatatableImportJob(GetFlowsDatatableImportJobRequest request)
                                              throws IOException,
ApiException

Returns the state information about an import job Returns the state information about an import job.

Parameters:

request - The request object

Returns:

DataTableImportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableImportJob

public ApiResponse<DataTableImportJob> getFlowsDatatableImportJob(ApiRequest<Void> request)
                                                           throws IOException

Returns the state information about an import job Returns the state information about an import job.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatableImportJobs

public DataTableImportEntityListing getFlowsDatatableImportJobs(String datatableId,
 Integer pageNumber,
 Integer pageSize)
                                                         throws IOException,
ApiException

Get all recent import jobs Get all recent import jobs

Parameters:

datatableId - id of datatable (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DataTableImportEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableImportJobsWithHttpInfo

public ApiResponse<DataTableImportEntityListing> getFlowsDatatableImportJobsWithHttpInfo(String datatableId,
 Integer pageNumber,
 Integer pageSize)
                                                                                  throws IOException

Get all recent import jobs Get all recent import jobs

Parameters:

datatableId - id of datatable (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

DataTableImportEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsDatatableImportJobs

public DataTableImportEntityListing getFlowsDatatableImportJobs(GetFlowsDatatableImportJobsRequest request)
                                                         throws IOException,
ApiException

Get all recent import jobs Get all recent import jobs

Parameters:

request - The request object

Returns:

DataTableImportEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableImportJobs

public ApiResponse<DataTableImportEntityListing> getFlowsDatatableImportJobs(ApiRequest<Void> request)
                                                                      throws IOException

Get all recent import jobs Get all recent import jobs

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatableRow

public Map<String,Object> getFlowsDatatableRow(String datatableId,
 String rowId,
 Boolean showbrief)
                                        throws IOException,
ApiException

Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.

Parameters:

datatableId - id of datatable (required)

rowId - The key for the row (required)

showbrief - if true returns just the key field for the row (optional, default to true)

Returns:

Map<String, Object>

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableRowWithHttpInfo

public ApiResponse<Map<String,Object>> getFlowsDatatableRowWithHttpInfo(String datatableId,
 String rowId,
 Boolean showbrief)
                                                                 throws IOException

Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.

Parameters:

datatableId - id of datatable (required)

rowId - The key for the row (required)

showbrief - if true returns just the key field for the row (optional, default to true)

Returns:

Map<String, Object>

Throws:

IOException - if the request fails to be processed

getFlowsDatatableRow

public Map<String,Object> getFlowsDatatableRow(GetFlowsDatatableRowRequest request)
                                        throws IOException,
ApiException

Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.

Parameters:

request - The request object

Returns:

Map<String, Object>

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableRow

public ApiResponse<Map<String,Object>> getFlowsDatatableRow(ApiRequest<Void> request)
                                                     throws IOException

Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatableRows

public DataTableRowEntityListing getFlowsDatatableRows(String datatableId,
 Integer pageNumber,
 Integer pageSize,
 Boolean showbrief,
 String sortOrder)
                                                throws IOException,
ApiException

Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.

Parameters:

datatableId - id of datatable (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

showbrief - If true returns just the key value of the row (optional, default to true)

sortOrder - Sort order (optional, default to ascending)

Returns:

DataTableRowEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableRowsWithHttpInfo

public ApiResponse<DataTableRowEntityListing> getFlowsDatatableRowsWithHttpInfo(String datatableId,
 Integer pageNumber,
 Integer pageSize,
 Boolean showbrief,
 String sortOrder)
                                                                         throws IOException

Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.

Parameters:

datatableId - id of datatable (required)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

showbrief - If true returns just the key value of the row (optional, default to true)

sortOrder - Sort order (optional, default to ascending)

Returns:

DataTableRowEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsDatatableRows

public DataTableRowEntityListing getFlowsDatatableRows(GetFlowsDatatableRowsRequest request)
                                                throws IOException,
ApiException

Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.

Parameters:

request - The request object

Returns:

DataTableRowEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatableRows

public ApiResponse<DataTableRowEntityListing> getFlowsDatatableRows(ApiRequest<Void> request)
                                                             throws IOException

Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatables

public DataTablesDomainEntityListing getFlowsDatatables(String expand,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> divisionId,
 String name)
                                                 throws IOException,
ApiException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

expand - Expand instructions for the result (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to ascending)

divisionId - division ID(s) (optional)

name - Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional, default to null)

Returns:

DataTablesDomainEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatablesWithHttpInfo

public ApiResponse<DataTablesDomainEntityListing> getFlowsDatatablesWithHttpInfo(String expand,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> divisionId,
 String name)
                                                                          throws IOException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

expand - Expand instructions for the result (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to ascending)

divisionId - division ID(s) (optional)

name - Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional, default to null)

Returns:

DataTablesDomainEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsDatatables

public DataTablesDomainEntityListing getFlowsDatatables(GetFlowsDatatablesRequest request)
                                                 throws IOException,
ApiException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

request - The request object

Returns:

DataTablesDomainEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatables

public ApiResponse<DataTablesDomainEntityListing> getFlowsDatatables(ApiRequest<Void> request)
                                                              throws IOException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatablesDivisionview

public DataTable getFlowsDatatablesDivisionview(String datatableId,
 String expand)
                                         throws IOException,
ApiException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

datatableId - id of datatable (required)

expand - Expand instructions for the result (optional)

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatablesDivisionviewWithHttpInfo

public ApiResponse<DataTable> getFlowsDatatablesDivisionviewWithHttpInfo(String datatableId,
 String expand)
                                                                  throws IOException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

datatableId - id of datatable (required)

expand - Expand instructions for the result (optional)

Returns:

DataTable

Throws:

IOException - if the request fails to be processed

getFlowsDatatablesDivisionview

public DataTable getFlowsDatatablesDivisionview(GetFlowsDatatablesDivisionviewRequest request)
                                         throws IOException,
ApiException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

request - The request object

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatablesDivisionview

public ApiResponse<DataTable> getFlowsDatatablesDivisionview(ApiRequest<Void> request)
                                                      throws IOException

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDatatablesDivisionviews

public DataTablesDomainEntityListing getFlowsDatatablesDivisionviews(String expand,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> divisionId,
 String name)
                                                              throws IOException,
ApiException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

expand - Expand instructions for the result (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to ascending)

divisionId - division ID(s) (optional)

name - Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional, default to null)

Returns:

DataTablesDomainEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatablesDivisionviewsWithHttpInfo

public ApiResponse<DataTablesDomainEntityListing> getFlowsDatatablesDivisionviewsWithHttpInfo(String expand,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> divisionId,
 String name)
                                                                                       throws IOException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

expand - Expand instructions for the result (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to ascending)

divisionId - division ID(s) (optional)

name - Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional, default to null)

Returns:

DataTablesDomainEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsDatatablesDivisionviews

public DataTablesDomainEntityListing getFlowsDatatablesDivisionviews(GetFlowsDatatablesDivisionviewsRequest request)
                                                              throws IOException,
ApiException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

request - The request object

Returns:

DataTablesDomainEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDatatablesDivisionviews

public ApiResponse<DataTablesDomainEntityListing> getFlowsDatatablesDivisionviews(ApiRequest<Void> request)
                                                                           throws IOException

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsDivisionviews

public FlowDivisionViewEntityListing getFlowsDivisionviews(List<String> type,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String publishVersionId,
 String publishedAfter,
 String publishedBefore,
 List<String> divisionId,
 Boolean includeSchemas)
                                                    throws IOException,
ApiException

Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

type - Type (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

publishVersionId - Publish version ID (optional)

publishedAfter - Published after (optional, default to null)

publishedBefore - Published before (optional, default to null)

divisionId - division ID(s) (optional)

includeSchemas - Include variable schemas (optional, default to false)

Returns:

FlowDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDivisionviewsWithHttpInfo

public ApiResponse<FlowDivisionViewEntityListing> getFlowsDivisionviewsWithHttpInfo(List<String> type,
 Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String publishVersionId,
 String publishedAfter,
 String publishedBefore,
 List<String> divisionId,
 Boolean includeSchemas)
                                                                             throws IOException

Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

type - Type (optional)

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

publishVersionId - Publish version ID (optional)

publishedAfter - Published after (optional, default to null)

publishedBefore - Published before (optional, default to null)

divisionId - division ID(s) (optional)

includeSchemas - Include variable schemas (optional, default to false)

Returns:

FlowDivisionViewEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsDivisionviews

public FlowDivisionViewEntityListing getFlowsDivisionviews(GetFlowsDivisionviewsRequest request)
                                                    throws IOException,
ApiException

Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

FlowDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsDivisionviews

public ApiResponse<FlowDivisionViewEntityListing> getFlowsDivisionviews(ApiRequest<Void> request)
                                                                 throws IOException

Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsExecution

public FlowRuntimeExecution getFlowsExecution(String flowExecutionId)
                                       throws IOException,
ApiException

Get a flow execution's details. Flow execution details are available for several days after the flow is started.

Parameters:

flowExecutionId - flow execution ID (required)

Returns:

FlowRuntimeExecution

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsExecutionWithHttpInfo

public ApiResponse<FlowRuntimeExecution> getFlowsExecutionWithHttpInfo(String flowExecutionId)
                                                                throws IOException

Get a flow execution's details. Flow execution details are available for several days after the flow is started.

Parameters:

flowExecutionId - flow execution ID (required)

Returns:

FlowRuntimeExecution

Throws:

IOException - if the request fails to be processed

getFlowsExecution

public FlowRuntimeExecution getFlowsExecution(GetFlowsExecutionRequest request)
                                       throws IOException,
ApiException

Get a flow execution's details. Flow execution details are available for several days after the flow is started.

Parameters:

request - The request object

Returns:

FlowRuntimeExecution

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsExecution

public ApiResponse<FlowRuntimeExecution> getFlowsExecution(ApiRequest<Void> request)
                                                    throws IOException

Get a flow execution's details. Flow execution details are available for several days after the flow is started.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsExportJob

public ArchitectExportJobStateResponse getFlowsExportJob(String jobId,
 List<String> expand)
                                                  throws IOException,
ApiException

Fetch Architect Export Job Status

Parameters:

jobId - Job ID (required)

expand - Which fields, if any, to expand. (optional)

Returns:

ArchitectExportJobStateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsExportJobWithHttpInfo

public ApiResponse<ArchitectExportJobStateResponse> getFlowsExportJobWithHttpInfo(String jobId,
 List<String> expand)
                                                                           throws IOException

Fetch Architect Export Job Status

Parameters:

jobId - Job ID (required)

expand - Which fields, if any, to expand. (optional)

Returns:

ArchitectExportJobStateResponse

Throws:

IOException - if the request fails to be processed

getFlowsExportJob

public ArchitectExportJobStateResponse getFlowsExportJob(GetFlowsExportJobRequest request)
                                                  throws IOException,
ApiException

Fetch Architect Export Job Status

Parameters:

request - The request object

Returns:

ArchitectExportJobStateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsExportJob

public ApiResponse<ArchitectExportJobStateResponse> getFlowsExportJob(ApiRequest<Void> request)
                                                               throws IOException

Fetch Architect Export Job Status

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsInstance

public GetFlowExecutionDataJobResult getFlowsInstance(String instanceId,
 String expand)
                                               throws IOException,
ApiException

Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

instanceId - Instance ID (required)

expand - Expand various details. (optional)

Returns:

GetFlowExecutionDataJobResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstanceWithHttpInfo

public ApiResponse<GetFlowExecutionDataJobResult> getFlowsInstanceWithHttpInfo(String instanceId,
 String expand)
                                                                        throws IOException

Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

instanceId - Instance ID (required)

expand - Expand various details. (optional)

Returns:

GetFlowExecutionDataJobResult

Throws:

IOException - if the request fails to be processed

getFlowsInstance

public GetFlowExecutionDataJobResult getFlowsInstance(GetFlowsInstanceRequest request)
                                               throws IOException,
ApiException

Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

request - The request object

Returns:

GetFlowExecutionDataJobResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstance

public ApiResponse<GetFlowExecutionDataJobResult> getFlowsInstance(ApiRequest<Void> request)
                                                            throws IOException

Start a process (job) to prepare a download of a singular flow execution data instance by Id Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsInstancesJob

public GetFlowExecutionDataJobResult getFlowsInstancesJob(String jobId)
                                                   throws IOException,
ApiException

Get the status and/or results of an asynchronous flow execution data retrieval job

Parameters:

jobId - The asynchronous job ID (required)

Returns:

GetFlowExecutionDataJobResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesJobWithHttpInfo

public ApiResponse<GetFlowExecutionDataJobResult> getFlowsInstancesJobWithHttpInfo(String jobId)
                                                                            throws IOException

Get the status and/or results of an asynchronous flow execution data retrieval job

Parameters:

jobId - The asynchronous job ID (required)

Returns:

GetFlowExecutionDataJobResult

Throws:

IOException - if the request fails to be processed

getFlowsInstancesJob

public GetFlowExecutionDataJobResult getFlowsInstancesJob(GetFlowsInstancesJobRequest request)
                                                   throws IOException,
ApiException

Get the status and/or results of an asynchronous flow execution data retrieval job

Parameters:

request - The request object

Returns:

GetFlowExecutionDataJobResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesJob

public ApiResponse<GetFlowExecutionDataJobResult> getFlowsInstancesJob(ApiRequest<Void> request)
                                                                throws IOException

Get the status and/or results of an asynchronous flow execution data retrieval job

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsInstancesQuerycapabilities

public FlowsQueryCriteriaResponse getFlowsInstancesQuerycapabilities(String expand)
                                                              throws IOException,
ApiException

Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.

Parameters:

expand - Expand various query types. (optional)

Returns:

FlowsQueryCriteriaResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesQuerycapabilitiesWithHttpInfo

public ApiResponse<FlowsQueryCriteriaResponse> getFlowsInstancesQuerycapabilitiesWithHttpInfo(String expand)
                                                                                       throws IOException

Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.

Parameters:

expand - Expand various query types. (optional)

Returns:

FlowsQueryCriteriaResponse

Throws:

IOException - if the request fails to be processed

getFlowsInstancesQuerycapabilities

public FlowsQueryCriteriaResponse getFlowsInstancesQuerycapabilities(GetFlowsInstancesQuerycapabilitiesRequest request)
                                                              throws IOException,
ApiException

Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.

Parameters:

request - The request object

Returns:

FlowsQueryCriteriaResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesQuerycapabilities

public ApiResponse<FlowsQueryCriteriaResponse> getFlowsInstancesQuerycapabilities(ApiRequest<Void> request)
                                                                           throws IOException

Retrieve a list of capabilities that the org can use to query for execution data Returns the queryable parameters that can be used to build a query for execution data.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsExecutiondata

public ExecutionDataFlowSettingsResponse getFlowsInstancesSettingsExecutiondata()
                                                                         throws IOException,
ApiException

Get the execution history enabled setting. Get the execution history enabled setting.

Returns:

ExecutionDataFlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsExecutiondataWithHttpInfo

public ApiResponse<ExecutionDataFlowSettingsResponse> getFlowsInstancesSettingsExecutiondataWithHttpInfo()
                                                                                                  throws IOException

Get the execution history enabled setting. Get the execution history enabled setting.

Returns:

ExecutionDataFlowSettingsResponse

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsExecutiondata

public ExecutionDataFlowSettingsResponse getFlowsInstancesSettingsExecutiondata(GetFlowsInstancesSettingsExecutiondataRequest request)
                                                                         throws IOException,
ApiException

Get the execution history enabled setting. Get the execution history enabled setting.

Parameters:

request - The request object

Returns:

ExecutionDataFlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsExecutiondata

public ApiResponse<ExecutionDataFlowSettingsResponse> getFlowsInstancesSettingsExecutiondata(ApiRequest<Void> request)
                                                                                      throws IOException

Get the execution history enabled setting. Get the execution history enabled setting.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevels

public FlowSettingsResponseEntityListing getFlowsInstancesSettingsLoglevels(List<String> expand,
 Integer pageNumber,
 Integer pageSize)
                                                                     throws IOException,
ApiException

Retrieve a list of LogLevels for the organization. Returns a paged set of LogLevels per flow id

Parameters:

expand - Expand instructions for the result (optional)

pageNumber - Page number (optional, default to 1)

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

Returns:

FlowSettingsResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsWithHttpInfo

public ApiResponse<FlowSettingsResponseEntityListing> getFlowsInstancesSettingsLoglevelsWithHttpInfo(List<String> expand,
 Integer pageNumber,
 Integer pageSize)
                                                                                              throws IOException

Retrieve a list of LogLevels for the organization. Returns a paged set of LogLevels per flow id

Parameters:

expand - Expand instructions for the result (optional)

pageNumber - Page number (optional, default to 1)

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

Returns:

FlowSettingsResponseEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevels

public FlowSettingsResponseEntityListing getFlowsInstancesSettingsLoglevels(GetFlowsInstancesSettingsLoglevelsRequest request)
                                                                     throws IOException,
ApiException

Retrieve a list of LogLevels for the organization. Returns a paged set of LogLevels per flow id

Parameters:

request - The request object

Returns:

FlowSettingsResponseEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevels

public ApiResponse<FlowSettingsResponseEntityListing> getFlowsInstancesSettingsLoglevels(ApiRequest<Void> request)
                                                                                  throws IOException

Retrieve a list of LogLevels for the organization. Returns a paged set of LogLevels per flow id

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsCharacteristics

public FlowLogLevelCharacteristicsDefinitions getFlowsInstancesSettingsLoglevelsCharacteristics()
                                                                                         throws IOException,
ApiException

Gets the available flow log level characteristics for this organization. Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.

Returns:

FlowLogLevelCharacteristicsDefinitions

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsCharacteristicsWithHttpInfo

public ApiResponse<FlowLogLevelCharacteristicsDefinitions> getFlowsInstancesSettingsLoglevelsCharacteristicsWithHttpInfo()
                                                                                                                  throws IOException

Gets the available flow log level characteristics for this organization. Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.

Returns:

FlowLogLevelCharacteristicsDefinitions

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsCharacteristics

public FlowLogLevelCharacteristicsDefinitions getFlowsInstancesSettingsLoglevelsCharacteristics(GetFlowsInstancesSettingsLoglevelsCharacteristicsRequest request)
                                                                                         throws IOException,
ApiException

Gets the available flow log level characteristics for this organization. Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.

Parameters:

request - The request object

Returns:

FlowLogLevelCharacteristicsDefinitions

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsCharacteristics

public ApiResponse<FlowLogLevelCharacteristicsDefinitions> getFlowsInstancesSettingsLoglevelsCharacteristics(ApiRequest<Void> request)
                                                                                                      throws IOException

Gets the available flow log level characteristics for this organization. Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsDefault

public FlowSettingsResponse getFlowsInstancesSettingsLoglevelsDefault(List<String> expand)
                                                               throws IOException,
ApiException

Returns the flow default log level. Returns the flow default log level which will be used if no specific flow id log level is found.

Parameters:

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo

public ApiResponse<FlowSettingsResponse> getFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo(List<String> expand)
                                                                                        throws IOException

Returns the flow default log level. Returns the flow default log level which will be used if no specific flow id log level is found.

Parameters:

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsDefault

public FlowSettingsResponse getFlowsInstancesSettingsLoglevelsDefault(GetFlowsInstancesSettingsLoglevelsDefaultRequest request)
                                                               throws IOException,
ApiException

Returns the flow default log level. Returns the flow default log level which will be used if no specific flow id log level is found.

Parameters:

request - The request object

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsInstancesSettingsLoglevelsDefault

public ApiResponse<FlowSettingsResponse> getFlowsInstancesSettingsLoglevelsDefault(ApiRequest<Void> request)
                                                                            throws IOException

Returns the flow default log level. Returns the flow default log level which will be used if no specific flow id log level is found.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsJob

public ArchitectJobStateResponse getFlowsJob(String jobId,
 List<String> expand)
                                      throws IOException,
ApiException

Fetch Architect Job Status

Parameters:

jobId - Job ID (required)

expand - Which fields, if any, to expand. (optional)

Returns:

ArchitectJobStateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsJobWithHttpInfo

public ApiResponse<ArchitectJobStateResponse> getFlowsJobWithHttpInfo(String jobId,
 List<String> expand)
                                                               throws IOException

Fetch Architect Job Status

Parameters:

jobId - Job ID (required)

expand - Which fields, if any, to expand. (optional)

Returns:

ArchitectJobStateResponse

Throws:

IOException - if the request fails to be processed

getFlowsJob

public ArchitectJobStateResponse getFlowsJob(GetFlowsJobRequest request)
                                      throws IOException,
ApiException

Fetch Architect Job Status

Parameters:

request - The request object

Returns:

ArchitectJobStateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsJob

public ApiResponse<ArchitectJobStateResponse> getFlowsJob(ApiRequest<Void> request)
                                                   throws IOException

Fetch Architect Job Status

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsMilestone

public FlowMilestone getFlowsMilestone(String milestoneId)
                                throws IOException,
ApiException

Get a flow milestone Returns a specified flow milestone

Parameters:

milestoneId - flow milestone ID (required)

Returns:

FlowMilestone

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsMilestoneWithHttpInfo

public ApiResponse<FlowMilestone> getFlowsMilestoneWithHttpInfo(String milestoneId)
                                                         throws IOException

Get a flow milestone Returns a specified flow milestone

Parameters:

milestoneId - flow milestone ID (required)

Returns:

FlowMilestone

Throws:

IOException - if the request fails to be processed

getFlowsMilestone

public FlowMilestone getFlowsMilestone(GetFlowsMilestoneRequest request)
                                throws IOException,
ApiException

Get a flow milestone Returns a specified flow milestone

Parameters:

request - The request object

Returns:

FlowMilestone

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsMilestone

public ApiResponse<FlowMilestone> getFlowsMilestone(ApiRequest<Void> request)
                                             throws IOException

Get a flow milestone Returns a specified flow milestone

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsMilestones

public FlowMilestoneListing getFlowsMilestones(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 List<String> divisionId)
                                        throws IOException,
ApiException

Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

divisionId - division ID(s) (optional)

Returns:

FlowMilestoneListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsMilestonesWithHttpInfo

public ApiResponse<FlowMilestoneListing> getFlowsMilestonesWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 List<String> divisionId)
                                                                 throws IOException

Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

divisionId - division ID(s) (optional)

Returns:

FlowMilestoneListing

Throws:

IOException - if the request fails to be processed

getFlowsMilestones

public FlowMilestoneListing getFlowsMilestones(GetFlowsMilestonesRequest request)
                                        throws IOException,
ApiException

Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.

Parameters:

request - The request object

Returns:

FlowMilestoneListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsMilestones

public ApiResponse<FlowMilestoneListing> getFlowsMilestones(ApiRequest<Void> request)
                                                     throws IOException

Get a pageable list of flow milestones, filtered by query parameters Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsMilestonesDivisionviews

public FlowMilestoneDivisionViewEntityListing getFlowsMilestonesDivisionviews(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                       throws IOException,
ApiException

Get a pageable list of basic flow milestone information objects filterable by query parameters. This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

divisionId - division ID(s) (optional)

Returns:

FlowMilestoneDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsMilestonesDivisionviewsWithHttpInfo

public ApiResponse<FlowMilestoneDivisionViewEntityListing> getFlowsMilestonesDivisionviewsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                                                throws IOException

Get a pageable list of basic flow milestone information objects filterable by query parameters. This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

divisionId - division ID(s) (optional)

Returns:

FlowMilestoneDivisionViewEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsMilestonesDivisionviews

public FlowMilestoneDivisionViewEntityListing getFlowsMilestonesDivisionviews(GetFlowsMilestonesDivisionviewsRequest request)
                                                                       throws IOException,
ApiException

Get a pageable list of basic flow milestone information objects filterable by query parameters. This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

FlowMilestoneDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsMilestonesDivisionviews

public ApiResponse<FlowMilestoneDivisionViewEntityListing> getFlowsMilestonesDivisionviews(ApiRequest<Void> request)
                                                                                    throws IOException

Get a pageable list of basic flow milestone information objects filterable by query parameters. This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsOutcome

public FlowOutcome getFlowsOutcome(String flowOutcomeId)
                            throws IOException,
ApiException

Get a flow outcome Returns a specified flow outcome

Parameters:

flowOutcomeId - flow outcome ID (required)

Returns:

FlowOutcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsOutcomeWithHttpInfo

public ApiResponse<FlowOutcome> getFlowsOutcomeWithHttpInfo(String flowOutcomeId)
                                                     throws IOException

Get a flow outcome Returns a specified flow outcome

Parameters:

flowOutcomeId - flow outcome ID (required)

Returns:

FlowOutcome

Throws:

IOException - if the request fails to be processed

getFlowsOutcome

public FlowOutcome getFlowsOutcome(GetFlowsOutcomeRequest request)
                            throws IOException,
ApiException

Get a flow outcome Returns a specified flow outcome

Parameters:

request - The request object

Returns:

FlowOutcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsOutcome

public ApiResponse<FlowOutcome> getFlowsOutcome(ApiRequest<Void> request)
                                         throws IOException

Get a flow outcome Returns a specified flow outcome

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsOutcomes

public FlowOutcomeListing getFlowsOutcomes(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 List<String> divisionId)
                                    throws IOException,
ApiException

Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

divisionId - division ID(s) (optional)

Returns:

FlowOutcomeListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsOutcomesWithHttpInfo

public ApiResponse<FlowOutcomeListing> getFlowsOutcomesWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 String description,
 String nameOrDescription,
 List<String> divisionId)
                                                             throws IOException

Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

description - Description (optional)

nameOrDescription - Name or description (optional)

divisionId - division ID(s) (optional)

Returns:

FlowOutcomeListing

Throws:

IOException - if the request fails to be processed

getFlowsOutcomes

public FlowOutcomeListing getFlowsOutcomes(GetFlowsOutcomesRequest request)
                                    throws IOException,
ApiException

Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.

Parameters:

request - The request object

Returns:

FlowOutcomeListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsOutcomes

public ApiResponse<FlowOutcomeListing> getFlowsOutcomes(ApiRequest<Void> request)
                                                 throws IOException

Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getFlowsOutcomesDivisionviews

public FlowOutcomeDivisionViewEntityListing getFlowsOutcomesDivisionviews(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                   throws IOException,
ApiException

Get a pageable list of basic flow outcome information objects filterable by query parameters. This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

divisionId - division ID(s) (optional)

Returns:

FlowOutcomeDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsOutcomesDivisionviewsWithHttpInfo

public ApiResponse<FlowOutcomeDivisionViewEntityListing> getFlowsOutcomesDivisionviewsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String sortOrder,
 List<String> id,
 String name,
 List<String> divisionId)
                                                                                            throws IOException

Get a pageable list of basic flow outcome information objects filterable by query parameters. This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Sort by (optional, default to id)

sortOrder - Sort order (optional, default to asc)

id - ID (optional)

name - Name (optional)

divisionId - division ID(s) (optional)

Returns:

FlowOutcomeDivisionViewEntityListing

Throws:

IOException - if the request fails to be processed

getFlowsOutcomesDivisionviews

public FlowOutcomeDivisionViewEntityListing getFlowsOutcomesDivisionviews(GetFlowsOutcomesDivisionviewsRequest request)
                                                                   throws IOException,
ApiException

Get a pageable list of basic flow outcome information objects filterable by query parameters. This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

FlowOutcomeDivisionViewEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getFlowsOutcomesDivisionviews

public ApiResponse<FlowOutcomeDivisionViewEntityListing> getFlowsOutcomesDivisionviews(ApiRequest<Void> request)
                                                                                throws IOException

Get a pageable list of basic flow outcome information objects filterable by query parameters. This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchArchitectGrammar

public Grammar patchArchitectGrammar(String grammarId,
 Grammar body)
                              throws IOException,
ApiException

Updates a grammar

Parameters:

grammarId - grammar ID (required)

body - (optional)

Returns:

Grammar

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchArchitectGrammarWithHttpInfo

public ApiResponse<Grammar> patchArchitectGrammarWithHttpInfo(String grammarId,
 Grammar body)
                                                       throws IOException

Updates a grammar

Parameters:

grammarId - grammar ID (required)

body - (optional)

Returns:

Grammar

Throws:

IOException - if the request fails to be processed

patchArchitectGrammar

public Grammar patchArchitectGrammar(PatchArchitectGrammarRequest request)
                              throws IOException,
ApiException

Updates a grammar

Parameters:

request - The request object

Returns:

Grammar

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchArchitectGrammar

public ApiResponse<Grammar> patchArchitectGrammar(ApiRequest<Grammar> request)
                                           throws IOException

Updates a grammar

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchArchitectGrammarLanguage

public GrammarLanguage patchArchitectGrammarLanguage(String grammarId,
 String languageCode,
 GrammarLanguageUpdate body)
                                              throws IOException,
ApiException

Updates a grammar language

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

body - (optional)

Returns:

GrammarLanguage

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchArchitectGrammarLanguageWithHttpInfo

public ApiResponse<GrammarLanguage> patchArchitectGrammarLanguageWithHttpInfo(String grammarId,
 String languageCode,
 GrammarLanguageUpdate body)
                                                                       throws IOException

Updates a grammar language

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

body - (optional)

Returns:

GrammarLanguage

Throws:

IOException - if the request fails to be processed

patchArchitectGrammarLanguage

public GrammarLanguage patchArchitectGrammarLanguage(PatchArchitectGrammarLanguageRequest request)
                                              throws IOException,
ApiException

Updates a grammar language

Parameters:

request - The request object

Returns:

GrammarLanguage

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchArchitectGrammarLanguage

public ApiResponse<GrammarLanguage> patchArchitectGrammarLanguage(ApiRequest<GrammarLanguageUpdate> request)
                                                           throws IOException

Updates a grammar language

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchFlowsInstancesSettingsExecutiondata

public ExecutionDataFlowSettingsResponse patchFlowsInstancesSettingsExecutiondata(ExecutionDataSettingsRequest body)
                                                                           throws IOException,
ApiException

Edit the execution history enabled setting. Edit the execution history enabled setting.

Parameters:

body - New Execution Data Setting (required)

Returns:

ExecutionDataFlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchFlowsInstancesSettingsExecutiondataWithHttpInfo

public ApiResponse<ExecutionDataFlowSettingsResponse> patchFlowsInstancesSettingsExecutiondataWithHttpInfo(ExecutionDataSettingsRequest body)
                                                                                                    throws IOException

Edit the execution history enabled setting. Edit the execution history enabled setting.

Parameters:

body - New Execution Data Setting (required)

Returns:

ExecutionDataFlowSettingsResponse

Throws:

IOException - if the request fails to be processed

patchFlowsInstancesSettingsExecutiondata

public ExecutionDataFlowSettingsResponse patchFlowsInstancesSettingsExecutiondata(PatchFlowsInstancesSettingsExecutiondataRequest request)
                                                                           throws IOException,
ApiException

Edit the execution history enabled setting. Edit the execution history enabled setting.

Parameters:

request - The request object

Returns:

ExecutionDataFlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchFlowsInstancesSettingsExecutiondata

public ApiResponse<ExecutionDataFlowSettingsResponse> patchFlowsInstancesSettingsExecutiondata(ApiRequest<ExecutionDataSettingsRequest> request)
                                                                                        throws IOException

Edit the execution history enabled setting. Edit the execution history enabled setting.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectDependencytrackingBuild

public void postArchitectDependencytrackingBuild()
                                          throws IOException,
ApiException

Rebuild Dependency Tracking data for an organization Asynchronous. Notification topic: v2.architect.dependencytracking.build

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectDependencytrackingBuildWithHttpInfo

public ApiResponse<Void> postArchitectDependencytrackingBuildWithHttpInfo()
                                                                   throws IOException

Rebuild Dependency Tracking data for an organization Asynchronous. Notification topic: v2.architect.dependencytracking.build

Throws:

IOException - if the request fails to be processed

postArchitectDependencytrackingBuild

public void postArchitectDependencytrackingBuild(PostArchitectDependencytrackingBuildRequest request)
                                          throws IOException,
ApiException

Rebuild Dependency Tracking data for an organization Asynchronous. Notification topic: v2.architect.dependencytracking.build

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectDependencytrackingBuild

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

Rebuild Dependency Tracking data for an organization Asynchronous. Notification topic: v2.architect.dependencytracking.build

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectEmergencygroups

public EmergencyGroup postArchitectEmergencygroups(EmergencyGroup body)
                                            throws IOException,
ApiException

Creates a new emergency group

Parameters:

body - (required)

Returns:

EmergencyGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectEmergencygroupsWithHttpInfo

public ApiResponse<EmergencyGroup> postArchitectEmergencygroupsWithHttpInfo(EmergencyGroup body)
                                                                     throws IOException

Creates a new emergency group

Parameters:

body - (required)

Returns:

EmergencyGroup

Throws:

IOException - if the request fails to be processed

postArchitectEmergencygroups

public EmergencyGroup postArchitectEmergencygroups(PostArchitectEmergencygroupsRequest request)
                                            throws IOException,
ApiException

Creates a new emergency group

Parameters:

request - The request object

Returns:

EmergencyGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectEmergencygroups

public ApiResponse<EmergencyGroup> postArchitectEmergencygroups(ApiRequest<EmergencyGroup> request)
                                                         throws IOException

Creates a new emergency group

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesDtmf

public UploadUrlResponse postArchitectGrammarLanguageFilesDtmf(String grammarId,
 String languageCode,
 GrammarFileUploadRequest body)
                                                        throws IOException,
ApiException

Creates a presigned URL for uploading a grammar DTMF mode file

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

body - query (required)

Returns:

UploadUrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesDtmfWithHttpInfo

public ApiResponse<UploadUrlResponse> postArchitectGrammarLanguageFilesDtmfWithHttpInfo(String grammarId,
 String languageCode,
 GrammarFileUploadRequest body)
                                                                                 throws IOException

Creates a presigned URL for uploading a grammar DTMF mode file

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

body - query (required)

Returns:

UploadUrlResponse

Throws:

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesDtmf

public UploadUrlResponse postArchitectGrammarLanguageFilesDtmf(PostArchitectGrammarLanguageFilesDtmfRequest request)
                                                        throws IOException,
ApiException

Creates a presigned URL for uploading a grammar DTMF mode file

Parameters:

request - The request object

Returns:

UploadUrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesDtmf

public ApiResponse<UploadUrlResponse> postArchitectGrammarLanguageFilesDtmf(ApiRequest<GrammarFileUploadRequest> request)
                                                                     throws IOException

Creates a presigned URL for uploading a grammar DTMF mode file

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesVoice

public UploadUrlResponse postArchitectGrammarLanguageFilesVoice(String grammarId,
 String languageCode,
 GrammarFileUploadRequest body)
                                                         throws IOException,
ApiException

Creates a presigned URL for uploading a grammar voice mode file

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

body - query (required)

Returns:

UploadUrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesVoiceWithHttpInfo

public ApiResponse<UploadUrlResponse> postArchitectGrammarLanguageFilesVoiceWithHttpInfo(String grammarId,
 String languageCode,
 GrammarFileUploadRequest body)
                                                                                  throws IOException

Creates a presigned URL for uploading a grammar voice mode file

Parameters:

grammarId - Grammar ID (required)

languageCode - Language (required)

body - query (required)

Returns:

UploadUrlResponse

Throws:

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesVoice

public UploadUrlResponse postArchitectGrammarLanguageFilesVoice(PostArchitectGrammarLanguageFilesVoiceRequest request)
                                                         throws IOException,
ApiException

Creates a presigned URL for uploading a grammar voice mode file

Parameters:

request - The request object

Returns:

UploadUrlResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammarLanguageFilesVoice

public ApiResponse<UploadUrlResponse> postArchitectGrammarLanguageFilesVoice(ApiRequest<GrammarFileUploadRequest> request)
                                                                      throws IOException

Creates a presigned URL for uploading a grammar voice mode file

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectGrammarLanguages

public GrammarLanguage postArchitectGrammarLanguages(String grammarId,
 GrammarLanguage body)
                                              throws IOException,
ApiException

Create a new language for a given grammar

Parameters:

grammarId - Grammar ID (required)

body - (required)

Returns:

GrammarLanguage

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammarLanguagesWithHttpInfo

public ApiResponse<GrammarLanguage> postArchitectGrammarLanguagesWithHttpInfo(String grammarId,
 GrammarLanguage body)
                                                                       throws IOException

Create a new language for a given grammar

Parameters:

grammarId - Grammar ID (required)

body - (required)

Returns:

GrammarLanguage

Throws:

IOException - if the request fails to be processed

postArchitectGrammarLanguages

public GrammarLanguage postArchitectGrammarLanguages(PostArchitectGrammarLanguagesRequest request)
                                              throws IOException,
ApiException

Create a new language for a given grammar

Parameters:

request - The request object

Returns:

GrammarLanguage

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammarLanguages

public ApiResponse<GrammarLanguage> postArchitectGrammarLanguages(ApiRequest<GrammarLanguage> request)
                                                           throws IOException

Create a new language for a given grammar

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectGrammars

public Grammar postArchitectGrammars(Grammar body)
                              throws IOException,
ApiException

Create a new grammar

Parameters:

body - (required)

Returns:

Grammar

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammarsWithHttpInfo

public ApiResponse<Grammar> postArchitectGrammarsWithHttpInfo(Grammar body)
                                                       throws IOException

Create a new grammar

Parameters:

body - (required)

Returns:

Grammar

Throws:

IOException - if the request fails to be processed

postArchitectGrammars

public Grammar postArchitectGrammars(PostArchitectGrammarsRequest request)
                              throws IOException,
ApiException

Create a new grammar

Parameters:

request - The request object

Returns:

Grammar

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectGrammars

public ApiResponse<Grammar> postArchitectGrammars(ApiRequest<Grammar> request)
                                           throws IOException

Create a new grammar

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectIvrs

public IVR postArchitectIvrs(IVR body)
                      throws IOException,
ApiException

Create IVR config.

Parameters:

body - (required)

Returns:

IVR

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectIvrsWithHttpInfo

public ApiResponse<IVR> postArchitectIvrsWithHttpInfo(IVR body)
                                               throws IOException

Create IVR config.

Parameters:

body - (required)

Returns:

IVR

Throws:

IOException - if the request fails to be processed

postArchitectIvrs

public IVR postArchitectIvrs(PostArchitectIvrsRequest request)
                      throws IOException,
ApiException

Create IVR config.

Parameters:

request - The request object

Returns:

IVR

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectIvrs

public ApiResponse<IVR> postArchitectIvrs(ApiRequest<IVR> request)
                                   throws IOException

Create IVR config.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectPromptHistory

public Operation postArchitectPromptHistory(String promptId)
                                     throws IOException,
ApiException

Generate prompt history Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

promptId - Prompt ID (required)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPromptHistoryWithHttpInfo

public ApiResponse<Operation> postArchitectPromptHistoryWithHttpInfo(String promptId)
                                                              throws IOException

Generate prompt history Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

promptId - Prompt ID (required)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

postArchitectPromptHistory

public Operation postArchitectPromptHistory(PostArchitectPromptHistoryRequest request)
                                     throws IOException,
ApiException

Generate prompt history Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPromptHistory

public ApiResponse<Operation> postArchitectPromptHistory(ApiRequest<Void> request)
                                                  throws IOException

Generate prompt history Asynchronous. Notification topic: v2.architect.prompts.{promptId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectPromptResourceUploads

public PromptAssetUpload postArchitectPromptResourceUploads(String promptId,
 String languageCode)
                                                     throws IOException,
ApiException

Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

PromptAssetUpload

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPromptResourceUploadsWithHttpInfo

public ApiResponse<PromptAssetUpload> postArchitectPromptResourceUploadsWithHttpInfo(String promptId,
 String languageCode)
                                                                              throws IOException

Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

PromptAssetUpload

Throws:

IOException - if the request fails to be processed

postArchitectPromptResourceUploads

public PromptAssetUpload postArchitectPromptResourceUploads(PostArchitectPromptResourceUploadsRequest request)
                                                     throws IOException,
ApiException

Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads 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:

PromptAssetUpload

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPromptResourceUploads

public ApiResponse<PromptAssetUpload> postArchitectPromptResourceUploads(ApiRequest<Void> request)
                                                                  throws IOException

Creates a presigned URL for uploading a user prompt file postArchitectPromptResourceUploads 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

postArchitectPromptResources

public PromptAsset postArchitectPromptResources(String promptId,
 PromptAssetCreate body)
                                         throws IOException,
ApiException

Create a new user prompt resource

Parameters:

promptId - Prompt ID (required)

body - (required)

Returns:

PromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPromptResourcesWithHttpInfo

public ApiResponse<PromptAsset> postArchitectPromptResourcesWithHttpInfo(String promptId,
 PromptAssetCreate body)
                                                                  throws IOException

Create a new user prompt resource

Parameters:

promptId - Prompt ID (required)

body - (required)

Returns:

PromptAsset

Throws:

IOException - if the request fails to be processed

postArchitectPromptResources

public PromptAsset postArchitectPromptResources(PostArchitectPromptResourcesRequest request)
                                         throws IOException,
ApiException

Create a new user prompt resource

Parameters:

request - The request object

Returns:

PromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPromptResources

public ApiResponse<PromptAsset> postArchitectPromptResources(ApiRequest<PromptAssetCreate> request)
                                                      throws IOException

Create a new user prompt resource

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectPrompts

public Prompt postArchitectPrompts(Prompt body)
                            throws IOException,
ApiException

Create a new user prompt

Parameters:

body - (required)

Returns:

Prompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPromptsWithHttpInfo

public ApiResponse<Prompt> postArchitectPromptsWithHttpInfo(Prompt body)
                                                     throws IOException

Create a new user prompt

Parameters:

body - (required)

Returns:

Prompt

Throws:

IOException - if the request fails to be processed

postArchitectPrompts

public Prompt postArchitectPrompts(PostArchitectPromptsRequest request)
                            throws IOException,
ApiException

Create a new user prompt

Parameters:

request - The request object

Returns:

Prompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectPrompts

public ApiResponse<Prompt> postArchitectPrompts(ApiRequest<Prompt> request)
                                         throws IOException

Create a new user prompt

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectSchedulegroups

public ScheduleGroup postArchitectSchedulegroups(ScheduleGroup body)
                                          throws IOException,
ApiException

Creates a new schedule group

Parameters:

body - (required)

Returns:

ScheduleGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSchedulegroupsWithHttpInfo

public ApiResponse<ScheduleGroup> postArchitectSchedulegroupsWithHttpInfo(ScheduleGroup body)
                                                                   throws IOException

Creates a new schedule group

Parameters:

body - (required)

Returns:

ScheduleGroup

Throws:

IOException - if the request fails to be processed

postArchitectSchedulegroups

public ScheduleGroup postArchitectSchedulegroups(PostArchitectSchedulegroupsRequest request)
                                          throws IOException,
ApiException

Creates a new schedule group

Parameters:

request - The request object

Returns:

ScheduleGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSchedulegroups

public ApiResponse<ScheduleGroup> postArchitectSchedulegroups(ApiRequest<ScheduleGroup> request)
                                                       throws IOException

Creates a new schedule group

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectSchedules

public Schedule postArchitectSchedules(Schedule body)
                                throws IOException,
ApiException

Create a new schedule.

Parameters:

body - (required)

Returns:

Schedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSchedulesWithHttpInfo

public ApiResponse<Schedule> postArchitectSchedulesWithHttpInfo(Schedule body)
                                                         throws IOException

Create a new schedule.

Parameters:

body - (required)

Returns:

Schedule

Throws:

IOException - if the request fails to be processed

postArchitectSchedules

public Schedule postArchitectSchedules(PostArchitectSchedulesRequest request)
                                throws IOException,
ApiException

Create a new schedule.

Parameters:

request - The request object

Returns:

Schedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSchedules

public ApiResponse<Schedule> postArchitectSchedules(ApiRequest<Schedule> request)
                                             throws IOException

Create a new schedule.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectSystempromptHistory

public Operation postArchitectSystempromptHistory(String promptId)
                                           throws IOException,
ApiException

Generate system prompt history Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}

Parameters:

promptId - promptId (required)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSystempromptHistoryWithHttpInfo

public ApiResponse<Operation> postArchitectSystempromptHistoryWithHttpInfo(String promptId)
                                                                    throws IOException

Generate system prompt history Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}

Parameters:

promptId - promptId (required)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

postArchitectSystempromptHistory

public Operation postArchitectSystempromptHistory(PostArchitectSystempromptHistoryRequest request)
                                           throws IOException,
ApiException

Generate system prompt history Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSystempromptHistory

public ApiResponse<Operation> postArchitectSystempromptHistory(ApiRequest<Void> request)
                                                        throws IOException

Generate system prompt history Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postArchitectSystempromptResourceUploads

public PromptAssetUpload postArchitectSystempromptResourceUploads(String promptId,
 String languageCode)
                                                           throws IOException,
ApiException

Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

PromptAssetUpload

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSystempromptResourceUploadsWithHttpInfo

public ApiResponse<PromptAssetUpload> postArchitectSystempromptResourceUploadsWithHttpInfo(String promptId,
 String languageCode)
                                                                                    throws IOException

Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

Returns:

PromptAssetUpload

Throws:

IOException - if the request fails to be processed

postArchitectSystempromptResourceUploads

public PromptAssetUpload postArchitectSystempromptResourceUploads(PostArchitectSystempromptResourceUploadsRequest request)
                                                           throws IOException,
ApiException

Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads 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:

PromptAssetUpload

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSystempromptResourceUploads

public ApiResponse<PromptAssetUpload> postArchitectSystempromptResourceUploads(ApiRequest<Void> request)
                                                                        throws IOException

Creates a presigned URL for uploading a system prompt file postArchitectSystempromptResourceUploads 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

postArchitectSystempromptResources

public SystemPromptAsset postArchitectSystempromptResources(String promptId,
 SystemPromptAsset body)
                                                     throws IOException,
ApiException

Create system prompt resource override.

Parameters:

promptId - Prompt ID (required)

body - (required)

Returns:

SystemPromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSystempromptResourcesWithHttpInfo

public ApiResponse<SystemPromptAsset> postArchitectSystempromptResourcesWithHttpInfo(String promptId,
 SystemPromptAsset body)
                                                                              throws IOException

Create system prompt resource override.

Parameters:

promptId - Prompt ID (required)

body - (required)

Returns:

SystemPromptAsset

Throws:

IOException - if the request fails to be processed

postArchitectSystempromptResources

public SystemPromptAsset postArchitectSystempromptResources(PostArchitectSystempromptResourcesRequest request)
                                                     throws IOException,
ApiException

Create system prompt resource override.

Parameters:

request - The request object

Returns:

SystemPromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postArchitectSystempromptResources

public ApiResponse<SystemPromptAsset> postArchitectSystempromptResources(ApiRequest<SystemPromptAsset> request)
                                                                  throws IOException

Create system prompt resource override.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowHistory

public Operation postFlowHistory(String flowId)
                          throws IOException,
ApiException

Generate flow history Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

flowId - Flow ID (required)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowHistoryWithHttpInfo

public ApiResponse<Operation> postFlowHistoryWithHttpInfo(String flowId)
                                                   throws IOException

Generate flow history Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

flowId - Flow ID (required)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

postFlowHistory

public Operation postFlowHistory(PostFlowHistoryRequest request)
                          throws IOException,
ApiException

Generate flow history Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowHistory

public ApiResponse<Operation> postFlowHistory(ApiRequest<Void> request)
                                       throws IOException

Generate flow history Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowInstancesSettingsLoglevels

public FlowSettingsResponse postFlowInstancesSettingsLoglevels(String flowId,
 FlowLogLevelRequest body,
 List<String> expand)
                                                        throws IOException,
ApiException

Set the logLevel for a particular flow id Assigns a new loglevel to a flow id

Parameters:

flowId - The flow id to set the loglevel for (required)

body - New LogLevel settings (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowInstancesSettingsLoglevelsWithHttpInfo

public ApiResponse<FlowSettingsResponse> postFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId,
 FlowLogLevelRequest body,
 List<String> expand)
                                                                                 throws IOException

Set the logLevel for a particular flow id Assigns a new loglevel to a flow id

Parameters:

flowId - The flow id to set the loglevel for (required)

body - New LogLevel settings (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

IOException - if the request fails to be processed

postFlowInstancesSettingsLoglevels

public FlowSettingsResponse postFlowInstancesSettingsLoglevels(PostFlowInstancesSettingsLoglevelsRequest request)
                                                        throws IOException,
ApiException

Set the logLevel for a particular flow id Assigns a new loglevel to a flow id

Parameters:

request - The request object

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowInstancesSettingsLoglevels

public ApiResponse<FlowSettingsResponse> postFlowInstancesSettingsLoglevels(ApiRequest<FlowLogLevelRequest> request)
                                                                     throws IOException

Set the logLevel for a particular flow id Assigns a new loglevel to a flow id

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowVersions

public FlowVersion postFlowVersions(String flowId,
 Object body)
                             throws IOException,
ApiException

Create flow version

Parameters:

flowId - Flow ID (required)

body - (required)

Returns:

FlowVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowVersionsWithHttpInfo

public ApiResponse<FlowVersion> postFlowVersionsWithHttpInfo(String flowId,
 Object body)
                                                      throws IOException

Create flow version

Parameters:

flowId - Flow ID (required)

body - (required)

Returns:

FlowVersion

Throws:

IOException - if the request fails to be processed

postFlowVersions

public FlowVersion postFlowVersions(PostFlowVersionsRequest request)
                             throws IOException,
ApiException

Create flow version

Parameters:

request - The request object

Returns:

FlowVersion

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowVersions

public ApiResponse<FlowVersion> postFlowVersions(ApiRequest<Object> request)
                                          throws IOException

Create flow version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlows

public Flow postFlows(Flow body,
 String language)
               throws IOException,
ApiException

Create flow

Parameters:

body - (required)

language - Language (optional)

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsWithHttpInfo

public ApiResponse<Flow> postFlowsWithHttpInfo(Flow body,
 String language)
                                        throws IOException

Create flow

Parameters:

body - (required)

language - Language (optional)

Returns:

Flow

Throws:

IOException - if the request fails to be processed

postFlows

public Flow postFlows(PostFlowsRequest request)
               throws IOException,
ApiException

Create flow

Parameters:

request - The request object

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlows

public ApiResponse<Flow> postFlows(ApiRequest<Flow> request)
                            throws IOException

Create flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsActionsCheckin

public Operation postFlowsActionsCheckin(String flow)
                                  throws IOException,
ApiException

Check-in flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

flow - Flow ID (required)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsCheckinWithHttpInfo

public ApiResponse<Operation> postFlowsActionsCheckinWithHttpInfo(String flow)
                                                           throws IOException

Check-in flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

flow - Flow ID (required)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

postFlowsActionsCheckin

public Operation postFlowsActionsCheckin(PostFlowsActionsCheckinRequest request)
                                  throws IOException,
ApiException

Check-in flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsCheckin

public ApiResponse<Operation> postFlowsActionsCheckin(ApiRequest<Void> request)
                                               throws IOException

Check-in flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsActionsCheckout

public Flow postFlowsActionsCheckout(String flow)
                              throws IOException,
ApiException

Check-out flow

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsCheckoutWithHttpInfo

public ApiResponse<Flow> postFlowsActionsCheckoutWithHttpInfo(String flow)
                                                       throws IOException

Check-out flow

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

IOException - if the request fails to be processed

postFlowsActionsCheckout

public Flow postFlowsActionsCheckout(PostFlowsActionsCheckoutRequest request)
                              throws IOException,
ApiException

Check-out flow

Parameters:

request - The request object

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsCheckout

public ApiResponse<Flow> postFlowsActionsCheckout(ApiRequest<Void> request)
                                           throws IOException

Check-out flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsActionsDeactivate

public Flow postFlowsActionsDeactivate(String flow)
                                throws IOException,
ApiException

Deactivate flow

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsDeactivateWithHttpInfo

public ApiResponse<Flow> postFlowsActionsDeactivateWithHttpInfo(String flow)
                                                         throws IOException

Deactivate flow

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

IOException - if the request fails to be processed

postFlowsActionsDeactivate

public Flow postFlowsActionsDeactivate(PostFlowsActionsDeactivateRequest request)
                                throws IOException,
ApiException

Deactivate flow

Parameters:

request - The request object

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsDeactivate

public ApiResponse<Flow> postFlowsActionsDeactivate(ApiRequest<Void> request)
                                             throws IOException

Deactivate flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsActionsPublish

public Operation postFlowsActionsPublish(String flow,
 String version)
                                  throws IOException,
ApiException

Publish flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

flow - Flow ID (required)

version - version (optional)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsPublishWithHttpInfo

public ApiResponse<Operation> postFlowsActionsPublishWithHttpInfo(String flow,
 String version)
                                                           throws IOException

Publish flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

flow - Flow ID (required)

version - version (optional)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

postFlowsActionsPublish

public Operation postFlowsActionsPublish(PostFlowsActionsPublishRequest request)
                                  throws IOException,
ApiException

Publish flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsPublish

public ApiResponse<Operation> postFlowsActionsPublish(ApiRequest<Void> request)
                                               throws IOException

Publish flow Asynchronous. Notification topic: v2.flows.{flowId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsActionsRevert

public Flow postFlowsActionsRevert(String flow)
                            throws IOException,
ApiException

Revert flow

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsRevertWithHttpInfo

public ApiResponse<Flow> postFlowsActionsRevertWithHttpInfo(String flow)
                                                     throws IOException

Revert flow

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

IOException - if the request fails to be processed

postFlowsActionsRevert

public Flow postFlowsActionsRevert(PostFlowsActionsRevertRequest request)
                            throws IOException,
ApiException

Revert flow

Parameters:

request - The request object

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsRevert

public ApiResponse<Flow> postFlowsActionsRevert(ApiRequest<Void> request)
                                         throws IOException

Revert flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsActionsUnlock

public Flow postFlowsActionsUnlock(String flow)
                            throws IOException,
ApiException

Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsUnlockWithHttpInfo

public ApiResponse<Flow> postFlowsActionsUnlockWithHttpInfo(String flow)
                                                     throws IOException

Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

Parameters:

flow - Flow ID (required)

Returns:

Flow

Throws:

IOException - if the request fails to be processed

postFlowsActionsUnlock

public Flow postFlowsActionsUnlock(PostFlowsActionsUnlockRequest request)
                            throws IOException,
ApiException

Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

Parameters:

request - The request object

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsActionsUnlock

public ApiResponse<Flow> postFlowsActionsUnlock(ApiRequest<Void> request)
                                         throws IOException

Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsDatatableExportJobs

public DataTableExportJob postFlowsDatatableExportJobs(String datatableId)
                                                throws IOException,
ApiException

Begin an export process for exporting all rows from a datatable Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response

Parameters:

datatableId - id of datatable (required)

Returns:

DataTableExportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableExportJobsWithHttpInfo

public ApiResponse<DataTableExportJob> postFlowsDatatableExportJobsWithHttpInfo(String datatableId)
                                                                         throws IOException

Begin an export process for exporting all rows from a datatable Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response

Parameters:

datatableId - id of datatable (required)

Returns:

DataTableExportJob

Throws:

IOException - if the request fails to be processed

postFlowsDatatableExportJobs

public DataTableExportJob postFlowsDatatableExportJobs(PostFlowsDatatableExportJobsRequest request)
                                                throws IOException,
ApiException

Begin an export process for exporting all rows from a datatable Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response

Parameters:

request - The request object

Returns:

DataTableExportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableExportJobs

public ApiResponse<DataTableExportJob> postFlowsDatatableExportJobs(ApiRequest<Void> request)
                                                             throws IOException

Begin an export process for exporting all rows from a datatable Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsDatatableImportCsvJobs

public DataTableImportJob postFlowsDatatableImportCsvJobs(String datatableId,
 DataTableImportJob body)
                                                   throws IOException,
ApiException

Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field. Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response

Parameters:

datatableId - id of datatable (required)

body - import job information (required)

Returns:

DataTableImportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableImportCsvJobsWithHttpInfo

public ApiResponse<DataTableImportJob> postFlowsDatatableImportCsvJobsWithHttpInfo(String datatableId,
 DataTableImportJob body)
                                                                            throws IOException

Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field. Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response

Parameters:

datatableId - id of datatable (required)

body - import job information (required)

Returns:

DataTableImportJob

Throws:

IOException - if the request fails to be processed

postFlowsDatatableImportCsvJobs

public DataTableImportJob postFlowsDatatableImportCsvJobs(PostFlowsDatatableImportCsvJobsRequest request)
                                                   throws IOException,
ApiException

Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field. Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response

Parameters:

request - The request object

Returns:

DataTableImportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableImportCsvJobs

public ApiResponse<DataTableImportJob> postFlowsDatatableImportCsvJobs(ApiRequest<DataTableImportJob> request)
                                                                throws IOException

Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field. Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsDatatableImportJobs

public DataTableImportJob postFlowsDatatableImportJobs(String datatableId,
 DataTableImportJob body)
                                                throws IOException,
ApiException

Deprecated.

Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response

Parameters:

datatableId - id of datatable (required)

body - import job information (required)

Returns:

DataTableImportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableImportJobsWithHttpInfo

public ApiResponse<DataTableImportJob> postFlowsDatatableImportJobsWithHttpInfo(String datatableId,
 DataTableImportJob body)
                                                                         throws IOException

Deprecated.

Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response

Parameters:

datatableId - id of datatable (required)

body - import job information (required)

Returns:

DataTableImportJob

Throws:

IOException - if the request fails to be processed

postFlowsDatatableImportJobs

public DataTableImportJob postFlowsDatatableImportJobs(PostFlowsDatatableImportJobsRequest request)
                                                throws IOException,
ApiException

Deprecated.

Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response

Parameters:

request - The request object

Returns:

DataTableImportJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableImportJobs

public ApiResponse<DataTableImportJob> postFlowsDatatableImportJobs(ApiRequest<DataTableImportJob> request)
                                                             throws IOException

Deprecated.

Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsDatatableRows

public Map<String,Object> postFlowsDatatableRows(String datatableId,
 Object dataTableRow)
                                          throws IOException,
ApiException

Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

datatableId - id of datatable (required)

dataTableRow - (required)

Returns:

Map<String, Object>

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableRowsWithHttpInfo

public ApiResponse<Map<String,Object>> postFlowsDatatableRowsWithHttpInfo(String datatableId,
 Object dataTableRow)
                                                                   throws IOException

Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

datatableId - id of datatable (required)

dataTableRow - (required)

Returns:

Map<String, Object>

Throws:

IOException - if the request fails to be processed

postFlowsDatatableRows

public Map<String,Object> postFlowsDatatableRows(PostFlowsDatatableRowsRequest request)
                                          throws IOException,
ApiException

Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

request - The request object

Returns:

Map<String, Object>

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatableRows

public ApiResponse<Map<String,Object>> postFlowsDatatableRows(ApiRequest<Object> request)
                                                       throws IOException

Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsDatatables

public DataTable postFlowsDatatables(DataTable body)
                              throws IOException,
ApiException

Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/

Parameters:

body - datatable json-schema (required)

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatablesWithHttpInfo

public ApiResponse<DataTable> postFlowsDatatablesWithHttpInfo(DataTable body)
                                                       throws IOException

Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/

Parameters:

body - datatable json-schema (required)

Returns:

DataTable

Throws:

IOException - if the request fails to be processed

postFlowsDatatables

public DataTable postFlowsDatatables(PostFlowsDatatablesRequest request)
                              throws IOException,
ApiException

Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/

Parameters:

request - The request object

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsDatatables

public ApiResponse<DataTable> postFlowsDatatables(ApiRequest<DataTable> request)
                                           throws IOException

Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsExecutions

public FlowExecutionLaunchResponse postFlowsExecutions(FlowExecutionLaunchRequest flowLaunchRequest)
                                                throws IOException,
ApiException

Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.

Parameters:

flowLaunchRequest - (required)

Returns:

FlowExecutionLaunchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsExecutionsWithHttpInfo

public ApiResponse<FlowExecutionLaunchResponse> postFlowsExecutionsWithHttpInfo(FlowExecutionLaunchRequest flowLaunchRequest)
                                                                         throws IOException

Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.

Parameters:

flowLaunchRequest - (required)

Returns:

FlowExecutionLaunchResponse

Throws:

IOException - if the request fails to be processed

postFlowsExecutions

public FlowExecutionLaunchResponse postFlowsExecutions(PostFlowsExecutionsRequest request)
                                                throws IOException,
ApiException

Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.

Parameters:

request - The request object

Returns:

FlowExecutionLaunchResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsExecutions

public ApiResponse<FlowExecutionLaunchResponse> postFlowsExecutions(ApiRequest<FlowExecutionLaunchRequest> request)
                                                             throws IOException

Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsExportJobs

public RegisterArchitectExportJobResponse postFlowsExportJobs(RegisterArchitectExportJob body)
                                                       throws IOException,
ApiException

Register Architect Export Job

Parameters:

body - (required)

Returns:

RegisterArchitectExportJobResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsExportJobsWithHttpInfo

public ApiResponse<RegisterArchitectExportJobResponse> postFlowsExportJobsWithHttpInfo(RegisterArchitectExportJob body)
                                                                                throws IOException

Register Architect Export Job

Parameters:

body - (required)

Returns:

RegisterArchitectExportJobResponse

Throws:

IOException - if the request fails to be processed

postFlowsExportJobs

public RegisterArchitectExportJobResponse postFlowsExportJobs(PostFlowsExportJobsRequest request)
                                                       throws IOException,
ApiException

Register Architect Export Job

Parameters:

request - The request object

Returns:

RegisterArchitectExportJobResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsExportJobs

public ApiResponse<RegisterArchitectExportJobResponse> postFlowsExportJobs(ApiRequest<RegisterArchitectExportJob> request)
                                                                    throws IOException

Register Architect Export Job

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsInstancesJobs

public GetFlowExecutionDataJobResult postFlowsInstancesJobs(ExecutionDataRequest body,
 String expand)
                                                     throws IOException,
ApiException

Start a process (job) that will prepare a list of execution data IDs for download. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

body - Requested Flow Ids (required)

expand - Expand various query types. (optional)

Returns:

GetFlowExecutionDataJobResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsInstancesJobsWithHttpInfo

public ApiResponse<GetFlowExecutionDataJobResult> postFlowsInstancesJobsWithHttpInfo(ExecutionDataRequest body,
 String expand)
                                                                              throws IOException

Start a process (job) that will prepare a list of execution data IDs for download. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

body - Requested Flow Ids (required)

expand - Expand various query types. (optional)

Returns:

GetFlowExecutionDataJobResult

Throws:

IOException - if the request fails to be processed

postFlowsInstancesJobs

public GetFlowExecutionDataJobResult postFlowsInstancesJobs(PostFlowsInstancesJobsRequest request)
                                                     throws IOException,
ApiException

Start a process (job) that will prepare a list of execution data IDs for download. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

request - The request object

Returns:

GetFlowExecutionDataJobResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsInstancesJobs

public ApiResponse<GetFlowExecutionDataJobResult> postFlowsInstancesJobs(ApiRequest<ExecutionDataRequest> request)
                                                                  throws IOException

Start a process (job) that will prepare a list of execution data IDs for download. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsInstancesQuery

public FlowResultEntityListing postFlowsInstancesQuery(CriteriaQuery body,
 Boolean indexOnly,
 Integer pageSize)
                                                throws IOException,
ApiException

Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.

Parameters:

body - query (required)

indexOnly - indexes only (optional)

pageSize - number of results to return (optional, default to 50)

Returns:

FlowResultEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsInstancesQueryWithHttpInfo

public ApiResponse<FlowResultEntityListing> postFlowsInstancesQueryWithHttpInfo(CriteriaQuery body,
 Boolean indexOnly,
 Integer pageSize)
                                                                         throws IOException

Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.

Parameters:

body - query (required)

indexOnly - indexes only (optional)

pageSize - number of results to return (optional, default to 50)

Returns:

FlowResultEntityListing

Throws:

IOException - if the request fails to be processed

postFlowsInstancesQuery

public FlowResultEntityListing postFlowsInstancesQuery(PostFlowsInstancesQueryRequest request)
                                                throws IOException,
ApiException

Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.

Parameters:

request - The request object

Returns:

FlowResultEntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsInstancesQuery

public ApiResponse<FlowResultEntityListing> postFlowsInstancesQuery(ApiRequest<CriteriaQuery> request)
                                                             throws IOException

Query the database of existing flow histories to look for particular flow criteria Returns a list of matching flow histories up to 200 max.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsJobs

public RegisterArchitectJobResponse postFlowsJobs(Object body)
                                           throws IOException,
ApiException

Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.

Parameters:

body - (optional)

Returns:

RegisterArchitectJobResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsJobsWithHttpInfo

public ApiResponse<RegisterArchitectJobResponse> postFlowsJobsWithHttpInfo(Object body)
                                                                    throws IOException

Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.

Parameters:

body - (optional)

Returns:

RegisterArchitectJobResponse

Throws:

IOException - if the request fails to be processed

postFlowsJobs

public RegisterArchitectJobResponse postFlowsJobs(PostFlowsJobsRequest request)
                                           throws IOException,
ApiException

Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.

Parameters:

request - The request object

Returns:

RegisterArchitectJobResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsJobs

public ApiResponse<RegisterArchitectJobResponse> postFlowsJobs(ApiRequest<Object> request)
                                                        throws IOException

Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsMilestones

public FlowMilestone postFlowsMilestones(FlowMilestone body)
                                  throws IOException,
ApiException

Create a flow milestone

Parameters:

body - (optional)

Returns:

FlowMilestone

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsMilestonesWithHttpInfo

public ApiResponse<FlowMilestone> postFlowsMilestonesWithHttpInfo(FlowMilestone body)
                                                           throws IOException

Create a flow milestone

Parameters:

body - (optional)

Returns:

FlowMilestone

Throws:

IOException - if the request fails to be processed

postFlowsMilestones

public FlowMilestone postFlowsMilestones(PostFlowsMilestonesRequest request)
                                  throws IOException,
ApiException

Create a flow milestone

Parameters:

request - The request object

Returns:

FlowMilestone

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsMilestones

public ApiResponse<FlowMilestone> postFlowsMilestones(ApiRequest<FlowMilestone> request)
                                               throws IOException

Create a flow milestone

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postFlowsOutcomes

public FlowOutcome postFlowsOutcomes(FlowOutcome body)
                              throws IOException,
ApiException

Create a flow outcome Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}

Parameters:

body - (optional)

Returns:

FlowOutcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsOutcomesWithHttpInfo

public ApiResponse<FlowOutcome> postFlowsOutcomesWithHttpInfo(FlowOutcome body)
                                                       throws IOException

Create a flow outcome Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}

Parameters:

body - (optional)

Returns:

FlowOutcome

Throws:

IOException - if the request fails to be processed

postFlowsOutcomes

public FlowOutcome postFlowsOutcomes(PostFlowsOutcomesRequest request)
                              throws IOException,
ApiException

Create a flow outcome Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}

Parameters:

request - The request object

Returns:

FlowOutcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postFlowsOutcomes

public ApiResponse<FlowOutcome> postFlowsOutcomes(ApiRequest<FlowOutcome> request)
                                           throws IOException

Create a flow outcome Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectEmergencygroup

public EmergencyGroup putArchitectEmergencygroup(String emergencyGroupId,
 EmergencyGroup body)
                                          throws IOException,
ApiException

Updates a emergency group by ID

Parameters:

emergencyGroupId - Emergency group ID (required)

body - (required)

Returns:

EmergencyGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectEmergencygroupWithHttpInfo

public ApiResponse<EmergencyGroup> putArchitectEmergencygroupWithHttpInfo(String emergencyGroupId,
 EmergencyGroup body)
                                                                   throws IOException

Updates a emergency group by ID

Parameters:

emergencyGroupId - Emergency group ID (required)

body - (required)

Returns:

EmergencyGroup

Throws:

IOException - if the request fails to be processed

putArchitectEmergencygroup

public EmergencyGroup putArchitectEmergencygroup(PutArchitectEmergencygroupRequest request)
                                          throws IOException,
ApiException

Updates a emergency group by ID

Parameters:

request - The request object

Returns:

EmergencyGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectEmergencygroup

public ApiResponse<EmergencyGroup> putArchitectEmergencygroup(ApiRequest<EmergencyGroup> request)
                                                       throws IOException

Updates a emergency group by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectIvr

public IVR putArchitectIvr(String ivrId,
 IVR body)
                    throws IOException,
ApiException

Update an IVR Config.

Parameters:

ivrId - IVR id (required)

body - (required)

Returns:

IVR

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectIvrWithHttpInfo

public ApiResponse<IVR> putArchitectIvrWithHttpInfo(String ivrId,
 IVR body)
                                             throws IOException

Update an IVR Config.

Parameters:

ivrId - IVR id (required)

body - (required)

Returns:

IVR

Throws:

IOException - if the request fails to be processed

putArchitectIvr

public IVR putArchitectIvr(PutArchitectIvrRequest request)
                    throws IOException,
ApiException

Update an IVR Config.

Parameters:

request - The request object

Returns:

IVR

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectIvr

public ApiResponse<IVR> putArchitectIvr(ApiRequest<IVR> request)
                                 throws IOException

Update an IVR Config.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectIvrIdentityresolution

public IVRIdentityResolutionConfig putArchitectIvrIdentityresolution(String ivrId,
 IVRIdentityResolutionConfig body)
                                                              throws IOException,
ApiException

Update an IVR IdentityResolutionConfig.

Parameters:

ivrId - IVR id (required)

body - (required)

Returns:

IVRIdentityResolutionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectIvrIdentityresolutionWithHttpInfo

public ApiResponse<IVRIdentityResolutionConfig> putArchitectIvrIdentityresolutionWithHttpInfo(String ivrId,
 IVRIdentityResolutionConfig body)
                                                                                       throws IOException

Update an IVR IdentityResolutionConfig.

Parameters:

ivrId - IVR id (required)

body - (required)

Returns:

IVRIdentityResolutionConfig

Throws:

IOException - if the request fails to be processed

putArchitectIvrIdentityresolution

public IVRIdentityResolutionConfig putArchitectIvrIdentityresolution(PutArchitectIvrIdentityresolutionRequest request)
                                                              throws IOException,
ApiException

Update an IVR IdentityResolutionConfig.

Parameters:

request - The request object

Returns:

IVRIdentityResolutionConfig

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectIvrIdentityresolution

public ApiResponse<IVRIdentityResolutionConfig> putArchitectIvrIdentityresolution(ApiRequest<IVRIdentityResolutionConfig> request)
                                                                           throws IOException

Update an IVR IdentityResolutionConfig.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectPrompt

public Prompt putArchitectPrompt(String promptId,
 Prompt body)
                          throws IOException,
ApiException

Update specified user prompt

Parameters:

promptId - Prompt ID (required)

body - (required)

Returns:

Prompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectPromptWithHttpInfo

public ApiResponse<Prompt> putArchitectPromptWithHttpInfo(String promptId,
 Prompt body)
                                                   throws IOException

Update specified user prompt

Parameters:

promptId - Prompt ID (required)

body - (required)

Returns:

Prompt

Throws:

IOException - if the request fails to be processed

putArchitectPrompt

public Prompt putArchitectPrompt(PutArchitectPromptRequest request)
                          throws IOException,
ApiException

Update specified user prompt

Parameters:

request - The request object

Returns:

Prompt

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectPrompt

public ApiResponse<Prompt> putArchitectPrompt(ApiRequest<Prompt> request)
                                       throws IOException

Update specified user prompt

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectPromptResource

public PromptAsset putArchitectPromptResource(String promptId,
 String languageCode,
 PromptAsset body)
                                       throws IOException,
ApiException

Update specified user prompt resource

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

body - (required)

Returns:

PromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectPromptResourceWithHttpInfo

public ApiResponse<PromptAsset> putArchitectPromptResourceWithHttpInfo(String promptId,
 String languageCode,
 PromptAsset body)
                                                                throws IOException

Update specified user prompt resource

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

body - (required)

Returns:

PromptAsset

Throws:

IOException - if the request fails to be processed

putArchitectPromptResource

public PromptAsset putArchitectPromptResource(PutArchitectPromptResourceRequest request)
                                       throws IOException,
ApiException

Update specified user prompt resource

Parameters:

request - The request object

Returns:

PromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectPromptResource

public ApiResponse<PromptAsset> putArchitectPromptResource(ApiRequest<PromptAsset> request)
                                                    throws IOException

Update specified user prompt resource

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectSchedule

public Schedule putArchitectSchedule(String scheduleId,
 Schedule body)
                              throws IOException,
ApiException

Update schedule by ID

Parameters:

scheduleId - Schedule ID (required)

body - (required)

Returns:

Schedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectScheduleWithHttpInfo

public ApiResponse<Schedule> putArchitectScheduleWithHttpInfo(String scheduleId,
 Schedule body)
                                                       throws IOException

Update schedule by ID

Parameters:

scheduleId - Schedule ID (required)

body - (required)

Returns:

Schedule

Throws:

IOException - if the request fails to be processed

putArchitectSchedule

public Schedule putArchitectSchedule(PutArchitectScheduleRequest request)
                              throws IOException,
ApiException

Update schedule by ID

Parameters:

request - The request object

Returns:

Schedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectSchedule

public ApiResponse<Schedule> putArchitectSchedule(ApiRequest<Schedule> request)
                                           throws IOException

Update schedule by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectSchedulegroup

public ScheduleGroup putArchitectSchedulegroup(String scheduleGroupId,
 ScheduleGroup body)
                                        throws IOException,
ApiException

Updates a schedule group by ID

Parameters:

scheduleGroupId - Schedule group ID (required)

body - (required)

Returns:

ScheduleGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectSchedulegroupWithHttpInfo

public ApiResponse<ScheduleGroup> putArchitectSchedulegroupWithHttpInfo(String scheduleGroupId,
 ScheduleGroup body)
                                                                 throws IOException

Updates a schedule group by ID

Parameters:

scheduleGroupId - Schedule group ID (required)

body - (required)

Returns:

ScheduleGroup

Throws:

IOException - if the request fails to be processed

putArchitectSchedulegroup

public ScheduleGroup putArchitectSchedulegroup(PutArchitectSchedulegroupRequest request)
                                        throws IOException,
ApiException

Updates a schedule group by ID

Parameters:

request - The request object

Returns:

ScheduleGroup

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectSchedulegroup

public ApiResponse<ScheduleGroup> putArchitectSchedulegroup(ApiRequest<ScheduleGroup> request)
                                                     throws IOException

Updates a schedule group by ID

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putArchitectSystempromptResource

public SystemPromptAsset putArchitectSystempromptResource(String promptId,
 String languageCode,
 SystemPromptAsset body)
                                                   throws IOException,
ApiException

Updates a system prompt resource override.

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

body - (required)

Returns:

SystemPromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectSystempromptResourceWithHttpInfo

public ApiResponse<SystemPromptAsset> putArchitectSystempromptResourceWithHttpInfo(String promptId,
 String languageCode,
 SystemPromptAsset body)
                                                                            throws IOException

Updates a system prompt resource override.

Parameters:

promptId - Prompt ID (required)

languageCode - Language (required)

body - (required)

Returns:

SystemPromptAsset

Throws:

IOException - if the request fails to be processed

putArchitectSystempromptResource

public SystemPromptAsset putArchitectSystempromptResource(PutArchitectSystempromptResourceRequest request)
                                                   throws IOException,
ApiException

Updates a system prompt resource override.

Parameters:

request - The request object

Returns:

SystemPromptAsset

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putArchitectSystempromptResource

public ApiResponse<SystemPromptAsset> putArchitectSystempromptResource(ApiRequest<SystemPromptAsset> request)
                                                                throws IOException

Updates a system prompt resource override.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFlow

public Flow putFlow(String flowId,
 Flow body)
             throws IOException,
ApiException

Update flow

Parameters:

flowId - Flow ID (required)

body - (required)

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowWithHttpInfo

public ApiResponse<Flow> putFlowWithHttpInfo(String flowId,
 Flow body)
                                      throws IOException

Update flow

Parameters:

flowId - Flow ID (required)

body - (required)

Returns:

Flow

Throws:

IOException - if the request fails to be processed

putFlow

public Flow putFlow(PutFlowRequest request)
             throws IOException,
ApiException

Update flow

Parameters:

request - The request object

Returns:

Flow

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlow

public ApiResponse<Flow> putFlow(ApiRequest<Flow> request)
                          throws IOException

Update flow

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFlowInstancesSettingsLoglevels

public FlowSettingsResponse putFlowInstancesSettingsLoglevels(String flowId,
 FlowLogLevelRequest body,
 List<String> expand)
                                                       throws IOException,
ApiException

Edit the logLevel for a particular flow id Updates the loglevel for a flow id

Parameters:

flowId - The flow id to edit the loglevel for (required)

body - New LogLevel settings (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowInstancesSettingsLoglevelsWithHttpInfo

public ApiResponse<FlowSettingsResponse> putFlowInstancesSettingsLoglevelsWithHttpInfo(String flowId,
 FlowLogLevelRequest body,
 List<String> expand)
                                                                                throws IOException

Edit the logLevel for a particular flow id Updates the loglevel for a flow id

Parameters:

flowId - The flow id to edit the loglevel for (required)

body - New LogLevel settings (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

IOException - if the request fails to be processed

putFlowInstancesSettingsLoglevels

public FlowSettingsResponse putFlowInstancesSettingsLoglevels(PutFlowInstancesSettingsLoglevelsRequest request)
                                                       throws IOException,
ApiException

Edit the logLevel for a particular flow id Updates the loglevel for a flow id

Parameters:

request - The request object

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowInstancesSettingsLoglevels

public ApiResponse<FlowSettingsResponse> putFlowInstancesSettingsLoglevels(ApiRequest<FlowLogLevelRequest> request)
                                                                    throws IOException

Edit the logLevel for a particular flow id Updates the loglevel for a flow id

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFlowsDatatable

public DataTable putFlowsDatatable(String datatableId,
 DataTable body,
 String expand)
                            throws IOException,
ApiException

Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.

Parameters:

datatableId - id of datatable (required)

body - datatable json-schema (required)

expand - Expand instructions for the result (optional)

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsDatatableWithHttpInfo

public ApiResponse<DataTable> putFlowsDatatableWithHttpInfo(String datatableId,
 DataTable body,
 String expand)
                                                     throws IOException

Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.

Parameters:

datatableId - id of datatable (required)

body - datatable json-schema (required)

expand - Expand instructions for the result (optional)

Returns:

DataTable

Throws:

IOException - if the request fails to be processed

putFlowsDatatable

public DataTable putFlowsDatatable(PutFlowsDatatableRequest request)
                            throws IOException,
ApiException

Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.

Parameters:

request - The request object

Returns:

DataTable

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsDatatable

public ApiResponse<DataTable> putFlowsDatatable(ApiRequest<DataTable> request)
                                         throws IOException

Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFlowsDatatableRow

public Map<String,Object> putFlowsDatatableRow(String datatableId,
 String rowId,
 Object body)
                                        throws IOException,
ApiException

Update a row entry Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

datatableId - id of datatable (required)

rowId - the key for the row (required)

body - datatable row (optional)

Returns:

Map<String, Object>

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsDatatableRowWithHttpInfo

public ApiResponse<Map<String,Object>> putFlowsDatatableRowWithHttpInfo(String datatableId,
 String rowId,
 Object body)
                                                                 throws IOException

Update a row entry Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

datatableId - id of datatable (required)

rowId - the key for the row (required)

body - datatable row (optional)

Returns:

Map<String, Object>

Throws:

IOException - if the request fails to be processed

putFlowsDatatableRow

public Map<String,Object> putFlowsDatatableRow(PutFlowsDatatableRowRequest request)
                                        throws IOException,
ApiException

Update a row entry Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

request - The request object

Returns:

Map<String, Object>

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsDatatableRow

public ApiResponse<Map<String,Object>> putFlowsDatatableRow(ApiRequest<Object> request)
                                                     throws IOException

Update a row entry Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" }

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFlowsInstancesSettingsLoglevelsDefault

public FlowSettingsResponse putFlowsInstancesSettingsLoglevelsDefault(FlowLogLevelRequest body,
 List<String> expand)
                                                               throws IOException,
ApiException

Edit the flow default log level. Edit the flow default log level.

Parameters:

body - New LogLevel settings (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo

public ApiResponse<FlowSettingsResponse> putFlowsInstancesSettingsLoglevelsDefaultWithHttpInfo(FlowLogLevelRequest body,
 List<String> expand)
                                                                                        throws IOException

Edit the flow default log level. Edit the flow default log level.

Parameters:

body - New LogLevel settings (required)

expand - Expand instructions for the result (optional)

Returns:

FlowSettingsResponse

Throws:

IOException - if the request fails to be processed

putFlowsInstancesSettingsLoglevelsDefault

public FlowSettingsResponse putFlowsInstancesSettingsLoglevelsDefault(PutFlowsInstancesSettingsLoglevelsDefaultRequest request)
                                                               throws IOException,
ApiException

Edit the flow default log level. Edit the flow default log level.

Parameters:

request - The request object

Returns:

FlowSettingsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsInstancesSettingsLoglevelsDefault

public ApiResponse<FlowSettingsResponse> putFlowsInstancesSettingsLoglevelsDefault(ApiRequest<FlowLogLevelRequest> request)
                                                                            throws IOException

Edit the flow default log level. Edit the flow default log level.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFlowsMilestone

public FlowMilestone putFlowsMilestone(String milestoneId,
 FlowMilestone body)
                                throws IOException,
ApiException

Updates a flow milestone

Parameters:

milestoneId - flow milestone ID (required)

body - (optional)

Returns:

FlowMilestone

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsMilestoneWithHttpInfo

public ApiResponse<FlowMilestone> putFlowsMilestoneWithHttpInfo(String milestoneId,
 FlowMilestone body)
                                                         throws IOException

Updates a flow milestone

Parameters:

milestoneId - flow milestone ID (required)

body - (optional)

Returns:

FlowMilestone

Throws:

IOException - if the request fails to be processed

putFlowsMilestone

public FlowMilestone putFlowsMilestone(PutFlowsMilestoneRequest request)
                                throws IOException,
ApiException

Updates a flow milestone

Parameters:

request - The request object

Returns:

FlowMilestone

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsMilestone

public ApiResponse<FlowMilestone> putFlowsMilestone(ApiRequest<FlowMilestone> request)
                                             throws IOException

Updates a flow milestone

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putFlowsOutcome

public Operation putFlowsOutcome(String flowOutcomeId,
 FlowOutcome body)
                          throws IOException,
ApiException

Updates a flow outcome Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}

Parameters:

flowOutcomeId - flow outcome ID (required)

body - (optional)

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsOutcomeWithHttpInfo

public ApiResponse<Operation> putFlowsOutcomeWithHttpInfo(String flowOutcomeId,
 FlowOutcome body)
                                                   throws IOException

Updates a flow outcome Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}

Parameters:

flowOutcomeId - flow outcome ID (required)

body - (optional)

Returns:

Operation

Throws:

IOException - if the request fails to be processed

putFlowsOutcome

public Operation putFlowsOutcome(PutFlowsOutcomeRequest request)
                          throws IOException,
ApiException

Updates a flow outcome Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}

Parameters:

request - The request object

Returns:

Operation

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putFlowsOutcome

public ApiResponse<Operation> putFlowsOutcome(ApiRequest<FlowOutcome> request)
                                       throws IOException

Updates a flow outcome Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed