class Wallee::Subscriber

A subscriber represents everyone who is subscribed to a product.

Attributes

additional_allowed_payment_method_configurations[RW]

Those payment methods which are allowed additionally will be available even when the product does not allow those methods.

billing_address[RW]
description[RW]

The subscriber description can be used to add a description to the subscriber. This is used in the back office to identify the subscriber.

disallowed_payment_method_configurations[RW]

Those payment methods which are disallowed will not be available to the subscriber even if the product allows those methods.

email_address[RW]

The email address is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.

external_id[RW]

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.

id[RW]

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

language[RW]

The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).

linked_space_id[RW]

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

meta_data[RW]

Meta data allow to store additional data along the object.

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.

reference[RW]

The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).

shipping_address[RW]
state[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/subscriber.rb, line 69
def self.attribute_map
  {
    :'additional_allowed_payment_method_configurations' => :'additionalAllowedPaymentMethodConfigurations',
    :'billing_address' => :'billingAddress',
    :'description' => :'description',
    :'disallowed_payment_method_configurations' => :'disallowedPaymentMethodConfigurations',
    :'email_address' => :'emailAddress',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'language' => :'language',
    :'linked_space_id' => :'linkedSpaceId',
    :'meta_data' => :'metaData',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'reference' => :'reference',
    :'shipping_address' => :'shippingAddress',
    :'state' => :'state',
    :'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/subscriber.rb, line 112
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?(:'additionalAllowedPaymentMethodConfigurations')
    if (value = attributes[:'additionalAllowedPaymentMethodConfigurations']).is_a?(Array)
      self.additional_allowed_payment_method_configurations = value
    end
  end

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

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

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

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

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

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  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?(:'metaData')
    if (value = attributes[:'metaData']).is_a?(Hash)
      self.meta_data = value
    end
  end

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

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

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

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  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/subscriber.rb, line 90
def self.swagger_types
  {
    :'additional_allowed_payment_method_configurations' => :'Array<Integer>',
    :'billing_address' => :'Address',
    :'description' => :'String',
    :'disallowed_payment_method_configurations' => :'Array<Integer>',
    :'email_address' => :'String',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'language' => :'String',
    :'linked_space_id' => :'Integer',
    :'meta_data' => :'Hash<String, String>',
    :'planned_purge_date' => :'DateTime',
    :'reference' => :'String',
    :'shipping_address' => :'Address',
    :'state' => :'CreationEntityState',
    :'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/subscriber.rb, line 245
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_allowed_payment_method_configurations == o.additional_allowed_payment_method_configurations &&
      billing_address == o.billing_address &&
      description == o.description &&
      disallowed_payment_method_configurations == o.disallowed_payment_method_configurations &&
      email_address == o.email_address &&
      external_id == o.external_id &&
      id == o.id &&
      language == o.language &&
      linked_space_id == o.linked_space_id &&
      meta_data == o.meta_data &&
      planned_purge_date == o.planned_purge_date &&
      reference == o.reference &&
      shipping_address == o.shipping_address &&
      state == o.state &&
      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/subscriber.rb, line 301
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/subscriber.rb, line 367
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/subscriber.rb, line 280
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/subscriber.rb, line 215
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
email_address=(email_address) click to toggle source

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

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

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

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

# File lib/wallee-ruby-sdk/models/subscriber.rb, line 267
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/subscriber.rb, line 273
def hash
  [additional_allowed_payment_method_configurations, billing_address, description, disallowed_payment_method_configurations, email_address, external_id, id, language, linked_space_id, meta_data, planned_purge_date, reference, shipping_address, state, 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/subscriber.rb, line 187
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 !@email_address.nil? && @email_address.to_s.length > 254
    invalid_properties.push('invalid value for "email_address", the character length must be smaller than or equal to 254.')
  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/subscriber.rb, line 235
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/subscriber.rb, line 347
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/subscriber.rb, line 353
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/subscriber.rb, line 341
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/subscriber.rb, line 206
def valid?
  return false if !@description.nil? && @description.to_s.length > 200
  return false if !@email_address.nil? && @email_address.to_s.length > 254
  return false if !@reference.nil? && @reference.to_s.length > 100
  true
end