docraptor 1.3.0 → 1.4.0

data/lib/docraptor/api_error.rb

@@ -1,12 +1,12 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.3.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.14
 
 =end
 

data/lib/docraptor/configuration.rb

@@ -1,12 +1,12 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.3.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.14
 
 =end
 
@@ -170,7 +170,7 @@ module DocRaptor
     def base_path=(base_path)
       # Add leading and trailing slashes to base_path
       @base_path = "/#{base_path}".gsub(/\/+/, '/')
-      @base_path = "" if @base_path == "/"
+      @base_path = '' if @base_path == '/'
     end
 
     def base_url

data/lib/docraptor/models/async_doc.rb

@@ -1,24 +1,22 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.3.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.14
 
 =end
 
 require 'date'
 
 module DocRaptor
-
   class AsyncDoc
-    # The identifier used to get the status of the document using the status api.
+    # The identifier used to get the status of the document using the status API.
     attr_accessor :status_id
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -39,25 +37,24 @@ module DocRaptor
       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}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'status_id')
         self.status_id = attributes[:'status_id']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      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
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -87,10 +84,10 @@ module DocRaptor
       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
+          # check to ensure the input is an array given that 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) } )
+            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]]))
@@ -172,7 +169,7 @@ module DocRaptor
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -185,5 +182,4 @@ module DocRaptor
     end
 
   end
-
 end

data/lib/docraptor/models/doc.rb

@@ -1,23 +1,19 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.3.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.14
 
 =end
 
 require 'date'
 
 module DocRaptor
-
   class Doc
-    # Specify a specific verison of the DocRaptor Pipeline to use.
-    attr_accessor :pipeline
-
     # A name for identifying your document.
     attr_accessor :name
 
@@ -33,6 +29,9 @@ module DocRaptor
     # Enable test mode for this document. Test documents are not charged for but include a watermark.
     attr_accessor :test
 
+    # Specify a specific verison of the DocRaptor Pipeline to use.
+    attr_accessor :pipeline
+
     # Force strict HTML validation.
     attr_accessor :strict
 
@@ -54,9 +53,15 @@ module DocRaptor
     # Set HTTP referrer when generating this document.
     attr_accessor :referrer
 
-    # A URL that will receive a POST request after successfully completing an asynchronous document. The POST data will include download_url and download_id similar to status api responses. WARNING: this only works on asynchronous documents.
+    # A URL that will receive a POST request after successfully completing an asynchronous document. The POST data will include download_url and download_id similar to status API responses. WARNING: this only works on asynchronous documents.
     attr_accessor :callback_url
 
+    # The number of times a hosted document can be downloaded.  If no limit is specified, the document will be available for an unlimited number of downloads.
+    attr_accessor :hosted_download_limit
+
+    # The date and time at which a hosted document will be removed and no longer available. Must be a properly formatted ISO 8601 datetime, like 1981-01-23T08:02:30-05:00.
+    attr_accessor :hosted_expires_at
+
     attr_accessor :prince_options
 
     class EnumAttributeValidator
@@ -84,12 +89,12 @@ module DocRaptor
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'pipeline' => :'pipeline',
         :'name' => :'name',
         :'document_type' => :'document_type',
         :'document_content' => :'document_content',
         :'document_url' => :'document_url',
         :'test' => :'test',
+        :'pipeline' => :'pipeline',
         :'strict' => :'strict',
         :'ignore_resource_errors' => :'ignore_resource_errors',
         :'ignore_console_messages' => :'ignore_console_messages',
@@ -98,6 +103,8 @@ module DocRaptor
         :'javascript' => :'javascript',
         :'referrer' => :'referrer',
         :'callback_url' => :'callback_url',
+        :'hosted_download_limit' => :'hosted_download_limit',
+        :'hosted_expires_at' => :'hosted_expires_at',
         :'prince_options' => :'prince_options'
       }
     end
@@ -105,12 +112,12 @@ module DocRaptor
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'pipeline' => :'String',
         :'name' => :'String',
         :'document_type' => :'String',
         :'document_content' => :'String',
         :'document_url' => :'String',
         :'test' => :'BOOLEAN',
+        :'pipeline' => :'String',
         :'strict' => :'String',
         :'ignore_resource_errors' => :'BOOLEAN',
         :'ignore_console_messages' => :'BOOLEAN',
@@ -119,6 +126,8 @@ module DocRaptor
         :'javascript' => :'BOOLEAN',
         :'referrer' => :'String',
         :'callback_url' => :'String',
+        :'hosted_download_limit' => :'Integer',
+        :'hosted_expires_at' => :'String',
         :'prince_options' => :'PrinceOptions'
       }
     end
@@ -129,11 +138,7 @@ module DocRaptor
       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?(:'pipeline')
-        self.pipeline = attributes[:'pipeline']
-      end
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
@@ -157,10 +162,12 @@ module DocRaptor
         self.test = true
       end
 
+      if attributes.has_key?(:'pipeline')
+        self.pipeline = attributes[:'pipeline']
+      end
+
       if attributes.has_key?(:'strict')
         self.strict = attributes[:'strict']
-      else
-        self.strict = "none"
       end
 
       if attributes.has_key?(:'ignore_resource_errors')
@@ -199,29 +206,36 @@ module DocRaptor
         self.callback_url = attributes[:'callback_url']
       end
 
