Package com.mypurecloud.sdk.v2.api

Class JourneyApi

java.lang.Object

com.mypurecloud.sdk.v2.api.JourneyApi

public class JourneyApi
extends Object

Constructor Summary

Constructors

Constructor	Description
JourneyApi()
JourneyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteAnalyticsJourneysAggregatesJob(DeleteAnalyticsJourneysAggregatesJobRequest request)	Delete/cancel an async request for journey aggregates
ApiResponse<Void>	deleteAnalyticsJourneysAggregatesJob(ApiRequest<Void> request)	Delete/cancel an async request for journey aggregates
void	deleteAnalyticsJourneysAggregatesJob(String jobId)	Delete/cancel an async request for journey aggregates
ApiResponse<Void>	deleteAnalyticsJourneysAggregatesJobWithHttpInfo(String jobId)	Delete/cancel an async request for journey aggregates
void	deleteJourneyActionmap(DeleteJourneyActionmapRequest request)	Delete single action map.
ApiResponse<Void>	deleteJourneyActionmap(ApiRequest<Void> request)	Delete single action map.
void	deleteJourneyActionmap(String actionMapId)	Delete single action map.
ApiResponse<Void>	deleteJourneyActionmapWithHttpInfo(String actionMapId)	Delete single action map.
void	deleteJourneyActiontemplate(DeleteJourneyActiontemplateRequest request)	Delete a single action template.
ApiResponse<Void>	deleteJourneyActiontemplate(ApiRequest<Void> request)	Delete a single action template.
void	deleteJourneyActiontemplate(String actionTemplateId, Boolean hardDelete)	Delete a single action template.
ApiResponse<Void>	deleteJourneyActiontemplateWithHttpInfo(String actionTemplateId, Boolean hardDelete)	Delete a single action template.
void	deleteJourneyExternaleventsConfiguration(DeleteJourneyExternaleventsConfigurationRequest request)	Delete an external events configuration.
ApiResponse<Void>	deleteJourneyExternaleventsConfiguration(ApiRequest<Void> request)	Delete an external events configuration.
void	deleteJourneyExternaleventsConfiguration(String configId)	Delete an external events configuration.
ApiResponse<Void>	deleteJourneyExternaleventsConfigurationWithHttpInfo(String configId)	Delete an external events configuration.
void	deleteJourneyExternaleventsSchema(DeleteJourneyExternaleventsSchemaRequest request)	Delete a schema
ApiResponse<Void>	deleteJourneyExternaleventsSchema(ApiRequest<Void> request)	Delete a schema
void	deleteJourneyExternaleventsSchema(String schemaId)	Delete a schema
ApiResponse<Void>	deleteJourneyExternaleventsSchemaWithHttpInfo(String schemaId)	Delete a schema
void	deleteJourneyOutcome(DeleteJourneyOutcomeRequest request)	Deprecated.
ApiResponse<Void>	deleteJourneyOutcome(ApiRequest<Void> request)	Deprecated.
void	deleteJourneyOutcome(String outcomeId)	Deprecated.
void	deleteJourneyOutcomesPredictor(DeleteJourneyOutcomesPredictorRequest request)	Deprecated.
ApiResponse<Void>	deleteJourneyOutcomesPredictor(ApiRequest<Void> request)	Deprecated.
void	deleteJourneyOutcomesPredictor(String predictorId)	Deprecated.
ApiResponse<Void>	deleteJourneyOutcomesPredictorWithHttpInfo(String predictorId)	Deprecated.
ApiResponse<Void>	deleteJourneyOutcomeWithHttpInfo(String outcomeId)	Deprecated.
void	deleteJourneySegment(DeleteJourneySegmentRequest request)	Delete a segment.
ApiResponse<Void>	deleteJourneySegment(ApiRequest<Void> request)	Delete a segment.
void	deleteJourneySegment(String segmentId)	Delete a segment.
ApiResponse<Void>	deleteJourneySegmentWithHttpInfo(String segmentId)	Delete a segment.
void	deleteJourneyView(DeleteJourneyViewRequest request)	Delete a Journey View by ID deletes all versions
ApiResponse<Void>	deleteJourneyView(ApiRequest<Void> request)	Delete a Journey View by ID deletes all versions
void	deleteJourneyView(String viewId)	Delete a Journey View by ID deletes all versions
JourneyViewSchedule	deleteJourneyViewSchedules(DeleteJourneyViewSchedulesRequest request)	Delete the Schedule of a JourneyView
ApiResponse<JourneyViewSchedule>	deleteJourneyViewSchedules(ApiRequest<Void> request)	Delete the Schedule of a JourneyView
JourneyViewSchedule	deleteJourneyViewSchedules(String viewId)	Delete the Schedule of a JourneyView
ApiResponse<JourneyViewSchedule>	deleteJourneyViewSchedulesWithHttpInfo(String viewId)	Delete the Schedule of a JourneyView
ApiResponse<Void>	deleteJourneyViewWithHttpInfo(String viewId)	Delete a Journey View by ID deletes all versions
AsyncQueryStatus	getAnalyticsJourneysAggregatesJob(GetAnalyticsJourneysAggregatesJobRequest request)	Get status for async query for journey aggregates
ApiResponse<AsyncQueryStatus>	getAnalyticsJourneysAggregatesJob(ApiRequest<Void> request)	Get status for async query for journey aggregates
AsyncQueryStatus	getAnalyticsJourneysAggregatesJob(String jobId)	Get status for async query for journey aggregates
JourneyAsyncAggregateQueryResponse	getAnalyticsJourneysAggregatesJobResults(GetAnalyticsJourneysAggregatesJobResultsRequest request)	Fetch a page of results for an async aggregates query
ApiResponse<JourneyAsyncAggregateQueryResponse>	getAnalyticsJourneysAggregatesJobResults(ApiRequest<Void> request)	Fetch a page of results for an async aggregates query
JourneyAsyncAggregateQueryResponse	getAnalyticsJourneysAggregatesJobResults(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<JourneyAsyncAggregateQueryResponse>	getAnalyticsJourneysAggregatesJobResultsWithHttpInfo(String jobId, String cursor)	Fetch a page of results for an async aggregates query
ApiResponse<AsyncQueryStatus>	getAnalyticsJourneysAggregatesJobWithHttpInfo(String jobId)	Get status for async query for journey aggregates
SegmentAssignmentListing	getExternalcontactsContactJourneySegments(GetExternalcontactsContactJourneySegmentsRequest request)	Retrieve segment assignments by external contact ID.
ApiResponse<SegmentAssignmentListing>	getExternalcontactsContactJourneySegments(ApiRequest<Void> request)	Retrieve segment assignments by external contact ID.
SegmentAssignmentListing	getExternalcontactsContactJourneySegments(String contactId, Boolean includeMerged, Integer limit)	Retrieve segment assignments by external contact ID.
ApiResponse<SegmentAssignmentListing>	getExternalcontactsContactJourneySegmentsWithHttpInfo(String contactId, Boolean includeMerged, Integer limit)	Retrieve segment assignments by external contact ID.
SessionListing	getExternalcontactsContactJourneySessions(GetExternalcontactsContactJourneySessionsRequest request)	Retrieve all sessions for a given external contact.
ApiResponse<SessionListing>	getExternalcontactsContactJourneySessions(ApiRequest<Void> request)	Retrieve all sessions for a given external contact.
SessionListing	getExternalcontactsContactJourneySessions(String contactId, String pageSize, String after, Boolean includeMerged)	Retrieve all sessions for a given external contact.
ApiResponse<SessionListing>	getExternalcontactsContactJourneySessionsWithHttpInfo(String contactId, String pageSize, String after, Boolean includeMerged)	Retrieve all sessions for a given external contact.
ActionMap	getJourneyActionmap(GetJourneyActionmapRequest request)	Retrieve a single action map.
ApiResponse<ActionMap>	getJourneyActionmap(ApiRequest<Void> request)	Retrieve a single action map.
ActionMap	getJourneyActionmap(String actionMapId)	Retrieve a single action map.
ActionMapListing	getJourneyActionmaps(GetJourneyActionmapsRequest request)	Retrieve all action maps.
ApiResponse<ActionMapListing>	getJourneyActionmaps(ApiRequest<Void> request)	Retrieve all action maps.
ActionMapListing	getJourneyActionmaps(Integer pageNumber, Integer pageSize, String sortBy, String filterField, String filterValue, List<String> actionMapIds, List<String> queryFields, String queryValue)	Retrieve all action maps.
String	getJourneyActionmapsEstimatesJob(GetJourneyActionmapsEstimatesJobRequest request)	Deprecated.
ApiResponse<String>	getJourneyActionmapsEstimatesJob(ApiRequest<Void> request)	Deprecated.
String	getJourneyActionmapsEstimatesJob(String jobId)	Deprecated.
ActionMapEstimateResult	getJourneyActionmapsEstimatesJobResults(GetJourneyActionmapsEstimatesJobResultsRequest request)	Deprecated.
ApiResponse<ActionMapEstimateResult>	getJourneyActionmapsEstimatesJobResults(ApiRequest<Void> request)	Deprecated.
ActionMapEstimateResult	getJourneyActionmapsEstimatesJobResults(String jobId)	Deprecated.
ApiResponse<ActionMapEstimateResult>	getJourneyActionmapsEstimatesJobResultsWithHttpInfo(String jobId)	Deprecated.
ApiResponse<String>	getJourneyActionmapsEstimatesJobWithHttpInfo(String jobId)	Deprecated.
ApiResponse<ActionMapListing>	getJourneyActionmapsWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String filterField, String filterValue, List<String> actionMapIds, List<String> queryFields, String queryValue)	Retrieve all action maps.
ApiResponse<ActionMap>	getJourneyActionmapWithHttpInfo(String actionMapId)	Retrieve a single action map.
ActionTarget	getJourneyActiontarget(GetJourneyActiontargetRequest request)	Deprecated.
ApiResponse<ActionTarget>	getJourneyActiontarget(ApiRequest<Void> request)	Deprecated.
ActionTarget	getJourneyActiontarget(String actionTargetId)	Deprecated.
ActionTargetListing	getJourneyActiontargets(GetJourneyActiontargetsRequest request)	Deprecated.
ApiResponse<ActionTargetListing>	getJourneyActiontargets(ApiRequest<Void> request)	Deprecated.
ActionTargetListing	getJourneyActiontargets(Integer pageNumber, Integer pageSize)	Deprecated.
ApiResponse<ActionTargetListing>	getJourneyActiontargetsWithHttpInfo(Integer pageNumber, Integer pageSize)	Deprecated.
ApiResponse<ActionTarget>	getJourneyActiontargetWithHttpInfo(String actionTargetId)	Deprecated.
ActionTemplate	getJourneyActiontemplate(GetJourneyActiontemplateRequest request)	Retrieve a single action template.
ApiResponse<ActionTemplate>	getJourneyActiontemplate(ApiRequest<Void> request)	Retrieve a single action template.
ActionTemplate	getJourneyActiontemplate(String actionTemplateId)	Retrieve a single action template.
ActionTemplateListing	getJourneyActiontemplates(GetJourneyActiontemplatesRequest request)	Retrieve all action templates.
ApiResponse<ActionTemplateListing>	getJourneyActiontemplates(ApiRequest<Void> request)	Retrieve all action templates.
ActionTemplateListing	getJourneyActiontemplates(Integer pageNumber, Integer pageSize, String sortBy, String mediaType, String state, List<String> queryFields, String queryValue)	Retrieve all action templates.
ApiResponse<ActionTemplateListing>	getJourneyActiontemplatesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, String mediaType, String state, List<String> queryFields, String queryValue)	Retrieve all action templates.
ApiResponse<ActionTemplate>	getJourneyActiontemplateWithHttpInfo(String actionTemplateId)	Retrieve a single action template.
DeploymentPing	getJourneyDeploymentCustomerPing(GetJourneyDeploymentCustomerPingRequest request)	Send a ping.
ApiResponse<DeploymentPing>	getJourneyDeploymentCustomerPing(ApiRequest<Void> request)	Send a ping.
DeploymentPing	getJourneyDeploymentCustomerPing(String deploymentId, String customerCookieId, String dl, String dt, String appNamespace, String sessionId, Long sinceLastBeaconMilliseconds)	Send a ping.
ApiResponse<DeploymentPing>	getJourneyDeploymentCustomerPingWithHttpInfo(String deploymentId, String customerCookieId, String dl, String dt, String appNamespace, String sessionId, Long sinceLastBeaconMilliseconds)	Send a ping.
ExternalEventsConfiguration	getJourneyExternaleventsConfiguration(GetJourneyExternaleventsConfigurationRequest request)	Get an external events configuration
ApiResponse<ExternalEventsConfiguration>	getJourneyExternaleventsConfiguration(ApiRequest<Void> request)	Get an external events configuration
ExternalEventsConfiguration	getJourneyExternaleventsConfiguration(String configId)	Get an external events configuration
ExternalEventsConfigurationListing	getJourneyExternaleventsConfigurations(GetJourneyExternaleventsConfigurationsRequest request)	Get all external event configurations.
ApiResponse<ExternalEventsConfigurationListing>	getJourneyExternaleventsConfigurations(ApiRequest<Void> request)	Get all external event configurations.
ExternalEventsConfigurationListing	getJourneyExternaleventsConfigurations(Integer pageSize, Integer pageNumber)	Get all external event configurations.
ApiResponse<ExternalEventsConfigurationListing>	getJourneyExternaleventsConfigurationsWithHttpInfo(Integer pageSize, Integer pageNumber)	Get all external event configurations.
ApiResponse<ExternalEventsConfiguration>	getJourneyExternaleventsConfigurationWithHttpInfo(String configId)	Get an external events configuration
JourneyExternalEventsSchema	getJourneyExternaleventsSchema(GetJourneyExternaleventsSchemaRequest request)	Get a schema
ApiResponse<JourneyExternalEventsSchema>	getJourneyExternaleventsSchema(ApiRequest<Void> request)	Get a schema
JourneyExternalEventsSchema	getJourneyExternaleventsSchema(String schemaId)	Get a schema
JourneyExternalEventsSchemaListing	getJourneyExternaleventsSchemas()	Get a list of schemas.
JourneyExternalEventsSchemaListing	getJourneyExternaleventsSchemas(GetJourneyExternaleventsSchemasRequest request)	Get a list of schemas.
ApiResponse<JourneyExternalEventsSchemaListing>	getJourneyExternaleventsSchemas(ApiRequest<Void> request)	Get a list of schemas.
Coretype	getJourneyExternaleventsSchemasCoretype(GetJourneyExternaleventsSchemasCoretypeRequest request)	Get a core type from which all schemas are built
ApiResponse<Coretype>	getJourneyExternaleventsSchemasCoretype(ApiRequest<Void> request)	Get a core type from which all schemas are built
Coretype	getJourneyExternaleventsSchemasCoretype(String coreTypeName)	Get a core type from which all schemas are built
CoretypeListing	getJourneyExternaleventsSchemasCoretypes()	Get the list of core types enabled for a specific namespace.
CoretypeListing	getJourneyExternaleventsSchemasCoretypes(GetJourneyExternaleventsSchemasCoretypesRequest request)	Get the list of core types enabled for a specific namespace.
ApiResponse<CoretypeListing>	getJourneyExternaleventsSchemasCoretypes(ApiRequest<Void> request)	Get the list of core types enabled for a specific namespace.
ApiResponse<CoretypeListing>	getJourneyExternaleventsSchemasCoretypesWithHttpInfo()	Get the list of core types enabled for a specific namespace.
ApiResponse<Coretype>	getJourneyExternaleventsSchemasCoretypeWithHttpInfo(String coreTypeName)	Get a core type from which all schemas are built
SchemaQuantityLimits	getJourneyExternaleventsSchemasLimits()	Get quantitative limits on schemas
SchemaQuantityLimits	getJourneyExternaleventsSchemasLimits(GetJourneyExternaleventsSchemasLimitsRequest request)	Get quantitative limits on schemas
ApiResponse<SchemaQuantityLimits>	getJourneyExternaleventsSchemasLimits(ApiRequest<Void> request)	Get quantitative limits on schemas
ApiResponse<SchemaQuantityLimits>	getJourneyExternaleventsSchemasLimitsWithHttpInfo()	Get quantitative limits on schemas
ApiResponse<JourneyExternalEventsSchemaListing>	getJourneyExternaleventsSchemasWithHttpInfo()	Get a list of schemas.
JourneyExternalEventsSchema	getJourneyExternaleventsSchemaVersion(GetJourneyExternaleventsSchemaVersionRequest request)	Get a specific version of a schema
ApiResponse<JourneyExternalEventsSchema>	getJourneyExternaleventsSchemaVersion(ApiRequest<Void> request)	Get a specific version of a schema
JourneyExternalEventsSchema	getJourneyExternaleventsSchemaVersion(String schemaId, String versionId)	Get a specific version of a schema
JourneyExternalEventsSchemaListing	getJourneyExternaleventsSchemaVersions(GetJourneyExternaleventsSchemaVersionsRequest request)	Get all versions of a External Events schema
ApiResponse<JourneyExternalEventsSchemaListing>	getJourneyExternaleventsSchemaVersions(ApiRequest<Void> request)	Get all versions of a External Events schema
JourneyExternalEventsSchemaListing	getJourneyExternaleventsSchemaVersions(String schemaId)	Get all versions of a External Events schema
ApiResponse<JourneyExternalEventsSchemaListing>	getJourneyExternaleventsSchemaVersionsWithHttpInfo(String schemaId)	Get all versions of a External Events schema
ApiResponse<JourneyExternalEventsSchema>	getJourneyExternaleventsSchemaVersionWithHttpInfo(String schemaId, String versionId)	Get a specific version of a schema
ApiResponse<JourneyExternalEventsSchema>	getJourneyExternaleventsSchemaWithHttpInfo(String schemaId)	Get a schema
Outcome	getJourneyOutcome(GetJourneyOutcomeRequest request)	Deprecated.
ApiResponse<Outcome>	getJourneyOutcome(ApiRequest<Void> request)	Deprecated.
Outcome	getJourneyOutcome(String outcomeId)	Deprecated.
OutcomeListing	getJourneyOutcomes(GetJourneyOutcomesRequest request)	Deprecated.
ApiResponse<OutcomeListing>	getJourneyOutcomes(ApiRequest<Void> request)	Deprecated.
OutcomeListing	getJourneyOutcomes(Integer pageNumber, Integer pageSize, String sortBy, List<String> outcomeIds, List<String> queryFields, String queryValue)	Deprecated.
OutcomeAttributionJobStateResponse	getJourneyOutcomesAttributionsJob(GetJourneyOutcomesAttributionsJobRequest request)	Deprecated.
ApiResponse<OutcomeAttributionJobStateResponse>	getJourneyOutcomesAttributionsJob(ApiRequest<Void> request)	Deprecated.
OutcomeAttributionJobStateResponse	getJourneyOutcomesAttributionsJob(String jobId)	Deprecated.
OutcomeAttributionResponseListing	getJourneyOutcomesAttributionsJobResults(GetJourneyOutcomesAttributionsJobResultsRequest request)	Deprecated.
ApiResponse<OutcomeAttributionResponseListing>	getJourneyOutcomesAttributionsJobResults(ApiRequest<Void> request)	Deprecated.
OutcomeAttributionResponseListing	getJourneyOutcomesAttributionsJobResults(String jobId)	Deprecated.
ApiResponse<OutcomeAttributionResponseListing>	getJourneyOutcomesAttributionsJobResultsWithHttpInfo(String jobId)	Deprecated.
ApiResponse<OutcomeAttributionJobStateResponse>	getJourneyOutcomesAttributionsJobWithHttpInfo(String jobId)	Deprecated.
OutcomePredictor	getJourneyOutcomesPredictor(GetJourneyOutcomesPredictorRequest request)	Deprecated.
ApiResponse<OutcomePredictor>	getJourneyOutcomesPredictor(ApiRequest<Void> request)	Deprecated.
OutcomePredictor	getJourneyOutcomesPredictor(String predictorId)	Deprecated.
OutcomePredictorListing	getJourneyOutcomesPredictors()	Deprecated.
OutcomePredictorListing	getJourneyOutcomesPredictors(GetJourneyOutcomesPredictorsRequest request)	Deprecated.
ApiResponse<OutcomePredictorListing>	getJourneyOutcomesPredictors(ApiRequest<Void> request)	Deprecated.
ApiResponse<OutcomePredictorListing>	getJourneyOutcomesPredictorsWithHttpInfo()	Deprecated.
ApiResponse<OutcomePredictor>	getJourneyOutcomesPredictorWithHttpInfo(String predictorId)	Deprecated.
ApiResponse<OutcomeListing>	getJourneyOutcomesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortBy, List<String> outcomeIds, List<String> queryFields, String queryValue)	Deprecated.
ApiResponse<Outcome>	getJourneyOutcomeWithHttpInfo(String outcomeId)	Deprecated.
JourneySegment	getJourneySegment(GetJourneySegmentRequest request)	Retrieve a single segment.
ApiResponse<JourneySegment>	getJourneySegment(ApiRequest<Void> request)	Retrieve a single segment.
JourneySegment	getJourneySegment(String segmentId)	Retrieve a single segment.
SegmentListing	getJourneySegments(GetJourneySegmentsRequest request)	Retrieve all segments.
ApiResponse<SegmentListing>	getJourneySegments(ApiRequest<Void> request)	Retrieve all segments.
SegmentListing	getJourneySegments(String sortBy, Integer pageSize, Integer pageNumber, Boolean isActive, List<String> segmentIds, List<String> queryFields, String queryValue)	Retrieve all segments.
ApiResponse<SegmentListing>	getJourneySegmentsWithHttpInfo(String sortBy, Integer pageSize, Integer pageNumber, Boolean isActive, List<String> segmentIds, List<String> queryFields, String queryValue)	Retrieve all segments.
ApiResponse<JourneySegment>	getJourneySegmentWithHttpInfo(String segmentId)	Retrieve a single segment.
Session	getJourneySession(GetJourneySessionRequest request)	Retrieve a single session.
ApiResponse<Session>	getJourneySession(ApiRequest<Void> request)	Retrieve a single session.
Session	getJourneySession(String sessionId)	Retrieve a single session.
EventListing	getJourneySessionEvents(GetJourneySessionEventsRequest request)	Retrieve all events for a given session.
ApiResponse<EventListing>	getJourneySessionEvents(ApiRequest<Void> request)	Retrieve all events for a given session.
EventListing	getJourneySessionEvents(String sessionId, String pageSize, String after, String eventType)	Retrieve all events for a given session.
ApiResponse<EventListing>	getJourneySessionEventsWithHttpInfo(String sessionId, String pageSize, String after, String eventType)	Retrieve all events for a given session.
OutcomeScoresResult	getJourneySessionOutcomescores(GetJourneySessionOutcomescoresRequest request)	Deprecated.
ApiResponse<OutcomeScoresResult>	getJourneySessionOutcomescores(ApiRequest<Void> request)	Deprecated.
OutcomeScoresResult	getJourneySessionOutcomescores(String sessionId)	Deprecated.
ApiResponse<OutcomeScoresResult>	getJourneySessionOutcomescoresWithHttpInfo(String sessionId)	Deprecated.
ApiResponse<Session>	getJourneySessionWithHttpInfo(String sessionId)	Retrieve a single session.
JourneyView	getJourneyView(GetJourneyViewRequest request)	Get a Journey View by ID returns the latest version
ApiResponse<JourneyView>	getJourneyView(ApiRequest<Void> request)	Get a Journey View by ID returns the latest version
JourneyView	getJourneyView(String viewId)	Get a Journey View by ID returns the latest version
JourneyViewListing	getJourneyViews(GetJourneyViewsRequest request)	Get a list of Journey Views
ApiResponse<JourneyViewListing>	getJourneyViews(ApiRequest<Void> request)	Get a list of Journey Views
JourneyViewListing	getJourneyViews(Integer pageNumber, Integer pageSize, String nameOrCreatedBy, String expand, String id)	Get a list of Journey Views
JourneyViewSchedule	getJourneyViewSchedules(GetJourneyViewSchedulesRequest request)	Get the Schedule for a JourneyView
ApiResponse<JourneyViewSchedule>	getJourneyViewSchedules(ApiRequest<Void> request)	Get the Schedule for a JourneyView
JourneyViewSchedule	getJourneyViewSchedules(String viewId)	Get the Schedule for a JourneyView
ApiResponse<JourneyViewSchedule>	getJourneyViewSchedulesWithHttpInfo(String viewId)	Get the Schedule for a JourneyView
DataRange	getJourneyViewsDataDetails()	Get details about the data available for journey queries including oldest and newest event dates
DataRange	getJourneyViewsDataDetails(GetJourneyViewsDataDetailsRequest request)	Get details about the data available for journey queries including oldest and newest event dates
ApiResponse<DataRange>	getJourneyViewsDataDetails(ApiRequest<Void> request)	Get details about the data available for journey queries including oldest and newest event dates
ApiResponse<DataRange>	getJourneyViewsDataDetailsWithHttpInfo()	Get details about the data available for journey queries including oldest and newest event dates
JourneyEventDefinition	getJourneyViewsEventdefinition(GetJourneyViewsEventdefinitionRequest request)	Get an Event Definition
ApiResponse<JourneyEventDefinition>	getJourneyViewsEventdefinition(ApiRequest<Void> request)	Get an Event Definition
JourneyEventDefinition	getJourneyViewsEventdefinition(String eventDefinitionId)	Get an Event Definition
JourneyEventDefinitionListing	getJourneyViewsEventdefinitions()	Get a list of Event Definitions
JourneyEventDefinitionListing	getJourneyViewsEventdefinitions(GetJourneyViewsEventdefinitionsRequest request)	Get a list of Event Definitions
ApiResponse<JourneyEventDefinitionListing>	getJourneyViewsEventdefinitions(ApiRequest<Void> request)	Get a list of Event Definitions
GetExternalEventsResponse	getJourneyViewsEventdefinitionsExternal()	Get external events for journey views
GetExternalEventsResponse	getJourneyViewsEventdefinitionsExternal(GetJourneyViewsEventdefinitionsExternalRequest request)	Get external events for journey views
ApiResponse<GetExternalEventsResponse>	getJourneyViewsEventdefinitionsExternal(ApiRequest<Void> request)	Get external events for journey views
ExternalEventChangesResponse	getJourneyViewsEventdefinitionsExternalChanges()	Get changes in external event definitions
ExternalEventChangesResponse	getJourneyViewsEventdefinitionsExternalChanges(GetJourneyViewsEventdefinitionsExternalChangesRequest request)	Get changes in external event definitions
ApiResponse<ExternalEventChangesResponse>	getJourneyViewsEventdefinitionsExternalChanges(ApiRequest<Void> request)	Get changes in external event definitions
ApiResponse<ExternalEventChangesResponse>	getJourneyViewsEventdefinitionsExternalChangesWithHttpInfo()	Get changes in external event definitions
ApiResponse<GetExternalEventsResponse>	getJourneyViewsEventdefinitionsExternalWithHttpInfo()	Get external events for journey views
ApiResponse<JourneyEventDefinitionListing>	getJourneyViewsEventdefinitionsWithHttpInfo()	Get a list of Event Definitions
ApiResponse<JourneyEventDefinition>	getJourneyViewsEventdefinitionWithHttpInfo(String eventDefinitionId)	Get an Event Definition
JourneyViewJobListing	getJourneyViewsJobs(GetJourneyViewsJobsRequest request)	Get the jobs for an organization.
ApiResponse<JourneyViewJobListing>	getJourneyViewsJobs(ApiRequest<Void> request)	Get the jobs for an organization.
JourneyViewJobListing	getJourneyViewsJobs(Integer pageNumber, Integer pageSize, String interval, String statuses)	Get the jobs for an organization.
JourneyViewJobListing	getJourneyViewsJobsMe(GetJourneyViewsJobsMeRequest request)	Get my jobs
ApiResponse<JourneyViewJobListing>	getJourneyViewsJobsMe(ApiRequest<Void> request)	Get my jobs
JourneyViewJobListing	getJourneyViewsJobsMe(Integer pageNumber, Integer pageSize, String interval, String statuses)	Get my jobs
ApiResponse<JourneyViewJobListing>	getJourneyViewsJobsMeWithHttpInfo(Integer pageNumber, Integer pageSize, String interval, String statuses)	Get my jobs
ApiResponse<JourneyViewJobListing>	getJourneyViewsJobsWithHttpInfo(Integer pageNumber, Integer pageSize, String interval, String statuses)	Get the jobs for an organization.
JourneyViewScheduleListing	getJourneyViewsSchedules(GetJourneyViewsSchedulesRequest request)	Get the journey schedules for an organization.
ApiResponse<JourneyViewScheduleListing>	getJourneyViewsSchedules(ApiRequest<Void> request)	Get the journey schedules for an organization.
JourneyViewScheduleListing	getJourneyViewsSchedules(Integer pageNumber, Integer pageSize)	Get the journey schedules for an organization.
ApiResponse<JourneyViewScheduleListing>	getJourneyViewsSchedulesWithHttpInfo(Integer pageNumber, Integer pageSize)	Get the journey schedules for an organization.
ApiResponse<JourneyViewListing>	getJourneyViewsWithHttpInfo(Integer pageNumber, Integer pageSize, String nameOrCreatedBy, String expand, String id)	Get a list of Journey Views
JourneyView	getJourneyViewVersion(GetJourneyViewVersionRequest request)	Get a Journey View by ID and version
ApiResponse<JourneyView>	getJourneyViewVersion(ApiRequest<Void> request)	Get a Journey View by ID and version
JourneyView	getJourneyViewVersion(String viewId, String versionId)	Get a Journey View by ID and version
JourneyViewChart	getJourneyViewVersionChart(GetJourneyViewVersionChartRequest request)	Get a Chart by ID returns the latest version
ApiResponse<JourneyViewChart>	getJourneyViewVersionChart(ApiRequest<Void> request)	Get a Chart by ID returns the latest version
JourneyViewChart	getJourneyViewVersionChart(String viewId, String journeyViewVersion, String chartId)	Get a Chart by ID returns the latest version
JourneyViewChart	getJourneyViewVersionChartVersion(GetJourneyViewVersionChartVersionRequest request)	Get a Chart by ID and version
ApiResponse<JourneyViewChart>	getJourneyViewVersionChartVersion(ApiRequest<Void> request)	Get a Chart by ID and version
JourneyViewChart	getJourneyViewVersionChartVersion(String viewId, String journeyViewVersion, String chartId, String chartVersion)	Get a Chart by ID and version
ApiResponse<JourneyViewChart>	getJourneyViewVersionChartVersionWithHttpInfo(String viewId, String journeyViewVersion, String chartId, String chartVersion)	Get a Chart by ID and version
ApiResponse<JourneyViewChart>	getJourneyViewVersionChartWithHttpInfo(String viewId, String journeyViewVersion, String chartId)	Get a Chart by ID returns the latest version
JourneyViewJob	getJourneyViewVersionJob(GetJourneyViewVersionJobRequest request)	Get the job for a journey view version.
ApiResponse<JourneyViewJob>	getJourneyViewVersionJob(ApiRequest<Void> request)	Get the job for a journey view version.
JourneyViewJob	getJourneyViewVersionJob(String viewId, String journeyVersionId, String jobId)	Get the job for a journey view version.
JourneyViewResult	getJourneyViewVersionJobResults(GetJourneyViewVersionJobResultsRequest request)	Get the result of a job for a journey view version.
ApiResponse<JourneyViewResult>	getJourneyViewVersionJobResults(ApiRequest<Void> request)	Get the result of a job for a journey view version.
JourneyViewResult	getJourneyViewVersionJobResults(String viewId, String journeyViewVersion, String jobId)	Get the result of a job for a journey view version.
JourneyViewChartResult	getJourneyViewVersionJobResultsChart(GetJourneyViewVersionJobResultsChartRequest request)	Get the chart result associated with a journey view job.
ApiResponse<JourneyViewChartResult>	getJourneyViewVersionJobResultsChart(ApiRequest<Void> request)	Get the chart result associated with a journey view job.
JourneyViewChartResult	getJourneyViewVersionJobResultsChart(String viewId, String journeyVersionId, String jobId, String chartId)	Get the chart result associated with a journey view job.
ApiResponse<JourneyViewChartResult>	getJourneyViewVersionJobResultsChartWithHttpInfo(String viewId, String journeyVersionId, String jobId, String chartId)	Get the chart result associated with a journey view job.
ApiResponse<JourneyViewResult>	getJourneyViewVersionJobResultsWithHttpInfo(String viewId, String journeyViewVersion, String jobId)	Get the result of a job for a journey view version.
JourneyViewJob	getJourneyViewVersionJobsLatest(GetJourneyViewVersionJobsLatestRequest request)	Get the latest job of a journey view version.
ApiResponse<JourneyViewJob>	getJourneyViewVersionJobsLatest(ApiRequest<Void> request)	Get the latest job of a journey view version.
JourneyViewJob	getJourneyViewVersionJobsLatest(String viewId, String journeyVersionId)	Get the latest job of a journey view version.
ApiResponse<JourneyViewJob>	getJourneyViewVersionJobsLatestWithHttpInfo(String viewId, String journeyVersionId)	Get the latest job of a journey view version.
ApiResponse<JourneyViewJob>	getJourneyViewVersionJobWithHttpInfo(String viewId, String journeyVersionId, String jobId)	Get the job for a journey view version.
ApiResponse<JourneyView>	getJourneyViewVersionWithHttpInfo(String viewId, String versionId)	Get a Journey View by ID and version
ApiResponse<JourneyView>	getJourneyViewWithHttpInfo(String viewId)	Get a Journey View by ID returns the latest version
ActionMap	patchJourneyActionmap(PatchJourneyActionmapRequest request)	Update single action map.
ApiResponse<ActionMap>	patchJourneyActionmap(ApiRequest<PatchActionMap> request)	Update single action map.
ActionMap	patchJourneyActionmap(String actionMapId, PatchActionMap body)	Update single action map.
ApiResponse<ActionMap>	patchJourneyActionmapWithHttpInfo(String actionMapId, PatchActionMap body)	Update single action map.
ActionTarget	patchJourneyActiontarget(PatchJourneyActiontargetRequest request)	Deprecated.
ApiResponse<ActionTarget>	patchJourneyActiontarget(ApiRequest<PatchActionTarget> request)	Deprecated.
ActionTarget	patchJourneyActiontarget(String actionTargetId, PatchActionTarget body)	Deprecated.
ApiResponse<ActionTarget>	patchJourneyActiontargetWithHttpInfo(String actionTargetId, PatchActionTarget body)	Deprecated.
ActionTemplate	patchJourneyActiontemplate(PatchJourneyActiontemplateRequest request)	Update a single action template.
ApiResponse<ActionTemplate>	patchJourneyActiontemplate(ApiRequest<PatchActionTemplate> request)	Update a single action template.
ActionTemplate	patchJourneyActiontemplate(String actionTemplateId, PatchActionTemplate body)	Update a single action template.
ApiResponse<ActionTemplate>	patchJourneyActiontemplateWithHttpInfo(String actionTemplateId, PatchActionTemplate body)	Update a single action template.
ExternalEventsConfiguration	patchJourneyExternaleventsConfiguration(PatchJourneyExternaleventsConfigurationRequest request)	Update an external events configuration.
ApiResponse<ExternalEventsConfiguration>	patchJourneyExternaleventsConfiguration(ApiRequest<UpdateExternalEventsConfigurationRequest> request)	Update an external events configuration.
ExternalEventsConfiguration	patchJourneyExternaleventsConfiguration(String configId, UpdateExternalEventsConfigurationRequest body)	Update an external events configuration.
ApiResponse<ExternalEventsConfiguration>	patchJourneyExternaleventsConfigurationWithHttpInfo(String configId, UpdateExternalEventsConfigurationRequest body)	Update an external events configuration.
Outcome	patchJourneyOutcome(PatchJourneyOutcomeRequest request)	Deprecated.
ApiResponse<Outcome>	patchJourneyOutcome(ApiRequest<PatchOutcome> request)	Deprecated.
Outcome	patchJourneyOutcome(String outcomeId, PatchOutcome body)	Deprecated.
ApiResponse<Outcome>	patchJourneyOutcomeWithHttpInfo(String outcomeId, PatchOutcome body)	Deprecated.
JourneySegment	patchJourneySegment(PatchJourneySegmentRequest request)	Update a segment.
ApiResponse<JourneySegment>	patchJourneySegment(ApiRequest<PatchSegment> request)	Update a segment.
JourneySegment	patchJourneySegment(String segmentId, PatchSegment body)	Update a segment.
ApiResponse<JourneySegment>	patchJourneySegmentWithHttpInfo(String segmentId, PatchSegment body)	Update a segment.
JourneyViewJob	patchJourneyViewVersionJob(PatchJourneyViewVersionJobRequest request)	Update the job for a journey view version.
ApiResponse<JourneyViewJob>	patchJourneyViewVersionJob(ApiRequest<JourneyViewJob> request)	Update the job for a journey view version.
JourneyViewJob	patchJourneyViewVersionJob(String viewId, String journeyVersionId, String jobId, JourneyViewJob body)	Update the job for a journey view version.
ApiResponse<JourneyViewJob>	patchJourneyViewVersionJobWithHttpInfo(String viewId, String journeyVersionId, String jobId, JourneyViewJob body)	Update the job for a journey view version.
AsyncQueryResponse	postAnalyticsJourneysAggregatesJobs(PostAnalyticsJourneysAggregatesJobsRequest request)	Query for journey aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsJourneysAggregatesJobs(ApiRequest<JourneyAsyncAggregationQuery> request)	Query for journey aggregates asynchronously
AsyncQueryResponse	postAnalyticsJourneysAggregatesJobs(JourneyAsyncAggregationQuery body)	Query for journey aggregates asynchronously
ApiResponse<AsyncQueryResponse>	postAnalyticsJourneysAggregatesJobsWithHttpInfo(JourneyAsyncAggregationQuery body)	Query for journey aggregates asynchronously
JourneyAggregateQueryResponse	postAnalyticsJourneysAggregatesQuery(PostAnalyticsJourneysAggregatesQueryRequest request)	Query for journey aggregates
ApiResponse<JourneyAggregateQueryResponse>	postAnalyticsJourneysAggregatesQuery(ApiRequest<JourneyAggregationQuery> request)	Query for journey aggregates
JourneyAggregateQueryResponse	postAnalyticsJourneysAggregatesQuery(JourneyAggregationQuery body)	Query for journey aggregates
ApiResponse<JourneyAggregateQueryResponse>	postAnalyticsJourneysAggregatesQueryWithHttpInfo(JourneyAggregationQuery body)	Query for journey aggregates
UpdateSegmentAssignmentResponse	postExternalcontactsContactJourneySegments(PostExternalcontactsContactJourneySegmentsRequest request)	Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
ApiResponse<UpdateSegmentAssignmentResponse>	postExternalcontactsContactJourneySegments(ApiRequest<UpdateSegmentAssignmentRequest> request)	Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
UpdateSegmentAssignmentResponse	postExternalcontactsContactJourneySegments(String contactId, UpdateSegmentAssignmentRequest body)	Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
ApiResponse<UpdateSegmentAssignmentResponse>	postExternalcontactsContactJourneySegmentsWithHttpInfo(String contactId, UpdateSegmentAssignmentRequest body)	Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
ActionMap	postJourneyActionmaps(PostJourneyActionmapsRequest request)	Create an action map.
ApiResponse<ActionMap>	postJourneyActionmaps(ApiRequest<ActionMap> request)	Create an action map.
ActionMap	postJourneyActionmaps(ActionMap body)	Create an action map.
EstimateJobAsyncResponse	postJourneyActionmapsEstimatesJobs(PostJourneyActionmapsEstimatesJobsRequest request)	Deprecated.
ApiResponse<EstimateJobAsyncResponse>	postJourneyActionmapsEstimatesJobs(ApiRequest<ActionMapEstimateRequest> request)	Deprecated.
EstimateJobAsyncResponse	postJourneyActionmapsEstimatesJobs(ActionMapEstimateRequest body)	Deprecated.
ApiResponse<EstimateJobAsyncResponse>	postJourneyActionmapsEstimatesJobsWithHttpInfo(ActionMapEstimateRequest body)	Deprecated.
ApiResponse<ActionMap>	postJourneyActionmapsWithHttpInfo(ActionMap body)	Create an action map.
ActionTemplate	postJourneyActiontemplates(PostJourneyActiontemplatesRequest request)	Create a single action template.
ApiResponse<ActionTemplate>	postJourneyActiontemplates(ApiRequest<ActionTemplate> request)	Create a single action template.
ActionTemplate	postJourneyActiontemplates(ActionTemplate body)	Create a single action template.
ApiResponse<ActionTemplate>	postJourneyActiontemplatesWithHttpInfo(ActionTemplate body)	Create a single action template.
void	postJourneyDeploymentActionevent(PostJourneyDeploymentActioneventRequest request)	Sends an action event, which is used for changing the state of actions that have been offered to the user.
ApiResponse<Void>	postJourneyDeploymentActionevent(ApiRequest<ActionEventRequest> request)	Sends an action event, which is used for changing the state of actions that have been offered to the user.
void	postJourneyDeploymentActionevent(String deploymentId, ActionEventRequest body)	Sends an action event, which is used for changing the state of actions that have been offered to the user.
ApiResponse<Void>	postJourneyDeploymentActioneventWithHttpInfo(String deploymentId, ActionEventRequest body)	Sends an action event, which is used for changing the state of actions that have been offered to the user.
AppEventResponse	postJourneyDeploymentAppevents(PostJourneyDeploymentAppeventsRequest request)	Send a journey app event, used for tracking customer activity on an application.
ApiResponse<AppEventResponse>	postJourneyDeploymentAppevents(ApiRequest<AppEventRequest> request)	Send a journey app event, used for tracking customer activity on an application.
AppEventResponse	postJourneyDeploymentAppevents(String deploymentId, AppEventRequest body)	Send a journey app event, used for tracking customer activity on an application.
ApiResponse<AppEventResponse>	postJourneyDeploymentAppeventsWithHttpInfo(String deploymentId, AppEventRequest body)	Send a journey app event, used for tracking customer activity on an application.
WebEventResponse	postJourneyDeploymentWebevents(PostJourneyDeploymentWebeventsRequest request)	Send a journey web event, used for tracking customer activity on a website.
ApiResponse<WebEventResponse>	postJourneyDeploymentWebevents(ApiRequest<WebEventRequest> request)	Send a journey web event, used for tracking customer activity on a website.
WebEventResponse	postJourneyDeploymentWebevents(String deploymentId, WebEventRequest body)	Send a journey web event, used for tracking customer activity on a website.
ApiResponse<WebEventResponse>	postJourneyDeploymentWebeventsWithHttpInfo(String deploymentId, WebEventRequest body)	Send a journey web event, used for tracking customer activity on a website.
ExternalEventsResponse	postJourneyExternaleventsConfigurationEvents(PostJourneyExternaleventsConfigurationEventsRequest request)	Create external events
ApiResponse<ExternalEventsResponse>	postJourneyExternaleventsConfigurationEvents(ApiRequest<ExternalEventsRequest> request)	Create external events
ExternalEventsResponse	postJourneyExternaleventsConfigurationEvents(String configurationId, ExternalEventsRequest body)	Create external events
ApiResponse<ExternalEventsResponse>	postJourneyExternaleventsConfigurationEventsWithHttpInfo(String configurationId, ExternalEventsRequest body)	Create external events
ExternalEventsConfiguration	postJourneyExternaleventsConfigurations(PostJourneyExternaleventsConfigurationsRequest request)	Create an external events configuration.
ApiResponse<ExternalEventsConfiguration>	postJourneyExternaleventsConfigurations(ApiRequest<CreateExternalEventsConfigurationRequest> request)	Create an external events configuration.
ExternalEventsConfiguration	postJourneyExternaleventsConfigurations(CreateExternalEventsConfigurationRequest body)	Create an external events configuration.
ApiResponse<ExternalEventsConfiguration>	postJourneyExternaleventsConfigurationsWithHttpInfo(CreateExternalEventsConfigurationRequest body)	Create an external events configuration.
JourneyExternalEventsSchema	postJourneyExternaleventsSchemas(PostJourneyExternaleventsSchemasRequest request)	Create a schema
ApiResponse<JourneyExternalEventsSchema>	postJourneyExternaleventsSchemas(ApiRequest<JourneyJsonSchemaRequest> request)	Create a schema
JourneyExternalEventsSchema	postJourneyExternaleventsSchemas(JourneyJsonSchemaRequest body)	Create a schema
ApiResponse<JourneyExternalEventsSchema>	postJourneyExternaleventsSchemasWithHttpInfo(JourneyJsonSchemaRequest body)	Create a schema
FlowPaths	postJourneyFlowsPathsQuery(PostJourneyFlowsPathsQueryRequest request)	Query for flow paths.
ApiResponse<FlowPaths>	postJourneyFlowsPathsQuery(ApiRequest<FlowPathsQuery> request)	Query for flow paths.
FlowPaths	postJourneyFlowsPathsQuery(FlowPathsQuery body)	Query for flow paths.
ApiResponse<FlowPaths>	postJourneyFlowsPathsQueryWithHttpInfo(FlowPathsQuery body)	Query for flow paths.
Outcome	postJourneyOutcomes(PostJourneyOutcomesRequest request)	Deprecated.
ApiResponse<Outcome>	postJourneyOutcomes(ApiRequest<OutcomeRequest> request)	Deprecated.
Outcome	postJourneyOutcomes(OutcomeRequest body)	Deprecated.
OutcomeAttributionAsyncResponse	postJourneyOutcomesAttributionsJobs(PostJourneyOutcomesAttributionsJobsRequest request)	Deprecated.
ApiResponse<OutcomeAttributionAsyncResponse>	postJourneyOutcomesAttributionsJobs(ApiRequest<OutcomeAttributionListing> request)	Deprecated.
OutcomeAttributionAsyncResponse	postJourneyOutcomesAttributionsJobs(OutcomeAttributionListing body)	Deprecated.
ApiResponse<OutcomeAttributionAsyncResponse>	postJourneyOutcomesAttributionsJobsWithHttpInfo(OutcomeAttributionListing body)	Deprecated.
OutcomePredictor	postJourneyOutcomesPredictors(PostJourneyOutcomesPredictorsRequest request)	Deprecated.
ApiResponse<OutcomePredictor>	postJourneyOutcomesPredictors(ApiRequest<OutcomePredictorRequest> request)	Deprecated.
OutcomePredictor	postJourneyOutcomesPredictors(OutcomePredictorRequest body)	Deprecated.
ApiResponse<OutcomePredictor>	postJourneyOutcomesPredictorsWithHttpInfo(OutcomePredictorRequest body)	Deprecated.
ApiResponse<Outcome>	postJourneyOutcomesWithHttpInfo(OutcomeRequest body)	Deprecated.
JourneySegment	postJourneySegments(PostJourneySegmentsRequest request)	Create a segment.
ApiResponse<JourneySegment>	postJourneySegments(ApiRequest<JourneySegmentRequest> request)	Create a segment.
JourneySegment	postJourneySegments(JourneySegmentRequest body)	Create a segment.
ApiResponse<JourneySegment>	postJourneySegmentsWithHttpInfo(JourneySegmentRequest body)	Create a segment.
JourneyView	postJourneyViews(PostJourneyViewsRequest request)	Create a new Journey View
ApiResponse<JourneyView>	postJourneyViews(ApiRequest<JourneyView> request)	Create a new Journey View
JourneyView	postJourneyViews(JourneyView body)	Create a new Journey View
JourneyViewSchedule	postJourneyViewSchedules(PostJourneyViewSchedulesRequest request)	Add a new Schedule to a JourneyView
ApiResponse<JourneyViewSchedule>	postJourneyViewSchedules(ApiRequest<JourneyViewSchedule> request)	Add a new Schedule to a JourneyView
JourneyViewSchedule	postJourneyViewSchedules(String viewId, JourneyViewSchedule body)	Add a new Schedule to a JourneyView
ApiResponse<JourneyViewSchedule>	postJourneyViewSchedulesWithHttpInfo(String viewId, JourneyViewSchedule body)	Add a new Schedule to a JourneyView
EntityListing	postJourneyViewsEncodingsValidate(PostJourneyViewsEncodingsValidateRequest request)	Validate whether an encoding exist for a label/value combination.
ApiResponse<EntityListing>	postJourneyViewsEncodingsValidate(ApiRequest<List<Label>> request)	Validate whether an encoding exist for a label/value combination.
EntityListing	postJourneyViewsEncodingsValidate(List<Label> body)	Validate whether an encoding exist for a label/value combination.
ApiResponse<EntityListing>	postJourneyViewsEncodingsValidateWithHttpInfo(List<Label> body)	Validate whether an encoding exist for a label/value combination.
ApiResponse<JourneyView>	postJourneyViewsWithHttpInfo(JourneyView body)	Create a new Journey View
JourneyViewJob	postJourneyViewVersionJobs(PostJourneyViewVersionJobsRequest request)	Submit a job request for a journey view version.
ApiResponse<JourneyViewJob>	postJourneyViewVersionJobs(ApiRequest<Void> request)	Submit a job request for a journey view version.
JourneyViewJob	postJourneyViewVersionJobs(String viewId, String journeyVersionId)	Submit a job request for a journey view version.
ApiResponse<JourneyViewJob>	postJourneyViewVersionJobsWithHttpInfo(String viewId, String journeyVersionId)	Submit a job request for a journey view version.
JourneyView	postJourneyViewVersions(PostJourneyViewVersionsRequest request)	Update a Journey View by ID creates a new version
ApiResponse<JourneyView>	postJourneyViewVersions(ApiRequest<JourneyView> request)	Update a Journey View by ID creates a new version
JourneyView	postJourneyViewVersions(String viewId, JourneyView body)	Update a Journey View by ID creates a new version
ApiResponse<JourneyView>	postJourneyViewVersionsWithHttpInfo(String viewId, JourneyView body)	Update a Journey View by ID creates a new version
JourneyExternalEventsSchema	putJourneyExternaleventsSchema(PutJourneyExternaleventsSchemaRequest request)	Update a schema
ApiResponse<JourneyExternalEventsSchema>	putJourneyExternaleventsSchema(ApiRequest<JourneySchemaUpdateRequest> request)	Update a schema
JourneyExternalEventsSchema	putJourneyExternaleventsSchema(String schemaId, JourneySchemaUpdateRequest body)	Update a schema
ApiResponse<JourneyExternalEventsSchema>	putJourneyExternaleventsSchemaWithHttpInfo(String schemaId, JourneySchemaUpdateRequest body)	Update a schema
JourneyViewSchedule	putJourneyViewSchedules(PutJourneyViewSchedulesRequest request)	Update the Schedule for a JourneyView
ApiResponse<JourneyViewSchedule>	putJourneyViewSchedules(ApiRequest<JourneyViewSchedule> request)	Update the Schedule for a JourneyView
JourneyViewSchedule	putJourneyViewSchedules(String viewId, JourneyViewSchedule body)	Update the Schedule for a JourneyView
ApiResponse<JourneyViewSchedule>	putJourneyViewSchedulesWithHttpInfo(String viewId, JourneyViewSchedule body)	Update the Schedule for a JourneyView
UpdateExternalEventResponse	putJourneyViewsEventdefinition(PutJourneyViewsEventdefinitionRequest request)	Update external event for journey views
ApiResponse<UpdateExternalEventResponse>	putJourneyViewsEventdefinition(ApiRequest<UpdateExternalEventRequest> request)	Update external event for journey views
UpdateExternalEventResponse	putJourneyViewsEventdefinition(String eventDefinitionId, UpdateExternalEventRequest body)	Update external event for journey views
ActivateExternalEventResponse	putJourneyViewsEventdefinitionActivate(PutJourneyViewsEventdefinitionActivateRequest request)	Activate external event for journey views
ApiResponse<ActivateExternalEventResponse>	putJourneyViewsEventdefinitionActivate(ApiRequest<ActivateExternalEventRequest> request)	Activate external event for journey views
ActivateExternalEventResponse	putJourneyViewsEventdefinitionActivate(String eventDefinitionId, ActivateExternalEventRequest body)	Activate external event for journey views
ApiResponse<ActivateExternalEventResponse>	putJourneyViewsEventdefinitionActivateWithHttpInfo(String eventDefinitionId, ActivateExternalEventRequest body)	Activate external event for journey views
ApiResponse<UpdateExternalEventResponse>	putJourneyViewsEventdefinitionWithHttpInfo(String eventDefinitionId, UpdateExternalEventRequest body)	Update external event for journey views
JourneyView	putJourneyViewVersion(PutJourneyViewVersionRequest request)	Update a Journey View by ID and version does not create a new version
ApiResponse<JourneyView>	putJourneyViewVersion(ApiRequest<JourneyView> request)	Update a Journey View by ID and version does not create a new version
JourneyView	putJourneyViewVersion(String viewId, String versionId, JourneyView body)	Update a Journey View by ID and version does not create a new version
ApiResponse<JourneyView>	putJourneyViewVersionWithHttpInfo(String viewId, String versionId, JourneyView body)	Update a Journey View by ID and version does not create a new version

Methods inherited from class java.lang.Object

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

Constructor Details

JourneyApi

public JourneyApi()

JourneyApi

public JourneyApi(ApiClient apiClient)

Method Details

deleteAnalyticsJourneysAggregatesJob

public void deleteAnalyticsJourneysAggregatesJob(String jobId)
                                          throws IOException,
ApiException

Delete/cancel an async request for journey aggregates

Parameters:

jobId - jobId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsJourneysAggregatesJobWithHttpInfo

public ApiResponse<Void> deleteAnalyticsJourneysAggregatesJobWithHttpInfo(String jobId)
                                                                   throws IOException

Delete/cancel an async request for journey aggregates

Parameters:

jobId - jobId (required)

Throws:

IOException - if the request fails to be processed

deleteAnalyticsJourneysAggregatesJob

public void deleteAnalyticsJourneysAggregatesJob(DeleteAnalyticsJourneysAggregatesJobRequest request)
                                          throws IOException,
ApiException

Delete/cancel an async request for journey aggregates

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteAnalyticsJourneysAggregatesJob

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

Delete/cancel an async request for journey aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyActionmap

public void deleteJourneyActionmap(String actionMapId)
                            throws IOException,
ApiException

Delete single action map.

Parameters:

actionMapId - ID of the action map. (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyActionmapWithHttpInfo

public ApiResponse<Void> deleteJourneyActionmapWithHttpInfo(String actionMapId)
                                                     throws IOException

Delete single action map.

Parameters:

actionMapId - ID of the action map. (required)

Throws:

IOException - if the request fails to be processed

deleteJourneyActionmap

public void deleteJourneyActionmap(DeleteJourneyActionmapRequest request)
                            throws IOException,
ApiException

Delete single action map.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyActionmap

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

Delete single action map.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyActiontemplate

public void deleteJourneyActiontemplate(String actionTemplateId,
 Boolean hardDelete)
                                 throws IOException,
ApiException

Delete a single action template.

Parameters:

actionTemplateId - ID of the action template. (required)

hardDelete - Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (optional)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyActiontemplateWithHttpInfo

public ApiResponse<Void> deleteJourneyActiontemplateWithHttpInfo(String actionTemplateId,
 Boolean hardDelete)
                                                          throws IOException

Delete a single action template.

Parameters:

actionTemplateId - ID of the action template. (required)

hardDelete - Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (optional)

Throws:

IOException - if the request fails to be processed

deleteJourneyActiontemplate

public void deleteJourneyActiontemplate(DeleteJourneyActiontemplateRequest request)
                                 throws IOException,
ApiException

Delete a single action template.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyActiontemplate

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

Delete a single action template.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyExternaleventsConfiguration

public void deleteJourneyExternaleventsConfiguration(String configId)
                                              throws IOException,
ApiException

Delete an external events configuration.

Parameters:

configId - The ID of the external event configuration. (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyExternaleventsConfigurationWithHttpInfo

public ApiResponse<Void> deleteJourneyExternaleventsConfigurationWithHttpInfo(String configId)
                                                                       throws IOException

Delete an external events configuration.

Parameters:

configId - The ID of the external event configuration. (required)

Throws:

IOException - if the request fails to be processed

deleteJourneyExternaleventsConfiguration

public void deleteJourneyExternaleventsConfiguration(DeleteJourneyExternaleventsConfigurationRequest request)
                                              throws IOException,
ApiException

Delete an external events configuration.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyExternaleventsConfiguration

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

Delete an external events configuration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyExternaleventsSchema

public void deleteJourneyExternaleventsSchema(String schemaId)
                                       throws IOException,
ApiException

Delete a schema

Parameters:

schemaId - Schema ID (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyExternaleventsSchemaWithHttpInfo

public ApiResponse<Void> deleteJourneyExternaleventsSchemaWithHttpInfo(String schemaId)
                                                                throws IOException

Delete a schema

Parameters:

schemaId - Schema ID (required)

Throws:

IOException - if the request fails to be processed

deleteJourneyExternaleventsSchema

public void deleteJourneyExternaleventsSchema(DeleteJourneyExternaleventsSchemaRequest request)
                                       throws IOException,
ApiException

Delete a schema

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyExternaleventsSchema

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

Delete a schema

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyOutcome

public void deleteJourneyOutcome(String outcomeId)
                          throws IOException,
ApiException

Deprecated.

Deprecated. Delete an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

outcomeId - ID of the outcome. (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyOutcomeWithHttpInfo

public ApiResponse<Void> deleteJourneyOutcomeWithHttpInfo(String outcomeId)
                                                   throws IOException

Deprecated.

Deprecated. Delete an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

outcomeId - ID of the outcome. (required)

Throws:

IOException - if the request fails to be processed

deleteJourneyOutcome

public void deleteJourneyOutcome(DeleteJourneyOutcomeRequest request)
                          throws IOException,
ApiException

Deprecated.

Deprecated. Delete an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyOutcome

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

Deprecated.

Deprecated. Delete an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyOutcomesPredictor

public void deleteJourneyOutcomesPredictor(String predictorId)
                                    throws IOException,
ApiException

Deprecated.

Deprecated. Delete an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

predictorId - ID of predictor (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyOutcomesPredictorWithHttpInfo

public ApiResponse<Void> deleteJourneyOutcomesPredictorWithHttpInfo(String predictorId)
                                                             throws IOException

Deprecated.

Deprecated. Delete an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

predictorId - ID of predictor (required)

Throws:

IOException - if the request fails to be processed

deleteJourneyOutcomesPredictor

public void deleteJourneyOutcomesPredictor(DeleteJourneyOutcomesPredictorRequest request)
                                    throws IOException,
ApiException

Deprecated.

Deprecated. Delete an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyOutcomesPredictor

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

Deprecated.

Deprecated. Delete an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneySegment

public void deleteJourneySegment(String segmentId)
                          throws IOException,
ApiException

Delete a segment.

Parameters:

segmentId - ID of the segment. (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneySegmentWithHttpInfo

public ApiResponse<Void> deleteJourneySegmentWithHttpInfo(String segmentId)
                                                   throws IOException

Delete a segment.

Parameters:

segmentId - ID of the segment. (required)

Throws:

IOException - if the request fails to be processed

deleteJourneySegment

public void deleteJourneySegment(DeleteJourneySegmentRequest request)
                          throws IOException,
ApiException

Delete a segment.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneySegment

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

Delete a segment.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyView

public void deleteJourneyView(String viewId)
                       throws IOException,
ApiException

Delete a Journey View by ID deletes all versions

Parameters:

viewId - viewId (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyViewWithHttpInfo

public ApiResponse<Void> deleteJourneyViewWithHttpInfo(String viewId)
                                                throws IOException

Delete a Journey View by ID deletes all versions

Parameters:

viewId - viewId (required)

Throws:

IOException - if the request fails to be processed

deleteJourneyView

public void deleteJourneyView(DeleteJourneyViewRequest request)
                       throws IOException,
ApiException

Delete a Journey View by ID deletes all versions

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyView

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

Delete a Journey View by ID deletes all versions

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

deleteJourneyViewSchedules

public JourneyViewSchedule deleteJourneyViewSchedules(String viewId)
                                               throws IOException,
ApiException

Delete the Schedule of a JourneyView

Parameters:

viewId - Journey View Id (required)

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyViewSchedulesWithHttpInfo

public ApiResponse<JourneyViewSchedule> deleteJourneyViewSchedulesWithHttpInfo(String viewId)
                                                                        throws IOException

Delete the Schedule of a JourneyView

Parameters:

viewId - Journey View Id (required)

Returns:

JourneyViewSchedule

Throws:

IOException - if the request fails to be processed

deleteJourneyViewSchedules

public JourneyViewSchedule deleteJourneyViewSchedules(DeleteJourneyViewSchedulesRequest request)
                                               throws IOException,
ApiException

Delete the Schedule of a JourneyView

Parameters:

request - The request object

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

deleteJourneyViewSchedules

public ApiResponse<JourneyViewSchedule> deleteJourneyViewSchedules(ApiRequest<Void> request)
                                                            throws IOException

Delete the Schedule of a JourneyView

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJob

public AsyncQueryStatus getAnalyticsJourneysAggregatesJob(String jobId)
                                                   throws IOException,
ApiException

Get status for async query for journey aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJobWithHttpInfo

public ApiResponse<AsyncQueryStatus> getAnalyticsJourneysAggregatesJobWithHttpInfo(String jobId)
                                                                            throws IOException

Get status for async query for journey aggregates

Parameters:

jobId - jobId (required)

Returns:

AsyncQueryStatus

Throws:

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJob

public AsyncQueryStatus getAnalyticsJourneysAggregatesJob(GetAnalyticsJourneysAggregatesJobRequest request)
                                                   throws IOException,
ApiException

Get status for async query for journey aggregates

Parameters:

request - The request object

Returns:

AsyncQueryStatus

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJob

public ApiResponse<AsyncQueryStatus> getAnalyticsJourneysAggregatesJob(ApiRequest<Void> request)
                                                                throws IOException

Get status for async query for journey aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJobResults

public JourneyAsyncAggregateQueryResponse getAnalyticsJourneysAggregatesJobResults(String jobId,
 String cursor)
                                                                            throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

JourneyAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJobResultsWithHttpInfo

public ApiResponse<JourneyAsyncAggregateQueryResponse> getAnalyticsJourneysAggregatesJobResultsWithHttpInfo(String jobId,
 String cursor)
                                                                                                     throws IOException

Fetch a page of results for an async aggregates query

Parameters:

jobId - jobId (required)

cursor - Cursor token to retrieve next page (optional)

Returns:

JourneyAsyncAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJobResults

public JourneyAsyncAggregateQueryResponse getAnalyticsJourneysAggregatesJobResults(GetAnalyticsJourneysAggregatesJobResultsRequest request)
                                                                            throws IOException,
ApiException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

JourneyAsyncAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getAnalyticsJourneysAggregatesJobResults

public ApiResponse<JourneyAsyncAggregateQueryResponse> getAnalyticsJourneysAggregatesJobResults(ApiRequest<Void> request)
                                                                                         throws IOException

Fetch a page of results for an async aggregates query

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getExternalcontactsContactJourneySegments

public SegmentAssignmentListing getExternalcontactsContactJourneySegments(String contactId,
 Boolean includeMerged,
 Integer limit)
                                                                   throws IOException,
ApiException

Retrieve segment assignments by external contact ID.

Parameters:

contactId - ExternalContact ID (required)

includeMerged - Indicates whether to return segment assignments from all external contacts in the merge-set of the given one. (optional)

limit - Number of entities to return. Default of 25, maximum of 500. (optional)

Returns:

SegmentAssignmentListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getExternalcontactsContactJourneySegmentsWithHttpInfo

public ApiResponse<SegmentAssignmentListing> getExternalcontactsContactJourneySegmentsWithHttpInfo(String contactId,
 Boolean includeMerged,
 Integer limit)
                                                                                            throws IOException

Retrieve segment assignments by external contact ID.

Parameters:

contactId - ExternalContact ID (required)

includeMerged - Indicates whether to return segment assignments from all external contacts in the merge-set of the given one. (optional)

limit - Number of entities to return. Default of 25, maximum of 500. (optional)

Returns:

SegmentAssignmentListing

Throws:

IOException - if the request fails to be processed

getExternalcontactsContactJourneySegments

public SegmentAssignmentListing getExternalcontactsContactJourneySegments(GetExternalcontactsContactJourneySegmentsRequest request)
                                                                   throws IOException,
ApiException

Retrieve segment assignments by external contact ID.

Parameters:

request - The request object

Returns:

SegmentAssignmentListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getExternalcontactsContactJourneySegments

public ApiResponse<SegmentAssignmentListing> getExternalcontactsContactJourneySegments(ApiRequest<Void> request)
                                                                                throws IOException

Retrieve segment assignments by external contact ID.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getExternalcontactsContactJourneySessions

public SessionListing getExternalcontactsContactJourneySessions(String contactId,
 String pageSize,
 String after,
 Boolean includeMerged)
                                                         throws IOException,
ApiException

Retrieve all sessions for a given external contact.

Parameters:

contactId - ExternalContact ID (required)

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

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

includeMerged - Indicates whether to return sessions from all external contacts in the merge-set of the given one. (optional)

Returns:

SessionListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getExternalcontactsContactJourneySessionsWithHttpInfo

public ApiResponse<SessionListing> getExternalcontactsContactJourneySessionsWithHttpInfo(String contactId,
 String pageSize,
 String after,
 Boolean includeMerged)
                                                                                  throws IOException

Retrieve all sessions for a given external contact.

Parameters:

contactId - ExternalContact ID (required)

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

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

includeMerged - Indicates whether to return sessions from all external contacts in the merge-set of the given one. (optional)

Returns:

SessionListing

Throws:

IOException - if the request fails to be processed

getExternalcontactsContactJourneySessions

public SessionListing getExternalcontactsContactJourneySessions(GetExternalcontactsContactJourneySessionsRequest request)
                                                         throws IOException,
ApiException

Retrieve all sessions for a given external contact.

Parameters:

request - The request object

Returns:

SessionListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getExternalcontactsContactJourneySessions

public ApiResponse<SessionListing> getExternalcontactsContactJourneySessions(ApiRequest<Void> request)
                                                                      throws IOException

Retrieve all sessions for a given external contact.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActionmap

public ActionMap getJourneyActionmap(String actionMapId)
                              throws IOException,
ApiException

Retrieve a single action map.

Parameters:

actionMapId - ID of the action map. (required)

Returns:

ActionMap

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmapWithHttpInfo

public ApiResponse<ActionMap> getJourneyActionmapWithHttpInfo(String actionMapId)
                                                       throws IOException

Retrieve a single action map.

Parameters:

actionMapId - ID of the action map. (required)

Returns:

ActionMap

Throws:

IOException - if the request fails to be processed

getJourneyActionmap

public ActionMap getJourneyActionmap(GetJourneyActionmapRequest request)
                              throws IOException,
ApiException

Retrieve a single action map.

Parameters:

request - The request object

Returns:

ActionMap

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmap

public ApiResponse<ActionMap> getJourneyActionmap(ApiRequest<Void> request)
                                           throws IOException

Retrieve a single action map.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActionmaps

public ActionMapListing getJourneyActionmaps(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String filterField,
 String filterValue,
 List<String> actionMapIds,
 List<String> queryFields,
 String queryValue)
                                      throws IOException,
ApiException

Retrieve all action maps.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional)

filterField - Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set. (optional)

filterValue - Value to filter by. Requires 'filterValue' to also be set. (optional)

actionMapIds - IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request. (optional)

queryFields - Action Map field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

ActionMapListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmapsWithHttpInfo

public ApiResponse<ActionMapListing> getJourneyActionmapsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String filterField,
 String filterValue,
 List<String> actionMapIds,
 List<String> queryFields,
 String queryValue)
                                                               throws IOException

Retrieve all action maps.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional)

filterField - Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set. (optional)

filterValue - Value to filter by. Requires 'filterValue' to also be set. (optional)

actionMapIds - IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request. (optional)

queryFields - Action Map field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

ActionMapListing

Throws:

IOException - if the request fails to be processed

getJourneyActionmaps

public ActionMapListing getJourneyActionmaps(GetJourneyActionmapsRequest request)
                                      throws IOException,
ApiException

Retrieve all action maps.

Parameters:

request - The request object

Returns:

ActionMapListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmaps

public ApiResponse<ActionMapListing> getJourneyActionmaps(ApiRequest<Void> request)
                                                   throws IOException

Retrieve all action maps.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJob

public String getJourneyActionmapsEstimatesJob(String jobId)
                                        throws IOException,
ApiException

Deprecated.

Deprecated. Get status of job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

jobId - ID of the job. (required)

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJobWithHttpInfo

public ApiResponse<String> getJourneyActionmapsEstimatesJobWithHttpInfo(String jobId)
                                                                 throws IOException

Deprecated.

Deprecated. Get status of job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

jobId - ID of the job. (required)

Returns:

String

Throws:

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJob

public String getJourneyActionmapsEstimatesJob(GetJourneyActionmapsEstimatesJobRequest request)
                                        throws IOException,
ApiException

Deprecated.

Deprecated. Get status of job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

String

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJob

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

Deprecated.

Deprecated. Get status of job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJobResults

public ActionMapEstimateResult getJourneyActionmapsEstimatesJobResults(String jobId)
                                                                throws IOException,
ApiException

Deprecated.

Deprecated. Get estimates from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

jobId - ID of the job. (required)

Returns:

ActionMapEstimateResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJobResultsWithHttpInfo

public ApiResponse<ActionMapEstimateResult> getJourneyActionmapsEstimatesJobResultsWithHttpInfo(String jobId)
                                                                                         throws IOException

Deprecated.

Deprecated. Get estimates from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

jobId - ID of the job. (required)

Returns:

ActionMapEstimateResult

Throws:

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJobResults

public ActionMapEstimateResult getJourneyActionmapsEstimatesJobResults(GetJourneyActionmapsEstimatesJobResultsRequest request)
                                                                throws IOException,
ApiException

Deprecated.

Deprecated. Get estimates from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

ActionMapEstimateResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActionmapsEstimatesJobResults

public ApiResponse<ActionMapEstimateResult> getJourneyActionmapsEstimatesJobResults(ApiRequest<Void> request)
                                                                             throws IOException

Deprecated.

Deprecated. Get estimates from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActiontarget

public ActionTarget getJourneyActiontarget(String actionTargetId)
                                    throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

actionTargetId - ID of the action target. (required)

Returns:

ActionTarget

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontargetWithHttpInfo

public ApiResponse<ActionTarget> getJourneyActiontargetWithHttpInfo(String actionTargetId)
                                                             throws IOException

Deprecated.

Deprecated. Retrieve a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

actionTargetId - ID of the action target. (required)

Returns:

ActionTarget

Throws:

IOException - if the request fails to be processed

getJourneyActiontarget

public ActionTarget getJourneyActiontarget(GetJourneyActiontargetRequest request)
                                    throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

request - The request object

Returns:

ActionTarget

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontarget

public ApiResponse<ActionTarget> getJourneyActiontarget(ApiRequest<Void> request)
                                                 throws IOException

Deprecated.

Deprecated. Retrieve a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActiontargets

public ActionTargetListing getJourneyActiontargets(Integer pageNumber,
 Integer pageSize)
                                            throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve all action targets. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

ActionTargetListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontargetsWithHttpInfo

public ApiResponse<ActionTargetListing> getJourneyActiontargetsWithHttpInfo(Integer pageNumber,
 Integer pageSize)
                                                                     throws IOException

Deprecated.

Deprecated. Retrieve all action targets. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

Returns:

ActionTargetListing

Throws:

IOException - if the request fails to be processed

getJourneyActiontargets

public ActionTargetListing getJourneyActiontargets(GetJourneyActiontargetsRequest request)
                                            throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve all action targets. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

request - The request object

Returns:

ActionTargetListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontargets

public ApiResponse<ActionTargetListing> getJourneyActiontargets(ApiRequest<Void> request)
                                                         throws IOException

Deprecated.

Deprecated. Retrieve all action targets. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActiontemplate

public ActionTemplate getJourneyActiontemplate(String actionTemplateId)
                                        throws IOException,
ApiException

Retrieve a single action template.

Parameters:

actionTemplateId - ID of the action template. (required)

Returns:

ActionTemplate

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontemplateWithHttpInfo

public ApiResponse<ActionTemplate> getJourneyActiontemplateWithHttpInfo(String actionTemplateId)
                                                                 throws IOException

Retrieve a single action template.

Parameters:

actionTemplateId - ID of the action template. (required)

Returns:

ActionTemplate

Throws:

IOException - if the request fails to be processed

getJourneyActiontemplate

public ActionTemplate getJourneyActiontemplate(GetJourneyActiontemplateRequest request)
                                        throws IOException,
ApiException

Retrieve a single action template.

Parameters:

request - The request object

Returns:

ActionTemplate

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontemplate

public ApiResponse<ActionTemplate> getJourneyActiontemplate(ApiRequest<Void> request)
                                                     throws IOException

Retrieve a single action template.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyActiontemplates

public ActionTemplateListing getJourneyActiontemplates(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String mediaType,
 String state,
 List<String> queryFields,
 String queryValue)
                                                throws IOException,
ApiException

Retrieve all action templates.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate). (optional)

mediaType - Media type (optional)

state - Action template state. (optional)

queryFields - ActionTemplate field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

ActionTemplateListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontemplatesWithHttpInfo

public ApiResponse<ActionTemplateListing> getJourneyActiontemplatesWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 String mediaType,
 String state,
 List<String> queryFields,
 String queryValue)
                                                                         throws IOException

Retrieve all action templates.

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate). (optional)

mediaType - Media type (optional)

state - Action template state. (optional)

queryFields - ActionTemplate field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

ActionTemplateListing

Throws:

IOException - if the request fails to be processed

getJourneyActiontemplates

public ActionTemplateListing getJourneyActiontemplates(GetJourneyActiontemplatesRequest request)
                                                throws IOException,
ApiException

Retrieve all action templates.

Parameters:

request - The request object

Returns:

ActionTemplateListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyActiontemplates

public ApiResponse<ActionTemplateListing> getJourneyActiontemplates(ApiRequest<Void> request)
                                                             throws IOException

Retrieve all action templates.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyDeploymentCustomerPing

public DeploymentPing getJourneyDeploymentCustomerPing(String deploymentId,
 String customerCookieId,
 String dl,
 String dt,
 String appNamespace,
 String sessionId,
 Long sinceLastBeaconMilliseconds)
                                                throws IOException,
ApiException

Send a ping.

Parameters:

deploymentId - The ID of the deployment sending the ping. (required)

customerCookieId - ID of the customer associated with the ping. (required)

dl - Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions. (optional)

dt - Document Title. A human readable name for the page or screen (optional)

appNamespace - Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions (optional)

sessionId - UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session (optional)

sinceLastBeaconMilliseconds - How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings. (optional)

Returns:

DeploymentPing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyDeploymentCustomerPingWithHttpInfo

public ApiResponse<DeploymentPing> getJourneyDeploymentCustomerPingWithHttpInfo(String deploymentId,
 String customerCookieId,
 String dl,
 String dt,
 String appNamespace,
 String sessionId,
 Long sinceLastBeaconMilliseconds)
                                                                         throws IOException

Send a ping.

Parameters:

deploymentId - The ID of the deployment sending the ping. (required)

customerCookieId - ID of the customer associated with the ping. (required)

dl - Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions. (optional)

dt - Document Title. A human readable name for the page or screen (optional)

appNamespace - Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions (optional)

sessionId - UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session (optional)

sinceLastBeaconMilliseconds - How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings. (optional)

Returns:

DeploymentPing

Throws:

IOException - if the request fails to be processed

getJourneyDeploymentCustomerPing

public DeploymentPing getJourneyDeploymentCustomerPing(GetJourneyDeploymentCustomerPingRequest request)
                                                throws IOException,
ApiException

Send a ping.

Parameters:

request - The request object

Returns:

DeploymentPing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyDeploymentCustomerPing

public ApiResponse<DeploymentPing> getJourneyDeploymentCustomerPing(ApiRequest<Void> request)
                                                             throws IOException

Send a ping.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsConfiguration

public ExternalEventsConfiguration getJourneyExternaleventsConfiguration(String configId)
                                                                  throws IOException,
ApiException

Get an external events configuration

Parameters:

configId - The ID of the external event configuration. (required)

Returns:

ExternalEventsConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsConfigurationWithHttpInfo

public ApiResponse<ExternalEventsConfiguration> getJourneyExternaleventsConfigurationWithHttpInfo(String configId)
                                                                                           throws IOException

Get an external events configuration

Parameters:

configId - The ID of the external event configuration. (required)

Returns:

ExternalEventsConfiguration

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsConfiguration

public ExternalEventsConfiguration getJourneyExternaleventsConfiguration(GetJourneyExternaleventsConfigurationRequest request)
                                                                  throws IOException,
ApiException

Get an external events configuration

Parameters:

request - The request object

Returns:

ExternalEventsConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsConfiguration

public ApiResponse<ExternalEventsConfiguration> getJourneyExternaleventsConfiguration(ApiRequest<Void> request)
                                                                               throws IOException

Get an external events configuration

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsConfigurations

public ExternalEventsConfigurationListing getJourneyExternaleventsConfigurations(Integer pageSize,
 Integer pageNumber)
                                                                          throws IOException,
ApiException

Get all external event configurations.

Parameters:

pageSize - Page size (optional, default to 20)

pageNumber - Page number (optional, default to 1)

Returns:

ExternalEventsConfigurationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsConfigurationsWithHttpInfo

public ApiResponse<ExternalEventsConfigurationListing> getJourneyExternaleventsConfigurationsWithHttpInfo(Integer pageSize,
 Integer pageNumber)
                                                                                                   throws IOException

Get all external event configurations.

Parameters:

pageSize - Page size (optional, default to 20)

pageNumber - Page number (optional, default to 1)

Returns:

ExternalEventsConfigurationListing

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsConfigurations

public ExternalEventsConfigurationListing getJourneyExternaleventsConfigurations(GetJourneyExternaleventsConfigurationsRequest request)
                                                                          throws IOException,
ApiException

Get all external event configurations.

Parameters:

request - The request object

Returns:

ExternalEventsConfigurationListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsConfigurations

public ApiResponse<ExternalEventsConfigurationListing> getJourneyExternaleventsConfigurations(ApiRequest<Void> request)
                                                                                       throws IOException

Get all external event configurations.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchema

public JourneyExternalEventsSchema getJourneyExternaleventsSchema(String schemaId)
                                                           throws IOException,
ApiException

Get a schema

Parameters:

schemaId - Schema ID (required)

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaWithHttpInfo

public ApiResponse<JourneyExternalEventsSchema> getJourneyExternaleventsSchemaWithHttpInfo(String schemaId)
                                                                                    throws IOException

Get a schema

Parameters:

schemaId - Schema ID (required)

Returns:

JourneyExternalEventsSchema

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchema

public JourneyExternalEventsSchema getJourneyExternaleventsSchema(GetJourneyExternaleventsSchemaRequest request)
                                                           throws IOException,
ApiException

Get a schema

Parameters:

request - The request object

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchema

public ApiResponse<JourneyExternalEventsSchema> getJourneyExternaleventsSchema(ApiRequest<Void> request)
                                                                        throws IOException

Get a schema

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersion

public JourneyExternalEventsSchema getJourneyExternaleventsSchemaVersion(String schemaId,
 String versionId)
                                                                  throws IOException,
ApiException

Get a specific version of a schema

Parameters:

schemaId - Schema ID (required)

versionId - Schema version (required)

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersionWithHttpInfo

public ApiResponse<JourneyExternalEventsSchema> getJourneyExternaleventsSchemaVersionWithHttpInfo(String schemaId,
 String versionId)
                                                                                           throws IOException

Get a specific version of a schema

Parameters:

schemaId - Schema ID (required)

versionId - Schema version (required)

Returns:

JourneyExternalEventsSchema

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersion

public JourneyExternalEventsSchema getJourneyExternaleventsSchemaVersion(GetJourneyExternaleventsSchemaVersionRequest request)
                                                                  throws IOException,
ApiException

Get a specific version of a schema

Parameters:

request - The request object

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersion

public ApiResponse<JourneyExternalEventsSchema> getJourneyExternaleventsSchemaVersion(ApiRequest<Void> request)
                                                                               throws IOException

Get a specific version of a schema

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersions

public JourneyExternalEventsSchemaListing getJourneyExternaleventsSchemaVersions(String schemaId)
                                                                          throws IOException,
ApiException

Get all versions of a External Events schema

Parameters:

schemaId - Schema ID (required)

Returns:

JourneyExternalEventsSchemaListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersionsWithHttpInfo

public ApiResponse<JourneyExternalEventsSchemaListing> getJourneyExternaleventsSchemaVersionsWithHttpInfo(String schemaId)
                                                                                                   throws IOException

Get all versions of a External Events schema

Parameters:

schemaId - Schema ID (required)

Returns:

JourneyExternalEventsSchemaListing

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersions

public JourneyExternalEventsSchemaListing getJourneyExternaleventsSchemaVersions(GetJourneyExternaleventsSchemaVersionsRequest request)
                                                                          throws IOException,
ApiException

Get all versions of a External Events schema

Parameters:

request - The request object

Returns:

JourneyExternalEventsSchemaListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemaVersions

public ApiResponse<JourneyExternalEventsSchemaListing> getJourneyExternaleventsSchemaVersions(ApiRequest<Void> request)
                                                                                       throws IOException

Get all versions of a External Events schema

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemas

public JourneyExternalEventsSchemaListing getJourneyExternaleventsSchemas()
                                                                   throws IOException,
ApiException

Get a list of schemas.

Returns:

JourneyExternalEventsSchemaListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasWithHttpInfo

public ApiResponse<JourneyExternalEventsSchemaListing> getJourneyExternaleventsSchemasWithHttpInfo()
                                                                                            throws IOException

Get a list of schemas.

Returns:

JourneyExternalEventsSchemaListing

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemas

public JourneyExternalEventsSchemaListing getJourneyExternaleventsSchemas(GetJourneyExternaleventsSchemasRequest request)
                                                                   throws IOException,
ApiException

Get a list of schemas.

Parameters:

request - The request object

Returns:

JourneyExternalEventsSchemaListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemas

public ApiResponse<JourneyExternalEventsSchemaListing> getJourneyExternaleventsSchemas(ApiRequest<Void> request)
                                                                                throws IOException

Get a list of schemas.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretype

public Coretype getJourneyExternaleventsSchemasCoretype(String coreTypeName)
                                                 throws IOException,
ApiException

Get a core type from which all schemas are built

Parameters:

coreTypeName - Name of core type (required)

Returns:

Coretype

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretypeWithHttpInfo

public ApiResponse<Coretype> getJourneyExternaleventsSchemasCoretypeWithHttpInfo(String coreTypeName)
                                                                          throws IOException

Get a core type from which all schemas are built

Parameters:

coreTypeName - Name of core type (required)

Returns:

Coretype

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretype

public Coretype getJourneyExternaleventsSchemasCoretype(GetJourneyExternaleventsSchemasCoretypeRequest request)
                                                 throws IOException,
ApiException

Get a core type from which all schemas are built

Parameters:

request - The request object

Returns:

Coretype

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretype

public ApiResponse<Coretype> getJourneyExternaleventsSchemasCoretype(ApiRequest<Void> request)
                                                              throws IOException

Get a core type from which all schemas are built

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretypes

public CoretypeListing getJourneyExternaleventsSchemasCoretypes()
                                                         throws IOException,
ApiException

Get the list of core types enabled for a specific namespace.

Returns:

CoretypeListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretypesWithHttpInfo

public ApiResponse<CoretypeListing> getJourneyExternaleventsSchemasCoretypesWithHttpInfo()
                                                                                  throws IOException

Get the list of core types enabled for a specific namespace.

Returns:

CoretypeListing

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretypes

public CoretypeListing getJourneyExternaleventsSchemasCoretypes(GetJourneyExternaleventsSchemasCoretypesRequest request)
                                                         throws IOException,
ApiException

Get the list of core types enabled for a specific namespace.

Parameters:

request - The request object

Returns:

CoretypeListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasCoretypes

public ApiResponse<CoretypeListing> getJourneyExternaleventsSchemasCoretypes(ApiRequest<Void> request)
                                                                      throws IOException

Get the list of core types enabled for a specific namespace.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasLimits

public SchemaQuantityLimits getJourneyExternaleventsSchemasLimits()
                                                           throws IOException,
ApiException

Get quantitative limits on schemas

Returns:

SchemaQuantityLimits

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasLimitsWithHttpInfo

public ApiResponse<SchemaQuantityLimits> getJourneyExternaleventsSchemasLimitsWithHttpInfo()
                                                                                    throws IOException

Get quantitative limits on schemas

Returns:

SchemaQuantityLimits

Throws:

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasLimits

public SchemaQuantityLimits getJourneyExternaleventsSchemasLimits(GetJourneyExternaleventsSchemasLimitsRequest request)
                                                           throws IOException,
ApiException

Get quantitative limits on schemas

Parameters:

request - The request object

Returns:

SchemaQuantityLimits

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyExternaleventsSchemasLimits

public ApiResponse<SchemaQuantityLimits> getJourneyExternaleventsSchemasLimits(ApiRequest<Void> request)
                                                                        throws IOException

Get quantitative limits on schemas

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyOutcome

public Outcome getJourneyOutcome(String outcomeId)
                          throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve a single outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

outcomeId - ID of the outcome. (required)

Returns:

Outcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomeWithHttpInfo

public ApiResponse<Outcome> getJourneyOutcomeWithHttpInfo(String outcomeId)
                                                   throws IOException

Deprecated.

Deprecated. Retrieve a single outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

outcomeId - ID of the outcome. (required)

Returns:

Outcome

Throws:

IOException - if the request fails to be processed

getJourneyOutcome

public Outcome getJourneyOutcome(GetJourneyOutcomeRequest request)
                          throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve a single outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

Outcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcome

public ApiResponse<Outcome> getJourneyOutcome(ApiRequest<Void> request)
                                       throws IOException

Deprecated.

Deprecated. Retrieve a single outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyOutcomes

public OutcomeListing getJourneyOutcomes(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 List<String> outcomeIds,
 List<String> queryFields,
 String queryValue)
                                  throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional)

