class BudgeaClient::Connection

Attributes

accounts[RW]
active[RW]

This connection is active and will be automatically synced

all_accounts[RW]
connection[RW]
created[RW]

Creation date

error[RW]

If the last update has failed, the error code

error_message[RW]

If fail, error message received from connector

expire[RW]

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

fields[RW]
id[RW]

ID of connection

id_connector[RW]

ID of the related connector

id_user[RW]

ID of the related user

last_push[RW]

Last successful push

last_update[RW]

Last successful update

message[RW]
next_try[RW]

Date of next synchronization

state[RW]

State of Connection

subscriptions[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/budgea_client/models/connection.rb, line 297
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/budgea_client/models/connection.rb, line 258
def state=(state)
  validator = EnumAttributeValidator.new('String', ['wrongpass', 'additionalInformationNeeded', 'websiteUnavailable', 'actionNeeded', 'SCARequired', 'decoupled', 'passwordExpired', 'webauthRequired', 'rateLimiting', 'bug'])
  unless validator.valid?(state)
    fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/budgea_client/models/connection.rb, line 377
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/budgea_client/models/connection.rb, line 371
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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