Class: QwilAPI::WriteUserSerializer

Inherits:
Object
  • Object
show all
Defined in:
lib/qwil_api/models/write_user_serializer.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WriteUserSerializer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 129

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.has_key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.has_key?(:'business_name')
    self.business_name = attributes[:'business_name']
  end

  if attributes.has_key?(:'contractor_type')
    self.contractor_type = attributes[:'contractor_type']
  end

  if attributes.has_key?(:'default_account')
    self. = attributes[:'default_account']
  end

  if attributes.has_key?(:'tax_savings_account')
    self. = attributes[:'tax_savings_account']
  end

  if attributes.has_key?(:'tax_savings_percent')
    self.tax_savings_percent = attributes[:'tax_savings_percent']
  end

  if attributes.has_key?(:'use_plaid')
    self.use_plaid = attributes[:'use_plaid']
  end

  if attributes.has_key?(:'use_income_requests')
    self.use_income_requests = attributes[:'use_income_requests']
  end

  if attributes.has_key?(:'use_tax_savings')
    self.use_tax_savings = attributes[:'use_tax_savings']
  end

  if attributes.has_key?(:'is_auto_cashout_enabled')
    self.is_auto_cashout_enabled = attributes[:'is_auto_cashout_enabled']
  end

  if attributes.has_key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.has_key?(:'personal_information')
    self.personal_information = attributes[:'personal_information']
  end

end

Instance Attribute Details

#business_name ⇒ Object

Business name. Only use this field if this user is a business entity.



36
37
38
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 36

def business_name
  @business_name
end

#contractor_type ⇒ Object

Returns the value of attribute contractor_type.



38
39
40
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 38

def contractor_type
  @contractor_type
end

#default_account ⇒ Object

Default account to use for payment of unpaid income.



41
42
43
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 41

def 
  @default_account
end

#email ⇒ Object

Returns the value of attribute email.



27
28
29
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 27

def email
  @email
end

#first_name ⇒ Object

First name, if the user is an individual. Leave blank if this user is a company.



30
31
32
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 30

def first_name
  @first_name
end

#is_auto_cashout_enabled ⇒ Object

Whether or not all income should be immediately cashed out for this user.



59
60
61
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 59

def is_auto_cashout_enabled
  @is_auto_cashout_enabled
end

#last_name ⇒ Object

Last name, if the user is an individual. Leave blank if this user is a company.



33
34
35
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 33

def last_name
  @last_name
end

#password ⇒ Object

Returns the value of attribute password.



61
62
63
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 61

def password
  @password
end

#personal_information ⇒ Object

Returns the value of attribute personal_information.



63
64
65
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 63

def personal_information
  @personal_information
end

#tax_savings_account ⇒ Object

Account to use for tax savings.



44
45
46
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 44

def 
  @tax_savings_account
end

#tax_savings_percent ⇒ Object

The percent of income to be withheld for tax savings purposes.



47
48
49
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 47

def tax_savings_percent
  @tax_savings_percent
end

#use_income_requests ⇒ Object

Feature flag specifying if IncomeRequests should be enabled for this user.



53
54
55
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 53

def use_income_requests
  @use_income_requests
end

#use_plaid ⇒ Object

Feature flag specifying if Plaid integration should be used.



50
51
52
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 50

def use_plaid
  @use_plaid
end

#use_tax_savings ⇒ Object

Feature flag specifying if tax savings should be enabled.



56
57
58
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 56

def use_tax_savings
  @use_tax_savings
end

Class Method Details

.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
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 88

def self.attribute_map
  {
    :'email' => :'email',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'business_name' => :'business_name',
    :'contractor_type' => :'contractor_type',
    :'default_account' => :'default_account',
    :'tax_savings_account' => :'tax_savings_account',
    :'tax_savings_percent' => :'tax_savings_percent',
    :'use_plaid' => :'use_plaid',
    :'use_income_requests' => :'use_income_requests',
    :'use_tax_savings' => :'use_tax_savings',
    :'is_auto_cashout_enabled' => :'is_auto_cashout_enabled',
    :'password' => :'password',
    :'personal_information' => :'personal_information'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 108

def self.swagger_types
  {
    :'email' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'business_name' => :'String',
    :'contractor_type' => :'String',
    :'default_account' => :'String',
    :'tax_savings_account' => :'String',
    :'tax_savings_percent' => :'String',
    :'use_plaid' => :'BOOLEAN',
    :'use_income_requests' => :'BOOLEAN',
    :'use_tax_savings' => :'BOOLEAN',
    :'is_auto_cashout_enabled' => :'BOOLEAN',
    :'password' => :'String',
    :'personal_information' => :'PersonalInformationSerializer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      business_name == o.business_name &&
      contractor_type == o.contractor_type &&
       == o. &&
       == o. &&
      tax_savings_percent == o.tax_savings_percent &&
      use_plaid == o.use_plaid &&
      use_income_requests == o.use_income_requests &&
      use_tax_savings == o.use_tax_savings &&
      is_auto_cashout_enabled == o.is_auto_cashout_enabled &&
      password == o.password &&
      personal_information == o.personal_information
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



276
277
278
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
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 276

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
    temp_model = QwilAPI.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 342

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

#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
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 255

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


242
243
244
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



248
249
250
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 248

def hash
  [email, first_name, last_name, business_name, contractor_type, , , tax_savings_percent, use_plaid, use_income_requests, use_tax_savings, is_auto_cashout_enabled, password, personal_information].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



195
196
197
198
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 195

def list_invalid_properties
  invalid_properties = Array.new
  return 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



322
323
324
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 322

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



328
329
330
331
332
333
334
335
336
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 328

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



316
317
318
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 316

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



202
203
204
205
206
207
 
# File 'lib/qwil_api/models/write_user_serializer.rb', line 202

def valid?
  return false if @email.nil?
  contractor_type_validator = EnumAttributeValidator.new('String', ["INDIVIDUAL", "BUSINESS"])
  return false unless contractor_type_validator.valid?(@contractor_type)
  return true
end