class DocRaptor::Doc
Attributes
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.
The HTML data to be transformed into a document. You must supply content using document_content
or document_url.
The type of document being created.
The URL to fetch the HTML data to be transformed into a document. You must supply content using document_content
or document_url.
Request support help with this request if it succeeds.
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.
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.
Prevent console.log from stopping document rendering during JavaScript execution.
Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.
Enable DocRaptor
JavaScript parsing. PrinceXML JavaScript parsing is also available elsewhere.
A name for identifying your document.
Specify a specific verison of the DocRaptor
Pipeline to use.
Set HTTP referrer when generating this document.
Force strict HTML validation.
A field for storing a small amount of metadata with this document.
Enable test mode for this document. Test documents are not charged for but include a watermark.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/docraptor/models/doc.rb, line 114 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docraptor/models/doc.rb, line 91 def self.attribute_map { :'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', :'tag' => :'tag', :'help' => :'help', :'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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/docraptor/models/doc.rb, line 327 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docraptor/models/doc.rb, line 149 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `DocRaptor::Doc` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `DocRaptor::Doc`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'document_type') self.document_type = attributes[:'document_type'] end if attributes.key?(:'document_content') self.document_content = attributes[:'document_content'] end if attributes.key?(:'document_url') self.document_url = attributes[:'document_url'] end if attributes.key?(:'test') self.test = attributes[:'test'] else self.test = true end if attributes.key?(:'pipeline') self.pipeline = attributes[:'pipeline'] end if attributes.key?(:'strict') self.strict = attributes[:'strict'] end if attributes.key?(:'ignore_resource_errors') self.ignore_resource_errors = attributes[:'ignore_resource_errors'] else self.ignore_resource_errors = true end if attributes.key?(:'ignore_console_messages') self.ignore_console_messages = attributes[:'ignore_console_messages'] else self.ignore_console_messages = false end if attributes.key?(:'tag') self.tag = attributes[:'tag'] end if attributes.key?(:'help') self.help = attributes[:'help'] else self.help = false end if attributes.key?(:'javascript') self.javascript = attributes[:'javascript'] else self.javascript = false end if attributes.key?(:'referrer') self.referrer = attributes[:'referrer'] end if attributes.key?(:'callback_url') self.callback_url = attributes[:'callback_url'] end if attributes.key?(:'hosted_download_limit') self.hosted_download_limit = attributes[:'hosted_download_limit'] end if attributes.key?(:'hosted_expires_at') self.hosted_expires_at = attributes[:'hosted_expires_at'] end if attributes.key?(:'prince_options') self.prince_options = attributes[:'prince_options'] end end
List of attributes with nullable: true
# File lib/docraptor/models/doc.rb, line 142 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/docraptor/models/doc.rb, line 119 def self.openapi_types { :'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', :'tag' => :'String', :'help' => :'Boolean', :'javascript' => :'Boolean', :'referrer' => :'String', :'callback_url' => :'String', :'hosted_download_limit' => :'Integer', :'hosted_expires_at' => :'String', :'prince_options' => :'PrinceOptions' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/docraptor/models/doc.rb, line 290 def ==(o) return true if self.equal?(o) self.class == o.class && 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 && tag == o.tag && help == o.help && 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/docraptor/models/doc.rb, line 358 def _deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = DocRaptor.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end 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
# File lib/docraptor/models/doc.rb, line 429 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/docraptor/models/doc.rb, line 334 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # 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) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
Custom attribute writer method checking allowed values (enum). @param [Object] document_type
Object to be assigned
# File lib/docraptor/models/doc.rb, line 270 def document_type=(document_type) 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}." end @document_type = document_type end
@see the ‘==` method @param [Object] Object to be compared
# File lib/docraptor/models/doc.rb, line 314 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/docraptor/models/doc.rb, line 320 def 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docraptor/models/doc.rb, line 243 def list_invalid_properties invalid_properties = Array.new if @name.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.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] strict Object to be assigned
# File lib/docraptor/models/doc.rb, line 280 def strict=(strict) validator = EnumAttributeValidator.new('String', ["none", "html"]) unless validator.valid?(strict) fail ArgumentError, "invalid value for \"strict\", must be one of #{validator.allowable_values}." end @strict = strict end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docraptor/models/doc.rb, line 411 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docraptor/models/doc.rb, line 399 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/docraptor/models/doc.rb, line 258 def valid? return false if @name.nil? return false if @document_type.nil? document_type_validator = EnumAttributeValidator.new('String', ["pdf", "xls", "xlsx"]) return false unless document_type_validator.valid?(@document_type) strict_validator = EnumAttributeValidator.new('String', ["none", "html"]) return false unless strict_validator.valid?(@strict) true end