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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 140

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
  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: " + 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 = '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
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

#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_attributes ⇒ Object

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



89
90
91
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 89

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.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 75

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'
  }
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



251
252
253
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 251

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:



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

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



94
95
96
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 94

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



124
125
126
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 124

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

.merged_types ⇒ Object

Attribute type mapping of this model + parent



113
114
115
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 113

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 99

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 223

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 && 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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 282

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 :File
    value
  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
    # models (e.g. Pet)
    klass = Dropbox::Sign.const_get(type)
    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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 356

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 258

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


238
239
240
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 244

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



193
194
195
196
197
198
199
200
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 193

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



331
332
333
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 331

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 337

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



325
326
327
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 325

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



204
205
206
207
208
209
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_text.rb', line 204

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)
  true && super
end