Uses of Class
com.mypurecloud.sdk.v2.model.Flow

Packages that use Flow

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.api.request
com.mypurecloud.sdk.v2.model

Uses of Flow in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return Flow

Modifier and Type	Method	Description
Flow	ArchitectApi.getFlow(GetFlowRequest request)	Get flow
Flow	ArchitectApi.getFlow(String flowId, Boolean deleted)	Get flow
Flow	ArchitectApi.postFlows(PostFlowsRequest request)	Create flow
Flow	ArchitectApi.postFlows(Flow body, String language)	Create flow
Flow	ArchitectApi.postFlowsActionsCheckout(PostFlowsActionsCheckoutRequest request)	Check-out flow
Flow	ArchitectApi.postFlowsActionsCheckout(String flow)	Check-out flow
Flow	ArchitectApi.postFlowsActionsDeactivate(PostFlowsActionsDeactivateRequest request)	Deactivate flow
Flow	ArchitectApi.postFlowsActionsDeactivate(String flow)	Deactivate flow
Flow	ArchitectApi.postFlowsActionsRevert(PostFlowsActionsRevertRequest request)	Revert flow
Flow	ArchitectApi.postFlowsActionsRevert(String flow)	Revert flow
Flow	ArchitectApi.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.
Flow	ArchitectApi.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.
Flow	ArchitectApi.putFlow(PutFlowRequest request)	Update flow
Flow	ArchitectApi.putFlow(String flowId, Flow body)	Update flow

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type Flow

