Package com.mypurecloud.sdk.v2.api

Class GeolocationApi

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

  • Constructor Details

    • GeolocationApi

      public GeolocationApi()

    • GeolocationApi

      public GeolocationApi(ApiClient apiClient)

  • Method Details

    • getGeolocationsSettings

      public GeolocationSettings getGeolocationsSettings() throws IOException, ApiException
      Get a organization's GeolocationSettings
      Returns:
      GeolocationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGeolocationsSettingsWithHttpInfo

      public ApiResponse<GeolocationSettings> getGeolocationsSettingsWithHttpInfo() throws IOException
      Get a organization's GeolocationSettings
      Returns:
      GeolocationSettings
      Throws:
      IOException - if the request fails to be processed

    • getGeolocationsSettings

      public GeolocationSettings getGeolocationsSettings(GetGeolocationsSettingsRequest request) throws IOException, ApiException
      Get a organization's GeolocationSettings
      Parameters:
      request - The request object
      Returns:
      GeolocationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGeolocationsSettings

      public ApiResponse<GeolocationSettings> getGeolocationsSettings(ApiRequest<Void> request) throws IOException
      Get a organization's GeolocationSettings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUserGeolocation

      public Geolocation getUserGeolocation(String userId, String clientId) throws IOException, ApiException
      Get a user's Geolocation
      Parameters:
      userId - user Id (required)
      clientId - client Id (required)
      Returns:
      Geolocation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserGeolocationWithHttpInfo

      public ApiResponse<Geolocation> getUserGeolocationWithHttpInfo(String userId, String clientId) throws IOException
      Get a user's Geolocation
      Parameters:
      userId - user Id (required)
      clientId - client Id (required)
      Returns:
      Geolocation
      Throws:
      IOException - if the request fails to be processed

    • getUserGeolocation

      public Geolocation getUserGeolocation(GetUserGeolocationRequest request) throws IOException, ApiException
      Get a user's Geolocation
      Parameters:
      request - The request object
      Returns:
      Geolocation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserGeolocation

      public ApiResponse<Geolocation> getUserGeolocation(ApiRequest<Void> request) throws IOException
      Get a user's Geolocation
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchGeolocationsSettings

      public GeolocationSettings patchGeolocationsSettings(GeolocationSettings body) throws IOException, ApiException
      Patch a organization's GeolocationSettings
      Parameters:
      body - Geolocation settings (required)
      Returns:
      GeolocationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchGeolocationsSettingsWithHttpInfo

      public ApiResponse<GeolocationSettings> patchGeolocationsSettingsWithHttpInfo(GeolocationSettings body) throws IOException
      Patch a organization's GeolocationSettings
      Parameters:
      body - Geolocation settings (required)
      Returns:
      GeolocationSettings
      Throws:
      IOException - if the request fails to be processed

    • patchGeolocationsSettings

      public GeolocationSettings patchGeolocationsSettings(PatchGeolocationsSettingsRequest request) throws IOException, ApiException
      Patch a organization's GeolocationSettings
      Parameters:
      request - The request object
      Returns:
      GeolocationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchGeolocationsSettings

      public ApiResponse<GeolocationSettings> patchGeolocationsSettings(ApiRequest<GeolocationSettings> request) throws IOException
      Patch a organization's GeolocationSettings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchUserGeolocation

      public Geolocation patchUserGeolocation(String userId, String clientId, Geolocation body) throws IOException, ApiException
      Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
      Parameters:
      userId - user Id (required)
      clientId - client Id (required)
      body - Geolocation (required)
      Returns:
      Geolocation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUserGeolocationWithHttpInfo

      public ApiResponse<Geolocation> patchUserGeolocationWithHttpInfo(String userId, String clientId, Geolocation body) throws IOException
      Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
      Parameters:
      userId - user Id (required)
      clientId - client Id (required)
      body - Geolocation (required)
      Returns:
      Geolocation
      Throws:
      IOException - if the request fails to be processed

    • patchUserGeolocation

      public Geolocation patchUserGeolocation(PatchUserGeolocationRequest request) throws IOException, ApiException
      Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
      Parameters:
      request - The request object
      Returns:
      Geolocation
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchUserGeolocation

      public ApiResponse<Geolocation> patchUserGeolocation(ApiRequest<Geolocation> request) throws IOException
      Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed