Class: Hubspot::Files::Files::FilesApi
- Inherits:
-
Object
- Object
- Hubspot::Files::Files::FilesApi
- Defined in:
- lib/hubspot/codegen/files/files/api/files_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(file_id, opts = {}) ⇒ nil
Delete file Delete file by ID.
-
#archive_gdpr(file_id, opts = {}) ⇒ nil
GDPR delete GDRP delete file.
-
#archive_gdpr_with_http_info(file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
GDPR delete GDRP delete file.
-
#archive_with_http_info(file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete file Delete file by ID.
-
#check_import(task_id, opts = {}) ⇒ FileActionResponse
Check import status.
-
#check_import_with_http_info(task_id, opts = {}) ⇒ Array<(FileActionResponse, Integer, Hash)>
Check import status.
-
#do_search(opts = {}) ⇒ CollectionResponseFile
Search files Search through files in the file manager.
-
#do_search_with_http_info(opts = {}) ⇒ Array<(CollectionResponseFile, Integer, Hash)>
Search files Search through files in the file manager.
-
#get_by_id(file_id, opts = {}) ⇒ File
Get file.
-
#get_by_id_with_http_info(file_id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Get file.
-
#get_signed_url(file_id, opts = {}) ⇒ SignedUrl
Get signed URL to access private file.
-
#get_signed_url_with_http_info(file_id, opts = {}) ⇒ Array<(SignedUrl, Integer, Hash)>
Get signed URL to access private file.
-
#import_from_url(import_from_url_input, opts = {}) ⇒ ImportFromUrlTaskLocator
Import a file from a URL into the file manager.
-
#import_from_url_with_http_info(import_from_url_input, opts = {}) ⇒ Array<(ImportFromUrlTaskLocator, Integer, Hash)>
Import a file from a URL into the file manager.
-
#initialize(api_client = ApiClient.default) ⇒ FilesApi
constructor
A new instance of FilesApi.
-
#replace(file_id, opts = {}) ⇒ File
Replace file.
-
#replace_with_http_info(file_id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Replace file.
-
#update_properties(file_id, file_update_input, opts = {}) ⇒ File
update file properties Update properties of file by ID.
-
#update_properties_with_http_info(file_id, file_update_input, opts = {}) ⇒ Array<(File, Integer, Hash)>
update file properties Update properties of file by ID.
-
#upload(opts = {}) ⇒ File
Upload file Upload a single file with content specified in request body.
-
#upload_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>
Upload file Upload a single file with content specified in request body.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
19 20 21 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#archive(file_id, opts = {}) ⇒ nil
Delete file Delete file by ID
29 30 31 32 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 29 def archive(file_id, opts = {}) archive_with_http_info(file_id, opts) nil end |
#archive_gdpr(file_id, opts = {}) ⇒ nil
GDPR delete GDRP delete file
97 98 99 100 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 97 def archive_gdpr(file_id, opts = {}) archive_gdpr_with_http_info(file_id, opts) nil end |
#archive_gdpr_with_http_info(file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
GDPR delete GDRP delete file
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 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 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 107 def archive_gdpr_with_http_info(file_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.archive_gdpr ...' end # verify the required parameter 'file_id' is set if @api_client.config.client_side_validation && file_id.nil? fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.archive_gdpr" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && file_id !~ pattern fail ArgumentError, "invalid value for 'file_id' when calling FilesApi.archive_gdpr, must conform to the pattern #{pattern}." end # resource path local_var_path = '/files/v3/files/{fileId}/gdpr-delete'.sub('{' + 'fileId' + '}', CGI.escape(file_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(['*/*']) # 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] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.archive_gdpr", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FilesApi#archive_gdpr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#archive_with_http_info(file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete file Delete file by ID
39 40 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 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 39 def archive_with_http_info(file_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.archive ...' end # verify the required parameter 'file_id' is set if @api_client.config.client_side_validation && file_id.nil? fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.archive" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && file_id !~ pattern fail ArgumentError, "invalid value for 'file_id' when calling FilesApi.archive, must conform to the pattern #{pattern}." end # resource path local_var_path = '/files/v3/files/{fileId}'.sub('{' + 'fileId' + '}', CGI.escape(file_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(['*/*']) # 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] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.archive", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FilesApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#check_import(task_id, opts = {}) ⇒ FileActionResponse
Check import status. Check the status of requested import.
165 166 167 168 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 165 def check_import(task_id, opts = {}) data, _status_code, _headers = check_import_with_http_info(task_id, opts) data end |
#check_import_with_http_info(task_id, opts = {}) ⇒ Array<(FileActionResponse, Integer, Hash)>
Check import status. Check the status of requested import.
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 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 175 def check_import_with_http_info(task_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.check_import ...' end # verify the required parameter 'task_id' is set if @api_client.config.client_side_validation && task_id.nil? fail ArgumentError, "Missing the required parameter 'task_id' when calling FilesApi.check_import" end # resource path local_var_path = '/files/v3/files/import-from-url/async/tasks/{taskId}/status'.sub('{' + 'taskId' + '}', CGI.escape(task_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] || 'FileActionResponse' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.check_import", :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: FilesApi#check_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#do_search(opts = {}) ⇒ CollectionResponseFile
Search files Search through files in the file manager. Does not display hidden or archived files.
251 252 253 254 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 251 def do_search(opts = {}) data, _status_code, _headers = do_search_with_http_info(opts) data end |
#do_search_with_http_info(opts = {}) ⇒ Array<(CollectionResponseFile, Integer, Hash)>
Search files Search through files in the file manager. Does not display hidden or archived files.
284 285 286 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 350 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 284 def do_search_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.do_search ...' end # resource path local_var_path = '/files/v3/files/search' # query parameters query_params = opts[:query_params] || {} query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :csv) if !opts[:'properties'].nil? query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil? query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil? query_params[:'createdAt'] = opts[:'created_at'] if !opts[:'created_at'].nil? query_params[:'createdAtLte'] = opts[:'created_at_lte'] if !opts[:'created_at_lte'].nil? query_params[:'createdAtGte'] = opts[:'created_at_gte'] if !opts[:'created_at_gte'].nil? query_params[:'updatedAt'] = opts[:'updated_at'] if !opts[:'updated_at'].nil? query_params[:'updatedAtLte'] = opts[:'updated_at_lte'] if !opts[:'updated_at_lte'].nil? query_params[:'updatedAtGte'] = opts[:'updated_at_gte'] if !opts[:'updated_at_gte'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil? query_params[:'parentFolderId'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil? query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil? query_params[:'encoding'] = opts[:'encoding'] if !opts[:'encoding'].nil? query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil? query_params[:'extension'] = opts[:'extension'] if !opts[:'extension'].nil? query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil? query_params[:'isUsableInContent'] = opts[:'is_usable_in_content'] if !opts[:'is_usable_in_content'].nil? query_params[:'allowsAnonymousAccess'] = opts[:'allows_anonymous_access'] if !opts[:'allows_anonymous_access'].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] || 'CollectionResponseFile' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.do_search", :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: FilesApi#do_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_by_id(file_id, opts = {}) ⇒ File
Get file. Get file by ID.
358 359 360 361 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 358 def get_by_id(file_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(file_id, opts) data end |
#get_by_id_with_http_info(file_id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Get file. Get file by ID.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 369 def get_by_id_with_http_info(file_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.get_by_id ...' end # verify the required parameter 'file_id' is set if @api_client.config.client_side_validation && file_id.nil? fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.get_by_id" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && file_id !~ pattern fail ArgumentError, "invalid value for 'file_id' when calling FilesApi.get_by_id, must conform to the pattern #{pattern}." end # resource path local_var_path = '/files/v3/files/{fileId}'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :csv) if !opts[:'properties'].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] || 'HubspotFile' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.get_by_id", :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: FilesApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_signed_url(file_id, opts = {}) ⇒ SignedUrl
Get signed URL to access private file. Generates signed URL that allows temporary access to a private file.
431 432 433 434 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 431 def get_signed_url(file_id, opts = {}) data, _status_code, _headers = get_signed_url_with_http_info(file_id, opts) data end |
#get_signed_url_with_http_info(file_id, opts = {}) ⇒ Array<(SignedUrl, Integer, Hash)>
Get signed URL to access private file. Generates signed URL that allows temporary access to a private file.
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 444 def get_signed_url_with_http_info(file_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.get_signed_url ...' end # verify the required parameter 'file_id' is set if @api_client.config.client_side_validation && file_id.nil? fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.get_signed_url" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && file_id !~ pattern fail ArgumentError, "invalid value for 'file_id' when calling FilesApi.get_signed_url, must conform to the pattern #{pattern}." end allowable_values = ["thumb", "icon", "medium", "preview"] if @api_client.config.client_side_validation && opts[:'size'] && !allowable_values.include?(opts[:'size']) fail ArgumentError, "invalid value for \"size\", must be one of #{allowable_values}" end # resource path local_var_path = '/files/v3/files/{fileId}/signed-url'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'expirationSeconds'] = opts[:'expiration_seconds'] if !opts[:'expiration_seconds'].nil? query_params[:'upscale'] = opts[:'upscale'] if !opts[:'upscale'].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] || 'SignedUrl' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.get_signed_url", :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: FilesApi#get_signed_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#import_from_url(import_from_url_input, opts = {}) ⇒ ImportFromUrlTaskLocator
Import a file from a URL into the file manager. Asynchronously imports the file at the given URL into the file manager.
509 510 511 512 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 509 def import_from_url(import_from_url_input, opts = {}) data, _status_code, _headers = import_from_url_with_http_info(import_from_url_input, opts) data end |
#import_from_url_with_http_info(import_from_url_input, opts = {}) ⇒ Array<(ImportFromUrlTaskLocator, Integer, Hash)>
Import a file from a URL into the file manager. Asynchronously imports the file at the given URL into the file manager.
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 519 def import_from_url_with_http_info(import_from_url_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.import_from_url ...' end # verify the required parameter 'import_from_url_input' is set if @api_client.config.client_side_validation && import_from_url_input.nil? fail ArgumentError, "Missing the required parameter 'import_from_url_input' when calling FilesApi.import_from_url" end # resource path local_var_path = '/files/v3/files/import-from-url/async' # 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' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(import_from_url_input) # return_type return_type = opts[:debug_return_type] || 'ImportFromUrlTaskLocator' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.import_from_url", :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: FilesApi#import_from_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#replace(file_id, opts = {}) ⇒ File
Replace file. Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references.
580 581 582 583 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 580 def replace(file_id, opts = {}) data, _status_code, _headers = replace_with_http_info(file_id, opts) data end |
#replace_with_http_info(file_id, opts = {}) ⇒ Array<(File, Integer, Hash)>
Replace file. Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 593 def replace_with_http_info(file_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.replace ...' end # verify the required parameter 'file_id' is set if @api_client.config.client_side_validation && file_id.nil? fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.replace" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && file_id !~ pattern fail ArgumentError, "invalid value for 'file_id' when calling FilesApi.replace, must conform to the pattern #{pattern}." end # resource path local_var_path = '/files/v3/files/{fileId}'.sub('{' + 'fileId' + '}', CGI.escape(file_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' content_type = @api_client.select_header_content_type(['multipart/form-data']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['charsetHunch'] = opts[:'charset_hunch'] if !opts[:'charset_hunch'].nil? form_params['options'] = opts[:'options'] if !opts[:'options'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HubspotFile' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.replace", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FilesApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_properties(file_id, file_update_input, opts = {}) ⇒ File
update file properties Update properties of file by ID.
660 661 662 663 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 660 def update_properties(file_id, file_update_input, opts = {}) data, _status_code, _headers = update_properties_with_http_info(file_id, file_update_input, opts) data end |
#update_properties_with_http_info(file_id, file_update_input, opts = {}) ⇒ Array<(File, Integer, Hash)>
update file properties Update properties of file by ID.
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 671 def update_properties_with_http_info(file_id, file_update_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.update_properties ...' end # verify the required parameter 'file_id' is set if @api_client.config.client_side_validation && file_id.nil? fail ArgumentError, "Missing the required parameter 'file_id' when calling FilesApi.update_properties" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && file_id !~ pattern fail ArgumentError, "invalid value for 'file_id' when calling FilesApi.update_properties, must conform to the pattern #{pattern}." end # verify the required parameter 'file_update_input' is set if @api_client.config.client_side_validation && file_update_input.nil? fail ArgumentError, "Missing the required parameter 'file_update_input' when calling FilesApi.update_properties" end # resource path local_var_path = '/files/v3/files/{fileId}'.sub('{' + 'fileId' + '}', CGI.escape(file_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' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(file_update_input) # return_type return_type = opts[:debug_return_type] || 'HubspotFile' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.update_properties", :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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FilesApi#update_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#upload(opts = {}) ⇒ File
Upload file Upload a single file with content specified in request body.
743 744 745 746 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 743 def upload(opts = {}) data, _status_code, _headers = upload_with_http_info(opts) data end |
#upload_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>
Upload file Upload a single file with content specified in request body.
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 |
# File 'lib/hubspot/codegen/files/files/api/files_api.rb', line 758 def upload_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FilesApi.upload ...' end # resource path local_var_path = '/files/v3/files' # 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' content_type = @api_client.select_header_content_type(['multipart/form-data']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['folderId'] = opts[:'folder_id'] if !opts[:'folder_id'].nil? form_params['folderPath'] = opts[:'folder_path'] if !opts[:'folder_path'].nil? form_params['fileName'] = opts[:'file_name'] if !opts[:'file_name'].nil? form_params['charsetHunch'] = opts[:'charset_hunch'] if !opts[:'charset_hunch'].nil? form_params['options'] = opts[:'options'] if !opts[:'options'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'HubspotFile' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"FilesApi.upload", :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: FilesApi#upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |