class Wallee::Subscription

Attributes

activated_on[RW]
affiliate[RW]
created_on[RW]
current_product_version[RW]
description[RW]
id[RW]

The ID is the primary key of the entity. The ID identifies the entity uniquely.

initialized_on[RW]
language[RW]
linked_space_id[RW]

The linked space id holds the ID of the space to which the entity belongs to.

planned_purge_date[RW]

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.

planned_termination_date[RW]
reference[RW]
state[RW]
subscriber[RW]
terminated_by[RW]
terminated_on[RW]
terminating_on[RW]
termination_scheduled_on[RW]
token[RW]
version[RW]

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription.rb, line 84
def self.attribute_map
  {
    :'activated_on' => :'activatedOn',
    :'affiliate' => :'affiliate',
    :'created_on' => :'createdOn',
    :'current_product_version' => :'currentProductVersion',
    :'description' => :'description',
    :'id' => :'id',
    :'initialized_on' => :'initializedOn',
    :'language' => :'language',
    :'linked_space_id' => :'linkedSpaceId',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'planned_termination_date' => :'plannedTerminationDate',
    :'reference' => :'reference',
    :'state' => :'state',
    :'subscriber' => :'subscriber',
    :'terminated_by' => :'terminatedBy',
    :'terminated_on' => :'terminatedOn',
    :'terminating_on' => :'terminatingOn',
    :'termination_scheduled_on' => :'terminationScheduledOn',
    :'token' => :'token',
    :'version' => :'version'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription.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?(:'activatedOn')
    self.activated_on = attributes[:'activatedOn']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/wallee-ruby-sdk/models/subscription.rb, line 110
def self.swagger_types
  {
    :'activated_on' => :'DateTime',
    :'affiliate' => :'SubscriptionAffiliate',
    :'created_on' => :'DateTime',
    :'current_product_version' => :'SubscriptionProductVersion',
    :'description' => :'String',
    :'id' => :'Integer',
    :'initialized_on' => :'DateTime',
    :'language' => :'String',
    :'linked_space_id' => :'Integer',
    :'planned_purge_date' => :'DateTime',
    :'planned_termination_date' => :'DateTime',
    :'reference' => :'String',
    :'state' => :'SubscriptionState',
    :'subscriber' => :'Subscriber',
    :'terminated_by' => :'Integer',
    :'terminated_on' => :'DateTime',
    :'terminating_on' => :'DateTime',
    :'termination_scheduled_on' => :'DateTime',
    :'token' => :'Token',
    :'version' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription.rb, line 269
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activated_on == o.activated_on &&
      affiliate == o.affiliate &&
      created_on == o.created_on &&
      current_product_version == o.current_product_version &&
      description == o.description &&
      id == o.id &&
      initialized_on == o.initialized_on &&
      language == o.language &&
      linked_space_id == o.linked_space_id &&
      planned_purge_date == o.planned_purge_date &&
      planned_termination_date == o.planned_termination_date &&
      reference == o.reference &&
      state == o.state &&
      subscriber == o.subscriber &&
      terminated_by == o.terminated_by &&
      terminated_on == o.terminated_on &&
      terminating_on == o.terminating_on &&
      termination_scheduled_on == o.termination_scheduled_on &&
      token == o.token &&
      version == o.version
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/wallee-ruby-sdk/models/subscription.rb, line 330
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 = Wallee.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/wallee-ruby-sdk/models/subscription.rb, line 396
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/wallee-ruby-sdk/models/subscription.rb, line 309
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
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/wallee-ruby-sdk/models/subscription.rb, line 249
def description=(description)
  if !description.nil? && description.to_s.length > 200
    fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 200.'
  end

  @description = description
end
eql?(o) click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription.rb, line 296
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription.rb, line 302
def hash
  [activated_on, affiliate, created_on, current_product_version, description, id, initialized_on, language, linked_space_id, planned_purge_date, planned_termination_date, reference, state, subscriber, terminated_by, terminated_on, terminating_on, termination_scheduled_on, token, version].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/wallee-ruby-sdk/models/subscription.rb, line 226
def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 200
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 200.')
  end

  if !@reference.nil? && @reference.to_s.length > 100
    invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end
reference=(reference) click to toggle source

Custom attribute writer method with validation @param [Object] reference Value to be assigned

# File lib/wallee-ruby-sdk/models/subscription.rb, line 259
def reference=(reference)
  if !reference.nil? && reference.to_s.length > 100
    fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 100.'
  end

  @reference = reference
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/wallee-ruby-sdk/models/subscription.rb, line 376
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/wallee-ruby-sdk/models/subscription.rb, line 382
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/wallee-ruby-sdk/models/subscription.rb, line 370
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/wallee-ruby-sdk/models/subscription.rb, line 241
def valid?
  return false if !@description.nil? && @description.to_s.length > 200
  return false if !@reference.nil? && @reference.to_s.length > 100
  true
end