outcomeIds - IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request. (optional)

queryFields - Outcome field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

OutcomeListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesWithHttpInfo

public ApiResponse<OutcomeListing> getJourneyOutcomesWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String sortBy,
 List<String> outcomeIds,
 List<String> queryFields,
 String queryValue)
                                                           throws IOException

Deprecated.

Deprecated. Retrieve all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

sortBy - Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional)

outcomeIds - IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request. (optional)

queryFields - Outcome field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

OutcomeListing

Throws:

IOException - if the request fails to be processed

getJourneyOutcomes

public OutcomeListing getJourneyOutcomes(GetJourneyOutcomesRequest request)
                                  throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

OutcomeListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomes

public ApiResponse<OutcomeListing> getJourneyOutcomes(ApiRequest<Void> request)
                                               throws IOException

Deprecated.

Deprecated. Retrieve all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyOutcomesAttributionsJob

public OutcomeAttributionJobStateResponse getJourneyOutcomesAttributionsJob(String jobId)
                                                                     throws IOException,
ApiException

Deprecated.

Deprecated. Get job status. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

jobId - ID of the job. (required)

Returns:

OutcomeAttributionJobStateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesAttributionsJobWithHttpInfo

public ApiResponse<OutcomeAttributionJobStateResponse> getJourneyOutcomesAttributionsJobWithHttpInfo(String jobId)
                                                                                              throws IOException

