class YousignClient::UsersApi
Attributes
Public Class Methods
# File lib/yousign_client/api/users_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List all Users @param [Hash] opts the optional parameters @return [Array<UserOutput>]
# File lib/yousign_client/api/users_api.rb, line 25 def users_get(opts = {}) data, _status_code, _headers = users_get_with_http_info(opts) data end
List all Users @param [Hash] opts the optional parameters @return [Array<(Array<UserOutput>, Fixnum, Hash)>] Array<UserOutput> data, response status code and response headers
# File lib/yousign_client/api/users_api.rb, line 33 def users_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users_get ...' end # resource path local_var_path = '/users' # query parameters query_params = {} # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Array<UserOutput>') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a User @param id @param [Hash] opts the optional parameters @return [nil]
# File lib/yousign_client/api/users_api.rb, line 72 def users_id_delete(id, opts = {}) users_id_delete_with_http_info(id, opts) nil end
Delete a User @param id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/yousign_client/api/users_api.rb, line 81 def users_id_delete_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users_id_delete ...' 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.users_id_delete" end # resource path local_var_path = '/users/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Find a User by ID @param id @param [Hash] opts the optional parameters @return [UserOutput]
# File lib/yousign_client/api/users_api.rb, line 123 def users_id_get(id, opts = {}) data, _status_code, _headers = users_id_get_with_http_info(id, opts) data end
Find a User by ID @param id @param [Hash] opts the optional parameters @return [Array<(UserOutput
, Fixnum, Hash)>] UserOutput
data, response status code and response headers
# File lib/yousign_client/api/users_api.rb, line 132 def users_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users_id_get ...' 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.users_id_get" end # resource path local_var_path = '/users/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'UserOutput') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a User @param id @param body @param [Hash] opts the optional parameters @return [UserOutput]
# File lib/yousign_client/api/users_api.rb, line 176 def users_id_put(id, body, opts = {}) data, _status_code, _headers = users_id_put_with_http_info(id, body, opts) data end
Update a User @param id @param body @param [Hash] opts the optional parameters @return [Array<(UserOutput
, Fixnum, Hash)>] UserOutput
data, response status code and response headers
# File lib/yousign_client/api/users_api.rb, line 186 def users_id_put_with_http_info(id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users_id_put ...' 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.users_id_put" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.users_id_put" end # resource path local_var_path = '/users/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['api_key'] 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 => 'UserOutput') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a new User on Yousign application @param body @param [Hash] opts the optional parameters @return [UserOutput]
# File lib/yousign_client/api/users_api.rb, line 231 def users_post(body, opts = {}) data, _status_code, _headers = users_post_with_http_info(body, opts) data end
Create a new User on Yousign application @param body @param [Hash] opts the optional parameters @return [Array<(UserOutput
, Fixnum, Hash)>] UserOutput
data, response status code and response headers
# File lib/yousign_client/api/users_api.rb, line 240 def users_post_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users_post ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.users_post" end # resource path local_var_path = '/users' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['api_key'] 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 => 'UserOutput') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end