Class: DocuSign_eSign::FormulaTab

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormulaTab

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/formula_tab.rb', line 287

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

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

  if attributes.has_key?(:'conditionalParentValue')
    self.conditional_parent_value = attributes[:'conditionalParentValue']
  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?(:'documentId')
    self.document_id = attributes[:'documentId']
  end

  if attributes.has_key?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  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?(:'formula')
    self.formula = attributes[:'formula']
  end

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

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

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

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

  if attributes.has_key?(:'maxLength')
    self.max_length = attributes[:'maxLength']
  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?(:'originalValue')
    self.original_value = attributes[:'originalValue']
  end

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

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

  if attributes.has_key?(:'recipientId')
    self.recipient_id = attributes[:'recipientId']
  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?(:'roundDecimalPlaces')
    self.round_decimal_places = attributes[:'roundDecimalPlaces']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#anchor_case_sensitive ⇒ Object

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



17
18
19
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 17

def anchor_case_sensitive
  @anchor_case_sensitive
end

#anchor_horizontal_alignment ⇒ Object

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



20
21
22
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 20

def anchor_horizontal_alignment
  @anchor_horizontal_alignment
end

#anchor_ignore_if_not_present ⇒ Object

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



23
24
25
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 23

def anchor_ignore_if_not_present
  @anchor_ignore_if_not_present
end

#anchor_match_whole_word ⇒ Object

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.



26
27
28
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 26

def anchor_match_whole_word
  @anchor_match_whole_word
end

#anchor_string ⇒ Object

Anchor text information for a radio button.



29
30
31
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 29

def anchor_string
  @anchor_string
end

#anchor_units ⇒ Object

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



32
33
34
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 32

def anchor_units
  @anchor_units
end

#anchor_x_offset ⇒ Object

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



35
36
37
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 35

def anchor_x_offset
  @anchor_x_offset
end

#anchor_y_offset ⇒ Object

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



38
39
40
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 38

def anchor_y_offset
  @anchor_y_offset
end

#bold ⇒ Object

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



41
42
43
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 41

def bold
  @bold
end

#conceal_value_on_document ⇒ Object

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.



44
45
46
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 44

def conceal_value_on_document
  @conceal_value_on_document
end

#conditional_parent_label ⇒ Object

For conditional fields this is the TabLabel of the parent tab that controls this tab’s visibility.



47
48
49
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 47

def conditional_parent_label
  @conditional_parent_label
end

#conditional_parent_value ⇒ Object

For conditional fields, this is the value of the parent tab that controls the tab’s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.



50
51
52
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 50

def conditional_parent_value
  @conditional_parent_value
end

#custom_tab_id ⇒ Object

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.



53
54
55
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 53

def custom_tab_id
  @custom_tab_id
end

#disable_auto_size ⇒ Object

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.



56
57
58
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 56

def disable_auto_size
  @disable_auto_size
end

#document_id ⇒ Object

Specifies the document ID number that the tab is placed on. This must refer to an existing Document’s ID attribute.



59
60
61
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 59

def document_id
  @document_id
end

#error_details ⇒ Object

Returns the value of attribute error_details.



61
62
63
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 61

def error_details
  @error_details
end

#font ⇒ Object

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.



64
65
66
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 64

def font
  @font
end

#font_color ⇒ Object

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



67
68
69
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 67

def font_color
  @font_color
end

#font_size ⇒ Object

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.



70
71
72
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 70

def font_size
  @font_size
end

#formula ⇒ Object

The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. Example: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1][Line2][Tax]



73
74
75
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 73

def formula
  @formula
end

#hidden ⇒ Object

Returns the value of attribute hidden.



76
77
78
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 76

def hidden
  @hidden
end

#is_payment_amount ⇒ Object

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.



79
80
81
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 79

def is_payment_amount
  @is_payment_amount
end

#italic ⇒ Object

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



82
83
84
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 82

def italic
  @italic
end

#locked ⇒ Object

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



85
86
87
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 85

def locked
  @locked
end

#max_length ⇒ Object

An optional value that describes the maximum length of the property when the property is a string.



88
89
90
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 88

def max_length
  @max_length
end

#merge_field ⇒ Object

Returns the value of attribute merge_field.



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

def merge_field
  @merge_field
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#original_value ⇒ Object

The initial value of the tab when it was sent to the recipient.



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

def original_value
  @original_value
end

#page_number ⇒ Object

Specifies the page number on which the tab is located.



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

def page_number
  @page_number
end

#payment_details ⇒ Object

Returns the value of attribute payment_details.



101
102
103
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 101

def payment_details
  @payment_details
end

#recipient_id ⇒ Object

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



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

def recipient_id
  @recipient_id
end

#require_all ⇒ Object

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



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

def require_all
  @require_all
end

#require_initial_on_shared_change ⇒ Object

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



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

def require_initial_on_shared_change
  @require_initial_on_shared_change
end

#required ⇒ Object

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



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

def required
  @required
end

#round_decimal_places ⇒ Object

Returns the value of attribute round_decimal_places.



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

def round_decimal_places
  @round_decimal_places
end

#sender_required ⇒ Object

When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a ‘senderRequired` value of true cannot be deleted from an envelope.



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

def sender_required
  @sender_required
end

#shared ⇒ Object

When set to true, this custom tab is shared.



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

def shared
  @shared
end

#status ⇒ Object

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.



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

def status
  @status
end

#tab_group_labels ⇒ Object

Returns the value of attribute tab_group_labels.



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

def tab_group_labels
  @tab_group_labels
end

#tab_id ⇒ Object

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].



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

def tab_id
  @tab_id
end

#tab_label ⇒ Object

The label string associated with the tab.



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

def tab_label
  @tab_label
end

#tab_order ⇒ Object

Returns the value of attribute tab_order.



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

def tab_order
  @tab_order
end

#template_locked ⇒ Object

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.



140
141
142
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 140

def template_locked
  @template_locked
end

#template_required ⇒ Object

When set to true, the sender may not remove the recipient. Used only when working with template recipients.



143
144
145
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 143

def template_required
  @template_required
end

#tooltip ⇒ Object

Returns the value of attribute tooltip.



146
147
148
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 146

def tooltip
  @tooltip
end

#underline ⇒ Object

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



149
150
151
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 149

def underline
  @underline
end

#validation_message ⇒ Object

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



152
153
154
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 152

def validation_message
  @validation_message
end

#validation_pattern ⇒ Object

A regular expression used to validate input for the tab.



155
156
157
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 155

def validation_pattern
  @validation_pattern
end

#value ⇒ Object

Specifies the value of the tab.



158
159
160
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 158

def value
  @value
end

#width ⇒ Object

Width of the tab in pixels.



161
162
163
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 161

def width
  @width
end

#x_position ⇒ Object

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.



164
165
166
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 164

def x_position
  @x_position
end

#y_position ⇒ Object

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.



167
168
169
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 167

def y_position
  @y_position
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'anchor_case_sensitive' => :'anchorCaseSensitive',
    :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
    :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent',
    :'anchor_match_whole_word' => :'anchorMatchWholeWord',
    :'anchor_string' => :'anchorString',
    :'anchor_units' => :'anchorUnits',
    :'anchor_x_offset' => :'anchorXOffset',
    :'anchor_y_offset' => :'anchorYOffset',
    :'bold' => :'bold',
    :'conceal_value_on_document' => :'concealValueOnDocument',
    :'conditional_parent_label' => :'conditionalParentLabel',
    :'conditional_parent_value' => :'conditionalParentValue',
    :'custom_tab_id' => :'customTabId',
    :'disable_auto_size' => :'disableAutoSize',
    :'document_id' => :'documentId',
    :'error_details' => :'errorDetails',
    :'font' => :'font',
    :'font_color' => :'fontColor',
    :'font_size' => :'fontSize',
    :'formula' => :'formula',
    :'hidden' => :'hidden',
    :'is_payment_amount' => :'isPaymentAmount',
    :'italic' => :'italic',
    :'locked' => :'locked',
    :'max_length' => :'maxLength',
    :'merge_field' => :'mergeField',
    :'name' => :'name',
    :'original_value' => :'originalValue',
    :'page_number' => :'pageNumber',
    :'payment_details' => :'paymentDetails',
    :'recipient_id' => :'recipientId',
    :'require_all' => :'requireAll',
    :'required' => :'required',
    :'require_initial_on_shared_change' => :'requireInitialOnSharedChange',
    :'round_decimal_places' => :'roundDecimalPlaces',
    :'sender_required' => :'senderRequired',
    :'shared' => :'shared',
    :'status' => :'status',
    :'tab_group_labels' => :'tabGroupLabels',
    :'tab_id' => :'tabId',
    :'tab_label' => :'tabLabel',
    :'tab_order' => :'tabOrder',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'tooltip' => :'tooltip',
    :'underline' => :'underline',
    :'validation_message' => :'validationMessage',
    :'validation_pattern' => :'validationPattern',
    :'value' => :'value',
    :'width' => :'width',
    :'x_position' => :'xPosition',
    :'y_position' => :'yPosition'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'anchor_case_sensitive' => :'String',
    :'anchor_horizontal_alignment' => :'String',
    :'anchor_ignore_if_not_present' => :'String',
    :'anchor_match_whole_word' => :'String',
    :'anchor_string' => :'String',
    :'anchor_units' => :'String',
    :'anchor_x_offset' => :'String',
    :'anchor_y_offset' => :'String',
    :'bold' => :'String',
    :'conceal_value_on_document' => :'String',
    :'conditional_parent_label' => :'String',
    :'conditional_parent_value' => :'String',
    :'custom_tab_id' => :'String',
    :'disable_auto_size' => :'String',
    :'document_id' => :'String',
    :'error_details' => :'ErrorDetails',
    :'font' => :'String',
    :'font_color' => :'String',
    :'font_size' => :'String',
    :'formula' => :'String',
    :'hidden' => :'String',
    :'is_payment_amount' => :'String',
    :'italic' => :'String',
    :'locked' => :'String',
    :'max_length' => :'Integer',
    :'merge_field' => :'MergeField',
    :'name' => :'String',
    :'original_value' => :'String',
    :'page_number' => :'String',
    :'payment_details' => :'PaymentDetails',
    :'recipient_id' => :'String',
    :'require_all' => :'String',
    :'required' => :'String',
    :'require_initial_on_shared_change' => :'String',
    :'round_decimal_places' => :'String',
    :'sender_required' => :'String',
    :'shared' => :'String',
    :'status' => :'String',
    :'tab_group_labels' => :'Array<String>',
    :'tab_id' => :'String',
    :'tab_label' => :'String',
    :'tab_order' => :'String',
    :'template_locked' => :'String',
    :'template_required' => :'String',
    :'tooltip' => :'String',
    :'underline' => :'String',
    :'validation_message' => :'String',
    :'validation_pattern' => :'String',
    :'value' => :'String',
    :'width' => :'Integer',
    :'x_position' => :'String',
    :'y_position' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 519

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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_string == o.anchor_string &&
      anchor_units == o.anchor_units &&
      anchor_x_offset == o.anchor_x_offset &&
      anchor_y_offset == o.anchor_y_offset &&
      bold == o.bold &&
      conceal_value_on_document == o.conceal_value_on_document &&
      conditional_parent_label == o.conditional_parent_label &&
      conditional_parent_value == o.conditional_parent_value &&
      custom_tab_id == o.custom_tab_id &&
      disable_auto_size == o.disable_auto_size &&
      document_id == o.document_id &&
      error_details == o.error_details &&
      font == o.font &&
      font_color == o.font_color &&
      font_size == o.font_size &&
      formula == o.formula &&
      hidden == o.hidden &&
      is_payment_amount == o.is_payment_amount &&
      italic == o.italic &&
      locked == o.locked &&
      max_length == o.max_length &&
      merge_field == o.merge_field &&
      name == o.name &&
      original_value == o.original_value &&
      page_number == o.page_number &&
      payment_details == o.payment_details &&
      recipient_id == o.recipient_id &&
      require_all == o.require_all &&
      required == o.required &&
      require_initial_on_shared_change == o.require_initial_on_shared_change &&
      round_decimal_places == o.round_decimal_places &&
      sender_required == o.sender_required &&
      shared == o.shared &&
      status == o.status &&
      tab_group_labels == o.tab_group_labels &&
      tab_id == o.tab_id &&
      tab_label == o.tab_label &&
      tab_order == o.tab_order &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      tooltip == o.tooltip &&
      underline == o.underline &&
      validation_message == o.validation_message &&
      validation_pattern == o.validation_pattern &&
      value == o.value &&
      width == o.width &&
      x_position == o.x_position &&
      y_position == o.y_position
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



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 612

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



678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 678

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



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 591

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


578
579
580
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 578

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



584
585
586
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 584

def hash
  [anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_string, anchor_units, anchor_x_offset, anchor_y_offset, bold, conceal_value_on_document, conditional_parent_label, conditional_parent_value, custom_tab_id, disable_auto_size, document_id, error_details, font, font_color, font_size, formula, hidden, is_payment_amount, italic, locked, max_length, merge_field, name, original_value, page_number, payment_details, recipient_id, require_all, required, require_initial_on_shared_change, round_decimal_places, sender_required, shared, status, tab_group_labels, tab_id, tab_label, tab_order, template_locked, template_required, tooltip, underline, validation_message, validation_pattern, value, width, x_position, y_position].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



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

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



658
659
660
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 658

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



664
665
666
667
668
669
670
671
672
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 664

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



652
653
654
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 652

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



513
514
515
 
# File 'lib/docusign_esign/models/formula_tab.rb', line 513

def valid?
  true
end