Class: Dropbox::Sign::SubFormFieldsPerDocumentHyperlink

Inherits:
SubFormFieldsPerDocumentBase show all
Defined in:
lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb

Overview

This class extends ‘SubFormFieldsPerDocumentBase`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from SubFormFieldsPerDocumentBase

#api_id, #document_index, #height, #name, #page, #required, #signer, #width, #x, #y

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SubFormFieldsPerDocumentBase

discriminator_class_name, openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ SubFormFieldsPerDocumentHyperlink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 124

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubFormFieldsPerDocumentHyperlink` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentHyperlink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'hyperlink'
  end

  if attributes.key?(:'content')
    self.content = attributes[:'content']
  end

  if attributes.key?(:'content_url')
    self.content_url = attributes[:'content_url']
  end

  if attributes.key?(:'font_family')
    self.font_family = attributes[:'font_family']
  end

  if attributes.key?(:'font_size')
    self.font_size = attributes[:'font_size']
  else
    self.font_size = 12
  end
end

Instance Attribute Details

#content ⇒ String

Link Text.

Returns:

  • (String) 


28
29
30
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 28

def content
  @content
end

#content_url ⇒ String

Link URL.

Returns:

  • (String) 


32
33
34
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 32

def content_url
  @content_url
end

#font_family ⇒ String

Font family for the field.

Returns:

  • (String) 


36
37
38
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 36

def font_family
  @font_family
end

#font_size ⇒ Integer

The initial px font size for the field contents. Can be any integer value between ‘7` and `49`. NOTE: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 40

def font_size
  @font_size
end

#type ⇒ String

A hyperlink field. Use the ‘SubFormFieldsPerDocumentHyperlink` class.

Returns:

  • (String) 


24
25
26
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 24

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



76
77
78
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 76

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 65

def self.attribute_map
  {
    :'type' => :'type',
    :'content' => :'content',
    :'content_url' => :'content_url',
    :'font_family' => :'font_family',
    :'font_size' => :'font_size'
  }
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



232
233
234
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 232

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ SubFormFieldsPerDocumentHyperlink

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



115
116
117
118
119
120
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 115

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "SubFormFieldsPerDocumentHyperlink"
  ) || SubFormFieldsPerDocumentHyperlink.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



98
99
100
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 98

def self.merged_attributes
  self.superclass.attribute_map.merge(self.attribute_map)
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



108
109
110
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 108

def self.merged_nullable
  self.superclass.openapi_nullable.merge(self.openapi_nullable)
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



103
104
105
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 103

def self.merged_types
  self.superclass.openapi_types.merge(self.openapi_types)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 92

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 81

def self.openapi_types
  {
    :'type' => :'String',
    :'content' => :'String',
    :'content_url' => :'String',
    :'font_family' => :'String',
    :'font_size' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      content == o.content &&
      content_url == o.content_url &&
      font_family == o.font_family &&
      font_size == o.font_size && super(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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 263

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ 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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 334

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 239

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


219
220
221
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 225

def hash
  [type, content, content_url, font_family, font_size].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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 167

def list_invalid_properties
  invalid_properties = super
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @content.nil?
    invalid_properties.push('invalid value for "content", content cannot be nil.')
  end

  if @content_url.nil?
    invalid_properties.push('invalid value for "content_url", content_url cannot be nil.')
  end

  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



309
310
311
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 309

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 315

def to_hash(include_nil = true)
  hash = super
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



303
304
305
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 303

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



186
187
188
189
190
191
192
193
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb', line 186

def valid?
  return false if @type.nil?
  return false if @content.nil?
  return false if @content_url.nil?
  font_family_validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
  return false unless font_family_validator.valid?(@font_family)
  true && super
end