class BudgeaClient::Subscription

Attributes

deleted[RW]

This subscription is not found on the website anymore

disabled[RW]

This subscription has been deleted by user and will not be synchronized anymore

error[RW]

If the last update has failed, the error code

id[RW]

ID of subscription

id_connection[RW]

ID of related connection

id_source[RW]

ID of the related connection source

id_user[RW]

ID of related user

label[RW]

Label of the subscription

last_update[RW]

Last successful update of the subscription

number[RW]

Subscription's number

renewdate[RW]

Next renew date, if any

subscriber[RW]

Name of the subscriber

validity[RW]

The subscription is valid until this date, if any

Public Class Methods

attribute_map() click to toggle source

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

# File lib/budgea_client/models/subscription.rb, line 57
def self.attribute_map
  {
    :'id' => :'id',
    :'id_connection' => :'id_connection',
    :'id_user' => :'id_user',
    :'id_source' => :'id_source',
    :'number' => :'number',
    :'label' => :'label',
    :'subscriber' => :'subscriber',
    :'validity' => :'validity',
    :'renewdate' => :'renewdate',
    :'last_update' => :'last_update',
    :'deleted' => :'deleted',
    :'disabled' => :'disabled',
    :'error' => :'error'
  }
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/subscription.rb, line 96
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_connection')
    self.id_connection = attributes[:'id_connection']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'error')
    self.error = attributes[:'error']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/budgea_client/models/subscription.rb, line 76
def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_connection' => :'Integer',
    :'id_user' => :'Integer',
    :'id_source' => :'Integer',
    :'number' => :'String',
    :'label' => :'String',
    :'subscriber' => :'String',
    :'validity' => :'Date',
    :'renewdate' => :'Date',
    :'last_update' => :'DateTime',
    :'deleted' => :'DateTime',
    :'disabled' => :'DateTime',
    :'error' => :'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/subscription.rb, line 185
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_connection == o.id_connection &&
      id_user == o.id_user &&
      id_source == o.id_source &&
      number == o.number &&
      label == o.label &&
      subscriber == o.subscriber &&
      validity == o.validity &&
      renewdate == o.renewdate &&
      last_update == o.last_update &&
      deleted == o.deleted &&
      disabled == o.disabled &&
      error == o.error
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/subscription.rb, line 239
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/subscription.rb, line 305
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/subscription.rb, line 218
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/subscription.rb, line 205
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/subscription.rb, line 211
def hash
  [id, id_connection, id_user, id_source, number, label, subscriber, validity, renewdate, last_update, deleted, disabled, error].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/subscription.rb, line 157
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

  invalid_properties
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/subscription.rb, line 285
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/subscription.rb, line 291
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/subscription.rb, line 279
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/subscription.rb, line 176
def valid?
  return false if @id.nil?
  return false if @number.nil?
  return false if @label.nil?
  true
end