Class: DocuSign_eSign::TabMetadata

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TabMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'lib/docusign_esign/models/tab_metadata.rb', line 269

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#anchorObject

An optional string that is used to auto-match tabs to strings located in the documents of an envelope.


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

def anchor
  @anchor
end

#anchor_case_sensitiveObject

When set to *true*, the anchor string does not consider case when matching strings in the document. The default value is *true*.


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

def anchor_case_sensitive
  @anchor_case_sensitive
end

#anchor_horizontal_alignmentObject

Specifies the alignment of anchor tabs with anchor strings. Possible values are *left* or *right*. The default value is *left*.


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

def anchor_horizontal_alignment
  @anchor_horizontal_alignment
end

#anchor_ignore_if_not_presentObject

When set to *true*, this tab is ignored if anchorString is not found in the document.


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

def anchor_ignore_if_not_present
  @anchor_ignore_if_not_present
end

#anchor_match_whole_wordObject

When set to *true*, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is *true*.


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

def anchor_match_whole_word
  @anchor_match_whole_word
end

#anchor_unitsObject

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.


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

def anchor_units
  @anchor_units
end

#anchor_x_offsetObject

Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.


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

def anchor_x_offset
  @anchor_x_offset
end

#anchor_y_offsetObject

Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.


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

def anchor_y_offset
  @anchor_y_offset
end

#boldObject

When set to *true*, the information in the tab is bold.


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

def bold
  @bold
end

#collaborativeObject

Returns the value of attribute collaborative


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

def collaborative
  @collaborative
end

#conceal_value_on_documentObject

When set to *true*, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.


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

def conceal_value_on_document
  @conceal_value_on_document
end

#created_by_display_nameObject

The user name of the DocuSign user who created this object.


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

def created_by_display_name
  @created_by_display_name
end

#created_by_user_idObject

The userId of the DocuSign user who created this object.


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

def created_by_user_id
  @created_by_user_id
end

#custom_tab_idObject

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.


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

def custom_tab_id
  @custom_tab_id
end

#disable_auto_sizeObject

When set to *true*, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.


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

def disable_auto_size
  @disable_auto_size
end

#editableObject

When set to *true*, the custom tab is editable. Otherwise the custom tab cannot be modified.


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

def editable
  @editable
end

#fontObject

The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.


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

def font
  @font
end

#font_colorObject

The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.


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

def font_color
  @font_color
end

#font_sizeObject

The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.


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

def font_size
  @font_size
end

#heightObject

Height of the tab in pixels.


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

def height
  @height
end

#included_in_emailObject

When set to *true*, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.


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

def included_in_email
  @included_in_email
end

#initial_valueObject

The original value of the tab.


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

def initial_value
  @initial_value
end

#italicObject

When set to *true*, the information in the tab is italic.


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

def italic
  @italic
end

#itemsObject

If the tab is a list, this represents the values that are possible for the tab.


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

def items
  @items
end

#last_modifiedObject

The UTC DateTime this object was last modified. This is in ISO8601 format.


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

def last_modified
  @last_modified
end

#last_modified_by_display_nameObject

The User Name of the DocuSign user who last modified this object.


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

def last_modified_by_display_name
  @last_modified_by_display_name
end

#last_modified_by_user_idObject

The userId of the DocuSign user who last modified this object.


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

def last_modified_by_user_id
  @last_modified_by_user_id
end

#lockedObject

When set to *true*, the signer cannot change the data of the custom tab.


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

def locked
  @locked
end

#maximum_lengthObject

The maximum number of entry characters supported by the custom tab.


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

def maximum_length
  @maximum_length
end

#merge_fieldObject

Returns the value of attribute merge_field


104
105
106
# File 'lib/docusign_esign/models/tab_metadata.rb', line 104

def merge_field
  @merge_field
end

#nameObject

Returns the value of attribute name


107
108
109
# File 'lib/docusign_esign/models/tab_metadata.rb', line 107

def name
  @name
end

#payment_item_codeObject

Returns the value of attribute payment_item_code


110
111
112
# File 'lib/docusign_esign/models/tab_metadata.rb', line 110

def payment_item_code
  @payment_item_code
end

#payment_item_descriptionObject

Returns the value of attribute payment_item_description


113
114
115
# File 'lib/docusign_esign/models/tab_metadata.rb', line 113

def payment_item_description
  @payment_item_description
end

#payment_item_nameObject

Returns the value of attribute payment_item_name


116
117
118
# File 'lib/docusign_esign/models/tab_metadata.rb', line 116

def payment_item_name
  @payment_item_name
end

#require_allObject

When set to *true* and shared is true, information must be entered in this field to complete the envelope.


119
120
121
# File 'lib/docusign_esign/models/tab_metadata.rb', line 119

def require_all
  @require_all
end

#require_initial_on_shared_changeObject

Optional element for field markup. When set to *true*, the signer is required to initial when they modify a shared field.


125
126
127
# File 'lib/docusign_esign/models/tab_metadata.rb', line 125

def require_initial_on_shared_change
  @require_initial_on_shared_change
end

#requiredObject

When set to *true*, the signer is required to fill out this tab


122
123
124
# File 'lib/docusign_esign/models/tab_metadata.rb', line 122

def required
  @required
end

#scale_valueObject

Returns the value of attribute scale_value


128
129
130
# File 'lib/docusign_esign/models/tab_metadata.rb', line 128

def scale_value
  @scale_value
end

#selectedObject

Returns the value of attribute selected


131
132
133
# File 'lib/docusign_esign/models/tab_metadata.rb', line 131

def selected
  @selected
end

#sharedObject

When set to *true*, this custom tab is shared.


134
135
136
# File 'lib/docusign_esign/models/tab_metadata.rb', line 134

def shared
  @shared
end

#stamp_typeObject

Returns the value of attribute stamp_type


137
138
139
# File 'lib/docusign_esign/models/tab_metadata.rb', line 137

def stamp_type
  @stamp_type
end

#stamp_type_metadataObject

Returns the value of attribute stamp_type_metadata


139
140
141
# File 'lib/docusign_esign/models/tab_metadata.rb', line 139

def 
  @stamp_type_metadata
end

#tab_labelObject

The label string associated with the tab.


142
143
144
# File 'lib/docusign_esign/models/tab_metadata.rb', line 142

def tab_label
  @tab_label
end

#typeObject

The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.


145
146
147
# File 'lib/docusign_esign/models/tab_metadata.rb', line 145

def type
  @type
end

#underlineObject

When set to *true*, the information in the tab is underlined.


148
149
150
# File 'lib/docusign_esign/models/tab_metadata.rb', line 148

def underline
  @underline
end

#validation_messageObject

The message displayed if the custom tab fails input validation (either custom of embedded).


151
152
153
# File 'lib/docusign_esign/models/tab_metadata.rb', line 151

def validation_message
  @validation_message
end

#validation_patternObject

A regular expression used to validate input for the tab.


154
155
156
# File 'lib/docusign_esign/models/tab_metadata.rb', line 154

def validation_pattern
  @validation_pattern
end

#widthObject

Width of the tab in pixels.


157
158
159
# File 'lib/docusign_esign/models/tab_metadata.rb', line 157

def width
  @width
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'anchor' => :'anchor',
    :'anchor_case_sensitive' => :'anchorCaseSensitive',
    :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
    :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent',
    :'anchor_match_whole_word' => :'anchorMatchWholeWord',
    :'anchor_units' => :'anchorUnits',
    :'anchor_x_offset' => :'anchorXOffset',
    :'anchor_y_offset' => :'anchorYOffset',
    :'bold' => :'bold',
    :'collaborative' => :'collaborative',
    :'conceal_value_on_document' => :'concealValueOnDocument',
    :'created_by_display_name' => :'createdByDisplayName',
    :'created_by_user_id' => :'createdByUserId',
    :'custom_tab_id' => :'customTabId',
    :'disable_auto_size' => :'disableAutoSize',
    :'editable' => :'editable',
    :'font' => :'font',
    :'font_color' => :'fontColor',
    :'font_size' => :'fontSize',
    :'height' => :'height',
    :'included_in_email' => :'includedInEmail',
    :'initial_value' => :'initialValue',
    :'italic' => :'italic',
    :'items' => :'items',
    :'last_modified' => :'lastModified',
    :'last_modified_by_display_name' => :'lastModifiedByDisplayName',
    :'last_modified_by_user_id' => :'lastModifiedByUserId',
    :'locked' => :'locked',
    :'maximum_length' => :'maximumLength',
    :'merge_field' => :'mergeField',
    :'name' => :'name',
    :'payment_item_code' => :'paymentItemCode',
    :'payment_item_description' => :'paymentItemDescription',
    :'payment_item_name' => :'paymentItemName',
    :'require_all' => :'requireAll',
    :'required' => :'required',
    :'require_initial_on_shared_change' => :'requireInitialOnSharedChange',
    :'scale_value' => :'scaleValue',
    :'selected' => :'selected',
    :'shared' => :'shared',
    :'stamp_type' => :'stampType',
    :'stamp_type_metadata' => :'stampTypeMetadata',
    :'tab_label' => :'tabLabel',
    :'type' => :'type',
    :'underline' => :'underline',
    :'validation_message' => :'validationMessage',
    :'validation_pattern' => :'validationPattern',
    :'width' => :'width'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'anchor' => :'String',
    :'anchor_case_sensitive' => :'String',
    :'anchor_horizontal_alignment' => :'String',
    :'anchor_ignore_if_not_present' => :'String',
    :'anchor_match_whole_word' => :'String',
    :'anchor_units' => :'String',
    :'anchor_x_offset' => :'String',
    :'anchor_y_offset' => :'String',
    :'bold' => :'String',
    :'collaborative' => :'String',
    :'conceal_value_on_document' => :'String',
    :'created_by_display_name' => :'String',
    :'created_by_user_id' => :'String',
    :'custom_tab_id' => :'String',
    :'disable_auto_size' => :'String',
    :'editable' => :'String',
    :'font' => :'String',
    :'font_color' => :'String',
    :'font_size' => :'String',
    :'height' => :'String',
    :'included_in_email' => :'String',
    :'initial_value' => :'String',
    :'italic' => :'String',
    :'items' => :'Array<String>',
    :'last_modified' => :'String',
    :'last_modified_by_display_name' => :'String',
    :'last_modified_by_user_id' => :'String',
    :'locked' => :'String',
    :'maximum_length' => :'String',
    :'merge_field' => :'MergeField',
    :'name' => :'String',
    :'payment_item_code' => :'String',
    :'payment_item_description' => :'String',
    :'payment_item_name' => :'String',
    :'require_all' => :'String',
    :'required' => :'String',
    :'require_initial_on_shared_change' => :'String',
    :'scale_value' => :'String',
    :'selected' => :'String',
    :'shared' => :'String',
    :'stamp_type' => :'String',
    :'stamp_type_metadata' => :'PropertyMetadata',
    :'tab_label' => :'String',
    :'type' => :'String',
    :'underline' => :'String',
    :'validation_message' => :'String',
    :'validation_pattern' => :'String',
    :'width' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
# File 'lib/docusign_esign/models/tab_metadata.rb', line 485

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      anchor == o.anchor &&
      anchor_case_sensitive == o.anchor_case_sensitive &&
      anchor_horizontal_alignment == o.anchor_horizontal_alignment &&
      anchor_ignore_if_not_present == o.anchor_ignore_if_not_present &&
      anchor_match_whole_word == o.anchor_match_whole_word &&
      anchor_units == o.anchor_units &&
      anchor_x_offset == o.anchor_x_offset &&
      anchor_y_offset == o.anchor_y_offset &&
      bold == o.bold &&
      collaborative == o.collaborative &&
      conceal_value_on_document == o.conceal_value_on_document &&
      created_by_display_name == o.created_by_display_name &&
      created_by_user_id == o.created_by_user_id &&
      custom_tab_id == o.custom_tab_id &&
      disable_auto_size == o.disable_auto_size &&
      editable == o.editable &&
      font == o.font &&
      font_color == o.font_color &&
      font_size == o.font_size &&
      height == o.height &&
      included_in_email == o.included_in_email &&
      initial_value == o.initial_value &&
      italic == o.italic &&
      items == o.items &&
      last_modified == o.last_modified &&
      last_modified_by_display_name == o.last_modified_by_display_name &&
      last_modified_by_user_id == o.last_modified_by_user_id &&
      locked == o.locked &&
      maximum_length == o.maximum_length &&
      merge_field == o.merge_field &&
      name == o.name &&
      payment_item_code == o.payment_item_code &&
      payment_item_description == o.payment_item_description &&
      payment_item_name == o.payment_item_name &&
      require_all == o.require_all &&
      required == o.required &&
      require_initial_on_shared_change == o.require_initial_on_shared_change &&
      scale_value == o.scale_value &&
      selected == o.selected &&
      shared == o.shared &&
      stamp_type == o.stamp_type &&
       == o. &&
      tab_label == o.tab_label &&
      type == o.type &&
      underline == o.underline &&
      validation_message == o.validation_message &&
      validation_pattern == o.validation_pattern &&
      width == o.width
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


574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
# File 'lib/docusign_esign/models/tab_metadata.rb', line 574

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


640
641
642
643
644
645
646
647
648
649
650
651
652
# File 'lib/docusign_esign/models/tab_metadata.rb', line 640

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


553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
# File 'lib/docusign_esign/models/tab_metadata.rb', line 553

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

540
541
542
# File 'lib/docusign_esign/models/tab_metadata.rb', line 540

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


546
547
548
# File 'lib/docusign_esign/models/tab_metadata.rb', line 546

def hash
  [anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locked, maximum_length, merge_field, name, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, stamp_type, , tab_label, type, underline, validation_message, validation_pattern, width].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


472
473
474
475
# File 'lib/docusign_esign/models/tab_metadata.rb', line 472

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


620
621
622
# File 'lib/docusign_esign/models/tab_metadata.rb', line 620

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


626
627
628
629
630
631
632
633
634
# File 'lib/docusign_esign/models/tab_metadata.rb', line 626

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


614
615
616
# File 'lib/docusign_esign/models/tab_metadata.rb', line 614

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


479
480
481
# File 'lib/docusign_esign/models/tab_metadata.rb', line 479

def valid?
  true
end