class Yapstone::InstallmentPlan
If you will be collecting a total amount in multiple installments, use this to specify which installment this payment is.
Attributes
The payment installment number represents the installment the customer is on. For example if you had a total of four payments, and the customer was on their third payment, the installmentNumber would be 3.
This is the overall number of installments a customer will be paying. For example, if the customer was paying four installments total, this number would be 4.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/yapstone-payments/models/installment_plan.rb, line 25 def self.attribute_map { :'installment_number' => :'installmentNumber', :'total_installments' => :'totalInstallments' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/yapstone-payments/models/installment_plan.rb, line 101 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/yapstone-payments/models/installment_plan.rb, line 42 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::InstallmentPlan` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Yapstone::InstallmentPlan`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'installment_number') self.installment_number = attributes[:'installment_number'] end if attributes.key?(:'total_installments') self.total_installments = attributes[:'total_installments'] end end
Attribute type mapping.
# File lib/yapstone-payments/models/installment_plan.rb, line 33 def self.openapi_types { :'installment_number' => :'Integer', :'total_installments' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/yapstone-payments/models/installment_plan.rb, line 79 def ==(o) return true if self.equal?(o) self.class == o.class && installment_number == o.installment_number && total_installments == o.total_installments 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/yapstone-payments/models/installment_plan.rb, line 129 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 Yapstone.const_get(type).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/yapstone-payments/models/installment_plan.rb, line 194 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/yapstone-payments/models/installment_plan.rb, line 108 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_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/yapstone-payments/models/installment_plan.rb, line 88 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/yapstone-payments/models/installment_plan.rb, line 94 def hash [installment_number, total_installments].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/yapstone-payments/models/installment_plan.rb, line 66 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/yapstone-payments/models/installment_plan.rb, line 180 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/yapstone-payments/models/installment_plan.rb, line 168 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/yapstone-payments/models/installment_plan.rb, line 73 def valid? true end