Class: Dropbox::Sign::SubSignatureRequestSigner

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/sub_signature_request_signer.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubSignatureRequestSigner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 130

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubSignatureRequestSigner` 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::SubSignatureRequestSigner`. 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?(:'email_address')
    self.email_address = attributes[:'email_address']
  end

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

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

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

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

Instance Attribute Details

#email_address ⇒ String

The email address of the signer.

Returns:

  • (String) 


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

def email_address
  @email_address
end

#name ⇒ String

The name of the signer.

Returns:

  • (String) 


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

def name
  @name
end

#order ⇒ Integer?

The order the signer is required to sign in.

Returns:

  • (Integer, nil) 


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

def order
  @order
end

#pin ⇒ String

The 4- to 12-character access code that will secure this signer’s signature page.

Returns:

  • (String) 


35
36
37
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 35

def pin
  @pin
end

#sms_phone_number ⇒ String

An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer’s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). NOTE: Not available in test mode and requires a Standard plan or higher.

Returns:

  • (String) 


39
40
41
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 39

def sms_phone_number
  @sms_phone_number
end

#sms_phone_number_type ⇒ String

Specifies the feature used with the ‘sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (and email).

Returns:

  • (String) 


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

def sms_phone_number_type
  @sms_phone_number_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 68

def self.attribute_map
  {
    :'name' => :'name',
    :'email_address' => :'email_address',
    :'order' => :'order',
    :'pin' => :'pin',
    :'sms_phone_number' => :'sms_phone_number',
    :'sms_phone_number_type' => :'sms_phone_number_type'
  }
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



255
256
257
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 255

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

.init(data) ⇒ SubSignatureRequestSigner

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



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

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



104
105
106
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 104

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



114
115
116
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 114

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



109
110
111
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 109

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
101
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 85

def self.openapi_types
  {
    :'name' => :'String',
    :'email_address' => :'String',
    :'order' => :'Integer',
    :'pin' => :'String',
    :'sms_phone_number' => :'String',
    :'sms_phone_number_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      email_address == o.email_address &&
      order == o.order &&
      pin == o.pin &&
      sms_phone_number == o.sms_phone_number &&
      sms_phone_number_type == o.sms_phone_number_type
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 285

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 356

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 262

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


242
243
244
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 248

def hash
  [name, email_address, order, pin, sms_phone_number, sms_phone_number_type].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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

  if !@pin.nil? && @pin.to_s.length > 12
    invalid_properties.push('invalid value for "pin", the character length must be smaller than or equal to 12.')
  end

  if !@pin.nil? && @pin.to_s.length < 4
    invalid_properties.push('invalid value for "pin", the character length must be great than or equal to 4.')
  end

  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



331
332
333
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 331

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 337

def to_hash(include_nil = true)
  hash = {}
  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



325
326
327
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 325

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



193
194
195
196
197
198
199
200
201
 
# File 'lib/dropbox-sign/models/sub_signature_request_signer.rb', line 193

def valid?
  return false if @name.nil?
  return false if @email_address.nil?
  return false if !@pin.nil? && @pin.to_s.length > 12
  return false if !@pin.nil? && @pin.to_s.length < 4
  sms_phone_number_type_validator = EnumAttributeValidator.new('String', ["authentication", "delivery"])
  return false unless sms_phone_number_type_validator.valid?(@sms_phone_number_type)
  true
end