Class: DocuSign_eSign::DocumentHtmlDefinition
- Inherits:
-
Object
- Object
- DocuSign_eSign::DocumentHtmlDefinition
- Defined in:
- lib/docusign_esign/models/document_html_definition.rb
Instance Attribute Summary collapse
-
#display_anchor_prefix ⇒ Object
Returns the value of attribute display_anchor_prefix.
-
#display_anchors ⇒ Object
Returns the value of attribute display_anchors.
-
#display_order ⇒ Object
Returns the value of attribute display_order.
-
#display_page_number ⇒ Object
Returns the value of attribute display_page_number.
-
#document_guid ⇒ Object
Returns the value of attribute document_guid.
-
#document_id ⇒ Object
Specifies the document ID number that the tab is placed on.
-
#header_label ⇒ Object
Returns the value of attribute header_label.
-
#max_screen_width ⇒ Object
Returns the value of attribute max_screen_width.
-
#remove_empty_tags ⇒ Object
Returns the value of attribute remove_empty_tags.
-
#show_mobile_optimized_toggle ⇒ Object
Returns the value of attribute show_mobile_optimized_toggle.
-
#source ⇒ Object
Returns the value of attribute source.
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 = {}) ⇒ DocumentHtmlDefinition
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 = {}) ⇒ DocumentHtmlDefinition
Initializes the object
85 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 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 85 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?(:'displayAnchorPrefix') self.display_anchor_prefix = attributes[:'displayAnchorPrefix'] end if attributes.has_key?(:'displayAnchors') if (value = attributes[:'displayAnchors']).is_a?(Array) self.display_anchors = value end end if attributes.has_key?(:'displayOrder') self.display_order = attributes[:'displayOrder'] end if attributes.has_key?(:'displayPageNumber') self.display_page_number = attributes[:'displayPageNumber'] end if attributes.has_key?(:'documentGuid') self.document_guid = attributes[:'documentGuid'] end if attributes.has_key?(:'documentId') self.document_id = attributes[:'documentId'] end if attributes.has_key?(:'headerLabel') self.header_label = attributes[:'headerLabel'] end if attributes.has_key?(:'maxScreenWidth') self.max_screen_width = attributes[:'maxScreenWidth'] end if attributes.has_key?(:'removeEmptyTags') self. = attributes[:'removeEmptyTags'] end if attributes.has_key?(:'showMobileOptimizedToggle') self.show_mobile_optimized_toggle = attributes[:'showMobileOptimizedToggle'] end if attributes.has_key?(:'source') self.source = attributes[:'source'] end end |
Instance Attribute Details
#display_anchor_prefix ⇒ Object
Returns the value of attribute display_anchor_prefix.
17 18 19 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 17 def display_anchor_prefix @display_anchor_prefix end |
#display_anchors ⇒ Object
Returns the value of attribute display_anchors.
20 21 22 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 20 def display_anchors @display_anchors end |
#display_order ⇒ Object
Returns the value of attribute display_order.
23 24 25 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 23 def display_order @display_order end |
#display_page_number ⇒ Object
Returns the value of attribute display_page_number.
26 27 28 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 26 def display_page_number @display_page_number end |
#document_guid ⇒ Object
Returns the value of attribute document_guid.
29 30 31 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 29 def document_guid @document_guid 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.
32 33 34 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 32 def document_id @document_id end |
#header_label ⇒ Object
Returns the value of attribute header_label.
35 36 37 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 35 def header_label @header_label end |
#max_screen_width ⇒ Object
Returns the value of attribute max_screen_width.
38 39 40 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 38 def max_screen_width @max_screen_width end |
#remove_empty_tags ⇒ Object
Returns the value of attribute remove_empty_tags.
41 42 43 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 41 def @remove_empty_tags end |
#show_mobile_optimized_toggle ⇒ Object
Returns the value of attribute show_mobile_optimized_toggle.
44 45 46 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 44 def show_mobile_optimized_toggle @show_mobile_optimized_toggle end |
#source ⇒ Object
Returns the value of attribute source.
47 48 49 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 47 def source @source end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 50 def self.attribute_map { :'display_anchor_prefix' => :'displayAnchorPrefix', :'display_anchors' => :'displayAnchors', :'display_order' => :'displayOrder', :'display_page_number' => :'displayPageNumber', :'document_guid' => :'documentGuid', :'document_id' => :'documentId', :'header_label' => :'headerLabel', :'max_screen_width' => :'maxScreenWidth', :'remove_empty_tags' => :'removeEmptyTags', :'show_mobile_optimized_toggle' => :'showMobileOptimizedToggle', :'source' => :'source' } end |
.swagger_types ⇒ Object
Attribute type mapping.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 67 def self.swagger_types { :'display_anchor_prefix' => :'String', :'display_anchors' => :'Array<DocumentHtmlDisplayAnchor>', :'display_order' => :'String', :'display_page_number' => :'String', :'document_guid' => :'String', :'document_id' => :'String', :'header_label' => :'String', :'max_screen_width' => :'String', :'remove_empty_tags' => :'String', :'show_mobile_optimized_toggle' => :'String', :'source' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 153 def ==(o) return true if self.equal?(o) self.class == o.class && display_anchor_prefix == o.display_anchor_prefix && display_anchors == o.display_anchors && display_order == o.display_order && display_page_number == o.display_page_number && document_guid == o.document_guid && document_id == o.document_id && header_label == o.header_label && max_screen_width == o.max_screen_width && == o. && show_mobile_optimized_toggle == o.show_mobile_optimized_toggle && source == o.source end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 205 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
271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 271 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
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 184 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
171 172 173 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 171 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
177 178 179 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 177 def hash [display_anchor_prefix, display_anchors, display_order, display_page_number, document_guid, document_id, header_label, max_screen_width, , show_mobile_optimized_toggle, source].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
140 141 142 143 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 140 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
251 252 253 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 251 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
257 258 259 260 261 262 263 264 265 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 257 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
245 246 247 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 245 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
147 148 149 |
# File 'lib/docusign_esign/models/document_html_definition.rb', line 147 def valid? true end |