cloudmersive-convert-api-client 1.3.6 → 1.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 75c5b1a36b8cc669f4821132aebb44e28736a37e9ea3d6ec5207cbd2a6735661
4
- data.tar.gz: a732298829671b9ea718ee701dc3e091e22347736d0ebfb1d10f138c64fbb63c
3
+ metadata.gz: 658bdf01cc76df80585fc703c6f5dbc96ee2eb6c44b7c51d18063ef8a5e8ed8c
4
+ data.tar.gz: 0af97b1ea920bf862fac3a32aff533cca5ab705c1d706c57da277de252271f48
5
5
  SHA512:
6
- metadata.gz: 36ce9afc46ece0a3bc459f773efc0d50eb29059be7657fd7a2cb95875b400f6c13134736db1059b5a178172812d085c0f59b8069b82e7aed4e6256e817b6451e
7
- data.tar.gz: bc5e7fcc48fbfdeedfff151349f39d2ca73c988742438da5b124d59a9e2ffd3a47fac05140c328c024a0984b7153d722f64412cfb74e26796762685568109b03
6
+ metadata.gz: e3e6e4e01bee72d12773faadecf30034da677d2d510514da3e2258dc8b55ae711131f4b7305036da9a709f22514f8c70897c965c19edaca2ec2a8f31c5a551cd
7
+ data.tar.gz: 489ad2c57f347c85cc365442179d47d757cf59159b9be72950568551e664822d3efd5f53e6002d046467d7ee352043f87ea569e10ad174603b64517387db8765
data/README.md CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 1.3.6
10
+ - Package version: 1.3.7
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-convert-api-client-1.3.6.gem
26
+ gem install ./cloudmersive-convert-api-client-1.3.7.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.3.6.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-convert-api-client-1.3.7.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-convert-api-client', '~> 1.3.6'
34
+ gem 'cloudmersive-convert-api-client', '~> 1.3.7'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -97,6 +97,8 @@ Class | Method | HTTP request | Description
97
97
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_docx**](docs/ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Word DOC (97-03) to DOCX
98
98
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_doc_to_pdf**](docs/ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Word DOC (97-03) to PDF
99
99
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_docx_to_pdf**](docs/ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Word DOCX to PDF
100
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_pdf**](docs/ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | HTML to PDF
101
+ *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_html_to_png**](docs/ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | HTML to PNG array
100
102
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_docx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | PDF to Word DOCX
101
103
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_png_array**](docs/ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | PDF to PNG Array
102
104
  *CloudmersiveConvertApiClient::ConvertDocumentApi* | [**convert_document_pdf_to_pptx**](docs/ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | PDF to PowerPoint PPTX
@@ -11,6 +11,8 @@ Method | HTTP request | Description
11
11
  [**convert_document_doc_to_docx**](ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Word DOC (97-03) to DOCX
12
12
  [**convert_document_doc_to_pdf**](ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Word DOC (97-03) to PDF
13
13
  [**convert_document_docx_to_pdf**](ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Word DOCX to PDF
14
+ [**convert_document_html_to_pdf**](ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | HTML to PDF
15
+ [**convert_document_html_to_png**](ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | HTML to PNG array
14
16
  [**convert_document_pdf_to_docx**](ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | PDF to Word DOCX
15
17
  [**convert_document_pdf_to_png_array**](ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | PDF to PNG Array
16
18
  [**convert_document_pdf_to_pptx**](ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | PDF to PowerPoint PPTX
@@ -82,7 +84,7 @@ Name | Type | Description | Notes
82
84
 
83
85
  Convert Document to PDF
84
86
 
85
- Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
87
+ Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.
86
88
 
87
89
  ### Example
88
90
  ```ruby
@@ -401,6 +403,114 @@ Name | Type | Description | Notes
401
403
 
402
404
 
403
405
 
406
+ # **convert_document_html_to_pdf**
407
+ > String convert_document_html_to_pdf(input_file)
408
+
409
+ HTML to PDF
410
+
411
+ Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
412
+
413
+ ### Example
414
+ ```ruby
415
+ # load the gem
416
+ require 'cloudmersive-convert-api-client'
417
+ # setup authorization
418
+ CloudmersiveConvertApiClient.configure do |config|
419
+ # Configure API key authorization: Apikey
420
+ config.api_key['Apikey'] = 'YOUR API KEY'
421
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
422
+ #config.api_key_prefix['Apikey'] = 'Bearer'
423
+ end
424
+
425
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
426
+
427
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
428
+
429
+
430
+ begin
431
+ #HTML to PDF
432
+ result = api_instance.convert_document_html_to_pdf(input_file)
433
+ p result
434
+ rescue CloudmersiveConvertApiClient::ApiError => e
435
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_pdf: #{e}"
436
+ end
437
+ ```
438
+
439
+ ### Parameters
440
+
441
+ Name | Type | Description | Notes
442
+ ------------- | ------------- | ------------- | -------------
443
+ **input_file** | **File**| Input file to perform the operation on. |
444
+
445
+ ### Return type
446
+
447
+ **String**
448
+
449
+ ### Authorization
450
+
451
+ [Apikey](../README.md#Apikey)
452
+
453
+ ### HTTP request headers
454
+
455
+ - **Content-Type**: multipart/form-data
456
+ - **Accept**: application/octet-stream
457
+
458
+
459
+
460
+ # **convert_document_html_to_png**
461
+ > PdfToPngResult convert_document_html_to_png(input_file)
462
+
463
+ HTML to PNG array
464
+
465
+ Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
466
+
467
+ ### Example
468
+ ```ruby
469
+ # load the gem
470
+ require 'cloudmersive-convert-api-client'
471
+ # setup authorization
472
+ CloudmersiveConvertApiClient.configure do |config|
473
+ # Configure API key authorization: Apikey
474
+ config.api_key['Apikey'] = 'YOUR API KEY'
475
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
476
+ #config.api_key_prefix['Apikey'] = 'Bearer'
477
+ end
478
+
479
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
480
+
481
+ input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
482
+
483
+
484
+ begin
485
+ #HTML to PNG array
486
+ result = api_instance.convert_document_html_to_png(input_file)
487
+ p result
488
+ rescue CloudmersiveConvertApiClient::ApiError => e
489
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_png: #{e}"
490
+ end
491
+ ```
492
+
493
+ ### Parameters
494
+
495
+ Name | Type | Description | Notes
496
+ ------------- | ------------- | ------------- | -------------
497
+ **input_file** | **File**| Input file to perform the operation on. |
498
+
499
+ ### Return type
500
+
501
+ [**PdfToPngResult**](PdfToPngResult.md)
502
+
503
+ ### Authorization
504
+
505
+ [Apikey](../README.md#Apikey)
506
+
507
+ ### HTTP request headers
508
+
509
+ - **Content-Type**: multipart/form-data
510
+ - **Accept**: application/octet-stream
511
+
512
+
513
+
404
514
  # **convert_document_pdf_to_docx**
405
515
  > String convert_document_pdf_to_docx(input_file)
406
516
 
@@ -77,7 +77,7 @@ module CloudmersiveConvertApiClient
77
77
  end
78
78
 
79
79
  # Convert Document to PDF
80
- # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
80
+ # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.
81
81
  # @param input_file Input file to perform the operation on.
82
82
  # @param [Hash] opts the optional parameters
83
83
  # @return [String]
@@ -87,7 +87,7 @@ module CloudmersiveConvertApiClient
87
87
  end
88
88
 
89
89
  # Convert Document to PDF
90
- # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
90
+ # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.
91
91
  # @param input_file Input file to perform the operation on.
92
92
  # @param [Hash] opts the optional parameters
93
93
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
@@ -412,6 +412,118 @@ module CloudmersiveConvertApiClient
412
412
  return data, status_code, headers
413
413
  end
414
414
 
415
+ # HTML to PDF
416
+ # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
417
+ # @param input_file Input file to perform the operation on.
418
+ # @param [Hash] opts the optional parameters
419
+ # @return [String]
420
+ def convert_document_html_to_pdf(input_file, opts = {})
421
+ data, _status_code, _headers = convert_document_html_to_pdf_with_http_info(input_file, opts)
422
+ return data
423
+ end
424
+
425
+ # HTML to PDF
426
+ # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
427
+ # @param input_file Input file to perform the operation on.
428
+ # @param [Hash] opts the optional parameters
429
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
430
+ def convert_document_html_to_pdf_with_http_info(input_file, opts = {})
431
+ if @api_client.config.debugging
432
+ @api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_html_to_pdf ..."
433
+ end
434
+ # verify the required parameter 'input_file' is set
435
+ if @api_client.config.client_side_validation && input_file.nil?
436
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_html_to_pdf"
437
+ end
438
+ # resource path
439
+ local_var_path = "/convert/html/to/pdf"
440
+
441
+ # query parameters
442
+ query_params = {}
443
+
444
+ # header parameters
445
+ header_params = {}
446
+ # HTTP header 'Accept' (if needed)
447
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
448
+ # HTTP header 'Content-Type'
449
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
450
+
451
+ # form parameters
452
+ form_params = {}
453
+ form_params["inputFile"] = input_file
454
+
455
+ # http body (model)
456
+ post_body = nil
457
+ auth_names = ['Apikey']
458
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
459
+ :header_params => header_params,
460
+ :query_params => query_params,
461
+ :form_params => form_params,
462
+ :body => post_body,
463
+ :auth_names => auth_names,
464
+ :return_type => 'String')
465
+ if @api_client.config.debugging
466
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_html_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
467
+ end
468
+ return data, status_code, headers
469
+ end
470
+
471
+ # HTML to PNG array
472
+ # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
473
+ # @param input_file Input file to perform the operation on.
474
+ # @param [Hash] opts the optional parameters
475
+ # @return [PdfToPngResult]
476
+ def convert_document_html_to_png(input_file, opts = {})
477
+ data, _status_code, _headers = convert_document_html_to_png_with_http_info(input_file, opts)
478
+ return data
479
+ end
480
+
481
+ # HTML to PNG array
482
+ # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
483
+ # @param input_file Input file to perform the operation on.
484
+ # @param [Hash] opts the optional parameters
485
+ # @return [Array<(PdfToPngResult, Fixnum, Hash)>] PdfToPngResult data, response status code and response headers
486
+ def convert_document_html_to_png_with_http_info(input_file, opts = {})
487
+ if @api_client.config.debugging
488
+ @api_client.config.logger.debug "Calling API: ConvertDocumentApi.convert_document_html_to_png ..."
489
+ end
490
+ # verify the required parameter 'input_file' is set
491
+ if @api_client.config.client_side_validation && input_file.nil?
492
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling ConvertDocumentApi.convert_document_html_to_png"
493
+ end
494
+ # resource path
495
+ local_var_path = "/convert/html/to/png"
496
+
497
+ # query parameters
498
+ query_params = {}
499
+
500
+ # header parameters
501
+ header_params = {}
502
+ # HTTP header 'Accept' (if needed)
503
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
504
+ # HTTP header 'Content-Type'
505
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
506
+
507
+ # form parameters
508
+ form_params = {}
509
+ form_params["inputFile"] = input_file
510
+
511
+ # http body (model)
512
+ post_body = nil
513
+ auth_names = ['Apikey']
514
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
515
+ :header_params => header_params,
516
+ :query_params => query_params,
517
+ :form_params => form_params,
518
+ :body => post_body,
519
+ :auth_names => auth_names,
520
+ :return_type => 'PdfToPngResult')
521
+ if @api_client.config.debugging
522
+ @api_client.config.logger.debug "API called: ConvertDocumentApi#convert_document_html_to_png\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
523
+ end
524
+ return data, status_code, headers
525
+ end
526
+
415
527
  # PDF to Word DOCX
416
528
  # Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
417
529
  # @param input_file Input file to perform the operation on.
@@ -11,5 +11,5 @@ Swagger Codegen version: unset
11
11
  =end
12
12
 
13
13
  module CloudmersiveConvertApiClient
14
- VERSION = "1.3.6"
14
+ VERSION = "1.3.7"
15
15
  end
@@ -46,7 +46,7 @@ describe 'ConvertDocumentApi' do
46
46
 
47
47
  # unit tests for convert_document_autodetect_to_pdf
48
48
  # Convert Document to PDF
49
- # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
49
+ # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.
50
50
  # @param input_file Input file to perform the operation on.
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [String]
@@ -116,6 +116,30 @@ describe 'ConvertDocumentApi' do
116
116
  end
117
117
  end
118
118
 
119
+ # unit tests for convert_document_html_to_pdf
120
+ # HTML to PDF
121
+ # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
122
+ # @param input_file Input file to perform the operation on.
123
+ # @param [Hash] opts the optional parameters
124
+ # @return [String]
125
+ describe 'convert_document_html_to_pdf test' do
126
+ it "should work" do
127
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
+ end
129
+ end
130
+
131
+ # unit tests for convert_document_html_to_png
132
+ # HTML to PNG array
133
+ # Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
134
+ # @param input_file Input file to perform the operation on.
135
+ # @param [Hash] opts the optional parameters
136
+ # @return [PdfToPngResult]
137
+ describe 'convert_document_html_to_png test' do
138
+ it "should work" do
139
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
140
+ end
141
+ end
142
+
119
143
  # unit tests for convert_document_pdf_to_docx
120
144
  # PDF to Word DOCX
121
145
  # Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloudmersive-convert-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.6
4
+ version: 1.3.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cloudmersive
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-08-11 00:00:00.000000000 Z
11
+ date: 2019-08-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus