class DocuSign_eSign::RecipientPreviewRequest

This request object contains the information necessary to create a recipient preview.

Attributes

assertion_id[RW]
authentication_instant[RW]
authentication_method[RW]
client_ur_ls[RW]
ping_frequency[RW]
ping_url[RW]
recipient_id[RW]

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

return_url[RW]
security_domain[RW]
x_frame_options[RW]
x_frame_options_allow_from_url[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/recipient_preview_request.rb, line 51
def self.attribute_map
  {
    :'assertion_id' => :'assertionId',
    :'authentication_instant' => :'authenticationInstant',
    :'authentication_method' => :'authenticationMethod',
    :'client_ur_ls' => :'clientURLs',
    :'ping_frequency' => :'pingFrequency',
    :'ping_url' => :'pingUrl',
    :'recipient_id' => :'recipientId',
    :'return_url' => :'returnUrl',
    :'security_domain' => :'securityDomain',
    :'x_frame_options' => :'xFrameOptions',
    :'x_frame_options_allow_from_url' => :'xFrameOptionsAllowFromUrl'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/docusign_esign/models/recipient_preview_request.rb, line 86
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?(:'assertionId')
    self.assertion_id = attributes[:'assertionId']
  end

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'xFrameOptionsAllowFromUrl')
    self.x_frame_options_allow_from_url = attributes[:'xFrameOptionsAllowFromUrl']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/recipient_preview_request.rb, line 68
def self.swagger_types
  {
    :'assertion_id' => :'String',
    :'authentication_instant' => :'String',
    :'authentication_method' => :'String',
    :'client_ur_ls' => :'RecipientTokenClientURLs',
    :'ping_frequency' => :'String',
    :'ping_url' => :'String',
    :'recipient_id' => :'String',
    :'return_url' => :'String',
    :'security_domain' => :'String',
    :'x_frame_options' => :'String',
    :'x_frame_options_allow_from_url' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/docusign_esign/models/recipient_preview_request.rb, line 152
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assertion_id == o.assertion_id &&
      authentication_instant == o.authentication_instant &&
      authentication_method == o.authentication_method &&
      client_ur_ls == o.client_ur_ls &&
      ping_frequency == o.ping_frequency &&
      ping_url == o.ping_url &&
      recipient_id == o.recipient_id &&
      return_url == o.return_url &&
      security_domain == o.security_domain &&
      x_frame_options == o.x_frame_options &&
      x_frame_options_allow_from_url == o.x_frame_options_allow_from_url
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/docusign_esign/models/recipient_preview_request.rb, line 204
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 = DocuSign_eSign.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/docusign_esign/models/recipient_preview_request.rb, line 270
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/docusign_esign/models/recipient_preview_request.rb, line 183
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
eql?(o) click to toggle source

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

# File lib/docusign_esign/models/recipient_preview_request.rb, line 170
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/docusign_esign/models/recipient_preview_request.rb, line 176
def hash
  [assertion_id, authentication_instant, authentication_method, client_ur_ls, ping_frequency, ping_url, recipient_id, return_url, security_domain, x_frame_options, x_frame_options_allow_from_url].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/docusign_esign/models/recipient_preview_request.rb, line 139
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/docusign_esign/models/recipient_preview_request.rb, line 250
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/docusign_esign/models/recipient_preview_request.rb, line 256
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/docusign_esign/models/recipient_preview_request.rb, line 244
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/docusign_esign/models/recipient_preview_request.rb, line 146
def valid?
  true
end