Class: DocuSign_eSign::RadioGroup
- Inherits:
-
Object
- Object
- DocuSign_eSign::RadioGroup
- Defined in:
- lib/docusign_esign/models/radio_group.rb
Instance Attribute Summary collapse
-
#conditional_parent_label ⇒ Object
For conditional fields this is the TabLabel of the parent tab that controls this tab’s visibility.
-
#conditional_parent_value ⇒ Object
For conditional fields, this is the value of the parent tab that controls the tab’s visibility.
-
#document_id ⇒ Object
Specifies the document ID number that the tab is placed on.
-
#group_name ⇒ Object
The name of the group.
-
#radios ⇒ Object
Specifies the locations and status for radio buttons that are grouped together.
-
#recipient_id ⇒ Object
Unique for the recipient.
-
#require_all ⇒ Object
When set to true and shared is true, information must be entered in this field to complete the envelope.
-
#require_initial_on_shared_change ⇒ Object
Optional element for field markup.
-
#shared ⇒ Object
When set to true, this custom tab is shared.
-
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient.
-
#template_required ⇒ Object
When set to true, the sender may not remove the recipient.
-
#tooltip ⇒ Object
Returns the value of attribute tooltip.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RadioGroup
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ RadioGroup
Initializes the object
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 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 |
# File 'lib/docusign_esign/models/radio_group.rb', line 92 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?(:'conditionalParentValue') self.conditional_parent_value = attributes[:'conditionalParentValue'] end if attributes.has_key?(:'documentId') self.document_id = attributes[:'documentId'] end if attributes.has_key?(:'groupName') self.group_name = attributes[:'groupName'] 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?(:'requireAll') self.require_all = attributes[:'requireAll'] end if attributes.has_key?(:'requireInitialOnSharedChange') self.require_initial_on_shared_change = attributes[:'requireInitialOnSharedChange'] end if attributes.has_key?(:'shared') self.shared = attributes[:'shared'] end if attributes.has_key?(:'templateLocked') self.template_locked = attributes[:'templateLocked'] end if attributes.has_key?(:'templateRequired') self.template_required = attributes[:'templateRequired'] end if attributes.has_key?(:'tooltip') self.tooltip = attributes[:'tooltip'] 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.
18 19 20 |
# File 'lib/docusign_esign/models/radio_group.rb', line 18 def conditional_parent_label @conditional_parent_label 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.
21 22 23 |
# File 'lib/docusign_esign/models/radio_group.rb', line 21 def conditional_parent_value @conditional_parent_value 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.
24 25 26 |
# File 'lib/docusign_esign/models/radio_group.rb', line 24 def document_id @document_id end |
#group_name ⇒ Object
The name of the group.
27 28 29 |
# File 'lib/docusign_esign/models/radio_group.rb', line 27 def group_name @group_name end |
#radios ⇒ Object
Specifies the locations and status for radio buttons that are grouped together.
30 31 32 |
# File 'lib/docusign_esign/models/radio_group.rb', line 30 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.
33 34 35 |
# File 'lib/docusign_esign/models/radio_group.rb', line 33 def recipient_id @recipient_id end |
#require_all ⇒ Object
When set to true and shared is true, information must be entered in this field to complete the envelope.
36 37 38 |
# File 'lib/docusign_esign/models/radio_group.rb', line 36 def require_all @require_all 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.
39 40 41 |
# File 'lib/docusign_esign/models/radio_group.rb', line 39 def require_initial_on_shared_change @require_initial_on_shared_change end |
#shared ⇒ Object
When set to true, this custom tab is shared.
42 43 44 |
# File 'lib/docusign_esign/models/radio_group.rb', line 42 def shared @shared end |
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
45 46 47 |
# File 'lib/docusign_esign/models/radio_group.rb', line 45 def template_locked @template_locked end |
#template_required ⇒ Object
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
48 49 50 |
# File 'lib/docusign_esign/models/radio_group.rb', line 48 def template_required @template_required end |
#tooltip ⇒ Object
Returns the value of attribute tooltip.
51 52 53 |
# File 'lib/docusign_esign/models/radio_group.rb', line 51 def tooltip @tooltip end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/docusign_esign/models/radio_group.rb', line 55 def self.attribute_map { :'conditional_parent_label' => :'conditionalParentLabel', :'conditional_parent_value' => :'conditionalParentValue', :'document_id' => :'documentId', :'group_name' => :'groupName', :'radios' => :'radios', :'recipient_id' => :'recipientId', :'require_all' => :'requireAll', :'require_initial_on_shared_change' => :'requireInitialOnSharedChange', :'shared' => :'shared', :'template_locked' => :'templateLocked', :'template_required' => :'templateRequired', :'tooltip' => :'tooltip' } end |
.swagger_types ⇒ Object
Attribute type mapping.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/docusign_esign/models/radio_group.rb', line 73 def self.swagger_types { :'conditional_parent_label' => :'String', :'conditional_parent_value' => :'String', :'document_id' => :'String', :'group_name' => :'String', :'radios' => :'Array<Radio>', :'recipient_id' => :'String', :'require_all' => :'String', :'require_initial_on_shared_change' => :'String', :'shared' => :'String', :'template_locked' => :'String', :'template_required' => :'String', :'tooltip' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/docusign_esign/models/radio_group.rb', line 165 def ==(o) return true if self.equal?(o) self.class == o.class && conditional_parent_label == o.conditional_parent_label && conditional_parent_value == o.conditional_parent_value && document_id == o.document_id && group_name == o.group_name && radios == o.radios && recipient_id == o.recipient_id && require_all == o.require_all && require_initial_on_shared_change == o.require_initial_on_shared_change && shared == o.shared && template_locked == o.template_locked && template_required == o.template_required && tooltip == o.tooltip end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/docusign_esign/models/radio_group.rb', line 218 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
284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/docusign_esign/models/radio_group.rb', line 284 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
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/docusign_esign/models/radio_group.rb', line 197 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 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
184 185 186 |
# File 'lib/docusign_esign/models/radio_group.rb', line 184 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
190 191 192 |
# File 'lib/docusign_esign/models/radio_group.rb', line 190 def hash [conditional_parent_label, conditional_parent_value, document_id, group_name, radios, recipient_id, require_all, require_initial_on_shared_change, shared, template_locked, template_required, tooltip].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
152 153 154 155 |
# File 'lib/docusign_esign/models/radio_group.rb', line 152 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
264 265 266 |
# File 'lib/docusign_esign/models/radio_group.rb', line 264 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
270 271 272 273 274 275 276 277 278 |
# File 'lib/docusign_esign/models/radio_group.rb', line 270 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
258 259 260 |
# File 'lib/docusign_esign/models/radio_group.rb', line 258 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
159 160 161 |
# File 'lib/docusign_esign/models/radio_group.rb', line 159 def valid? return true end |