Class: DocuSign_eSign::RadioGroup

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

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
 
# File 'lib/docusign_esign/models/radio_group.rb', line 161

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.conditional_parent_label_metadata = attributes[:'conditionalParentLabelMetadata']
  end

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

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

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

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

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

  if attributes.has_key?(:'groupNameMetadata')
    self.group_name_metadata = attributes[:'groupNameMetadata']
  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.recipient_id_guid_metadata = attributes[:'recipientIdGuidMetadata']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#conditional_parent_label ⇒ Object

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



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

def conditional_parent_label
  @conditional_parent_label
end

#conditional_parent_label_metadata ⇒ Object

Returns the value of attribute conditional_parent_label_metadata.



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

def conditional_parent_label_metadata
  @conditional_parent_label_metadata
end

#conditional_parent_value ⇒ Object

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



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

def conditional_parent_value
  @conditional_parent_value
end

#conditional_parent_value_metadata ⇒ Object

Returns the value of attribute conditional_parent_value_metadata.



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

def conditional_parent_value_metadata
  @conditional_parent_value_metadata
end

#document_id ⇒ Object

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



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

def document_id
  @document_id
end

#document_id_metadata ⇒ Object

Returns the value of attribute document_id_metadata.



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

def document_id_metadata
  @document_id_metadata
end

#group_name ⇒ Object

The name of the group.



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

def group_name
  @group_name
end

#group_name_metadata ⇒ Object

Returns the value of attribute group_name_metadata.



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

def group_name_metadata
  @group_name_metadata
end

#radios ⇒ Object

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



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

def radios
  @radios
end

#recipient_id ⇒ Object

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



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

def recipient_id
  @recipient_id
end

#recipient_id_guid ⇒ Object

Returns the value of attribute recipient_id_guid.



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

def recipient_id_guid
  @recipient_id_guid
end

#recipient_id_guid_metadata ⇒ Object

Returns the value of attribute recipient_id_guid_metadata.



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

def recipient_id_guid_metadata
  @recipient_id_guid_metadata
end

#recipient_id_metadata ⇒ Object

Returns the value of attribute recipient_id_metadata.



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

def recipient_id_metadata
  @recipient_id_metadata
end

#require_all ⇒ Object

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



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

def require_all
  @require_all
end

#require_all_metadata ⇒ Object

Returns the value of attribute require_all_metadata.



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

def require_all_metadata
  @require_all_metadata
end

#require_initial_on_shared_change ⇒ Object

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



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

def require_initial_on_shared_change
  @require_initial_on_shared_change
end

#require_initial_on_shared_change_metadata ⇒ Object

Returns the value of attribute require_initial_on_shared_change_metadata.



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

def require_initial_on_shared_change_metadata
  @require_initial_on_shared_change_metadata
end

#share_to_recipients ⇒ Object

Returns the value of attribute share_to_recipients.



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

def share_to_recipients
  @share_to_recipients
end

#share_to_recipients_metadata ⇒ Object

Returns the value of attribute share_to_recipients_metadata.



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

def share_to_recipients_metadata
  @share_to_recipients_metadata
end

#shared ⇒ Object

When set to true, this custom tab is shared.



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

def shared
  @shared
end

#shared_metadata ⇒ Object

Returns the value of attribute shared_metadata.



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

def shared_metadata
  @shared_metadata
end

#tab_type ⇒ Object

Returns the value of attribute tab_type.



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

def tab_type
  @tab_type
end

#tab_type_metadata ⇒ Object

Returns the value of attribute tab_type_metadata.



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

def tab_type_metadata
  @tab_type_metadata
end

#template_locked ⇒ Object

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



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

def template_locked
  @template_locked
end

#template_locked_metadata ⇒ Object

Returns the value of attribute template_locked_metadata.



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

def template_locked_metadata
  @template_locked_metadata
end

#template_required ⇒ Object

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



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

def template_required
  @template_required
end

#template_required_metadata ⇒ Object

Returns the value of attribute template_required_metadata.



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

def template_required_metadata
  @template_required_metadata
end

#tooltip ⇒ Object

Returns the value of attribute tooltip.



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

def tooltip
  @tooltip
end

#tooltip_metadata ⇒ Object

Returns the value of attribute tooltip_metadata.



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

def tooltip_metadata
  @tooltip_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/docusign_esign/models/radio_group.rb', line 90

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conditional_parent_label == o.conditional_parent_label &&
      conditional_parent_label_metadata == o.conditional_parent_label_metadata &&
      conditional_parent_value == o.conditional_parent_value &&
      conditional_parent_value_metadata == o.conditional_parent_value_metadata &&
      document_id == o.document_id &&
      document_id_metadata == o.document_id_metadata &&
      group_name == o.group_name &&
      group_name_metadata == o.group_name_metadata &&
      radios == o.radios &&
      recipient_id == o.recipient_id &&
      recipient_id_guid == o.recipient_id_guid &&
      recipient_id_guid_metadata == o.recipient_id_guid_metadata &&
      recipient_id_metadata == o.recipient_id_metadata &&
      require_all == o.require_all &&
      require_all_metadata == o.require_all_metadata &&
      require_initial_on_shared_change == o.require_initial_on_shared_change &&
      require_initial_on_shared_change_metadata == o.require_initial_on_shared_change_metadata &&
      shared == o.shared &&
      shared_metadata == o.shared_metadata &&
      share_to_recipients == o.share_to_recipients &&
      share_to_recipients_metadata == o.share_to_recipients_metadata &&
      tab_type == o.tab_type &&
      tab_type_metadata == o.tab_type_metadata &&
      template_locked == o.template_locked &&
      template_locked_metadata == o.template_locked_metadata &&
      template_required == o.template_required &&
      template_required_metadata == o.template_required_metadata &&
      tooltip == o.tooltip &&
      tooltip_metadata == o.tooltip_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



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

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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/docusign_esign/models/radio_group.rb', line 437

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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/docusign_esign/models/radio_group.rb', line 350

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


337
338
339
 
# File 'lib/docusign_esign/models/radio_group.rb', line 337

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



343
344
345
 
# File 'lib/docusign_esign/models/radio_group.rb', line 343

def hash
  [conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, document_id, document_id_metadata, group_name, group_name_metadata, radios, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tooltip_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



288
289
290
291
 
# File 'lib/docusign_esign/models/radio_group.rb', line 288

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



417
418
419
 
# File 'lib/docusign_esign/models/radio_group.rb', line 417

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



423
424
425
426
427
428
429
430
431
 
# File 'lib/docusign_esign/models/radio_group.rb', line 423

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



411
412
413
 
# File 'lib/docusign_esign/models/radio_group.rb', line 411

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



295
296
297
 
# File 'lib/docusign_esign/models/radio_group.rb', line 295

def valid?
  true
end