Class: DocuSign_eSign::Radio

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

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



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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/docusign_esign/models/radio.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?(:'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?(:'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?(:'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

Returns the value of attribute anchor_allow_white_space_in_characters_metadata.



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

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.



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

def anchor_case_sensitive
  @anchor_case_sensitive
end

#anchor_case_sensitive_metadata ⇒ Object

Returns the value of attribute anchor_case_sensitive_metadata.



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

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.



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

def anchor_horizontal_alignment
  @anchor_horizontal_alignment
end

#anchor_horizontal_alignment_metadata ⇒ Object

Returns the value of attribute anchor_horizontal_alignment_metadata.



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

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.



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

def anchor_ignore_if_not_present
  @anchor_ignore_if_not_present
end

#anchor_ignore_if_not_present_metadata ⇒ Object

Returns the value of attribute anchor_ignore_if_not_present_metadata.



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

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.



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

def anchor_match_whole_word
  @anchor_match_whole_word
end

#anchor_match_whole_word_metadata ⇒ Object

Returns the value of attribute anchor_match_whole_word_metadata.



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

def anchor_match_whole_word_metadata
  @anchor_match_whole_word_metadata
end

#anchor_string ⇒ Object

Anchor text information for a radio button.



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

def anchor_string
  @anchor_string
end

#anchor_string_metadata ⇒ Object

Returns the value of attribute anchor_string_metadata.



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

def anchor_string_metadata
  @anchor_string_metadata
end

#anchor_tab_processor_version ⇒ Object

Returns the value of attribute anchor_tab_processor_version.



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

def anchor_tab_processor_version
  @anchor_tab_processor_version
end

#anchor_tab_processor_version_metadata ⇒ Object

Returns the value of attribute anchor_tab_processor_version_metadata.



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

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.



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

def anchor_units
  @anchor_units
end

#anchor_units_metadata ⇒ Object

Returns the value of attribute anchor_units_metadata.



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

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.



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

def anchor_x_offset
  @anchor_x_offset
end

#anchor_x_offset_metadata ⇒ Object

Returns the value of attribute anchor_x_offset_metadata.



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

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.



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

def anchor_y_offset
  @anchor_y_offset
end

#anchor_y_offset_metadata ⇒ Object

Returns the value of attribute anchor_y_offset_metadata.



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

def anchor_y_offset_metadata
  @anchor_y_offset_metadata
end

#bold ⇒ Object

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



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

def bold
  @bold
end

#bold_metadata ⇒ Object

Returns the value of attribute bold_metadata.



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

def bold_metadata
  @bold_metadata
end

#error_details ⇒ Object

Returns the value of attribute error_details.



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

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.



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

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.



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

def font_color
  @font_color
end

#font_color_metadata ⇒ Object

Returns the value of attribute font_color_metadata.



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

def font_color_metadata
  @font_color_metadata
end

#font_metadata ⇒ Object

Returns the value of attribute font_metadata.



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

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.



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

def font_size
  @font_size
end

#font_size_metadata ⇒ Object

Returns the value of attribute font_size_metadata.



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

def font_size_metadata
  @font_size_metadata
end

#italic ⇒ Object

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



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

def italic
  @italic
end

#italic_metadata ⇒ Object

Returns the value of attribute italic_metadata.



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

def italic_metadata
  @italic_metadata
end

#locked ⇒ Object

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



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

def locked
  @locked
end

#locked_metadata ⇒ Object

Returns the value of attribute locked_metadata.



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

def locked_metadata
  @locked_metadata
end

#page_number ⇒ Object

Specifies the page number on which the tab is located.



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

def page_number
  @page_number
end

#page_number_metadata ⇒ Object

Returns the value of attribute page_number_metadata.



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

def page_number_metadata
  @page_number_metadata
end

#required ⇒ Object

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



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

def required
  @required
end

#required_metadata ⇒ Object

Returns the value of attribute required_metadata.



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

def required_metadata
  @required_metadata
end

#selected ⇒ Object

When set to true, the radio button is selected.



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

def selected
  @selected
end

#selected_metadata ⇒ Object

Returns the value of attribute selected_metadata.



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

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.



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

def status
  @status
end

#status_metadata ⇒ Object

Returns the value of attribute status_metadata.



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

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



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

def tab_id
  @tab_id
end

#tab_id_metadata ⇒ Object

Returns the value of attribute tab_id_metadata.



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

def tab_id_metadata
  @tab_id_metadata
end

#tab_order ⇒ Object

Returns the value of attribute tab_order.



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

def tab_order
  @tab_order
end

#tab_order_metadata ⇒ Object

Returns the value of attribute tab_order_metadata.



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

def tab_order_metadata
  @tab_order_metadata
end

#underline ⇒ Object

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



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

def underline
  @underline
end

#underline_metadata ⇒ Object

Returns the value of attribute underline_metadata.



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

def underline_metadata
  @underline_metadata
end

#value ⇒ Object

Specifies the value of the tab.



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

def value
  @value
end

#value_metadata ⇒ Object

Returns the value of attribute value_metadata.



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

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.



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

def x_position
  @x_position
end

#x_position_metadata ⇒ Object

Returns the value of attribute x_position_metadata.



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

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.



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

def y_position
  @y_position
end

#y_position_metadata ⇒ Object

Returns the value of attribute y_position_metadata.



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

def y_position_metadata
  @y_position_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/docusign_esign/models/radio.rb', line 150

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',
    :'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',
    :'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.



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/docusign_esign/models/radio.rb', line 209

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',
    :'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',
    :'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



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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/docusign_esign/models/radio.rb', line 503

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 &&
      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 &&
      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



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/docusign_esign/models/radio.rb', line 597

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



663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/docusign_esign/models/radio.rb', line 663

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



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/docusign_esign/models/radio.rb', line 576

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


563
564
565
 
# File 'lib/docusign_esign/models/radio.rb', line 563

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



569
570
571
 
# File 'lib/docusign_esign/models/radio.rb', line 569

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, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, italic, italic_metadata, locked, locked_metadata, 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



490
491
492
493
 
# File 'lib/docusign_esign/models/radio.rb', line 490

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



643
644
645
 
# File 'lib/docusign_esign/models/radio.rb', line 643

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



649
650
651
652
653
654
655
656
657
 
# File 'lib/docusign_esign/models/radio.rb', line 649

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



637
638
639
 
# File 'lib/docusign_esign/models/radio.rb', line 637

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



497
498
499
 
# File 'lib/docusign_esign/models/radio.rb', line 497

def valid?
  true
end