Class: SignWell::AdditionalFieldsInnerInner

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/models/additional_fields_inner_inner.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdditionalFieldsInnerInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 166

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::AdditionalFieldsInnerInner` 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 (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::AdditionalFieldsInnerInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'x')
    self.x = attributes[:'x']
  else
    self.x = nil
  end

  if attributes.key?(:'y')
    self.y = attributes[:'y']
  else
    self.y = nil
  end

  if attributes.key?(:'page')
    self.page = attributes[:'page']
  else
    self.page = nil
  end

  if attributes.key?(:'recipient_id')
    self.recipient_id = attributes[:'recipient_id']
  else
    self.recipient_id = nil
  end

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

  if attributes.key?(:'required')
    self.required = attributes[:'required']
  else
    self.required = true
  end

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

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

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

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

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

  if attributes.key?(:'fixed_width')
    self.fixed_width = attributes[:'fixed_width']
  else
    self.fixed_width = false
  end

  if attributes.key?(:'lock_sign_date')
    self.lock_sign_date = attributes[:'lock_sign_date']
  else
    self.lock_sign_date = false
  end

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

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

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

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

  if attributes.key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end

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

  if attributes.key?(:'allow_other')
    self.allow_other = attributes[:'allow_other']
  else
    self.allow_other = false
  end
end

Instance Attribute Details

#allow_other ⇒ Object

Whether to allow \"Other\" option with text input (for dropdown/select fields only)



72
73
74
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 72

def allow_other
  @allow_other
end

#api_id ⇒ Object

Unique identifier of the field. Useful when needing to reference specific field values or update a document and its fields.



41
42
43
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 41

def api_id
  @api_id
end

#date_format ⇒ Object

Returns the value of attribute date_format.



54
55
56
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 54

def date_format
  @date_format
end

#default_option ⇒ Object

Default selected option (for dropdown/select fields only)



69
70
71
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 69

def default_option
  @default_option
end

#fixed_width ⇒ Object

Text fields only: whether the field width will stay fixed and text will display in multiple lines, rather than one long line. If set to false the field width will automatically grow horizontally to fit text on one line. Defaults to false.



49
50
51
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 49

def fixed_width
  @fixed_width
end

#formula ⇒ Object

Date fields only (text field formulas coming soon): formulas are a way to prefill fields with calculated future or past dates. Addition, subtraction, and parentheses are allowed. Valid event dates are created_date, sent_date, and signed_date. Valid time periods are day, days, week, weeks, month, and months. Example: formula: 'sent_date + 10 days'. Use with lock_sign_date if you'd like to make the field readonly and prevent signers from choosing a different date.



57
58
59
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 57

def formula
  @formula
end

#height ⇒ Object

Height of the field (in pixels). Maximum height varies by field type: Signature/Initials (200px), others (74px). When using text tags if the height is greater than the maximum height, the height will be set to the maximum height.



60
61
62
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 60

def height
  @height
end

#label ⇒ Object

Text and Date fields only: label that is displayed when the field is empty.



36
37
38
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 36

def label
  @label
end

#lock_sign_date ⇒ Object

Date fields only: makes fields readonly and automatically populates with the date the recipient signed. Defaults to false.



52
53
54
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 52

def lock_sign_date
  @lock_sign_date
end

#name ⇒ Object

Checkbox fields only. At least 2 checkbox fields in an array of fields must be assigned to the same recipient and grouped with selection requirements.



44
45
46
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 44

def name
  @name
end

#options ⇒ Object

Array of dropdown options (for dropdown/select fields only)



66
67
68
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 66

def options
  @options
end

#page ⇒ Object

The page number within the file. If the page does not exist within the file then the field won't be created.



25
26
27
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 25

def page
  @page
end

#recipient_id ⇒ Object

Unique identifier of the recipient assigned to the field. Recipients assigned to fields will be the only ones that will see and be able to complete those fields.



28
29
30
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 28

def recipient_id
  @recipient_id
end

#required ⇒ Object

Whether the field must be completed by the recipient. Defaults to true except for checkbox type fields.



33
34
35
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 33

def required
  @required
end

#type ⇒ Object

Returns the value of attribute type.



30
31
32
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 30

def type
  @type
end

#validation ⇒ Object

Returns the value of attribute validation.



46
47
48
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 46

def validation
  @validation
end

#value ⇒ Object

Returns the value of attribute value.



38
39
40
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 38

def value
  @value
end

#width ⇒ Object

Width of the field (in pixels). For text fields, width will auto-grow unless fixed_width is true.



63
64
65
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 63

def width
  @width
end

#x ⇒ Object

Horizontal value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located.



19
20
21
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 19

def x
  @x
end

#y ⇒ Object

Vertical value in the coordinates of the field (in pixels). Coordinates are specific to the page where fields are located.



22
23
24
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 22

def y
  @y
end

Class Method Details

._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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 437

def self._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
    # models (e.g. Pet) or oneOf
    klass = SignWell.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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



123
124
125
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 123

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



128
129
130
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 128

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 97

def self.attribute_map
  {
    :'x' => :'x',
    :'y' => :'y',
    :'page' => :'page',
    :'recipient_id' => :'recipient_id',
    :'type' => :'type',
    :'required' => :'required',
    :'label' => :'label',
    :'value' => :'value',
    :'api_id' => :'api_id',
    :'name' => :'name',
    :'validation' => :'validation',
    :'fixed_width' => :'fixed_width',
    :'lock_sign_date' => :'lock_sign_date',
    :'date_format' => :'date_format',
    :'formula' => :'formula',
    :'height' => :'height',
    :'width' => :'width',
    :'options' => :'options',
    :'default_option' => :'default_option',
    :'allow_other' => :'allow_other'
  }
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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 413

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



159
160
161
162
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 159

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

.openapi_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 133

def self.openapi_types
  {
    :'x' => :'Float',
    :'y' => :'Float',
    :'page' => :'Integer',
    :'recipient_id' => :'String',
    :'type' => :'FieldType',
    :'required' => :'Boolean',
    :'label' => :'String',
    :'value' => :'AdditionalFieldsInnerInnerValue',
    :'api_id' => :'String',
    :'name' => :'String',
    :'validation' => :'TextValidation',
    :'fixed_width' => :'Boolean',
    :'lock_sign_date' => :'Boolean',
    :'date_format' => :'DateFormat',
    :'formula' => :'String',
    :'height' => :'Float',
    :'width' => :'Float',
    :'options' => :'Array<DropdownOption>',
    :'default_option' => :'String',
    :'allow_other' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 373

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      x == o.x &&
      y == o.y &&
      page == o.page &&
      recipient_id == o.recipient_id &&
      type == o.type &&
      required == o.required &&
      label == o.label &&
      value == o.value &&
      api_id == o.api_id &&
      name == o.name &&
      validation == o.validation &&
      fixed_width == o.fixed_width &&
      lock_sign_date == o.lock_sign_date &&
      date_format == o.date_format &&
      formula == o.formula &&
      height == o.height &&
      width == o.width &&
      options == o.options &&
      default_option == o.default_option &&
      allow_other == o.allow_other
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



508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 508

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


400
401
402
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 400

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



406
407
408
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 406

def hash
  [x, y, page, recipient_id, type, required, label, value, api_id, name, validation, fixed_width, lock_sign_date, date_format, formula, height, width, options, default_option, allow_other].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



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
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 283

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @x.nil?
    invalid_properties.push('invalid value for "x", x cannot be nil.')
  end

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

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

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

  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



484
485
486
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 484

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



490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 490

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

    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



478
479
480
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 478

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



311
312
313
314
315
316
317
318
319
 
# File 'lib/signwell_sdk/models/additional_fields_inner_inner.rb', line 311

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @x.nil?
  return false if @y.nil?
  return false if @page.nil?
  return false if @recipient_id.nil?
  return false if @type.nil?
  true
end