Package com.mypurecloud.sdk.v2.api

Class LicenseApi

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

  • Constructor Details

    • LicenseApi

      public LicenseApi()

    • LicenseApi

      public LicenseApi(ApiClient apiClient)

  • Method Details

    • getLicenseDefinition

      public LicenseDefinition getLicenseDefinition(String licenseId) throws IOException, ApiException
      Get PureCloud license definition.
      Parameters:
      licenseId - ID (required)
      Returns:
      LicenseDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseDefinitionWithHttpInfo

      public ApiResponse<LicenseDefinition> getLicenseDefinitionWithHttpInfo(String licenseId) throws IOException
      Get PureCloud license definition.
      Parameters:
      licenseId - ID (required)
      Returns:
      LicenseDefinition
      Throws:
      IOException - if the request fails to be processed

    • getLicenseDefinition

      public LicenseDefinition getLicenseDefinition(GetLicenseDefinitionRequest request) throws IOException, ApiException
      Get PureCloud license definition.
      Parameters:
      request - The request object
      Returns:
      LicenseDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseDefinition

      public ApiResponse<LicenseDefinition> getLicenseDefinition(ApiRequest<Void> request) throws IOException
      Get PureCloud license definition.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLicenseDefinitions

      public List<LicenseDefinition> getLicenseDefinitions() throws IOException, ApiException
      Get all PureCloud license definitions available for the organization.
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseDefinitionsWithHttpInfo

      public ApiResponse<List<LicenseDefinition>> getLicenseDefinitionsWithHttpInfo() throws IOException
      Get all PureCloud license definitions available for the organization.
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • getLicenseDefinitions

      public List<LicenseDefinition> getLicenseDefinitions(GetLicenseDefinitionsRequest request) throws IOException, ApiException
      Get all PureCloud license definitions available for the organization.
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseDefinitions

      public ApiResponse<List<LicenseDefinition>> getLicenseDefinitions(ApiRequest<Void> request) throws IOException
      Get all PureCloud license definitions available for the organization.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLicenseToggle

      public LicenseOrgToggle getLicenseToggle(String featureName) throws IOException, ApiException
      Deprecated - no alternative required. This operation will always return 'true' for requested toggles
      Parameters:
      featureName - featureName (required)
      Returns:
      LicenseOrgToggle
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseToggleWithHttpInfo

      public ApiResponse<LicenseOrgToggle> getLicenseToggleWithHttpInfo(String featureName) throws IOException
      Deprecated - no alternative required. This operation will always return 'true' for requested toggles
      Parameters:
      featureName - featureName (required)
      Returns:
      LicenseOrgToggle
      Throws:
      IOException - if the request fails to be processed

    • getLicenseToggle

      public LicenseOrgToggle getLicenseToggle(GetLicenseToggleRequest request) throws IOException, ApiException
      Deprecated - no alternative required. This operation will always return 'true' for requested toggles
      Parameters:
      request - The request object
      Returns:
      LicenseOrgToggle
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseToggle

      public ApiResponse<LicenseOrgToggle> getLicenseToggle(ApiRequest<Void> request) throws IOException
      Deprecated - no alternative required. This operation will always return 'true' for requested toggles
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLicenseUser

      public LicenseUser getLicenseUser(String userId) throws IOException, ApiException
      Get licenses for specified user.
      Parameters:
      userId - ID (required)
      Returns:
      LicenseUser
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseUserWithHttpInfo

      public ApiResponse<LicenseUser> getLicenseUserWithHttpInfo(String userId) throws IOException
      Get licenses for specified user.
      Parameters:
      userId - ID (required)
      Returns:
      LicenseUser
      Throws:
      IOException - if the request fails to be processed

    • getLicenseUser

      public LicenseUser getLicenseUser(GetLicenseUserRequest request) throws IOException, ApiException
      Get licenses for specified user.
      Parameters:
      request - The request object
      Returns:
      LicenseUser
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseUser

      public ApiResponse<LicenseUser> getLicenseUser(ApiRequest<Void> request) throws IOException
      Get licenses for specified user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLicenseUsers

      public UserLicensesEntityListing getLicenseUsers(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      UserLicensesEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseUsersWithHttpInfo

      public ApiResponse<UserLicensesEntityListing> getLicenseUsersWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      UserLicensesEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getLicenseUsers

      public UserLicensesEntityListing getLicenseUsers(GetLicenseUsersRequest request) throws IOException, ApiException
      Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
      Parameters:
      request - The request object
      Returns:
      UserLicensesEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLicenseUsers

      public ApiResponse<UserLicensesEntityListing> getLicenseUsers(ApiRequest<Void> request) throws IOException
      Get a page of users and their licenses Retrieve a page of users in an organization along with the licenses they possess.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLicenseInfer

      public List<String> postLicenseInfer(List<String> body) throws IOException, ApiException
      Get a list of licenses inferred based on a list of roleIds
      Parameters:
      body - The roleIds to use while inferring licenses (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseInferWithHttpInfo

      public ApiResponse<List<String>> postLicenseInferWithHttpInfo(List<String> body) throws IOException
      Get a list of licenses inferred based on a list of roleIds
      Parameters:
      body - The roleIds to use while inferring licenses (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • postLicenseInfer

      public List<String> postLicenseInfer(PostLicenseInferRequest request) throws IOException, ApiException
      Get a list of licenses inferred based on a list of roleIds
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseInfer

      public ApiResponse<List<String>> postLicenseInfer(ApiRequest<List<String>> request) throws IOException
      Get a list of licenses inferred based on a list of roleIds
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLicenseInferPermissions

      public List<String> postLicenseInferPermissions(List<String> body) throws IOException, ApiException
      Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - The permissions to use while inferring licenses (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseInferPermissionsWithHttpInfo

      public ApiResponse<List<String>> postLicenseInferPermissionsWithHttpInfo(List<String> body) throws IOException
      Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - The permissions to use while inferring licenses (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • postLicenseInferPermissions

      public List<String> postLicenseInferPermissions(PostLicenseInferPermissionsRequest request) throws IOException, ApiException
      Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions 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

    • postLicenseInferPermissions

      public ApiResponse<List<String>> postLicenseInferPermissions(ApiRequest<List<String>> request) throws IOException
      Get a list of licenses inferred based on a list of permissions postLicenseInferPermissions 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

    • postLicenseOrganization

      public List<LicenseUpdateStatus> postLicenseOrganization(LicenseBatchAssignmentRequest body) throws IOException, ApiException
      Update the organization's license assignments in a batch.
      Parameters:
      body - The license assignments to update. (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseOrganizationWithHttpInfo

      public ApiResponse<List<LicenseUpdateStatus>> postLicenseOrganizationWithHttpInfo(LicenseBatchAssignmentRequest body) throws IOException
      Update the organization's license assignments in a batch.
      Parameters:
      body - The license assignments to update. (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • postLicenseOrganization

      public List<LicenseUpdateStatus> postLicenseOrganization(PostLicenseOrganizationRequest request) throws IOException, ApiException
      Update the organization's license assignments in a batch.
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseOrganization

      public ApiResponse<List<LicenseUpdateStatus>> postLicenseOrganization(ApiRequest<LicenseBatchAssignmentRequest> request) throws IOException
      Update the organization's license assignments in a batch.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLicenseToggle

      public LicenseOrgToggle postLicenseToggle(String featureName) throws IOException, ApiException
      Deprecated. No alternative required - this endpoint has no effect
      Parameters:
      featureName - featureName (required)
      Returns:
      LicenseOrgToggle
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseToggleWithHttpInfo

      public ApiResponse<LicenseOrgToggle> postLicenseToggleWithHttpInfo(String featureName) throws IOException
      Deprecated. No alternative required - this endpoint has no effect
      Parameters:
      featureName - featureName (required)
      Returns:
      LicenseOrgToggle
      Throws:
      IOException - if the request fails to be processed

    • postLicenseToggle

      public LicenseOrgToggle postLicenseToggle(PostLicenseToggleRequest request) throws IOException, ApiException
      Deprecated. No alternative required - this endpoint has no effect
      Parameters:
      request - The request object
      Returns:
      LicenseOrgToggle
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseToggle

      public ApiResponse<LicenseOrgToggle> postLicenseToggle(ApiRequest<Void> request) throws IOException
      Deprecated. No alternative required - this endpoint has no effect
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLicenseUsers

      public Map<String,Object> postLicenseUsers(List<String> body) throws IOException, ApiException
      Fetch user licenses in a batch.
      Parameters:
      body - The user IDs to fetch. (optional)
      Returns:
      Map<String, Object>
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseUsersWithHttpInfo

      public ApiResponse<Map<String,Object>> postLicenseUsersWithHttpInfo(List<String> body) throws IOException
      Fetch user licenses in a batch.
      Parameters:
      body - The user IDs to fetch. (optional)
      Returns:
      Map<String, Object>
      Throws:
      IOException - if the request fails to be processed

    • postLicenseUsers

      public Map<String,Object> postLicenseUsers(PostLicenseUsersRequest request) throws IOException, ApiException
      Fetch user licenses in a batch.
      Parameters:
      request - The request object
      Returns:
      Map<String, Object>
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLicenseUsers

      public ApiResponse<Map<String,Object>> postLicenseUsers(ApiRequest<List<String>> request) throws IOException
      Fetch user licenses in a batch.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed