Class: DocuSign_eSign::Tabs

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tabs

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
# File 'lib/docusign_esign/models/tabs.rb', line 186

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?(:'approveTabs')
    if (value = attributes[:'approveTabs']).is_a?(Array)
      self.approve_tabs = value
    end
  end

  if attributes.has_key?(:'checkboxTabs')
    if (value = attributes[:'checkboxTabs']).is_a?(Array)
      self.checkbox_tabs = value
    end
  end

  if attributes.has_key?(:'commentThreadTabs')
    if (value = attributes[:'commentThreadTabs']).is_a?(Array)
      self.comment_thread_tabs = value
    end
  end

  if attributes.has_key?(:'companyTabs')
    if (value = attributes[:'companyTabs']).is_a?(Array)
      self.company_tabs = value
    end
  end

  if attributes.has_key?(:'dateSignedTabs')
    if (value = attributes[:'dateSignedTabs']).is_a?(Array)
      self.date_signed_tabs = value
    end
  end

  if attributes.has_key?(:'dateTabs')
    if (value = attributes[:'dateTabs']).is_a?(Array)
      self.date_tabs = value
    end
  end

  if attributes.has_key?(:'declineTabs')
    if (value = attributes[:'declineTabs']).is_a?(Array)
      self.decline_tabs = value
    end
  end

  if attributes.has_key?(:'drawTabs')
    if (value = attributes[:'drawTabs']).is_a?(Array)
      self.draw_tabs = value
    end
  end

  if attributes.has_key?(:'emailAddressTabs')
    if (value = attributes[:'emailAddressTabs']).is_a?(Array)
      self.email_address_tabs = value
    end
  end

  if attributes.has_key?(:'emailTabs')
    if (value = attributes[:'emailTabs']).is_a?(Array)
      self.email_tabs = value
    end
  end

  if attributes.has_key?(:'envelopeIdTabs')
    if (value = attributes[:'envelopeIdTabs']).is_a?(Array)
      self.envelope_id_tabs = value
    end
  end

  if attributes.has_key?(:'firstNameTabs')
    if (value = attributes[:'firstNameTabs']).is_a?(Array)
      self.first_name_tabs = value
    end
  end

  if attributes.has_key?(:'formulaTabs')
    if (value = attributes[:'formulaTabs']).is_a?(Array)
      self.formula_tabs = value
    end
  end

  if attributes.has_key?(:'fullNameTabs')
    if (value = attributes[:'fullNameTabs']).is_a?(Array)
      self.full_name_tabs = value
    end
  end

  if attributes.has_key?(:'initialHereTabs')
    if (value = attributes[:'initialHereTabs']).is_a?(Array)
      self.initial_here_tabs = value
    end
  end

  if attributes.has_key?(:'lastNameTabs')
    if (value = attributes[:'lastNameTabs']).is_a?(Array)
      self.last_name_tabs = value
    end
  end

  if attributes.has_key?(:'listTabs')
    if (value = attributes[:'listTabs']).is_a?(Array)
      self.list_tabs = value
    end
  end

  if attributes.has_key?(:'notarizeTabs')
    if (value = attributes[:'notarizeTabs']).is_a?(Array)
      self.notarize_tabs = value
    end
  end

  if attributes.has_key?(:'noteTabs')
    if (value = attributes[:'noteTabs']).is_a?(Array)
      self.note_tabs = value
    end
  end

  if attributes.has_key?(:'numberTabs')
    if (value = attributes[:'numberTabs']).is_a?(Array)
      self.number_tabs = value
    end
  end

  if attributes.has_key?(:'polyLineOverlayTabs')
    if (value = attributes[:'polyLineOverlayTabs']).is_a?(Array)
      self.poly_line_overlay_tabs = value
    end
  end

  if attributes.has_key?(:'radioGroupTabs')
    if (value = attributes[:'radioGroupTabs']).is_a?(Array)
      self.radio_group_tabs = value
    end
  end

  if attributes.has_key?(:'signerAttachmentTabs')
    if (value = attributes[:'signerAttachmentTabs']).is_a?(Array)
      self.signer_attachment_tabs = value
    end
  end

  if attributes.has_key?(:'signHereTabs')
    if (value = attributes[:'signHereTabs']).is_a?(Array)
      self.sign_here_tabs = value
    end
  end

  if attributes.has_key?(:'smartSectionTabs')
    if (value = attributes[:'smartSectionTabs']).is_a?(Array)
      self.smart_section_tabs = value
    end
  end

  if attributes.has_key?(:'ssnTabs')
    if (value = attributes[:'ssnTabs']).is_a?(Array)
      self.ssn_tabs = value
    end
  end

  if attributes.has_key?(:'tabGroups')
    if (value = attributes[:'tabGroups']).is_a?(Array)
      self.tab_groups = value
    end
  end

  if attributes.has_key?(:'textTabs')
    if (value = attributes[:'textTabs']).is_a?(Array)
      self.text_tabs = value
    end
  end

  if attributes.has_key?(:'titleTabs')
    if (value = attributes[:'titleTabs']).is_a?(Array)
      self.title_tabs = value
    end
  end

  if attributes.has_key?(:'viewTabs')
    if (value = attributes[:'viewTabs']).is_a?(Array)
      self.view_tabs = value
    end
  end

  if attributes.has_key?(:'zipTabs')
    if (value = attributes[:'zipTabs']).is_a?(Array)
      self.zip_tabs = value
    end
  end
end

Instance Attribute Details

#approve_tabsObject

Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history.


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

def approve_tabs
  @approve_tabs
end

#checkbox_tabsObject

Specifies a tag on the document in a location where the recipient can select an option.


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

def checkbox_tabs
  @checkbox_tabs
end

#comment_thread_tabsObject

Returns the value of attribute comment_thread_tabs


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

def comment_thread_tabs
  @comment_thread_tabs
end

#company_tabsObject

Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.


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

def company_tabs
  @company_tabs
end

#date_signed_tabsObject

Specifies a tab on the document where the date the document was signed will automatically appear.


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

def date_signed_tabs
  @date_signed_tabs
end

#date_tabsObject

Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.


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

def date_tabs
  @date_tabs
end

#decline_tabsObject

Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided.


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

def decline_tabs
  @decline_tabs
end

#draw_tabsObject

Returns the value of attribute draw_tabs


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

def draw_tabs
  @draw_tabs
end

#email_address_tabsObject

Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display.


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

def email_address_tabs
  @email_address_tabs
end

#email_tabsObject

Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. [email protected]) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.


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

def email_tabs
  @email_tabs
end

#envelope_id_tabsObject

Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only.


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

def envelope_id_tabs
  @envelope_id_tabs
end

#first_name_tabsObject

Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.


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

def first_name_tabs
  @first_name_tabs
end

#formula_tabsObject

Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the "formula" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas.


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

def formula_tabs
  @formula_tabs
end

#full_name_tabsObject

Specifies a tag on the document where you want the recipient's name to appear.


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

def full_name_tabs
  @full_name_tabs
end

#initial_here_tabsObject

Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional.


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

def initial_here_tabs
  @initial_here_tabs
end

#last_name_tabsObject

Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.


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

def last_name_tabs
  @last_name_tabs
end

#list_tabsObject

Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select.


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

def list_tabs
  @list_tabs
end

#notarize_tabsObject

Returns the value of attribute notarize_tabs


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

def notarize_tabs
  @notarize_tabs
end

#note_tabsObject

Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient.


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

def note_tabs
  @note_tabs
end

#number_tabsObject

Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.


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

def number_tabs
  @number_tabs
end

#poly_line_overlay_tabsObject

Returns the value of attribute poly_line_overlay_tabs


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

def poly_line_overlay_tabs
  @poly_line_overlay_tabs
end

#radio_group_tabsObject

Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.


81
82
83
# File 'lib/docusign_esign/models/tabs.rb', line 81

def radio_group_tabs
  @radio_group_tabs
end

#sign_here_tabsObject

A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The "optional" parameter sets if the signature is required or optional.


87
88
89
# File 'lib/docusign_esign/models/tabs.rb', line 87

def sign_here_tabs
  @sign_here_tabs
end

#signer_attachment_tabsObject

Specifies a tag on the document when you want the recipient to add supporting documents to an envelope.


84
85
86
# File 'lib/docusign_esign/models/tabs.rb', line 84

def signer_attachment_tabs
  @signer_attachment_tabs
end

#smart_section_tabsObject

Returns the value of attribute smart_section_tabs


90
91
92
# File 'lib/docusign_esign/models/tabs.rb', line 90

def smart_section_tabs
  @smart_section_tabs
end

#ssn_tabsObject

Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.


93
94
95
# File 'lib/docusign_esign/models/tabs.rb', line 93

def ssn_tabs
  @ssn_tabs
end

#tab_groupsObject

Returns the value of attribute tab_groups


96
97
98
# File 'lib/docusign_esign/models/tabs.rb', line 96

def tab_groups
  @tab_groups
end

#text_tabsObject

Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.


99
100
101
# File 'lib/docusign_esign/models/tabs.rb', line 99

def text_tabs
  @text_tabs
end

#title_tabsObject

Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.


102
103
104
# File 'lib/docusign_esign/models/tabs.rb', line 102

def title_tabs
  @title_tabs
end

#view_tabsObject

Returns the value of attribute view_tabs


105
106
107
# File 'lib/docusign_esign/models/tabs.rb', line 105

def view_tabs
  @view_tabs
end

#zip_tabsObject

Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.


108
109
110
# File 'lib/docusign_esign/models/tabs.rb', line 108

def zip_tabs
  @zip_tabs
end

Class Method Details

.attribute_mapObject

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


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/docusign_esign/models/tabs.rb', line 111

