Class: DocuSign_eSign::DisplayApplianceRecipient

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/display_appliance_recipient.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DisplayApplianceRecipient

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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
227
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 137

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?(:'cfrPart11')
    self.cfr_part11 = attributes[:'cfrPart11']
  end

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

  if attributes.has_key?(:'digitalSignatureBase64')
    self.digital_signature_base64 = attributes[:'digitalSignatureBase64']
  end

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

  if attributes.has_key?(:'fullName')
    self.full_name = attributes[:'fullName']
  end

  if attributes.has_key?(:'initialsBase64')
    self.initials_base64 = attributes[:'initialsBase64']
  end

  if attributes.has_key?(:'inPersonEmail')
    self.in_person_email = attributes[:'inPersonEmail']
  end

  if attributes.has_key?(:'isNotary')
    self.is_notary = attributes[:'isNotary']
  end

  if attributes.has_key?(:'notarySealBase64')
    self.notary_seal_base64 = attributes[:'notarySealBase64']
  end

  if attributes.has_key?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end

  if attributes.has_key?(:'recipientCompleteCount')
    self.recipient_complete_count = attributes[:'recipientCompleteCount']
  end

  if attributes.has_key?(:'recipientGuidId')
    self.recipient_guid_id = attributes[:'recipientGuidId']
  end

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

  if attributes.has_key?(:'recipientStatus')
    self.recipient_status = attributes[:'recipientStatus']
  end

  if attributes.has_key?(:'recipientType')
    self.recipient_type = attributes[:'recipientType']
  end

  if attributes.has_key?(:'rowState')
    self.row_state = attributes[:'rowState']
  end

  if attributes.has_key?(:'signatureBase64')
    self.signature_base64 = attributes[:'signatureBase64']
  end

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

  if attributes.has_key?(:'signerApplyTabs')
    self.signer_apply_tabs = attributes[:'signerApplyTabs']
  end

  if attributes.has_key?(:'signerAttachmentBase64')
    self.signer_attachment_base64 = attributes[:'signerAttachmentBase64']
  end

  if attributes.has_key?(:'userName')
    self.user_name = attributes[:'userName']
  end

end

Instance Attribute Details

#cfr_part11 ⇒ Object

Returns the value of attribute cfr_part11.



18
19
20
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 18

def cfr_part11
  @cfr_part11
end

#company ⇒ Object

Returns the value of attribute company.



21
22
23
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 21

def company
  @company
end

#digital_signature_base64 ⇒ Object

Returns the value of attribute digital_signature_base64.



24
25
26
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 24

def digital_signature_base64
  @digital_signature_base64
end

#email ⇒ Object

Returns the value of attribute email.



27
28
29
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 27

def email
  @email
end

#full_name ⇒ Object

Returns the value of attribute full_name.



30
31
32
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 30

def full_name
  @full_name
end

#in_person_email ⇒ Object

Returns the value of attribute in_person_email.



36
37
38
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 36

def in_person_email
  @in_person_email
end

#initials_base64 ⇒ Object

Returns the value of attribute initials_base64.



33
34
35
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 33

def initials_base64
  @initials_base64
end

#is_notary ⇒ Object

Returns the value of attribute is_notary.



39
40
41
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 39

def is_notary
  @is_notary
end

#notary_seal_base64 ⇒ Object

Returns the value of attribute notary_seal_base64.



42
43
44
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 42

def notary_seal_base64
  @notary_seal_base64
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



45
46
47
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 45

def phone_number
  @phone_number
end

#recipient_complete_count ⇒ Object

Returns the value of attribute recipient_complete_count.



48
49
50
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 48

def recipient_complete_count
  @recipient_complete_count
end

#recipient_guid_id ⇒ Object

Returns the value of attribute recipient_guid_id.



51
52
53
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 51

def recipient_guid_id
  @recipient_guid_id
end

#recipient_id ⇒ Object

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



54
55
56
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 54

def recipient_id
  @recipient_id
end

#recipient_status ⇒ Object

Returns the value of attribute recipient_status.



57
58
59
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 57

def recipient_status
  @recipient_status
end

#recipient_type ⇒ Object

Returns the value of attribute recipient_type.



60
61
62
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 60

def recipient_type
  @recipient_type
end

#row_state ⇒ Object

Returns the value of attribute row_state.



63
64
65
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 63

def row_state
  @row_state
end

#signature_base64 ⇒ Object

Returns the value of attribute signature_base64.



66
67
68
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 66

def signature_base64
  @signature_base64
end

#signed ⇒ Object

Returns the value of attribute signed.



69
70
71
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 69

def signed
  @signed
end

#signer_apply_tabs ⇒ Object

Returns the value of attribute signer_apply_tabs.



72
73
74
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 72

def signer_apply_tabs
  @signer_apply_tabs
end

#signer_attachment_base64 ⇒ Object

Returns the value of attribute signer_attachment_base64.



75
76
77
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 75

def signer_attachment_base64
  @signer_attachment_base64
end

#user_name ⇒ Object

Returns the value of attribute user_name.



78
79
80
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 78

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 82

def self.attribute_map
  {
    :'cfr_part11' => :'cfrPart11',
    :'company' => :'company',
    :'digital_signature_base64' => :'digitalSignatureBase64',
    :'email' => :'email',
    :'full_name' => :'fullName',
    :'initials_base64' => :'initialsBase64',
    :'in_person_email' => :'inPersonEmail',
    :'is_notary' => :'isNotary',
    :'notary_seal_base64' => :'notarySealBase64',
    :'phone_number' => :'phoneNumber',
    :'recipient_complete_count' => :'recipientCompleteCount',
    :'recipient_guid_id' => :'recipientGuidId',
    :'recipient_id' => :'recipientId',
    :'recipient_status' => :'recipientStatus',
    :'recipient_type' => :'recipientType',
    :'row_state' => :'rowState',
    :'signature_base64' => :'signatureBase64',
    :'signed' => :'signed',
    :'signer_apply_tabs' => :'signerApplyTabs',
    :'signer_attachment_base64' => :'signerAttachmentBase64',
    :'user_name' => :'userName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 109

def self.swagger_types
  {
    :'cfr_part11' => :'BOOLEAN',
    :'company' => :'String',
    :'digital_signature_base64' => :'String',
    :'email' => :'String',
    :'full_name' => :'String',
    :'initials_base64' => :'String',
    :'in_person_email' => :'String',
    :'is_notary' => :'BOOLEAN',
    :'notary_seal_base64' => :'String',
    :'phone_number' => :'String',
    :'recipient_complete_count' => :'Integer',
    :'recipient_guid_id' => :'String',
    :'recipient_id' => :'String',
    :'recipient_status' => :'String',
    :'recipient_type' => :'String',
    :'row_state' => :'String',
    :'signature_base64' => :'String',
    :'signed' => :'BOOLEAN',
    :'signer_apply_tabs' => :'BOOLEAN',
    :'signer_attachment_base64' => :'String',
    :'user_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cfr_part11 == o.cfr_part11 &&
      company == o.company &&
      digital_signature_base64 == o.digital_signature_base64 &&
      email == o.email &&
      full_name == o.full_name &&
      initials_base64 == o.initials_base64 &&
      in_person_email == o.in_person_email &&
      is_notary == o.is_notary &&
      notary_seal_base64 == o.notary_seal_base64 &&
      phone_number == o.phone_number &&
      recipient_complete_count == o.recipient_complete_count &&
      recipient_guid_id == o.recipient_guid_id &&
      recipient_id == o.recipient_id &&
      recipient_status == o.recipient_status &&
      recipient_type == o.recipient_type &&
      row_state == o.row_state &&
      signature_base64 == o.signature_base64 &&
      signed == o.signed &&
      signer_apply_tabs == o.signer_apply_tabs &&
      signer_attachment_base64 == o.signer_attachment_base64 &&
      user_name == o.user_name
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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 306

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) ⇒ 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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 372

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 285

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 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 278

def hash
  [cfr_part11, company, digital_signature_base64, email, full_name, initials_base64, in_person_email, is_notary, notary_seal_base64, phone_number, recipient_complete_count, recipient_guid_id, recipient_id, recipient_status, recipient_type, row_state, signature_base64, signed, signer_apply_tabs, signer_attachment_base64, user_name].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



231
232
233
234
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 231

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



352
353
354
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 352

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



358
359
360
361
362
363
364
365
366
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 358

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



346
347
348
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 346

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



238
239
240
 
# File 'lib/docusign_esign/models/display_appliance_recipient.rb', line 238

def valid?
  return true
end