class Bfwd::DunningLine
A dunning-line specifies when the next execution attempt of an unpaid invoice should take place given the number of existing execution attempts.
Attributes
{ "description" : "The payment attempt this dunning line applies to, specified as a positive integer. Dunning lines are ZERO indexed.", "verbs":["POST","PUT","GET"] }
{ "description" : "ID of the user who last updated the entity.", "verbs":[] }
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{ "description" : "Has the dunning-line been deleted?", "verbs":["POST","PUT","GET"] }
{ "description" : "The payment gateway to use for this payment attempt.", "verbs":["POST","PUT","GET"] }
{ "description" : "ID of the dunning-line.", "verbs":["GET"] }
{ "description" : "The time before the next payment attempt in minutes.", "verbs":["POST","PUT","GET"] }
{ "description" : "organization associated with the dunning-line.", "verbs":["POST","PUT","GET"] }
{ "description" : "ID of the organization associated with the dunning-line.", "verbs":["POST","PUT","GET"] }
{ "description" : "ID of the organization associated with the dunning-line.", "verbs":["POST","PUT","GET"] }
{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/dunning_line.rb, line 74 def self.attribute_map { :'created' => :'created', :'changed_by' => :'changedBy', :'updated' => :'updated', :'id' => :'id', :'organization_id' => :'organizationID', :'type' => :'type', :'attempt_ix' => :'attemptIx', :'minutes_delay' => :'minutesDelay', :'gateway' => :'gateway', :'deleted' => :'deleted', :'organization' => :'organization' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/dunning_line.rb, line 109 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?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'changedBy') self.changed_by = attributes[:'changedBy'] end if attributes.has_key?(:'updated') self.updated = attributes[:'updated'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'attemptIx') self.attempt_ix = attributes[:'attemptIx'] end if attributes.has_key?(:'minutesDelay') self.minutes_delay = attributes[:'minutesDelay'] end if attributes.has_key?(:'gateway') self.gateway = attributes[:'gateway'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] else self.deleted = false end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/dunning_line.rb, line 91 def self.swagger_types { :'created' => :'DateTime', :'changed_by' => :'String', :'updated' => :'DateTime', :'id' => :'String', :'organization_id' => :'String', :'type' => :'String', :'attempt_ix' => :'Integer', :'minutes_delay' => :'Integer', :'gateway' => :'String', :'deleted' => :'BOOLEAN', :'organization' => :'Organization' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/dunning_line.rb, line 237 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && changed_by == o.changed_by && updated == o.updated && id == o.id && organization_id == o.organization_id && type == o.type && attempt_ix == o.attempt_ix && minutes_delay == o.minutes_delay && gateway == o.gateway && deleted == o.deleted && organization == o.organization 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/bf_ruby2/models/dunning_line.rb, line 289 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 = Bfwd.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/bf_ruby2/models/dunning_line.rb, line 355 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/bf_ruby2/models/dunning_line.rb, line 268 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
@see the `==` method @param [Object] Object to be compared
# File lib/bf_ruby2/models/dunning_line.rb, line 255 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] gateway Object to be assigned
# File lib/bf_ruby2/models/dunning_line.rb, line 227 def gateway=(gateway) validator = EnumAttributeValidator.new('String', ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"]) unless validator.valid?(gateway) fail ArgumentError, "invalid value for 'gateway', must be one of #{validator.allowable_values}." end @gateway = gateway end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/dunning_line.rb, line 261 def hash [created, changed_by, updated, id, organization_id, type, attempt_ix, minutes_delay, gateway, deleted, organization].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/bf_ruby2/models/dunning_line.rb, line 165 def list_invalid_properties invalid_properties = Array.new if @organization_id.nil? invalid_properties.push("invalid value for 'organization_id', organization_id cannot be nil.") end if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end if @attempt_ix.nil? invalid_properties.push("invalid value for 'attempt_ix', attempt_ix cannot be nil.") end if @minutes_delay.nil? invalid_properties.push("invalid value for 'minutes_delay', minutes_delay cannot be nil.") end if @gateway.nil? invalid_properties.push("invalid value for 'gateway', gateway cannot be nil.") end if @deleted.nil? invalid_properties.push("invalid value for 'deleted', deleted cannot be nil.") end if @organization.nil? invalid_properties.push("invalid value for 'organization', organization cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/dunning_line.rb, line 341 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/bf_ruby2/models/dunning_line.rb, line 329 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/bf_ruby2/models/dunning_line.rb, line 217 def type=(type) validator = EnumAttributeValidator.new('String', ["Invoice", "Notification"]) unless validator.valid?(type) fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/bf_ruby2/models/dunning_line.rb, line 200 def valid? return false if @organization_id.nil? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["Invoice", "Notification"]) return false unless type_validator.valid?(@type) return false if @attempt_ix.nil? return false if @minutes_delay.nil? return false if @gateway.nil? gateway_validator = EnumAttributeValidator.new('String', ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"]) return false unless gateway_validator.valid?(@gateway) return false if @deleted.nil? return false if @organization.nil? return true end