geolocation_api.rb in purecloud-0.36.1

- old
+ new

@@ -1,16 +1,32 @@
+=begin
+PureCloud API
+
+PureCloud API
+
+OpenAPI spec version: v1
+Contact: chuck.pulfer@inin.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: http://www.inin.com
+
+=end
+
 require "uri"
 
 module PureCloud
   class GeolocationApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
 
-    # Get a organization&#39;s GeolocationSettings
+    # Get a organization's GeolocationSettings
     # 
     # @param [Hash] opts the optional parameters
     # @return [GeolocationSettings]
     def get_settings(opts = {})
       data, status_code, headers = get_settings_with_http_info(opts)
@@ -25,11 +41,11 @@
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: GeolocationApi#get_settings ..."
       end
       
       # resource path
-      path = "/api/v2/geolocations/settings".sub('{format}','json')
+      local_var_path = "/api/v2/geolocations/settings".sub('{format}','json')
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -47,13 +63,12 @@
       form_params = {}
 
       # http body (model)
       post_body = nil
       
-
       auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:GET, path,
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
@@ -62,32 +77,40 @@
         @api_client.config.logger.debug "API called: GeolocationApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Patch a organization&#39;s GeolocationSettings
+    # Get a user's Geolocation
     # 
+    # @param user_id user Id
+    # @param client_id client Id
     # @param [Hash] opts the optional parameters
-    # @option opts [GeolocationSettings] :body 
-    # @return [GeolocationSettings]
-    def patch_settings(opts = {})
-      data, status_code, headers = patch_settings_with_http_info(opts)
+    # @return [Geolocation]
+    def get_user_id_geolocations_client_id(user_id, client_id, opts = {})
+      data, status_code, headers = get_user_id_geolocations_client_id_with_http_info(user_id, client_id, opts)
       return data
     end
 
-    # Patch a organization&#39;s GeolocationSettings
+    # Get a user&#39;s Geolocation
     # 
+    # @param user_id user Id
+    # @param client_id client Id
     # @param [Hash] opts the optional parameters
-    # @option opts [GeolocationSettings] :body 
-    # @return [Array<(GeolocationSettings, Fixnum, Hash)>] GeolocationSettings data, response status code and response headers
-    def patch_settings_with_http_info(opts = {})
+    # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
+    def get_user_id_geolocations_client_id_with_http_info(user_id, client_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: GeolocationApi#patch_settings ..."
+        @api_client.config.logger.debug "Calling API: GeolocationApi#get_user_id_geolocations_client_id ..."
       end
       
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_id_geolocations_client_id" if user_id.nil?
+      
+      # verify the required parameter 'client_id' is set
+      fail "Missing the required parameter 'client_id' when calling get_user_id_geolocations_client_id" if client_id.nil?
+      
       # resource path
-      path = "/api/v2/geolocations/settings".sub('{format}','json')
+      local_var_path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -103,57 +126,48 @@
 
       # form parameters
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'body'])
+      post_body = nil
       
-
       auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:PATCH, path,
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'GeolocationSettings')
+        :return_type => 'Geolocation')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: GeolocationApi#patch_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: GeolocationApi#get_user_id_geolocations_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a user&#39;s Geolocation
+    # Patch a organization's GeolocationSettings
     # 
-    # @param user_id user Id
-    # @param client_id client Id
     # @param [Hash] opts the optional parameters
-    # @return [Geolocation]
-    def get_user_id_geolocations_client_id(user_id, client_id, opts = {})
-      data, status_code, headers = get_user_id_geolocations_client_id_with_http_info(user_id, client_id, opts)
+    # @option opts [GeolocationSettings] :body 
+    # @return [GeolocationSettings]
+    def patch_settings(opts = {})
+      data, status_code, headers = patch_settings_with_http_info(opts)
       return data
     end
 
-    # Get a user&#39;s Geolocation
+    # Patch a organization&#39;s GeolocationSettings
     # 
-    # @param user_id user Id
-    # @param client_id client Id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
-    def get_user_id_geolocations_client_id_with_http_info(user_id, client_id, opts = {})
+    # @option opts [GeolocationSettings] :body 
+    # @return [Array<(GeolocationSettings, Fixnum, Hash)>] GeolocationSettings data, response status code and response headers
+    def patch_settings_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: GeolocationApi#get_user_id_geolocations_client_id ..."
+        @api_client.config.logger.debug "Calling API: GeolocationApi#patch_settings ..."
       end
       
-      # verify the required parameter 'user_id' is set
-      fail "Missing the required parameter 'user_id' when calling get_user_id_geolocations_client_id" if user_id.nil?
-      
-      # verify the required parameter 'client_id' is set
-      fail "Missing the required parameter 'client_id' when calling get_user_id_geolocations_client_id" if client_id.nil?
-      
       # resource path
-      path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
+      local_var_path = "/api/v2/geolocations/settings".sub('{format}','json')
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -169,29 +183,28 @@
 
       # form parameters
       form_params = {}
 
       # http body (model)
-      post_body = nil
+      post_body = @api_client.object_to_http_body(opts[:'body'])
       
-
       auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:GET, path,
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Geolocation')
+        :return_type => 'GeolocationSettings')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: GeolocationApi#get_user_id_geolocations_client_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: GeolocationApi#patch_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Patch a user&#39;s Geolocation
-    # The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source.  Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values.  This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;.  Option 3:  Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; 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.
+    # 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.
     # @param user_id user Id
     # @param client_id client Id
     # @param [Hash] opts the optional parameters
     # @option opts [Geolocation] :body 
     # @return [Geolocation]
@@ -217,11 +230,11 @@
       
       # verify the required parameter 'client_id' is set
       fail "Missing the required parameter 'client_id' when calling patch_user_id_geolocations_client_id" if client_id.nil?
       
       # resource path
-      path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
+      local_var_path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -239,13 +252,12 @@
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(opts[:'body'])
       
-
       auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:PATCH, path,
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
@@ -255,9 +267,5 @@
       end
       return data, status_code, headers
     end
   end
 end
-
-
-
-