Class RoutingApi

java.lang.Object
com.mypurecloud.sdk.v2.api.RoutingApi

public class RoutingApi extends Object
  • Constructor Details

    • RoutingApi

      public RoutingApi()
    • RoutingApi

      public RoutingApi(ApiClient apiClient)
  • Method Details

    • deleteRoutingAssessment

      public void deleteRoutingAssessment(String assessmentId) throws IOException, ApiException
      Delete single benefit assessment.
      Parameters:
      assessmentId - Benefit Assessment ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingAssessmentWithHttpInfo

      public ApiResponse<Void> deleteRoutingAssessmentWithHttpInfo(String assessmentId) throws IOException
      Delete single benefit assessment.
      Parameters:
      assessmentId - Benefit Assessment ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingAssessment

      public void deleteRoutingAssessment(DeleteRoutingAssessmentRequest request) throws IOException, ApiException
      Delete single benefit assessment.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingAssessment

      public ApiResponse<Void> deleteRoutingAssessment(ApiRequest<Void> request) throws IOException
      Delete single benefit assessment.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingDirectroutingbackupSettingsMe

      public void deleteRoutingDirectroutingbackupSettingsMe() throws IOException, ApiException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingDirectroutingbackupSettingsMeWithHttpInfo

      public ApiResponse<Void> deleteRoutingDirectroutingbackupSettingsMeWithHttpInfo() throws IOException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingDirectroutingbackupSettingsMe

      public void deleteRoutingDirectroutingbackupSettingsMe(DeleteRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingDirectroutingbackupSettingsMe

      public ApiResponse<Void> deleteRoutingDirectroutingbackupSettingsMe(ApiRequest<Void> request) throws IOException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingEmailDomain

      public void deleteRoutingEmailDomain(String domainId) throws IOException, ApiException
      Delete a domain
      Parameters:
      domainId - domain ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailDomainWithHttpInfo

      public ApiResponse<Void> deleteRoutingEmailDomainWithHttpInfo(String domainId) throws IOException
      Delete a domain
      Parameters:
      domainId - domain ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingEmailDomain

      public void deleteRoutingEmailDomain(DeleteRoutingEmailDomainRequest request) throws IOException, ApiException
      Delete a domain
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailDomain

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

      public void deleteRoutingEmailDomainRoute(String domainName, String routeId) throws IOException, ApiException
      Delete a route
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailDomainRouteWithHttpInfo

      public ApiResponse<Void> deleteRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId) throws IOException
      Delete a route
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingEmailDomainRoute

      public void deleteRoutingEmailDomainRoute(DeleteRoutingEmailDomainRouteRequest request) throws IOException, ApiException
      Delete a route
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailDomainRoute

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

      public void deleteRoutingEmailOutboundDomain(String domainId) throws IOException, ApiException
      Delete an outbound domain
      Parameters:
      domainId - domain ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailOutboundDomainWithHttpInfo

      public ApiResponse<Void> deleteRoutingEmailOutboundDomainWithHttpInfo(String domainId) throws IOException
      Delete an outbound domain
      Parameters:
      domainId - domain ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingEmailOutboundDomain

      public void deleteRoutingEmailOutboundDomain(DeleteRoutingEmailOutboundDomainRequest request) throws IOException, ApiException
      Delete an outbound domain
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailOutboundDomain

      public ApiResponse<Void> deleteRoutingEmailOutboundDomain(ApiRequest<Void> request) throws IOException
      Delete an outbound domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingEmailSettingEmailSettingId

      public void deleteRoutingEmailSettingEmailSettingId(String emailSettingId) throws IOException, ApiException
      Delete an email setting. Removes the email setting and its associated settings
      Parameters:
      emailSettingId - Email Setting ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailSettingEmailSettingIdWithHttpInfo

      public ApiResponse<Void> deleteRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId) throws IOException
      Delete an email setting. Removes the email setting and its associated settings
      Parameters:
      emailSettingId - Email Setting ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingEmailSettingEmailSettingId

      public void deleteRoutingEmailSettingEmailSettingId(DeleteRoutingEmailSettingEmailSettingIdRequest request) throws IOException, ApiException
      Delete an email setting. Removes the email setting and its associated settings
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingEmailSettingEmailSettingId

      public ApiResponse<Void> deleteRoutingEmailSettingEmailSettingId(ApiRequest<Void> request) throws IOException
      Delete an email setting. Removes the email setting and its associated settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingLanguage

      public void deleteRoutingLanguage(String languageId) throws IOException, ApiException
      Delete a routing language
      Parameters:
      languageId - Language ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingLanguageWithHttpInfo

      public ApiResponse<Void> deleteRoutingLanguageWithHttpInfo(String languageId) throws IOException
      Delete a routing language
      Parameters:
      languageId - Language ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingLanguage

      public void deleteRoutingLanguage(DeleteRoutingLanguageRequest request) throws IOException, ApiException
      Delete a routing language
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingLanguage

      public ApiResponse<Void> deleteRoutingLanguage(ApiRequest<Void> request) throws IOException
      Delete a routing language
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingPredictor

      public void deleteRoutingPredictor(String predictorId) throws IOException, ApiException
      Delete single predictor.
      Parameters:
      predictorId - Predictor ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingPredictorWithHttpInfo

      public ApiResponse<Void> deleteRoutingPredictorWithHttpInfo(String predictorId) throws IOException
      Delete single predictor.
      Parameters:
      predictorId - Predictor ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingPredictor

      public void deleteRoutingPredictor(DeleteRoutingPredictorRequest request) throws IOException, ApiException
      Delete single predictor.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingPredictor

      public ApiResponse<Void> deleteRoutingPredictor(ApiRequest<Void> request) throws IOException
      Delete single predictor.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingPredictorsKeyperformanceindicator

      public void deleteRoutingPredictorsKeyperformanceindicator(String kpiId) throws IOException, ApiException
      Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      kpiId - Key Performance Indicator ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingPredictorsKeyperformanceindicatorWithHttpInfo

      public ApiResponse<Void> deleteRoutingPredictorsKeyperformanceindicatorWithHttpInfo(String kpiId) throws IOException
      Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      kpiId - Key Performance Indicator ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingPredictorsKeyperformanceindicator

      public void deleteRoutingPredictorsKeyperformanceindicator(DeleteRoutingPredictorsKeyperformanceindicatorRequest request) throws IOException, ApiException
      Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingPredictorsKeyperformanceindicator

      public ApiResponse<Void> deleteRoutingPredictorsKeyperformanceindicator(ApiRequest<Void> request) throws IOException
      Delete a custom Key Performance Indicator. deleteRoutingPredictorsKeyperformanceindicator 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
    • deleteRoutingQueue

      public void deleteRoutingQueue(String queueId, Boolean forceDelete) throws IOException, ApiException
      Delete a queue
      Parameters:
      queueId - Queue ID (required)
      forceDelete - forceDelete (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueueWithHttpInfo

      public ApiResponse<Void> deleteRoutingQueueWithHttpInfo(String queueId, Boolean forceDelete) throws IOException
      Delete a queue
      Parameters:
      queueId - Queue ID (required)
      forceDelete - forceDelete (optional)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingQueue

      public void deleteRoutingQueue(DeleteRoutingQueueRequest request) throws IOException, ApiException
      Delete a queue
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueue

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

      public void deleteRoutingQueueMember(String queueId, String memberId) throws IOException, ApiException
      Delete a queue member.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueueMemberWithHttpInfo

      public ApiResponse<Void> deleteRoutingQueueMemberWithHttpInfo(String queueId, String memberId) throws IOException
      Delete a queue member.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingQueueMember

      public void deleteRoutingQueueMember(DeleteRoutingQueueMemberRequest request) throws IOException, ApiException
      Delete a queue member.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueueMember

      public ApiResponse<Void> deleteRoutingQueueMember(ApiRequest<Void> request) throws IOException
      Delete a queue member.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingQueueUser

      public void deleteRoutingQueueUser(String queueId, String memberId) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueueUserWithHttpInfo

      public ApiResponse<Void> deleteRoutingQueueUserWithHttpInfo(String queueId, String memberId) throws IOException
      Deprecated.
      DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingQueueUser

      public void deleteRoutingQueueUser(DeleteRoutingQueueUserRequest request) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueueUser

      public ApiResponse<Void> deleteRoutingQueueUser(ApiRequest<Void> request) throws IOException
      Deprecated.
      DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingQueueWrapupcode

      public void deleteRoutingQueueWrapupcode(String queueId, String codeId) throws IOException, ApiException
      Delete a wrap-up code from a queue
      Parameters:
      queueId - Queue ID (required)
      codeId - Code ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueueWrapupcodeWithHttpInfo

      public ApiResponse<Void> deleteRoutingQueueWrapupcodeWithHttpInfo(String queueId, String codeId) throws IOException
      Delete a wrap-up code from a queue
      Parameters:
      queueId - Queue ID (required)
      codeId - Code ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingQueueWrapupcode

      public void deleteRoutingQueueWrapupcode(DeleteRoutingQueueWrapupcodeRequest request) throws IOException, ApiException
      Delete a wrap-up code from a queue
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingQueueWrapupcode

      public ApiResponse<Void> deleteRoutingQueueWrapupcode(ApiRequest<Void> request) throws IOException
      Delete a wrap-up code from a queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSettings

      public void deleteRoutingSettings() throws IOException, ApiException
      Delete an organization's routing settings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSettingsWithHttpInfo

      public ApiResponse<Void> deleteRoutingSettingsWithHttpInfo() throws IOException
      Delete an organization's routing settings
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSettings

      public void deleteRoutingSettings(DeleteRoutingSettingsRequest request) throws IOException, ApiException
      Delete an organization's routing settings
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSettings

      public ApiResponse<Void> deleteRoutingSettings(ApiRequest<Void> request) throws IOException
      Delete an organization's routing settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkill

      public void deleteRoutingSkill(String skillId) throws IOException, ApiException
      Delete Routing Skill
      Parameters:
      skillId - Skill ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkillWithHttpInfo

      public ApiResponse<Void> deleteRoutingSkillWithHttpInfo(String skillId) throws IOException
      Delete Routing Skill
      Parameters:
      skillId - Skill ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkill

      public void deleteRoutingSkill(DeleteRoutingSkillRequest request) throws IOException, ApiException
      Delete Routing Skill
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkill

      public ApiResponse<Void> deleteRoutingSkill(ApiRequest<Void> request) throws IOException
      Delete Routing Skill
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpression

      public void deleteRoutingSkillexpression(String expressionId) throws IOException, ApiException
      Archive a skill expression to remove it from the set of active expressions
      Parameters:
      expressionId - Expression ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpressionWithHttpInfo

      public ApiResponse<Void> deleteRoutingSkillexpressionWithHttpInfo(String expressionId) throws IOException
      Archive a skill expression to remove it from the set of active expressions
      Parameters:
      expressionId - Expression ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpression

      public void deleteRoutingSkillexpression(DeleteRoutingSkillexpressionRequest request) throws IOException, ApiException
      Archive a skill expression to remove it from the set of active expressions
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpression

      public ApiResponse<Void> deleteRoutingSkillexpression(ApiRequest<Void> request) throws IOException
      Archive a skill expression to remove it from the set of active expressions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpressions

      public void deleteRoutingSkillexpressions(List<String> id) throws IOException, ApiException
      Archive a set of skill expressions to remove them from the set of active expressions
      Parameters:
      id - Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpressionsWithHttpInfo

      public ApiResponse<Void> deleteRoutingSkillexpressionsWithHttpInfo(List<String> id) throws IOException
      Archive a set of skill expressions to remove them from the set of active expressions
      Parameters:
      id - Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpressions

      public void deleteRoutingSkillexpressions(DeleteRoutingSkillexpressionsRequest request) throws IOException, ApiException
      Archive a set of skill expressions to remove them from the set of active expressions
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkillexpressions

      public ApiResponse<Void> deleteRoutingSkillexpressions(ApiRequest<Void> request) throws IOException
      Archive a set of skill expressions to remove them from the set of active expressions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkillgroup

      public void deleteRoutingSkillgroup(String skillGroupId) throws IOException, ApiException
      Remove skill group definition
      Parameters:
      skillGroupId - Skill Group ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkillgroupWithHttpInfo

      public ApiResponse<Void> deleteRoutingSkillgroupWithHttpInfo(String skillGroupId) throws IOException
      Remove skill group definition
      Parameters:
      skillGroupId - Skill Group ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSkillgroup

      public void deleteRoutingSkillgroup(DeleteRoutingSkillgroupRequest request) throws IOException, ApiException
      Remove skill group definition
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSkillgroup

      public ApiResponse<Void> deleteRoutingSkillgroup(ApiRequest<Void> request) throws IOException
      Remove skill group definition
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSmsAddress

      public void deleteRoutingSmsAddress(String addressId) throws IOException, ApiException
      Delete an Address by Id for SMS
      Parameters:
      addressId - Address ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSmsAddressWithHttpInfo

      public ApiResponse<Void> deleteRoutingSmsAddressWithHttpInfo(String addressId) throws IOException
      Delete an Address by Id for SMS
      Parameters:
      addressId - Address ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSmsAddress

      public void deleteRoutingSmsAddress(DeleteRoutingSmsAddressRequest request) throws IOException, ApiException
      Delete an Address by Id for SMS
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSmsAddress

      public ApiResponse<Void> deleteRoutingSmsAddress(ApiRequest<Void> request) throws IOException
      Delete an Address by Id for SMS
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSmsPhonenumber

      public void deleteRoutingSmsPhonenumber(String phoneNumberId) throws IOException, ApiException
      Delete a phone number provisioned for SMS.
      Parameters:
      phoneNumberId - phone number (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSmsPhonenumberWithHttpInfo

      public ApiResponse<Void> deleteRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId) throws IOException
      Delete a phone number provisioned for SMS.
      Parameters:
      phoneNumberId - phone number (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingSmsPhonenumber

      public void deleteRoutingSmsPhonenumber(DeleteRoutingSmsPhonenumberRequest request) throws IOException, ApiException
      Delete a phone number provisioned for SMS.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingSmsPhonenumber

      public ApiResponse<Void> deleteRoutingSmsPhonenumber(ApiRequest<Void> request) throws IOException
      Delete a phone number provisioned for SMS.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUserDirectroutingbackupSettings

      public void deleteRoutingUserDirectroutingbackupSettings(String userId) throws IOException, ApiException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Parameters:
      userId - User ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUserDirectroutingbackupSettingsWithHttpInfo

      public ApiResponse<Void> deleteRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId) throws IOException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Parameters:
      userId - User ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUserDirectroutingbackupSettings

      public void deleteRoutingUserDirectroutingbackupSettings(DeleteRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUserDirectroutingbackupSettings

      public ApiResponse<Void> deleteRoutingUserDirectroutingbackupSettings(ApiRequest<Void> request) throws IOException
      Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUserUtilization

      public void deleteRoutingUserUtilization(String userId) throws IOException, ApiException
      Delete the user's max utilization settings and revert to the organization-wide default.
      Parameters:
      userId - User ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUserUtilizationWithHttpInfo

      public ApiResponse<Void> deleteRoutingUserUtilizationWithHttpInfo(String userId) throws IOException
      Delete the user's max utilization settings and revert to the organization-wide default.
      Parameters:
      userId - User ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUserUtilization

      public void deleteRoutingUserUtilization(DeleteRoutingUserUtilizationRequest request) throws IOException, ApiException
      Delete the user's max utilization settings and revert to the organization-wide default.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUserUtilization

      public ApiResponse<Void> deleteRoutingUserUtilization(ApiRequest<Void> request) throws IOException
      Delete the user's max utilization settings and revert to the organization-wide default.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUtilization

      public void deleteRoutingUtilization() throws IOException, ApiException
      Delete the organization-wide max utilization settings and revert to the system default.
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUtilizationWithHttpInfo

      public ApiResponse<Void> deleteRoutingUtilizationWithHttpInfo() throws IOException
      Delete the organization-wide max utilization settings and revert to the system default.
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUtilization

      public void deleteRoutingUtilization(DeleteRoutingUtilizationRequest request) throws IOException, ApiException
      Delete the organization-wide max utilization settings and revert to the system default.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUtilization

      public ApiResponse<Void> deleteRoutingUtilization(ApiRequest<Void> request) throws IOException
      Delete the organization-wide max utilization settings and revert to the system default.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUtilizationLabel

      public void deleteRoutingUtilizationLabel(String labelId, Boolean forceDelete) throws IOException, ApiException
      Delete a utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      forceDelete - Remove all label usages (if found) without warning (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUtilizationLabelWithHttpInfo

      public ApiResponse<Void> deleteRoutingUtilizationLabelWithHttpInfo(String labelId, Boolean forceDelete) throws IOException
      Delete a utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      forceDelete - Remove all label usages (if found) without warning (optional, default to false)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingUtilizationLabel

      public void deleteRoutingUtilizationLabel(DeleteRoutingUtilizationLabelRequest request) throws IOException, ApiException
      Delete a utilization label
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingUtilizationLabel

      public ApiResponse<Void> deleteRoutingUtilizationLabel(ApiRequest<Void> request) throws IOException
      Delete a utilization label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingWrapupcode

      public void deleteRoutingWrapupcode(String codeId) throws IOException, ApiException
      Delete wrap-up code
      Parameters:
      codeId - Wrapup Code ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingWrapupcodeWithHttpInfo

      public ApiResponse<Void> deleteRoutingWrapupcodeWithHttpInfo(String codeId) throws IOException
      Delete wrap-up code
      Parameters:
      codeId - Wrapup Code ID (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteRoutingWrapupcode

      public void deleteRoutingWrapupcode(DeleteRoutingWrapupcodeRequest request) throws IOException, ApiException
      Delete wrap-up code
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteRoutingWrapupcode

      public ApiResponse<Void> deleteRoutingWrapupcode(ApiRequest<Void> request) throws IOException
      Delete wrap-up code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteUserRoutinglanguage

      public void deleteUserRoutinglanguage(String userId, String languageId) throws IOException, ApiException
      Remove a routing language from a user
      Parameters:
      userId - User ID (required)
      languageId - languageId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteUserRoutinglanguageWithHttpInfo

      public ApiResponse<Void> deleteUserRoutinglanguageWithHttpInfo(String userId, String languageId) throws IOException
      Remove a routing language from a user
      Parameters:
      userId - User ID (required)
      languageId - languageId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteUserRoutinglanguage

      public void deleteUserRoutinglanguage(DeleteUserRoutinglanguageRequest request) throws IOException, ApiException
      Remove a routing language from a user
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteUserRoutinglanguage

      public ApiResponse<Void> deleteUserRoutinglanguage(ApiRequest<Void> request) throws IOException
      Remove a routing language from a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • deleteUserRoutingskill

      public void deleteUserRoutingskill(String userId, String skillId) throws IOException, ApiException
      Remove a routing skill from a user
      Parameters:
      userId - User ID (required)
      skillId - skillId (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteUserRoutingskillWithHttpInfo

      public ApiResponse<Void> deleteUserRoutingskillWithHttpInfo(String userId, String skillId) throws IOException
      Remove a routing skill from a user
      Parameters:
      userId - User ID (required)
      skillId - skillId (required)
      Throws:
      IOException - if the request fails to be processed
    • deleteUserRoutingskill

      public void deleteUserRoutingskill(DeleteUserRoutingskillRequest request) throws IOException, ApiException
      Remove a routing skill from a user
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • deleteUserRoutingskill

      public ApiResponse<Void> deleteUserRoutingskill(ApiRequest<Void> request) throws IOException
      Remove a routing skill from a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessment

      public BenefitAssessment getRoutingAssessment(String assessmentId) throws IOException, ApiException
      Retrieve a single benefit assessment.
      Parameters:
      assessmentId - Benefit Assessment ID (required)
      Returns:
      BenefitAssessment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessmentWithHttpInfo

      public ApiResponse<BenefitAssessment> getRoutingAssessmentWithHttpInfo(String assessmentId) throws IOException
      Retrieve a single benefit assessment.
      Parameters:
      assessmentId - Benefit Assessment ID (required)
      Returns:
      BenefitAssessment
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessment

      public BenefitAssessment getRoutingAssessment(GetRoutingAssessmentRequest request) throws IOException, ApiException
      Retrieve a single benefit assessment.
      Parameters:
      request - The request object
      Returns:
      BenefitAssessment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessment

      public ApiResponse<BenefitAssessment> getRoutingAssessment(ApiRequest<Void> request) throws IOException
      Retrieve a single benefit assessment.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessments

      public AssessmentListing getRoutingAssessments(String before, String after, String limit, String pageSize, List<String> queueId) throws IOException, ApiException
      Retrieve all benefit assessments.
      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)
      limit - Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      queueId - Queue ID(s) to filter assessments by. (optional)
      Returns:
      AssessmentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessmentsWithHttpInfo

      public ApiResponse<AssessmentListing> getRoutingAssessmentsWithHttpInfo(String before, String after, String limit, String pageSize, List<String> queueId) throws IOException
      Retrieve all benefit assessments.
      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)
      limit - Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      queueId - Queue ID(s) to filter assessments by. (optional)
      Returns:
      AssessmentListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessments

      public AssessmentListing getRoutingAssessments(GetRoutingAssessmentsRequest request) throws IOException, ApiException
      Retrieve all benefit assessments.
      Parameters:
      request - The request object
      Returns:
      AssessmentListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessments

      public ApiResponse<AssessmentListing> getRoutingAssessments(ApiRequest<Void> request) throws IOException
      Retrieve all benefit assessments.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJob

      public BenefitAssessmentJob getRoutingAssessmentsJob(String jobId) throws IOException, ApiException
      Retrieve a single benefit assessments job.
      Parameters:
      jobId - Benefit Assessment Job ID (required)
      Returns:
      BenefitAssessmentJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJobWithHttpInfo

      public ApiResponse<BenefitAssessmentJob> getRoutingAssessmentsJobWithHttpInfo(String jobId) throws IOException
      Retrieve a single benefit assessments job.
      Parameters:
      jobId - Benefit Assessment Job ID (required)
      Returns:
      BenefitAssessmentJob
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJob

      public BenefitAssessmentJob getRoutingAssessmentsJob(GetRoutingAssessmentsJobRequest request) throws IOException, ApiException
      Retrieve a single benefit assessments job.
      Parameters:
      request - The request object
      Returns:
      BenefitAssessmentJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJob

      public ApiResponse<BenefitAssessmentJob> getRoutingAssessmentsJob(ApiRequest<Void> request) throws IOException
      Retrieve a single benefit assessments job.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJobs

      public AssessmentJobListing getRoutingAssessmentsJobs(List<String> divisionId) throws IOException, ApiException
      Retrieve all benefit assessment jobs.
      Parameters:
      divisionId - Division ID(s) to filter assessment jobs by. (optional)
      Returns:
      AssessmentJobListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJobsWithHttpInfo

      public ApiResponse<AssessmentJobListing> getRoutingAssessmentsJobsWithHttpInfo(List<String> divisionId) throws IOException
      Retrieve all benefit assessment jobs.
      Parameters:
      divisionId - Division ID(s) to filter assessment jobs by. (optional)
      Returns:
      AssessmentJobListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJobs

      public AssessmentJobListing getRoutingAssessmentsJobs(GetRoutingAssessmentsJobsRequest request) throws IOException, ApiException
      Retrieve all benefit assessment jobs.
      Parameters:
      request - The request object
      Returns:
      AssessmentJobListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAssessmentsJobs

      public ApiResponse<AssessmentJobListing> getRoutingAssessmentsJobs(ApiRequest<Void> request) throws IOException
      Retrieve all benefit assessment jobs.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAvailablemediatypes

      public AvailableMediaTypeEntityListing getRoutingAvailablemediatypes() throws IOException, ApiException
      Get available media types
      Returns:
      AvailableMediaTypeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAvailablemediatypesWithHttpInfo

      public ApiResponse<AvailableMediaTypeEntityListing> getRoutingAvailablemediatypesWithHttpInfo() throws IOException
      Get available media types
      Returns:
      AvailableMediaTypeEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingAvailablemediatypes

      public AvailableMediaTypeEntityListing getRoutingAvailablemediatypes(GetRoutingAvailablemediatypesRequest request) throws IOException, ApiException
      Get available media types
      Parameters:
      request - The request object
      Returns:
      AvailableMediaTypeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingAvailablemediatypes

      public ApiResponse<AvailableMediaTypeEntityListing> getRoutingAvailablemediatypes(ApiRequest<Void> request) throws IOException
      Get available media types
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingDirectroutingbackupSettingsMe

      public AgentDirectRoutingBackupSettings getRoutingDirectroutingbackupSettingsMe() throws IOException, ApiException
      Get the user's Direct Routing Backup settings.
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingDirectroutingbackupSettingsMeWithHttpInfo

      public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingDirectroutingbackupSettingsMeWithHttpInfo() throws IOException
      Get the user's Direct Routing Backup settings.
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      IOException - if the request fails to be processed
    • getRoutingDirectroutingbackupSettingsMe

      public AgentDirectRoutingBackupSettings getRoutingDirectroutingbackupSettingsMe(GetRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException
      Get the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingDirectroutingbackupSettingsMe

      public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingDirectroutingbackupSettingsMe(ApiRequest<Void> request) throws IOException
      Get the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomain

      public InboundDomain getRoutingEmailDomain(String domainId, String expand) throws IOException, ApiException
      Get domain
      Parameters:
      domainId - domain ID (required)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainWithHttpInfo

      public ApiResponse<InboundDomain> getRoutingEmailDomainWithHttpInfo(String domainId, String expand) throws IOException
      Get domain
      Parameters:
      domainId - domain ID (required)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      InboundDomain
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomain

      public InboundDomain getRoutingEmailDomain(GetRoutingEmailDomainRequest request) throws IOException, ApiException
      Get domain
      Parameters:
      request - The request object
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomain

      public ApiResponse<InboundDomain> getRoutingEmailDomain(ApiRequest<Void> request) throws IOException
      Get domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainDkim

      public VerificationResult getRoutingEmailDomainDkim(String domainId) throws IOException, ApiException
      Get domain dkim settings
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainDkimWithHttpInfo

      public ApiResponse<VerificationResult> getRoutingEmailDomainDkimWithHttpInfo(String domainId) throws IOException
      Get domain dkim settings
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainDkim

      public VerificationResult getRoutingEmailDomainDkim(GetRoutingEmailDomainDkimRequest request) throws IOException, ApiException
      Get domain dkim settings
      Parameters:
      request - The request object
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainDkim

      public ApiResponse<VerificationResult> getRoutingEmailDomainDkim(ApiRequest<Void> request) throws IOException
      Get domain dkim settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainMailfrom

      public MailFromResult getRoutingEmailDomainMailfrom(String domainId) throws IOException, ApiException
      Get domain mail from settings
      Parameters:
      domainId - domain ID (required)
      Returns:
      MailFromResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainMailfromWithHttpInfo

      public ApiResponse<MailFromResult> getRoutingEmailDomainMailfromWithHttpInfo(String domainId) throws IOException
      Get domain mail from settings
      Parameters:
      domainId - domain ID (required)
      Returns:
      MailFromResult
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainMailfrom

      public MailFromResult getRoutingEmailDomainMailfrom(GetRoutingEmailDomainMailfromRequest request) throws IOException, ApiException
      Get domain mail from settings
      Parameters:
      request - The request object
      Returns:
      MailFromResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainMailfrom

      public ApiResponse<MailFromResult> getRoutingEmailDomainMailfrom(ApiRequest<Void> request) throws IOException
      Get domain mail from settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRoute

      public InboundRoute getRoutingEmailDomainRoute(String domainName, String routeId, List<String> expand) throws IOException, ApiException
      Get a route
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      expand - Which fields, if any, to expand (optional)
      Returns:
      InboundRoute
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRouteWithHttpInfo

      public ApiResponse<InboundRoute> getRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId, List<String> expand) throws IOException
      Get a route
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      expand - Which fields, if any, to expand (optional)
      Returns:
      InboundRoute
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRoute

      public InboundRoute getRoutingEmailDomainRoute(GetRoutingEmailDomainRouteRequest request) throws IOException, ApiException
      Get a route
      Parameters:
      request - The request object
      Returns:
      InboundRoute
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRoute

      public ApiResponse<InboundRoute> getRoutingEmailDomainRoute(ApiRequest<Void> request) throws IOException
      Get a route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRouteIdentityresolution

      public RouteIdentityResolutionConfig getRoutingEmailDomainRouteIdentityresolution(String domainName, String routeId) throws IOException, ApiException
      Get a route identity resolution setting.
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      Returns:
      RouteIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRouteIdentityresolutionWithHttpInfo

      public ApiResponse<RouteIdentityResolutionConfig> getRoutingEmailDomainRouteIdentityresolutionWithHttpInfo(String domainName, String routeId) throws IOException
      Get a route identity resolution setting.
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      Returns:
      RouteIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRouteIdentityresolution

      public RouteIdentityResolutionConfig getRoutingEmailDomainRouteIdentityresolution(GetRoutingEmailDomainRouteIdentityresolutionRequest request) throws IOException, ApiException
      Get a route identity resolution setting.
      Parameters:
      request - The request object
      Returns:
      RouteIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRouteIdentityresolution

      public ApiResponse<RouteIdentityResolutionConfig> getRoutingEmailDomainRouteIdentityresolution(ApiRequest<Void> request) throws IOException
      Get a route identity resolution setting.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRoutes

      public InboundRouteEntityListing getRoutingEmailDomainRoutes(String domainName, Integer pageSize, Integer pageNumber, String pattern, List<String> expand) throws IOException, ApiException
      Get routes
      Parameters:
      domainName - email domain (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      pattern - Filter routes by the route's pattern property (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      InboundRouteEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRoutesWithHttpInfo

      public ApiResponse<InboundRouteEntityListing> getRoutingEmailDomainRoutesWithHttpInfo(String domainName, Integer pageSize, Integer pageNumber, String pattern, List<String> expand) throws IOException
      Get routes
      Parameters:
      domainName - email domain (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      pattern - Filter routes by the route's pattern property (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      InboundRouteEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRoutes

      public InboundRouteEntityListing getRoutingEmailDomainRoutes(GetRoutingEmailDomainRoutesRequest request) throws IOException, ApiException
      Get routes
      Parameters:
      request - The request object
      Returns:
      InboundRouteEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainRoutes

      public ApiResponse<InboundRouteEntityListing> getRoutingEmailDomainRoutes(ApiRequest<Void> request) throws IOException
      Get routes
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainVerification

      public VerificationResult getRoutingEmailDomainVerification(String domainId) throws IOException, ApiException
      Get domain verification settings
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainVerificationWithHttpInfo

      public ApiResponse<VerificationResult> getRoutingEmailDomainVerificationWithHttpInfo(String domainId) throws IOException
      Get domain verification settings
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomainVerification

      public VerificationResult getRoutingEmailDomainVerification(GetRoutingEmailDomainVerificationRequest request) throws IOException, ApiException
      Get domain verification settings
      Parameters:
      request - The request object
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainVerification

      public ApiResponse<VerificationResult> getRoutingEmailDomainVerification(ApiRequest<Void> request) throws IOException
      Get domain verification settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomains

      public InboundDomainEntityListing getRoutingEmailDomains(Integer pageSize, Integer pageNumber, Boolean excludeStatus, String filter, String expand) throws IOException, ApiException
      Get domains
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      excludeStatus - Exclude MX record data (optional, default to false)
      filter - Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      InboundDomainEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomainsWithHttpInfo

      public ApiResponse<InboundDomainEntityListing> getRoutingEmailDomainsWithHttpInfo(Integer pageSize, Integer pageNumber, Boolean excludeStatus, String filter, String expand) throws IOException
      Get domains
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      excludeStatus - Exclude MX record data (optional, default to false)
      filter - Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      InboundDomainEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailDomains

      public InboundDomainEntityListing getRoutingEmailDomains(GetRoutingEmailDomainsRequest request) throws IOException, ApiException
      Get domains
      Parameters:
      request - The request object
      Returns:
      InboundDomainEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailDomains

      public ApiResponse<InboundDomainEntityListing> getRoutingEmailDomains(ApiRequest<Void> request) throws IOException
      Get domains
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomain

      public OutboundDomain getRoutingEmailOutboundDomain(String domainId, String expand) throws IOException, ApiException
      Get domain
      Parameters:
      domainId - domain ID (required)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      OutboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomainWithHttpInfo

      public ApiResponse<OutboundDomain> getRoutingEmailOutboundDomainWithHttpInfo(String domainId, String expand) throws IOException
      Get domain
      Parameters:
      domainId - domain ID (required)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      OutboundDomain
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomain

      public OutboundDomain getRoutingEmailOutboundDomain(GetRoutingEmailOutboundDomainRequest request) throws IOException, ApiException
      Get domain
      Parameters:
      request - The request object
      Returns:
      OutboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomain

      public ApiResponse<OutboundDomain> getRoutingEmailOutboundDomain(ApiRequest<Void> request) throws IOException
      Get domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomainActivation

      public EmailOutboundDomainResult getRoutingEmailOutboundDomainActivation(String domainId) throws IOException, ApiException
      Get activation status (cname + dkim) of an outbound domain
      Parameters:
      domainId - domain ID (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomainActivationWithHttpInfo

      public ApiResponse<EmailOutboundDomainResult> getRoutingEmailOutboundDomainActivationWithHttpInfo(String domainId) throws IOException
      Get activation status (cname + dkim) of an outbound domain
      Parameters:
      domainId - domain ID (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomainActivation

      public EmailOutboundDomainResult getRoutingEmailOutboundDomainActivation(GetRoutingEmailOutboundDomainActivationRequest request) throws IOException, ApiException
      Get activation status (cname + dkim) of an outbound domain
      Parameters:
      request - The request object
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomainActivation

      public ApiResponse<EmailOutboundDomainResult> getRoutingEmailOutboundDomainActivation(ApiRequest<Void> request) throws IOException
      Get activation status (cname + dkim) of an outbound domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomains

      public OutboundDomainEntityListing getRoutingEmailOutboundDomains(Integer pageSize, Integer pageNumber, String filter, String expand) throws IOException, ApiException
      Get outbound domains
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filter - Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      OutboundDomainEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomainsWithHttpInfo

      public ApiResponse<OutboundDomainEntityListing> getRoutingEmailOutboundDomainsWithHttpInfo(Integer pageSize, Integer pageNumber, String filter, String expand) throws IOException
      Get outbound domains
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      filter - Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter. (optional)
      expand - Expand options. Valid values: settings (optional)
      Returns:
      OutboundDomainEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomains

      public OutboundDomainEntityListing getRoutingEmailOutboundDomains(GetRoutingEmailOutboundDomainsRequest request) throws IOException, ApiException
      Get outbound domains
      Parameters:
      request - The request object
      Returns:
      OutboundDomainEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailOutboundDomains

      public ApiResponse<OutboundDomainEntityListing> getRoutingEmailOutboundDomains(ApiRequest<Void> request) throws IOException
      Get outbound domains
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailSetting

      public EmailSettingEntityListing getRoutingEmailSetting(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get a paged list of email routing settings.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      EmailSettingEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailSettingWithHttpInfo

      public ApiResponse<EmailSettingEntityListing> getRoutingEmailSettingWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Get a paged list of email routing settings.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      EmailSettingEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailSetting

      public EmailSettingEntityListing getRoutingEmailSetting(GetRoutingEmailSettingRequest request) throws IOException, ApiException
      Get a paged list of email routing settings.
      Parameters:
      request - The request object
      Returns:
      EmailSettingEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailSetting

      public ApiResponse<EmailSettingEntityListing> getRoutingEmailSetting(ApiRequest<Void> request) throws IOException
      Get a paged list of email routing settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailSettingEmailSettingId

      public EmailSetting getRoutingEmailSettingEmailSettingId(String emailSettingId) throws IOException, ApiException
      Get email setting. Returns the specified email setting that defines settings for email
      Parameters:
      emailSettingId - Email Setting ID (required)
      Returns:
      EmailSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailSettingEmailSettingIdWithHttpInfo

      public ApiResponse<EmailSetting> getRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId) throws IOException
      Get email setting. Returns the specified email setting that defines settings for email
      Parameters:
      emailSettingId - Email Setting ID (required)
      Returns:
      EmailSetting
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailSettingEmailSettingId

      public EmailSetting getRoutingEmailSettingEmailSettingId(GetRoutingEmailSettingEmailSettingIdRequest request) throws IOException, ApiException
      Get email setting. Returns the specified email setting that defines settings for email
      Parameters:
      request - The request object
      Returns:
      EmailSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailSettingEmailSettingId

      public ApiResponse<EmailSetting> getRoutingEmailSettingEmailSettingId(ApiRequest<Void> request) throws IOException
      Get email setting. Returns the specified email setting that defines settings for email
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailSetup

      public EmailSetup getRoutingEmailSetup() throws IOException, ApiException
      Get email setup
      Returns:
      EmailSetup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailSetupWithHttpInfo

      public ApiResponse<EmailSetup> getRoutingEmailSetupWithHttpInfo() throws IOException
      Get email setup
      Returns:
      EmailSetup
      Throws:
      IOException - if the request fails to be processed
    • getRoutingEmailSetup

      public EmailSetup getRoutingEmailSetup(GetRoutingEmailSetupRequest request) throws IOException, ApiException
      Get email setup
      Parameters:
      request - The request object
      Returns:
      EmailSetup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingEmailSetup

      public ApiResponse<EmailSetup> getRoutingEmailSetup(ApiRequest<Void> request) throws IOException
      Get email setup
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingLanguage

      public Language getRoutingLanguage(String languageId) throws IOException, ApiException
      Get a routing language
      Parameters:
      languageId - Language ID (required)
      Returns:
      Language
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingLanguageWithHttpInfo

      public ApiResponse<Language> getRoutingLanguageWithHttpInfo(String languageId) throws IOException
      Get a routing language
      Parameters:
      languageId - Language ID (required)
      Returns:
      Language
      Throws:
      IOException - if the request fails to be processed
    • getRoutingLanguage

      public Language getRoutingLanguage(GetRoutingLanguageRequest request) throws IOException, ApiException
      Get a routing language
      Parameters:
      request - The request object
      Returns:
      Language
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingLanguage

      public ApiResponse<Language> getRoutingLanguage(ApiRequest<Void> request) throws IOException
      Get a routing language
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingLanguages

      public LanguageEntityListing getRoutingLanguages(Integer pageSize, Integer pageNumber, String sortOrder, String name, List<String> id) throws IOException, ApiException
      Get the list of supported languages.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      name - Name (optional)
      id - id (optional)
      Returns:
      LanguageEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingLanguagesWithHttpInfo

      public ApiResponse<LanguageEntityListing> getRoutingLanguagesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder, String name, List<String> id) throws IOException
      Get the list of supported languages.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      name - Name (optional)
      id - id (optional)
      Returns:
      LanguageEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingLanguages

      public LanguageEntityListing getRoutingLanguages(GetRoutingLanguagesRequest request) throws IOException, ApiException
      Get the list of supported languages.
      Parameters:
      request - The request object
      Returns:
      LanguageEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingLanguages

      public ApiResponse<LanguageEntityListing> getRoutingLanguages(ApiRequest<Void> request) throws IOException
      Get the list of supported languages.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingMessageRecipient

      public Recipient getRoutingMessageRecipient(String recipientId) throws IOException, ApiException
      Get a recipient
      Parameters:
      recipientId - Recipient ID (required)
      Returns:
      Recipient
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingMessageRecipientWithHttpInfo

      public ApiResponse<Recipient> getRoutingMessageRecipientWithHttpInfo(String recipientId) throws IOException
      Get a recipient
      Parameters:
      recipientId - Recipient ID (required)
      Returns:
      Recipient
      Throws:
      IOException - if the request fails to be processed
    • getRoutingMessageRecipient

      public Recipient getRoutingMessageRecipient(GetRoutingMessageRecipientRequest request) throws IOException, ApiException
      Get a recipient
      Parameters:
      request - The request object
      Returns:
      Recipient
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingMessageRecipient

      public ApiResponse<Recipient> getRoutingMessageRecipient(ApiRequest<Void> request) throws IOException
      Get a recipient
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingMessageRecipients

      public RecipientListing getRoutingMessageRecipients(String messengerType, String name, Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get recipients
      Parameters:
      messengerType - Messenger Type (optional)
      name - Recipient Name (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      RecipientListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingMessageRecipientsWithHttpInfo

      public ApiResponse<RecipientListing> getRoutingMessageRecipientsWithHttpInfo(String messengerType, String name, Integer pageSize, Integer pageNumber) throws IOException
      Get recipients
      Parameters:
      messengerType - Messenger Type (optional)
      name - Recipient Name (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      RecipientListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingMessageRecipients

      public RecipientListing getRoutingMessageRecipients(GetRoutingMessageRecipientsRequest request) throws IOException, ApiException
      Get recipients
      Parameters:
      request - The request object
      Returns:
      RecipientListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingMessageRecipients

      public ApiResponse<RecipientListing> getRoutingMessageRecipients(ApiRequest<Void> request) throws IOException
      Get recipients
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictor

      public Predictor getRoutingPredictor(String predictorId) throws IOException, ApiException
      Retrieve a single predictor.
      Parameters:
      predictorId - Predictor ID (required)
      Returns:
      Predictor
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorWithHttpInfo

      public ApiResponse<Predictor> getRoutingPredictorWithHttpInfo(String predictorId) throws IOException
      Retrieve a single predictor.
      Parameters:
      predictorId - Predictor ID (required)
      Returns:
      Predictor
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictor

      public Predictor getRoutingPredictor(GetRoutingPredictorRequest request) throws IOException, ApiException
      Retrieve a single predictor.
      Parameters:
      request - The request object
      Returns:
      Predictor
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictor

      public ApiResponse<Predictor> getRoutingPredictor(ApiRequest<Void> request) throws IOException
      Retrieve a single predictor.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorModelFeatures

      public PredictorModelFeatureListing getRoutingPredictorModelFeatures(String predictorId, String modelId) throws IOException, ApiException
      Retrieve Predictor Model Features.
      Parameters:
      predictorId - Predictor ID (required)
      modelId - Model ID (required)
      Returns:
      PredictorModelFeatureListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorModelFeaturesWithHttpInfo

      public ApiResponse<PredictorModelFeatureListing> getRoutingPredictorModelFeaturesWithHttpInfo(String predictorId, String modelId) throws IOException
      Retrieve Predictor Model Features.
      Parameters:
      predictorId - Predictor ID (required)
      modelId - Model ID (required)
      Returns:
      PredictorModelFeatureListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorModelFeatures

      public PredictorModelFeatureListing getRoutingPredictorModelFeatures(GetRoutingPredictorModelFeaturesRequest request) throws IOException, ApiException
      Retrieve Predictor Model Features.
      Parameters:
      request - The request object
      Returns:
      PredictorModelFeatureListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorModelFeatures

      public ApiResponse<PredictorModelFeatureListing> getRoutingPredictorModelFeatures(ApiRequest<Void> request) throws IOException
      Retrieve Predictor Model Features.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorModels

      public PredictorModels getRoutingPredictorModels(String predictorId) throws IOException, ApiException
      Retrieve Predictor Models and Top Features.
      Parameters:
      predictorId - Predictor ID (required)
      Returns:
      PredictorModels
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorModelsWithHttpInfo

      public ApiResponse<PredictorModels> getRoutingPredictorModelsWithHttpInfo(String predictorId) throws IOException
      Retrieve Predictor Models and Top Features.
      Parameters:
      predictorId - Predictor ID (required)
      Returns:
      PredictorModels
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorModels

      public PredictorModels getRoutingPredictorModels(GetRoutingPredictorModelsRequest request) throws IOException, ApiException
      Retrieve Predictor Models and Top Features.
      Parameters:
      request - The request object
      Returns:
      PredictorModels
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorModels

      public ApiResponse<PredictorModels> getRoutingPredictorModels(ApiRequest<Void> request) throws IOException
      Retrieve Predictor Models and Top Features.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictors

      public PredictorListing getRoutingPredictors(String before, String after, String limit, String pageSize, List<String> queueId, String kpiId, String state) throws IOException, ApiException
      Retrieve all predictors.
      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)
      limit - Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      queueId - Comma-separated list of queue Ids to filter by. (optional)
      kpiId - Standard or custom KPI id used to filter predictors. (optional)
      state - The state used to filter predictors. (optional)
      Returns:
      PredictorListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorsWithHttpInfo

      public ApiResponse<PredictorListing> getRoutingPredictorsWithHttpInfo(String before, String after, String limit, String pageSize, List<String> queueId, String kpiId, String state) throws IOException
      Retrieve all predictors.
      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)
      limit - Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      queueId - Comma-separated list of queue Ids to filter by. (optional)
      kpiId - Standard or custom KPI id used to filter predictors. (optional)
      state - The state used to filter predictors. (optional)
      Returns:
      PredictorListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictors

      public PredictorListing getRoutingPredictors(GetRoutingPredictorsRequest request) throws IOException, ApiException
      Retrieve all predictors.
      Parameters:
      request - The request object
      Returns:
      PredictorListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictors

      public ApiResponse<PredictorListing> getRoutingPredictors(ApiRequest<Void> request) throws IOException
      Retrieve all predictors.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicator

      public KeyPerformanceIndicator getRoutingPredictorsKeyperformanceindicator(String kpiId, List<String> expand) throws IOException, ApiException
      Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      kpiId - Key Performance Indicator ID (required)
      expand - Parameter to request additional data to return in KPI payload (optional)
      Returns:
      KeyPerformanceIndicator
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicatorWithHttpInfo

      public ApiResponse<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicatorWithHttpInfo(String kpiId, List<String> expand) throws IOException
      Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      kpiId - Key Performance Indicator ID (required)
      expand - Parameter to request additional data to return in KPI payload (optional)
      Returns:
      KeyPerformanceIndicator
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicator

      public KeyPerformanceIndicator getRoutingPredictorsKeyperformanceindicator(GetRoutingPredictorsKeyperformanceindicatorRequest request) throws IOException, ApiException
      Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator 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:
      KeyPerformanceIndicator
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicator

      public ApiResponse<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicator(ApiRequest<Void> request) throws IOException
      Retrieve a single Key Performance Indicator. getRoutingPredictorsKeyperformanceindicator 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
    • getRoutingPredictorsKeyperformanceindicators

      public List<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicators(String kpiGroup, List<String> expand) throws IOException, ApiException
      Get a list of Key Performance Indicators
      Parameters:
      kpiGroup - The Group of Key Performance Indicators to return (optional)
      expand - Parameter to request additional data to return in KPI payload (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicatorsWithHttpInfo

      public ApiResponse<List<KeyPerformanceIndicator>> getRoutingPredictorsKeyperformanceindicatorsWithHttpInfo(String kpiGroup, List<String> expand) throws IOException
      Get a list of Key Performance Indicators
      Parameters:
      kpiGroup - The Group of Key Performance Indicators to return (optional)
      expand - Parameter to request additional data to return in KPI payload (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicators

      public List<KeyPerformanceIndicator> getRoutingPredictorsKeyperformanceindicators(GetRoutingPredictorsKeyperformanceindicatorsRequest request) throws IOException, ApiException
      Get a list of Key Performance Indicators
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicators

      public ApiResponse<List<KeyPerformanceIndicator>> getRoutingPredictorsKeyperformanceindicators(ApiRequest<Void> request) throws IOException
      Get a list of Key Performance Indicators
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicatortypes

      public List<KeyPerformanceIndicatorType> getRoutingPredictorsKeyperformanceindicatortypes() throws IOException, ApiException
      Get a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicatortypesWithHttpInfo

      public ApiResponse<List<KeyPerformanceIndicatorType>> getRoutingPredictorsKeyperformanceindicatortypesWithHttpInfo() throws IOException
      Get a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicatortypes

      public List<KeyPerformanceIndicatorType> getRoutingPredictorsKeyperformanceindicatortypes(GetRoutingPredictorsKeyperformanceindicatortypesRequest request) throws IOException, ApiException
      Get a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes 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:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingPredictorsKeyperformanceindicatortypes

      public ApiResponse<List<KeyPerformanceIndicatorType>> getRoutingPredictorsKeyperformanceindicatortypes(ApiRequest<Void> request) throws IOException
      Get a list of Key Performance Indicators Types available. getRoutingPredictorsKeyperformanceindicatortypes 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
    • getRoutingQueue

      public Queue getRoutingQueue(String queueId, List<String> expand) throws IOException, ApiException
      Get details about this queue.
      Parameters:
      queueId - Queue ID (required)
      expand - Which fields, if any, to expand (optional)
      Returns:
      Queue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueWithHttpInfo

      public ApiResponse<Queue> getRoutingQueueWithHttpInfo(String queueId, List<String> expand) throws IOException
      Get details about this queue.
      Parameters:
      queueId - Queue ID (required)
      expand - Which fields, if any, to expand (optional)
      Returns:
      Queue
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueue

      public Queue getRoutingQueue(GetRoutingQueueRequest request) throws IOException, ApiException
      Get details about this queue.
      Parameters:
      request - The request object
      Returns:
      Queue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueue

      public ApiResponse<Queue> getRoutingQueue(ApiRequest<Void> request) throws IOException
      Get details about this queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueAssistant

      public AssistantQueue getRoutingQueueAssistant(String queueId, List<String> expand, String languageVariation, Boolean fallbackToPrimaryAssistant) throws IOException, ApiException
      Get an assistant associated with a queue.
      Parameters:
      queueId - Queue ID (required)
      expand - Which fields, if any, to expand. (optional)
      languageVariation - Language variation (optional)
      fallbackToPrimaryAssistant - Fall back to primary assistant if specified variation is not found (optional)
      Returns:
      AssistantQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueAssistantWithHttpInfo

      public ApiResponse<AssistantQueue> getRoutingQueueAssistantWithHttpInfo(String queueId, List<String> expand, String languageVariation, Boolean fallbackToPrimaryAssistant) throws IOException
      Get an assistant associated with a queue.
      Parameters:
      queueId - Queue ID (required)
      expand - Which fields, if any, to expand. (optional)
      languageVariation - Language variation (optional)
      fallbackToPrimaryAssistant - Fall back to primary assistant if specified variation is not found (optional)
      Returns:
      AssistantQueue
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueAssistant

      public AssistantQueue getRoutingQueueAssistant(GetRoutingQueueAssistantRequest request) throws IOException, ApiException
      Get an assistant associated with a queue.
      Parameters:
      request - The request object
      Returns:
      AssistantQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueAssistant

      public ApiResponse<AssistantQueue> getRoutingQueueAssistant(ApiRequest<Void> request) throws IOException
      Get an assistant associated with a queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiod

      public ComparisonPeriod getRoutingQueueComparisonperiod(String queueId, String comparisonPeriodId) throws IOException, ApiException
      Get a Comparison Period.
      Parameters:
      queueId - Queue id (required)
      comparisonPeriodId - ComparisonPeriod id (required)
      Returns:
      ComparisonPeriod
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiodWithHttpInfo

      public ApiResponse<ComparisonPeriod> getRoutingQueueComparisonperiodWithHttpInfo(String queueId, String comparisonPeriodId) throws IOException
      Get a Comparison Period.
      Parameters:
      queueId - Queue id (required)
      comparisonPeriodId - ComparisonPeriod id (required)
      Returns:
      ComparisonPeriod
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiod

      public ComparisonPeriod getRoutingQueueComparisonperiod(GetRoutingQueueComparisonperiodRequest request) throws IOException, ApiException
      Get a Comparison Period.
      Parameters:
      request - The request object
      Returns:
      ComparisonPeriod
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiod

      public ApiResponse<ComparisonPeriod> getRoutingQueueComparisonperiod(ApiRequest<Void> request) throws IOException
      Get a Comparison Period.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiods

      public ComparisonPeriodListing getRoutingQueueComparisonperiods(String queueId) throws IOException, ApiException
      Get list of comparison periods
      Parameters:
      queueId - Queue id (required)
      Returns:
      ComparisonPeriodListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiodsWithHttpInfo

      public ApiResponse<ComparisonPeriodListing> getRoutingQueueComparisonperiodsWithHttpInfo(String queueId) throws IOException
      Get list of comparison periods
      Parameters:
      queueId - Queue id (required)
      Returns:
      ComparisonPeriodListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiods

      public ComparisonPeriodListing getRoutingQueueComparisonperiods(GetRoutingQueueComparisonperiodsRequest request) throws IOException, ApiException
      Get list of comparison periods
      Parameters:
      request - The request object
      Returns:
      ComparisonPeriodListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueComparisonperiods

      public ApiResponse<ComparisonPeriodListing> getRoutingQueueComparisonperiods(ApiRequest<Void> request) throws IOException
      Get list of comparison periods
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueEstimatedwaittime

      public EstimatedWaitTimePredictions getRoutingQueueEstimatedwaittime(String queueId, String conversationId) throws IOException, ApiException
      Get Estimated Wait Time
      Parameters:
      queueId - queueId (required)
      conversationId - conversationId (optional)
      Returns:
      EstimatedWaitTimePredictions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueEstimatedwaittimeWithHttpInfo

      public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueEstimatedwaittimeWithHttpInfo(String queueId, String conversationId) throws IOException
      Get Estimated Wait Time
      Parameters:
      queueId - queueId (required)
      conversationId - conversationId (optional)
      Returns:
      EstimatedWaitTimePredictions
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueEstimatedwaittime

      public EstimatedWaitTimePredictions getRoutingQueueEstimatedwaittime(GetRoutingQueueEstimatedwaittimeRequest request) throws IOException, ApiException
      Get Estimated Wait Time
      Parameters:
      request - The request object
      Returns:
      EstimatedWaitTimePredictions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueEstimatedwaittime

      public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueEstimatedwaittime(ApiRequest<Void> request) throws IOException
      Get Estimated Wait Time
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueIdentityresolution

      public IdentityResolutionQueueConfig getRoutingQueueIdentityresolution(String queueId) throws IOException, ApiException
      Get Queue IdentityResolution Settings.
      Parameters:
      queueId - Queue ID (required)
      Returns:
      IdentityResolutionQueueConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueIdentityresolutionWithHttpInfo

      public ApiResponse<IdentityResolutionQueueConfig> getRoutingQueueIdentityresolutionWithHttpInfo(String queueId) throws IOException
      Get Queue IdentityResolution Settings.
      Parameters:
      queueId - Queue ID (required)
      Returns:
      IdentityResolutionQueueConfig
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueIdentityresolution

      public IdentityResolutionQueueConfig getRoutingQueueIdentityresolution(GetRoutingQueueIdentityresolutionRequest request) throws IOException, ApiException
      Get Queue IdentityResolution Settings.
      Parameters:
      request - The request object
      Returns:
      IdentityResolutionQueueConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueIdentityresolution

      public ApiResponse<IdentityResolutionQueueConfig> getRoutingQueueIdentityresolution(ApiRequest<Void> request) throws IOException
      Get Queue IdentityResolution Settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueMediatypeEstimatedwaittime

      public EstimatedWaitTimePredictions getRoutingQueueMediatypeEstimatedwaittime(String queueId, String mediaType, String labelId) throws IOException, ApiException
      Get Estimated Wait Time
      Parameters:
      queueId - queueId (required)
      mediaType - mediaType (required)
      labelId - Unique id that represents the interaction label used with media type for EWT calculation (optional)
      Returns:
      EstimatedWaitTimePredictions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueMediatypeEstimatedwaittimeWithHttpInfo

      public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueMediatypeEstimatedwaittimeWithHttpInfo(String queueId, String mediaType, String labelId) throws IOException
      Get Estimated Wait Time
      Parameters:
      queueId - queueId (required)
      mediaType - mediaType (required)
      labelId - Unique id that represents the interaction label used with media type for EWT calculation (optional)
      Returns:
      EstimatedWaitTimePredictions
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueMediatypeEstimatedwaittime

      public EstimatedWaitTimePredictions getRoutingQueueMediatypeEstimatedwaittime(GetRoutingQueueMediatypeEstimatedwaittimeRequest request) throws IOException, ApiException
      Get Estimated Wait Time
      Parameters:
      request - The request object
      Returns:
      EstimatedWaitTimePredictions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueMediatypeEstimatedwaittime

      public ApiResponse<EstimatedWaitTimePredictions> getRoutingQueueMediatypeEstimatedwaittime(ApiRequest<Void> request) throws IOException
      Get Estimated Wait Time
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueMembers

      public QueueMemberEntityListing getRoutingQueueMembers(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence, String memberBy, Boolean joined) throws IOException, ApiException
      Get the members of this queue.
      Parameters:
      queueId - Queue ID (required)
      pageNumber - (optional, default to 1)
      pageSize - Max value is 100 (optional, default to 25)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      expand - Which fields, if any, to expand. (optional)
      name - Filter by queue member name (contains-style search) (optional)
      profileSkills - Filter by profile skill (contains-style search) (optional)
      skills - Filter by skill (contains-style search) (optional)
      languages - Filter by language (contains-style search) (optional)
      routingStatus - Filter by routing status (optional)
      presence - Filter by presence (optional)
      memberBy - Filter by member type (optional)
      joined - Filter by joined status (optional)
      Returns:
      QueueMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueMembersWithHttpInfo

      public ApiResponse<QueueMemberEntityListing> getRoutingQueueMembersWithHttpInfo(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence, String memberBy, Boolean joined) throws IOException
      Get the members of this queue.
      Parameters:
      queueId - Queue ID (required)
      pageNumber - (optional, default to 1)
      pageSize - Max value is 100 (optional, default to 25)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      expand - Which fields, if any, to expand. (optional)
      name - Filter by queue member name (contains-style search) (optional)
      profileSkills - Filter by profile skill (contains-style search) (optional)
      skills - Filter by skill (contains-style search) (optional)
      languages - Filter by language (contains-style search) (optional)
      routingStatus - Filter by routing status (optional)
      presence - Filter by presence (optional)
      memberBy - Filter by member type (optional)
      joined - Filter by joined status (optional)
      Returns:
      QueueMemberEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueMembers

      public QueueMemberEntityListing getRoutingQueueMembers(GetRoutingQueueMembersRequest request) throws IOException, ApiException
      Get the members of this queue.
      Parameters:
      request - The request object
      Returns:
      QueueMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueMembers

      public ApiResponse<QueueMemberEntityListing> getRoutingQueueMembers(ApiRequest<Void> request) throws IOException
      Get the members of this queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueUsers

      public QueueMemberEntityListingV1 getRoutingQueueUsers(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, Boolean joined, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.
      Parameters:
      queueId - Queue ID (required)
      pageNumber - (optional, default to 1)
      pageSize - Max value is 100 (optional, default to 25)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      expand - Which fields, if any, to expand. (optional)
      joined - Filter by joined status (optional)
      name - Filter by queue member name (optional)
      profileSkills - Filter by profile skill (optional)
      skills - Filter by skill (optional)
      languages - Filter by language (optional)
      routingStatus - Filter by routing status (optional)
      presence - Filter by presence (optional)
      Returns:
      QueueMemberEntityListingV1
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueUsersWithHttpInfo

      public ApiResponse<QueueMemberEntityListingV1> getRoutingQueueUsersWithHttpInfo(String queueId, Integer pageNumber, Integer pageSize, String sortOrder, List<String> expand, Boolean joined, String name, List<String> profileSkills, List<String> skills, List<String> languages, List<String> routingStatus, List<String> presence) throws IOException
      Deprecated.
      DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.
      Parameters:
      queueId - Queue ID (required)
      pageNumber - (optional, default to 1)
      pageSize - Max value is 100 (optional, default to 25)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      expand - Which fields, if any, to expand. (optional)
      joined - Filter by joined status (optional)
      name - Filter by queue member name (optional)
      profileSkills - Filter by profile skill (optional)
      skills - Filter by skill (optional)
      languages - Filter by language (optional)
      routingStatus - Filter by routing status (optional)
      presence - Filter by presence (optional)
      Returns:
      QueueMemberEntityListingV1
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueUsers

      public QueueMemberEntityListingV1 getRoutingQueueUsers(GetRoutingQueueUsersRequest request) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.
      Parameters:
      request - The request object
      Returns:
      QueueMemberEntityListingV1
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueUsers

      public ApiResponse<QueueMemberEntityListingV1> getRoutingQueueUsers(ApiRequest<Void> request) throws IOException
      Deprecated.
      DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueWrapupcodes

      public WrapupCodeEntityListing getRoutingQueueWrapupcodes(String queueId, Integer pageSize, Integer pageNumber, String name) throws IOException, ApiException
      Get the wrap-up codes for a queue
      Parameters:
      queueId - Queue ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      name - Wrapup code's name (trailing asterisks allowed) (optional)
      Returns:
      WrapupCodeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueWrapupcodesWithHttpInfo

      public ApiResponse<WrapupCodeEntityListing> getRoutingQueueWrapupcodesWithHttpInfo(String queueId, Integer pageSize, Integer pageNumber, String name) throws IOException
      Get the wrap-up codes for a queue
      Parameters:
      queueId - Queue ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      name - Wrapup code's name (trailing asterisks allowed) (optional)
      Returns:
      WrapupCodeEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueueWrapupcodes

      public WrapupCodeEntityListing getRoutingQueueWrapupcodes(GetRoutingQueueWrapupcodesRequest request) throws IOException, ApiException
      Get the wrap-up codes for a queue
      Parameters:
      request - The request object
      Returns:
      WrapupCodeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueueWrapupcodes

      public ApiResponse<WrapupCodeEntityListing> getRoutingQueueWrapupcodes(ApiRequest<Void> request) throws IOException
      Get the wrap-up codes for a queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueues

      public QueueEntityListing getRoutingQueues(Integer pageNumber, Integer pageSize, String sortOrder, String name, List<String> id, List<String> divisionId, List<String> peerId, String cannedResponseLibraryId, Boolean hasPeer, List<String> expand) throws IOException, ApiException
      Get list of queues.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      name - Include only queues with the given name (leading and trailing asterisks allowed) (optional)
      id - Include only queues with the specified ID(s) (optional)
      divisionId - Include only queues in the specified division ID(s) (optional)
      peerId - Include only queues with the specified peer ID(s) (optional)
      cannedResponseLibraryId - Include only queues explicitly associated with the specified canned response library ID (optional)
      hasPeer - Include only queues with a peer ID (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      QueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueuesWithHttpInfo

      public ApiResponse<QueueEntityListing> getRoutingQueuesWithHttpInfo(Integer pageNumber, Integer pageSize, String sortOrder, String name, List<String> id, List<String> divisionId, List<String> peerId, String cannedResponseLibraryId, Boolean hasPeer, List<String> expand) throws IOException
      Get list of queues.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      name - Include only queues with the given name (leading and trailing asterisks allowed) (optional)
      id - Include only queues with the specified ID(s) (optional)
      divisionId - Include only queues in the specified division ID(s) (optional)
      peerId - Include only queues with the specified peer ID(s) (optional)
      cannedResponseLibraryId - Include only queues explicitly associated with the specified canned response library ID (optional)
      hasPeer - Include only queues with a peer ID (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      QueueEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueues

      public QueueEntityListing getRoutingQueues(GetRoutingQueuesRequest request) throws IOException, ApiException
      Get list of queues.
      Parameters:
      request - The request object
      Returns:
      QueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueues

      public ApiResponse<QueueEntityListing> getRoutingQueues(ApiRequest<Void> request) throws IOException
      Get list of queues.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviews

      public QueueEntityListing getRoutingQueuesDivisionviews(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException, ApiException
      Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
      Parameters:
      pageSize - Page size [max value is 100] (optional, default to 25)
      pageNumber - Page number [max value is 5] (optional, default to 1)
      sortBy - Sort by (optional, default to name)
      sortOrder - Sort order (optional, default to asc)
      name - Name (optional)
      id - Queue ID(s) (optional)
      divisionId - Division ID(s). Including '*' will query for all divisions (optional)
      Returns:
      QueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviewsWithHttpInfo

      public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException
      Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
      Parameters:
      pageSize - Page size [max value is 100] (optional, default to 25)
      pageNumber - Page number [max value is 5] (optional, default to 1)
      sortBy - Sort by (optional, default to name)
      sortOrder - Sort order (optional, default to asc)
      name - Name (optional)
      id - Queue ID(s) (optional)
      divisionId - Division ID(s). Including '*' will query for all divisions (optional)
      Returns:
      QueueEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviews

      public QueueEntityListing getRoutingQueuesDivisionviews(GetRoutingQueuesDivisionviewsRequest request) throws IOException, ApiException
      Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
      Parameters:
      request - The request object
      Returns:
      QueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviews

      public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviews(ApiRequest<Void> request) throws IOException
      Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviewsAll

      public QueueEntityListing getRoutingQueuesDivisionviewsAll(Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException
      Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
      Parameters:
      pageSize - Page size [max value is 500] (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order (optional, default to asc)
      Returns:
      QueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviewsAllWithHttpInfo

      public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviewsAllWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder) throws IOException
      Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
      Parameters:
      pageSize - Page size [max value is 500] (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order (optional, default to asc)
      Returns:
      QueueEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviewsAll

      public QueueEntityListing getRoutingQueuesDivisionviewsAll(GetRoutingQueuesDivisionviewsAllRequest request) throws IOException, ApiException
      Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
      Parameters:
      request - The request object
      Returns:
      QueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueuesDivisionviewsAll

      public ApiResponse<QueueEntityListing> getRoutingQueuesDivisionviewsAll(ApiRequest<Void> request) throws IOException
      Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueuesMe

      public UserQueueEntityListing getRoutingQueuesMe(Integer pageNumber, Integer pageSize, Boolean joined, String sortOrder) throws IOException, ApiException
      Get a paged listing of queues the user is a member of.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      joined - Filter by joined status. (optional)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      Returns:
      UserQueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueuesMeWithHttpInfo

      public ApiResponse<UserQueueEntityListing> getRoutingQueuesMeWithHttpInfo(Integer pageNumber, Integer pageSize, Boolean joined, String sortOrder) throws IOException
      Get a paged listing of queues the user is a member of.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      joined - Filter by joined status. (optional)
      sortOrder - Note: results are sorted by name. (optional, default to asc)
      Returns:
      UserQueueEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingQueuesMe

      public UserQueueEntityListing getRoutingQueuesMe(GetRoutingQueuesMeRequest request) throws IOException, ApiException
      Get a paged listing of queues the user is a member of.
      Parameters:
      request - The request object
      Returns:
      UserQueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingQueuesMe

      public ApiResponse<UserQueueEntityListing> getRoutingQueuesMe(ApiRequest<Void> request) throws IOException
      Get a paged listing of queues the user is a member of.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSettings

      public RoutingSettings getRoutingSettings() throws IOException, ApiException
      Get an organization's routing settings
      Returns:
      RoutingSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSettingsWithHttpInfo

      public ApiResponse<RoutingSettings> getRoutingSettingsWithHttpInfo() throws IOException
      Get an organization's routing settings
      Returns:
      RoutingSettings
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSettings

      public RoutingSettings getRoutingSettings(GetRoutingSettingsRequest request) throws IOException, ApiException
      Get an organization's routing settings
      Parameters:
      request - The request object
      Returns:
      RoutingSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSettings

      public ApiResponse<RoutingSettings> getRoutingSettings(ApiRequest<Void> request) throws IOException
      Get an organization's routing settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSettingsContactcenter

      public ContactCenterSettings getRoutingSettingsContactcenter() throws IOException, ApiException
      Get Contact Center Settings
      Returns:
      ContactCenterSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSettingsContactcenterWithHttpInfo

      public ApiResponse<ContactCenterSettings> getRoutingSettingsContactcenterWithHttpInfo() throws IOException
      Get Contact Center Settings
      Returns:
      ContactCenterSettings
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSettingsContactcenter

      public ContactCenterSettings getRoutingSettingsContactcenter(GetRoutingSettingsContactcenterRequest request) throws IOException, ApiException
      Get Contact Center Settings
      Parameters:
      request - The request object
      Returns:
      ContactCenterSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSettingsContactcenter

      public ApiResponse<ContactCenterSettings> getRoutingSettingsContactcenter(ApiRequest<Void> request) throws IOException
      Get Contact Center Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSettingsTranscription

      public TranscriptionSettings getRoutingSettingsTranscription() throws IOException, ApiException
      Get Transcription Settings
      Returns:
      TranscriptionSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSettingsTranscriptionWithHttpInfo

      public ApiResponse<TranscriptionSettings> getRoutingSettingsTranscriptionWithHttpInfo() throws IOException
      Get Transcription Settings
      Returns:
      TranscriptionSettings
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSettingsTranscription

      public TranscriptionSettings getRoutingSettingsTranscription(GetRoutingSettingsTranscriptionRequest request) throws IOException, ApiException
      Get Transcription Settings
      Parameters:
      request - The request object
      Returns:
      TranscriptionSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSettingsTranscription

      public ApiResponse<TranscriptionSettings> getRoutingSettingsTranscription(ApiRequest<Void> request) throws IOException
      Get Transcription Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkill

      public RoutingSkill getRoutingSkill(String skillId) throws IOException, ApiException
      Get Routing Skill
      Parameters:
      skillId - Skill ID (required)
      Returns:
      RoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillWithHttpInfo

      public ApiResponse<RoutingSkill> getRoutingSkillWithHttpInfo(String skillId) throws IOException
      Get Routing Skill
      Parameters:
      skillId - Skill ID (required)
      Returns:
      RoutingSkill
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkill

      public RoutingSkill getRoutingSkill(GetRoutingSkillRequest request) throws IOException, ApiException
      Get Routing Skill
      Parameters:
      request - The request object
      Returns:
      RoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkill

      public ApiResponse<RoutingSkill> getRoutingSkill(ApiRequest<Void> request) throws IOException
      Get Routing Skill
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillexpression

      public SkillExpression getRoutingSkillexpression(String expressionId, Boolean includeArchived, String format) throws IOException, ApiException
      Get a skill expression by ID
      Parameters:
      expressionId - Expression ID (required)
      includeArchived - Include archived (optional, default to false)
      format - Response format: raw expression or normalized (optional, default to Raw)
      Returns:
      SkillExpression
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillexpressionWithHttpInfo

      public ApiResponse<SkillExpression> getRoutingSkillexpressionWithHttpInfo(String expressionId, Boolean includeArchived, String format) throws IOException
      Get a skill expression by ID
      Parameters:
      expressionId - Expression ID (required)
      includeArchived - Include archived (optional, default to false)
      format - Response format: raw expression or normalized (optional, default to Raw)
      Returns:
      SkillExpression
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillexpression

      public SkillExpression getRoutingSkillexpression(GetRoutingSkillexpressionRequest request) throws IOException, ApiException
      Get a skill expression by ID
      Parameters:
      request - The request object
      Returns:
      SkillExpression
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillexpression

      public ApiResponse<SkillExpression> getRoutingSkillexpression(ApiRequest<Void> request) throws IOException
      Get a skill expression by ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillexpressions

      public SkillExpressionEntityListing getRoutingSkillexpressions(String format, Boolean includeArchived, List<String> id) throws IOException, ApiException
      Get skill expressions
      Parameters:
      format - Response format: raw expression or normalized (optional, default to Raw)
      includeArchived - Include archived (optional, default to false)
      id - Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)
      Returns:
      SkillExpressionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillexpressionsWithHttpInfo

      public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressionsWithHttpInfo(String format, Boolean includeArchived, List<String> id) throws IOException
      Get skill expressions
      Parameters:
      format - Response format: raw expression or normalized (optional, default to Raw)
      includeArchived - Include archived (optional, default to false)
      id - Expression ID(s) to filter. Repeat for multiple or use comma-separated list. (optional)
      Returns:
      SkillExpressionEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillexpressions

      public SkillExpressionEntityListing getRoutingSkillexpressions(GetRoutingSkillexpressionsRequest request) throws IOException, ApiException
      Get skill expressions
      Parameters:
      request - The request object
      Returns:
      SkillExpressionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillexpressions

      public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressions(ApiRequest<Void> request) throws IOException
      Get skill expressions
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillexpressionsQueueQueueId

      public SkillExpressionEntityListing getRoutingSkillexpressionsQueueQueueId(String queueId, String format, Boolean includeArchived) throws IOException, ApiException
      Get skill expressions associated with a queue
      Parameters:
      queueId - Queue ID (required)
      format - Response format: raw expression or normalized (optional, default to Raw)
      includeArchived - Include archived (optional, default to false)
      Returns:
      SkillExpressionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillexpressionsQueueQueueIdWithHttpInfo

      public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressionsQueueQueueIdWithHttpInfo(String queueId, String format, Boolean includeArchived) throws IOException
      Get skill expressions associated with a queue
      Parameters:
      queueId - Queue ID (required)
      format - Response format: raw expression or normalized (optional, default to Raw)
      includeArchived - Include archived (optional, default to false)
      Returns:
      SkillExpressionEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillexpressionsQueueQueueId

      public SkillExpressionEntityListing getRoutingSkillexpressionsQueueQueueId(GetRoutingSkillexpressionsQueueQueueIdRequest request) throws IOException, ApiException
      Get skill expressions associated with a queue
      Parameters:
      request - The request object
      Returns:
      SkillExpressionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillexpressionsQueueQueueId

      public ApiResponse<SkillExpressionEntityListing> getRoutingSkillexpressionsQueueQueueId(ApiRequest<Void> request) throws IOException
      Get skill expressions associated with a queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroup

      public SkillGroup getRoutingSkillgroup(String skillGroupId) throws IOException, ApiException
      Get skill group
      Parameters:
      skillGroupId - Skill Group ID (required)
      Returns:
      SkillGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroupWithHttpInfo

      public ApiResponse<SkillGroup> getRoutingSkillgroupWithHttpInfo(String skillGroupId) throws IOException
      Get skill group
      Parameters:
      skillGroupId - Skill Group ID (required)
      Returns:
      SkillGroup
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroup

      public SkillGroup getRoutingSkillgroup(GetRoutingSkillgroupRequest request) throws IOException, ApiException
      Get skill group
      Parameters:
      request - The request object
      Returns:
      SkillGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroup

      public ApiResponse<SkillGroup> getRoutingSkillgroup(ApiRequest<Void> request) throws IOException
      Get skill group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembers

      public SkillGroupMemberEntityListing getRoutingSkillgroupMembers(String skillGroupId, Integer pageSize, String after, String before, String expand) throws IOException, ApiException
      Get skill group members
      Parameters:
      skillGroupId - Skill Group ID (required)
      pageSize - Page size (optional, default to 25)
      after - The cursor that points to the next item (optional)
      before - The cursor that points to the previous item (optional)
      expand - Expand the name on each user (optional)
      Returns:
      SkillGroupMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembersWithHttpInfo

      public ApiResponse<SkillGroupMemberEntityListing> getRoutingSkillgroupMembersWithHttpInfo(String skillGroupId, Integer pageSize, String after, String before, String expand) throws IOException
      Get skill group members
      Parameters:
      skillGroupId - Skill Group ID (required)
      pageSize - Page size (optional, default to 25)
      after - The cursor that points to the next item (optional)
      before - The cursor that points to the previous item (optional)
      expand - Expand the name on each user (optional)
      Returns:
      SkillGroupMemberEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembers

      public SkillGroupMemberEntityListing getRoutingSkillgroupMembers(GetRoutingSkillgroupMembersRequest request) throws IOException, ApiException
      Get skill group members
      Parameters:
      request - The request object
      Returns:
      SkillGroupMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembers

      public ApiResponse<SkillGroupMemberEntityListing> getRoutingSkillgroupMembers(ApiRequest<Void> request) throws IOException
      Get skill group members
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembersDivisions

      public SkillGroupMemberDivisionList getRoutingSkillgroupMembersDivisions(String skillGroupId, String expand) throws IOException, ApiException
      Get list of member divisions for this skill group.
      Parameters:
      skillGroupId - Skill Group ID (required)
      expand - Expand the name on each user (optional)
      Returns:
      SkillGroupMemberDivisionList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembersDivisionsWithHttpInfo

      public ApiResponse<SkillGroupMemberDivisionList> getRoutingSkillgroupMembersDivisionsWithHttpInfo(String skillGroupId, String expand) throws IOException
      Get list of member divisions for this skill group.
      Parameters:
      skillGroupId - Skill Group ID (required)
      expand - Expand the name on each user (optional)
      Returns:
      SkillGroupMemberDivisionList
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembersDivisions

      public SkillGroupMemberDivisionList getRoutingSkillgroupMembersDivisions(GetRoutingSkillgroupMembersDivisionsRequest request) throws IOException, ApiException
      Get list of member divisions for this skill group.
      Parameters:
      request - The request object
      Returns:
      SkillGroupMemberDivisionList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroupMembersDivisions

      public ApiResponse<SkillGroupMemberDivisionList> getRoutingSkillgroupMembersDivisions(ApiRequest<Void> request) throws IOException
      Get list of member divisions for this skill group.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroups

      public SkillGroupEntityListing getRoutingSkillgroups(Integer pageSize, String name, String after, String before) throws IOException, ApiException
      Get skill group listing
      Parameters:
      pageSize - Page size (optional, default to 25)
      name - Return only skill group names whose names start with this value (case-insensitive matching) (optional)
      after - The cursor that points to the next item (optional)
      before - The cursor that points to the previous item (optional)
      Returns:
      SkillGroupEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroupsWithHttpInfo

      public ApiResponse<SkillGroupEntityListing> getRoutingSkillgroupsWithHttpInfo(Integer pageSize, String name, String after, String before) throws IOException
      Get skill group listing
      Parameters:
      pageSize - Page size (optional, default to 25)
      name - Return only skill group names whose names start with this value (case-insensitive matching) (optional)
      after - The cursor that points to the next item (optional)
      before - The cursor that points to the previous item (optional)
      Returns:
      SkillGroupEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkillgroups

      public SkillGroupEntityListing getRoutingSkillgroups(GetRoutingSkillgroupsRequest request) throws IOException, ApiException
      Get skill group listing
      Parameters:
      request - The request object
      Returns:
      SkillGroupEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillgroups

      public ApiResponse<SkillGroupEntityListing> getRoutingSkillgroups(ApiRequest<Void> request) throws IOException
      Get skill group listing
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkills

      public SkillEntityListing getRoutingSkills(Integer pageSize, Integer pageNumber, String name, List<String> id) throws IOException, ApiException
      Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      name - Filter for results that start with this value (optional)
      id - id (optional)
      Returns:
      SkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkillsWithHttpInfo

      public ApiResponse<SkillEntityListing> getRoutingSkillsWithHttpInfo(Integer pageSize, Integer pageNumber, String name, List<String> id) throws IOException
      Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      name - Filter for results that start with this value (optional)
      id - id (optional)
      Returns:
      SkillEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSkills

      public SkillEntityListing getRoutingSkills(GetRoutingSkillsRequest request) throws IOException, ApiException
      Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
      Parameters:
      request - The request object
      Returns:
      SkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSkills

      public ApiResponse<SkillEntityListing> getRoutingSkills(ApiRequest<Void> request) throws IOException
      Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsAddress

      public SmsAddress getRoutingSmsAddress(String addressId) throws IOException, ApiException
      Get an Address by Id for SMS
      Parameters:
      addressId - Address ID (required)
      Returns:
      SmsAddress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsAddressWithHttpInfo

      public ApiResponse<SmsAddress> getRoutingSmsAddressWithHttpInfo(String addressId) throws IOException
      Get an Address by Id for SMS
      Parameters:
      addressId - Address ID (required)
      Returns:
      SmsAddress
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsAddress

      public SmsAddress getRoutingSmsAddress(GetRoutingSmsAddressRequest request) throws IOException, ApiException
      Get an Address by Id for SMS
      Parameters:
      request - The request object
      Returns:
      SmsAddress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsAddress

      public ApiResponse<SmsAddress> getRoutingSmsAddress(ApiRequest<Void> request) throws IOException
      Get an Address by Id for SMS
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsAddresses

      public SmsAddressEntityListing getRoutingSmsAddresses(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get a list of Addresses for SMS
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      SmsAddressEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsAddressesWithHttpInfo

      public ApiResponse<SmsAddressEntityListing> getRoutingSmsAddressesWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Get a list of Addresses for SMS
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      SmsAddressEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsAddresses

      public SmsAddressEntityListing getRoutingSmsAddresses(GetRoutingSmsAddressesRequest request) throws IOException, ApiException
      Get a list of Addresses for SMS
      Parameters:
      request - The request object
      Returns:
      SmsAddressEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsAddresses

      public ApiResponse<SmsAddressEntityListing> getRoutingSmsAddresses(ApiRequest<Void> request) throws IOException
      Get a list of Addresses for SMS
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsAvailablephonenumbers

      public SMSAvailablePhoneNumberEntityListing getRoutingSmsAvailablephonenumbers(String countryCode, String phoneNumberType, String region, String city, String areaCode, String pattern, String addressRequirement) throws IOException, ApiException
      Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
      Parameters:
      countryCode - The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned (required)
      phoneNumberType - Type of available phone numbers searched (required)
      region - Region/province/state that can be used to restrict the numbers returned (optional)
      city - City that can be used to restrict the numbers returned (optional)
      areaCode - Area code that can be used to restrict the numbers returned (optional)
      pattern - A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit. (optional)
      addressRequirement - This indicates whether the phone number requires to have an Address registered. (optional)
      Returns:
      SMSAvailablePhoneNumberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsAvailablephonenumbersWithHttpInfo

      public ApiResponse<SMSAvailablePhoneNumberEntityListing> getRoutingSmsAvailablephonenumbersWithHttpInfo(String countryCode, String phoneNumberType, String region, String city, String areaCode, String pattern, String addressRequirement) throws IOException
      Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
      Parameters:
      countryCode - The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned (required)
      phoneNumberType - Type of available phone numbers searched (required)
      region - Region/province/state that can be used to restrict the numbers returned (optional)
      city - City that can be used to restrict the numbers returned (optional)
      areaCode - Area code that can be used to restrict the numbers returned (optional)
      pattern - A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit. (optional)
      addressRequirement - This indicates whether the phone number requires to have an Address registered. (optional)
      Returns:
      SMSAvailablePhoneNumberEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsAvailablephonenumbers

      Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
      Parameters:
      request - The request object
      Returns:
      SMSAvailablePhoneNumberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsAvailablephonenumbers

      public ApiResponse<SMSAvailablePhoneNumberEntityListing> getRoutingSmsAvailablephonenumbers(ApiRequest<Void> request) throws IOException
      Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsIdentityresolutionPhonenumber

      public SmsIdentityResolutionConfig getRoutingSmsIdentityresolutionPhonenumber(String addressId) throws IOException, ApiException
      Get a SMS identity resolution settings.
      Parameters:
      addressId - Address ID (required)
      Returns:
      SmsIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsIdentityresolutionPhonenumberWithHttpInfo

      public ApiResponse<SmsIdentityResolutionConfig> getRoutingSmsIdentityresolutionPhonenumberWithHttpInfo(String addressId) throws IOException
      Get a SMS identity resolution settings.
      Parameters:
      addressId - Address ID (required)
      Returns:
      SmsIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsIdentityresolutionPhonenumber

      public SmsIdentityResolutionConfig getRoutingSmsIdentityresolutionPhonenumber(GetRoutingSmsIdentityresolutionPhonenumberRequest request) throws IOException, ApiException
      Get a SMS identity resolution settings.
      Parameters:
      request - The request object
      Returns:
      SmsIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsIdentityresolutionPhonenumber

      public ApiResponse<SmsIdentityResolutionConfig> getRoutingSmsIdentityresolutionPhonenumber(ApiRequest<Void> request) throws IOException
      Get a SMS identity resolution settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumber

      public SmsPhoneNumber getRoutingSmsPhonenumber(String phoneNumberId, String expand) throws IOException, ApiException
      Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.
      Parameters:
      phoneNumberId - phone number (required)
      expand - Expand response with additional information (optional)
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumberWithHttpInfo

      public ApiResponse<SmsPhoneNumber> getRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId, String expand) throws IOException
      Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.
      Parameters:
      phoneNumberId - phone number (required)
      expand - Expand response with additional information (optional)
      Returns:
      SmsPhoneNumber
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumber

      public SmsPhoneNumber getRoutingSmsPhonenumber(GetRoutingSmsPhonenumberRequest request) throws IOException, ApiException
      Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.
      Parameters:
      request - The request object
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumber

      public ApiResponse<SmsPhoneNumber> getRoutingSmsPhonenumber(ApiRequest<Void> request) throws IOException
      Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumbers

      public SmsPhoneNumberEntityListing getRoutingSmsPhonenumbers(String phoneNumber, List<String> phoneNumberType, List<String> phoneNumberStatus, List<String> countryCode, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String language, String integrationId, String supportedContentId, List<String> expand) throws IOException, ApiException
      Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.
      Parameters:
      phoneNumber - Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used. (optional)
      phoneNumberType - Filter on phone number type (optional)
      phoneNumberStatus - Filter on phone number status (optional)
      countryCode - Filter on country code (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - Optional field to sort results (optional)
      sortOrder - Sort order (optional)
      language - A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations (optional, default to "en-US")
      integrationId - Filter on the Genesys Cloud integration id to which the phone number belongs to (optional)
      supportedContentId - Filter based on the supported content ID (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      SmsPhoneNumberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumbersWithHttpInfo

      public ApiResponse<SmsPhoneNumberEntityListing> getRoutingSmsPhonenumbersWithHttpInfo(String phoneNumber, List<String> phoneNumberType, List<String> phoneNumberStatus, List<String> countryCode, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String language, String integrationId, String supportedContentId, List<String> expand) throws IOException
      Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.
      Parameters:
      phoneNumber - Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used. (optional)
      phoneNumberType - Filter on phone number type (optional)
      phoneNumberStatus - Filter on phone number status (optional)
      countryCode - Filter on country code (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - Optional field to sort results (optional)
      sortOrder - Sort order (optional)
      language - A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations (optional, default to "en-US")
      integrationId - Filter on the Genesys Cloud integration id to which the phone number belongs to (optional)
      supportedContentId - Filter based on the supported content ID (optional)
      expand - Which fields, if any, to expand (optional)
      Returns:
      SmsPhoneNumberEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumbers

      public SmsPhoneNumberEntityListing getRoutingSmsPhonenumbers(GetRoutingSmsPhonenumbersRequest request) throws IOException, ApiException
      Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.
      Parameters:
      request - The request object
      Returns:
      SmsPhoneNumberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingSmsPhonenumbers

      public ApiResponse<SmsPhoneNumberEntityListing> getRoutingSmsPhonenumbers(ApiRequest<Void> request) throws IOException
      Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The \"SMS Default\" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUserDirectroutingbackupSettings

      public AgentDirectRoutingBackupSettings getRoutingUserDirectroutingbackupSettings(String userId) throws IOException, ApiException
      Get the user's Direct Routing Backup settings.
      Parameters:
      userId - User ID (required)
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUserDirectroutingbackupSettingsWithHttpInfo

      public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId) throws IOException
      Get the user's Direct Routing Backup settings.
      Parameters:
      userId - User ID (required)
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUserDirectroutingbackupSettings

      public AgentDirectRoutingBackupSettings getRoutingUserDirectroutingbackupSettings(GetRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException
      Get the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUserDirectroutingbackupSettings

      public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingUserDirectroutingbackupSettings(ApiRequest<Void> request) throws IOException
      Get the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUserUtilization

      public AgentMaxUtilizationResponse getRoutingUserUtilization(String userId) throws IOException, ApiException
      Get the user's max utilization settings. If not configured, the organization-wide default is returned.
      Parameters:
      userId - User ID (required)
      Returns:
      AgentMaxUtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUserUtilizationWithHttpInfo

      public ApiResponse<AgentMaxUtilizationResponse> getRoutingUserUtilizationWithHttpInfo(String userId) throws IOException
      Get the user's max utilization settings. If not configured, the organization-wide default is returned.
      Parameters:
      userId - User ID (required)
      Returns:
      AgentMaxUtilizationResponse
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUserUtilization

      public AgentMaxUtilizationResponse getRoutingUserUtilization(GetRoutingUserUtilizationRequest request) throws IOException, ApiException
      Get the user's max utilization settings. If not configured, the organization-wide default is returned.
      Parameters:
      request - The request object
      Returns:
      AgentMaxUtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUserUtilization

      public ApiResponse<AgentMaxUtilizationResponse> getRoutingUserUtilization(ApiRequest<Void> request) throws IOException
      Get the user's max utilization settings. If not configured, the organization-wide default is returned.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilization

      public UtilizationResponse getRoutingUtilization() throws IOException, ApiException
      Get the organization-wide max utilization settings.
      Returns:
      UtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilizationWithHttpInfo

      public ApiResponse<UtilizationResponse> getRoutingUtilizationWithHttpInfo() throws IOException
      Get the organization-wide max utilization settings.
      Returns:
      UtilizationResponse
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilization

      public UtilizationResponse getRoutingUtilization(GetRoutingUtilizationRequest request) throws IOException, ApiException
      Get the organization-wide max utilization settings.
      Parameters:
      request - The request object
      Returns:
      UtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilization

      public ApiResponse<UtilizationResponse> getRoutingUtilization(ApiRequest<Void> request) throws IOException
      Get the organization-wide max utilization settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabel

      public UtilizationLabel getRoutingUtilizationLabel(String labelId) throws IOException, ApiException
      Get details about this utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      Returns:
      UtilizationLabel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabelWithHttpInfo

      public ApiResponse<UtilizationLabel> getRoutingUtilizationLabelWithHttpInfo(String labelId) throws IOException
      Get details about this utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      Returns:
      UtilizationLabel
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabel

      public UtilizationLabel getRoutingUtilizationLabel(GetRoutingUtilizationLabelRequest request) throws IOException, ApiException
      Get details about this utilization label
      Parameters:
      request - The request object
      Returns:
      UtilizationLabel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabel

      public ApiResponse<UtilizationLabel> getRoutingUtilizationLabel(ApiRequest<Void> request) throws IOException
      Get details about this utilization label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabelAgents

      public List<Object> getRoutingUtilizationLabelAgents(String labelId) throws IOException, ApiException
      Get list of agent ids associated with a utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabelAgentsWithHttpInfo

      public ApiResponse<List<Object>> getRoutingUtilizationLabelAgentsWithHttpInfo(String labelId) throws IOException
      Get list of agent ids associated with a utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabelAgents

      public List<Object> getRoutingUtilizationLabelAgents(GetRoutingUtilizationLabelAgentsRequest request) throws IOException, ApiException
      Get list of agent ids associated with a utilization label
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabelAgents

      public ApiResponse<List<Object>> getRoutingUtilizationLabelAgents(ApiRequest<Void> request) throws IOException
      Get list of agent ids associated with a utilization label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabels

      public UtilizationLabelEntityListing getRoutingUtilizationLabels(Integer pageSize, Integer pageNumber, String sortOrder, String name) throws IOException, ApiException
      Get list of utilization labels
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order by name (optional, default to ascending)
      name - Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' (optional)
      Returns:
      UtilizationLabelEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabelsWithHttpInfo

      public ApiResponse<UtilizationLabelEntityListing> getRoutingUtilizationLabelsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortOrder, String name) throws IOException
      Get list of utilization labels
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Sort order by name (optional, default to ascending)
      name - Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' (optional)
      Returns:
      UtilizationLabelEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabels

      public UtilizationLabelEntityListing getRoutingUtilizationLabels(GetRoutingUtilizationLabelsRequest request) throws IOException, ApiException
      Get list of utilization labels
      Parameters:
      request - The request object
      Returns:
      UtilizationLabelEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingUtilizationLabels

      public ApiResponse<UtilizationLabelEntityListing> getRoutingUtilizationLabels(ApiRequest<Void> request) throws IOException
      Get list of utilization labels
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcode

      public WrapupCode getRoutingWrapupcode(String codeId) throws IOException, ApiException
      Get details about this wrap-up code.
      Parameters:
      codeId - Wrapup Code ID (required)
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcodeWithHttpInfo

      public ApiResponse<WrapupCode> getRoutingWrapupcodeWithHttpInfo(String codeId) throws IOException
      Get details about this wrap-up code.
      Parameters:
      codeId - Wrapup Code ID (required)
      Returns:
      WrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcode

      public WrapupCode getRoutingWrapupcode(GetRoutingWrapupcodeRequest request) throws IOException, ApiException
      Get details about this wrap-up code.
      Parameters:
      request - The request object
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcode

      public ApiResponse<WrapupCode> getRoutingWrapupcode(ApiRequest<Void> request) throws IOException
      Get details about this wrap-up code.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcodes

      public WrapupCodeEntityListing getRoutingWrapupcodes(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException, ApiException
      Get list of wrapup codes.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - Sort by (optional, default to name)
      sortOrder - Sort order (optional, default to ascending)
      name - Wrapup code's name ('Sort by' param is ignored unless this field is provided) (optional)
      id - Filter by wrapup code ID(s) (optional)
      divisionId - Filter by division ID(s) (optional)
      Returns:
      WrapupCodeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesWithHttpInfo

      public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, List<String> id, List<String> divisionId) throws IOException
      Get list of wrapup codes.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - Sort by (optional, default to name)
      sortOrder - Sort order (optional, default to ascending)
      name - Wrapup code's name ('Sort by' param is ignored unless this field is provided) (optional)
      id - Filter by wrapup code ID(s) (optional)
      divisionId - Filter by division ID(s) (optional)
      Returns:
      WrapupCodeEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcodes

      public WrapupCodeEntityListing getRoutingWrapupcodes(GetRoutingWrapupcodesRequest request) throws IOException, ApiException
      Get list of wrapup codes.
      Parameters:
      request - The request object
      Returns:
      WrapupCodeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcodes

      public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodes(ApiRequest<Void> request) throws IOException
      Get list of wrapup codes.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionview

      public WrapupCode getRoutingWrapupcodesDivisionview(String codeId) throws IOException, ApiException
      Get a simplified wrap-up code.
      Parameters:
      codeId - Wrapup Code ID (required)
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionviewWithHttpInfo

      public ApiResponse<WrapupCode> getRoutingWrapupcodesDivisionviewWithHttpInfo(String codeId) throws IOException
      Get a simplified wrap-up code.
      Parameters:
      codeId - Wrapup Code ID (required)
      Returns:
      WrapupCode
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionview

      public WrapupCode getRoutingWrapupcodesDivisionview(GetRoutingWrapupcodesDivisionviewRequest request) throws IOException, ApiException
      Get a simplified wrap-up code.
      Parameters:
      request - The request object
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionview

      public ApiResponse<WrapupCode> getRoutingWrapupcodesDivisionview(ApiRequest<Void> request) throws IOException
      Get a simplified wrap-up code.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionviews

      public WrapupCodeEntityListing getRoutingWrapupcodesDivisionviews(Integer pageSize, Integer pageNumber, String name, List<String> id, List<String> divisionId, String includeState) throws IOException, ApiException
      Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      name - Name (trailing asterisks allowed) (optional)
      id - Wrapup code ID(s) (optional)
      divisionId - Division ID(s) (optional)
      includeState - Wrapup code state(s) to include (optional)
      Returns:
      WrapupCodeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionviewsWithHttpInfo

      public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodesDivisionviewsWithHttpInfo(Integer pageSize, Integer pageNumber, String name, List<String> id, List<String> divisionId, String includeState) throws IOException
      Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      name - Name (trailing asterisks allowed) (optional)
      id - Wrapup code ID(s) (optional)
      divisionId - Division ID(s) (optional)
      includeState - Wrapup code state(s) to include (optional)
      Returns:
      WrapupCodeEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionviews

      public WrapupCodeEntityListing getRoutingWrapupcodesDivisionviews(GetRoutingWrapupcodesDivisionviewsRequest request) throws IOException, ApiException
      Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.
      Parameters:
      request - The request object
      Returns:
      WrapupCodeEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getRoutingWrapupcodesDivisionviews

      public ApiResponse<WrapupCodeEntityListing> getRoutingWrapupcodesDivisionviews(ApiRequest<Void> request) throws IOException
      Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getUserQueues

      public UserQueueEntityListing getUserQueues(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) throws IOException, ApiException
      Get queues for user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      joined - Is joined to the queue (optional, default to true)
      divisionId - Division ID(s) (optional)
      Returns:
      UserQueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserQueuesWithHttpInfo

      public ApiResponse<UserQueueEntityListing> getUserQueuesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) throws IOException
      Get queues for user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      joined - Is joined to the queue (optional, default to true)
      divisionId - Division ID(s) (optional)
      Returns:
      UserQueueEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getUserQueues

      public UserQueueEntityListing getUserQueues(GetUserQueuesRequest request) throws IOException, ApiException
      Get queues for user
      Parameters:
      request - The request object
      Returns:
      UserQueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserQueues

      public ApiResponse<UserQueueEntityListing> getUserQueues(ApiRequest<Void> request) throws IOException
      Get queues for user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getUserRoutinglanguages

      public UserLanguageEntityListing getUserRoutinglanguages(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException
      List routing languages assigned to a user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      UserLanguageEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserRoutinglanguagesWithHttpInfo

      public ApiResponse<UserLanguageEntityListing> getUserRoutinglanguagesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException
      List routing languages assigned to a user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      UserLanguageEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getUserRoutinglanguages

      public UserLanguageEntityListing getUserRoutinglanguages(GetUserRoutinglanguagesRequest request) throws IOException, ApiException
      List routing languages assigned to a user
      Parameters:
      request - The request object
      Returns:
      UserLanguageEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserRoutinglanguages

      public ApiResponse<UserLanguageEntityListing> getUserRoutinglanguages(ApiRequest<Void> request) throws IOException
      List routing languages assigned to a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getUserRoutingskills

      public UserSkillEntityListing getUserRoutingskills(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException
      List routing skills assigned to a user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      UserSkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserRoutingskillsWithHttpInfo

      public ApiResponse<UserSkillEntityListing> getUserRoutingskillsWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException
      List routing skills assigned to a user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      UserSkillEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getUserRoutingskills

      public UserSkillEntityListing getUserRoutingskills(GetUserRoutingskillsRequest request) throws IOException, ApiException
      List routing skills assigned to a user
      Parameters:
      request - The request object
      Returns:
      UserSkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserRoutingskills

      public ApiResponse<UserSkillEntityListing> getUserRoutingskills(ApiRequest<Void> request) throws IOException
      List routing skills assigned to a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • getUserSkillgroups

      public UserSkillGroupEntityListing getUserSkillgroups(String userId, Integer pageSize, String after, String before) throws IOException, ApiException
      Get skill groups for a user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      after - The cursor that points to the next page (optional)
      before - The cursor that points to the previous page (optional)
      Returns:
      UserSkillGroupEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserSkillgroupsWithHttpInfo

      public ApiResponse<UserSkillGroupEntityListing> getUserSkillgroupsWithHttpInfo(String userId, Integer pageSize, String after, String before) throws IOException
      Get skill groups for a user
      Parameters:
      userId - User ID (required)
      pageSize - Page size (optional, default to 25)
      after - The cursor that points to the next page (optional)
      before - The cursor that points to the previous page (optional)
      Returns:
      UserSkillGroupEntityListing
      Throws:
      IOException - if the request fails to be processed
    • getUserSkillgroups

      Get skill groups for a user
      Parameters:
      request - The request object
      Returns:
      UserSkillGroupEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • getUserSkillgroups

      public ApiResponse<UserSkillGroupEntityListing> getUserSkillgroups(ApiRequest<Void> request) throws IOException
      Get skill groups for a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingConversation

      public RoutingConversationAttributesResponse patchRoutingConversation(String conversationId, RoutingConversationAttributesRequest body) throws IOException, ApiException
      Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.
      Parameters:
      conversationId - Conversation ID (required)
      body - Conversation Attributes (required)
      Returns:
      RoutingConversationAttributesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingConversationWithHttpInfo

      public ApiResponse<RoutingConversationAttributesResponse> patchRoutingConversationWithHttpInfo(String conversationId, RoutingConversationAttributesRequest body) throws IOException
      Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.
      Parameters:
      conversationId - Conversation ID (required)
      body - Conversation Attributes (required)
      Returns:
      RoutingConversationAttributesResponse
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingConversation

      Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.
      Parameters:
      request - The request object
      Returns:
      RoutingConversationAttributesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingConversation

      Update attributes of an in-queue conversation Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailDomain

      public InboundDomain patchRoutingEmailDomain(String domainId, InboundDomainPatchRequest body) throws IOException, ApiException
      Update domain settings
      Parameters:
      domainId - domain ID (required)
      body - Domain settings (required)
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailDomainWithHttpInfo

      public ApiResponse<InboundDomain> patchRoutingEmailDomainWithHttpInfo(String domainId, InboundDomainPatchRequest body) throws IOException
      Update domain settings
      Parameters:
      domainId - domain ID (required)
      body - Domain settings (required)
      Returns:
      InboundDomain
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailDomain

      public InboundDomain patchRoutingEmailDomain(PatchRoutingEmailDomainRequest request) throws IOException, ApiException
      Update domain settings
      Parameters:
      request - The request object
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailDomain

      public ApiResponse<InboundDomain> patchRoutingEmailDomain(ApiRequest<InboundDomainPatchRequest> request) throws IOException
      Update domain settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailDomainValidate

      public InboundDomain patchRoutingEmailDomainValidate(String domainId, InboundDomainPatchRequest body) throws IOException, ApiException
      Validate domain settings
      Parameters:
      domainId - domain ID (required)
      body - Domain settings (required)
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailDomainValidateWithHttpInfo

      public ApiResponse<InboundDomain> patchRoutingEmailDomainValidateWithHttpInfo(String domainId, InboundDomainPatchRequest body) throws IOException
      Validate domain settings
      Parameters:
      domainId - domain ID (required)
      body - Domain settings (required)
      Returns:
      InboundDomain
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailDomainValidate

      public InboundDomain patchRoutingEmailDomainValidate(PatchRoutingEmailDomainValidateRequest request) throws IOException, ApiException
      Validate domain settings
      Parameters:
      request - The request object
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailDomainValidate

      public ApiResponse<InboundDomain> patchRoutingEmailDomainValidate(ApiRequest<InboundDomainPatchRequest> request) throws IOException
      Validate domain settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailOutboundDomain

      public OutboundDomain patchRoutingEmailOutboundDomain(String domainId, OutboundDomainPatchRequest body) throws IOException, ApiException
      Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).
      Parameters:
      domainId - domain ID (required)
      body - Domain settings (required)
      Returns:
      OutboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailOutboundDomainWithHttpInfo

      public ApiResponse<OutboundDomain> patchRoutingEmailOutboundDomainWithHttpInfo(String domainId, OutboundDomainPatchRequest body) throws IOException
      Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).
      Parameters:
      domainId - domain ID (required)
      body - Domain settings (required)
      Returns:
      OutboundDomain
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailOutboundDomain

      public OutboundDomain patchRoutingEmailOutboundDomain(PatchRoutingEmailOutboundDomainRequest request) throws IOException, ApiException
      Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).
      Parameters:
      request - The request object
      Returns:
      OutboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailOutboundDomain

      public ApiResponse<OutboundDomain> patchRoutingEmailOutboundDomain(ApiRequest<OutboundDomainPatchRequest> request) throws IOException
      Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailSettingEmailSettingId

      public EmailSetting patchRoutingEmailSettingEmailSettingId(String emailSettingId, EmailSetting body) throws IOException, ApiException
      Update an email setting. Modifies the settings for email setting
      Parameters:
      emailSettingId - Email Setting ID (required)
      body - EmailSetting (required)
      Returns:
      EmailSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailSettingEmailSettingIdWithHttpInfo

      public ApiResponse<EmailSetting> patchRoutingEmailSettingEmailSettingIdWithHttpInfo(String emailSettingId, EmailSetting body) throws IOException
      Update an email setting. Modifies the settings for email setting
      Parameters:
      emailSettingId - Email Setting ID (required)
      body - EmailSetting (required)
      Returns:
      EmailSetting
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingEmailSettingEmailSettingId

      public EmailSetting patchRoutingEmailSettingEmailSettingId(PatchRoutingEmailSettingEmailSettingIdRequest request) throws IOException, ApiException
      Update an email setting. Modifies the settings for email setting
      Parameters:
      request - The request object
      Returns:
      EmailSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingEmailSettingEmailSettingId

      public ApiResponse<EmailSetting> patchRoutingEmailSettingEmailSettingId(ApiRequest<EmailSetting> request) throws IOException
      Update an email setting. Modifies the settings for email setting
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingPredictor

      public Predictor patchRoutingPredictor(String predictorId, PatchPredictorRequest body) throws IOException, ApiException
      Update single predictor.
      Parameters:
      predictorId - Predictor ID (required)
      body - (optional)
      Returns:
      Predictor
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingPredictorWithHttpInfo

      public ApiResponse<Predictor> patchRoutingPredictorWithHttpInfo(String predictorId, PatchPredictorRequest body) throws IOException
      Update single predictor.
      Parameters:
      predictorId - Predictor ID (required)
      body - (optional)
      Returns:
      Predictor
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingPredictor

      public Predictor patchRoutingPredictor(PatchRoutingPredictorRequest request) throws IOException, ApiException
      Update single predictor.
      Parameters:
      request - The request object
      Returns:
      Predictor
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingPredictor

      public ApiResponse<Predictor> patchRoutingPredictor(ApiRequest<PatchPredictorRequest> request) throws IOException
      Update single predictor.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingPredictorsKeyperformanceindicator

      public KeyPerformanceIndicator patchRoutingPredictorsKeyperformanceindicator(String kpiId, UpdateKpiRequest body) throws IOException, ApiException
      Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      kpiId - Key Performance Indicator ID (required)
      body - (optional)
      Returns:
      KeyPerformanceIndicator
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingPredictorsKeyperformanceindicatorWithHttpInfo

      public ApiResponse<KeyPerformanceIndicator> patchRoutingPredictorsKeyperformanceindicatorWithHttpInfo(String kpiId, UpdateKpiRequest body) throws IOException
      Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      kpiId - Key Performance Indicator ID (required)
      body - (optional)
      Returns:
      KeyPerformanceIndicator
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingPredictorsKeyperformanceindicator

      public KeyPerformanceIndicator patchRoutingPredictorsKeyperformanceindicator(PatchRoutingPredictorsKeyperformanceindicatorRequest request) throws IOException, ApiException
      Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator 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:
      KeyPerformanceIndicator
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingPredictorsKeyperformanceindicator

      public ApiResponse<KeyPerformanceIndicator> patchRoutingPredictorsKeyperformanceindicator(ApiRequest<UpdateKpiRequest> request) throws IOException
      Update a custom Key Performance Indicator. patchRoutingPredictorsKeyperformanceindicator 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
    • patchRoutingQueueMember

      public void patchRoutingQueueMember(String queueId, String memberId, QueueMember body) throws IOException, ApiException
      Update the ring number OR joined status for a queue member.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      body - Queue Member (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueMemberWithHttpInfo

      public ApiResponse<Void> patchRoutingQueueMemberWithHttpInfo(String queueId, String memberId, QueueMember body) throws IOException
      Update the ring number OR joined status for a queue member.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      body - Queue Member (required)
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingQueueMember

      public void patchRoutingQueueMember(PatchRoutingQueueMemberRequest request) throws IOException, ApiException
      Update the ring number OR joined status for a queue member.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueMember

      public ApiResponse<Void> patchRoutingQueueMember(ApiRequest<QueueMember> request) throws IOException
      Update the ring number OR joined status for a queue member.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingQueueMembers

      public QueueMemberEntityListing patchRoutingQueueMembers(String queueId, List<QueueMember> body) throws IOException, ApiException
      Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      Returns:
      QueueMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueMembersWithHttpInfo

      public ApiResponse<QueueMemberEntityListing> patchRoutingQueueMembersWithHttpInfo(String queueId, List<QueueMember> body) throws IOException
      Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      Returns:
      QueueMemberEntityListing
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingQueueMembers

      public QueueMemberEntityListing patchRoutingQueueMembers(PatchRoutingQueueMembersRequest request) throws IOException, ApiException
      Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      request - The request object
      Returns:
      QueueMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueMembers

      public ApiResponse<QueueMemberEntityListing> patchRoutingQueueMembers(ApiRequest<List<QueueMember>> request) throws IOException
      Join or unjoin a set of up to 100 users for a queue Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingQueueUser

      public void patchRoutingQueueUser(String queueId, String memberId, QueueMember body) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      body - Queue Member (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueUserWithHttpInfo

      public ApiResponse<Void> patchRoutingQueueUserWithHttpInfo(String queueId, String memberId, QueueMember body) throws IOException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.
      Parameters:
      queueId - Queue ID (required)
      memberId - Member ID (required)
      body - Queue Member (required)
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingQueueUser

      public void patchRoutingQueueUser(PatchRoutingQueueUserRequest request) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueUser

      public ApiResponse<Void> patchRoutingQueueUser(ApiRequest<QueueMember> request) throws IOException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingQueueUsers

      public QueueMemberEntityListingV1 patchRoutingQueueUsers(String queueId, List<QueueMember> body) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      Returns:
      QueueMemberEntityListingV1
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueUsersWithHttpInfo

      public ApiResponse<QueueMemberEntityListingV1> patchRoutingQueueUsersWithHttpInfo(String queueId, List<QueueMember> body) throws IOException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      Returns:
      QueueMemberEntityListingV1
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingQueueUsers

      public QueueMemberEntityListingV1 patchRoutingQueueUsers(PatchRoutingQueueUsersRequest request) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.
      Parameters:
      request - The request object
      Returns:
      QueueMemberEntityListingV1
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingQueueUsers

      public ApiResponse<QueueMemberEntityListingV1> patchRoutingQueueUsers(ApiRequest<List<QueueMember>> request) throws IOException
      Deprecated.
      DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSettingsContactcenter

      public void patchRoutingSettingsContactcenter(ContactCenterSettings body) throws IOException, ApiException
      Update Contact Center Settings
      Parameters:
      body - Contact Center Settings (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSettingsContactcenterWithHttpInfo

      public ApiResponse<Void> patchRoutingSettingsContactcenterWithHttpInfo(ContactCenterSettings body) throws IOException
      Update Contact Center Settings
      Parameters:
      body - Contact Center Settings (required)
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSettingsContactcenter

      public void patchRoutingSettingsContactcenter(PatchRoutingSettingsContactcenterRequest request) throws IOException, ApiException
      Update Contact Center Settings
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSettingsContactcenter

      public ApiResponse<Void> patchRoutingSettingsContactcenter(ApiRequest<ContactCenterSettings> request) throws IOException
      Update Contact Center Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSettingsTranscription

      public TranscriptionSettings patchRoutingSettingsTranscription(TranscriptionSettings body) throws IOException, ApiException
      Patch Transcription Settings
      Parameters:
      body - Organization Settings (required)
      Returns:
      TranscriptionSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSettingsTranscriptionWithHttpInfo

      public ApiResponse<TranscriptionSettings> patchRoutingSettingsTranscriptionWithHttpInfo(TranscriptionSettings body) throws IOException
      Patch Transcription Settings
      Parameters:
      body - Organization Settings (required)
      Returns:
      TranscriptionSettings
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSettingsTranscription

      public TranscriptionSettings patchRoutingSettingsTranscription(PatchRoutingSettingsTranscriptionRequest request) throws IOException, ApiException
      Patch Transcription Settings
      Parameters:
      request - The request object
      Returns:
      TranscriptionSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSettingsTranscription

      public ApiResponse<TranscriptionSettings> patchRoutingSettingsTranscription(ApiRequest<TranscriptionSettings> request) throws IOException
      Patch Transcription Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSkill

      public RoutingSkill patchRoutingSkill(String skillId, UpdateSkillDivisionRequest body) throws IOException, ApiException
      Update Routing Skill Division
      Parameters:
      skillId - Skill ID (required)
      body - updateSkillDivisionRequest (required)
      Returns:
      RoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSkillWithHttpInfo

      public ApiResponse<RoutingSkill> patchRoutingSkillWithHttpInfo(String skillId, UpdateSkillDivisionRequest body) throws IOException
      Update Routing Skill Division
      Parameters:
      skillId - Skill ID (required)
      body - updateSkillDivisionRequest (required)
      Returns:
      RoutingSkill
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSkill

      public RoutingSkill patchRoutingSkill(PatchRoutingSkillRequest request) throws IOException, ApiException
      Update Routing Skill Division
      Parameters:
      request - The request object
      Returns:
      RoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSkill

      public ApiResponse<RoutingSkill> patchRoutingSkill(ApiRequest<UpdateSkillDivisionRequest> request) throws IOException
      Update Routing Skill Division
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSkillgroup

      public SkillGroup patchRoutingSkillgroup(String skillGroupId, SkillGroup body) throws IOException, ApiException
      Update skill group definition
      Parameters:
      skillGroupId - Skill Group ID (required)
      body - Update skill groups (required)
      Returns:
      SkillGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSkillgroupWithHttpInfo

      public ApiResponse<SkillGroup> patchRoutingSkillgroupWithHttpInfo(String skillGroupId, SkillGroup body) throws IOException
      Update skill group definition
      Parameters:
      skillGroupId - Skill Group ID (required)
      body - Update skill groups (required)
      Returns:
      SkillGroup
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSkillgroup

      public SkillGroup patchRoutingSkillgroup(PatchRoutingSkillgroupRequest request) throws IOException, ApiException
      Update skill group definition
      Parameters:
      request - The request object
      Returns:
      SkillGroup
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSkillgroup

      public ApiResponse<SkillGroup> patchRoutingSkillgroup(ApiRequest<SkillGroup> request) throws IOException
      Update skill group definition
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSmsPhonenumber

      public SmsPhoneNumber patchRoutingSmsPhonenumber(String phoneNumberId, SmsPhoneNumberPatchRequest body) throws IOException, ApiException
      Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.
      Parameters:
      phoneNumberId - phone number (required)
      body - SmsPhoneNumberPatchRequest (required)
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSmsPhonenumberWithHttpInfo

      public ApiResponse<SmsPhoneNumber> patchRoutingSmsPhonenumberWithHttpInfo(String phoneNumberId, SmsPhoneNumberPatchRequest body) throws IOException
      Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.
      Parameters:
      phoneNumberId - phone number (required)
      body - SmsPhoneNumberPatchRequest (required)
      Returns:
      SmsPhoneNumber
      Throws:
      IOException - if the request fails to be processed
    • patchRoutingSmsPhonenumber

      public SmsPhoneNumber patchRoutingSmsPhonenumber(PatchRoutingSmsPhonenumberRequest request) throws IOException, ApiException
      Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.
      Parameters:
      request - The request object
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchRoutingSmsPhonenumber

      public ApiResponse<SmsPhoneNumber> patchRoutingSmsPhonenumber(ApiRequest<SmsPhoneNumberPatchRequest> request) throws IOException
      Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the \"SMS Default\" profile, which allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchUserQueue

      public UserQueue patchUserQueue(String queueId, String userId, UserQueue body) throws IOException, ApiException
      Join or unjoin a queue for a user
      Parameters:
      queueId - Queue ID (required)
      userId - User ID (required)
      body - Queue Member (required)
      Returns:
      UserQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserQueueWithHttpInfo

      public ApiResponse<UserQueue> patchUserQueueWithHttpInfo(String queueId, String userId, UserQueue body) throws IOException
      Join or unjoin a queue for a user
      Parameters:
      queueId - Queue ID (required)
      userId - User ID (required)
      body - Queue Member (required)
      Returns:
      UserQueue
      Throws:
      IOException - if the request fails to be processed
    • patchUserQueue

      public UserQueue patchUserQueue(PatchUserQueueRequest request) throws IOException, ApiException
      Join or unjoin a queue for a user
      Parameters:
      request - The request object
      Returns:
      UserQueue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserQueue

      public ApiResponse<UserQueue> patchUserQueue(ApiRequest<UserQueue> request) throws IOException
      Join or unjoin a queue for a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchUserQueues

      public UserQueueEntityListing patchUserQueues(String userId, List<UserQueue> body, List<String> divisionId) throws IOException, ApiException
      Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      userId - User ID (required)
      body - User Queues (required)
      divisionId - Division ID(s) (optional)
      Returns:
      UserQueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserQueuesWithHttpInfo

      public ApiResponse<UserQueueEntityListing> patchUserQueuesWithHttpInfo(String userId, List<UserQueue> body, List<String> divisionId) throws IOException
      Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      userId - User ID (required)
      body - User Queues (required)
      divisionId - Division ID(s) (optional)
      Returns:
      UserQueueEntityListing
      Throws:
      IOException - if the request fails to be processed
    • patchUserQueues

      public UserQueueEntityListing patchUserQueues(PatchUserQueuesRequest request) throws IOException, ApiException
      Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      request - The request object
      Returns:
      UserQueueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserQueues

      public ApiResponse<UserQueueEntityListing> patchUserQueues(ApiRequest<List<UserQueue>> request) throws IOException
      Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchUserRoutinglanguage

      public UserRoutingLanguage patchUserRoutinglanguage(String userId, String languageId, UserRoutingLanguage body) throws IOException, ApiException
      Update an assigned routing language's proficiency
      Parameters:
      userId - User ID (required)
      languageId - languageId (required)
      body - Language (required)
      Returns:
      UserRoutingLanguage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserRoutinglanguageWithHttpInfo

      public ApiResponse<UserRoutingLanguage> patchUserRoutinglanguageWithHttpInfo(String userId, String languageId, UserRoutingLanguage body) throws IOException
      Update an assigned routing language's proficiency
      Parameters:
      userId - User ID (required)
      languageId - languageId (required)
      body - Language (required)
      Returns:
      UserRoutingLanguage
      Throws:
      IOException - if the request fails to be processed
    • patchUserRoutinglanguage

      public UserRoutingLanguage patchUserRoutinglanguage(PatchUserRoutinglanguageRequest request) throws IOException, ApiException
      Update an assigned routing language's proficiency
      Parameters:
      request - The request object
      Returns:
      UserRoutingLanguage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserRoutinglanguage

      public ApiResponse<UserRoutingLanguage> patchUserRoutinglanguage(ApiRequest<UserRoutingLanguage> request) throws IOException
      Update an assigned routing language's proficiency
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchUserRoutinglanguagesBulk

      public UserLanguageEntityListing patchUserRoutinglanguagesBulk(String userId, List<UserRoutingLanguagePost> body) throws IOException, ApiException
      Assign multiple routing languages to a user. Max 50 routing languages in request body
      Parameters:
      userId - User ID (required)
      body - Language (required)
      Returns:
      UserLanguageEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserRoutinglanguagesBulkWithHttpInfo

      public ApiResponse<UserLanguageEntityListing> patchUserRoutinglanguagesBulkWithHttpInfo(String userId, List<UserRoutingLanguagePost> body) throws IOException
      Assign multiple routing languages to a user. Max 50 routing languages in request body
      Parameters:
      userId - User ID (required)
      body - Language (required)
      Returns:
      UserLanguageEntityListing
      Throws:
      IOException - if the request fails to be processed
    • patchUserRoutinglanguagesBulk

      public UserLanguageEntityListing patchUserRoutinglanguagesBulk(PatchUserRoutinglanguagesBulkRequest request) throws IOException, ApiException
      Assign multiple routing languages to a user. Max 50 routing languages in request body
      Parameters:
      request - The request object
      Returns:
      UserLanguageEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserRoutinglanguagesBulk

      public ApiResponse<UserLanguageEntityListing> patchUserRoutinglanguagesBulk(ApiRequest<List<UserRoutingLanguagePost>> request) throws IOException
      Assign multiple routing languages to a user. Max 50 routing languages in request body
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • patchUserRoutingskillsBulk

      public UserSkillEntityListing patchUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) throws IOException, ApiException
      Assign multiple routing skills to a user
      Parameters:
      userId - User ID (required)
      body - Skill (required)
      Returns:
      UserSkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserRoutingskillsBulkWithHttpInfo

      public ApiResponse<UserSkillEntityListing> patchUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) throws IOException
      Assign multiple routing skills to a user
      Parameters:
      userId - User ID (required)
      body - Skill (required)
      Returns:
      UserSkillEntityListing
      Throws:
      IOException - if the request fails to be processed
    • patchUserRoutingskillsBulk

      public UserSkillEntityListing patchUserRoutingskillsBulk(PatchUserRoutingskillsBulkRequest request) throws IOException, ApiException
      Assign multiple routing skills to a user
      Parameters:
      request - The request object
      Returns:
      UserSkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • patchUserRoutingskillsBulk

      public ApiResponse<UserSkillEntityListing> patchUserRoutingskillsBulk(ApiRequest<List<UserRoutingSkillPost>> request) throws IOException
      Assign multiple routing skills to a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsQueuesObservationsQuery

      public QueueObservationQueryResponse postAnalyticsQueuesObservationsQuery(QueueObservationQuery body) throws IOException, ApiException
      Query for queue observations
      Parameters:
      body - query (required)
      Returns:
      QueueObservationQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsQueuesObservationsQueryWithHttpInfo

      public ApiResponse<QueueObservationQueryResponse> postAnalyticsQueuesObservationsQueryWithHttpInfo(QueueObservationQuery body) throws IOException
      Query for queue observations
      Parameters:
      body - query (required)
      Returns:
      QueueObservationQueryResponse
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsQueuesObservationsQuery

      public QueueObservationQueryResponse postAnalyticsQueuesObservationsQuery(PostAnalyticsQueuesObservationsQueryRequest request) throws IOException, ApiException
      Query for queue observations
      Parameters:
      request - The request object
      Returns:
      QueueObservationQueryResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsQueuesObservationsQuery

      public ApiResponse<QueueObservationQueryResponse> postAnalyticsQueuesObservationsQuery(ApiRequest<QueueObservationQuery> request) throws IOException
      Query for queue observations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsRoutingActivityQuery

      public RoutingActivityResponse postAnalyticsRoutingActivityQuery(RoutingActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Query for user activity observations
      Parameters:
      body - query (required)
      pageSize - The desired page size (optional)
      pageNumber - The desired page number (optional)
      Returns:
      RoutingActivityResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsRoutingActivityQueryWithHttpInfo

      public ApiResponse<RoutingActivityResponse> postAnalyticsRoutingActivityQueryWithHttpInfo(RoutingActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException
      Query for user activity observations
      Parameters:
      body - query (required)
      pageSize - The desired page size (optional)
      pageNumber - The desired page number (optional)
      Returns:
      RoutingActivityResponse
      Throws:
      IOException - if the request fails to be processed
    • postAnalyticsRoutingActivityQuery

      public RoutingActivityResponse postAnalyticsRoutingActivityQuery(PostAnalyticsRoutingActivityQueryRequest request) throws IOException, ApiException
      Query for user activity observations
      Parameters:
      request - The request object
      Returns:
      RoutingActivityResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postAnalyticsRoutingActivityQuery

      public ApiResponse<RoutingActivityResponse> postAnalyticsRoutingActivityQuery(ApiRequest<RoutingActivityQuery> request) throws IOException
      Query for user activity observations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingAssessments

      public BenefitAssessment postRoutingAssessments(CreateBenefitAssessmentRequest body) throws IOException, ApiException
      Create a benefit assessment.
      Parameters:
      body - (optional)
      Returns:
      BenefitAssessment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingAssessmentsWithHttpInfo

      public ApiResponse<BenefitAssessment> postRoutingAssessmentsWithHttpInfo(CreateBenefitAssessmentRequest body) throws IOException
      Create a benefit assessment.
      Parameters:
      body - (optional)
      Returns:
      BenefitAssessment
      Throws:
      IOException - if the request fails to be processed
    • postRoutingAssessments

      public BenefitAssessment postRoutingAssessments(PostRoutingAssessmentsRequest request) throws IOException, ApiException
      Create a benefit assessment.
      Parameters:
      request - The request object
      Returns:
      BenefitAssessment
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingAssessments

      public ApiResponse<BenefitAssessment> postRoutingAssessments(ApiRequest<CreateBenefitAssessmentRequest> request) throws IOException
      Create a benefit assessment.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingAssessmentsJobs

      public BenefitAssessmentJob postRoutingAssessmentsJobs(CreateBenefitAssessmentJobRequest body) throws IOException, ApiException
      Create a benefit assessment job.
      Parameters:
      body - (optional)
      Returns:
      BenefitAssessmentJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingAssessmentsJobsWithHttpInfo

      public ApiResponse<BenefitAssessmentJob> postRoutingAssessmentsJobsWithHttpInfo(CreateBenefitAssessmentJobRequest body) throws IOException
      Create a benefit assessment job.
      Parameters:
      body - (optional)
      Returns:
      BenefitAssessmentJob
      Throws:
      IOException - if the request fails to be processed
    • postRoutingAssessmentsJobs

      public BenefitAssessmentJob postRoutingAssessmentsJobs(PostRoutingAssessmentsJobsRequest request) throws IOException, ApiException
      Create a benefit assessment job.
      Parameters:
      request - The request object
      Returns:
      BenefitAssessmentJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingAssessmentsJobs

      public ApiResponse<BenefitAssessmentJob> postRoutingAssessmentsJobs(ApiRequest<CreateBenefitAssessmentJobRequest> request) throws IOException
      Create a benefit assessment job.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainDkim

      public VerificationResult postRoutingEmailDomainDkim(String domainId) throws IOException, ApiException
      Restart domain dkim
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainDkimWithHttpInfo

      public ApiResponse<VerificationResult> postRoutingEmailDomainDkimWithHttpInfo(String domainId) throws IOException
      Restart domain dkim
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainDkim

      public VerificationResult postRoutingEmailDomainDkim(PostRoutingEmailDomainDkimRequest request) throws IOException, ApiException
      Restart domain dkim
      Parameters:
      request - The request object
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainDkim

      public ApiResponse<VerificationResult> postRoutingEmailDomainDkim(ApiRequest<Void> request) throws IOException
      Restart domain dkim
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainMailfrom

      public MailFromResult postRoutingEmailDomainMailfrom(String domainId, MailFromResult body) throws IOException, ApiException
      Set domain mail from settings
      Parameters:
      domainId - domain ID (required)
      body - Mail From Settings (required)
      Returns:
      MailFromResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainMailfromWithHttpInfo

      public ApiResponse<MailFromResult> postRoutingEmailDomainMailfromWithHttpInfo(String domainId, MailFromResult body) throws IOException
      Set domain mail from settings
      Parameters:
      domainId - domain ID (required)
      body - Mail From Settings (required)
      Returns:
      MailFromResult
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainMailfrom

      public MailFromResult postRoutingEmailDomainMailfrom(PostRoutingEmailDomainMailfromRequest request) throws IOException, ApiException
      Set domain mail from settings
      Parameters:
      request - The request object
      Returns:
      MailFromResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainMailfrom

      public ApiResponse<MailFromResult> postRoutingEmailDomainMailfrom(ApiRequest<MailFromResult> request) throws IOException
      Set domain mail from settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainRoutes

      public InboundRoute postRoutingEmailDomainRoutes(String domainName, InboundRoute body) throws IOException, ApiException
      Create a route
      Parameters:
      domainName - email domain (required)
      body - Route (required)
      Returns:
      InboundRoute
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainRoutesWithHttpInfo

      public ApiResponse<InboundRoute> postRoutingEmailDomainRoutesWithHttpInfo(String domainName, InboundRoute body) throws IOException
      Create a route
      Parameters:
      domainName - email domain (required)
      body - Route (required)
      Returns:
      InboundRoute
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainRoutes

      public InboundRoute postRoutingEmailDomainRoutes(PostRoutingEmailDomainRoutesRequest request) throws IOException, ApiException
      Create a route
      Parameters:
      request - The request object
      Returns:
      InboundRoute
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainRoutes

      public ApiResponse<InboundRoute> postRoutingEmailDomainRoutes(ApiRequest<InboundRoute> request) throws IOException
      Create a route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainTestconnection

      public TestMessage postRoutingEmailDomainTestconnection(String domainId, TestMessage body) throws IOException, ApiException
      Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      domainId - domain ID (required)
      body - TestMessage (optional)
      Returns:
      TestMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainTestconnectionWithHttpInfo

      public ApiResponse<TestMessage> postRoutingEmailDomainTestconnectionWithHttpInfo(String domainId, TestMessage body) throws IOException
      Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      domainId - domain ID (required)
      body - TestMessage (optional)
      Returns:
      TestMessage
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainTestconnection

      public TestMessage postRoutingEmailDomainTestconnection(PostRoutingEmailDomainTestconnectionRequest request) throws IOException, ApiException
      Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      request - The request object
      Returns:
      TestMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainTestconnection

      public ApiResponse<TestMessage> postRoutingEmailDomainTestconnection(ApiRequest<TestMessage> request) throws IOException
      Tests the custom SMTP server integration connection set on this ACD domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainVerification

      public VerificationResult postRoutingEmailDomainVerification(String domainId) throws IOException, ApiException
      Restart domain verification
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainVerificationWithHttpInfo

      public ApiResponse<VerificationResult> postRoutingEmailDomainVerificationWithHttpInfo(String domainId) throws IOException
      Restart domain verification
      Parameters:
      domainId - domain ID (required)
      Returns:
      VerificationResult
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomainVerification

      public VerificationResult postRoutingEmailDomainVerification(PostRoutingEmailDomainVerificationRequest request) throws IOException, ApiException
      Restart domain verification
      Parameters:
      request - The request object
      Returns:
      VerificationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainVerification

      public ApiResponse<VerificationResult> postRoutingEmailDomainVerification(ApiRequest<Void> request) throws IOException
      Restart domain verification
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomains

      public InboundDomain postRoutingEmailDomains(InboundDomainCreateRequest body) throws IOException, ApiException
      Create a domain
      Parameters:
      body - Domain (required)
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomainsWithHttpInfo

      public ApiResponse<InboundDomain> postRoutingEmailDomainsWithHttpInfo(InboundDomainCreateRequest body) throws IOException
      Create a domain
      Parameters:
      body - Domain (required)
      Returns:
      InboundDomain
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailDomains

      public InboundDomain postRoutingEmailDomains(PostRoutingEmailDomainsRequest request) throws IOException, ApiException
      Create a domain
      Parameters:
      request - The request object
      Returns:
      InboundDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailDomains

      public ApiResponse<InboundDomain> postRoutingEmailDomains(ApiRequest<InboundDomainCreateRequest> request) throws IOException
      Create a domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainTestconnection

      public TestMessage postRoutingEmailOutboundDomainTestconnection(String domainId, TestMessage body) throws IOException, ApiException
      Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      domainId - domain ID (required)
      body - TestMessage (optional)
      Returns:
      TestMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainTestconnectionWithHttpInfo

      public ApiResponse<TestMessage> postRoutingEmailOutboundDomainTestconnectionWithHttpInfo(String domainId, TestMessage body) throws IOException
      Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      domainId - domain ID (required)
      body - TestMessage (optional)
      Returns:
      TestMessage
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainTestconnection

      public TestMessage postRoutingEmailOutboundDomainTestconnection(PostRoutingEmailOutboundDomainTestconnectionRequest request) throws IOException, ApiException
      Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      request - The request object
      Returns:
      TestMessage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainTestconnection

      public ApiResponse<TestMessage> postRoutingEmailOutboundDomainTestconnection(ApiRequest<TestMessage> request) throws IOException
      Tests the custom SMTP server integration connection set on this outbound domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomains

      public EmailOutboundDomainResult postRoutingEmailOutboundDomains(OutboundDomainCreateRequest body) throws IOException, ApiException
      Create a domain
      Parameters:
      body - Domain (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainsWithHttpInfo

      public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomainsWithHttpInfo(OutboundDomainCreateRequest body) throws IOException
      Create a domain
      Parameters:
      body - Domain (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomains

      public EmailOutboundDomainResult postRoutingEmailOutboundDomains(PostRoutingEmailOutboundDomainsRequest request) throws IOException, ApiException
      Create a domain
      Parameters:
      request - The request object
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomains

      public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomains(ApiRequest<OutboundDomainCreateRequest> request) throws IOException
      Create a domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainsSimulated

      public EmailOutboundDomainResult postRoutingEmailOutboundDomainsSimulated(OutboundDomainCreateRequest body) throws IOException, ApiException
      Create a simulated domain
      Parameters:
      body - Domain (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainsSimulatedWithHttpInfo

      public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomainsSimulatedWithHttpInfo(OutboundDomainCreateRequest body) throws IOException
      Create a simulated domain
      Parameters:
      body - Domain (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainsSimulated

      public EmailOutboundDomainResult postRoutingEmailOutboundDomainsSimulated(PostRoutingEmailOutboundDomainsSimulatedRequest request) throws IOException, ApiException
      Create a simulated domain
      Parameters:
      request - The request object
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailOutboundDomainsSimulated

      public ApiResponse<EmailOutboundDomainResult> postRoutingEmailOutboundDomainsSimulated(ApiRequest<OutboundDomainCreateRequest> request) throws IOException
      Create a simulated domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailSetting

      public EmailSetting postRoutingEmailSetting(EmailSetting body) throws IOException, ApiException
      Create a new email setting. Used to define various settings, that can then be associated with email domains
      Parameters:
      body - EmailSetting (required)
      Returns:
      EmailSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailSettingWithHttpInfo

      public ApiResponse<EmailSetting> postRoutingEmailSettingWithHttpInfo(EmailSetting body) throws IOException
      Create a new email setting. Used to define various settings, that can then be associated with email domains
      Parameters:
      body - EmailSetting (required)
      Returns:
      EmailSetting
      Throws:
      IOException - if the request fails to be processed
    • postRoutingEmailSetting

      public EmailSetting postRoutingEmailSetting(PostRoutingEmailSettingRequest request) throws IOException, ApiException
      Create a new email setting. Used to define various settings, that can then be associated with email domains
      Parameters:
      request - The request object
      Returns:
      EmailSetting
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingEmailSetting

      public ApiResponse<EmailSetting> postRoutingEmailSetting(ApiRequest<EmailSetting> request) throws IOException
      Create a new email setting. Used to define various settings, that can then be associated with email domains
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingLanguages

      public Language postRoutingLanguages(Language body) throws IOException, ApiException
      Create Language
      Parameters:
      body - Language (required)
      Returns:
      Language
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingLanguagesWithHttpInfo

      public ApiResponse<Language> postRoutingLanguagesWithHttpInfo(Language body) throws IOException
      Create Language
      Parameters:
      body - Language (required)
      Returns:
      Language
      Throws:
      IOException - if the request fails to be processed
    • postRoutingLanguages

      public Language postRoutingLanguages(PostRoutingLanguagesRequest request) throws IOException, ApiException
      Create Language
      Parameters:
      request - The request object
      Returns:
      Language
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingLanguages

      public ApiResponse<Language> postRoutingLanguages(ApiRequest<Language> request) throws IOException
      Create Language
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingPredictors

      public Predictor postRoutingPredictors(CreatePredictorRequest body) throws IOException, ApiException
      Create a predictor.
      Parameters:
      body - (optional)
      Returns:
      Predictor
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingPredictorsWithHttpInfo

      public ApiResponse<Predictor> postRoutingPredictorsWithHttpInfo(CreatePredictorRequest body) throws IOException
      Create a predictor.
      Parameters:
      body - (optional)
      Returns:
      Predictor
      Throws:
      IOException - if the request fails to be processed
    • postRoutingPredictors

      public Predictor postRoutingPredictors(PostRoutingPredictorsRequest request) throws IOException, ApiException
      Create a predictor.
      Parameters:
      request - The request object
      Returns:
      Predictor
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingPredictors

      public ApiResponse<Predictor> postRoutingPredictors(ApiRequest<CreatePredictorRequest> request) throws IOException
      Create a predictor.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingPredictorsKeyperformanceindicators

      public KeyPerformanceIndicator postRoutingPredictorsKeyperformanceindicators(CreateKpiRequest body) throws IOException, ApiException
      Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - request (required)
      Returns:
      KeyPerformanceIndicator
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingPredictorsKeyperformanceindicatorsWithHttpInfo

      public ApiResponse<KeyPerformanceIndicator> postRoutingPredictorsKeyperformanceindicatorsWithHttpInfo(CreateKpiRequest body) throws IOException
      Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - request (required)
      Returns:
      KeyPerformanceIndicator
      Throws:
      IOException - if the request fails to be processed
    • postRoutingPredictorsKeyperformanceindicators

      public KeyPerformanceIndicator postRoutingPredictorsKeyperformanceindicators(PostRoutingPredictorsKeyperformanceindicatorsRequest request) throws IOException, ApiException
      Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators 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:
      KeyPerformanceIndicator
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingPredictorsKeyperformanceindicators

      public ApiResponse<KeyPerformanceIndicator> postRoutingPredictorsKeyperformanceindicators(ApiRequest<CreateKpiRequest> request) throws IOException
      Create a custom Key Performance Indicator. postRoutingPredictorsKeyperformanceindicators 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
    • postRoutingQueueMembers

      public void postRoutingQueueMembers(String queueId, List<WritableEntity> body, Boolean delete) throws IOException, ApiException
      Bulk add or delete up to 100 queue members
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      delete - True to delete queue members (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueueMembersWithHttpInfo

      public ApiResponse<Void> postRoutingQueueMembersWithHttpInfo(String queueId, List<WritableEntity> body, Boolean delete) throws IOException
      Bulk add or delete up to 100 queue members
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      delete - True to delete queue members (optional, default to false)
      Throws:
      IOException - if the request fails to be processed
    • postRoutingQueueMembers

      public void postRoutingQueueMembers(PostRoutingQueueMembersRequest request) throws IOException, ApiException
      Bulk add or delete up to 100 queue members
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueueMembers

      public ApiResponse<Void> postRoutingQueueMembers(ApiRequest<List<WritableEntity>> request) throws IOException
      Bulk add or delete up to 100 queue members
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingQueueUsers

      public void postRoutingQueueUsers(String queueId, List<WritableEntity> body, Boolean delete) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      delete - True to delete queue members (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueueUsersWithHttpInfo

      public ApiResponse<Void> postRoutingQueueUsersWithHttpInfo(String queueId, List<WritableEntity> body, Boolean delete) throws IOException
      Deprecated.
      DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.
      Parameters:
      queueId - Queue ID (required)
      body - Queue Members (required)
      delete - True to delete queue members (optional, default to false)
      Throws:
      IOException - if the request fails to be processed
    • postRoutingQueueUsers

      public void postRoutingQueueUsers(PostRoutingQueueUsersRequest request) throws IOException, ApiException
      Deprecated.
      DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueueUsers

      public ApiResponse<Void> postRoutingQueueUsers(ApiRequest<List<WritableEntity>> request) throws IOException
      Deprecated.
      DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingQueueWrapupcodes

      public List<WrapupCode> postRoutingQueueWrapupcodes(String queueId, List<WrapUpCodeReference> body) throws IOException, ApiException
      Add up to 100 wrap-up codes to a queue
      Parameters:
      queueId - Queue ID (required)
      body - List of wrapup codes (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueueWrapupcodesWithHttpInfo

      public ApiResponse<List<WrapupCode>> postRoutingQueueWrapupcodesWithHttpInfo(String queueId, List<WrapUpCodeReference> body) throws IOException
      Add up to 100 wrap-up codes to a queue
      Parameters:
      queueId - Queue ID (required)
      body - List of wrapup codes (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed
    • postRoutingQueueWrapupcodes

      public List<WrapupCode> postRoutingQueueWrapupcodes(PostRoutingQueueWrapupcodesRequest request) throws IOException, ApiException
      Add up to 100 wrap-up codes to a queue
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueueWrapupcodes

      public ApiResponse<List<WrapupCode>> postRoutingQueueWrapupcodes(ApiRequest<List<WrapUpCodeReference>> request) throws IOException
      Add up to 100 wrap-up codes to a queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingQueues

      public Queue postRoutingQueues(CreateQueueRequest body) throws IOException, ApiException
      Create a queue
      Parameters:
      body - Queue (required)
      Returns:
      Queue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueuesWithHttpInfo

      public ApiResponse<Queue> postRoutingQueuesWithHttpInfo(CreateQueueRequest body) throws IOException
      Create a queue
      Parameters:
      body - Queue (required)
      Returns:
      Queue
      Throws:
      IOException - if the request fails to be processed
    • postRoutingQueues

      public Queue postRoutingQueues(PostRoutingQueuesRequest request) throws IOException, ApiException
      Create a queue
      Parameters:
      request - The request object
      Returns:
      Queue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingQueues

      public ApiResponse<Queue> postRoutingQueues(ApiRequest<CreateQueueRequest> request) throws IOException
      Create a queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkillexpressionsValidate

      public SkillExpressionValidationResult postRoutingSkillexpressionsValidate(SkillExpressionData body) throws IOException, ApiException
      Validate and normalize a skill expression
      Parameters:
      body - Skill expression data to validate (required)
      Returns:
      SkillExpressionValidationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkillexpressionsValidateWithHttpInfo

      public ApiResponse<SkillExpressionValidationResult> postRoutingSkillexpressionsValidateWithHttpInfo(SkillExpressionData body) throws IOException
      Validate and normalize a skill expression
      Parameters:
      body - Skill expression data to validate (required)
      Returns:
      SkillExpressionValidationResult
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkillexpressionsValidate

      public SkillExpressionValidationResult postRoutingSkillexpressionsValidate(PostRoutingSkillexpressionsValidateRequest request) throws IOException, ApiException
      Validate and normalize a skill expression
      Parameters:
      request - The request object
      Returns:
      SkillExpressionValidationResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkillexpressionsValidate

      public ApiResponse<SkillExpressionValidationResult> postRoutingSkillexpressionsValidate(ApiRequest<SkillExpressionData> request) throws IOException
      Validate and normalize a skill expression
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkillgroupMembersDivisions

      public void postRoutingSkillgroupMembersDivisions(String skillGroupId, SkillGroupMemberDivisions body) throws IOException, ApiException
      Add or remove member divisions for this skill group.
      Parameters:
      skillGroupId - Skill Group ID (required)
      body - (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkillgroupMembersDivisionsWithHttpInfo

      public ApiResponse<Void> postRoutingSkillgroupMembersDivisionsWithHttpInfo(String skillGroupId, SkillGroupMemberDivisions body) throws IOException
      Add or remove member divisions for this skill group.
      Parameters:
      skillGroupId - Skill Group ID (required)
      body - (optional)
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkillgroupMembersDivisions

      public void postRoutingSkillgroupMembersDivisions(PostRoutingSkillgroupMembersDivisionsRequest request) throws IOException, ApiException
      Add or remove member divisions for this skill group.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkillgroupMembersDivisions

      public ApiResponse<Void> postRoutingSkillgroupMembersDivisions(ApiRequest<SkillGroupMemberDivisions> request) throws IOException
      Add or remove member divisions for this skill group.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkillgroups

      Create a skill group
      Parameters:
      body - Create skill group (required)
      Returns:
      SkillGroupWithMemberDivisions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkillgroupsWithHttpInfo

      public ApiResponse<SkillGroupWithMemberDivisions> postRoutingSkillgroupsWithHttpInfo(SkillGroupWithMemberDivisions body) throws IOException
      Create a skill group
      Parameters:
      body - Create skill group (required)
      Returns:
      SkillGroupWithMemberDivisions
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkillgroups

      Create a skill group
      Parameters:
      request - The request object
      Returns:
      SkillGroupWithMemberDivisions
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkillgroups

      Create a skill group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkills

      public RoutingSkill postRoutingSkills(CreateRoutingSkill body) throws IOException, ApiException
      Create Skill
      Parameters:
      body - Skill (required)
      Returns:
      RoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkillsWithHttpInfo

      public ApiResponse<RoutingSkill> postRoutingSkillsWithHttpInfo(CreateRoutingSkill body) throws IOException
      Create Skill
      Parameters:
      body - Skill (required)
      Returns:
      RoutingSkill
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSkills

      public RoutingSkill postRoutingSkills(PostRoutingSkillsRequest request) throws IOException, ApiException
      Create Skill
      Parameters:
      request - The request object
      Returns:
      RoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSkills

      public ApiResponse<RoutingSkill> postRoutingSkills(ApiRequest<CreateRoutingSkill> request) throws IOException
      Create Skill
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSmsAddresses

      public SmsAddress postRoutingSmsAddresses(SmsAddressProvision body) throws IOException, ApiException
      Provision an Address for SMS
      Parameters:
      body - SmsAddress (required)
      Returns:
      SmsAddress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsAddressesWithHttpInfo

      public ApiResponse<SmsAddress> postRoutingSmsAddressesWithHttpInfo(SmsAddressProvision body) throws IOException
      Provision an Address for SMS
      Parameters:
      body - SmsAddress (required)
      Returns:
      SmsAddress
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSmsAddresses

      public SmsAddress postRoutingSmsAddresses(PostRoutingSmsAddressesRequest request) throws IOException, ApiException
      Provision an Address for SMS
      Parameters:
      request - The request object
      Returns:
      SmsAddress
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsAddresses

      public ApiResponse<SmsAddress> postRoutingSmsAddresses(ApiRequest<SmsAddressProvision> request) throws IOException
      Provision an Address for SMS
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbers

      public SmsPhoneNumber postRoutingSmsPhonenumbers(SmsPhoneNumberProvision body) throws IOException, ApiException
      Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.
      Parameters:
      body - SmsPhoneNumber (required)
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersWithHttpInfo

      public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersWithHttpInfo(SmsPhoneNumberProvision body) throws IOException
      Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.
      Parameters:
      body - SmsPhoneNumber (required)
      Returns:
      SmsPhoneNumber
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbers

      public SmsPhoneNumber postRoutingSmsPhonenumbers(PostRoutingSmsPhonenumbersRequest request) throws IOException, ApiException
      Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.
      Parameters:
      request - The request object
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbers

      public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbers(ApiRequest<SmsPhoneNumberProvision> request) throws IOException
      Provision a phone number for SMS When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the \"SMS Default\" profile. This default profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersAlphanumeric

      public SmsPhoneNumber postRoutingSmsPhonenumbersAlphanumeric(SmsAlphanumericProvision body) throws IOException, ApiException
      Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - SmsPhoneNumber (required)
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersAlphanumericWithHttpInfo

      public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersAlphanumericWithHttpInfo(SmsAlphanumericProvision body) throws IOException
      Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - SmsPhoneNumber (required)
      Returns:
      SmsPhoneNumber
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersAlphanumeric

      public SmsPhoneNumber postRoutingSmsPhonenumbersAlphanumeric(PostRoutingSmsPhonenumbersAlphanumericRequest request) throws IOException, ApiException
      Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric 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:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersAlphanumeric

      public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersAlphanumeric(ApiRequest<SmsAlphanumericProvision> request) throws IOException
      Provision an alphanumeric number for SMS postRoutingSmsPhonenumbersAlphanumeric 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
    • postRoutingSmsPhonenumbersImport

      public SmsPhoneNumber postRoutingSmsPhonenumbersImport(SmsPhoneNumberImport body) throws IOException, ApiException
      Imports a phone number for SMS
      Parameters:
      body - SmsPhoneNumber (required)
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersImportWithHttpInfo

      public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersImportWithHttpInfo(SmsPhoneNumberImport body) throws IOException
      Imports a phone number for SMS
      Parameters:
      body - SmsPhoneNumber (required)
      Returns:
      SmsPhoneNumber
      Throws:
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersImport

      public SmsPhoneNumber postRoutingSmsPhonenumbersImport(PostRoutingSmsPhonenumbersImportRequest request) throws IOException, ApiException
      Imports a phone number for SMS
      Parameters:
      request - The request object
      Returns:
      SmsPhoneNumber
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingSmsPhonenumbersImport

      public ApiResponse<SmsPhoneNumber> postRoutingSmsPhonenumbersImport(ApiRequest<SmsPhoneNumberImport> request) throws IOException
      Imports a phone number for SMS
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingUtilizationLabels

      public UtilizationLabel postRoutingUtilizationLabels(CreateUtilizationLabelRequest body) throws IOException, ApiException
      Create a utilization label
      Parameters:
      body - UtilizationLabel (required)
      Returns:
      UtilizationLabel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingUtilizationLabelsWithHttpInfo

      public ApiResponse<UtilizationLabel> postRoutingUtilizationLabelsWithHttpInfo(CreateUtilizationLabelRequest body) throws IOException
      Create a utilization label
      Parameters:
      body - UtilizationLabel (required)
      Returns:
      UtilizationLabel
      Throws:
      IOException - if the request fails to be processed
    • postRoutingUtilizationLabels

      public UtilizationLabel postRoutingUtilizationLabels(PostRoutingUtilizationLabelsRequest request) throws IOException, ApiException
      Create a utilization label
      Parameters:
      request - The request object
      Returns:
      UtilizationLabel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingUtilizationLabels

      public ApiResponse<UtilizationLabel> postRoutingUtilizationLabels(ApiRequest<CreateUtilizationLabelRequest> request) throws IOException
      Create a utilization label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postRoutingWrapupcodes

      public WrapupCode postRoutingWrapupcodes(WrapupCodeRequest body) throws IOException, ApiException
      Create a wrap-up code
      Parameters:
      body - WrapupCode (required)
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingWrapupcodesWithHttpInfo

      public ApiResponse<WrapupCode> postRoutingWrapupcodesWithHttpInfo(WrapupCodeRequest body) throws IOException
      Create a wrap-up code
      Parameters:
      body - WrapupCode (required)
      Returns:
      WrapupCode
      Throws:
      IOException - if the request fails to be processed
    • postRoutingWrapupcodes

      public WrapupCode postRoutingWrapupcodes(PostRoutingWrapupcodesRequest request) throws IOException, ApiException
      Create a wrap-up code
      Parameters:
      request - The request object
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postRoutingWrapupcodes

      public ApiResponse<WrapupCode> postRoutingWrapupcodes(ApiRequest<WrapupCodeRequest> request) throws IOException
      Create a wrap-up code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postUserRoutinglanguages

      public UserRoutingLanguage postUserRoutinglanguages(String userId, UserRoutingLanguagePost body) throws IOException, ApiException
      Assign a routing language to a user
      Parameters:
      userId - User ID (required)
      body - Language (required)
      Returns:
      UserRoutingLanguage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postUserRoutinglanguagesWithHttpInfo

      public ApiResponse<UserRoutingLanguage> postUserRoutinglanguagesWithHttpInfo(String userId, UserRoutingLanguagePost body) throws IOException
      Assign a routing language to a user
      Parameters:
      userId - User ID (required)
      body - Language (required)
      Returns:
      UserRoutingLanguage
      Throws:
      IOException - if the request fails to be processed
    • postUserRoutinglanguages

      public UserRoutingLanguage postUserRoutinglanguages(PostUserRoutinglanguagesRequest request) throws IOException, ApiException
      Assign a routing language to a user
      Parameters:
      request - The request object
      Returns:
      UserRoutingLanguage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postUserRoutinglanguages

      public ApiResponse<UserRoutingLanguage> postUserRoutinglanguages(ApiRequest<UserRoutingLanguagePost> request) throws IOException
      Assign a routing language to a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • postUserRoutingskills

      public UserRoutingSkill postUserRoutingskills(String userId, UserRoutingSkillPost body) throws IOException, ApiException
      Assign a routing skill to a user
      Parameters:
      userId - User ID (required)
      body - Skill (required)
      Returns:
      UserRoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postUserRoutingskillsWithHttpInfo

      public ApiResponse<UserRoutingSkill> postUserRoutingskillsWithHttpInfo(String userId, UserRoutingSkillPost body) throws IOException
      Assign a routing skill to a user
      Parameters:
      userId - User ID (required)
      body - Skill (required)
      Returns:
      UserRoutingSkill
      Throws:
      IOException - if the request fails to be processed
    • postUserRoutingskills

      public UserRoutingSkill postUserRoutingskills(PostUserRoutingskillsRequest request) throws IOException, ApiException
      Assign a routing skill to a user
      Parameters:
      request - The request object
      Returns:
      UserRoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • postUserRoutingskills

      public ApiResponse<UserRoutingSkill> postUserRoutingskills(ApiRequest<UserRoutingSkillPost> request) throws IOException
      Assign a routing skill to a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingDirectroutingbackupSettingsMe

      public AgentDirectRoutingBackupSettings putRoutingDirectroutingbackupSettingsMe(AgentDirectRoutingBackupSettings body) throws IOException, ApiException
      Update the user's Direct Routing Backup settings.
      Parameters:
      body - directRoutingBackup (required)
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingDirectroutingbackupSettingsMeWithHttpInfo

      public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingDirectroutingbackupSettingsMeWithHttpInfo(AgentDirectRoutingBackupSettings body) throws IOException
      Update the user's Direct Routing Backup settings.
      Parameters:
      body - directRoutingBackup (required)
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      IOException - if the request fails to be processed
    • putRoutingDirectroutingbackupSettingsMe

      public AgentDirectRoutingBackupSettings putRoutingDirectroutingbackupSettingsMe(PutRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException
      Update the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingDirectroutingbackupSettingsMe

      public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingDirectroutingbackupSettingsMe(ApiRequest<AgentDirectRoutingBackupSettings> request) throws IOException
      Update the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRoute

      public InboundRoute putRoutingEmailDomainRoute(String domainName, String routeId, InboundRoute body) throws IOException, ApiException
      Update a route
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      body - Route (required)
      Returns:
      InboundRoute
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRouteWithHttpInfo

      public ApiResponse<InboundRoute> putRoutingEmailDomainRouteWithHttpInfo(String domainName, String routeId, InboundRoute body) throws IOException
      Update a route
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      body - Route (required)
      Returns:
      InboundRoute
      Throws:
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRoute

      public InboundRoute putRoutingEmailDomainRoute(PutRoutingEmailDomainRouteRequest request) throws IOException, ApiException
      Update a route
      Parameters:
      request - The request object
      Returns:
      InboundRoute
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRoute

      public ApiResponse<InboundRoute> putRoutingEmailDomainRoute(ApiRequest<InboundRoute> request) throws IOException
      Update a route
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRouteIdentityresolution

      public RouteIdentityResolutionConfig putRoutingEmailDomainRouteIdentityresolution(String domainName, String routeId, RouteIdentityResolutionConfig body) throws IOException, ApiException
      Update identity resolution settings for a route.
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      body - (required)
      Returns:
      RouteIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRouteIdentityresolutionWithHttpInfo

      public ApiResponse<RouteIdentityResolutionConfig> putRoutingEmailDomainRouteIdentityresolutionWithHttpInfo(String domainName, String routeId, RouteIdentityResolutionConfig body) throws IOException
      Update identity resolution settings for a route.
      Parameters:
      domainName - email domain (required)
      routeId - route ID (required)
      body - (required)
      Returns:
      RouteIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRouteIdentityresolution

      public RouteIdentityResolutionConfig putRoutingEmailDomainRouteIdentityresolution(PutRoutingEmailDomainRouteIdentityresolutionRequest request) throws IOException, ApiException
      Update identity resolution settings for a route.
      Parameters:
      request - The request object
      Returns:
      RouteIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingEmailDomainRouteIdentityresolution

      public ApiResponse<RouteIdentityResolutionConfig> putRoutingEmailDomainRouteIdentityresolution(ApiRequest<RouteIdentityResolutionConfig> request) throws IOException
      Update identity resolution settings for a route.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingEmailOutboundDomainActivation

      public EmailOutboundDomainResult putRoutingEmailOutboundDomainActivation(String domainId) throws IOException, ApiException
      Request an activation status (cname + dkim) update of an outbound domain
      Parameters:
      domainId - domain ID (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingEmailOutboundDomainActivationWithHttpInfo

      public ApiResponse<EmailOutboundDomainResult> putRoutingEmailOutboundDomainActivationWithHttpInfo(String domainId) throws IOException
      Request an activation status (cname + dkim) update of an outbound domain
      Parameters:
      domainId - domain ID (required)
      Returns:
      EmailOutboundDomainResult
      Throws:
      IOException - if the request fails to be processed
    • putRoutingEmailOutboundDomainActivation

      public EmailOutboundDomainResult putRoutingEmailOutboundDomainActivation(PutRoutingEmailOutboundDomainActivationRequest request) throws IOException, ApiException
      Request an activation status (cname + dkim) update of an outbound domain
      Parameters:
      request - The request object
      Returns:
      EmailOutboundDomainResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingEmailOutboundDomainActivation

      public ApiResponse<EmailOutboundDomainResult> putRoutingEmailOutboundDomainActivation(ApiRequest<Void> request) throws IOException
      Request an activation status (cname + dkim) update of an outbound domain
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingMessageRecipient

      public Recipient putRoutingMessageRecipient(String recipientId, RecipientRequest body) throws IOException, ApiException
      Update a recipient
      Parameters:
      recipientId - Recipient ID (required)
      body - Recipient (required)
      Returns:
      Recipient
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingMessageRecipientWithHttpInfo

      public ApiResponse<Recipient> putRoutingMessageRecipientWithHttpInfo(String recipientId, RecipientRequest body) throws IOException
      Update a recipient
      Parameters:
      recipientId - Recipient ID (required)
      body - Recipient (required)
      Returns:
      Recipient
      Throws:
      IOException - if the request fails to be processed
    • putRoutingMessageRecipient

      public Recipient putRoutingMessageRecipient(PutRoutingMessageRecipientRequest request) throws IOException, ApiException
      Update a recipient
      Parameters:
      request - The request object
      Returns:
      Recipient
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingMessageRecipient

      public ApiResponse<Recipient> putRoutingMessageRecipient(ApiRequest<RecipientRequest> request) throws IOException
      Update a recipient
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingQueue

      public Queue putRoutingQueue(String queueId, QueueRequest body) throws IOException, ApiException
      Update a queue
      Parameters:
      queueId - Queue ID (required)
      body - Queue (required)
      Returns:
      Queue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingQueueWithHttpInfo

      public ApiResponse<Queue> putRoutingQueueWithHttpInfo(String queueId, QueueRequest body) throws IOException
      Update a queue
      Parameters:
      queueId - Queue ID (required)
      body - Queue (required)
      Returns:
      Queue
      Throws:
      IOException - if the request fails to be processed
    • putRoutingQueue

      public Queue putRoutingQueue(PutRoutingQueueRequest request) throws IOException, ApiException
      Update a queue
      Parameters:
      request - The request object
      Returns:
      Queue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingQueue

      public ApiResponse<Queue> putRoutingQueue(ApiRequest<QueueRequest> request) throws IOException
      Update a queue
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingQueueIdentityresolution

      public IdentityResolutionQueueConfig putRoutingQueueIdentityresolution(String queueId, IdentityResolutionQueueConfig body) throws IOException, ApiException
      Update Queue IdentityResolution Settings.
      Parameters:
      queueId - Queue ID (required)
      body - (required)
      Returns:
      IdentityResolutionQueueConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingQueueIdentityresolutionWithHttpInfo

      public ApiResponse<IdentityResolutionQueueConfig> putRoutingQueueIdentityresolutionWithHttpInfo(String queueId, IdentityResolutionQueueConfig body) throws IOException
      Update Queue IdentityResolution Settings.
      Parameters:
      queueId - Queue ID (required)
      body - (required)
      Returns:
      IdentityResolutionQueueConfig
      Throws:
      IOException - if the request fails to be processed
    • putRoutingQueueIdentityresolution

      public IdentityResolutionQueueConfig putRoutingQueueIdentityresolution(PutRoutingQueueIdentityresolutionRequest request) throws IOException, ApiException
      Update Queue IdentityResolution Settings.
      Parameters:
      request - The request object
      Returns:
      IdentityResolutionQueueConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingQueueIdentityresolution

      public ApiResponse<IdentityResolutionQueueConfig> putRoutingQueueIdentityresolution(ApiRequest<IdentityResolutionQueueConfig> request) throws IOException
      Update Queue IdentityResolution Settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingSettings

      public RoutingSettings putRoutingSettings(RoutingSettings body) throws IOException, ApiException
      Update an organization's routing settings
      Parameters:
      body - Organization Settings (required)
      Returns:
      RoutingSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingSettingsWithHttpInfo

      public ApiResponse<RoutingSettings> putRoutingSettingsWithHttpInfo(RoutingSettings body) throws IOException
      Update an organization's routing settings
      Parameters:
      body - Organization Settings (required)
      Returns:
      RoutingSettings
      Throws:
      IOException - if the request fails to be processed
    • putRoutingSettings

      public RoutingSettings putRoutingSettings(PutRoutingSettingsRequest request) throws IOException, ApiException
      Update an organization's routing settings
      Parameters:
      request - The request object
      Returns:
      RoutingSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingSettings

      public ApiResponse<RoutingSettings> putRoutingSettings(ApiRequest<RoutingSettings> request) throws IOException
      Update an organization's routing settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingSettingsTranscription

      public TranscriptionSettings putRoutingSettingsTranscription(TranscriptionSettings body) throws IOException, ApiException
      Update Transcription Settings
      Parameters:
      body - Organization Settings (required)
      Returns:
      TranscriptionSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingSettingsTranscriptionWithHttpInfo

      public ApiResponse<TranscriptionSettings> putRoutingSettingsTranscriptionWithHttpInfo(TranscriptionSettings body) throws IOException
      Update Transcription Settings
      Parameters:
      body - Organization Settings (required)
      Returns:
      TranscriptionSettings
      Throws:
      IOException - if the request fails to be processed
    • putRoutingSettingsTranscription

      public TranscriptionSettings putRoutingSettingsTranscription(PutRoutingSettingsTranscriptionRequest request) throws IOException, ApiException
      Update Transcription Settings
      Parameters:
      request - The request object
      Returns:
      TranscriptionSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingSettingsTranscription

      public ApiResponse<TranscriptionSettings> putRoutingSettingsTranscription(ApiRequest<TranscriptionSettings> request) throws IOException
      Update Transcription Settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingSmsIdentityresolutionPhonenumber

      public SmsIdentityResolutionConfig putRoutingSmsIdentityresolutionPhonenumber(String addressId, SmsIdentityResolutionConfig body) throws IOException, ApiException
      Update an SMS identity resolution settings.
      Parameters:
      addressId - Address ID (required)
      body - (required)
      Returns:
      SmsIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingSmsIdentityresolutionPhonenumberWithHttpInfo

      public ApiResponse<SmsIdentityResolutionConfig> putRoutingSmsIdentityresolutionPhonenumberWithHttpInfo(String addressId, SmsIdentityResolutionConfig body) throws IOException
      Update an SMS identity resolution settings.
      Parameters:
      addressId - Address ID (required)
      body - (required)
      Returns:
      SmsIdentityResolutionConfig
      Throws:
      IOException - if the request fails to be processed
    • putRoutingSmsIdentityresolutionPhonenumber

      public SmsIdentityResolutionConfig putRoutingSmsIdentityresolutionPhonenumber(PutRoutingSmsIdentityresolutionPhonenumberRequest request) throws IOException, ApiException
      Update an SMS identity resolution settings.
      Parameters:
      request - The request object
      Returns:
      SmsIdentityResolutionConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingSmsIdentityresolutionPhonenumber

      public ApiResponse<SmsIdentityResolutionConfig> putRoutingSmsIdentityresolutionPhonenumber(ApiRequest<SmsIdentityResolutionConfig> request) throws IOException
      Update an SMS identity resolution settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUserDirectroutingbackupSettings

      public AgentDirectRoutingBackupSettings putRoutingUserDirectroutingbackupSettings(String userId, AgentDirectRoutingBackupSettings body) throws IOException, ApiException
      Update the user's Direct Routing Backup settings.
      Parameters:
      userId - User ID (required)
      body - directRoutingBackup (required)
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUserDirectroutingbackupSettingsWithHttpInfo

      public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId, AgentDirectRoutingBackupSettings body) throws IOException
      Update the user's Direct Routing Backup settings.
      Parameters:
      userId - User ID (required)
      body - directRoutingBackup (required)
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUserDirectroutingbackupSettings

      public AgentDirectRoutingBackupSettings putRoutingUserDirectroutingbackupSettings(PutRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException
      Update the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      AgentDirectRoutingBackupSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUserDirectroutingbackupSettings

      public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingUserDirectroutingbackupSettings(ApiRequest<AgentDirectRoutingBackupSettings> request) throws IOException
      Update the user's Direct Routing Backup settings.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUserUtilization

      public AgentMaxUtilizationResponse putRoutingUserUtilization(String userId, UtilizationRequest body) throws IOException, ApiException
      Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.
      Parameters:
      userId - User ID (required)
      body - utilization (required)
      Returns:
      AgentMaxUtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUserUtilizationWithHttpInfo

      public ApiResponse<AgentMaxUtilizationResponse> putRoutingUserUtilizationWithHttpInfo(String userId, UtilizationRequest body) throws IOException
      Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.
      Parameters:
      userId - User ID (required)
      body - utilization (required)
      Returns:
      AgentMaxUtilizationResponse
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUserUtilization

      public AgentMaxUtilizationResponse putRoutingUserUtilization(PutRoutingUserUtilizationRequest request) throws IOException, ApiException
      Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.
      Parameters:
      request - The request object
      Returns:
      AgentMaxUtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUserUtilization

      public ApiResponse<AgentMaxUtilizationResponse> putRoutingUserUtilization(ApiRequest<UtilizationRequest> request) throws IOException
      Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUtilization

      public UtilizationResponse putRoutingUtilization(UtilizationRequest body) throws IOException, ApiException
      Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.
      Parameters:
      body - utilization (required)
      Returns:
      UtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUtilizationWithHttpInfo

      public ApiResponse<UtilizationResponse> putRoutingUtilizationWithHttpInfo(UtilizationRequest body) throws IOException
      Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.
      Parameters:
      body - utilization (required)
      Returns:
      UtilizationResponse
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUtilization

      public UtilizationResponse putRoutingUtilization(PutRoutingUtilizationRequest request) throws IOException, ApiException
      Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.
      Parameters:
      request - The request object
      Returns:
      UtilizationResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUtilization

      public ApiResponse<UtilizationResponse> putRoutingUtilization(ApiRequest<UtilizationRequest> request) throws IOException
      Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUtilizationLabel

      public UtilizationLabel putRoutingUtilizationLabel(String labelId, UpdateUtilizationLabelRequest body) throws IOException, ApiException
      Update a utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      body - UtilizationLabel (required)
      Returns:
      UtilizationLabel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUtilizationLabelWithHttpInfo

      public ApiResponse<UtilizationLabel> putRoutingUtilizationLabelWithHttpInfo(String labelId, UpdateUtilizationLabelRequest body) throws IOException
      Update a utilization label
      Parameters:
      labelId - Utilization Label ID (required)
      body - UtilizationLabel (required)
      Returns:
      UtilizationLabel
      Throws:
      IOException - if the request fails to be processed
    • putRoutingUtilizationLabel

      public UtilizationLabel putRoutingUtilizationLabel(PutRoutingUtilizationLabelRequest request) throws IOException, ApiException
      Update a utilization label
      Parameters:
      request - The request object
      Returns:
      UtilizationLabel
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingUtilizationLabel

      public ApiResponse<UtilizationLabel> putRoutingUtilizationLabel(ApiRequest<UpdateUtilizationLabelRequest> request) throws IOException
      Update a utilization label
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putRoutingWrapupcode

      public WrapupCode putRoutingWrapupcode(String codeId, WrapupCodeRequest body) throws IOException, ApiException
      Update wrap-up code
      Parameters:
      codeId - Wrapup Code ID (required)
      body - WrapupCode (required)
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingWrapupcodeWithHttpInfo

      public ApiResponse<WrapupCode> putRoutingWrapupcodeWithHttpInfo(String codeId, WrapupCodeRequest body) throws IOException
      Update wrap-up code
      Parameters:
      codeId - Wrapup Code ID (required)
      body - WrapupCode (required)
      Returns:
      WrapupCode
      Throws:
      IOException - if the request fails to be processed
    • putRoutingWrapupcode

      public WrapupCode putRoutingWrapupcode(PutRoutingWrapupcodeRequest request) throws IOException, ApiException
      Update wrap-up code
      Parameters:
      request - The request object
      Returns:
      WrapupCode
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putRoutingWrapupcode

      public ApiResponse<WrapupCode> putRoutingWrapupcode(ApiRequest<WrapupCodeRequest> request) throws IOException
      Update wrap-up code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putUserRoutingskill

      public UserRoutingSkill putUserRoutingskill(String userId, String skillId, UserRoutingSkill body) throws IOException, ApiException
      Update an assigned routing skill's proficiency
      Parameters:
      userId - User ID (required)
      skillId - skillId (required)
      body - Skill (required)
      Returns:
      UserRoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putUserRoutingskillWithHttpInfo

      public ApiResponse<UserRoutingSkill> putUserRoutingskillWithHttpInfo(String userId, String skillId, UserRoutingSkill body) throws IOException
      Update an assigned routing skill's proficiency
      Parameters:
      userId - User ID (required)
      skillId - skillId (required)
      body - Skill (required)
      Returns:
      UserRoutingSkill
      Throws:
      IOException - if the request fails to be processed
    • putUserRoutingskill

      public UserRoutingSkill putUserRoutingskill(PutUserRoutingskillRequest request) throws IOException, ApiException
      Update an assigned routing skill's proficiency
      Parameters:
      request - The request object
      Returns:
      UserRoutingSkill
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putUserRoutingskill

      public ApiResponse<UserRoutingSkill> putUserRoutingskill(ApiRequest<UserRoutingSkill> request) throws IOException
      Update an assigned routing skill's proficiency
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed
    • putUserRoutingskillsBulk

      public UserSkillEntityListing putUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) throws IOException, ApiException
      Assign multiple routing skills to a user, replacing any current assignments
      Parameters:
      userId - User ID (required)
      body - Skill (required)
      Returns:
      UserSkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putUserRoutingskillsBulkWithHttpInfo

      public ApiResponse<UserSkillEntityListing> putUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) throws IOException
      Assign multiple routing skills to a user, replacing any current assignments
      Parameters:
      userId - User ID (required)
      body - Skill (required)
      Returns:
      UserSkillEntityListing
      Throws:
      IOException - if the request fails to be processed
    • putUserRoutingskillsBulk

      public UserSkillEntityListing putUserRoutingskillsBulk(PutUserRoutingskillsBulkRequest request) throws IOException, ApiException
      Assign multiple routing skills to a user, replacing any current assignments
      Parameters:
      request - The request object
      Returns:
      UserSkillEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed
    • putUserRoutingskillsBulk

      public ApiResponse<UserSkillEntityListing> putUserRoutingskillsBulk(ApiRequest<List<UserRoutingSkillPost>> request) throws IOException
      Assign multiple routing skills to a user, replacing any current assignments
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed