class CyberSource::Ptsv2paymentsRecurringPaymentInformation
This object contains recurring payment information.
Attributes
The date after which no further recurring authorizations should be performed. Format: `YYYY-MM-DD` Note This field is required for recurring transactions.
Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 Example values accepted (31 days): - 31 - 031 - 0031 Note This field is required for recurring transactions.
Total number of payments for the duration of the recurring subscription.
Date of original purchase. Required for recurring transactions. Format: `YYYY-MM-DDTHH:MM:SSZ` Note: If this field is empty, the current date is used.
This field is mandatory for Cartes Bancaires recurring transactions on Credit Mutuel-CIC. This field records recurring sequence, e.g. 1st for initial, 2 for subsequent, 3 etc
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 34 def self.attribute_map { :'end_date' => :'endDate', :'frequency' => :'frequency', :'number_of_payments' => :'numberOfPayments', :'original_purchase_date' => :'originalPurchaseDate', :'sequence_number' => :'sequenceNumber' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.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?(:'endDate') self.end_date = attributes[:'endDate'] end if attributes.has_key?(:'frequency') self.frequency = attributes[:'frequency'] end if attributes.has_key?(:'numberOfPayments') self.number_of_payments = attributes[:'numberOfPayments'] end if attributes.has_key?(:'originalPurchaseDate') self.original_purchase_date = attributes[:'originalPurchaseDate'] end if attributes.has_key?(:'sequenceNumber') self.sequence_number = attributes[:'sequenceNumber'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 45 def self.swagger_types { :'end_date' => :'String', :'frequency' => :'Integer', :'number_of_payments' => :'Integer', :'original_purchase_date' => :'String', :'sequence_number' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 111 def ==(o) return true if self.equal?(o) self.class == o.class && end_date == o.end_date && frequency == o.frequency && number_of_payments == o.number_of_payments && original_purchase_date == o.original_purchase_date && sequence_number == o.sequence_number 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/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 157 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 = CyberSource.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/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 223 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/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 136 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 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
Custom attribute writer method with validation @param [Object] end_date
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 99 def end_date=(end_date) @end_date = end_date end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 123 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 129 def hash [end_date, frequency, number_of_payments, original_purchase_date, sequence_number].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 86 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] original_purchase_date
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 105 def original_purchase_date=(original_purchase_date) @original_purchase_date = original_purchase_date end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 209 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/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 197 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/cybersource_rest_client/models/ptsv2payments_recurring_payment_information.rb, line 93 def valid? true end