class Wallee::SubscriptionProductActive
A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.
Attributes
The allowed payment method configurations control which payment methods can be used with this product. When none is selected all methods will be allowed.
When a payment fails, the subscription to which the payment belongs to will be suspended. When the suspension is not removed within the specified period the subscription will be terminated. A payment is considered as failed when the subscriber issues a refund or when a subscription charge fails.
The ID is the primary key of the entity. The ID identifies the entity uniquely.
The product name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
Marks the product as locked. Meaning that customer can not change away from this product or change to this product later on.
The sort order controls in which order the product is listed. The sort order is used to order the products in ascending order.
The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 48 def self.attribute_map { :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations', :'failed_payment_suspension_period' => :'failedPaymentSuspensionPeriod', :'name' => :'name', :'product_locked' => :'productLocked', :'sort_order' => :'sortOrder', :'state' => :'state', :'id' => :'id', :'version' => :'version' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 77 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?(:'allowedPaymentMethodConfigurations') if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array) self.allowed_payment_method_configurations = value end end if attributes.has_key?(:'failedPaymentSuspensionPeriod') self.failed_payment_suspension_period = attributes[:'failedPaymentSuspensionPeriod'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'productLocked') self.product_locked = attributes[:'productLocked'] end if attributes.has_key?(:'sortOrder') self.sort_order = attributes[:'sortOrder'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end end
Attribute type mapping.
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 62 def self.swagger_types { :'allowed_payment_method_configurations' => :'Array<Integer>', :'failed_payment_suspension_period' => :'String', :'name' => :'String', :'product_locked' => :'BOOLEAN', :'sort_order' => :'Integer', :'state' => :'SubscriptionProductState', :'id' => :'Integer', :'version' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 158 def ==(o) return true if self.equal?(o) self.class == o.class && allowed_payment_method_configurations == o.allowed_payment_method_configurations && failed_payment_suspension_period == o.failed_payment_suspension_period && name == o.name && product_locked == o.product_locked && sort_order == o.sort_order && state == o.state && id == o.id && version == o.version end
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_product_active.rb, line 207 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
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_product_active.rb, line 273 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
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_product_active.rb, line 186 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
@see the `==` method @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 173 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 179 def hash [allowed_payment_method_configurations, failed_payment_suspension_period, name, product_locked, sort_order, state, id, version].hash end
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_product_active.rb, line 120 def list_invalid_properties invalid_properties = Array.new if !@name.nil? && @name.to_s.length > 100 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.') end if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @version.nil? invalid_properties.push('invalid value for "version", version cannot be nil.') end invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 148 def name=(name) if !name.nil? && name.to_s.length > 100 fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.' end @name = name end
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_product_active.rb, line 259 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/wallee-ruby-sdk/models/subscription_product_active.rb, line 247 def to_s to_hash.to_s end
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_product_active.rb, line 139 def valid? return false if !@name.nil? && @name.to_s.length > 100 return false if @id.nil? return false if @version.nil? true end