Class: Dropbox::Sign::SignatureRequestResponseDataValueSignature

Inherits:
SignatureRequestResponseDataBase show all
Defined in:
lib/dropbox-sign/models/signature_request_response_data_value_signature.rb

Instance Attribute Summary collapse

Attributes inherited from SignatureRequestResponseDataBase

#api_id, #name, #required, #signature_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SignatureRequestResponseDataBase

discriminator_class_name, openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ SignatureRequestResponseDataValueSignature

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestResponseDataValueSignature` 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.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueSignature`. 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
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'signature'
  end

  if attributes.key?(:'value')
    self.value = attributes[:'value']
  end

  if attributes.key?(:'is_signed')
    self.is_signed = attributes[:'is_signed']
  end
end

Instance Attribute Details

#is_signed ⇒ Boolean?

This field contains the boolean true if the field is signed.

Returns:

  • (Boolean, nil) 


31
32
33
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 31

def is_signed
  @is_signed
end

#type ⇒ String

A signature input field

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 23

def type
  @type
end

#value ⇒ String

The value of the form field.

Returns:

  • (String) 


27
28
29
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 27

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



43
44
45
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 43

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 34

def self.attribute_map
  {
    :'type' => :'type',
    :'value' => :'value',
    :'is_signed' => :'is_signed'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



159
160
161
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 159

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ SignatureRequestResponseDataValueSignature

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



81
82
83
84
85
86
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 81

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "SignatureRequestResponseDataValueSignature"
  ) || SignatureRequestResponseDataValueSignature.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



64
65
66
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 64

def self.merged_attributes
  self.superclass.attribute_map.merge(self.attribute_map)
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



74
75
76
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 74

def self.merged_nullable
  self.superclass.openapi_nullable.merge(self.openapi_nullable)
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



69
70
71
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 69

def self.merged_types
  self.superclass.openapi_types.merge(self.openapi_types)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
61
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 57

def self.openapi_nullable
  Set.new([
    :'is_signed'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 48

def self.openapi_types
  {
    :'type' => :'String',
    :'value' => :'String',
    :'is_signed' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      value == o.value &&
      is_signed == o.is_signed && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 190

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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 261

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 166

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



152
153
154
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 152

def hash
  [type, value, is_signed].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



123
124
125
126
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 123

def list_invalid_properties
  invalid_properties = super
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 236

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 242

def to_hash(include_nil = true)
  hash = super
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



230
231
232
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 230

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



130
131
132
 
# File 'lib/dropbox-sign/models/signature_request_response_data_value_signature.rb', line 130

def valid?
  true && super
end