Deprecated.

Deprecated. Get job status. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

jobId - ID of the job. (required)

Returns:

OutcomeAttributionJobStateResponse

Throws:

IOException - if the request fails to be processed

getJourneyOutcomesAttributionsJob

public OutcomeAttributionJobStateResponse getJourneyOutcomesAttributionsJob(GetJourneyOutcomesAttributionsJobRequest request)
                                                                     throws IOException,
ApiException

Deprecated.

Deprecated. Get job status. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJob 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:

OutcomeAttributionJobStateResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesAttributionsJob

public ApiResponse<OutcomeAttributionJobStateResponse> getJourneyOutcomesAttributionsJob(ApiRequest<Void> request)
                                                                                  throws IOException

Deprecated.

Deprecated. Get job status. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJob 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

getJourneyOutcomesAttributionsJobResults

public OutcomeAttributionResponseListing getJourneyOutcomesAttributionsJobResults(String jobId)
                                                                           throws IOException,
ApiException

Deprecated.

Deprecated. Get outcome attribution entities from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

jobId - ID of the job. (required)

Returns:

OutcomeAttributionResponseListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesAttributionsJobResultsWithHttpInfo

public ApiResponse<OutcomeAttributionResponseListing> getJourneyOutcomesAttributionsJobResultsWithHttpInfo(String jobId)
                                                                                                    throws IOException

Deprecated.

Deprecated. Get outcome attribution entities from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

jobId - ID of the job. (required)

Returns:

OutcomeAttributionResponseListing

Throws:

IOException - if the request fails to be processed

getJourneyOutcomesAttributionsJobResults

public OutcomeAttributionResponseListing getJourneyOutcomesAttributionsJobResults(GetJourneyOutcomesAttributionsJobResultsRequest request)
                                                                           throws IOException,
ApiException

Deprecated.

Deprecated. Get outcome attribution entities from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJobResults 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:

OutcomeAttributionResponseListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesAttributionsJobResults

public ApiResponse<OutcomeAttributionResponseListing> getJourneyOutcomesAttributionsJobResults(ApiRequest<Void> request)
                                                                                        throws IOException

Deprecated.

Deprecated. Get outcome attribution entities from completed job. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ getJourneyOutcomesAttributionsJobResults 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

getJourneyOutcomesPredictor

public OutcomePredictor getJourneyOutcomesPredictor(String predictorId)
                                             throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve a single outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

predictorId - ID of predictor (required)

Returns:

OutcomePredictor

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesPredictorWithHttpInfo

public ApiResponse<OutcomePredictor> getJourneyOutcomesPredictorWithHttpInfo(String predictorId)
                                                                      throws IOException

Deprecated.

Deprecated. Retrieve a single outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

predictorId - ID of predictor (required)

Returns:

OutcomePredictor

Throws:

IOException - if the request fails to be processed

getJourneyOutcomesPredictor

public OutcomePredictor getJourneyOutcomesPredictor(GetJourneyOutcomesPredictorRequest request)
                                             throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve a single outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

OutcomePredictor

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesPredictor

public ApiResponse<OutcomePredictor> getJourneyOutcomesPredictor(ApiRequest<Void> request)
                                                          throws IOException

Deprecated.

Deprecated. Retrieve a single outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyOutcomesPredictors

public OutcomePredictorListing getJourneyOutcomesPredictors()
                                                     throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve all outcome predictors. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Returns:

OutcomePredictorListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesPredictorsWithHttpInfo

public ApiResponse<OutcomePredictorListing> getJourneyOutcomesPredictorsWithHttpInfo()
                                                                              throws IOException

Deprecated.

Deprecated. Retrieve all outcome predictors. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Returns:

OutcomePredictorListing

Throws:

IOException - if the request fails to be processed

getJourneyOutcomesPredictors

public OutcomePredictorListing getJourneyOutcomesPredictors(GetJourneyOutcomesPredictorsRequest request)
                                                     throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve all outcome predictors. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

OutcomePredictorListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyOutcomesPredictors

public ApiResponse<OutcomePredictorListing> getJourneyOutcomesPredictors(ApiRequest<Void> request)
                                                                  throws IOException

Deprecated.

Deprecated. Retrieve all outcome predictors. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneySegment

public JourneySegment getJourneySegment(String segmentId)
                                 throws IOException,
ApiException

Retrieve a single segment.

Parameters:

segmentId - ID of the segment. (required)

Returns:

JourneySegment

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySegmentWithHttpInfo

public ApiResponse<JourneySegment> getJourneySegmentWithHttpInfo(String segmentId)
                                                          throws IOException

Retrieve a single segment.

Parameters:

segmentId - ID of the segment. (required)

Returns:

JourneySegment

Throws:

IOException - if the request fails to be processed

getJourneySegment

public JourneySegment getJourneySegment(GetJourneySegmentRequest request)
                                 throws IOException,
ApiException

Retrieve a single segment.

Parameters:

request - The request object

Returns:

JourneySegment

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySegment

public ApiResponse<JourneySegment> getJourneySegment(ApiRequest<Void> request)
                                              throws IOException

Retrieve a single segment.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneySegments

public SegmentListing getJourneySegments(String sortBy,
 Integer pageSize,
 Integer pageNumber,
 Boolean isActive,
 List<String> segmentIds,
 List<String> queryFields,
 String queryValue)
                                  throws IOException,
ApiException

Retrieve all segments.

Parameters:

sortBy - Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

isActive - Determines whether or not to show only active segments. (optional)

segmentIds - IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request. (optional)

queryFields - Segment field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

SegmentListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySegmentsWithHttpInfo

public ApiResponse<SegmentListing> getJourneySegmentsWithHttpInfo(String sortBy,
 Integer pageSize,
 Integer pageNumber,
 Boolean isActive,
 List<String> segmentIds,
 List<String> queryFields,
 String queryValue)
                                                           throws IOException

Retrieve all segments.

Parameters:

sortBy - Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional)

pageSize - Page size (optional, default to 25)

pageNumber - Page number (optional, default to 1)

isActive - Determines whether or not to show only active segments. (optional)

segmentIds - IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request. (optional)

queryFields - Segment field(s) to query on. Requires 'queryValue' to also be set. (optional)

queryValue - Value to query on using fuzzy matching. Requires 'queryFields' to also be set. (optional)

Returns:

SegmentListing

Throws:

IOException - if the request fails to be processed

getJourneySegments

public SegmentListing getJourneySegments(GetJourneySegmentsRequest request)
                                  throws IOException,
ApiException

Retrieve all segments.

Parameters:

request - The request object

Returns:

SegmentListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySegments

public ApiResponse<SegmentListing> getJourneySegments(ApiRequest<Void> request)
                                               throws IOException

Retrieve all segments.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneySession

public Session getJourneySession(String sessionId)
                          throws IOException,
ApiException

Retrieve a single session.

Parameters:

sessionId - ID of the session. (required)

Returns:

Session

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySessionWithHttpInfo

public ApiResponse<Session> getJourneySessionWithHttpInfo(String sessionId)
                                                   throws IOException

Retrieve a single session.

Parameters:

sessionId - ID of the session. (required)

Returns:

Session

Throws:

IOException - if the request fails to be processed

getJourneySession

public Session getJourneySession(GetJourneySessionRequest request)
                          throws IOException,
ApiException

Retrieve a single session.

Parameters:

request - The request object

Returns:

Session

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySession

public ApiResponse<Session> getJourneySession(ApiRequest<Void> request)
                                       throws IOException

Retrieve a single session.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneySessionEvents

public EventListing getJourneySessionEvents(String sessionId,
 String pageSize,
 String after,
 String eventType)
                                     throws IOException,
ApiException

Retrieve all events for a given session.

Parameters:

sessionId - System-generated UUID that represents the session the event is a part of. (required)

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

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

eventType - A comma separated list of journey event types to include in the results. (optional)

Returns:

EventListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySessionEventsWithHttpInfo

public ApiResponse<EventListing> getJourneySessionEventsWithHttpInfo(String sessionId,
 String pageSize,
 String after,
 String eventType)
                                                              throws IOException

Retrieve all events for a given session.

Parameters:

sessionId - System-generated UUID that represents the session the event is a part of. (required)

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

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

eventType - A comma separated list of journey event types to include in the results. (optional)

Returns:

EventListing

Throws:

IOException - if the request fails to be processed

getJourneySessionEvents

public EventListing getJourneySessionEvents(GetJourneySessionEventsRequest request)
                                     throws IOException,
ApiException

Retrieve all events for a given session.

Parameters:

request - The request object

Returns:

EventListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySessionEvents

public ApiResponse<EventListing> getJourneySessionEvents(ApiRequest<Void> request)
                                                  throws IOException

Retrieve all events for a given session.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneySessionOutcomescores

public OutcomeScoresResult getJourneySessionOutcomescores(String sessionId)
                                                   throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve latest outcome score associated with a session for all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

sessionId - ID of the session. (required)

Returns:

OutcomeScoresResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySessionOutcomescoresWithHttpInfo

public ApiResponse<OutcomeScoresResult> getJourneySessionOutcomescoresWithHttpInfo(String sessionId)
                                                                            throws IOException

Deprecated.

Deprecated. Retrieve latest outcome score associated with a session for all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

sessionId - ID of the session. (required)

Returns:

OutcomeScoresResult

Throws:

IOException - if the request fails to be processed

getJourneySessionOutcomescores

public OutcomeScoresResult getJourneySessionOutcomescores(GetJourneySessionOutcomescoresRequest request)
                                                   throws IOException,
ApiException

Deprecated.

Deprecated. Retrieve latest outcome score associated with a session for all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

OutcomeScoresResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneySessionOutcomescores

public ApiResponse<OutcomeScoresResult> getJourneySessionOutcomescores(ApiRequest<Void> request)
                                                                throws IOException

Deprecated.

Deprecated. Retrieve latest outcome score associated with a session for all outcomes. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyView

