Class: DocuSign_eSign::DocumentHtmlDefinition

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

Overview

Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentHtmlDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 86

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.remove_empty_tags = 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.



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

def display_anchor_prefix
  @display_anchor_prefix
end

#display_anchors ⇒ Object

Returns the value of attribute display_anchors.



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

def display_anchors
  @display_anchors
end

#display_order ⇒ Object

Returns the value of attribute display_order.



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

def display_order
  @display_order
end

#display_page_number ⇒ Object

Returns the value of attribute display_page_number.



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

def display_page_number
  @display_page_number
end

#document_guid ⇒ Object

Returns the value of attribute document_guid.



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

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.



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

def document_id
  @document_id
end

#header_label ⇒ Object

Returns the value of attribute header_label.



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

def header_label
  @header_label
end

#max_screen_width ⇒ Object

Returns the value of attribute max_screen_width.



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

def max_screen_width
  @max_screen_width
end

#remove_empty_tags ⇒ Object

Returns the value of attribute remove_empty_tags.



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

def remove_empty_tags
  @remove_empty_tags
end

#show_mobile_optimized_toggle ⇒ Object

Returns the value of attribute show_mobile_optimized_toggle.



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

def show_mobile_optimized_toggle
  @show_mobile_optimized_toggle
end

#source ⇒ Object

Returns the value of attribute source.



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

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 51

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.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 68

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.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 154

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 &&
      remove_empty_tags == o.remove_empty_tags &&
      show_mobile_optimized_toggle == o.show_mobile_optimized_toggle &&
      source == o.source
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



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

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 272

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 185

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


172
173
174
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



178
179
180
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 178

def hash
  [display_anchor_prefix, display_anchors, display_order, display_page_number, document_guid, document_id, header_label, max_screen_width, remove_empty_tags, show_mobile_optimized_toggle, source].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



141
142
143
144
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 141

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



252
253
254
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 252

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



258
259
260
261
262
263
264
265
266
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 258

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



246
247
248
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 246

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



148
149
150
 
# File 'lib/docusign_esign/models/document_html_definition.rb', line 148

def valid?
  true
end