class DocRaptor::Doc

Attributes

callback_url[RW]

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.

document_content[RW]

The HTML data to be transformed into a document. You must supply content using document_content or document_url.

document_type[RW]

The type of document being created.

document_url[RW]

The URL to fetch the HTML data to be transformed into a document. You must supply content using document_content or document_url.

help[RW]

Request support help with this request if it succeeds.

hosted_download_limit[RW]

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.

hosted_expires_at[RW]

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.

ignore_console_messages[RW]

Prevent console.log from stopping document rendering during JavaScript execution.

ignore_resource_errors[RW]

Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.

javascript[RW]

Enable DocRaptor JavaScript parsing. PrinceXML JavaScript parsing is also available elsewhere.

name[RW]

A name for identifying your document.

pipeline[RW]

Specify a specific verison of the DocRaptor Pipeline to use.

prince_options[RW]
referrer[RW]

Set HTTP referrer when generating this document.

strict[RW]

Force strict HTML validation.

tag[RW]

A field for storing a small amount of metadata with this document.

test[RW]

Enable test mode for this document. Test documents are not charged for but include a watermark.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/docraptor/models/doc.rb, line 90
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docraptor/models/doc.rb, line 137
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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'document_type')
    self.document_type = attributes[:'document_type']
  end

  if attributes.has_key?(:'document_content')
    self.document_content = attributes[:'document_content']
  end

  if attributes.has_key?(:'document_url')
    self.document_url = attributes[:'document_url']
  end

  if attributes.has_key?(:'test')
    self.test = attributes[:'test']
  else
    self.test = true
  end

  if attributes.has_key?(:'pipeline')
    self.pipeline = attributes[:'pipeline']
  end

  if attributes.has_key?(:'strict')
    self.strict = attributes[:'strict']
  end

  if attributes.has_key?(:'ignore_resource_errors')
    self.ignore_resource_errors = attributes[:'ignore_resource_errors']
  else
    self.ignore_resource_errors = true
  end

  if attributes.has_key?(:'ignore_console_messages')
    self.ignore_console_messages = attributes[:'ignore_console_messages']
  else
    self.ignore_console_messages = false
  end

  if attributes.has_key?(:'tag')
    self.tag = attributes[:'tag']
  end

  if attributes.has_key?(:'help')
    self.help = attributes[:'help']
  else
    self.help = false
  end

  if attributes.has_key?(:'javascript')
    self.javascript = attributes[:'javascript']
  else
    self.javascript = false
  end

  if attributes.has_key?(:'referrer')
    self.referrer = attributes[:'referrer']
  end

  if attributes.has_key?(:'callback_url')
    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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docraptor/models/doc.rb, line 113
def self.swagger_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

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docraptor/models/doc.rb, line 276
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
_deserialize(type, value) click to toggle source

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 334
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 = DocRaptor.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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 400
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
build_from_hash(attributes) click to toggle source

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 313
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 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
document_type=(document_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] document_type Object to be assigned

# File lib/docraptor/models/doc.rb, line 256
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docraptor/models/doc.rb, line 300
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docraptor/models/doc.rb, line 306
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
list_invalid_properties() click to toggle source

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 224
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

  if @document_content.nil?
    invalid_properties.push('invalid value for "document_content", document_content cannot be nil.')
  end

  invalid_properties
end
strict=(strict) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] strict Object to be assigned

# File lib/docraptor/models/doc.rb, line 266
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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docraptor/models/doc.rb, line 380
def to_body
  to_hash
end
to_hash() click to toggle source

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 386
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docraptor/models/doc.rb, line 374
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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 243
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)
  return false if @document_content.nil?
  strict_validator = EnumAttributeValidator.new('String', ['none', 'html'])
  return false unless strict_validator.valid?(@strict)
  true
end