public JourneyView getJourneyView(String viewId)
                           throws IOException,
ApiException

Get a Journey View by ID returns the latest version

Parameters:

viewId - viewId (required)

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewWithHttpInfo

public ApiResponse<JourneyView> getJourneyViewWithHttpInfo(String viewId)
                                                    throws IOException

Get a Journey View by ID returns the latest version

Parameters:

viewId - viewId (required)

Returns:

JourneyView

Throws:

IOException - if the request fails to be processed

getJourneyView

public JourneyView getJourneyView(GetJourneyViewRequest request)
                           throws IOException,
ApiException

Get a Journey View by ID returns the latest version

Parameters:

request - The request object

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyView

public ApiResponse<JourneyView> getJourneyView(ApiRequest<Void> request)
                                        throws IOException

Get a Journey View by ID returns the latest version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewSchedules

public JourneyViewSchedule getJourneyViewSchedules(String viewId)
                                            throws IOException,
ApiException

Get the Schedule for a JourneyView

Parameters:

viewId - Journey View Id (required)

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewSchedulesWithHttpInfo

public ApiResponse<JourneyViewSchedule> getJourneyViewSchedulesWithHttpInfo(String viewId)
                                                                     throws IOException

Get the Schedule for a JourneyView

Parameters:

viewId - Journey View Id (required)

Returns:

JourneyViewSchedule

Throws:

IOException - if the request fails to be processed

getJourneyViewSchedules

public JourneyViewSchedule getJourneyViewSchedules(GetJourneyViewSchedulesRequest request)
                                            throws IOException,
ApiException

Get the Schedule for a JourneyView

Parameters:

request - The request object

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewSchedules

public ApiResponse<JourneyViewSchedule> getJourneyViewSchedules(ApiRequest<Void> request)
                                                         throws IOException

Get the Schedule for a JourneyView

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewVersion

public JourneyView getJourneyViewVersion(String viewId,
 String versionId)
                                  throws IOException,
ApiException

Get a Journey View by ID and version

Parameters:

viewId - viewId (required)

versionId - versionId (required)

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionWithHttpInfo

public ApiResponse<JourneyView> getJourneyViewVersionWithHttpInfo(String viewId,
 String versionId)
                                                           throws IOException

Get a Journey View by ID and version

Parameters:

viewId - viewId (required)

versionId - versionId (required)

Returns:

JourneyView

Throws:

IOException - if the request fails to be processed

getJourneyViewVersion

public JourneyView getJourneyViewVersion(GetJourneyViewVersionRequest request)
                                  throws IOException,
ApiException

Get a Journey View by ID and version

Parameters:

request - The request object

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersion

public ApiResponse<JourneyView> getJourneyViewVersion(ApiRequest<Void> request)
                                               throws IOException

Get a Journey View by ID and version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionChart

public JourneyViewChart getJourneyViewVersionChart(String viewId,
 String journeyViewVersion,
 String chartId)
                                            throws IOException,
ApiException

Get a Chart by ID returns the latest version

Parameters:

viewId - viewId (required)

journeyViewVersion - Journey View Version (required)

chartId - chartId (required)

Returns:

JourneyViewChart

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionChartWithHttpInfo

public ApiResponse<JourneyViewChart> getJourneyViewVersionChartWithHttpInfo(String viewId,
 String journeyViewVersion,
 String chartId)
                                                                     throws IOException

Get a Chart by ID returns the latest version

Parameters:

viewId - viewId (required)

journeyViewVersion - Journey View Version (required)

chartId - chartId (required)

Returns:

JourneyViewChart

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionChart

public JourneyViewChart getJourneyViewVersionChart(GetJourneyViewVersionChartRequest request)
                                            throws IOException,
ApiException

Get a Chart by ID returns the latest version

Parameters:

request - The request object

Returns:

JourneyViewChart

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionChart

public ApiResponse<JourneyViewChart> getJourneyViewVersionChart(ApiRequest<Void> request)
                                                         throws IOException

Get a Chart by ID returns the latest version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionChartVersion

public JourneyViewChart getJourneyViewVersionChartVersion(String viewId,
 String journeyViewVersion,
 String chartId,
 String chartVersion)
                                                   throws IOException,
ApiException

Get a Chart by ID and version

Parameters:

viewId - viewId (required)

journeyViewVersion - Journey View Version (required)

chartId - chartId (required)

chartVersion - chartVersion (required)

Returns:

JourneyViewChart

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionChartVersionWithHttpInfo

public ApiResponse<JourneyViewChart> getJourneyViewVersionChartVersionWithHttpInfo(String viewId,
 String journeyViewVersion,
 String chartId,
 String chartVersion)
                                                                            throws IOException

Get a Chart by ID and version

Parameters:

viewId - viewId (required)

journeyViewVersion - Journey View Version (required)

chartId - chartId (required)

chartVersion - chartVersion (required)

Returns:

JourneyViewChart

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionChartVersion

public JourneyViewChart getJourneyViewVersionChartVersion(GetJourneyViewVersionChartVersionRequest request)
                                                   throws IOException,
ApiException

Get a Chart by ID and version

Parameters:

request - The request object

Returns:

JourneyViewChart

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionChartVersion

public ApiResponse<JourneyViewChart> getJourneyViewVersionChartVersion(ApiRequest<Void> request)
                                                                throws IOException

Get a Chart by ID and version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJob

public JourneyViewJob getJourneyViewVersionJob(String viewId,
 String journeyVersionId,
 String jobId)
                                        throws IOException,
ApiException

Get the job for a journey view version.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

jobId - JobId (required)

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJobWithHttpInfo

public ApiResponse<JourneyViewJob> getJourneyViewVersionJobWithHttpInfo(String viewId,
 String journeyVersionId,
 String jobId)
                                                                 throws IOException

Get the job for a journey view version.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

jobId - JobId (required)

Returns:

JourneyViewJob

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJob

public JourneyViewJob getJourneyViewVersionJob(GetJourneyViewVersionJobRequest request)
                                        throws IOException,
ApiException

Get the job for a journey view version.

Parameters:

request - The request object

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJob

public ApiResponse<JourneyViewJob> getJourneyViewVersionJob(ApiRequest<Void> request)
                                                     throws IOException

Get the job for a journey view version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJobResults

public JourneyViewResult getJourneyViewVersionJobResults(String viewId,
 String journeyViewVersion,
 String jobId)
                                                  throws IOException,
ApiException

Get the result of a job for a journey view version.

Parameters:

viewId - JourneyViewResult id (required)

journeyViewVersion - Journey View Version (required)

jobId - Id of the executing job (required)

Returns:

JourneyViewResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJobResultsWithHttpInfo

public ApiResponse<JourneyViewResult> getJourneyViewVersionJobResultsWithHttpInfo(String viewId,
 String journeyViewVersion,
 String jobId)
                                                                           throws IOException

Get the result of a job for a journey view version.

Parameters:

viewId - JourneyViewResult id (required)

journeyViewVersion - Journey View Version (required)

jobId - Id of the executing job (required)

Returns:

JourneyViewResult

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJobResults

public JourneyViewResult getJourneyViewVersionJobResults(GetJourneyViewVersionJobResultsRequest request)
                                                  throws IOException,
ApiException

Get the result of a job for a journey view version.

Parameters:

request - The request object

Returns:

JourneyViewResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJobResults

public ApiResponse<JourneyViewResult> getJourneyViewVersionJobResults(ApiRequest<Void> request)
                                                               throws IOException

Get the result of a job for a journey view version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJobResultsChart

public JourneyViewChartResult getJourneyViewVersionJobResultsChart(String viewId,
 String journeyVersionId,
 String jobId,
 String chartId)
                                                            throws IOException,
ApiException

Get the chart result associated with a journey view job.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

jobId - JobId (required)

chartId - ChartId (required)

Returns:

JourneyViewChartResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJobResultsChartWithHttpInfo

public ApiResponse<JourneyViewChartResult> getJourneyViewVersionJobResultsChartWithHttpInfo(String viewId,
 String journeyVersionId,
 String jobId,
 String chartId)
                                                                                     throws IOException

Get the chart result associated with a journey view job.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

jobId - JobId (required)

chartId - ChartId (required)

Returns:

JourneyViewChartResult

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJobResultsChart

public JourneyViewChartResult getJourneyViewVersionJobResultsChart(GetJourneyViewVersionJobResultsChartRequest request)
                                                            throws IOException,
ApiException

Get the chart result associated with a journey view job.

Parameters:

request - The request object

Returns:

JourneyViewChartResult

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJobResultsChart

public ApiResponse<JourneyViewChartResult> getJourneyViewVersionJobResultsChart(ApiRequest<Void> request)
                                                                         throws IOException

Get the chart result associated with a journey view job.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJobsLatest

public JourneyViewJob getJourneyViewVersionJobsLatest(String viewId,
 String journeyVersionId)
                                               throws IOException,
ApiException

Get the latest job of a journey view version.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJobsLatestWithHttpInfo

public ApiResponse<JourneyViewJob> getJourneyViewVersionJobsLatestWithHttpInfo(String viewId,
 String journeyVersionId)
                                                                        throws IOException

Get the latest job of a journey view version.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

Returns:

JourneyViewJob

Throws:

IOException - if the request fails to be processed

getJourneyViewVersionJobsLatest

public JourneyViewJob getJourneyViewVersionJobsLatest(GetJourneyViewVersionJobsLatestRequest request)
                                               throws IOException,
ApiException

Get the latest job of a journey view version.

Parameters:

request - The request object

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewVersionJobsLatest

public ApiResponse<JourneyViewJob> getJourneyViewVersionJobsLatest(ApiRequest<Void> request)
                                                            throws IOException

Get the latest job of a journey view version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViews

public JourneyViewListing getJourneyViews(Integer pageNumber,
 Integer pageSize,
 String nameOrCreatedBy,
 String expand,
 String id)
                                   throws IOException,
ApiException

Get a list of Journey Views

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

nameOrCreatedBy - Journey View Name or Created By (optional)

expand - Parameter to request additional data to return in Journey payload (optional)

id - Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items. (optional)

Returns:

JourneyViewListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsWithHttpInfo

public ApiResponse<JourneyViewListing> getJourneyViewsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String nameOrCreatedBy,
 String expand,
 String id)
                                                            throws IOException

Get a list of Journey Views

Parameters:

pageNumber - Page number (optional, default to 1)

pageSize - Page size (optional, default to 25)

nameOrCreatedBy - Journey View Name or Created By (optional)

expand - Parameter to request additional data to return in Journey payload (optional)

id - Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items. (optional)

Returns:

JourneyViewListing

Throws:

IOException - if the request fails to be processed

getJourneyViews

public JourneyViewListing getJourneyViews(GetJourneyViewsRequest request)
                                   throws IOException,
ApiException

Get a list of Journey Views

Parameters:

request - The request object

Returns:

JourneyViewListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViews

public ApiResponse<JourneyViewListing> getJourneyViews(ApiRequest<Void> request)
                                                throws IOException

Get a list of Journey Views

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsDataDetails

public DataRange getJourneyViewsDataDetails()
                                     throws IOException,
ApiException

Get details about the data available for journey queries including oldest and newest event dates

Returns:

DataRange

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsDataDetailsWithHttpInfo

public ApiResponse<DataRange> getJourneyViewsDataDetailsWithHttpInfo()
                                                              throws IOException

Get details about the data available for journey queries including oldest and newest event dates

Returns:

DataRange

Throws:

IOException - if the request fails to be processed

getJourneyViewsDataDetails

public DataRange getJourneyViewsDataDetails(GetJourneyViewsDataDetailsRequest request)
                                     throws IOException,
ApiException

Get details about the data available for journey queries including oldest and newest event dates

Parameters:

request - The request object

Returns:

DataRange

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsDataDetails

public ApiResponse<DataRange> getJourneyViewsDataDetails(ApiRequest<Void> request)
                                                  throws IOException

Get details about the data available for journey queries including oldest and newest event dates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinition

public JourneyEventDefinition getJourneyViewsEventdefinition(String eventDefinitionId)
                                                      throws IOException,
ApiException

Get an Event Definition

Parameters:

eventDefinitionId - Event Definition ID (required)

Returns:

JourneyEventDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionWithHttpInfo

public ApiResponse<JourneyEventDefinition> getJourneyViewsEventdefinitionWithHttpInfo(String eventDefinitionId)
                                                                               throws IOException

Get an Event Definition

Parameters:

eventDefinitionId - Event Definition ID (required)

Returns:

JourneyEventDefinition

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinition

public JourneyEventDefinition getJourneyViewsEventdefinition(GetJourneyViewsEventdefinitionRequest request)
                                                      throws IOException,
ApiException

Get an Event Definition

Parameters:

request - The request object

Returns:

JourneyEventDefinition

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinition

public ApiResponse<JourneyEventDefinition> getJourneyViewsEventdefinition(ApiRequest<Void> request)
                                                                   throws IOException

Get an Event Definition

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinitions

public JourneyEventDefinitionListing getJourneyViewsEventdefinitions()
                                                              throws IOException,
ApiException

Get a list of Event Definitions

Returns:

JourneyEventDefinitionListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsWithHttpInfo

public ApiResponse<JourneyEventDefinitionListing> getJourneyViewsEventdefinitionsWithHttpInfo()
                                                                                       throws IOException

Get a list of Event Definitions

Returns:

JourneyEventDefinitionListing

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinitions

public JourneyEventDefinitionListing getJourneyViewsEventdefinitions(GetJourneyViewsEventdefinitionsRequest request)
                                                              throws IOException,
ApiException

Get a list of Event Definitions

Parameters:

request - The request object

Returns:

JourneyEventDefinitionListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinitions

public ApiResponse<JourneyEventDefinitionListing> getJourneyViewsEventdefinitions(ApiRequest<Void> request)
                                                                           throws IOException

Get a list of Event Definitions

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternal

public GetExternalEventsResponse getJourneyViewsEventdefinitionsExternal()
                                                                  throws IOException,
ApiException

Get external events for journey views

Returns:

GetExternalEventsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternalWithHttpInfo

public ApiResponse<GetExternalEventsResponse> getJourneyViewsEventdefinitionsExternalWithHttpInfo()
                                                                                           throws IOException

Get external events for journey views

Returns:

GetExternalEventsResponse

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternal

public GetExternalEventsResponse getJourneyViewsEventdefinitionsExternal(GetJourneyViewsEventdefinitionsExternalRequest request)
                                                                  throws IOException,
ApiException

Get external events for journey views

Parameters:

request - The request object

Returns:

GetExternalEventsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternal

public ApiResponse<GetExternalEventsResponse> getJourneyViewsEventdefinitionsExternal(ApiRequest<Void> request)
                                                                               throws IOException

Get external events for journey views

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternalChanges

public ExternalEventChangesResponse getJourneyViewsEventdefinitionsExternalChanges()
                                                                            throws IOException,
ApiException

Get changes in external event definitions

Returns:

ExternalEventChangesResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternalChangesWithHttpInfo

public ApiResponse<ExternalEventChangesResponse> getJourneyViewsEventdefinitionsExternalChangesWithHttpInfo()
                                                                                                     throws IOException

Get changes in external event definitions

Returns:

ExternalEventChangesResponse

Throws:

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternalChanges

public ExternalEventChangesResponse getJourneyViewsEventdefinitionsExternalChanges(GetJourneyViewsEventdefinitionsExternalChangesRequest request)
                                                                            throws IOException,
ApiException

Get changes in external event definitions

Parameters:

request - The request object

Returns:

ExternalEventChangesResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsEventdefinitionsExternalChanges

public ApiResponse<ExternalEventChangesResponse> getJourneyViewsEventdefinitionsExternalChanges(ApiRequest<Void> request)
                                                                                         throws IOException

Get changes in external event definitions

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsJobs

public JourneyViewJobListing getJourneyViewsJobs(Integer pageNumber,
 Integer pageSize,
 String interval,
 String statuses)
                                          throws IOException,
ApiException

Get the jobs for an organization.

Parameters:

pageNumber - The number of the page to return (optional, default to 1)

pageSize - Max number of entities to return (optional, default to 25)

interval - An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. (optional, default to null)

statuses - Job statuses to filter for (optional, default to null)

Returns:

JourneyViewJobListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsJobsWithHttpInfo

public ApiResponse<JourneyViewJobListing> getJourneyViewsJobsWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String interval,
 String statuses)
                                                                   throws IOException

Get the jobs for an organization.

Parameters:

pageNumber - The number of the page to return (optional, default to 1)

pageSize - Max number of entities to return (optional, default to 25)

interval - An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. (optional, default to null)

statuses - Job statuses to filter for (optional, default to null)

Returns:

JourneyViewJobListing

Throws:

IOException - if the request fails to be processed

getJourneyViewsJobs

public JourneyViewJobListing getJourneyViewsJobs(GetJourneyViewsJobsRequest request)
                                          throws IOException,
ApiException

Get the jobs for an organization.

Parameters:

request - The request object

Returns:

JourneyViewJobListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsJobs

public ApiResponse<JourneyViewJobListing> getJourneyViewsJobs(ApiRequest<Void> request)
                                                       throws IOException

Get the jobs for an organization.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsJobsMe

public JourneyViewJobListing getJourneyViewsJobsMe(Integer pageNumber,
 Integer pageSize,
 String interval,
 String statuses)
                                            throws IOException,
ApiException

Get my jobs

Parameters:

pageNumber - The number of the page to return (optional, default to 1)

pageSize - Max number of entities to return (optional, default to 25)

interval - An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. (optional, default to null)

statuses - Job statuses to filter for (optional, default to null)

Returns:

JourneyViewJobListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsJobsMeWithHttpInfo

public ApiResponse<JourneyViewJobListing> getJourneyViewsJobsMeWithHttpInfo(Integer pageNumber,
 Integer pageSize,
 String interval,
 String statuses)
                                                                     throws IOException

Get my jobs

Parameters:

pageNumber - The number of the page to return (optional, default to 1)

pageSize - Max number of entities to return (optional, default to 25)

interval - An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. (optional, default to null)

statuses - Job statuses to filter for (optional, default to null)

Returns:

JourneyViewJobListing

Throws:

IOException - if the request fails to be processed

getJourneyViewsJobsMe

public JourneyViewJobListing getJourneyViewsJobsMe(GetJourneyViewsJobsMeRequest request)
                                            throws IOException,
ApiException

Get my jobs

Parameters:

request - The request object

Returns:

JourneyViewJobListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsJobsMe

public ApiResponse<JourneyViewJobListing> getJourneyViewsJobsMe(ApiRequest<Void> request)
                                                         throws IOException

Get my jobs

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

getJourneyViewsSchedules

public JourneyViewScheduleListing getJourneyViewsSchedules(Integer pageNumber,
 Integer pageSize)
                                                    throws IOException,
ApiException

Get the journey schedules for an organization.

Parameters:

pageNumber - The number of the page to return (optional, default to 1)

pageSize - Max number of entities to return (optional, default to 25)

Returns:

JourneyViewScheduleListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsSchedulesWithHttpInfo

public ApiResponse<JourneyViewScheduleListing> getJourneyViewsSchedulesWithHttpInfo(Integer pageNumber,
 Integer pageSize)
                                                                             throws IOException

Get the journey schedules for an organization.

Parameters:

pageNumber - The number of the page to return (optional, default to 1)

pageSize - Max number of entities to return (optional, default to 25)

Returns:

JourneyViewScheduleListing

Throws:

IOException - if the request fails to be processed

getJourneyViewsSchedules

public JourneyViewScheduleListing getJourneyViewsSchedules(GetJourneyViewsSchedulesRequest request)
                                                    throws IOException,
