Class: Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink

Inherits:
TemplateResponseDocumentFormFieldBase show all
Defined in:
lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb

Overview

This class extends ‘TemplateResponseDocumentFormFieldBase`

Instance Attribute Summary collapse

Attributes inherited from TemplateResponseDocumentFormFieldBase

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TemplateResponseDocumentFormFieldBase

discriminator_class_name, openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ TemplateResponseDocumentFormFieldHyperlink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
155
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 113

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

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  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::TemplateResponseDocumentFormFieldHyperlink`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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?(:'avg_text_length')
    self.avg_text_length = attributes[:'avg_text_length']
  end

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

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

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

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

Instance Attribute Details

#avg_text_length ⇒ TemplateResponseFieldAvgTextLength

Returns:



27
28
29
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 27

def avg_text_length
  @avg_text_length
end

#font_family ⇒ String

Font family used in this form field’s text.

Returns:

  • (String) 


39
40
41
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 39

def font_family
  @font_family
end

#group ⇒ String?

The name of the group this field is in. If this field is not a group, this defaults to ‘null` except for Radio fields.

Returns:

  • (String, nil) 


43
44
45
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 43

def group
  @group
end

#is_multiline ⇒ Boolean

Whether this form field is multiline text.

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 31

def is_multiline
  @is_multiline
end

#original_font_size ⇒ Integer

Original font size used in this form field’s text.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 35

def original_font_size
  @original_font_size
end

#type ⇒ String

The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses ‘TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about, including the ones defined in its parent(s)



58
59
60
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 58

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

.acceptable_attributes ⇒ Object

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



63
64
65
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 46

def self.attribute_map
  {
    :'type' => :'type',
    :'avg_text_length' => :'avg_text_length',
    :'is_multiline' => :'isMultiline',
    :'original_font_size' => :'originalFontSize',
    :'font_family' => :'fontFamily',
    :'group' => :'group'
  }
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



213
214
215
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 213

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

.init(data) ⇒ TemplateResponseDocumentFormFieldHyperlink

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



104
105
106
107
108
109
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 104

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



87
88
89
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 87

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



97
98
99
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 97

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

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
84
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 80

def self.openapi_nullable
  Set.new([
    :'group'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 68

def self.openapi_types
  {
    :'type' => :'String',
    :'avg_text_length' => :'TemplateResponseFieldAvgTextLength',
    :'is_multiline' => :'Boolean',
    :'original_font_size' => :'Integer',
    :'font_family' => :'String',
    :'group' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      avg_text_length == o.avg_text_length &&
      is_multiline == o.is_multiline &&
      original_font_size == o.original_font_size &&
      font_family == o.font_family &&
      group == o.group && 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



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
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 244

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



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

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 220

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


200
201
202
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 206

def hash
  [type, avg_text_length, is_multiline, original_font_size, font_family, group].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



159
160
161
162
163
164
165
166
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 159

def list_invalid_properties
  invalid_properties = super
  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



290
291
292
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 296

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



284
285
286
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 284

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



170
171
172
173
 
# File 'lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb', line 170

def valid?
  return false if @type.nil?
  true && super
end