Class: BudgeaClient::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/models/connection.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Connection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/budgea_client/models/connection.rb', line 137

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'active')
    self.active = attributes[:'active']
  else
    self.active = true
  end

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

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

  if attributes.has_key?(:'fields')
    if (value = attributes[:'fields']).is_a?(Array)
      self.fields = value
    end
  end

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

  if attributes.has_key?(:'accounts')
    if (value = attributes[:'accounts']).is_a?(Array)
      self.accounts = value
    end
  end

  if attributes.has_key?(:'all_accounts')
    if (value = attributes[:'all_accounts']).is_a?(Array)
      self.all_accounts = value
    end
  end

  if attributes.has_key?(:'subscriptions')
    if (value = attributes[:'subscriptions']).is_a?(Array)
      self.subscriptions = value
    end
  end

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

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

Instance Attribute Details

#accounts ⇒ Object

Returns the value of attribute accounts.



55
56
57
 
# File 'lib/budgea_client/models/connection.rb', line 55

def accounts
  @accounts
end

#active ⇒ Object

This connection is active and will be automatically synced



42
43
44
 
# File 'lib/budgea_client/models/connection.rb', line 42

def active
  @active
end

#all_accounts ⇒ Object

Returns the value of attribute all_accounts.



57
58
59
 
# File 'lib/budgea_client/models/connection.rb', line 57

def all_accounts
  @all_accounts
end

#connection ⇒ Object

Returns the value of attribute connection.



61
62
63
 
# File 'lib/budgea_client/models/connection.rb', line 61

def connection
  @connection
end

#created ⇒ Object

Creation date



30
31
32
 
# File 'lib/budgea_client/models/connection.rb', line 30

def created
  @created
end

#error ⇒ Object

If the last update has failed, the error code



33
34
35
 
# File 'lib/budgea_client/models/connection.rb', line 33

def error
  @error
end

#error_message ⇒ Object

If fail, error message received from connector



36
37
38
 
# File 'lib/budgea_client/models/connection.rb', line 36

def error_message
  @error_message
end

#expire ⇒ Object

Expiration of the connection. Used during add of a two-factor authentication, to purge the connection if the user abort



39
40
41
 
# File 'lib/budgea_client/models/connection.rb', line 39

def expire
  @expire
end

#fields ⇒ Object

Returns the value of attribute fields.



50
51
52
 
# File 'lib/budgea_client/models/connection.rb', line 50

def fields
  @fields
end

#id ⇒ Object

ID of connection



18
19
20
 
# File 'lib/budgea_client/models/connection.rb', line 18

def id
  @id
end

#id_connector ⇒ Object

ID of the related connector



24
25
26
 
# File 'lib/budgea_client/models/connection.rb', line 24

def id_connector
  @id_connector
end

#id_user ⇒ Object

ID of the related user



21
22
23
 
# File 'lib/budgea_client/models/connection.rb', line 21

def id_user
  @id_user
end

#last_push ⇒ Object

Last successful push



45
46
47
 
# File 'lib/budgea_client/models/connection.rb', line 45

def last_push
  @last_push
end

#last_update ⇒ Object

Last successful update



27
28
29
 
# File 'lib/budgea_client/models/connection.rb', line 27

def last_update
  @last_update
end

#message ⇒ Object

Returns the value of attribute message.



63
64
65
 
# File 'lib/budgea_client/models/connection.rb', line 63

def message
  @message
end

#next_try ⇒ Object

Date of next synchronization



53
54
55
 
# File 'lib/budgea_client/models/connection.rb', line 53

def next_try
  @next_try
end

#state ⇒ Object

State of Connection



48
49
50
 
# File 'lib/budgea_client/models/connection.rb', line 48

def state
  @state
end

#subscriptions ⇒ Object

Returns the value of attribute subscriptions.



59
60
61
 
# File 'lib/budgea_client/models/connection.rb', line 59

def subscriptions
  @subscriptions
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
106
107
108
109
 
# File 'lib/budgea_client/models/connection.rb', line 88

def self.attribute_map
  {
    :'id' => :'id',
    :'id_user' => :'id_user',
    :'id_connector' => :'id_connector',
    :'last_update' => :'last_update',
    :'created' => :'created',
    :'error' => :'error',
    :'error_message' => :'error_message',
    :'expire' => :'expire',
    :'active' => :'active',
    :'last_push' => :'last_push',
    :'state' => :'state',
    :'fields' => :'fields',
    :'next_try' => :'next_try',
    :'accounts' => :'accounts',
    :'all_accounts' => :'all_accounts',
    :'subscriptions' => :'subscriptions',
    :'connection' => :'connection',
    :'message' => :'message'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/budgea_client/models/connection.rb', line 112

def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_user' => :'Integer',
    :'id_connector' => :'Integer',
    :'last_update' => :'DateTime',
    :'created' => :'DateTime',
    :'error' => :'String',
    :'error_message' => :'String',
    :'expire' => :'DateTime',
    :'active' => :'BOOLEAN',
    :'last_push' => :'DateTime',
    :'state' => :'String',
    :'fields' => :'Array<Field>',
    :'next_try' => :'DateTime',
    :'accounts' => :'Array<Account>',
    :'all_accounts' => :'Array<Account>',
    :'subscriptions' => :'Array<Subscription>',
    :'connection' => :'Connection',
    :'message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/budgea_client/models/connection.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_user == o.id_user &&
      id_connector == o.id_connector &&
      last_update == o.last_update &&
      created == o.created &&
      error == o.error &&
      error_message == o.error_message &&
      expire == o.expire &&
      active == o.active &&
      last_push == o.last_push &&
      state == o.state &&
      fields == o.fields &&
      next_try == o.next_try &&
      accounts == o.accounts &&
      all_accounts == o.all_accounts &&
      subscriptions == o.subscriptions &&
      connection == o.connection &&
      message == o.message
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



331
332
333
334
335
336
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
363
364
365
366
367
 
# File 'lib/budgea_client/models/connection.rb', line 331

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 =~ /\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
    temp_model = BudgeaClient.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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/budgea_client/models/connection.rb', line 397

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/budgea_client/models/connection.rb', line 310

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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[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


297
298
299
 
# File 'lib/budgea_client/models/connection.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/budgea_client/models/connection.rb', line 303

def hash
  [id, id_user, id_connector, last_update, created, error, error_message, expire, active, last_push, state, fields, next_try, accounts, all_accounts, subscriptions, connection, message].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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/budgea_client/models/connection.rb', line 228

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

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

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



377
378
379
 
# File 'lib/budgea_client/models/connection.rb', line 377

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



383
384
385
386
387
388
389
390
391
 
# File 'lib/budgea_client/models/connection.rb', line 383

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



371
372
373
 
# File 'lib/budgea_client/models/connection.rb', line 371

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



247
248
249
250
251
252
253
254
 
# File 'lib/budgea_client/models/connection.rb', line 247

def valid?
  return false if @id.nil?
  return false if @id_connector.nil?
  return false if @active.nil?
  state_validator = EnumAttributeValidator.new('String', ['wrongpass', 'additionalInformationNeeded', 'websiteUnavailable', 'actionNeeded', 'SCARequired', 'decoupled', 'passwordExpired', 'webauthRequired', 'rateLimiting', 'bug'])
  return false unless state_validator.valid?(@state)
  true
end