ApiException

Get the journey schedules for an organization.

Parameters:

request - The request object

Returns:

JourneyViewScheduleListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

getJourneyViewsSchedules

public ApiResponse<JourneyViewScheduleListing> getJourneyViewsSchedules(ApiRequest<Void> request)
                                                                 throws IOException

Get the journey schedules for an organization.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchJourneyActionmap

public ActionMap patchJourneyActionmap(String actionMapId,
 PatchActionMap body)
                                throws IOException,
ApiException

Update single action map.

Parameters:

actionMapId - ID of the action map. (required)

body - (optional)

Returns:

ActionMap

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyActionmapWithHttpInfo

public ApiResponse<ActionMap> patchJourneyActionmapWithHttpInfo(String actionMapId,
 PatchActionMap body)
                                                         throws IOException

Update single action map.

Parameters:

actionMapId - ID of the action map. (required)

body - (optional)

Returns:

ActionMap

Throws:

IOException - if the request fails to be processed

patchJourneyActionmap

public ActionMap patchJourneyActionmap(PatchJourneyActionmapRequest request)
                                throws IOException,
ApiException

Update single action map.

Parameters:

request - The request object

Returns:

ActionMap

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyActionmap

public ApiResponse<ActionMap> patchJourneyActionmap(ApiRequest<PatchActionMap> request)
                                             throws IOException

Update single action map.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchJourneyActiontarget

public ActionTarget patchJourneyActiontarget(String actionTargetId,
 PatchActionTarget body)
                                      throws IOException,
ApiException

Deprecated.

Deprecated. Update a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

actionTargetId - ID of the action target. (required)

body - (optional)

Returns:

ActionTarget

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyActiontargetWithHttpInfo

public ApiResponse<ActionTarget> patchJourneyActiontargetWithHttpInfo(String actionTargetId,
 PatchActionTarget body)
                                                               throws IOException

Deprecated.

Deprecated. Update a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

actionTargetId - ID of the action target. (required)

body - (optional)

Returns:

ActionTarget

Throws:

IOException - if the request fails to be processed

patchJourneyActiontarget

public ActionTarget patchJourneyActiontarget(PatchJourneyActiontargetRequest request)
                                      throws IOException,
ApiException

Deprecated.

Deprecated. Update a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

request - The request object

Returns:

ActionTarget

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyActiontarget

public ApiResponse<ActionTarget> patchJourneyActiontarget(ApiRequest<PatchActionTarget> request)
                                                   throws IOException

Deprecated.

Deprecated. Update a single action target. ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchJourneyActiontemplate

public ActionTemplate patchJourneyActiontemplate(String actionTemplateId,
 PatchActionTemplate body)
                                          throws IOException,
ApiException

Update a single action template.

Parameters:

actionTemplateId - ID of the action template. (required)

body - (optional)

Returns:

ActionTemplate

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyActiontemplateWithHttpInfo

public ApiResponse<ActionTemplate> patchJourneyActiontemplateWithHttpInfo(String actionTemplateId,
 PatchActionTemplate body)
                                                                   throws IOException

Update a single action template.

Parameters:

actionTemplateId - ID of the action template. (required)

body - (optional)

Returns:

ActionTemplate

Throws:

IOException - if the request fails to be processed

patchJourneyActiontemplate

public ActionTemplate patchJourneyActiontemplate(PatchJourneyActiontemplateRequest request)
                                          throws IOException,
ApiException

Update a single action template.

Parameters:

request - The request object

Returns:

ActionTemplate

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyActiontemplate

public ApiResponse<ActionTemplate> patchJourneyActiontemplate(ApiRequest<PatchActionTemplate> request)
                                                       throws IOException

Update a single action template.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchJourneyExternaleventsConfiguration

public ExternalEventsConfiguration patchJourneyExternaleventsConfiguration(String configId,
 UpdateExternalEventsConfigurationRequest body)
                                                                    throws IOException,
ApiException

Update an external events configuration.

Parameters:

configId - The ID of the external event configuration. (required)

body - (optional)

Returns:

ExternalEventsConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyExternaleventsConfigurationWithHttpInfo

public ApiResponse<ExternalEventsConfiguration> patchJourneyExternaleventsConfigurationWithHttpInfo(String configId,
 UpdateExternalEventsConfigurationRequest body)
                                                                                             throws IOException

Update an external events configuration.

Parameters:

configId - The ID of the external event configuration. (required)

body - (optional)

Returns:

ExternalEventsConfiguration

Throws:

IOException - if the request fails to be processed

patchJourneyExternaleventsConfiguration

public ExternalEventsConfiguration patchJourneyExternaleventsConfiguration(PatchJourneyExternaleventsConfigurationRequest request)
                                                                    throws IOException,
ApiException

Update an external events configuration.

Parameters:

request - The request object

Returns:

ExternalEventsConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyExternaleventsConfiguration

public ApiResponse<ExternalEventsConfiguration> patchJourneyExternaleventsConfiguration(ApiRequest<UpdateExternalEventsConfigurationRequest> request)
                                                                                 throws IOException

Update an external events configuration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchJourneyOutcome

public Outcome patchJourneyOutcome(String outcomeId,
 PatchOutcome body)
                            throws IOException,
ApiException

Deprecated.

Deprecated. Update an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

outcomeId - ID of the outcome. (required)

body - (optional)

Returns:

Outcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyOutcomeWithHttpInfo

public ApiResponse<Outcome> patchJourneyOutcomeWithHttpInfo(String outcomeId,
 PatchOutcome body)
                                                     throws IOException

Deprecated.

Deprecated. Update an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

outcomeId - ID of the outcome. (required)

body - (optional)

Returns:

Outcome

Throws:

IOException - if the request fails to be processed

patchJourneyOutcome

public Outcome patchJourneyOutcome(PatchJourneyOutcomeRequest request)
                            throws IOException,
ApiException

Deprecated.

Deprecated. Update an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

Outcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyOutcome

public ApiResponse<Outcome> patchJourneyOutcome(ApiRequest<PatchOutcome> request)
                                         throws IOException

Deprecated.

Deprecated. Update an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchJourneySegment

public JourneySegment patchJourneySegment(String segmentId,
 PatchSegment body)
                                   throws IOException,
ApiException

Update a segment.

Parameters:

segmentId - ID of the segment. (required)

body - (optional)

Returns:

JourneySegment

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneySegmentWithHttpInfo

public ApiResponse<JourneySegment> patchJourneySegmentWithHttpInfo(String segmentId,
 PatchSegment body)
                                                            throws IOException

Update a segment.

Parameters:

segmentId - ID of the segment. (required)

body - (optional)

Returns:

JourneySegment

Throws:

IOException - if the request fails to be processed

patchJourneySegment

public JourneySegment patchJourneySegment(PatchJourneySegmentRequest request)
                                   throws IOException,
ApiException

Update a segment.

Parameters:

request - The request object

Returns:

JourneySegment

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneySegment

public ApiResponse<JourneySegment> patchJourneySegment(ApiRequest<PatchSegment> request)
                                                throws IOException

Update a segment.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

patchJourneyViewVersionJob

public JourneyViewJob patchJourneyViewVersionJob(String viewId,
 String journeyVersionId,
 String jobId,
 JourneyViewJob body)
                                          throws IOException,
ApiException

Update the job for a journey view version. Only the status can be changed and only to Cancelled

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

jobId - JobId (required)

body - journeyViewJob (required)

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyViewVersionJobWithHttpInfo

public ApiResponse<JourneyViewJob> patchJourneyViewVersionJobWithHttpInfo(String viewId,
 String journeyVersionId,
 String jobId,
 JourneyViewJob body)
                                                                   throws IOException

Update the job for a journey view version. Only the status can be changed and only to Cancelled

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

jobId - JobId (required)

body - journeyViewJob (required)

Returns:

JourneyViewJob

Throws:

IOException - if the request fails to be processed

patchJourneyViewVersionJob

public JourneyViewJob patchJourneyViewVersionJob(PatchJourneyViewVersionJobRequest request)
                                          throws IOException,
ApiException

Update the job for a journey view version. Only the status can be changed and only to Cancelled

Parameters:

request - The request object

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

patchJourneyViewVersionJob

public ApiResponse<JourneyViewJob> patchJourneyViewVersionJob(ApiRequest<JourneyViewJob> request)
                                                       throws IOException

Update the job for a journey view version. Only the status can be changed and only to Cancelled

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesJobs

public AsyncQueryResponse postAnalyticsJourneysAggregatesJobs(JourneyAsyncAggregationQuery body)
                                                       throws IOException,
ApiException

Query for journey aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesJobsWithHttpInfo

public ApiResponse<AsyncQueryResponse> postAnalyticsJourneysAggregatesJobsWithHttpInfo(JourneyAsyncAggregationQuery body)
                                                                                throws IOException

Query for journey aggregates asynchronously

Parameters:

body - query (required)

Returns:

AsyncQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesJobs

public AsyncQueryResponse postAnalyticsJourneysAggregatesJobs(PostAnalyticsJourneysAggregatesJobsRequest request)
                                                       throws IOException,
ApiException

Query for journey aggregates asynchronously

Parameters:

request - The request object

Returns:

AsyncQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesJobs

public ApiResponse<AsyncQueryResponse> postAnalyticsJourneysAggregatesJobs(ApiRequest<JourneyAsyncAggregationQuery> request)
                                                                    throws IOException

Query for journey aggregates asynchronously

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesQuery

public JourneyAggregateQueryResponse postAnalyticsJourneysAggregatesQuery(JourneyAggregationQuery body)
                                                                   throws IOException,
ApiException

Query for journey aggregates

Parameters:

body - query (required)

Returns:

JourneyAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesQueryWithHttpInfo

public ApiResponse<JourneyAggregateQueryResponse> postAnalyticsJourneysAggregatesQueryWithHttpInfo(JourneyAggregationQuery body)
                                                                                            throws IOException

Query for journey aggregates

Parameters:

body - query (required)

Returns:

JourneyAggregateQueryResponse

Throws:

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesQuery

public JourneyAggregateQueryResponse postAnalyticsJourneysAggregatesQuery(PostAnalyticsJourneysAggregatesQueryRequest request)
                                                                   throws IOException,
ApiException

Query for journey aggregates

Parameters:

request - The request object

Returns:

JourneyAggregateQueryResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postAnalyticsJourneysAggregatesQuery

public ApiResponse<JourneyAggregateQueryResponse> postAnalyticsJourneysAggregatesQuery(ApiRequest<JourneyAggregationQuery> request)
                                                                                throws IOException

Query for journey aggregates

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postExternalcontactsContactJourneySegments

public UpdateSegmentAssignmentResponse postExternalcontactsContactJourneySegments(String contactId,
 UpdateSegmentAssignmentRequest body)
                                                                           throws IOException,
ApiException

Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.

Parameters:

contactId - ExternalContact ID (required)

body - (optional)

Returns:

UpdateSegmentAssignmentResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postExternalcontactsContactJourneySegmentsWithHttpInfo

public ApiResponse<UpdateSegmentAssignmentResponse> postExternalcontactsContactJourneySegmentsWithHttpInfo(String contactId,
 UpdateSegmentAssignmentRequest body)
                                                                                                    throws IOException

Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.

Parameters:

contactId - ExternalContact ID (required)

body - (optional)

Returns:

UpdateSegmentAssignmentResponse

Throws:

IOException - if the request fails to be processed

postExternalcontactsContactJourneySegments

public UpdateSegmentAssignmentResponse postExternalcontactsContactJourneySegments(PostExternalcontactsContactJourneySegmentsRequest request)
                                                                           throws IOException,
ApiException

Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.

Parameters:

request - The request object

Returns:

UpdateSegmentAssignmentResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postExternalcontactsContactJourneySegments

public ApiResponse<UpdateSegmentAssignmentResponse> postExternalcontactsContactJourneySegments(ApiRequest<UpdateSegmentAssignmentRequest> request)
                                                                                        throws IOException

Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyActionmaps

public ActionMap postJourneyActionmaps(ActionMap body)
                                throws IOException,
ApiException

Create an action map.

Parameters:

body - (optional)

Returns:

ActionMap

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyActionmapsWithHttpInfo

public ApiResponse<ActionMap> postJourneyActionmapsWithHttpInfo(ActionMap body)
                                                         throws IOException

Create an action map.

Parameters:

body - (optional)

Returns:

ActionMap

Throws:

IOException - if the request fails to be processed

postJourneyActionmaps

public ActionMap postJourneyActionmaps(PostJourneyActionmapsRequest request)
                                throws IOException,
ApiException

Create an action map.

Parameters:

request - The request object

Returns:

ActionMap

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyActionmaps

public ApiResponse<ActionMap> postJourneyActionmaps(ApiRequest<ActionMap> request)
                                             throws IOException

Create an action map.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyActionmapsEstimatesJobs

public EstimateJobAsyncResponse postJourneyActionmapsEstimatesJobs(ActionMapEstimateRequest body)
                                                            throws IOException,
ApiException

Deprecated.

Deprecated. Query for estimates Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

body - audience estimator request (required)

Returns:

EstimateJobAsyncResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyActionmapsEstimatesJobsWithHttpInfo

public ApiResponse<EstimateJobAsyncResponse> postJourneyActionmapsEstimatesJobsWithHttpInfo(ActionMapEstimateRequest body)
                                                                                     throws IOException

Deprecated.

Deprecated. Query for estimates Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

body - audience estimator request (required)

Returns:

EstimateJobAsyncResponse

Throws:

IOException - if the request fails to be processed

postJourneyActionmapsEstimatesJobs

public EstimateJobAsyncResponse postJourneyActionmapsEstimatesJobs(PostJourneyActionmapsEstimatesJobsRequest request)
                                                            throws IOException,
ApiException

Deprecated.

Deprecated. Query for estimates Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

EstimateJobAsyncResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyActionmapsEstimatesJobs

public ApiResponse<EstimateJobAsyncResponse> postJourneyActionmapsEstimatesJobs(ApiRequest<ActionMapEstimateRequest> request)
                                                                         throws IOException

Deprecated.

Deprecated. Query for estimates Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyActiontemplates

public ActionTemplate postJourneyActiontemplates(ActionTemplate body)
                                          throws IOException,
ApiException

Create a single action template.

Parameters:

body - (optional)

Returns:

ActionTemplate

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyActiontemplatesWithHttpInfo

public ApiResponse<ActionTemplate> postJourneyActiontemplatesWithHttpInfo(ActionTemplate body)
                                                                   throws IOException

Create a single action template.

Parameters:

body - (optional)

Returns:

ActionTemplate

Throws:

IOException - if the request fails to be processed

postJourneyActiontemplates

public ActionTemplate postJourneyActiontemplates(PostJourneyActiontemplatesRequest request)
                                          throws IOException,
ApiException

Create a single action template.

Parameters:

request - The request object

Returns:

ActionTemplate

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyActiontemplates

public ApiResponse<ActionTemplate> postJourneyActiontemplates(ApiRequest<ActionTemplate> request)
                                                       throws IOException

Create a single action template.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyDeploymentActionevent

public void postJourneyDeploymentActionevent(String deploymentId,
 ActionEventRequest body)
                                      throws IOException,
ApiException

Sends an action event, which is used for changing the state of actions that have been offered to the user.

Parameters:

deploymentId - The ID of the deployment sending the beacon. (required)

body - (required)

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyDeploymentActioneventWithHttpInfo

public ApiResponse<Void> postJourneyDeploymentActioneventWithHttpInfo(String deploymentId,
 ActionEventRequest body)
                                                               throws IOException

Sends an action event, which is used for changing the state of actions that have been offered to the user.

Parameters:

deploymentId - The ID of the deployment sending the beacon. (required)

body - (required)

Throws:

IOException - if the request fails to be processed

postJourneyDeploymentActionevent

public void postJourneyDeploymentActionevent(PostJourneyDeploymentActioneventRequest request)
                                      throws IOException,
ApiException

Sends an action event, which is used for changing the state of actions that have been offered to the user.

Parameters:

request - The request object

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyDeploymentActionevent

public ApiResponse<Void> postJourneyDeploymentActionevent(ApiRequest<ActionEventRequest> request)
                                                   throws IOException

Sends an action event, which is used for changing the state of actions that have been offered to the user.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyDeploymentAppevents

public AppEventResponse postJourneyDeploymentAppevents(String deploymentId,
 AppEventRequest body)
                                                throws IOException,
ApiException

Send a journey app event, used for tracking customer activity on an application.

Parameters:

deploymentId - The ID of the deployment sending the app event. (required)

body - (optional)

Returns:

AppEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyDeploymentAppeventsWithHttpInfo

public ApiResponse<AppEventResponse> postJourneyDeploymentAppeventsWithHttpInfo(String deploymentId,
 AppEventRequest body)
                                                                         throws IOException

Send a journey app event, used for tracking customer activity on an application.

Parameters:

deploymentId - The ID of the deployment sending the app event. (required)

body - (optional)

Returns:

AppEventResponse

Throws:

IOException - if the request fails to be processed

postJourneyDeploymentAppevents

public AppEventResponse postJourneyDeploymentAppevents(PostJourneyDeploymentAppeventsRequest request)
                                                throws IOException,
ApiException

Send a journey app event, used for tracking customer activity on an application.

Parameters:

request - The request object

Returns:

AppEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyDeploymentAppevents

public ApiResponse<AppEventResponse> postJourneyDeploymentAppevents(ApiRequest<AppEventRequest> request)
                                                             throws IOException

Send a journey app event, used for tracking customer activity on an application.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyDeploymentWebevents

public WebEventResponse postJourneyDeploymentWebevents(String deploymentId,
 WebEventRequest body)
                                                throws IOException,
ApiException

Send a journey web event, used for tracking customer activity on a website.

Parameters:

deploymentId - The ID of the deployment sending the web event. (required)

body - (optional)

Returns:

WebEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyDeploymentWebeventsWithHttpInfo

public ApiResponse<WebEventResponse> postJourneyDeploymentWebeventsWithHttpInfo(String deploymentId,
 WebEventRequest body)
                                                                         throws IOException

Send a journey web event, used for tracking customer activity on a website.

Parameters:

deploymentId - The ID of the deployment sending the web event. (required)

body - (optional)

Returns:

WebEventResponse

Throws:

IOException - if the request fails to be processed

postJourneyDeploymentWebevents

public WebEventResponse postJourneyDeploymentWebevents(PostJourneyDeploymentWebeventsRequest request)
                                                throws IOException,
ApiException

Send a journey web event, used for tracking customer activity on a website.

Parameters:

request - The request object

Returns:

WebEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyDeploymentWebevents

public ApiResponse<WebEventResponse> postJourneyDeploymentWebevents(ApiRequest<WebEventRequest> request)
                                                             throws IOException

Send a journey web event, used for tracking customer activity on a website.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurationEvents

public ExternalEventsResponse postJourneyExternaleventsConfigurationEvents(String configurationId,
 ExternalEventsRequest body)
                                                                    throws IOException,
ApiException

Create external events

Parameters:

configurationId - The ID of the external event configuration. (required)

body - (optional)

Returns:

ExternalEventsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurationEventsWithHttpInfo

public ApiResponse<ExternalEventsResponse> postJourneyExternaleventsConfigurationEventsWithHttpInfo(String configurationId,
 ExternalEventsRequest body)
                                                                                             throws IOException

Create external events

Parameters:

configurationId - The ID of the external event configuration. (required)

body - (optional)

Returns:

ExternalEventsResponse

Throws:

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurationEvents

public ExternalEventsResponse postJourneyExternaleventsConfigurationEvents(PostJourneyExternaleventsConfigurationEventsRequest request)
                                                                    throws IOException,
ApiException

Create external events

Parameters:

