Class: FireflyIIIClient::User

Inherits:
Object
  • Object
show all
Defined in:
lib/firefly_iii_client/models/user.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/firefly_iii_client/models/user.rb', line 95

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FireflyIIIClient::User` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FireflyIIIClient::User`. 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
  }

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

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

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

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

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

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

Instance Attribute Details

#blocked ⇒ Object

Boolean to indicate if the user is blocked.



26
27
28
 
# File 'lib/firefly_iii_client/models/user.rb', line 26

def blocked
  @blocked
end

#blocked_code ⇒ Object

If you say the user must be blocked, this will be the reason code.



29
30
31
 
# File 'lib/firefly_iii_client/models/user.rb', line 29

def blocked_code
  @blocked_code
end

#created_at ⇒ Object

Returns the value of attribute created_at.



18
19
20
 
# File 'lib/firefly_iii_client/models/user.rb', line 18

def created_at
  @created_at
end

#email ⇒ Object

The new users email address.



23
24
25
 
# File 'lib/firefly_iii_client/models/user.rb', line 23

def email
  @email
end

#role ⇒ Object

Role for the new user. Can be empty or omitted.



32
33
34
 
# File 'lib/firefly_iii_client/models/user.rb', line 32

def role
  @role
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



20
21
22
 
# File 'lib/firefly_iii_client/models/user.rb', line 20

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/firefly_iii_client/models/user.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/firefly_iii_client/models/user.rb', line 57

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'email' => :'email',
    :'blocked' => :'blocked',
    :'blocked_code' => :'blocked_code',
    :'role' => :'role'
  }
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



203
204
205
 
# File 'lib/firefly_iii_client/models/user.rb', line 203

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
90
91
 
# File 'lib/firefly_iii_client/models/user.rb', line 86

def self.openapi_nullable
  Set.new([
    :'blocked_code',
    :'role'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/firefly_iii_client/models/user.rb', line 74

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'email' => :'String',
    :'blocked' => :'Boolean',
    :'blocked_code' => :'String',
    :'role' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/firefly_iii_client/models/user.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      email == o.email &&
      blocked == o.blocked &&
      blocked_code == o.blocked_code &&
      role == o.role
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



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
 
# File 'lib/firefly_iii_client/models/user.rb', line 233

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
    # models (e.g. Pet) or oneOf
    klass = FireflyIIIClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/firefly_iii_client/models/user.rb', line 304

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/firefly_iii_client/models/user.rb', line 210

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/firefly_iii_client/models/user.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



196
197
198
 
# File 'lib/firefly_iii_client/models/user.rb', line 196

def hash
  [created_at, updated_at, email, blocked, blocked_code, role].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



135
136
137
138
139
140
141
142
 
# File 'lib/firefly_iii_client/models/user.rb', line 135

def list_invalid_properties
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email 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



280
281
282
 
# File 'lib/firefly_iii_client/models/user.rb', line 280

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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/firefly_iii_client/models/user.rb', line 286

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



274
275
276
 
# File 'lib/firefly_iii_client/models/user.rb', line 274

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



146
147
148
149
150
151
152
153
 
# File 'lib/firefly_iii_client/models/user.rb', line 146

def valid?
  return false if @email.nil?
  blocked_code_validator = EnumAttributeValidator.new('String', ["email_changed"])
  return false unless blocked_code_validator.valid?(@blocked_code)
  role_validator = EnumAttributeValidator.new('String', ["owner", "demo"])
  return false unless role_validator.valid?(@role)
  true
end