Package com.mypurecloud.sdk.v2.api

Class ProcessAutomationApi

java.lang.Object
com.mypurecloud.sdk.v2.api.ProcessAutomationApi
public class ProcessAutomationApi extends Object

  • Constructor Details

    • ProcessAutomationApi

      public ProcessAutomationApi()

    • ProcessAutomationApi

      public ProcessAutomationApi(ApiClient apiClient)

  • Method Details

    • deleteProcessautomationScheduledtrigger

      public void deleteProcessautomationScheduledtrigger(String scheduledTriggerId) throws IOException, ApiException
      Delete a Scheduled Trigger
      Parameters:
      scheduledTriggerId - scheduledTriggerId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteProcessautomationScheduledtriggerWithHttpInfo

      public ApiResponse<Void> deleteProcessautomationScheduledtriggerWithHttpInfo(String scheduledTriggerId) throws IOException
      Delete a Scheduled Trigger
      Parameters:
      scheduledTriggerId - scheduledTriggerId (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteProcessautomationScheduledtrigger

      public void deleteProcessautomationScheduledtrigger(DeleteProcessautomationScheduledtriggerRequest request) throws IOException, ApiException
      Delete a Scheduled Trigger
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteProcessautomationScheduledtrigger

      public ApiResponse<Void> deleteProcessautomationScheduledtrigger(ApiRequest<Void> request) throws IOException
      Delete a Scheduled Trigger
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteProcessautomationTrigger

      public void deleteProcessautomationTrigger(String triggerId) throws IOException, ApiException
      Delete a Trigger
      Parameters:
      triggerId - triggerId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteProcessautomationTriggerWithHttpInfo

      public ApiResponse<Void> deleteProcessautomationTriggerWithHttpInfo(String triggerId) throws IOException
      Delete a Trigger
      Parameters:
      triggerId - triggerId (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteProcessautomationTrigger

      public void deleteProcessautomationTrigger(DeleteProcessautomationTriggerRequest request) throws IOException, ApiException
      Delete a Trigger
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteProcessautomationTrigger

      public ApiResponse<Void> deleteProcessautomationTrigger(ApiRequest<Void> request) throws IOException
      Delete a Trigger
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtrigger

      public ScheduledTrigger getProcessautomationScheduledtrigger(String scheduledTriggerId) throws IOException, ApiException
      Retrieve a single Scheduled Trigger matching id
      Parameters:
      scheduledTriggerId - scheduledTriggerId (required)
      Returns:
      ScheduledTrigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtriggerWithHttpInfo

      public ApiResponse<ScheduledTrigger> getProcessautomationScheduledtriggerWithHttpInfo(String scheduledTriggerId) throws IOException
      Retrieve a single Scheduled Trigger matching id
      Parameters:
      scheduledTriggerId - scheduledTriggerId (required)
      Returns:
      ScheduledTrigger
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtrigger

      public ScheduledTrigger getProcessautomationScheduledtrigger(GetProcessautomationScheduledtriggerRequest request) throws IOException, ApiException
      Retrieve a single Scheduled Trigger matching id
      Parameters:
      request - The request object
      Returns:
      ScheduledTrigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtrigger

      public ApiResponse<ScheduledTrigger> getProcessautomationScheduledtrigger(ApiRequest<Void> request) throws IOException
      Retrieve a single Scheduled Trigger matching id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtriggers

      public ScheduledTriggerEntityListing getProcessautomationScheduledtriggers(String before, String after, String pageSize, Boolean enabled) throws IOException, ApiException
      Retrieves all scheduled triggers, optionally filtered by query parameters.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      enabled - Boolean indicating desired enabled state of scheduled triggers (optional)
      Returns:
      ScheduledTriggerEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtriggersWithHttpInfo

      public ApiResponse<ScheduledTriggerEntityListing> getProcessautomationScheduledtriggersWithHttpInfo(String before, String after, String pageSize, Boolean enabled) throws IOException
      Retrieves all scheduled triggers, optionally filtered by query parameters.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      enabled - Boolean indicating desired enabled state of scheduled triggers (optional)
      Returns:
      ScheduledTriggerEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtriggers

      public ScheduledTriggerEntityListing getProcessautomationScheduledtriggers(GetProcessautomationScheduledtriggersRequest request) throws IOException, ApiException
      Retrieves all scheduled triggers, optionally filtered by query parameters.
      Parameters:
      request - The request object
      Returns:
      ScheduledTriggerEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationScheduledtriggers

      public ApiResponse<ScheduledTriggerEntityListing> getProcessautomationScheduledtriggers(ApiRequest<Void> request) throws IOException
      Retrieves all scheduled triggers, optionally filtered by query parameters.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationTrigger

      public Trigger getProcessautomationTrigger(String triggerId) throws IOException, ApiException
      Retrieve a single Trigger matching id
      Parameters:
      triggerId - triggerId (required)
      Returns:
      Trigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationTriggerWithHttpInfo

      public ApiResponse<Trigger> getProcessautomationTriggerWithHttpInfo(String triggerId) throws IOException
      Retrieve a single Trigger matching id
      Parameters:
      triggerId - triggerId (required)
      Returns:
      Trigger
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationTrigger

      public Trigger getProcessautomationTrigger(GetProcessautomationTriggerRequest request) throws IOException, ApiException
      Retrieve a single Trigger matching id
      Parameters:
      request - The request object
      Returns:
      Trigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationTrigger

      public ApiResponse<Trigger> getProcessautomationTrigger(ApiRequest<Void> request) throws IOException
      Retrieve a single Trigger matching id
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationTriggers

      public TriggerEntityListing getProcessautomationTriggers(String before, String after, String pageSize, String topicName, Boolean enabled, Boolean hasDelayBy) throws IOException, ApiException
      Retrieves all triggers, optionally filtered by query parameters.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      topicName - Topic name(s). Separated by commas (optional)
      enabled - Boolean indicating desired enabled state of triggers (optional)
      hasDelayBy - Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set. (optional)
      Returns:
      TriggerEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationTriggersWithHttpInfo

      public ApiResponse<TriggerEntityListing> getProcessautomationTriggersWithHttpInfo(String before, String after, String pageSize, String topicName, Boolean enabled, Boolean hasDelayBy) throws IOException
      Retrieves all triggers, optionally filtered by query parameters.
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      topicName - Topic name(s). Separated by commas (optional)
      enabled - Boolean indicating desired enabled state of triggers (optional)
      hasDelayBy - Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set. (optional)
      Returns:
      TriggerEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationTriggers

      public TriggerEntityListing getProcessautomationTriggers(GetProcessautomationTriggersRequest request) throws IOException, ApiException
      Retrieves all triggers, optionally filtered by query parameters.
      Parameters:
      request - The request object
      Returns:
      TriggerEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationTriggers

      public ApiResponse<TriggerEntityListing> getProcessautomationTriggers(ApiRequest<Void> request) throws IOException
      Retrieves all triggers, optionally filtered by query parameters.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationTriggersTopics

      public TopicCursorEntityListing getProcessautomationTriggersTopics(String before, String after, String pageSize) throws IOException, ApiException
      Get topics available for organization
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      TopicCursorEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationTriggersTopicsWithHttpInfo

      public ApiResponse<TopicCursorEntityListing> getProcessautomationTriggersTopicsWithHttpInfo(String before, String after, String pageSize) throws IOException
      Get topics available for organization
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      TopicCursorEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getProcessautomationTriggersTopics

      public TopicCursorEntityListing getProcessautomationTriggersTopics(GetProcessautomationTriggersTopicsRequest request) throws IOException, ApiException
      Get topics available for organization
      Parameters:
      request - The request object
      Returns:
      TopicCursorEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProcessautomationTriggersTopics

      public ApiResponse<TopicCursorEntityListing> getProcessautomationTriggersTopics(ApiRequest<Void> request) throws IOException
      Get topics available for organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationScheduledtriggers

      public ScheduledTrigger postProcessautomationScheduledtriggers(CreateScheduledTriggerRequest body) throws IOException, ApiException
      Create a scheduled Trigger
      Parameters:
      body - Input used to create a Scheduled Trigger (required)
      Returns:
      ScheduledTrigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationScheduledtriggersWithHttpInfo

      public ApiResponse<ScheduledTrigger> postProcessautomationScheduledtriggersWithHttpInfo(CreateScheduledTriggerRequest body) throws IOException
      Create a scheduled Trigger
      Parameters:
      body - Input used to create a Scheduled Trigger (required)
      Returns:
      ScheduledTrigger
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationScheduledtriggers

      public ScheduledTrigger postProcessautomationScheduledtriggers(PostProcessautomationScheduledtriggersRequest request) throws IOException, ApiException
      Create a scheduled Trigger
      Parameters:
      request - The request object
      Returns:
      ScheduledTrigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationScheduledtriggers

      public ApiResponse<ScheduledTrigger> postProcessautomationScheduledtriggers(ApiRequest<CreateScheduledTriggerRequest> request) throws IOException
      Create a scheduled Trigger
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationTriggerTest

      public TestModeResults postProcessautomationTriggerTest(String triggerId, String body) throws IOException, ApiException
      Test the matching of a Trigger based on provided event body
      Parameters:
      triggerId - triggerId (required)
      body - eventBody (optional)
      Returns:
      TestModeResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationTriggerTestWithHttpInfo

      public ApiResponse<TestModeResults> postProcessautomationTriggerTestWithHttpInfo(String triggerId, String body) throws IOException
      Test the matching of a Trigger based on provided event body
      Parameters:
      triggerId - triggerId (required)
      body - eventBody (optional)
      Returns:
      TestModeResults
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationTriggerTest

      public TestModeResults postProcessautomationTriggerTest(PostProcessautomationTriggerTestRequest request) throws IOException, ApiException
      Test the matching of a Trigger based on provided event body
      Parameters:
      request - The request object
      Returns:
      TestModeResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationTriggerTest

      public ApiResponse<TestModeResults> postProcessautomationTriggerTest(ApiRequest<String> request) throws IOException
      Test the matching of a Trigger based on provided event body
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationTriggers

      public Trigger postProcessautomationTriggers(CreateTriggerRequest body) throws IOException, ApiException
      Create a Trigger
      Parameters:
      body - Input used to create a Trigger. (required)
      Returns:
      Trigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationTriggersWithHttpInfo

      public ApiResponse<Trigger> postProcessautomationTriggersWithHttpInfo(CreateTriggerRequest body) throws IOException
      Create a Trigger
      Parameters:
      body - Input used to create a Trigger. (required)
      Returns:
      Trigger
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationTriggers

      public Trigger postProcessautomationTriggers(PostProcessautomationTriggersRequest request) throws IOException, ApiException
      Create a Trigger
      Parameters:
      request - The request object
      Returns:
      Trigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationTriggers

      public ApiResponse<Trigger> postProcessautomationTriggers(ApiRequest<CreateTriggerRequest> request) throws IOException
      Create a Trigger
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationTriggersTopicTest

      public TestModeEventResults postProcessautomationTriggersTopicTest(String topicName, String body) throws IOException, ApiException
      Test the matching of all organization Triggers on given topic using provided event body
      Parameters:
      topicName - topicName (required)
      body - eventBody (optional)
      Returns:
      TestModeEventResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationTriggersTopicTestWithHttpInfo

      public ApiResponse<TestModeEventResults> postProcessautomationTriggersTopicTestWithHttpInfo(String topicName, String body) throws IOException
      Test the matching of all organization Triggers on given topic using provided event body
      Parameters:
      topicName - topicName (required)
      body - eventBody (optional)
      Returns:
      TestModeEventResults
      Throws:
      IOException - if the request fails to be processed

    • postProcessautomationTriggersTopicTest

      public TestModeEventResults postProcessautomationTriggersTopicTest(PostProcessautomationTriggersTopicTestRequest request) throws IOException, ApiException
      Test the matching of all organization Triggers on given topic using provided event body
      Parameters:
      request - The request object
      Returns:
      TestModeEventResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postProcessautomationTriggersTopicTest

      public ApiResponse<TestModeEventResults> postProcessautomationTriggersTopicTest(ApiRequest<String> request) throws IOException
      Test the matching of all organization Triggers on given topic using provided event body
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putProcessautomationScheduledtrigger

      public ScheduledTrigger putProcessautomationScheduledtrigger(String scheduledTriggerId, UpdateScheduledTriggerRequest body) throws IOException, ApiException
      Update a Scheduled Trigger
      Parameters:
      scheduledTriggerId - scheduledTriggerId (required)
      body - Input to update Scheduled Trigger. (required)
      Returns:
      ScheduledTrigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putProcessautomationScheduledtriggerWithHttpInfo

      public ApiResponse<ScheduledTrigger> putProcessautomationScheduledtriggerWithHttpInfo(String scheduledTriggerId, UpdateScheduledTriggerRequest body) throws IOException
      Update a Scheduled Trigger
      Parameters:
      scheduledTriggerId - scheduledTriggerId (required)
      body - Input to update Scheduled Trigger. (required)
      Returns:
      ScheduledTrigger
      Throws:
      IOException - if the request fails to be processed

    • putProcessautomationScheduledtrigger

      public ScheduledTrigger putProcessautomationScheduledtrigger(PutProcessautomationScheduledtriggerRequest request) throws IOException, ApiException
      Update a Scheduled Trigger
      Parameters:
      request - The request object
      Returns:
      ScheduledTrigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putProcessautomationScheduledtrigger

      public ApiResponse<ScheduledTrigger> putProcessautomationScheduledtrigger(ApiRequest<UpdateScheduledTriggerRequest> request) throws IOException
      Update a Scheduled Trigger
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putProcessautomationTrigger

      public Trigger putProcessautomationTrigger(String triggerId, UpdateTriggerRequest body) throws IOException, ApiException
      Update a Trigger
      Parameters:
      triggerId - triggerId (required)
      body - Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName) (required)
      Returns:
      Trigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putProcessautomationTriggerWithHttpInfo

      public ApiResponse<Trigger> putProcessautomationTriggerWithHttpInfo(String triggerId, UpdateTriggerRequest body) throws IOException
      Update a Trigger
      Parameters:
      triggerId - triggerId (required)
      body - Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName) (required)
      Returns:
      Trigger
      Throws:
      IOException - if the request fails to be processed

    • putProcessautomationTrigger

      public Trigger putProcessautomationTrigger(PutProcessautomationTriggerRequest request) throws IOException, ApiException
      Update a Trigger
      Parameters:
      request - The request object
      Returns:
      Trigger
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putProcessautomationTrigger

      public ApiResponse<Trigger> putProcessautomationTrigger(ApiRequest<UpdateTriggerRequest> request) throws IOException
      Update a Trigger
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed