Class: DocuSign_eSign::Radio

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

Overview

One of the selectable radio buttons in the ‘radios` property of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Radio

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
537
538
539
540
 
# File 'lib/docusign_esign/models/radio.rb', line 311

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'captionMetadata')
    self.caption_metadata = attributes[:'captionMetadata']
  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?(:'fontColorMetadata')
    self.font_color_metadata = attributes[:'fontColorMetadata']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#anchor_allow_white_space_in_characters ⇒ Object

Returns the value of attribute anchor_allow_white_space_in_characters.



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

def anchor_allow_white_space_in_characters
  @anchor_allow_white_space_in_characters
end

#anchor_allow_white_space_in_characters_metadata ⇒ Object

Metadata that indicates whether the ‘anchorAllowWhiteSpaceInCharacters` property is editable.



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

def anchor_allow_white_space_in_characters_metadata
  @anchor_allow_white_space_in_characters_metadata
end

#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.



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

def anchor_case_sensitive
  @anchor_case_sensitive
end

#anchor_case_sensitive_metadata ⇒ Object

Metadata that indicates whether the ‘anchorCaseSensitive` property is editable.



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

def anchor_case_sensitive_metadata
  @anchor_case_sensitive_metadata
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.



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

def anchor_horizontal_alignment
  @anchor_horizontal_alignment
end

#anchor_horizontal_alignment_metadata ⇒ Object

Metadata that indicates whether the ‘anchorHorizontalAlignment` property is editable.



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

def anchor_horizontal_alignment_metadata
  @anchor_horizontal_alignment_metadata
end

#anchor_ignore_if_not_present ⇒ Object

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



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

def anchor_ignore_if_not_present
  @anchor_ignore_if_not_present
end

#anchor_ignore_if_not_present_metadata ⇒ Object

Metadata that indicates whether the ‘anchorIgnoreIfNotPresent` property is editable.



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

def anchor_ignore_if_not_present_metadata
  @anchor_ignore_if_not_present_metadata
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.



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

def anchor_match_whole_word
  @anchor_match_whole_word
end

#anchor_match_whole_word_metadata ⇒ Object

Metadata that indicates whether the ‘anchorMatchWholeWord` property is editable.



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

def anchor_match_whole_word_metadata
  @anchor_match_whole_word_metadata
end

#anchor_string ⇒ Object

Anchor text information for a radio button.



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

def anchor_string
  @anchor_string
end

#anchor_string_metadata ⇒ Object

Metadata that indicates whether the ‘anchorString` property is editable.



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

def anchor_string_metadata
  @anchor_string_metadata
end

#anchor_tab_processor_version ⇒ Object

Returns the value of attribute anchor_tab_processor_version.



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

def anchor_tab_processor_version
  @anchor_tab_processor_version
end

#anchor_tab_processor_version_metadata ⇒ Object

Reserved for DocuSign.



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

def anchor_tab_processor_version_metadata
  @anchor_tab_processor_version_metadata
end

#anchor_units ⇒ Object

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



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

def anchor_units
  @anchor_units
end

#anchor_units_metadata ⇒ Object

Metadata that indicates whether the ‘anchorUnits` property is editable.



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

def anchor_units_metadata
  @anchor_units_metadata
end

#anchor_x_offset ⇒ Object

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



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

def anchor_x_offset
  @anchor_x_offset
end

#anchor_x_offset_metadata ⇒ Object

Metadata that indicates whether the ‘anchorXOffset` property is editable.



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

def anchor_x_offset_metadata
  @anchor_x_offset_metadata
end

#anchor_y_offset ⇒ Object

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



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

def anchor_y_offset
  @anchor_y_offset
end

#anchor_y_offset_metadata ⇒ Object

Metadata that indicates whether the ‘anchorYOffset` property is editable.



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

def anchor_y_offset_metadata
  @anchor_y_offset_metadata
end

#bold ⇒ Object

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



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

def bold
  @bold
end

#bold_metadata ⇒ Object

Metadata that indicates whether the ‘bold` property is editable.



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

def bold_metadata
  @bold_metadata
end

#caption ⇒ Object

Returns the value of attribute caption.



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

def caption
  @caption
end

#caption_metadata ⇒ Object

Returns the value of attribute caption_metadata.



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

def caption_metadata
  @caption_metadata
end

#error_details ⇒ Object

Array or errors.



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

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.



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

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.



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

def font_color
  @font_color
end

#font_color_metadata ⇒ Object

Metadata that indicates whether the ‘fontColor` property is editable.



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

def font_color_metadata
  @font_color_metadata
end

#font_metadata ⇒ Object

Metadata that indicates whether the ‘font` property is editable.



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

def font_metadata
  @font_metadata
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.



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

def font_size
  @font_size
end

#font_size_metadata ⇒ Object

Metadata that indicates whether the ‘fontSize` property is editable.



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

def font_size_metadata
  @font_size_metadata
end

#italic ⇒ Object

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



111
112
113
 
# File 'lib/docusign_esign/models/radio.rb', line 111

def italic
  @italic
end

#italic_metadata ⇒ Object

Metadata that indicates whether the ‘italic` property is editable.



114
115
116
 
# File 'lib/docusign_esign/models/radio.rb', line 114

def italic_metadata
  @italic_metadata
end

#locked ⇒ Object

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



117
118
119
 
# File 'lib/docusign_esign/models/radio.rb', line 117

def locked
  @locked
end

#locked_metadata ⇒ Object

Metadata that indicates whether the ‘locked` property is editable.



120
121
122
 
# File 'lib/docusign_esign/models/radio.rb', line 120

def locked_metadata
  @locked_metadata
end

#merge_field_xml ⇒ Object

Returns the value of attribute merge_field_xml.



123
124
125
 
# File 'lib/docusign_esign/models/radio.rb', line 123

def merge_field_xml
  @merge_field_xml
end

#page_number ⇒ Object

Specifies the page number on which the tab is located.



126
127
128
 
# File 'lib/docusign_esign/models/radio.rb', line 126

def page_number
  @page_number
end

#page_number_metadata ⇒ Object

Metadata that indicates whether the ‘pageNumber` property is editable.



129
130
131
 
# File 'lib/docusign_esign/models/radio.rb', line 129

def page_number_metadata
  @page_number_metadata
end

#required ⇒ Object

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



132
133
134
 
# File 'lib/docusign_esign/models/radio.rb', line 132

def required
  @required
end

#required_metadata ⇒ Object

Metadata that indicates whether the ‘required` property is editable.



135
136
137
 
# File 'lib/docusign_esign/models/radio.rb', line 135

def required_metadata
  @required_metadata
end

#selected ⇒ Object

When set to true, the radio button is selected.



138
139
140
 
# File 'lib/docusign_esign/models/radio.rb', line 138

def selected
  @selected
end

#selected_metadata ⇒ Object

Metadata that indicates whether the ‘selected` property is editable.



141
142
143
 
# File 'lib/docusign_esign/models/radio.rb', line 141

def selected_metadata
  @selected_metadata
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.



144
145
146
 
# File 'lib/docusign_esign/models/radio.rb', line 144

def status
  @status
end

#status_metadata ⇒ Object

Metadata that indicates whether the ‘status` property is editable.



147
148
149
 
# File 'lib/docusign_esign/models/radio.rb', line 147

def status_metadata
  @status_metadata
end

#tab_id ⇒ Object

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



150
151
152
 
# File 'lib/docusign_esign/models/radio.rb', line 150

def tab_id
  @tab_id
end

#tab_id_metadata ⇒ Object

Metadata that indicates whether the ‘tabId` property is editable.



153
154
155
 
# File 'lib/docusign_esign/models/radio.rb', line 153

def tab_id_metadata
  @tab_id_metadata
end

#tab_order ⇒ Object

Returns the value of attribute tab_order.



156
157
158
 
# File 'lib/docusign_esign/models/radio.rb', line 156

def tab_order
  @tab_order
end

#tab_order_metadata ⇒ Object

Metadata that indicates whether the ‘tabOrder` property is editable.



159
160
161
 
# File 'lib/docusign_esign/models/radio.rb', line 159

def tab_order_metadata
  @tab_order_metadata
end

#underline ⇒ Object

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



162
163
164
 
# File 'lib/docusign_esign/models/radio.rb', line 162

def underline
  @underline
end

#underline_metadata ⇒ Object

Metadata that indicates whether the ‘underline` property is editable.



165
166
167
 
# File 'lib/docusign_esign/models/radio.rb', line 165

def underline_metadata
  @underline_metadata
end

#value ⇒ Object

Specifies the value of the tab.



168
169
170
 
# File 'lib/docusign_esign/models/radio.rb', line 168

def value
  @value
end

#value_metadata ⇒ Object

Metadata that indicates whether the ‘value` property is editable.



171
172
173
 
# File 'lib/docusign_esign/models/radio.rb', line 171

def value_metadata
  @value_metadata
end

#x_position ⇒ Object

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



174
175
176
 
# File 'lib/docusign_esign/models/radio.rb', line 174

def x_position
  @x_position
end

#x_position_metadata ⇒ Object

Metadata that indicates whether the ‘xPosition` property is editable.



177
178
179
 
# File 'lib/docusign_esign/models/radio.rb', line 177

def x_position_metadata
  @x_position_metadata
end

#y_position ⇒ Object

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



180
181
182
 
# File 'lib/docusign_esign/models/radio.rb', line 180

def y_position
  @y_position
end

#y_position_metadata ⇒ Object

Metadata that indicates whether the ‘yPosition` property is editable.



183
184
185
 
# File 'lib/docusign_esign/models/radio.rb', line 183

def y_position_metadata
  @y_position_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'anchor_allow_white_space_in_characters' => :'anchorAllowWhiteSpaceInCharacters',
    :'anchor_allow_white_space_in_characters_metadata' => :'anchorAllowWhiteSpaceInCharactersMetadata',
    :'anchor_case_sensitive' => :'anchorCaseSensitive',
    :'anchor_case_sensitive_metadata' => :'anchorCaseSensitiveMetadata',
    :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
    :'anchor_horizontal_alignment_metadata' => :'anchorHorizontalAlignmentMetadata',
    :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent',
    :'anchor_ignore_if_not_present_metadata' => :'anchorIgnoreIfNotPresentMetadata',
    :'anchor_match_whole_word' => :'anchorMatchWholeWord',
    :'anchor_match_whole_word_metadata' => :'anchorMatchWholeWordMetadata',
    :'anchor_string' => :'anchorString',
    :'anchor_string_metadata' => :'anchorStringMetadata',
    :'anchor_tab_processor_version' => :'anchorTabProcessorVersion',
    :'anchor_tab_processor_version_metadata' => :'anchorTabProcessorVersionMetadata',
    :'anchor_units' => :'anchorUnits',
    :'anchor_units_metadata' => :'anchorUnitsMetadata',
    :'anchor_x_offset' => :'anchorXOffset',
    :'anchor_x_offset_metadata' => :'anchorXOffsetMetadata',
    :'anchor_y_offset' => :'anchorYOffset',
    :'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
    :'bold' => :'bold',
    :'bold_metadata' => :'boldMetadata',
    :'caption' => :'caption',
    :'caption_metadata' => :'captionMetadata',
    :'error_details' => :'errorDetails',
    :'font' => :'font',
    :'font_color' => :'fontColor',
    :'font_color_metadata' => :'fontColorMetadata',
    :'font_metadata' => :'fontMetadata',
    :'font_size' => :'fontSize',
    :'font_size_metadata' => :'fontSizeMetadata',
    :'italic' => :'italic',
    :'italic_metadata' => :'italicMetadata',
    :'locked' => :'locked',
    :'locked_metadata' => :'lockedMetadata',
    :'merge_field_xml' => :'mergeFieldXml',
    :'page_number' => :'pageNumber',
    :'page_number_metadata' => :'pageNumberMetadata',
    :'required' => :'required',
    :'required_metadata' => :'requiredMetadata',
    :'selected' => :'selected',
    :'selected_metadata' => :'selectedMetadata',
    :'status' => :'status',
    :'status_metadata' => :'statusMetadata',
    :'tab_id' => :'tabId',
    :'tab_id_metadata' => :'tabIdMetadata',
    :'tab_order' => :'tabOrder',
    :'tab_order_metadata' => :'tabOrderMetadata',
    :'underline' => :'underline',
    :'underline_metadata' => :'underlineMetadata',
    :'value' => :'value',
    :'value_metadata' => :'valueMetadata',
    :'x_position' => :'xPosition',
    :'x_position_metadata' => :'xPositionMetadata',
    :'y_position' => :'yPosition',
    :'y_position_metadata' => :'yPositionMetadata'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'anchor_allow_white_space_in_characters' => :'String',
    :'anchor_allow_white_space_in_characters_metadata' => :'PropertyMetadata',
    :'anchor_case_sensitive' => :'String',
    :'anchor_case_sensitive_metadata' => :'PropertyMetadata',
    :'anchor_horizontal_alignment' => :'String',
    :'anchor_horizontal_alignment_metadata' => :'PropertyMetadata',
    :'anchor_ignore_if_not_present' => :'String',
    :'anchor_ignore_if_not_present_metadata' => :'PropertyMetadata',
    :'anchor_match_whole_word' => :'String',
    :'anchor_match_whole_word_metadata' => :'PropertyMetadata',
    :'anchor_string' => :'String',
    :'anchor_string_metadata' => :'PropertyMetadata',
    :'anchor_tab_processor_version' => :'String',
    :'anchor_tab_processor_version_metadata' => :'PropertyMetadata',
    :'anchor_units' => :'String',
    :'anchor_units_metadata' => :'PropertyMetadata',
    :'anchor_x_offset' => :'String',
    :'anchor_x_offset_metadata' => :'PropertyMetadata',
    :'anchor_y_offset' => :'String',
    :'anchor_y_offset_metadata' => :'PropertyMetadata',
    :'bold' => :'String',
    :'bold_metadata' => :'PropertyMetadata',
    :'caption' => :'String',
    :'caption_metadata' => :'PropertyMetadata',
    :'error_details' => :'ErrorDetails',
    :'font' => :'String',
    :'font_color' => :'String',
    :'font_color_metadata' => :'PropertyMetadata',
    :'font_metadata' => :'PropertyMetadata',
    :'font_size' => :'String',
    :'font_size_metadata' => :'PropertyMetadata',
    :'italic' => :'String',
    :'italic_metadata' => :'PropertyMetadata',
    :'locked' => :'String',
    :'locked_metadata' => :'PropertyMetadata',
    :'merge_field_xml' => :'String',
    :'page_number' => :'String',
    :'page_number_metadata' => :'PropertyMetadata',
    :'required' => :'String',
    :'required_metadata' => :'PropertyMetadata',
    :'selected' => :'String',
    :'selected_metadata' => :'PropertyMetadata',
    :'status' => :'String',
    :'status_metadata' => :'PropertyMetadata',
    :'tab_id' => :'String',
    :'tab_id_metadata' => :'PropertyMetadata',
    :'tab_order' => :'String',
    :'tab_order_metadata' => :'PropertyMetadata',
    :'underline' => :'String',
    :'underline_metadata' => :'PropertyMetadata',
    :'value' => :'String',
    :'value_metadata' => :'PropertyMetadata',
    :'x_position' => :'String',
    :'x_position_metadata' => :'PropertyMetadata',
    :'y_position' => :'String',
    :'y_position_metadata' => :'PropertyMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
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
611
612
613
614
615
616
 
# File 'lib/docusign_esign/models/radio.rb', line 557

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      anchor_allow_white_space_in_characters == o.anchor_allow_white_space_in_characters &&
      anchor_allow_white_space_in_characters_metadata == o.anchor_allow_white_space_in_characters_metadata &&
      anchor_case_sensitive == o.anchor_case_sensitive &&
      anchor_case_sensitive_metadata == o.anchor_case_sensitive_metadata &&
      anchor_horizontal_alignment == o.anchor_horizontal_alignment &&
      anchor_horizontal_alignment_metadata == o.anchor_horizontal_alignment_metadata &&
      anchor_ignore_if_not_present == o.anchor_ignore_if_not_present &&
      anchor_ignore_if_not_present_metadata == o.anchor_ignore_if_not_present_metadata &&
      anchor_match_whole_word == o.anchor_match_whole_word &&
      anchor_match_whole_word_metadata == o.anchor_match_whole_word_metadata &&
      anchor_string == o.anchor_string &&
      anchor_string_metadata == o.anchor_string_metadata &&
      anchor_tab_processor_version == o.anchor_tab_processor_version &&
      anchor_tab_processor_version_metadata == o.anchor_tab_processor_version_metadata &&
      anchor_units == o.anchor_units &&
      anchor_units_metadata == o.anchor_units_metadata &&
      anchor_x_offset == o.anchor_x_offset &&
      anchor_x_offset_metadata == o.anchor_x_offset_metadata &&
      anchor_y_offset == o.anchor_y_offset &&
      anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
      bold == o.bold &&
      bold_metadata == o.bold_metadata &&
      caption == o.caption &&
      caption_metadata == o.caption_metadata &&
      error_details == o.error_details &&
      font == o.font &&
      font_color == o.font_color &&
      font_color_metadata == o.font_color_metadata &&
      font_metadata == o.font_metadata &&
      font_size == o.font_size &&
      font_size_metadata == o.font_size_metadata &&
      italic == o.italic &&
      italic_metadata == o.italic_metadata &&
      locked == o.locked &&
      locked_metadata == o.locked_metadata &&
      merge_field_xml == o.merge_field_xml &&
      page_number == o.page_number &&
      page_number_metadata == o.page_number_metadata &&
      required == o.required &&
      required_metadata == o.required_metadata &&
      selected == o.selected &&
      selected_metadata == o.selected_metadata &&
      status == o.status &&
      status_metadata == o.status_metadata &&
      tab_id == o.tab_id &&
      tab_id_metadata == o.tab_id_metadata &&
      tab_order == o.tab_order &&
      tab_order_metadata == o.tab_order_metadata &&
      underline == o.underline &&
      underline_metadata == o.underline_metadata &&
      value == o.value &&
      value_metadata == o.value_metadata &&
      x_position == o.x_position &&
      x_position_metadata == o.x_position_metadata &&
      y_position == o.y_position &&
      y_position_metadata == o.y_position_metadata
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



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/docusign_esign/models/radio.rb', line 654

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



720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/docusign_esign/models/radio.rb', line 720

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



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/docusign_esign/models/radio.rb', line 633

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



626
627
628
 
# File 'lib/docusign_esign/models/radio.rb', line 626

def hash
  [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, italic, italic_metadata, locked, locked_metadata, merge_field_xml, page_number, page_number_metadata, required, required_metadata, selected, selected_metadata, status, status_metadata, tab_id, tab_id_metadata, tab_order, tab_order_metadata, underline, underline_metadata, value, value_metadata, x_position, x_position_metadata, y_position, y_position_metadata].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



544
545
546
547
 
# File 'lib/docusign_esign/models/radio.rb', line 544

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



700
701
702
 
# File 'lib/docusign_esign/models/radio.rb', line 700

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



706
707
708
709
710
711
712
713
714
 
# File 'lib/docusign_esign/models/radio.rb', line 706

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



694
695
696
 
# File 'lib/docusign_esign/models/radio.rb', line 694

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



551
552
553
 
# File 'lib/docusign_esign/models/radio.rb', line 551

def valid?
  true
end