Modifier and Type	Method	Description
ApiResponse<Flow>	ArchitectApi.getFlow(ApiRequest<Void> request)	Get flow
Future<Flow>	ArchitectApiAsync.getFlowAsync(GetFlowRequest request, AsyncApiCallback<Flow> callback)	Get flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.getFlowAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Get flow
ApiResponse<Flow>	ArchitectApi.getFlowWithHttpInfo(String flowId, Boolean deleted)	Get flow
ApiResponse<Flow>	ArchitectApi.postFlows(ApiRequest<Flow> request)	Create flow
ApiResponse<Flow>	ArchitectApi.postFlowsActionsCheckout(ApiRequest<Void> request)	Check-out flow
Future<Flow>	ArchitectApiAsync.postFlowsActionsCheckoutAsync(PostFlowsActionsCheckoutRequest request, AsyncApiCallback<Flow> callback)	Check-out flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsCheckoutAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Check-out flow
ApiResponse<Flow>	ArchitectApi.postFlowsActionsCheckoutWithHttpInfo(String flow)	Check-out flow
ApiResponse<Flow>	ArchitectApi.postFlowsActionsDeactivate(ApiRequest<Void> request)	Deactivate flow
Future<Flow>	ArchitectApiAsync.postFlowsActionsDeactivateAsync(PostFlowsActionsDeactivateRequest request, AsyncApiCallback<Flow> callback)	Deactivate flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsDeactivateAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Deactivate flow
ApiResponse<Flow>	ArchitectApi.postFlowsActionsDeactivateWithHttpInfo(String flow)	Deactivate flow
ApiResponse<Flow>	ArchitectApi.postFlowsActionsRevert(ApiRequest<Void> request)	Revert flow
Future<Flow>	ArchitectApiAsync.postFlowsActionsRevertAsync(PostFlowsActionsRevertRequest request, AsyncApiCallback<Flow> callback)	Revert flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsRevertAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Revert flow
ApiResponse<Flow>	ArchitectApi.postFlowsActionsRevertWithHttpInfo(String flow)	Revert flow
ApiResponse<Flow>	ArchitectApi.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.
Future<Flow>	ArchitectApiAsync.postFlowsActionsUnlockAsync(PostFlowsActionsUnlockRequest request, AsyncApiCallback<Flow> callback)	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.
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsUnlockAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	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>	ArchitectApi.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.
Future<Flow>	ArchitectApiAsync.postFlowsAsync(PostFlowsRequest request, AsyncApiCallback<Flow> callback)	Create flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsAsync(ApiRequest<Flow> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Create flow
ApiResponse<Flow>	ArchitectApi.postFlowsWithHttpInfo(Flow body, String language)	Create flow
ApiResponse<Flow>	ArchitectApi.putFlow(ApiRequest<Flow> request)	Update flow
Future<Flow>	ArchitectApiAsync.putFlowAsync(PutFlowRequest request, AsyncApiCallback<Flow> callback)	Update flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.putFlowAsync(ApiRequest<Flow> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Update flow
ApiResponse<Flow>	ArchitectApi.putFlowWithHttpInfo(String flowId, Flow body)	Update flow

Methods in com.mypurecloud.sdk.v2.api with parameters of type Flow

Modifier and Type	Method	Description
Flow	ArchitectApi.postFlows(Flow body, String language)	Create flow
ApiResponse<Flow>	ArchitectApi.postFlowsWithHttpInfo(Flow body, String language)	Create flow
Flow	ArchitectApi.putFlow(String flowId, Flow body)	Update flow
ApiResponse<Flow>	ArchitectApi.putFlowWithHttpInfo(String flowId, Flow body)	Update flow

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type Flow

Modifier and Type	Method	Description
Future<Flow>	ArchitectApiAsync.getFlowAsync(GetFlowRequest request, AsyncApiCallback<Flow> callback)	Get flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.getFlowAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Get flow
ApiResponse<Flow>	ArchitectApi.postFlows(ApiRequest<Flow> request)	Create flow
Future<Flow>	ArchitectApiAsync.postFlowsActionsCheckoutAsync(PostFlowsActionsCheckoutRequest request, AsyncApiCallback<Flow> callback)	Check-out flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsCheckoutAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Check-out flow
Future<Flow>	ArchitectApiAsync.postFlowsActionsDeactivateAsync(PostFlowsActionsDeactivateRequest request, AsyncApiCallback<Flow> callback)	Deactivate flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsDeactivateAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Deactivate flow
Future<Flow>	ArchitectApiAsync.postFlowsActionsRevertAsync(PostFlowsActionsRevertRequest request, AsyncApiCallback<Flow> callback)	Revert flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsRevertAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Revert flow
Future<Flow>	ArchitectApiAsync.postFlowsActionsUnlockAsync(PostFlowsActionsUnlockRequest request, AsyncApiCallback<Flow> callback)	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.
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsActionsUnlockAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Flow>> callback)	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.
Future<Flow>	ArchitectApiAsync.postFlowsAsync(PostFlowsRequest request, AsyncApiCallback<Flow> callback)	Create flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsAsync(ApiRequest<Flow> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Create flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.postFlowsAsync(ApiRequest<Flow> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Create flow
ApiResponse<Flow>	ArchitectApi.putFlow(ApiRequest<Flow> request)	Update flow
Future<Flow>	ArchitectApiAsync.putFlowAsync(PutFlowRequest request, AsyncApiCallback<Flow> callback)	Update flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.putFlowAsync(ApiRequest<Flow> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Update flow
Future<ApiResponse<Flow>>	ArchitectApiAsync.putFlowAsync(ApiRequest<Flow> request, AsyncApiCallback<ApiResponse<Flow>> callback)	Update flow

Uses of Flow in com.mypurecloud.sdk.v2.api.request

Methods in com.mypurecloud.sdk.v2.api.request that return Flow

Modifier and Type	Method	Description
Flow	PostFlowsRequest.getBody()
Flow	PutFlowRequest.getBody()

Methods in com.mypurecloud.sdk.v2.api.request that return types with arguments of type Flow

Modifier and Type	Method	Description
ApiRequest<Flow>	PostFlowsRequest.withHttpInfo()
ApiRequest<Flow>	PutFlowRequest.withHttpInfo()

Methods in com.mypurecloud.sdk.v2.api.request with parameters of type Flow

Modifier and Type	Method	Description
static PostFlowsRequest.Builder	PostFlowsRequest.builder(Flow body)
static PutFlowRequest.Builder	PutFlowRequest.builder(String flowId, Flow body)
void	PostFlowsRequest.setBody(Flow body)
void	PutFlowRequest.setBody(Flow body)
PostFlowsRequest.Builder	PostFlowsRequest.Builder.withBody(Flow body)
PostFlowsRequest	PostFlowsRequest.withBody(Flow body)
PutFlowRequest.Builder	PutFlowRequest.Builder.withBody(Flow body)
PutFlowRequest	PutFlowRequest.withBody(Flow body)
PostFlowsRequest.Builder	PostFlowsRequest.Builder.withRequiredParams(Flow body)
PutFlowRequest.Builder	PutFlowRequest.Builder.withRequiredParams(String flowId, Flow body)

Uses of Flow in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return Flow

Modifier and Type	Method	Description
Flow	Flow.active(Boolean active)
Flow	Flow.checkedInVersion(FlowVersion checkedInVersion)
Flow	Flow.currentOperation(Operation currentOperation)
Flow	Flow.debugVersion(FlowVersion debugVersion)
Flow	Flow.deleted(Boolean deleted)
Flow	Flow.description(String description)
Flow	Flow.division(WritableDivision division)	The division to which this entity belongs.
Flow	Recipient.getFlow()
Flow	Flow.id(String id)	The flow identifier
Flow	Flow.inputSchema(Object inputSchema)	json schema describing the inputs for the flow
Flow	Flow.lockedClient(DomainEntityRef lockedClient)	OAuth client that has the flow locked.
Flow	Flow.lockedUser(User lockedUser)	User that has the flow locked.
Flow	Flow.name(String name)	The flow name
Flow	Flow.outputSchema(Object outputSchema)	json schema describing the outputs for the flow
Flow	Flow.publishedBy(User publishedBy)
Flow	Flow.publishedVersion(FlowVersion publishedVersion)
Flow	Flow.savedVersion(FlowVersion savedVersion)
Flow	Flow.system(Boolean system)
Flow	Flow.type(Flow.TypeEnum type)
Flow	Flow.virtualAgentEnabled(Boolean virtualAgentEnabled)	Indicates whether virtual agent is enabled for this flow.
Flow	Flow.worktypeId(String worktypeId)

Methods in com.mypurecloud.sdk.v2.model that return types with arguments of type Flow

Modifier and Type	Method	Description
List<Flow>	FlowEntityListing.getEntities()

Methods in com.mypurecloud.sdk.v2.model with parameters of type Flow

Modifier and Type	Method	Description
Recipient	Recipient.flow(Flow flow)	An automate flow object which defines the set of actions to be taken, when a message is received by this recipient.
void	Recipient.setFlow(Flow flow)

Method parameters in com.mypurecloud.sdk.v2.model with type arguments of type Flow

Modifier and Type	Method	Description
FlowEntityListing	FlowEntityListing.entities(List<Flow> entities)
void	FlowEntityListing.setEntities(List<Flow> entities)