Class: MergeATSClient::ApplicationsApi
- Inherits:
-
Object
- Object
- MergeATSClient::ApplicationsApi
- Defined in:
- lib/merge_ats_client/api/applications_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#applications_create(x_account_token, application_endpoint_request, opts = {}) ⇒ ApplicationResponse
Creates an ‘Application` object with the given values.
-
#applications_create_with_http_info(x_account_token, application_endpoint_request, opts = {}) ⇒ Array<(ApplicationResponse, Integer, Hash)>
Creates an `Application` object with the given values.
-
#applications_list(x_account_token, opts = {}) ⇒ PaginatedApplicationList
Returns a list of ‘Application` objects.
-
#applications_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedApplicationList, Integer, Hash)>
Returns a list of `Application` objects.
-
#applications_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse
Returns metadata for ‘Application` POSTs.
-
#applications_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>
Returns metadata for `Application` POSTs.
-
#applications_retrieve(x_account_token, id, opts = {}) ⇒ Application
Returns an ‘Application` object with the given `id`.
-
#applications_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Application, Integer, Hash)>
Returns an `Application` object with the given `id`.
-
#initialize(api_client = ApiClient.default) ⇒ ApplicationsApi
constructor
A new instance of ApplicationsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ApplicationsApi
Returns a new instance of ApplicationsApi.
19 20 21 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#applications_create(x_account_token, application_endpoint_request, opts = {}) ⇒ ApplicationResponse
Creates an ‘Application` object with the given values.
29 30 31 32 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 29 def applications_create(x_account_token, application_endpoint_request, opts = {}) data, _status_code, _headers = applications_create_with_http_info(x_account_token, application_endpoint_request, opts) data end |
#applications_create_with_http_info(x_account_token, application_endpoint_request, opts = {}) ⇒ Array<(ApplicationResponse, Integer, Hash)>
Creates an `Application` object with the given values.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 41 def applications_create_with_http_info(x_account_token, application_endpoint_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_create ...' 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 ApplicationsApi.applications_create" end # verify the required parameter 'application_endpoint_request' is set if @api_client.config.client_side_validation && application_endpoint_request.nil? fail ArgumentError, "Missing the required parameter 'application_endpoint_request' when calling ApplicationsApi.applications_create" end # resource path local_var_path = '/applications' # query parameters query_params = opts[:query_params] || {} query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil? query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil? # 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', 'multipart/form-data']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(application_endpoint_request) # return_type return_type = opts[:debug_return_type] || 'ApplicationResponse' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"ApplicationsApi.applications_create", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ApplicationsApi#applications_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#applications_list(x_account_token, opts = {}) ⇒ PaginatedApplicationList
Returns a list of ‘Application` objects.
118 119 120 121 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 118 def applications_list(x_account_token, opts = {}) data, _status_code, _headers = applications_list_with_http_info(x_account_token, opts) data end |
#applications_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedApplicationList, Integer, Hash)>
Returns a list of `Application` objects.
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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 143 def applications_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_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 ApplicationsApi.applications_list" end allowable_values = ["candidate", "candidate,credited_to", "candidate,credited_to,current_stage", "candidate,credited_to,current_stage,reject_reason", "candidate,credited_to,reject_reason", "candidate,current_stage", "candidate,current_stage,reject_reason", "candidate,job", "candidate,job,credited_to", "candidate,job,credited_to,current_stage", "candidate,job,credited_to,current_stage,reject_reason", "candidate,job,credited_to,reject_reason", "candidate,job,current_stage", "candidate,job,current_stage,reject_reason", "candidate,job,reject_reason", "candidate,reject_reason", "credited_to", "credited_to,current_stage", "credited_to,current_stage,reject_reason", "credited_to,reject_reason", "current_stage", "current_stage,reject_reason", "job", "job,credited_to", "job,credited_to,current_stage", "job,credited_to,current_stage,reject_reason", "job,credited_to,reject_reason", "job,current_stage", "job,current_stage,reject_reason", "job,reject_reason", "reject_reason"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end # resource path local_var_path = '/applications' # query parameters query_params = opts[:query_params] || {} query_params[:'candidate_id'] = opts[:'candidate_id'] if !opts[:'candidate_id'].nil? 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[:'credited_to_id'] = opts[:'credited_to_id'] if !opts[:'credited_to_id'].nil? query_params[:'current_stage_id'] = opts[:'current_stage_id'] if !opts[:'current_stage_id'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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[:'job_id'] = opts[:'job_id'] if !opts[:'job_id'].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[:'reject_reason_id'] = opts[:'reject_reason_id'] if !opts[:'reject_reason_id'].nil? query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? query_params[:'source'] = opts[:'source'] if !opts[:'source'].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] || 'PaginatedApplicationList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"ApplicationsApi.applications_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: ApplicationsApi#applications_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#applications_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse
Returns metadata for ‘Application` POSTs.
217 218 219 220 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 217 def (x_account_token, opts = {}) data, _status_code, _headers = (x_account_token, opts) data end |
#applications_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>
Returns metadata for `Application` POSTs.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 227 def (x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_meta_post_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 ApplicationsApi.applications_meta_post_retrieve" end # resource path local_var_path = '/applications/meta/post' # query parameters query_params = opts[:query_params] || {} query_params[:'application_remote_template_id'] = opts[:'application_remote_template_id'] if !opts[:'application_remote_template_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] || 'MetaResponse' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"ApplicationsApi.applications_meta_post_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: ApplicationsApi#applications_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#applications_retrieve(x_account_token, id, opts = {}) ⇒ Application
Returns an ‘Application` object with the given `id`.
284 285 286 287 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 284 def applications_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = applications_retrieve_with_http_info(x_account_token, id, opts) data end |
#applications_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Application, Integer, Hash)>
Returns an `Application` object with the given `id`.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/merge_ats_client/api/applications_api.rb', line 296 def applications_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_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 ApplicationsApi.applications_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 ApplicationsApi.applications_retrieve" end allowable_values = ["candidate", "candidate,credited_to", "candidate,credited_to,current_stage", "candidate,credited_to,current_stage,reject_reason", "candidate,credited_to,reject_reason", "candidate,current_stage", "candidate,current_stage,reject_reason", "candidate,job", "candidate,job,credited_to", "candidate,job,credited_to,current_stage", "candidate,job,credited_to,current_stage,reject_reason", "candidate,job,credited_to,reject_reason", "candidate,job,current_stage", "candidate,job,current_stage,reject_reason", "candidate,job,reject_reason", "candidate,reject_reason", "credited_to", "credited_to,current_stage", "credited_to,current_stage,reject_reason", "credited_to,reject_reason", "current_stage", "current_stage,reject_reason", "job", "job,credited_to", "job,credited_to,current_stage", "job,credited_to,current_stage,reject_reason", "job,credited_to,reject_reason", "job,current_stage", "job,current_stage,reject_reason", "job,reject_reason", "reject_reason"] if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand']) fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}" end # resource path local_var_path = '/applications/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? 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] || 'Application' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"ApplicationsApi.applications_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: ApplicationsApi#applications_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |