pdfcrowd 5.6.1 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b696ba0a509cbffc0339d32959c96451b72b9d46bb86d25a51a4a460c67007f5
-  data.tar.gz: 9bf05c8b6d24a00691f0dbdeba3dcbbb1e808ce7c7b9fca291cbe87406d3a082
+  metadata.gz: '029e466dda9be9175a1854d7326c527367bc675373f33516835ae607f327d31b'
+  data.tar.gz: 2bc1dcb8dd2bd9a19938008d265be5991fcaac87825d5eaadb39d29bd8c8990d
 SHA512:
-  metadata.gz: 06e73ac3188ef5872cc338988b5fd1e1f20272713dd91a2cbea02c1ecaee328727bffebca505589ebc00c9813b9b01f467997689aa6b8faebc57a099cec50601
-  data.tar.gz: 06bb9f3f2b43b342a5f3e7d9fdc7011923e37408be20ba299bd47f91c8c65bf5f597339153014e381ffd69ff8660e301409408748435c09c8d90abfd0688649a
+  metadata.gz: 4478b95d606c97b4ac5023b1f780f1d648cdac6a9b958c8aff1372d687ea3426a879a7de11536f1ecf2b56fc9f00631d9c1b48838a5772daf44e674b63822400
+  data.tar.gz: baa4d81f298f629a6d5323c5d332a4920da36db054fe1c0ac52951cd21703cd39c17b406ae356e99fa6985514cf2fb73cd74ad585ff13db1728b27b402f2d0da

data/lib/pdfcrowd.rb

@@ -530,7 +530,7 @@ end
 module Pdfcrowd
     HOST = ENV["PDFCROWD_HOST"] || 'api.pdfcrowd.com'
     MULTIPART_BOUNDARY = '----------ThIs_Is_tHe_bOUnDary_$'
-    CLIENT_VERSION = '5.6.1'
+    CLIENT_VERSION = '5.8.0'
 
     class ConnectionHelper
         def initialize(user_name, api_key)
@@ -541,7 +541,7 @@ module Pdfcrowd
 
             setProxy(nil, nil, nil, nil)
             setUseHttp(false)
-            setUserAgent('pdfcrowd_ruby_client/5.6.1 (https://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/5.8.0 (https://pdfcrowd.com)')
 
             @retry_count = 1
             @converter_version = '20.10'
@@ -735,7 +735,7 @@ module Pdfcrowd
     def self.create_invalid_value_message(value, field, converter, hint, id)
         message = "Invalid value '%s' for %s." % [value, field]
         message += " " + hint if hint
-        return message + " " + "Details: https://www.pdfcrowd.com/doc/api/%s/ruby/ref/#%s" % [converter, id]
+        return message + " " + "Details: https://www.pdfcrowd.com/api/%s-ruby/ref/#%s" % [converter, id]
     end
 
 # generated code
@@ -1327,9 +1327,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the watermark PDF to every page of the output PDF.
+        # Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
         #
-        # * +watermark+ - The file path to a local watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -1340,7 +1340,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1353,9 +1353,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
-        # * +watermark+ - The file path to a local watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -1366,7 +1366,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1379,9 +1379,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the specified PDF to the background of every page of the output PDF.
+        # Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -1392,7 +1392,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1405,9 +1405,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified PDF to the background of the corresponding page of the output PDF.
+        # Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -1418,7 +1418,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1714,11 +1714,11 @@ module Pdfcrowd
 
         # The input HTML is automatically enhanced to improve the readability.
         #
-        # * +enhancements+ - Allowed values are none, readability-v1.
+        # * +enhancements+ - Allowed values are none, readability-v1, readability-v2, readability-v3.
         # * *Returns* - The converter object.
         def setReadabilityEnhancements(enhancements)
-            unless /(?i)^(none|readability-v1)$/.match(enhancements)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-pdf", "Allowed values are none, readability-v1.", "set_readability_enhancements"), 470);
+            unless /(?i)^(none|readability-v1|readability-v2|readability-v3)$/.match(enhancements)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-pdf", "Allowed values are none, readability-v1, readability-v2, readability-v3.", "set_readability_enhancements"), 470);
             end
             
             @fields['readability_enhancements'] = enhancements
@@ -2880,11 +2880,11 @@ module Pdfcrowd
 
         # The input HTML is automatically enhanced to improve the readability.
         #
-        # * +enhancements+ - Allowed values are none, readability-v1.
+        # * +enhancements+ - Allowed values are none, readability-v1, readability-v2, readability-v3.
         # * *Returns* - The converter object.
         def setReadabilityEnhancements(enhancements)
-            unless /(?i)^(none|readability-v1)$/.match(enhancements)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-image", "Allowed values are none, readability-v1.", "set_readability_enhancements"), 470);
+            unless /(?i)^(none|readability-v1|readability-v2|readability-v3)$/.match(enhancements)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-image", "Allowed values are none, readability-v1, readability-v2, readability-v3.", "set_readability_enhancements"), 470);
             end
             
             @fields['readability_enhancements'] = enhancements
@@ -3626,9 +3626,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the watermark PDF to every page of the output PDF.
+        # Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
         #
-        # * +watermark+ - The file path to a local watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -3639,7 +3639,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -3652,9 +3652,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
-        # * +watermark+ - The file path to a local watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -3665,7 +3665,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -3678,9 +3678,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the specified PDF to the background of every page of the output PDF.
+        # Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -3691,7 +3691,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -3704,9 +3704,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified PDF to the background of the corresponding page of the output PDF.
+        # Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -3717,7 +3717,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfcrowd
 version: !ruby/object:Gem::Version
-  version: 5.6.1
+  version: 5.8.0
 platform: ruby
 authors:
 - Pdfcrowd Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-09-05 00:00:00.000000000 Z
 dependencies: []
 description: The Pdfcrowd API lets you easily convert between HTML, PDF and various
   image formats.
@@ -18,7 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/pdfcrowd.rb
-homepage: https://pdfcrowd.com/doc/api/
+homepage: https://pdfcrowd.com/api/
 licenses:
 - MIT
 metadata: {}