Class: Dropbox::Sign::SignatureRequestResponseSignatures

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

Overview

An array of signature objects, 1 for each signer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureRequestResponseSignatures

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 201

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#decline_reason ⇒ String?

The reason provided by the signer for declining the request.

Returns:

  • (String, nil) 


52
53
54
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 52

def decline_reason
  @decline_reason
end

#error ⇒ String?

Error message pertaining to this signer, or null.

Returns:

  • (String, nil) 


96
97
98
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 96

def error
  @error
end

#has_pin ⇒ Boolean

Boolean to indicate whether this signature requires a PIN to access.

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 68

def has_pin
  @has_pin
end

#has_sms_auth ⇒ Boolean?

Boolean to indicate whether this signature has SMS authentication enabled.

Returns:

  • (Boolean, nil) 


72
73
74
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 72

def has_sms_auth
  @has_sms_auth
end

#has_sms_delivery ⇒ Boolean?

Boolean to indicate whether this signature has SMS delivery enabled.

Returns:

  • (Boolean, nil) 


76
77
78
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 76

def has_sms_delivery
  @has_sms_delivery
end

#last_reminded_at ⇒ Integer?

The time the last reminder email was sent to the signer or null.

Returns:

  • (Integer, nil) 


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

def last_reminded_at
  @last_reminded_at
end

#last_viewed_at ⇒ Integer?

The time that the document was last viewed by this signer or null.

Returns:

  • (Integer, nil) 


60
61
62
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 60

def last_viewed_at
  @last_viewed_at
end

#order ⇒ Integer?

If signer order is assigned this is the 0-based index for this signer.

Returns:

  • (Integer, nil) 


44
45
46
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 44

def order
  @order
end

#reassigned_by ⇒ String?

Email address of original signer who reassigned to this signer.

Returns:

  • (String, nil) 


84
85
86
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 84

def reassigned_by
  @reassigned_by
end

#reassigned_from ⇒ String?

Previous signature identifier.

Returns:

  • (String, nil) 


92
93
94
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 92

def reassigned_from
  @reassigned_from
end

#reassignment_reason ⇒ String?

Reason provided by original signer who reassigned to this signer.

Returns:

  • (String, nil) 


88
89
90
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 88

def reassignment_reason
  @reassignment_reason
end

#signature_id ⇒ String

Signature identifier.

Returns:

  • (String) 


24
25
26
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 24

def signature_id
  @signature_id
end

#signed_at ⇒ Integer?

Time that the document was signed or null.

Returns:

  • (Integer, nil) 


56
57
58
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 56

def signed_at
  @signed_at
end

#signer_email_address ⇒ String

The email address of the signer.

Returns:

  • (String) 


32
33
34
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 32

def signer_email_address
  @signer_email_address
end

#signer_group_guid ⇒ String?

Signer Group GUID

Returns:

  • (String, nil) 


28
29
30
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 28

def signer_group_guid
  @signer_group_guid
end

#signer_name ⇒ String?

The name of the signer.

Returns:

  • (String, nil) 


36
37
38
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 36

def signer_name
  @signer_name
end

#signer_role ⇒ String?

The role of the signer.

Returns:

  • (String, nil) 


40
41
42
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 40

def signer_role
  @signer_role
end

#sms_phone_number ⇒ String?

The SMS phone number used for authentication or signature request delivery.

Returns:

  • (String, nil) 


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

def sms_phone_number
  @sms_phone_number
end

#status_code ⇒ String

The current status of the signature. eg: awaiting_signature, signed, declined.

Returns:

  • (String) 


48
49
50
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 48

def status_code
  @status_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 99

def self.attribute_map
  {
    :'signature_id' => :'signature_id',
    :'signer_group_guid' => :'signer_group_guid',
    :'signer_email_address' => :'signer_email_address',
    :'signer_name' => :'signer_name',
    :'signer_role' => :'signer_role',
    :'order' => :'order',
    :'status_code' => :'status_code',
    :'decline_reason' => :'decline_reason',
    :'signed_at' => :'signed_at',
    :'last_viewed_at' => :'last_viewed_at',
    :'last_reminded_at' => :'last_reminded_at',
    :'has_pin' => :'has_pin',
    :'has_sms_auth' => :'has_sms_auth',
    :'has_sms_delivery' => :'has_sms_delivery',
    :'sms_phone_number' => :'sms_phone_number',
    :'reassigned_by' => :'reassigned_by',
    :'reassignment_reason' => :'reassignment_reason',
    :'reassigned_from' => :'reassigned_from',
    :'error' => :'error'
  }
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



345
346
347
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 345

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

.init(data) ⇒ SignatureRequestResponseSignatures

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



192
193
194
195
196
197
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 192

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



175
176
177
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 175

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



185
186
187
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 185

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



180
181
182
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 180

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 154

def self.openapi_nullable
  Set.new([
    :'signer_group_guid',
    :'signer_name',
    :'signer_role',
    :'order',
    :'decline_reason',
    :'signed_at',
    :'last_viewed_at',
    :'last_reminded_at',
    :'has_sms_auth',
    :'has_sms_delivery',
    :'sms_phone_number',
    :'reassigned_by',
    :'reassignment_reason',
    :'reassigned_from',
    :'error'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 129

def self.openapi_types
  {
    :'signature_id' => :'String',
    :'signer_group_guid' => :'String',
    :'signer_email_address' => :'String',
    :'signer_name' => :'String',
    :'signer_role' => :'String',
    :'order' => :'Integer',
    :'status_code' => :'String',
    :'decline_reason' => :'String',
    :'signed_at' => :'Integer',
    :'last_viewed_at' => :'Integer',
    :'last_reminded_at' => :'Integer',
    :'has_pin' => :'Boolean',
    :'has_sms_auth' => :'Boolean',
    :'has_sms_delivery' => :'Boolean',
    :'sms_phone_number' => :'String',
    :'reassigned_by' => :'String',
    :'reassignment_reason' => :'String',
    :'reassigned_from' => :'String',
    :'error' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      signature_id == o.signature_id &&
      signer_group_guid == o.signer_group_guid &&
      signer_email_address == o.signer_email_address &&
      signer_name == o.signer_name &&
      signer_role == o.signer_role &&
      order == o.order &&
      status_code == o.status_code &&
      decline_reason == o.decline_reason &&
      signed_at == o.signed_at &&
      last_viewed_at == o.last_viewed_at &&
      last_reminded_at == o.last_reminded_at &&
      has_pin == o.has_pin &&
      has_sms_auth == o.has_sms_auth &&
      has_sms_delivery == o.has_sms_delivery &&
      sms_phone_number == o.sms_phone_number &&
      reassigned_by == o.reassigned_by &&
      reassignment_reason == o.reassignment_reason &&
      reassigned_from == o.reassigned_from &&
      error == o.error
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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 375

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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 446

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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 352

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


332
333
334
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 338

def hash
  [signature_id, signer_group_guid, signer_email_address, signer_name, signer_role, order, status_code, decline_reason, signed_at, last_viewed_at, last_reminded_at, has_pin, has_sms_auth, has_sms_delivery, sms_phone_number, reassigned_by, reassignment_reason, reassigned_from, error].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



293
294
295
296
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 293

def list_invalid_properties
  invalid_properties = Array.new
  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



421
422
423
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 421

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



427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 427

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



415
416
417
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 415

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



300
301
302
 
# File 'lib/dropbox-sign/models/signature_request_response_signatures.rb', line 300

def valid?
  true
end