stations_api.rb in purecloud-0.36.1

- old
+ new

@@ -1,50 +1,59 @@
+=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 StationsApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
 
-    # Get the list of available stations.
+    # Unassigns the user assigned to this station
     # 
+    # @param id Station ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
-    # @option opts [String] :sort_by Sort by
-    # @option opts [String] :name Name
-    # @return [StationEntityListing]
-    def get_stations(opts = {})
-      data, status_code, headers = get_stations_with_http_info(opts)
+    # @return [String]
+    def delete_id_associateduser(id, opts = {})
+      data, status_code, headers = delete_id_associateduser_with_http_info(id, opts)
       return data
     end
 
-    # Get the list of available stations.
+    # Unassigns the user assigned to this station
     # 
+    # @param id Station ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
-    # @option opts [String] :sort_by Sort by
-    # @option opts [String] :name Name
-    # @return [Array<(StationEntityListing, Fixnum, Hash)>] StationEntityListing data, response status code and response headers
-    def get_stations_with_http_info(opts = {})
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def delete_id_associateduser_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: StationsApi#get_stations ..."
+        @api_client.config.logger.debug "Calling API: StationsApi#delete_id_associateduser ..."
       end
       
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling delete_id_associateduser" if id.nil?
+      
       # resource path
-      path = "/api/v2/stations".sub('{format}','json')
+      local_var_path = "/api/v2/stations/{id}/associateduser".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}
-      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
-      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
-      query_params[:'name'] = opts[:'name'] if opts[:'name']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -59,21 +68,20 @@
       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(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'StationEntityListing')
+        :return_type => 'String')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: StationsApi#get_stations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: StationsApi#delete_id_associateduser\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Get station.
@@ -98,11 +106,11 @@
       
       # verify the required parameter 'id' is set
       fail "Missing the required parameter 'id' when calling get_id" if id.nil?
       
       # resource path
-      path = "/api/v2/stations/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/api/v2/stations/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -120,13 +128,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,
@@ -135,38 +142,45 @@
         @api_client.config.logger.debug "API called: StationsApi#get_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Unassigns the user assigned to this station
+    # Get the list of available stations.
     # 
-    # @param id Station ID
     # @param [Hash] opts the optional parameters
-    # @return [String]
-    def delete_id_associateduser(id, opts = {})
-      data, status_code, headers = delete_id_associateduser_with_http_info(id, opts)
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [String] :sort_by Sort by (default to name)
+    # @option opts [String] :name Name
+    # @return [StationEntityListing]
+    def get_stations(opts = {})
+      data, status_code, headers = get_stations_with_http_info(opts)
       return data
     end
 
-    # Unassigns the user assigned to this station
+    # Get the list of available stations.
     # 
-    # @param id Station ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
-    def delete_id_associateduser_with_http_info(id, opts = {})
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :name Name
+    # @return [Array<(StationEntityListing, Fixnum, Hash)>] StationEntityListing data, response status code and response headers
+    def get_stations_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: StationsApi#delete_id_associateduser ..."
+        @api_client.config.logger.debug "Calling API: StationsApi#get_stations ..."
       end
       
-      # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling delete_id_associateduser" if id.nil?
-      
       # resource path
-      path = "/api/v2/stations/{id}/associateduser".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/api/v2/stations".sub('{format}','json')
 
       # query parameters
       query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'name'] = opts[:'name'] if opts[:'name']
 
       # header parameters
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
@@ -181,25 +195,20 @@
       form_params = {}
 
       # http body (model)
       post_body = nil
       
-
       auth_names = ['PureCloud Auth']
-      data, status_code, headers = @api_client.call_api(:DELETE, 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 => 'String')
+        :return_type => 'StationEntityListing')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: StationsApi#delete_id_associateduser\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: StationsApi#get_stations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
   end
 end
-
-
-
-