Class: Dropbox::Sign::SubFormFieldsPerDocumentText

Inherits:
SubFormFieldsPerDocumentBase show all
Defined in:
lib/dropbox-sign/models/sub_form_fields_per_document_text.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 = {}) ⇒ SubFormFieldsPerDocumentText

Initializes the object

Parameters:

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

    Model attributes in the form of hash



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 163

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubFormFieldsPerDocumentText` 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::SubFormFieldsPerDocumentText`. 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 = 'text'
  end

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

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

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

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

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

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

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

  if attributes.key?(:'content')
    self.content = attributes[:'content']
  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

#auto_fill_type ⇒ String

Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.

Returns:

  • (String) 


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

def auto_fill_type
  @auto_fill_type
end

#content ⇒ String

Content of a ‘me_now` text field

Returns:

  • (String) 


54
55
56
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 54

def content
  @content
end

#font_family ⇒ String

Font family for the field.

Returns:

  • (String) 


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

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) 


62
63
64
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 62

def font_size
  @font_size
end

#link_id ⇒ String

Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.

Returns:

  • (String) 


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

def link_id
  @link_id
end

#masked ⇒ Boolean

Masks entered data. For more information see [Masking sensitive information](faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). ‘true` for masking the data in a text field, otherwise `false`.

Returns:

  • (Boolean) 


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

def masked
  @masked
end

#placeholder ⇒ String

Placeholder value for text field.

Returns:

  • (String) 


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

def placeholder
  @placeholder
end

#type ⇒ String

A text input field. Use the ‘SubFormFieldsPerDocumentText` class.

Returns:

  • (String) 


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

def type
  @type
end

#validation_custom_regex ⇒ String

Returns:

  • (String) 


47
48
49
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 47

def validation_custom_regex
  @validation_custom_regex
end

#validation_custom_regex_format_label ⇒ String

Returns:

  • (String) 


50
51
52
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 50

def validation_custom_regex_format_label
  @validation_custom_regex_format_label
end

#validation_type ⇒ String

Each text field may contain a ‘validation_type` parameter. Check out the list of [validation types](faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. NOTE: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.

Returns:

  • (String) 


44
45
46
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 44

def validation_type
  @validation_type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

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



104
105
106
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 104

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)



109
110
111
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 109

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 87

def self.attribute_map
  {
    :'type' => :'type',
    :'placeholder' => :'placeholder',
    :'auto_fill_type' => :'auto_fill_type',
    :'link_id' => :'link_id',
    :'masked' => :'masked',
    :'validation_type' => :'validation_type',
    :'validation_custom_regex' => :'validation_custom_regex',
    :'validation_custom_regex_format_label' => :'validation_custom_regex_format_label',
    :'content' => :'content',
    :'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



314
315
316
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 314

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

.init(data) ⇒ SubFormFieldsPerDocumentText

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



154
155
156
157
158
159
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 154

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



137
138
139
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 137

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



147
148
149
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 147

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

.merged_types ⇒ Object

Attribute type mapping of this model + parent



142
143
144
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 142

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 131

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

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 114

def self.openapi_types
  {
    :'type' => :'String',
    :'placeholder' => :'String',
    :'auto_fill_type' => :'String',
    :'link_id' => :'String',
    :'masked' => :'Boolean',
    :'validation_type' => :'String',
    :'validation_custom_regex' => :'String',
    :'validation_custom_regex_format_label' => :'String',
    :'content' => :'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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      placeholder == o.placeholder &&
      auto_fill_type == o.auto_fill_type &&
      link_id == o.link_id &&
      masked == o.masked &&
      validation_type == o.validation_type &&
      validation_custom_regex == o.validation_custom_regex &&
      validation_custom_regex_format_label == o.validation_custom_regex_format_label &&
      content == o.content &&
      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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 345

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 416

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 321

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


301
302
303
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 307

def hash
  [type, placeholder, auto_fill_type, link_id, masked, validation_type, validation_custom_regex, validation_custom_regex_format_label, content, 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



231
232
233
234
235
236
237
238
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 231

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



391
392
393
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 391

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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 397

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



385
386
387
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 385

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



242
243
244
245
246
247
248
249
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 242

def valid?
  return false if @type.nil?
  validation_type_validator = EnumAttributeValidator.new('String', ["numbers_only", "letters_only", "phone_number", "bank_routing_number", "bank_account_number", "email_address", "zip_code", "social_security_number", "employer_identification_number", "custom_regex"])
  return false unless validation_type_validator.valid?(@validation_type)
  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