def self.attribute_map
  {
    :'approve_tabs' => :'approveTabs',
    :'checkbox_tabs' => :'checkboxTabs',
    :'comment_thread_tabs' => :'commentThreadTabs',
    :'company_tabs' => :'companyTabs',
    :'date_signed_tabs' => :'dateSignedTabs',
    :'date_tabs' => :'dateTabs',
    :'decline_tabs' => :'declineTabs',
    :'draw_tabs' => :'drawTabs',
    :'email_address_tabs' => :'emailAddressTabs',
    :'email_tabs' => :'emailTabs',
    :'envelope_id_tabs' => :'envelopeIdTabs',
    :'first_name_tabs' => :'firstNameTabs',
    :'formula_tabs' => :'formulaTabs',
    :'full_name_tabs' => :'fullNameTabs',
    :'initial_here_tabs' => :'initialHereTabs',
    :'last_name_tabs' => :'lastNameTabs',
    :'list_tabs' => :'listTabs',
    :'notarize_tabs' => :'notarizeTabs',
    :'note_tabs' => :'noteTabs',
    :'number_tabs' => :'numberTabs',
    :'poly_line_overlay_tabs' => :'polyLineOverlayTabs',
    :'radio_group_tabs' => :'radioGroupTabs',
    :'signer_attachment_tabs' => :'signerAttachmentTabs',
    :'sign_here_tabs' => :'signHereTabs',
    :'smart_section_tabs' => :'smartSectionTabs',
    :'ssn_tabs' => :'ssnTabs',
    :'tab_groups' => :'tabGroups',
    :'text_tabs' => :'textTabs',
    :'title_tabs' => :'titleTabs',
    :'view_tabs' => :'viewTabs',
    :'zip_tabs' => :'zipTabs'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'approve_tabs' => :'Array<Approve>',
    :'checkbox_tabs' => :'Array<Checkbox>',
    :'comment_thread_tabs' => :'Array<CommentThread>',
    :'company_tabs' => :'Array<Company>',
    :'date_signed_tabs' => :'Array<DateSigned>',
    :'date_tabs' => :'Array<DocuSign_eSign::Date>',
    :'decline_tabs' => :'Array<Decline>',
    :'draw_tabs' => :'Array<Draw>',
    :'email_address_tabs' => :'Array<EmailAddress>',
    :'email_tabs' => :'Array<Email>',
    :'envelope_id_tabs' => :'Array<EnvelopeId>',
    :'first_name_tabs' => :'Array<FirstName>',
    :'formula_tabs' => :'Array<FormulaTab>',
    :'full_name_tabs' => :'Array<FullName>',
    :'initial_here_tabs' => :'Array<InitialHere>',
    :'last_name_tabs' => :'Array<LastName>',
    :'list_tabs' => :'Array<Array>',
    :'notarize_tabs' => :'Array<Notarize>',
    :'note_tabs' => :'Array<Note>',
    :'number_tabs' => :'Array<Number>',
    :'poly_line_overlay_tabs' => :'Array<PolyLineOverlay>',
    :'radio_group_tabs' => :'Array<RadioGroup>',
    :'signer_attachment_tabs' => :'Array<SignerAttachment>',
    :'sign_here_tabs' => :'Array<SignHere>',
    :'smart_section_tabs' => :'Array<SmartSection>',
    :'ssn_tabs' => :'Array<Ssn>',
    :'tab_groups' => :'Array<TabGroup>',
    :'text_tabs' => :'Array<Text>',
    :'title_tabs' => :'Array<Title>',
    :'view_tabs' => :'Array<View>',
    :'zip_tabs' => :'Array<Zip>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/docusign_esign/models/tabs.rb', line 394

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      approve_tabs == o.approve_tabs &&
      checkbox_tabs == o.checkbox_tabs &&
      comment_thread_tabs == o.comment_thread_tabs &&
      company_tabs == o.company_tabs &&
      date_signed_tabs == o.date_signed_tabs &&
      date_tabs == o.date_tabs &&
      decline_tabs == o.decline_tabs &&
      draw_tabs == o.draw_tabs &&
      email_address_tabs == o.email_address_tabs &&
      email_tabs == o.email_tabs &&
      envelope_id_tabs == o.envelope_id_tabs &&
      first_name_tabs == o.first_name_tabs &&
      formula_tabs == o.formula_tabs &&
      full_name_tabs == o.full_name_tabs &&
      initial_here_tabs == o.initial_here_tabs &&
      last_name_tabs == o.last_name_tabs &&
      list_tabs == o.list_tabs &&
      notarize_tabs == o.notarize_tabs &&
      note_tabs == o.note_tabs &&
      number_tabs == o.number_tabs &&
      poly_line_overlay_tabs == o.poly_line_overlay_tabs &&
      radio_group_tabs == o.radio_group_tabs &&
      signer_attachment_tabs == o.signer_attachment_tabs &&
      sign_here_tabs == o.sign_here_tabs &&
      smart_section_tabs == o.smart_section_tabs &&
      ssn_tabs == o.ssn_tabs &&
      tab_groups == o.tab_groups &&
      text_tabs == o.text_tabs &&
      title_tabs == o.title_tabs &&
      view_tabs == o.view_tabs &&
      zip_tabs == o.zip_tabs
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


466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'lib/docusign_esign/models/tabs.rb', line 466

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


532
533
534
535
536
537
538
539
540
541
542
543
544
# File 'lib/docusign_esign/models/tabs.rb', line 532

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


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/docusign_esign/models/tabs.rb', line 445

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

432
433
434
# File 'lib/docusign_esign/models/tabs.rb', line 432

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


438
439
440
# File 'lib/docusign_esign/models/tabs.rb', line 438

def hash
  [approve_tabs, checkbox_tabs, comment_thread_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, note_tabs, number_tabs, poly_line_overlay_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, tab_groups, text_tabs, title_tabs, view_tabs, zip_tabs].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


381
382
383
384
# File 'lib/docusign_esign/models/tabs.rb', line 381

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


512
513
514
# File 'lib/docusign_esign/models/tabs.rb', line 512

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


518
519
520
521
522
523
524
525
526
# File 'lib/docusign_esign/models/tabs.rb', line 518

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


506
507
508
# File 'lib/docusign_esign/models/tabs.rb', line 506

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


388
389
390
# File 'lib/docusign_esign/models/tabs.rb', line 388

def valid?
  true
end