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


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

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?(:'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?(:'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
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

Returns the value of attribute conditional_parent_label_metadata


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

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.


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

def conditional_parent_value
  @conditional_parent_value
end

#conditional_parent_value_metadataObject

Returns the value of attribute conditional_parent_value_metadata


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

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.


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

def document_id
  @document_id
end

#document_id_metadataObject

Returns the value of attribute document_id_metadata


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

def 
  @document_id_metadata
end

#group_nameObject

The name of the group.


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

def group_name
  @group_name
end

#group_name_metadataObject

Returns the value of attribute group_name_metadata


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

def 
  @group_name_metadata
end

#radiosObject

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


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

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.


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

def recipient_id
  @recipient_id
end

#recipient_id_guidObject

Returns the value of attribute recipient_id_guid


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

def recipient_id_guid
  @recipient_id_guid
end

#recipient_id_guid_metadataObject

Returns the value of attribute recipient_id_guid_metadata


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

def 
  @recipient_id_guid_metadata
end

#recipient_id_metadataObject

Returns the value of attribute recipient_id_metadata


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

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.


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

def require_all
  @require_all
end

#require_all_metadataObject

Returns the value of attribute require_all_metadata


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

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.


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

def require_initial_on_shared_change
  @require_initial_on_shared_change
end

#require_initial_on_shared_change_metadataObject

Returns the value of attribute require_initial_on_shared_change_metadata


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

def 
  @require_initial_on_shared_change_metadata
end

#sharedObject

When set to *true*, this custom tab is shared.


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

def shared
  @shared
end

#shared_metadataObject

Returns the value of attribute shared_metadata


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

def 
  @shared_metadata
end

#tab_typeObject

Returns the value of attribute tab_type


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

def tab_type
  @tab_type
end

#tab_type_metadataObject

Returns the value of attribute tab_type_metadata


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

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.


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

def template_locked
  @template_locked
end

#template_locked_metadataObject

Returns the value of attribute template_locked_metadata


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

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.


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

def template_required
  @template_required
end

#template_required_metadataObject

Returns the value of attribute template_required_metadata


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

def 
  @template_required_metadata
end

#tooltipObject

Returns the value of attribute tooltip


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

def tooltip
  @tooltip
end

#tooltip_metadataObject

Returns the value of attribute tooltip_metadata


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

def 
  @tooltip_metadata
end

Class Method Details

.attribute_mapObject

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


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

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

Attribute type mapping.


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

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


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

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. &&
      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. &&
      tab_type == o.tab_type &&
       == o. &&
      template_locked == o.template_locked &&
       == o. &&
      template_required == o.template_required &&
       == o. &&
      tooltip == o.tooltip &&
       == 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


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

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


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

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


332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'lib/docusign_esign/models/radio_group.rb', line 332

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

319
320
321
# File 'lib/docusign_esign/models/radio_group.rb', line 319

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


325
326
327
# File 'lib/docusign_esign/models/radio_group.rb', line 325

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

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


272
273
274
275
# File 'lib/docusign_esign/models/radio_group.rb', line 272

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


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

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


405
406
407
408
409
410
411
412
413
# File 'lib/docusign_esign/models/radio_group.rb', line 405

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


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

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


279
280
281
# File 'lib/docusign_esign/models/radio_group.rb', line 279

def valid?
  true
end