Class: DocuSign_eSign::RadioGroup

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

Overview

This group tab is used to place radio buttons on a document. The ‘radios` property contains a list of [`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) objects associated with the group. Only one radio button can be selected in a group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RadioGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/docusign_esign/models/radio_group.rb', line 196

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#conditional_parent_labelObject

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



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

def conditional_parent_label
  @conditional_parent_label
end

#conditional_parent_label_metadataObject

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



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

def 
  @conditional_parent_label_metadata
end

#conditional_parent_valueObject

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.



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

def conditional_parent_value
  @conditional_parent_value
end

#conditional_parent_value_metadataObject

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



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

def 
  @conditional_parent_value_metadata
end

#document_idObject

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



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

def document_id
  @document_id
end

#document_id_metadataObject

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



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

def 
  @document_id_metadata
end

#group_nameObject

The name of the group.



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

def group_name
  @group_name
end

#group_name_metadataObject

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



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

def 
  @group_name_metadata
end

#original_valueObject

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



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

def original_value
  @original_value
end

#original_value_metadataObject

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



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

def 
  @original_value_metadata
end

#radiosObject

Specifies the locations and status for radio buttons that are grouped together.



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

def radios
  @radios
end

#recipient_idObject

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



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

def recipient_id
  @recipient_id
end

#recipient_id_guidObject

Returns the value of attribute recipient_id_guid.



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

def recipient_id_guid
  @recipient_id_guid
end

#recipient_id_guid_metadataObject

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



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

def 
  @recipient_id_guid_metadata
end

#recipient_id_metadataObject

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



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

def 
  @recipient_id_metadata
end

#require_allObject

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



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

def require_all
  @require_all
end

#require_all_metadataObject

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



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

def 
  @require_all_metadata
end

#require_initial_on_shared_changeObject

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



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

def require_initial_on_shared_change
  @require_initial_on_shared_change
end

#require_initial_on_shared_change_metadataObject

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



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

def 
  @require_initial_on_shared_change_metadata
end

#share_to_recipientsObject

Returns the value of attribute share_to_recipients.



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

def share_to_recipients
  @share_to_recipients
end

#share_to_recipients_metadataObject

Reserved for DocuSign.



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

def 
  @share_to_recipients_metadata
end

#sharedObject

When set to true, this custom tab is shared.



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

def shared
  @shared
end

#shared_metadataObject

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



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

def 
  @shared_metadata
end

#tab_typeObject

Returns the value of attribute tab_type.



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

def tab_type
  @tab_type
end

#tab_type_metadataObject

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



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

def 
  @tab_type_metadata
end

#template_lockedObject

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



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

def template_locked
  @template_locked
end

#template_locked_metadataObject

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



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

def 
  @template_locked_metadata
end

#template_requiredObject

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



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

def template_required
  @template_required
end

#template_required_metadataObject

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



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

def 
  @template_required_metadata
end

#tooltipObject

Returns the value of attribute tooltip.



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

def tooltip
  @tooltip
end

#tooltip_metadataObject

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



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

def 
  @tooltip_metadata
end

#valueObject

Specifies the value of the tab.



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

def value
  @value
end

#value_metadataObject

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



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

def 
  @value_metadata
end

Class Method Details

.attribute_mapObject

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/docusign_esign/models/radio_group.rb', line 117

