class DocuSign_eSign::RecipientTokenClientURLs

Attributes

on_access_code_failed[RW]
on_cancel[RW]
on_decline[RW]
on_exception[RW]
on_fax_pending[RW]
on_id_check_failed[RW]
on_session_timeout[RW]
on_signing_complete[RW]
on_ttl_expired[RW]
on_viewing_complete[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_token_client_ur_ls.rb, line 47
def self.attribute_map
  {
    :'on_access_code_failed' => :'OnAccessCodeFailed',
    :'on_cancel' => :'OnCancel',
    :'on_decline' => :'OnDecline',
    :'on_exception' => :'OnException',
    :'on_fax_pending' => :'OnFaxPending',
    :'on_id_check_failed' => :'OnIdCheckFailed',
    :'on_session_timeout' => :'OnSessionTimeout',
    :'on_signing_complete' => :'OnSigningComplete',
    :'on_ttl_expired' => :'OnTTLExpired',
    :'on_viewing_complete' => :'OnViewingComplete'
  }
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_token_client_ur_ls.rb, line 80
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?(:'OnAccessCodeFailed')
    self.on_access_code_failed = attributes[:'OnAccessCodeFailed']
  end

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/docusign_esign/models/recipient_token_client_ur_ls.rb, line 63
def self.swagger_types
  {
    :'on_access_code_failed' => :'String',
    :'on_cancel' => :'String',
    :'on_decline' => :'String',
    :'on_exception' => :'String',
    :'on_fax_pending' => :'String',
    :'on_id_check_failed' => :'String',
    :'on_session_timeout' => :'String',
    :'on_signing_complete' => :'String',
    :'on_ttl_expired' => :'String',
    :'on_viewing_complete' => :'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_token_client_ur_ls.rb, line 142
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      on_access_code_failed == o.on_access_code_failed &&
      on_cancel == o.on_cancel &&
      on_decline == o.on_decline &&
      on_exception == o.on_exception &&
      on_fax_pending == o.on_fax_pending &&
      on_id_check_failed == o.on_id_check_failed &&
      on_session_timeout == o.on_session_timeout &&
      on_signing_complete == o.on_signing_complete &&
      on_ttl_expired == o.on_ttl_expired &&
      on_viewing_complete == o.on_viewing_complete
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_token_client_ur_ls.rb, line 193
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_token_client_ur_ls.rb, line 259
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_token_client_ur_ls.rb, line 172
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_token_client_ur_ls.rb, line 159
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_token_client_ur_ls.rb, line 165
def hash
  [on_access_code_failed, on_cancel, on_decline, on_exception, on_fax_pending, on_id_check_failed, on_session_timeout, on_signing_complete, on_ttl_expired, on_viewing_complete].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_token_client_ur_ls.rb, line 129
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_token_client_ur_ls.rb, line 239
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_token_client_ur_ls.rb, line 245
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_token_client_ur_ls.rb, line 233
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_token_client_ur_ls.rb, line 136
def valid?
  true
end