artikcloud 2.0.0

data/lib/artikcloud/api/users_api.rb

@@ -0,0 +1,552 @@
+=begin
+ARTIK Cloud API
+
+OpenAPI spec version: 2.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: MIT
+http://en.wikipedia.org/wiki/MIT_License
+
+Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
+
+=end
+
+require "uri"
+
+module ArtikCloud
+  class UsersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Create User Application Properties
+    # Create application properties for a user
+    # @param user_id User Id
+    # @param properties Properties to be updated
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [PropertiesEnvelope]
+    def create_user_properties(user_id, properties, opts = {})
+      data, status_code, headers = create_user_properties_with_http_info(user_id, properties, opts)
+      return data
+    end
+
+    # Create User Application Properties
+    # Create application properties for a user
+    # @param user_id User Id
+    # @param properties Properties to be updated
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [Array<(PropertiesEnvelope, Fixnum, Hash)>] PropertiesEnvelope data, response status code and response headers
+    def create_user_properties_with_http_info(user_id, properties, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#create_user_properties ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling create_user_properties" if user_id.nil?
+      
+      # verify the required parameter 'properties' is set
+      fail "Missing the required parameter 'properties' when calling create_user_properties" if properties.nil?
+      
+      # resource path
+      local_var_path = "/users/{userId}/properties".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'aid'] = opts[:'aid'] if opts[:'aid']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(properties)
+      
+      auth_names = ['artikcloud_oauth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PropertiesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#create_user_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete User Application Properties
+    # Deletes a user's application properties
+    # @param user_id User Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [PropertiesEnvelope]
+    def delete_user_properties(user_id, opts = {})
+      data, status_code, headers = delete_user_properties_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Delete User Application Properties
+    # Deletes a user&#39;s application properties
+    # @param user_id User Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [Array<(PropertiesEnvelope, Fixnum, Hash)>] PropertiesEnvelope data, response status code and response headers
+    def delete_user_properties_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#delete_user_properties ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling delete_user_properties" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/users/{userId}/properties".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'aid'] = opts[:'aid'] if opts[:'aid']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['artikcloud_oauth']
+      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 => 'PropertiesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#delete_user_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Current User Profile
+    # Get's the current user's profile
+    # @param [Hash] opts the optional parameters
+    # @return [UserEnvelope]
+    def get_self(opts = {})
+      data, status_code, headers = get_self_with_http_info(opts)
+      return data
+    end
+
+    # Get Current User Profile
+    # Get&#39;s the current user&#39;s profile
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserEnvelope, Fixnum, Hash)>] UserEnvelope data, response status code and response headers
+    def get_self_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_self ..."
+      end
+      
+      # resource path
+      local_var_path = "/users/self".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['artikcloud_oauth']
+      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 => 'UserEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get User Device Types
+    # Retrieve User's Device Types
+    # @param user_id User ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Offset for pagination.
+    # @option opts [Integer] :count Desired count of items in the result set
+    # @option opts [BOOLEAN] :include_shared Optional. Boolean (true/false) - If false, only return the user&#39;s device types. If true, also return device types shared by other users.
+    # @return [DeviceTypesEnvelope]
+    def get_user_device_types(user_id, opts = {})
+      data, status_code, headers = get_user_device_types_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Get User Device Types
+    # Retrieve User&#39;s Device Types
+    # @param user_id User ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Offset for pagination.
+    # @option opts [Integer] :count Desired count of items in the result set
+    # @option opts [BOOLEAN] :include_shared Optional. Boolean (true/false) - If false, only return the user&#39;s device types. If true, also return device types shared by other users.
+    # @return [Array<(DeviceTypesEnvelope, Fixnum, Hash)>] DeviceTypesEnvelope data, response status code and response headers
+    def get_user_device_types_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_device_types ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_device_types" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/users/{userId}/devicetypes".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'count'] = opts[:'count'] if opts[:'count']
+      query_params[:'includeShared'] = opts[:'include_shared'] if opts[:'include_shared']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['artikcloud_oauth']
+      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 => 'DeviceTypesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_device_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get User Devices
+    # Retrieve User's Devices
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Offset for pagination.
+    # @option opts [Integer] :count Desired count of items in the result set
+    # @option opts [BOOLEAN] :include_properties Optional. Boolean (true/false) - If false, only return the user&#39;s device types. If true, also return device types shared by other users.
+    # @return [DevicesEnvelope]
+    def get_user_devices(user_id, opts = {})
+      data, status_code, headers = get_user_devices_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Get User Devices
+    # Retrieve User&#39;s Devices
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :offset Offset for pagination.
+    # @option opts [Integer] :count Desired count of items in the result set
+    # @option opts [BOOLEAN] :include_properties Optional. Boolean (true/false) - If false, only return the user&#39;s device types. If true, also return device types shared by other users.
+    # @return [Array<(DevicesEnvelope, Fixnum, Hash)>] DevicesEnvelope data, response status code and response headers
+    def get_user_devices_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_devices ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_devices" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/users/{userId}/devices".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'count'] = opts[:'count'] if opts[:'count']
+      query_params[:'includeProperties'] = opts[:'include_properties'] if opts[:'include_properties']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['artikcloud_oauth']
+      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 => 'DevicesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_devices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get User application properties
+    # Get application properties of a user
+    # @param user_id User Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [PropertiesEnvelope]
+    def get_user_properties(user_id, opts = {})
+      data, status_code, headers = get_user_properties_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Get User application properties
+    # Get application properties of a user
+    # @param user_id User Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [Array<(PropertiesEnvelope, Fixnum, Hash)>] PropertiesEnvelope data, response status code and response headers
+    def get_user_properties_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_properties ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_properties" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/users/{userId}/properties".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'aid'] = opts[:'aid'] if opts[:'aid']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['artikcloud_oauth']
+      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 => 'PropertiesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get User Rules
+    # Retrieve User's Rules
+    # @param user_id User ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :exclude_disabled Exclude disabled rules in the result.
+    # @option opts [BOOLEAN] :other_applications List rules of other applications if current application id has full read access
+    # @option opts [Integer] :count Desired count of items in the result set.
+    # @option opts [Integer] :offset Offset for pagination.
+    # @return [RulesEnvelope]
+    def get_user_rules(user_id, opts = {})
+      data, status_code, headers = get_user_rules_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Get User Rules
+    # Retrieve User&#39;s Rules
+    # @param user_id User ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :exclude_disabled Exclude disabled rules in the result.
+    # @option opts [BOOLEAN] :other_applications List rules of other applications if current application id has full read access
+    # @option opts [Integer] :count Desired count of items in the result set.
+    # @option opts [Integer] :offset Offset for pagination.
+    # @return [Array<(RulesEnvelope, Fixnum, Hash)>] RulesEnvelope data, response status code and response headers
+    def get_user_rules_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#get_user_rules ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling get_user_rules" if user_id.nil?
+      
+      # resource path
+      local_var_path = "/users/{userId}/rules".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'excludeDisabled'] = opts[:'exclude_disabled'] if opts[:'exclude_disabled']
+      query_params[:'otherApplications'] = opts[:'other_applications'] if opts[:'other_applications']
+      query_params[:'count'] = opts[:'count'] if opts[:'count']
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['artikcloud_oauth']
+      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 => 'RulesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update User Application Properties
+    # Updates application properties of a user
+    # @param user_id User Id
+    # @param properties Properties to be updated
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [PropertiesEnvelope]
+    def update_user_properties(user_id, properties, opts = {})
+      data, status_code, headers = update_user_properties_with_http_info(user_id, properties, opts)
+      return data
+    end
+
+    # Update User Application Properties
+    # Updates application properties of a user
+    # @param user_id User Id
+    # @param properties Properties to be updated
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :aid Application ID
+    # @return [Array<(PropertiesEnvelope, Fixnum, Hash)>] PropertiesEnvelope data, response status code and response headers
+    def update_user_properties_with_http_info(user_id, properties, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi#update_user_properties ..."
+      end
+      
+      # verify the required parameter 'user_id' is set
+      fail "Missing the required parameter 'user_id' when calling update_user_properties" if user_id.nil?
+      
+      # verify the required parameter 'properties' is set
+      fail "Missing the required parameter 'properties' when calling update_user_properties" if properties.nil?
+      
+      # resource path
+      local_var_path = "/users/{userId}/properties".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'aid'] = opts[:'aid'] if opts[:'aid']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(properties)
+      
+      auth_names = ['artikcloud_oauth']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PropertiesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#update_user_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end