class OpenapiClient::RecurringPaymentDetails
Details about existing gateway schedule.
Attributes
User supplied comments.
Date recurring payment was created.
Invoice number.
Date of next transaction process attempt.
Number of times the recurring payment will process.
Purchase order number.
Times the recurring payment has already run.
Date of mandate signature.
State of the recurring payment.
Store ID number.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/openapi_client/models/recurring_payment_details.rb, line 77 def self.attribute_map { :'store_id' => :'storeId', :'purchase_order_number' => :'purchaseOrderNumber', :'invoice_number' => :'invoiceNumber', :'creation_date' => :'creationDate', :'start_date' => :'startDate', :'next_attempt_date' => :'nextAttemptDate', :'transaction_amount' => :'transactionAmount', :'payment_method_details' => :'paymentMethodDetails', :'frequency' => :'frequency', :'number_of_payments' => :'numberOfPayments', :'run_count' => :'runCount', :'state' => :'state', :'comments' => :'comments' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/openapi_client/models/recurring_payment_details.rb, line 305 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/openapi_client/models/recurring_payment_details.rb, line 116 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::RecurringPaymentDetails` 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 `OpenapiClient::RecurringPaymentDetails`. 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?(:'store_id') self.store_id = attributes[:'store_id'] end if attributes.key?(:'purchase_order_number') self.purchase_order_number = attributes[:'purchase_order_number'] end if attributes.key?(:'invoice_number') self.invoice_number = attributes[:'invoice_number'] end if attributes.key?(:'creation_date') self.creation_date = attributes[:'creation_date'] end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'next_attempt_date') self.next_attempt_date = attributes[:'next_attempt_date'] end if attributes.key?(:'transaction_amount') self.transaction_amount = attributes[:'transaction_amount'] end if attributes.key?(:'payment_method_details') self.payment_method_details = attributes[:'payment_method_details'] end if attributes.key?(:'frequency') self.frequency = attributes[:'frequency'] end if attributes.key?(:'number_of_payments') self.number_of_payments = attributes[:'number_of_payments'] end if attributes.key?(:'run_count') self.run_count = attributes[:'run_count'] end if attributes.key?(:'state') self.state = attributes[:'state'] end if attributes.key?(:'comments') self.comments = attributes[:'comments'] end end
Attribute type mapping.
# File lib/openapi_client/models/recurring_payment_details.rb, line 96 def self.openapi_types { :'store_id' => :'String', :'purchase_order_number' => :'String', :'invoice_number' => :'String', :'creation_date' => :'String', :'start_date' => :'String', :'next_attempt_date' => :'String', :'transaction_amount' => :'Amount', :'payment_method_details' => :'PaymentMethodDetails', :'frequency' => :'Frequency', :'number_of_payments' => :'Integer', :'run_count' => :'Integer', :'state' => :'String', :'comments' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/openapi_client/models/recurring_payment_details.rb, line 272 def ==(o) return true if self.equal?(o) self.class == o.class && store_id == o.store_id && purchase_order_number == o.purchase_order_number && invoice_number == o.invoice_number && creation_date == o.creation_date && start_date == o.start_date && next_attempt_date == o.next_attempt_date && transaction_amount == o.transaction_amount && payment_method_details == o.payment_method_details && frequency == o.frequency && number_of_payments == o.number_of_payments && run_count == o.run_count && state == o.state && comments == o.comments 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/openapi_client/models/recurring_payment_details.rb, line 333 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 klass = OpenapiClient.const_get(type) if klass.respond_to?(:openapi_discriminator_name) klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]]) end klass.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/openapi_client/models/recurring_payment_details.rb, line 407 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/openapi_client/models/recurring_payment_details.rb, line 312 def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) return nil unless attributes.is_a?(Hash) 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[attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[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/openapi_client/models/recurring_payment_details.rb, line 292 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/openapi_client/models/recurring_payment_details.rb, line 298 def hash [store_id, purchase_order_number, invoice_number, creation_date, start_date, next_attempt_date, transaction_amount, payment_method_details, frequency, number_of_payments, run_count, state, comments].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/openapi_client/models/recurring_payment_details.rb, line 184 def list_invalid_properties invalid_properties = Array.new if !@store_id.nil? && @store_id.to_s.length > 20 invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.') end if !@number_of_payments.nil? && @number_of_payments > 999 invalid_properties.push('invalid value for "number_of_payments", must be smaller than or equal to 999.') end if !@number_of_payments.nil? && @number_of_payments < 1 invalid_properties.push('invalid value for "number_of_payments", must be greater than or equal to 1.') end if !@run_count.nil? && @run_count > 999 invalid_properties.push('invalid value for "run_count", must be smaller than or equal to 999.') end if !@run_count.nil? && @run_count < 0 invalid_properties.push('invalid value for "run_count", must be greater than or equal to 0.') end invalid_properties end
Custom attribute writer method with validation @param [Object] number_of_payments
Value to be assigned
# File lib/openapi_client/models/recurring_payment_details.rb, line 234 def number_of_payments=(number_of_payments) if !number_of_payments.nil? && number_of_payments > 999 fail ArgumentError, 'invalid value for "number_of_payments", must be smaller than or equal to 999.' end if !number_of_payments.nil? && number_of_payments < 1 fail ArgumentError, 'invalid value for "number_of_payments", must be greater than or equal to 1.' end @number_of_payments = number_of_payments end
Custom attribute writer method with validation @param [Object] run_count
Value to be assigned
# File lib/openapi_client/models/recurring_payment_details.rb, line 248 def run_count=(run_count) if !run_count.nil? && run_count > 999 fail ArgumentError, 'invalid value for "run_count", must be smaller than or equal to 999.' end if !run_count.nil? && run_count < 0 fail ArgumentError, 'invalid value for "run_count", must be greater than or equal to 0.' end @run_count = run_count end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/openapi_client/models/recurring_payment_details.rb, line 262 def state=(state) validator = EnumAttributeValidator.new('String', ["Installed", "Inactivated", "Cancelled"]) unless validator.valid?(state) fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}." end @state = state end
Custom attribute writer method with validation @param [Object] store_id
Value to be assigned
# File lib/openapi_client/models/recurring_payment_details.rb, line 224 def store_id=(store_id) if !store_id.nil? && store_id.to_s.length > 20 fail ArgumentError, 'invalid value for "store_id", the character length must be smaller than or equal to 20.' end @store_id = store_id end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/openapi_client/models/recurring_payment_details.rb, line 389 def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) hash = {} attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/openapi_client/models/recurring_payment_details.rb, line 377 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/openapi_client/models/recurring_payment_details.rb, line 211 def valid? return false if !@store_id.nil? && @store_id.to_s.length > 20 return false if !@number_of_payments.nil? && @number_of_payments > 999 return false if !@number_of_payments.nil? && @number_of_payments < 1 return false if !@run_count.nil? && @run_count > 999 return false if !@run_count.nil? && @run_count < 0 state_validator = EnumAttributeValidator.new('String', ["Installed", "Inactivated", "Cancelled"]) return false unless state_validator.valid?(@state) true end