class Wallee::SubscriptionSuspensionCreate

Attributes

end_action[RW]

When the suspension reaches the planned end date the end action will be carried out. This action is only executed when the suspension is ended automatically based on the end date.

note[RW]

The note may contain some internal information for the suspension. The note will not be disclosed to the subscriber.

planned_end_date[RW]

The planned end date of the suspension identifies the date on which the suspension will be ended automatically.

subscription[RW]

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_suspension_create.rb, line 36
def self.attribute_map
  {
    :'end_action' => :'endAction',
    :'note' => :'note',
    :'planned_end_date' => :'plannedEndDate',
    :'subscription' => :'subscription'
  }
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_suspension_create.rb, line 57
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?(:'endAction')
    self.end_action = attributes[:'endAction']
  end

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

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

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

Attribute type mapping.

# File lib/wallee-ruby-sdk/models/subscription_suspension_create.rb, line 46
def self.swagger_types
  {
    :'end_action' => :'SubscriptionSuspensionAction',
    :'note' => :'String',
    :'planned_end_date' => :'DateTime',
    :'subscription' => :'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_suspension_create.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_action == o.end_action &&
      note == o.note &&
      planned_end_date == o.planned_end_date &&
      subscription == o.subscription
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_suspension_create.rb, line 170
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_suspension_create.rb, line 236
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_suspension_create.rb, line 149
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/wallee-ruby-sdk/models/subscription_suspension_create.rb, line 136
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_suspension_create.rb, line 142
def hash
  [end_action, note, planned_end_date, subscription].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_suspension_create.rb, line 82
def list_invalid_properties
  invalid_properties = Array.new
  if @end_action.nil?
    invalid_properties.push('invalid value for "end_action", end_action cannot be nil.')
  end

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

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

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

  invalid_properties
end
note=(note) click to toggle source

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

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

  @note = note
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_suspension_create.rb, line 216
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_suspension_create.rb, line 222
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_suspension_create.rb, line 210
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_suspension_create.rb, line 105
def valid?
  return false if @end_action.nil?
  return false if !@note.nil? && @note.to_s.length > 300
  return false if @planned_end_date.nil?
  return false if @subscription.nil?
  true
end