def self.attribute_map
  {
    :'conditional_parent_label' => :'conditionalParentLabel',
    :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
    :'conditional_parent_value' => :'conditionalParentValue',
    :'conditional_parent_value_metadata' => :'conditionalParentValueMetadata',
    :'document_id' => :'documentId',
    :'document_id_metadata' => :'documentIdMetadata',
    :'group_name' => :'groupName',
    :'group_name_metadata' => :'groupNameMetadata',
    :'original_value' => :'originalValue',
    :'original_value_metadata' => :'originalValueMetadata',
    :'radios' => :'radios',
    :'recipient_id' => :'recipientId',
    :'recipient_id_guid' => :'recipientIdGuid',
    :'recipient_id_guid_metadata' => :'recipientIdGuidMetadata',
    :'recipient_id_metadata' => :'recipientIdMetadata',
    :'require_all' => :'requireAll',
    :'require_all_metadata' => :'requireAllMetadata',
    :'require_initial_on_shared_change' => :'requireInitialOnSharedChange',
    :'require_initial_on_shared_change_metadata' => :'requireInitialOnSharedChangeMetadata',
    :'shared' => :'shared',
    :'shared_metadata' => :'sharedMetadata',
    :'share_to_recipients' => :'shareToRecipients',
    :'share_to_recipients_metadata' => :'shareToRecipientsMetadata',
    :'tab_type' => :'tabType',
    :'tab_type_metadata' => :'tabTypeMetadata',
    :'template_locked' => :'templateLocked',
    :'template_locked_metadata' => :'templateLockedMetadata',
    :'template_required' => :'templateRequired',
    :'template_required_metadata' => :'templateRequiredMetadata',
    :'tooltip' => :'tooltip',
    :'tooltip_metadata' => :'tooltipMetadata',
    :'value' => :'value',
    :'value_metadata' => :'valueMetadata'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'conditional_parent_label' => :'String',
    :'conditional_parent_label_metadata' => :'PropertyMetadata',
    :'conditional_parent_value' => :'String',
    :'conditional_parent_value_metadata' => :'PropertyMetadata',
    :'document_id' => :'String',
    :'document_id_metadata' => :'PropertyMetadata',
    :'group_name' => :'String',
    :'group_name_metadata' => :'PropertyMetadata',
    :'original_value' => :'String',
    :'original_value_metadata' => :'PropertyMetadata',
    :'radios' => :'Array<Radio>',
    :'recipient_id' => :'String',
    :'recipient_id_guid' => :'String',
    :'recipient_id_guid_metadata' => :'PropertyMetadata',
    :'recipient_id_metadata' => :'PropertyMetadata',
    :'require_all' => :'String',
    :'require_all_metadata' => :'PropertyMetadata',
    :'require_initial_on_shared_change' => :'String',
    :'require_initial_on_shared_change_metadata' => :'PropertyMetadata',
    :'shared' => :'String',
    :'shared_metadata' => :'PropertyMetadata',
    :'share_to_recipients' => :'String',
    :'share_to_recipients_metadata' => :'PropertyMetadata',
    :'tab_type' => :'String',
    :'tab_type_metadata' => :'PropertyMetadata',
    :'template_locked' => :'String',
    :'template_locked_metadata' => :'PropertyMetadata',
    :'template_required' => :'String',
    :'template_required_metadata' => :'PropertyMetadata',
    :'tooltip' => :'String',
    :'tooltip_metadata' => :'PropertyMetadata',
    :'value' => :'String',
    :'value_metadata' => :'PropertyMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conditional_parent_label == o.conditional_parent_label &&
       == o. &&
      conditional_parent_value == o.conditional_parent_value &&
       == o. &&
      document_id == o.document_id &&
       == o. &&
      group_name == o.group_name &&
       == o. &&
      original_value == o.original_value &&
       == o. &&
      radios == o.radios &&
      recipient_id == o.recipient_id &&
      recipient_id_guid == o.recipient_id_guid &&
       == o. &&
       == o. &&
      require_all == o.require_all &&
       == o. &&
      require_initial_on_shared_change == o.require_initial_on_shared_change &&
       == o. &&
      shared == o.shared &&
       == o. &&
      share_to_recipients == o.share_to_recipients &&
       == o. &&
      tab_type == o.tab_type &&
       == o. &&
      template_locked == o.template_locked &&
       == o. &&
      template_required == o.template_required &&
       == o. &&
      tooltip == o.tooltip &&
       == o. &&
      value == o.value &&
       == o.
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



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

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



492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/docusign_esign/models/radio_group.rb', line 492

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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/docusign_esign/models/radio_group.rb', line 405

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


392
393
394
# File 'lib/docusign_esign/models/radio_group.rb', line 392

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



398
399
400
# File 'lib/docusign_esign/models/radio_group.rb', line 398

def hash
  [conditional_parent_label, , conditional_parent_value, , document_id, , group_name, , original_value, , radios, recipient_id, recipient_id_guid, , , require_all, , require_initial_on_shared_change, , shared, , share_to_recipients, , tab_type, , template_locked, , template_required, , tooltip, , value, ].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



339
340
341
342
# File 'lib/docusign_esign/models/radio_group.rb', line 339

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



478
479
480
481
482
483
484
485
486
# File 'lib/docusign_esign/models/radio_group.rb', line 478

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



466
467
468
# File 'lib/docusign_esign/models/radio_group.rb', line 466

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



346
347
348
# File 'lib/docusign_esign/models/radio_group.rb', line 346

def valid?
  true
end