Class: MergeATSClient::AttachmentsApi
- Inherits:
-
Object
- Object
- MergeATSClient::AttachmentsApi
- Defined in:
- lib/merge_ats_client/api/attachments_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#attachments_create(x_account_token, attachment_endpoint_request, opts = {}) ⇒ AttachmentResponse
Creates an ‘Attachment` object with the given values.
-
#attachments_create_with_http_info(x_account_token, attachment_endpoint_request, opts = {}) ⇒ Array<(AttachmentResponse, Integer, Hash)>
Creates an `Attachment` object with the given values.
-
#attachments_list(x_account_token, opts = {}) ⇒ PaginatedAttachmentList
Returns a list of ‘Attachment` objects.
-
#attachments_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedAttachmentList, Integer, Hash)>
Returns a list of `Attachment` objects.
-
#attachments_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse
Returns metadata for ‘Attachment` POSTs.
-
#attachments_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>
Returns metadata for `Attachment` POSTs.
-
#attachments_retrieve(x_account_token, id, opts = {}) ⇒ Attachment
Returns an ‘Attachment` object with the given `id`.
-
#attachments_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>
Returns an `Attachment` object with the given `id`.
-
#initialize(api_client = ApiClient.default) ⇒ AttachmentsApi
constructor
A new instance of AttachmentsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AttachmentsApi
Returns a new instance of AttachmentsApi.
19 20 21 |
# File 'lib/merge_ats_client/api/attachments_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/attachments_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#attachments_create(x_account_token, attachment_endpoint_request, opts = {}) ⇒ AttachmentResponse
Creates an ‘Attachment` object with the given values.
29 30 31 32 |
# File 'lib/merge_ats_client/api/attachments_api.rb', line 29 def (x_account_token, , opts = {}) data, _status_code, _headers = (x_account_token, , opts) data end |
#attachments_create_with_http_info(x_account_token, attachment_endpoint_request, opts = {}) ⇒ Array<(AttachmentResponse, Integer, Hash)>
Creates an `Attachment` 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/attachments_api.rb', line 41 def (x_account_token, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AttachmentsApi.attachments_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 AttachmentsApi.attachments_create" end # verify the required parameter 'attachment_endpoint_request' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'attachment_endpoint_request' when calling AttachmentsApi.attachments_create" end # resource path local_var_path = '/attachments' # 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() # return_type return_type = opts[:debug_return_type] || 'AttachmentResponse' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"AttachmentsApi.attachments_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: AttachmentsApi#attachments_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#attachments_list(x_account_token, opts = {}) ⇒ PaginatedAttachmentList
Returns a list of ‘Attachment` objects.
114 115 116 117 |
# File 'lib/merge_ats_client/api/attachments_api.rb', line 114 def (x_account_token, opts = {}) data, _status_code, _headers = (x_account_token, opts) data end |
#attachments_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedAttachmentList, Integer, Hash)>
Returns a list of `Attachment` objects.
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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/merge_ats_client/api/attachments_api.rb', line 135 def (x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AttachmentsApi.attachments_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 AttachmentsApi.attachments_list" end allowable_values = ["candidate"] 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 allowable_values = ["attachment_type"] if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields']) fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}" end # resource path local_var_path = '/attachments' # 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[:'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[:'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_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].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] || 'PaginatedAttachmentList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"AttachmentsApi.attachments_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: AttachmentsApi#attachments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#attachments_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse
Returns metadata for ‘Attachment` POSTs.
208 209 210 211 |
# File 'lib/merge_ats_client/api/attachments_api.rb', line 208 def (x_account_token, opts = {}) data, _status_code, _headers = (x_account_token, opts) data end |
#attachments_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>
Returns metadata for `Attachment` POSTs.
217 218 219 220 221 222 223 224 225 226 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 |
# File 'lib/merge_ats_client/api/attachments_api.rb', line 217 def (x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AttachmentsApi.attachments_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 AttachmentsApi.attachments_meta_post_retrieve" end # resource path local_var_path = '/attachments/meta/post' # 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']) 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 => :"AttachmentsApi.attachments_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: AttachmentsApi#attachments_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#attachments_retrieve(x_account_token, id, opts = {}) ⇒ Attachment
Returns an ‘Attachment` object with the given `id`.
274 275 276 277 |
# File 'lib/merge_ats_client/api/attachments_api.rb', line 274 def (x_account_token, id, opts = {}) data, _status_code, _headers = (x_account_token, id, opts) data end |
#attachments_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Attachment, Integer, Hash)>
Returns an `Attachment` object with the given `id`.
287 288 289 290 291 292 293 294 295 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 |
# File 'lib/merge_ats_client/api/attachments_api.rb', line 287 def (x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AttachmentsApi.attachments_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 AttachmentsApi.attachments_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 AttachmentsApi.attachments_retrieve" end allowable_values = ["candidate"] 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 allowable_values = ["attachment_type"] if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields']) fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}" end # resource path local_var_path = '/attachments/{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? query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].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] || 'Attachment' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"AttachmentsApi.attachments_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: AttachmentsApi#attachments_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |