cloudmersive-convert-api-client 1.6.8 → 1.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72bb167a10cb2907262314e5d0e061f5a401caaaacbdc589edcdc07f4124d0df
-  data.tar.gz: c8c4de7e3bb3b6629af7e907831a91fcb41807ee7ec5f25412a6d88998efcde6
+  metadata.gz: 8f6e2dcc39edb5f0e0877b63809bc3b052c8959a54161930c1e29c456d8c34cc
+  data.tar.gz: efdda5cd96ff0607b153672262bbda38223590f0e278fb5972def206a1e7d471
 SHA512:
-  metadata.gz: 6b0f914969cd652e711858344802356574e90152d7aa11abd3a239761a5faa19d45ede24b57f080a8e4f9004076a0fc4dd784d0be7d7fe41b98c15231f544bb3
-  data.tar.gz: a61907ce9a30ba856779d0b53539f9765a041b5f2fd25f21a86b02f92d7a25ec67c5f8d3955105ddd240c32b9ebde44df04bb7683bd334ae142a5e6b595fca93
+  metadata.gz: 46e2d9e7ebbff002811fe53edd9f017306a92847549cd5ef0079290d91f8e40a38e03e06b1c1285b924ff04fe91c4344c9b37591158488b088039285560fe466
+  data.tar.gz: 91141264ea4b8d7697dd7e3e4a63507e61b11d82d896c37df15c82ddafe2c864992bd5967287f7313588a3c258871f0bce8d128eedf8b2378382b6063feecd2a

data/README.md

@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.6.8
+- Package version: 1.6.9
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-convert-api-client-1.6.8.gem
+gem install ./cloudmersive-convert-api-client-1.6.9.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.8.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.9.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-convert-api-client', '~> 1.6.8'
+    gem 'cloudmersive-convert-api-client', '~> 1.6.9'
 
 ### Install from Git
 
@@ -183,7 +183,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_delete_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_delete_worksheet) | **POST** /convert/edit/xlsx/delete-worksheet | Delete, remove worksheet from an Excel XLSX spreadsheet document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_cell_by_identifier**](docs/EditDocumentApi.md#edit_document_xlsx_get_cell_by_identifier) | **POST** /convert/edit/xlsx/get-cell/by-identifier | Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
-*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_columns**](docs/EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get rows and cells from a Excel XLSX spreadsheet, worksheet
+*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_columns**](docs/EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_images**](docs/EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_rows_and_cells**](docs/EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_styles**](docs/EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
@@ -193,13 +193,13 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_set_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_set_cell_by_index) | **POST** /convert/edit/xlsx/set-cell/by-index | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_add_annotations**](docs/EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
-*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_delete_pages**](docs/EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document
+*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_delete_pages**](docs/EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove, delete pages from a PDF document
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_encrypt**](docs/EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_annotations**](docs/EditPdfApi.md#edit_pdf_get_annotations) | **POST** /convert/edit/pdf/annotations/list | Get PDF annotations, including comments in the document
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_form_fields**](docs/EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_metadata**](docs/EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_pdf_text_by_pages**](docs/EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
-*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_insert_pages**](docs/EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert / copy pages from one PDF document into another
+*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_insert_pages**](docs/EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert, copy pages from one PDF document into another
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_rasterize**](docs/EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_remove_all_annotations**](docs/EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
 *CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_remove_annotation_item**](docs/EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
@@ -424,6 +424,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveConvertApiClient::UpdateDocxTableCellResponse](docs/UpdateDocxTableCellResponse.md)
  - [CloudmersiveConvertApiClient::UpdateDocxTableRowRequest](docs/UpdateDocxTableRowRequest.md)
  - [CloudmersiveConvertApiClient::UpdateDocxTableRowResponse](docs/UpdateDocxTableRowResponse.md)
+ - [CloudmersiveConvertApiClient::UrlToPdfRequest](docs/UrlToPdfRequest.md)
  - [CloudmersiveConvertApiClient::UrlToTextRequest](docs/UrlToTextRequest.md)
  - [CloudmersiveConvertApiClient::UrlToTextResponse](docs/UrlToTextResponse.md)
  - [CloudmersiveConvertApiClient::ViewerResponse](docs/ViewerResponse.md)

data/docs/ConvertWebApi.md

@@ -305,7 +305,7 @@ end
 
 api_instance = CloudmersiveConvertApiClient::ConvertWebApi.new
 
-input = CloudmersiveConvertApiClient::ScreenshotRequest.new # ScreenshotRequest | URL to PDF request parameters
+input = CloudmersiveConvertApiClient::UrlToPdfRequest.new # UrlToPdfRequest | URL to PDF request parameters
 
 
 begin
@@ -321,7 +321,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **input** | [**ScreenshotRequest**](ScreenshotRequest.md)| URL to PDF request parameters | 
+ **input** | [**UrlToPdfRequest**](UrlToPdfRequest.md)| URL to PDF request parameters | 
 
 ### Return type
 

data/docs/EditDocumentApi.md

@@ -42,7 +42,7 @@ Method | HTTP request | Description
 [**edit_document_xlsx_delete_worksheet**](EditDocumentApi.md#edit_document_xlsx_delete_worksheet) | **POST** /convert/edit/xlsx/delete-worksheet | Delete, remove worksheet from an Excel XLSX spreadsheet document
 [**edit_document_xlsx_get_cell_by_identifier**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_identifier) | **POST** /convert/edit/xlsx/get-cell/by-identifier | Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
 [**edit_document_xlsx_get_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
-[**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get rows and cells from a Excel XLSX spreadsheet, worksheet
+[**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
 [**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
 [**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
 [**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
@@ -2107,9 +2107,9 @@ Name | Type | Description  | Notes
 # **edit_document_xlsx_get_columns**
 > GetXlsxColumnsResponse edit_document_xlsx_get_columns(input)
 
-Get rows and cells from a Excel XLSX spreadsheet, worksheet
+Get columns from a Excel XLSX spreadsheet, worksheet
 
-Returns the rows and cells defined in the Excel Spreadsheet worksheet
+Returns the columns defined in the Excel Spreadsheet worksheet
 
 ### Example
 ```ruby
@@ -2129,7 +2129,7 @@ input = CloudmersiveConvertApiClient::GetXlsxColumnsRequest.new # GetXlsxColumns
 
 
 begin
-  #Get rows and cells from a Excel XLSX spreadsheet, worksheet
+  #Get columns from a Excel XLSX spreadsheet, worksheet
   result = api_instance.edit_document_xlsx_get_columns(input)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e

data/docs/EditPdfApi.md

@@ -6,13 +6,13 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**edit_pdf_add_annotations**](EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
 [**edit_pdf_decrypt**](EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
-[**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document
+[**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove, delete pages from a PDF document
 [**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
 [**edit_pdf_get_annotations**](EditPdfApi.md#edit_pdf_get_annotations) | **POST** /convert/edit/pdf/annotations/list | Get PDF annotations, including comments in the document
 [**edit_pdf_get_form_fields**](EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
 [**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
 [**edit_pdf_get_pdf_text_by_pages**](EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
-[**edit_pdf_insert_pages**](EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert / copy pages from one PDF document into another
+[**edit_pdf_insert_pages**](EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert, copy pages from one PDF document into another
 [**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
 [**edit_pdf_remove_all_annotations**](EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
 [**edit_pdf_remove_annotation_item**](EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
@@ -138,7 +138,7 @@ Name | Type | Description  | Notes
 # **edit_pdf_delete_pages**
 > String edit_pdf_delete_pages(input_file, page_start, page_end)
 
-Remove / delete pages from a PDF document
+Remove, delete pages from a PDF document
 
 Remove one or more pages from a PDF document
 
@@ -164,7 +164,7 @@ page_end = 56 # Integer | Page number (1 based) to stop deleting pages from (inc
 
 
 begin
-  #Remove / delete pages from a PDF document
+  #Remove, delete pages from a PDF document
   result = api_instance.edit_pdf_delete_pages(input_file, page_start, page_end)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
@@ -476,7 +476,7 @@ Name | Type | Description  | Notes
 # **edit_pdf_insert_pages**
 > String edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
 
-Insert / copy pages from one PDF document into another
+Insert, copy pages from one PDF document into another
 
 Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
 
@@ -506,7 +506,7 @@ page_insert_before_desitnation = 56 # Integer | Page number (1 based) to insert
 
 
 begin
-  #Insert / copy pages from one PDF document into another
+  #Insert, copy pages from one PDF document into another
   result = api_instance.edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e

data/docs/ScreenshotRequest.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** | URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports. | [optional] 
 **extra_loading_wait** | **Integer** | Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds) | [optional] 
-**screenshot_width** | **Integer** | Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot | [optional] 
+**screenshot_width** | **Integer** | Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024 | [optional] 
 **screenshot_height** | **Integer** | Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot | [optional] 
 
 

data/docs/UrlToPdfRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::UrlToPdfRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports. | [optional] 
+**extra_loading_wait** | **Integer** | Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds) | [optional] 
+**include_background_graphics** | **BOOLEAN** | Optional: Set to true to include background graphics in the PDF, or false to not include.  Default is true. | [optional] 
+
+

data/lib/cloudmersive-convert-api-client.rb

@@ -186,6 +186,7 @@ require 'cloudmersive-convert-api-client/models/update_docx_table_cell_request'
 require 'cloudmersive-convert-api-client/models/update_docx_table_cell_response'
 require 'cloudmersive-convert-api-client/models/update_docx_table_row_request'
 require 'cloudmersive-convert-api-client/models/update_docx_table_row_response'
+require 'cloudmersive-convert-api-client/models/url_to_pdf_request'
 require 'cloudmersive-convert-api-client/models/url_to_text_request'
 require 'cloudmersive-convert-api-client/models/url_to_text_response'
 require 'cloudmersive-convert-api-client/models/viewer_response'

data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb

@@ -2111,8 +2111,8 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
-    # Get rows and cells from a Excel XLSX spreadsheet, worksheet
-    # Returns the rows and cells defined in the Excel Spreadsheet worksheet
+    # Get columns from a Excel XLSX spreadsheet, worksheet
+    # Returns the columns defined in the Excel Spreadsheet worksheet
     # @param input Document input request
     # @param [Hash] opts the optional parameters
     # @return [GetXlsxColumnsResponse]
@@ -2121,8 +2121,8 @@ module CloudmersiveConvertApiClient
       return data
     end
 
-    # Get rows and cells from a Excel XLSX spreadsheet, worksheet
-    # Returns the rows and cells defined in the Excel Spreadsheet worksheet
+    # Get columns from a Excel XLSX spreadsheet, worksheet
+    # Returns the columns defined in the Excel Spreadsheet worksheet
     # @param input Document input request
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetXlsxColumnsResponse, Fixnum, Hash)>] GetXlsxColumnsResponse data, response status code and response headers

data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb

@@ -138,7 +138,7 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
-    # Remove / delete pages from a PDF document
+    # Remove, delete pages from a PDF document
     # Remove one or more pages from a PDF document
     # @param input_file Input file to perform the operation on.
     # @param page_start Page number (1 based) to start deleting pages from (inclusive).
@@ -150,7 +150,7 @@ module CloudmersiveConvertApiClient
       return data
     end
 
-    # Remove / delete pages from a PDF document
+    # Remove, delete pages from a PDF document
     # Remove one or more pages from a PDF document
     # @param input_file Input file to perform the operation on.
     # @param page_start Page number (1 based) to start deleting pages from (inclusive).
@@ -497,7 +497,7 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
-    # Insert / copy pages from one PDF document into another
+    # Insert, copy pages from one PDF document into another
     # Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
     # @param source_file Source PDF file to copy pages from.
     # @param destination_file Destination PDF file to copy pages into.
@@ -511,7 +511,7 @@ module CloudmersiveConvertApiClient
       return data
     end
 
-    # Insert / copy pages from one PDF document into another
+    # Insert, copy pages from one PDF document into another
     # Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
     # @param source_file Source PDF file to copy pages from.
     # @param destination_file Destination PDF file to copy pages into.

data/lib/cloudmersive-convert-api-client/models/screenshot_request.rb

@@ -21,7 +21,7 @@ module CloudmersiveConvertApiClient
     # Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds)
     attr_accessor :extra_loading_wait
 
-    # Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
+    # Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024
     attr_accessor :screenshot_width
 
     # Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot

data/lib/cloudmersive-convert-api-client/models/url_to_pdf_request.rb

@@ -0,0 +1,209 @@
+=begin
+#convertapi
+
+#Convert API lets you effortlessly convert file formats and types.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'date'
+
+module CloudmersiveConvertApiClient
+  # Request to convert a URL to a PDF file
+  class UrlToPdfRequest
+    # URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports.
+    attr_accessor :url
+
+    # Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds)
+    attr_accessor :extra_loading_wait
+
+    # Optional: Set to true to include background graphics in the PDF, or false to not include.  Default is true.
+    attr_accessor :include_background_graphics
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'Url',
+        :'extra_loading_wait' => :'ExtraLoadingWait',
+        :'include_background_graphics' => :'IncludeBackgroundGraphics'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'url' => :'String',
+        :'extra_loading_wait' => :'Integer',
+        :'include_background_graphics' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'Url')
+        self.url = attributes[:'Url']
+      end
+
+      if attributes.has_key?(:'ExtraLoadingWait')
+        self.extra_loading_wait = attributes[:'ExtraLoadingWait']
+      end
+
+      if attributes.has_key?(:'IncludeBackgroundGraphics')
+        self.include_background_graphics = attributes[:'IncludeBackgroundGraphics']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          url == o.url &&
+          extra_loading_wait == o.extra_loading_wait &&
+          include_background_graphics == o.include_background_graphics
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [url, extra_loading_wait, include_background_graphics].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveConvertApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/cloudmersive-convert-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
 =end
 
 module CloudmersiveConvertApiClient
-  VERSION = "1.6.8"
+  VERSION = "1.6.9"
 end

data/spec/api/edit_document_api_spec.rb

@@ -489,8 +489,8 @@ describe 'EditDocumentApi' do
   end
 
   # unit tests for edit_document_xlsx_get_columns
-  # Get rows and cells from a Excel XLSX spreadsheet, worksheet
-  # Returns the rows and cells defined in the Excel Spreadsheet worksheet
+  # Get columns from a Excel XLSX spreadsheet, worksheet
+  # Returns the columns defined in the Excel Spreadsheet worksheet
   # @param input Document input request
   # @param [Hash] opts the optional parameters
   # @return [GetXlsxColumnsResponse]

data/spec/api/edit_pdf_api_spec.rb

@@ -58,7 +58,7 @@ describe 'EditPdfApi' do
   end
 
   # unit tests for edit_pdf_delete_pages
-  # Remove / delete pages from a PDF document
+  # Remove, delete pages from a PDF document
   # Remove one or more pages from a PDF document
   # @param input_file Input file to perform the operation on.
   # @param page_start Page number (1 based) to start deleting pages from (inclusive).
@@ -135,7 +135,7 @@ describe 'EditPdfApi' do
   end
 
   # unit tests for edit_pdf_insert_pages
-  # Insert / copy pages from one PDF document into another
+  # Insert, copy pages from one PDF document into another
   # Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
   # @param source_file Source PDF file to copy pages from.
   # @param destination_file Destination PDF file to copy pages into.

data/spec/models/url_to_pdf_request_spec.rb

@@ -0,0 +1,54 @@
+=begin
+#convertapi
+
+#Convert API lets you effortlessly convert file formats and types.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveConvertApiClient::UrlToPdfRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UrlToPdfRequest' do
+  before do
+    # run before each test
+    @instance = CloudmersiveConvertApiClient::UrlToPdfRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UrlToPdfRequest' do
+    it 'should create an instance of UrlToPdfRequest' do
+      expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::UrlToPdfRequest)
+    end
+  end
+  describe 'test attribute "url"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "extra_loading_wait"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "include_background_graphics"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-convert-api-client
 version: !ruby/object:Gem::Version
-  version: 1.6.8
+  version: 1.6.9
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -382,6 +382,7 @@ files:
 - "./docs/UpdateDocxTableCellResponse.md"
 - "./docs/UpdateDocxTableRowRequest.md"
 - "./docs/UpdateDocxTableRowResponse.md"
+- "./docs/UrlToPdfRequest.md"
 - "./docs/UrlToTextRequest.md"
 - "./docs/UrlToTextResponse.md"
 - "./docs/ValidateDocumentApi.md"
@@ -594,6 +595,7 @@ files:
 - "./lib/cloudmersive-convert-api-client/models/update_docx_table_cell_response.rb"
 - "./lib/cloudmersive-convert-api-client/models/update_docx_table_row_request.rb"
 - "./lib/cloudmersive-convert-api-client/models/update_docx_table_row_response.rb"
+- "./lib/cloudmersive-convert-api-client/models/url_to_pdf_request.rb"
 - "./lib/cloudmersive-convert-api-client/models/url_to_text_request.rb"
 - "./lib/cloudmersive-convert-api-client/models/url_to_text_response.rb"
 - "./lib/cloudmersive-convert-api-client/models/viewer_response.rb"
@@ -801,6 +803,7 @@ files:
 - "./spec/models/update_docx_table_cell_response_spec.rb"
 - "./spec/models/update_docx_table_row_request_spec.rb"
 - "./spec/models/update_docx_table_row_response_spec.rb"
+- "./spec/models/url_to_pdf_request_spec.rb"
 - "./spec/models/url_to_text_request_spec.rb"
 - "./spec/models/url_to_text_response_spec.rb"
 - "./spec/models/viewer_response_spec.rb"