+      if attributes.has_key?(:'hosted_download_limit')
+        self.hosted_download_limit = attributes[:'hosted_download_limit']
+      end
+
+      if attributes.has_key?(:'hosted_expires_at')
+        self.hosted_expires_at = attributes[:'hosted_expires_at']
+      end
+
       if attributes.has_key?(:'prince_options')
         self.prince_options = attributes[:'prince_options']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
       if @name.nil?
-        invalid_properties.push("invalid value for 'name', name cannot be nil.")
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
       if @document_type.nil?
-        invalid_properties.push("invalid value for 'document_type', document_type cannot be nil.")
+        invalid_properties.push('invalid value for "document_type", document_type cannot be nil.')
       end
 
       if @document_content.nil?
-        invalid_properties.push("invalid value for 'document_content', document_content cannot be nil.")
+        invalid_properties.push('invalid value for "document_content", document_content cannot be nil.')
       end
 
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
@@ -229,20 +243,20 @@ module DocRaptor
     def valid?
       return false if @name.nil?
       return false if @document_type.nil?
-      document_type_validator = EnumAttributeValidator.new('String', ["pdf", "xls", "xlsx"])
+      document_type_validator = EnumAttributeValidator.new('String', ['pdf', 'xls', 'xlsx'])
       return false unless document_type_validator.valid?(@document_type)
       return false if @document_content.nil?
-      strict_validator = EnumAttributeValidator.new('String', ["none"])
+      strict_validator = EnumAttributeValidator.new('String', ['none', 'html'])
       return false unless strict_validator.valid?(@strict)
-      return true
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] document_type Object to be assigned
     def document_type=(document_type)
-      validator = EnumAttributeValidator.new('String', ["pdf", "xls", "xlsx"])
+      validator = EnumAttributeValidator.new('String', ['pdf', 'xls', 'xlsx'])
       unless validator.valid?(document_type)
-        fail ArgumentError, "invalid value for 'document_type', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "document_type", must be one of #{validator.allowable_values}.'
       end
       @document_type = document_type
     end
@@ -250,9 +264,9 @@ module DocRaptor
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] strict Object to be assigned
     def strict=(strict)
-      validator = EnumAttributeValidator.new('String', ["none"])
+      validator = EnumAttributeValidator.new('String', ['none', 'html'])
       unless validator.valid?(strict)
-        fail ArgumentError, "invalid value for 'strict', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "strict", must be one of #{validator.allowable_values}.'
       end
       @strict = strict
     end
@@ -262,12 +276,12 @@ module DocRaptor
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          pipeline == o.pipeline &&
           name == o.name &&
           document_type == o.document_type &&
           document_content == o.document_content &&
           document_url == o.document_url &&
           test == o.test &&
+          pipeline == o.pipeline &&
           strict == o.strict &&
           ignore_resource_errors == o.ignore_resource_errors &&
           ignore_console_messages == o.ignore_console_messages &&
@@ -276,6 +290,8 @@ module DocRaptor
           javascript == o.javascript &&
           referrer == o.referrer &&
           callback_url == o.callback_url &&
+          hosted_download_limit == o.hosted_download_limit &&
+          hosted_expires_at == o.hosted_expires_at &&
           prince_options == o.prince_options
     end
 
@@ -288,7 +304,7 @@ module DocRaptor
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [pipeline, name, document_type, document_content, document_url, test, strict, ignore_resource_errors, ignore_console_messages, tag, help, javascript, referrer, callback_url, prince_options].hash
+      [name, document_type, document_content, document_url, test, pipeline, strict, ignore_resource_errors, ignore_console_messages, tag, help, javascript, referrer, callback_url, hosted_download_limit, hosted_expires_at, prince_options].hash
     end
 
     # Builds the object from hash
@@ -298,10 +314,10 @@ module DocRaptor
       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
+          # check to ensure the input is an array given that 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) } )
+            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]]))
@@ -383,7 +399,7 @@ module DocRaptor
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -396,5 +412,4 @@ module DocRaptor
     end
 
   end
-
 end

data/lib/docraptor/models/{async_doc_status.rb → doc_status.rb}

@@ -1,27 +1,26 @@
 =begin
-#DocRaptor v1
+#DocRaptor
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.3.0
+OpenAPI spec version: 1.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.4.14
 
 =end
 
 require 'date'
 
 module DocRaptor
-
-  class AsyncDocStatus
+  class DocStatus
     # The present status of the document. Can be queued, working, completed, and failed.
     attr_accessor :status
 
     # The URL where the document can be retrieved. This URL may only be used a few times.
     attr_accessor :download_url
 
-    # The identifier for downloading the document with the download api.
+    # The identifier for downloading the document with the download API.
     attr_accessor :download_id
 
     # Additional information.
@@ -33,7 +32,6 @@ module DocRaptor
     # Error information.
     attr_accessor :validation_errors
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -64,7 +62,7 @@ module DocRaptor
       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}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
@@ -89,20 +87,19 @@ module DocRaptor
       if attributes.has_key?(:'validation_errors')
         self.validation_errors = attributes[:'validation_errors']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      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
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -137,10 +134,10 @@ module DocRaptor
       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
+          # check to ensure the input is an array given that 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) } )
+            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]]))
@@ -222,7 +219,7 @@ module DocRaptor
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -235,5 +232,4 @@ module DocRaptor
     end
 
   end
-
 end