request - The request object

Returns:

ExternalEventsResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurationEvents

public ApiResponse<ExternalEventsResponse> postJourneyExternaleventsConfigurationEvents(ApiRequest<ExternalEventsRequest> request)
                                                                                 throws IOException

Create external events

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurations

public ExternalEventsConfiguration postJourneyExternaleventsConfigurations(CreateExternalEventsConfigurationRequest body)
                                                                    throws IOException,
ApiException

Create an external events configuration.

Parameters:

body - (optional)

Returns:

ExternalEventsConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurationsWithHttpInfo

public ApiResponse<ExternalEventsConfiguration> postJourneyExternaleventsConfigurationsWithHttpInfo(CreateExternalEventsConfigurationRequest body)
                                                                                             throws IOException

Create an external events configuration.

Parameters:

body - (optional)

Returns:

ExternalEventsConfiguration

Throws:

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurations

public ExternalEventsConfiguration postJourneyExternaleventsConfigurations(PostJourneyExternaleventsConfigurationsRequest request)
                                                                    throws IOException,
ApiException

Create an external events configuration.

Parameters:

request - The request object

Returns:

ExternalEventsConfiguration

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyExternaleventsConfigurations

public ApiResponse<ExternalEventsConfiguration> postJourneyExternaleventsConfigurations(ApiRequest<CreateExternalEventsConfigurationRequest> request)
                                                                                 throws IOException

Create an external events configuration.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyExternaleventsSchemas

public JourneyExternalEventsSchema postJourneyExternaleventsSchemas(JourneyJsonSchemaRequest body)
                                                             throws IOException,
ApiException

Create a schema

Parameters:

body - Schema create request body (required)

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyExternaleventsSchemasWithHttpInfo

public ApiResponse<JourneyExternalEventsSchema> postJourneyExternaleventsSchemasWithHttpInfo(JourneyJsonSchemaRequest body)
                                                                                      throws IOException

Create a schema

Parameters:

body - Schema create request body (required)

Returns:

JourneyExternalEventsSchema

Throws:

IOException - if the request fails to be processed

postJourneyExternaleventsSchemas

public JourneyExternalEventsSchema postJourneyExternaleventsSchemas(PostJourneyExternaleventsSchemasRequest request)
                                                             throws IOException,
ApiException

Create a schema

Parameters:

request - The request object

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyExternaleventsSchemas

public ApiResponse<JourneyExternalEventsSchema> postJourneyExternaleventsSchemas(ApiRequest<JourneyJsonSchemaRequest> request)
                                                                          throws IOException

Create a schema

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyFlowsPathsQuery

public FlowPaths postJourneyFlowsPathsQuery(FlowPathsQuery body)
                                     throws IOException,
ApiException

Query for flow paths.

Parameters:

body - (optional)

Returns:

FlowPaths

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyFlowsPathsQueryWithHttpInfo

public ApiResponse<FlowPaths> postJourneyFlowsPathsQueryWithHttpInfo(FlowPathsQuery body)
                                                              throws IOException

Query for flow paths.

Parameters:

body - (optional)

Returns:

FlowPaths

Throws:

IOException - if the request fails to be processed

postJourneyFlowsPathsQuery

public FlowPaths postJourneyFlowsPathsQuery(PostJourneyFlowsPathsQueryRequest request)
                                     throws IOException,
ApiException

Query for flow paths.

Parameters:

request - The request object

Returns:

FlowPaths

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyFlowsPathsQuery

public ApiResponse<FlowPaths> postJourneyFlowsPathsQuery(ApiRequest<FlowPathsQuery> request)
                                                  throws IOException

Query for flow paths.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyOutcomes

public Outcome postJourneyOutcomes(OutcomeRequest body)
                            throws IOException,
ApiException

Deprecated.

Deprecated. Create an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

body - (optional)

Returns:

Outcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyOutcomesWithHttpInfo

public ApiResponse<Outcome> postJourneyOutcomesWithHttpInfo(OutcomeRequest body)
                                                     throws IOException

Deprecated.

Deprecated. Create an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

body - (optional)

Returns:

Outcome

Throws:

IOException - if the request fails to be processed

postJourneyOutcomes

public Outcome postJourneyOutcomes(PostJourneyOutcomesRequest request)
                            throws IOException,
ApiException

Deprecated.

Deprecated. Create an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

Outcome

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyOutcomes

public ApiResponse<Outcome> postJourneyOutcomes(ApiRequest<OutcomeRequest> request)
                                         throws IOException

Deprecated.

Deprecated. Create an outcome. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyOutcomesAttributionsJobs

public OutcomeAttributionAsyncResponse postJourneyOutcomesAttributionsJobs(OutcomeAttributionListing body)
                                                                    throws IOException,
ApiException

Deprecated.

Deprecated. Create Outcome Attributions Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

body - outcome attribution request (optional)

Returns:

OutcomeAttributionAsyncResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyOutcomesAttributionsJobsWithHttpInfo

public ApiResponse<OutcomeAttributionAsyncResponse> postJourneyOutcomesAttributionsJobsWithHttpInfo(OutcomeAttributionListing body)
                                                                                             throws IOException

Deprecated.

Deprecated. Create Outcome Attributions Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice

Parameters:

body - outcome attribution request (optional)

Returns:

OutcomeAttributionAsyncResponse

Throws:

IOException - if the request fails to be processed

postJourneyOutcomesAttributionsJobs

public OutcomeAttributionAsyncResponse postJourneyOutcomesAttributionsJobs(PostJourneyOutcomesAttributionsJobsRequest request)
                                                                    throws IOException,
ApiException

Deprecated.

Deprecated. Create Outcome Attributions Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ postJourneyOutcomesAttributionsJobs 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:

OutcomeAttributionAsyncResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyOutcomesAttributionsJobs

public ApiResponse<OutcomeAttributionAsyncResponse> postJourneyOutcomesAttributionsJobs(ApiRequest<OutcomeAttributionListing> request)
                                                                                 throws IOException

Deprecated.

Deprecated. Create Outcome Attributions Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/ postJourneyOutcomesAttributionsJobs 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

postJourneyOutcomesPredictors

public OutcomePredictor postJourneyOutcomesPredictors(OutcomePredictorRequest body)
                                               throws IOException,
ApiException

Deprecated.

Deprecated. Create an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

body - (optional)

Returns:

OutcomePredictor

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyOutcomesPredictorsWithHttpInfo

public ApiResponse<OutcomePredictor> postJourneyOutcomesPredictorsWithHttpInfo(OutcomePredictorRequest body)
                                                                        throws IOException

Deprecated.

Deprecated. Create an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

body - (optional)

Returns:

OutcomePredictor

Throws:

IOException - if the request fails to be processed

postJourneyOutcomesPredictors

public OutcomePredictor postJourneyOutcomesPredictors(PostJourneyOutcomesPredictorsRequest request)
                                               throws IOException,
ApiException

Deprecated.

Deprecated. Create an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

OutcomePredictor

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyOutcomesPredictors

public ApiResponse<OutcomePredictor> postJourneyOutcomesPredictors(ApiRequest<OutcomePredictorRequest> request)
                                                            throws IOException

Deprecated.

Deprecated. Create an outcome predictor. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneySegments

public JourneySegment postJourneySegments(JourneySegmentRequest body)
                                   throws IOException,
ApiException

Create a segment.

Parameters:

body - (optional)

Returns:

JourneySegment

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneySegmentsWithHttpInfo

public ApiResponse<JourneySegment> postJourneySegmentsWithHttpInfo(JourneySegmentRequest body)
                                                            throws IOException

Create a segment.

Parameters:

body - (optional)

Returns:

JourneySegment

Throws:

IOException - if the request fails to be processed

postJourneySegments

public JourneySegment postJourneySegments(PostJourneySegmentsRequest request)
                                   throws IOException,
ApiException

Create a segment.

Parameters:

request - The request object

Returns:

JourneySegment

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneySegments

public ApiResponse<JourneySegment> postJourneySegments(ApiRequest<JourneySegmentRequest> request)
                                                throws IOException

Create a segment.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyViewSchedules

public JourneyViewSchedule postJourneyViewSchedules(String viewId,
 JourneyViewSchedule body)
                                             throws IOException,
ApiException

Add a new Schedule to a JourneyView

Parameters:

viewId - Journey View Id (required)

body - journeyViewSchedule (required)

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewSchedulesWithHttpInfo

public ApiResponse<JourneyViewSchedule> postJourneyViewSchedulesWithHttpInfo(String viewId,
 JourneyViewSchedule body)
                                                                      throws IOException

Add a new Schedule to a JourneyView

Parameters:

viewId - Journey View Id (required)

body - journeyViewSchedule (required)

Returns:

JourneyViewSchedule

Throws:

IOException - if the request fails to be processed

postJourneyViewSchedules

public JourneyViewSchedule postJourneyViewSchedules(PostJourneyViewSchedulesRequest request)
                                             throws IOException,
ApiException

Add a new Schedule to a JourneyView

Parameters:

request - The request object

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewSchedules

public ApiResponse<JourneyViewSchedule> postJourneyViewSchedules(ApiRequest<JourneyViewSchedule> request)
                                                          throws IOException

Add a new Schedule to a JourneyView

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyViewVersionJobs

public JourneyViewJob postJourneyViewVersionJobs(String viewId,
 String journeyVersionId)
                                          throws IOException,
ApiException

Submit a job request for a journey view version.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewVersionJobsWithHttpInfo

public ApiResponse<JourneyViewJob> postJourneyViewVersionJobsWithHttpInfo(String viewId,
 String journeyVersionId)
                                                                   throws IOException

Submit a job request for a journey view version.

Parameters:

viewId - Journey View Id (required)

journeyVersionId - Journey View Version (required)

Returns:

JourneyViewJob

Throws:

IOException - if the request fails to be processed

postJourneyViewVersionJobs

public JourneyViewJob postJourneyViewVersionJobs(PostJourneyViewVersionJobsRequest request)
                                          throws IOException,
ApiException

Submit a job request for a journey view version.

Parameters:

request - The request object

Returns:

JourneyViewJob

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewVersionJobs

public ApiResponse<JourneyViewJob> postJourneyViewVersionJobs(ApiRequest<Void> request)
                                                       throws IOException

Submit a job request for a journey view version.

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyViewVersions

public JourneyView postJourneyViewVersions(String viewId,
 JourneyView body)
                                    throws IOException,
ApiException

Update a Journey View by ID creates a new version

Parameters:

viewId - viewId (required)

body - JourneyView (required)

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewVersionsWithHttpInfo

public ApiResponse<JourneyView> postJourneyViewVersionsWithHttpInfo(String viewId,
 JourneyView body)
                                                             throws IOException

Update a Journey View by ID creates a new version

Parameters:

viewId - viewId (required)

body - JourneyView (required)

Returns:

JourneyView

Throws:

IOException - if the request fails to be processed

postJourneyViewVersions

public JourneyView postJourneyViewVersions(PostJourneyViewVersionsRequest request)
                                    throws IOException,
ApiException

Update a Journey View by ID creates a new version

Parameters:

request - The request object

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewVersions

public ApiResponse<JourneyView> postJourneyViewVersions(ApiRequest<JourneyView> request)
                                                 throws IOException

Update a Journey View by ID creates a new version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyViews

public JourneyView postJourneyViews(JourneyView body)
                             throws IOException,
ApiException

Create a new Journey View

Parameters:

body - JourneyView (required)

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewsWithHttpInfo

public ApiResponse<JourneyView> postJourneyViewsWithHttpInfo(JourneyView body)
                                                      throws IOException

Create a new Journey View

Parameters:

body - JourneyView (required)

Returns:

JourneyView

Throws:

IOException - if the request fails to be processed

postJourneyViews

public JourneyView postJourneyViews(PostJourneyViewsRequest request)
                             throws IOException,
ApiException

Create a new Journey View

Parameters:

request - The request object

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViews

public ApiResponse<JourneyView> postJourneyViews(ApiRequest<JourneyView> request)
                                          throws IOException

Create a new Journey View

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

postJourneyViewsEncodingsValidate

public EntityListing postJourneyViewsEncodingsValidate(List<Label> body)
                                                throws IOException,
ApiException

Validate whether an encoding exist for a label/value combination. True indicates a valid encoding

Parameters:

body - (optional)

Returns:

EntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewsEncodingsValidateWithHttpInfo

public ApiResponse<EntityListing> postJourneyViewsEncodingsValidateWithHttpInfo(List<Label> body)
                                                                         throws IOException

Validate whether an encoding exist for a label/value combination. True indicates a valid encoding

Parameters:

body - (optional)

Returns:

EntityListing

Throws:

IOException - if the request fails to be processed

postJourneyViewsEncodingsValidate

public EntityListing postJourneyViewsEncodingsValidate(PostJourneyViewsEncodingsValidateRequest request)
                                                throws IOException,
ApiException

Validate whether an encoding exist for a label/value combination. True indicates a valid encoding

Parameters:

request - The request object

Returns:

EntityListing

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

postJourneyViewsEncodingsValidate

public ApiResponse<EntityListing> postJourneyViewsEncodingsValidate(ApiRequest<List<Label>> request)
                                                             throws IOException

Validate whether an encoding exist for a label/value combination. True indicates a valid encoding

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putJourneyExternaleventsSchema

public JourneyExternalEventsSchema putJourneyExternaleventsSchema(String schemaId,
 JourneySchemaUpdateRequest body)
                                                           throws IOException,
ApiException

Update a schema

Parameters:

schemaId - Schema ID (required)

body - Schema update request body (required)

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyExternaleventsSchemaWithHttpInfo

public ApiResponse<JourneyExternalEventsSchema> putJourneyExternaleventsSchemaWithHttpInfo(String schemaId,
 JourneySchemaUpdateRequest body)
                                                                                    throws IOException

Update a schema

Parameters:

schemaId - Schema ID (required)

body - Schema update request body (required)

Returns:

JourneyExternalEventsSchema

Throws:

IOException - if the request fails to be processed

putJourneyExternaleventsSchema

public JourneyExternalEventsSchema putJourneyExternaleventsSchema(PutJourneyExternaleventsSchemaRequest request)
                                                           throws IOException,
ApiException

Update a schema

Parameters:

request - The request object

Returns:

JourneyExternalEventsSchema

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyExternaleventsSchema

public ApiResponse<JourneyExternalEventsSchema> putJourneyExternaleventsSchema(ApiRequest<JourneySchemaUpdateRequest> request)
                                                                        throws IOException

Update a schema

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putJourneyViewSchedules

public JourneyViewSchedule putJourneyViewSchedules(String viewId,
 JourneyViewSchedule body)
                                            throws IOException,
ApiException

Update the Schedule for a JourneyView

Parameters:

viewId - Journey View Id (required)

body - journeyViewSchedule (required)

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewSchedulesWithHttpInfo

public ApiResponse<JourneyViewSchedule> putJourneyViewSchedulesWithHttpInfo(String viewId,
 JourneyViewSchedule body)
                                                                     throws IOException

Update the Schedule for a JourneyView

Parameters:

viewId - Journey View Id (required)

body - journeyViewSchedule (required)

Returns:

JourneyViewSchedule

Throws:

IOException - if the request fails to be processed

putJourneyViewSchedules

public JourneyViewSchedule putJourneyViewSchedules(PutJourneyViewSchedulesRequest request)
                                            throws IOException,
ApiException

Update the Schedule for a JourneyView

Parameters:

request - The request object

Returns:

JourneyViewSchedule

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewSchedules

public ApiResponse<JourneyViewSchedule> putJourneyViewSchedules(ApiRequest<JourneyViewSchedule> request)
                                                         throws IOException

Update the Schedule for a JourneyView

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putJourneyViewVersion

public JourneyView putJourneyViewVersion(String viewId,
 String versionId,
 JourneyView body)
                                  throws IOException,
ApiException

Update a Journey View by ID and version does not create a new version

Parameters:

viewId - viewId (required)

versionId - versionId (required)

body - JourneyView (required)

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewVersionWithHttpInfo

public ApiResponse<JourneyView> putJourneyViewVersionWithHttpInfo(String viewId,
 String versionId,
 JourneyView body)
                                                           throws IOException

Update a Journey View by ID and version does not create a new version

Parameters:

viewId - viewId (required)

versionId - versionId (required)

body - JourneyView (required)

Returns:

JourneyView

Throws:

IOException - if the request fails to be processed

putJourneyViewVersion

public JourneyView putJourneyViewVersion(PutJourneyViewVersionRequest request)
                                  throws IOException,
ApiException

Update a Journey View by ID and version does not create a new version

Parameters:

request - The request object

Returns:

JourneyView

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewVersion

public ApiResponse<JourneyView> putJourneyViewVersion(ApiRequest<JourneyView> request)
                                               throws IOException

Update a Journey View by ID and version does not create a new version

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putJourneyViewsEventdefinition

public UpdateExternalEventResponse putJourneyViewsEventdefinition(String eventDefinitionId,
 UpdateExternalEventRequest body)
                                                           throws IOException,
ApiException

Update external event for journey views

Parameters:

eventDefinitionId - Event Definition ID (required)

body - (optional)

Returns:

UpdateExternalEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewsEventdefinitionWithHttpInfo

public ApiResponse<UpdateExternalEventResponse> putJourneyViewsEventdefinitionWithHttpInfo(String eventDefinitionId,
 UpdateExternalEventRequest body)
                                                                                    throws IOException

Update external event for journey views

Parameters:

eventDefinitionId - Event Definition ID (required)

body - (optional)

Returns:

UpdateExternalEventResponse

Throws:

IOException - if the request fails to be processed

putJourneyViewsEventdefinition

public UpdateExternalEventResponse putJourneyViewsEventdefinition(PutJourneyViewsEventdefinitionRequest request)
                                                           throws IOException,
ApiException

Update external event for journey views

Parameters:

request - The request object

Returns:

UpdateExternalEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewsEventdefinition

public ApiResponse<UpdateExternalEventResponse> putJourneyViewsEventdefinition(ApiRequest<UpdateExternalEventRequest> request)
                                                                        throws IOException

Update external event for journey views

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed

putJourneyViewsEventdefinitionActivate

public ActivateExternalEventResponse putJourneyViewsEventdefinitionActivate(String eventDefinitionId,
 ActivateExternalEventRequest body)
                                                                     throws IOException,
ApiException

Activate external event for journey views

Parameters:

eventDefinitionId - Event Definition ID (required)

body - (optional)

Returns:

ActivateExternalEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewsEventdefinitionActivateWithHttpInfo

public ApiResponse<ActivateExternalEventResponse> putJourneyViewsEventdefinitionActivateWithHttpInfo(String eventDefinitionId,
 ActivateExternalEventRequest body)
                                                                                              throws IOException

Activate external event for journey views

Parameters:

eventDefinitionId - Event Definition ID (required)

body - (optional)

Returns:

ActivateExternalEventResponse

Throws:

IOException - if the request fails to be processed

putJourneyViewsEventdefinitionActivate

public ActivateExternalEventResponse putJourneyViewsEventdefinitionActivate(PutJourneyViewsEventdefinitionActivateRequest request)
                                                                     throws IOException,
ApiException

Activate external event for journey views

Parameters:

request - The request object

Returns:

ActivateExternalEventResponse

Throws:

ApiException - if the request fails on the server

IOException - if the request fails to be processed

putJourneyViewsEventdefinitionActivate

public ApiResponse<ActivateExternalEventResponse> putJourneyViewsEventdefinitionActivate(ApiRequest<ActivateExternalEventRequest> request)
                                                                                  throws IOException

Activate external event for journey views

Parameters:

request - The request object

Returns:

the response

Throws:

IOException - if the request fails to be processed