Class: MergeATSClient::UsersApi
- Inherits:
-
Object
- Object
- MergeATSClient::UsersApi
- Defined in:
- lib/merge_ats_client/api/users_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ UsersApi
constructor
A new instance of UsersApi.
-
#users_list(x_account_token, opts = {}) ⇒ PaginatedRemoteUserList
Returns a list of ‘RemoteUser` objects.
-
#users_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedRemoteUserList, Integer, Hash)>
Returns a list of `RemoteUser` objects.
-
#users_retrieve(x_account_token, id, opts = {}) ⇒ RemoteUser
Returns a ‘RemoteUser` object with the given `id`.
-
#users_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(RemoteUser, Integer, Hash)>
Returns a `RemoteUser` object with the given `id`.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/merge_ats_client/api/users_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#users_list(x_account_token, opts = {}) ⇒ PaginatedRemoteUserList
Returns a list of ‘RemoteUser` objects.
36 37 38 39 |
# File 'lib/merge_ats_client/api/users_api.rb', line 36 def users_list(x_account_token, opts = {}) data, _status_code, _headers = users_list_with_http_info(x_account_token, opts) data end |
#users_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedRemoteUserList, Integer, Hash)>
Returns a list of `RemoteUser` objects.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/merge_ats_client/api/users_api.rb', line 55 def users_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users_list ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling UsersApi.users_list" end # resource path local_var_path = '/users' # query parameters query_params = opts[:query_params] || {} query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil? query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil? query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil? query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PaginatedRemoteUserList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"UsersApi.users_list", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#users_retrieve(x_account_token, id, opts = {}) ⇒ RemoteUser
Returns a ‘RemoteUser` object with the given `id`.
120 121 122 123 |
# File 'lib/merge_ats_client/api/users_api.rb', line 120 def users_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = users_retrieve_with_http_info(x_account_token, id, opts) data end |
#users_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(RemoteUser, Integer, Hash)>
Returns a `RemoteUser` object with the given `id`.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/merge_ats_client/api/users_api.rb', line 131 def users_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersApi.users_retrieve ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling UsersApi.users_retrieve" 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_retrieve" end # resource path local_var_path = '/users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'RemoteUser' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"UsersApi.users_retrieve", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: UsersApi#users_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |