class Wallee::ProductPeriodFeeUpdate
Attributes
The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.
The ID is the primary key of the entity. The ID identifies the entity uniquely.
The ledger entry title will be used for the title in the ledger entry and in the invoice.
The name of the fee should describe for the subscriber in few words for what the fee is for.
The number of free trial periods specify how many periods are free of charge at the begining of the subscription.
The period fee is charged for every period of the subscription except for those periods which are trial periods.
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/product_period_fee_update.rb, line 48 def self.attribute_map { :'id' => :'id', :'version' => :'version', :'component' => :'component', :'description' => :'description', :'ledger_entry_title' => :'ledgerEntryTitle', :'name' => :'name', :'number_of_free_trial_periods' => :'numberOfFreeTrialPeriods', :'period_fee' => :'periodFee' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/wallee-ruby-sdk/models/product_period_fee_update.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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end if attributes.has_key?(:'component') self.component = attributes[:'component'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'ledgerEntryTitle') self.ledger_entry_title = attributes[:'ledgerEntryTitle'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'numberOfFreeTrialPeriods') self.number_of_free_trial_periods = attributes[:'numberOfFreeTrialPeriods'] end if attributes.has_key?(:'periodFee') if (value = attributes[:'periodFee']).is_a?(Array) self.period_fee = value end end end
Attribute type mapping.
# File lib/wallee-ruby-sdk/models/product_period_fee_update.rb, line 62 def self.swagger_types { :'id' => :'Integer', :'version' => :'Integer', :'component' => :'Integer', :'description' => :'DatabaseTranslatedStringCreate', :'ledger_entry_title' => :'DatabaseTranslatedStringCreate', :'name' => :'DatabaseTranslatedStringCreate', :'number_of_free_trial_periods' => :'Integer', :'period_fee' => :'Array<PersistableCurrencyAmountUpdate>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/product_period_fee_update.rb, line 143 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && version == o.version && component == o.component && description == o.description && ledger_entry_title == o.ledger_entry_title && name == o.name && number_of_free_trial_periods == o.number_of_free_trial_periods && period_fee == o.period_fee 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/product_period_fee_update.rb, line 192 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/product_period_fee_update.rb, line 258 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/product_period_fee_update.rb, line 171 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/product_period_fee_update.rb, line 158 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/wallee-ruby-sdk/models/product_period_fee_update.rb, line 164 def hash [id, version, component, description, ledger_entry_title, name, number_of_free_trial_periods, period_fee].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/product_period_fee_update.rb, line 120 def list_invalid_properties invalid_properties = Array.new 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/wallee-ruby-sdk/models/product_period_fee_update.rb, line 244 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/product_period_fee_update.rb, line 232 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/product_period_fee_update.rb, line 135 def valid? return false if @id.nil? return false if @version.nil? true end