Class: SignWell::CheckboxGroupsInner

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckboxGroupsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
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
156
157
158
159
160
161
162
163
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 108

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

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

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

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

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

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

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

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

Instance Attribute Details

#checkbox_ids ⇒ Object

Returns the value of attribute checkbox_ids.



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

def checkbox_ids
  @checkbox_ids
end

#exact_value ⇒ Object

The exact number of checkboxes that must be checked in the group. (Only for validation: exact)



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

def exact_value
  @exact_value
end

#group_name ⇒ Object

A unique identifier for the checkbox group.



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

def group_name
  @group_name
end

#max_value ⇒ Object

The maximum number of checkboxes that can be checked in the group. (Only for validation: maximum and range)



35
36
37
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 35

def max_value
  @max_value
end

#min_value ⇒ Object

The minimum number of checkboxes that must be checked in the group. (Only for validation: minimum and range)



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

def min_value
  @min_value
end

#recipient_id ⇒ Object

The recipient ID associated with the checkbox group.



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

def recipient_id
  @recipient_id
end

#required ⇒ Object

Whether the group must be completed by the recipient. Defaults to false.



29
30
31
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 29

def required
  @required
end

#validation ⇒ Object

Returns the value of attribute validation.



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

def validation
  @validation
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



279
280
281
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
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 279

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



77
78
79
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 82

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 63

def self.attribute_map
  {
    :'group_name' => :'group_name',
    :'recipient_id' => :'recipient_id',
    :'checkbox_ids' => :'checkbox_ids',
    :'validation' => :'validation',
    :'required' => :'required',
    :'min_value' => :'min_value',
    :'max_value' => :'max_value',
    :'exact_value' => :'exact_value'
  }
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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 255

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



101
102
103
104
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 87

def self.openapi_types
  {
    :'group_name' => :'String',
    :'recipient_id' => :'String',
    :'checkbox_ids' => :'Array<String>',
    :'validation' => :'CheckboxValidation',
    :'required' => :'Boolean',
    :'min_value' => :'Integer',
    :'max_value' => :'Integer',
    :'exact_value' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      group_name == o.group_name &&
      recipient_id == o.recipient_id &&
      checkbox_ids == o.checkbox_ids &&
      validation == o.validation &&
      required == o.required &&
      min_value == o.min_value &&
      max_value == o.max_value &&
      exact_value == o.exact_value
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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 350

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


242
243
244
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 248

def hash
  [group_name, recipient_id, checkbox_ids, validation, required, min_value, max_value, exact_value].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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 167

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

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

  if @checkbox_ids.nil?
    invalid_properties.push('invalid value for "checkbox_ids", checkbox_ids 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



326
327
328
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 326

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 332

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



320
321
322
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 320

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



187
188
189
190
191
192
193
 
# File 'lib/signwell_sdk/models/checkbox_groups_inner.rb', line 187

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @group_name.nil?
  return false if @recipient_id.nil?
  return false if @checkbox_ids.nil?
  true
end