Package com.mypurecloud.sdk.v2.api

Class UsersRulesApi

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

  • Constructor Details

    • UsersRulesApi

      public UsersRulesApi()

    • UsersRulesApi

      public UsersRulesApi(ApiClient apiClient)

  • Method Details

    • deleteUsersRule

      public void deleteUsersRule(String ruleId) throws IOException, ApiException
      Delete an existing users rule
      Parameters:
      ruleId - The id of the rule (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteUsersRuleWithHttpInfo

      public ApiResponse<Void> deleteUsersRuleWithHttpInfo(String ruleId) throws IOException
      Delete an existing users rule
      Parameters:
      ruleId - The id of the rule (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteUsersRule

      public void deleteUsersRule(DeleteUsersRuleRequest request) throws IOException, ApiException
      Delete an existing users rule
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteUsersRule

      public ApiResponse<Void> deleteUsersRule(ApiRequest<Void> request) throws IOException
      Delete an existing users rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsersRule

      public UsersRulesRule getUsersRule(String ruleId) throws IOException, ApiException
      Get a users rule
      Parameters:
      ruleId - The ID of the rule to retrieve (required)
      Returns:
      UsersRulesRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRuleWithHttpInfo

      public ApiResponse<UsersRulesRule> getUsersRuleWithHttpInfo(String ruleId) throws IOException
      Get a users rule
      Parameters:
      ruleId - The ID of the rule to retrieve (required)
      Returns:
      UsersRulesRule
      Throws:
      IOException - if the request fails to be processed

    • getUsersRule

      public UsersRulesRule getUsersRule(GetUsersRuleRequest request) throws IOException, ApiException
      Get a users rule
      Parameters:
      request - The request object
      Returns:
      UsersRulesRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRule

      public ApiResponse<UsersRulesRule> getUsersRule(ApiRequest<Void> request) throws IOException
      Get a users rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsersRuleDependentTypeId

      public UsersRulesDependent getUsersRuleDependentTypeId(String ruleId, String ruleType, String typeId) throws IOException, ApiException
      Get dependent of a users rule
      Parameters:
      ruleId - The ID of the rule for which to retrieve dependents (required)
      ruleType - The type of the dependent (required)
      typeId - The type ID of the dependent (required)
      Returns:
      UsersRulesDependent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRuleDependentTypeIdWithHttpInfo

      public ApiResponse<UsersRulesDependent> getUsersRuleDependentTypeIdWithHttpInfo(String ruleId, String ruleType, String typeId) throws IOException
      Get dependent of a users rule
      Parameters:
      ruleId - The ID of the rule for which to retrieve dependents (required)
      ruleType - The type of the dependent (required)
      typeId - The type ID of the dependent (required)
      Returns:
      UsersRulesDependent
      Throws:
      IOException - if the request fails to be processed

    • getUsersRuleDependentTypeId

      public UsersRulesDependent getUsersRuleDependentTypeId(GetUsersRuleDependentTypeIdRequest request) throws IOException, ApiException
      Get dependent of a users rule
      Parameters:
      request - The request object
      Returns:
      UsersRulesDependent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRuleDependentTypeId

      public ApiResponse<UsersRulesDependent> getUsersRuleDependentTypeId(ApiRequest<Void> request) throws IOException
      Get dependent of a users rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsersRuleDependents

      public UsersRulesDependentList getUsersRuleDependents(String ruleId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException
      Get dependents for a users rule
      Parameters:
      ruleId - The ID of the rule for which to retrieve dependents (required)
      pageSize - Number of results per page (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order for dependents (by last run date, then created date) (optional, default to descending)
      Returns:
      UsersRulesDependentList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRuleDependentsWithHttpInfo

      public ApiResponse<UsersRulesDependentList> getUsersRuleDependentsWithHttpInfo(String ruleId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException
      Get dependents for a users rule
      Parameters:
      ruleId - The ID of the rule for which to retrieve dependents (required)
      pageSize - Number of results per page (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order for dependents (by last run date, then created date) (optional, default to descending)
      Returns:
      UsersRulesDependentList
      Throws:
      IOException - if the request fails to be processed

    • getUsersRuleDependents

      public UsersRulesDependentList getUsersRuleDependents(GetUsersRuleDependentsRequest request) throws IOException, ApiException
      Get dependents for a users rule
      Parameters:
      request - The request object
      Returns:
      UsersRulesDependentList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRuleDependents

      public ApiResponse<UsersRulesDependentList> getUsersRuleDependents(ApiRequest<Void> request) throws IOException
      Get dependents for a users rule
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsersRules

      public UsersRulesRuleList getUsersRules(List<String> types, Integer pageNumber, Integer pageSize, List<String> expand, Boolean enabled, String searchTerm, String sortOrder) throws IOException, ApiException
      Get the list of users rules
      Parameters:
      types - The types of the rule (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Number of results per page (optional, default to 25)
      expand - Fields to expand in response (optional)
      enabled - Whether to list enabled or disabled rules (optional)
      searchTerm - a search term for finding a rule by name (optional)
      sortOrder - sort rules by name, ascending, descending (optional, default to ascending)
      Returns:
      UsersRulesRuleList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRulesWithHttpInfo

      public ApiResponse<UsersRulesRuleList> getUsersRulesWithHttpInfo(List<String> types, Integer pageNumber, Integer pageSize, List<String> expand, Boolean enabled, String searchTerm, String sortOrder) throws IOException
      Get the list of users rules
      Parameters:
      types - The types of the rule (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Number of results per page (optional, default to 25)
      expand - Fields to expand in response (optional)
      enabled - Whether to list enabled or disabled rules (optional)
      searchTerm - a search term for finding a rule by name (optional)
      sortOrder - sort rules by name, ascending, descending (optional, default to ascending)
      Returns:
      UsersRulesRuleList
      Throws:
      IOException - if the request fails to be processed

    • getUsersRules

      public UsersRulesRuleList getUsersRules(GetUsersRulesRequest request) throws IOException, ApiException
      Get the list of users rules
      Parameters:
      request - The request object
      Returns:
      UsersRulesRuleList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRules

      public ApiResponse<UsersRulesRuleList> getUsersRules(ApiRequest<Void> request) throws IOException
      Get the list of users rules
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUsersRulesSetting

      public UsersRulesRuleSettings getUsersRulesSetting(String ruleType) throws IOException, ApiException
      Get the settings for a specific users rule type
      Parameters:
      ruleType - The type of the rule (required)
      Returns:
      UsersRulesRuleSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRulesSettingWithHttpInfo

      public ApiResponse<UsersRulesRuleSettings> getUsersRulesSettingWithHttpInfo(String ruleType) throws IOException
      Get the settings for a specific users rule type
      Parameters:
      ruleType - The type of the rule (required)
      Returns:
      UsersRulesRuleSettings
      Throws:
      IOException - if the request fails to be processed

    • getUsersRulesSetting

      public UsersRulesRuleSettings getUsersRulesSetting(GetUsersRulesSettingRequest request) throws IOException, ApiException
      Get the settings for a specific users rule type
      Parameters:
      request - The request object
      Returns:
      UsersRulesRuleSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUsersRulesSetting

      public ApiResponse<UsersRulesRuleSettings> getUsersRulesSetting(ApiRequest<Void> request) throws IOException
      Get the settings for a specific users rule type
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchUsersRule

      public UsersRulesRule patchUsersRule(String ruleId, UsersRulesUpdateRuleRequest body) throws IOException, ApiException
      Update an existing users rule This will update an existing users rule with the specified fields.
      Parameters:
      ruleId - The ID of the rule to update (required)
      body - updateRuleRequest (required)
      Returns:
      UsersRulesRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUsersRuleWithHttpInfo

      public ApiResponse<UsersRulesRule> patchUsersRuleWithHttpInfo(String ruleId, UsersRulesUpdateRuleRequest body) throws IOException
      Update an existing users rule This will update an existing users rule with the specified fields.
      Parameters:
      ruleId - The ID of the rule to update (required)
      body - updateRuleRequest (required)
      Returns:
      UsersRulesRule
      Throws:
      IOException - if the request fails to be processed

    • patchUsersRule

      public UsersRulesRule patchUsersRule(PatchUsersRuleRequest request) throws IOException, ApiException
      Update an existing users rule This will update an existing users rule with the specified fields.
      Parameters:
      request - The request object
      Returns:
      UsersRulesRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUsersRule

      public ApiResponse<UsersRulesRule> patchUsersRule(ApiRequest<UsersRulesUpdateRuleRequest> request) throws IOException
      Update an existing users rule This will update an existing users rule with the specified fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postUsersRules

      public UsersRulesRule postUsersRules(UsersRulesCreateRuleRequest body) throws IOException, ApiException
      Create a new rule This will create a new rule with the specified fields.
      Parameters:
      body - usersRulesCreateRuleRequest (required)
      Returns:
      UsersRulesRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsersRulesWithHttpInfo

      public ApiResponse<UsersRulesRule> postUsersRulesWithHttpInfo(UsersRulesCreateRuleRequest body) throws IOException
      Create a new rule This will create a new rule with the specified fields.
      Parameters:
      body - usersRulesCreateRuleRequest (required)
      Returns:
      UsersRulesRule
      Throws:
      IOException - if the request fails to be processed

    • postUsersRules

      public UsersRulesRule postUsersRules(PostUsersRulesRequest request) throws IOException, ApiException
      Create a new rule This will create a new rule with the specified fields.
      Parameters:
      request - The request object
      Returns:
      UsersRulesRule
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsersRules

      public ApiResponse<UsersRulesRule> postUsersRules(ApiRequest<UsersRulesCreateRuleRequest> request) throws IOException
      Create a new rule This will create a new rule with the specified fields.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postUsersRulesQuery

      public UsersRulesQueryResponse postUsersRulesQuery(UsersRulesQueryRuleRequest body, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Query the result of a users rule This will query the result of a rule.
      Parameters:
      body - usersRulesQueryRuleRequest (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Number of results per page (optional, default to 25)
      Returns:
      UsersRulesQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsersRulesQueryWithHttpInfo

      public ApiResponse<UsersRulesQueryResponse> postUsersRulesQueryWithHttpInfo(UsersRulesQueryRuleRequest body, Integer pageNumber, Integer pageSize) throws IOException
      Query the result of a users rule This will query the result of a rule.
      Parameters:
      body - usersRulesQueryRuleRequest (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Number of results per page (optional, default to 25)
      Returns:
      UsersRulesQueryResponse
      Throws:
      IOException - if the request fails to be processed

    • postUsersRulesQuery

      public UsersRulesQueryResponse postUsersRulesQuery(PostUsersRulesQueryRequest request) throws IOException, ApiException
      Query the result of a users rule This will query the result of a rule.
      Parameters:
      request - The request object
      Returns:
      UsersRulesQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postUsersRulesQuery

      public ApiResponse<UsersRulesQueryResponse> postUsersRulesQuery(ApiRequest<UsersRulesQueryRuleRequest> request) throws IOException
      Query the result of a users rule This will query the result of a rule.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed