Class: Dropbox::Sign::SubFormFieldsPerDocumentCheckbox

Inherits:
SubFormFieldsPerDocumentBase show all
Defined in:
lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb

Overview

This class extends ‘SubFormFieldsPerDocumentBase`.

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 = {}) ⇒ SubFormFieldsPerDocumentCheckbox

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 90

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

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

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

Instance Attribute Details

#group ⇒ String

String referencing group defined in ‘form_field_groups` parameter.

Returns:

  • (String) 


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

def group
  @group
end

#is_checked ⇒ Boolean

‘true` for checking the checkbox field by default, otherwise `false`.

Returns:

  • (Boolean) 


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

def is_checked
  @is_checked
end

#type ⇒ String

A yes/no checkbox. Use the ‘SubFormFieldsPerDocumentCheckbox` class.

Returns:

  • (String) 


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

def type
  @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)



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

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.



35
36
37
38
39
40
41
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 35

def self.attribute_map
  {
    :'type' => :'type',
    :'is_checked' => :'is_checked',
    :'group' => :'group'
  }
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



169
170
171
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 169

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

.init(data) ⇒ SubFormFieldsPerDocumentCheckbox

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



81
82
83
84
85
86
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 81

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



64
65
66
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 64

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



74
75
76
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 74

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

.merged_types ⇒ Object

Attribute type mapping of this model + parent



69
70
71
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 69

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 49

def self.openapi_types
  {
    :'type' => :'String',
    :'is_checked' => :'Boolean',
    :'group' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



146
147
148
149
150
151
152
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      is_checked == o.is_checked &&
      group == o.group && 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



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
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 200

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 271

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 176

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


156
157
158
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 162

def hash
  [type, is_checked, group].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



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 123

def list_invalid_properties
  invalid_properties = super
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

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



246
247
248
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 246

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 252

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



240
241
242
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 240

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



138
139
140
141
142
 
# File 'lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb', line 138

def valid?
  return false if @type.nil?
  return false if @is_checked.nil?
  true && super
end