class FireflyIIIClient::UsersApi
Attributes
Public Class Methods
# File lib/firefly_iii_client/api/users_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete a user. Delete a user. You cannot delete the current user. @param id [Integer] The user ID. @param [Hash] opts the optional parameters @return [nil]
# File lib/firefly_iii_client/api/users_api.rb, line 27 def delete_user(id, opts = {}) delete_user_with_http_info(id, opts) nil end
Delete a user. Delete a user. You cannot delete the current user. @param id [Integer] The user ID. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/firefly_iii_client/api/users_api.rb, line 37 def delete_user_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.delete_user ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.delete_user" end # resource path local_var_path = '/api/v1/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] new_options = opts.merge( :operation => :"UsersApi.delete_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a single user. Gets all info of a single user. @param id [Integer] The user ID. @param [Hash] opts the optional parameters @return [UserSingle]
# File lib/firefly_iii_client/api/users_api.rb, line 88 def get_user(id, opts = {}) data, _status_code, _headers = get_user_with_http_info(id, opts) data end
Get a single user. Gets all info of a single user. @param id [Integer] The user ID. @param [Hash] opts the optional parameters @return [Array<(UserSingle
, Integer, Hash)>] UserSingle
data, response status code and response headers
# File lib/firefly_iii_client/api/users_api.rb, line 98 def get_user_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.get_user ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.get_user" end # resource path local_var_path = '/api/v1/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'UserSingle' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] new_options = opts.merge( :operation => :"UsersApi.get_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List all users. List all the users in this instance of Firefly III. @param [Hash] opts the optional parameters @option opts [Integer] :page The page number, if necessary. The default pagination is 50, so 50 users per page. @return [UserArray]
# File lib/firefly_iii_client/api/users_api.rb, line 151 def list_user(opts = {}) data, _status_code, _headers = list_user_with_http_info(opts) data end
List all users. List all the users in this instance of Firefly III. @param [Hash] opts the optional parameters @option opts [Integer] :page The page number, if necessary. The default pagination is 50, so 50 users per page. @return [Array<(UserArray
, Integer, Hash)>] UserArray
data, response status code and response headers
# File lib/firefly_iii_client/api/users_api.rb, line 161 def list_user_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.list_user ...' end # resource path local_var_path = '/api/v1/users' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'UserArray' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] new_options = opts.merge( :operation => :"UsersApi.list_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#list_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Store a new user Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the "forgot password" function. @param user [User] JSON array or key=value pairs with the necessary user information. See the model for the exact specifications. @param [Hash] opts the optional parameters @return [UserSingle]
# File lib/firefly_iii_client/api/users_api.rb, line 211 def store_user(user, opts = {}) data, _status_code, _headers = store_user_with_http_info(user, opts) data end
Store a new user Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the "forgot password" function. @param user [User] JSON array or key=value pairs with the necessary user information. See the model for the exact specifications. @param [Hash] opts the optional parameters @return [Array<(UserSingle
, Integer, Hash)>] UserSingle
data, response status code and response headers
# File lib/firefly_iii_client/api/users_api.rb, line 221 def store_user_with_http_info(user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.store_user ...' end # verify the required parameter 'user' is set if @api_client.config.client_side_validation && user.nil? fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.store_user" end # resource path local_var_path = '/api/v1/users' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(user) # return_type return_type = opts[:debug_return_type] || 'UserSingle' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] new_options = opts.merge( :operation => :"UsersApi.store_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#store_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update an existing user's information. Update existing user. @param id [Integer] The user ID. @param user [User] JSON array with updated user information. See the model for the exact specifications. @param [Hash] opts the optional parameters @return [UserSingle]
# File lib/firefly_iii_client/api/users_api.rb, line 277 def update_user(id, user, opts = {}) data, _status_code, _headers = update_user_with_http_info(id, user, opts) data end
Update an existing user's information. Update existing user. @param id [Integer] The user ID. @param user [User] JSON array with updated user information. See the model for the exact specifications. @param [Hash] opts the optional parameters @return [Array<(UserSingle
, Integer, Hash)>] UserSingle
data, response status code and response headers
# File lib/firefly_iii_client/api/users_api.rb, line 288 def update_user_with_http_info(id, user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.update_user ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.update_user" end # verify the required parameter 'user' is set if @api_client.config.client_side_validation && user.nil? fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.update_user" end # resource path local_var_path = '/api/v1/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(user) # return_type return_type = opts[:debug_return_type] || 'UserSingle' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] new_options = opts.merge( :operation => :"UsersApi.update_user", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end