Class: SignWell::DocumentResponseFieldsInnerInner

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/models/document_response_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 = {}) ⇒ DocumentResponseFieldsInnerInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::DocumentResponseFieldsInnerInner` 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::DocumentResponseFieldsInnerInner`. 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')
    self.recipient = attributes[:'recipient']
  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?(:'date_format')
    self.date_format = attributes[:'date_format']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_other ⇒ Object

Whether \"Other\" option is allowed



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

def allow_other
  @allow_other
end

#api_id ⇒ Object

Returns the value of attribute api_id.



26
27
28
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 26

def api_id
  @api_id
end

#date_format ⇒ Object

Returns the value of attribute date_format.



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

def date_format
  @date_format
end

#default_option ⇒ Object

Default selected option



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

def default_option
  @default_option
end

#fixed_width ⇒ Object

Returns the value of attribute fixed_width.



32
33
34
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 32

def fixed_width
  @fixed_width
end

#height ⇒ Object

Returns the value of attribute height.



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

def height
  @height
end

#label ⇒ Object

Returns the value of attribute label.



34
35
36
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 34

def label
  @label
end

#lock_sign_date ⇒ Object

Returns the value of attribute lock_sign_date.



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

def lock_sign_date
  @lock_sign_date
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#options ⇒ Object

Dropdown options (for dropdown/select fields)



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

def options
  @options
end

#page ⇒ Object

Returns the value of attribute page.



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

def page
  @page
end

#placeholder_name ⇒ Object

Returns the value of attribute placeholder_name.



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

def placeholder_name
  @placeholder_name
end

#recipient ⇒ Object

Returns the value of attribute recipient.



24
25
26
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 24

def recipient
  @recipient
end

#recipient_id ⇒ Object

Returns the value of attribute recipient_id.



50
51
52
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 50

def recipient_id
  @recipient_id
end

#required ⇒ Object

Returns the value of attribute required.



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

def required
  @required
end

#signing_elements_group_id ⇒ Object

Returns the value of attribute signing_elements_group_id.



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

def signing_elements_group_id
  @signing_elements_group_id
end

#type ⇒ Object

Returns the value of attribute type.



40
41
42
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 40

def type
  @type
end

#validation ⇒ Object

Returns the value of attribute validation.



42
43
44
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 42

def validation
  @validation
end

#value ⇒ Object

Returns the value of attribute value.



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

def value
  @value
end

#width ⇒ Object

Returns the value of attribute width.



48
49
50
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 48

def width
  @width
end

#x ⇒ Object

Returns the value of attribute x.



18
19
20
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 18

def x
  @x
end

#y ⇒ Object

Returns the value of attribute y.



20
21
22
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 20

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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 403

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



116
117
118
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 116

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



121
122
123
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 121

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 88

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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 379

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



154
155
156
157
158
159
160
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 154

def self.openapi_nullable
  Set.new([
    :'name',
    :'value',
    :'recipient_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 337

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



474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 474

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


366
367
368
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 366

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



372
373
374
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 372

def hash
  [x, y, page, recipient, api_id, name, date_format, fixed_width, label, lock_sign_date, required, type, validation, value, height, width, recipient_id, signing_elements_group_id, placeholder_name, 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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 277

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

  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



450
451
452
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 450

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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 456

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



444
445
446
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 444

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



297
298
299
300
301
302
303
 
# File 'lib/signwell_sdk/models/document_response_fields_inner_inner.rb', line 297

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