class PostFinanceCheckout::Refund
The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).
Attributes
The created on date indicates the date on which the entity was stored into the database.
The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
The ID is the primary key of the entity. The ID identifies the entity uniquely.
The linked space id holds the ID of the space to which the entity belongs to.
The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
The total applied fees is the sum of all fees that have been applied so far.
The total settled amount is the total amount which has been settled so far.
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/postfinancecheckout-ruby-sdk/models/refund.rb, line 120 def self.attribute_map { :'amount' => :'amount', :'base_line_items' => :'baseLineItems', :'completion' => :'completion', :'created_by' => :'createdBy', :'created_on' => :'createdOn', :'environment' => :'environment', :'external_id' => :'externalId', :'failed_on' => :'failedOn', :'failure_reason' => :'failureReason', :'id' => :'id', :'labels' => :'labels', :'language' => :'language', :'line_items' => :'lineItems', :'linked_space_id' => :'linkedSpaceId', :'merchant_reference' => :'merchantReference', :'next_update_on' => :'nextUpdateOn', :'planned_purge_date' => :'plannedPurgeDate', :'processing_on' => :'processingOn', :'processor_reference' => :'processorReference', :'reduced_line_items' => :'reducedLineItems', :'reductions' => :'reductions', :'state' => :'state', :'succeeded_on' => :'succeededOn', :'taxes' => :'taxes', :'time_zone' => :'timeZone', :'timeout_on' => :'timeoutOn', :'total_applied_fees' => :'totalAppliedFees', :'total_settled_amount' => :'totalSettledAmount', :'transaction' => :'transaction', :'type' => :'type', :'updated_invoice' => :'updatedInvoice', :'version' => :'version' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 197 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?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'baseLineItems') if (value = attributes[:'baseLineItems']).is_a?(Array) self.base_line_items = value end end if attributes.has_key?(:'completion') self.completion = attributes[:'completion'] end if attributes.has_key?(:'createdBy') self.created_by = attributes[:'createdBy'] end if attributes.has_key?(:'createdOn') self.created_on = attributes[:'createdOn'] end if attributes.has_key?(:'environment') self.environment = attributes[:'environment'] end if attributes.has_key?(:'externalId') self.external_id = attributes[:'externalId'] end if attributes.has_key?(:'failedOn') self.failed_on = attributes[:'failedOn'] end if attributes.has_key?(:'failureReason') self.failure_reason = attributes[:'failureReason'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'labels') if (value = attributes[:'labels']).is_a?(Array) self.labels = value end end if attributes.has_key?(:'language') self.language = attributes[:'language'] end if attributes.has_key?(:'lineItems') if (value = attributes[:'lineItems']).is_a?(Array) self.line_items = value end end if attributes.has_key?(:'linkedSpaceId') self.linked_space_id = attributes[:'linkedSpaceId'] end if attributes.has_key?(:'merchantReference') self.merchant_reference = attributes[:'merchantReference'] end if attributes.has_key?(:'nextUpdateOn') self.next_update_on = attributes[:'nextUpdateOn'] end if attributes.has_key?(:'plannedPurgeDate') self.planned_purge_date = attributes[:'plannedPurgeDate'] end if attributes.has_key?(:'processingOn') self.processing_on = attributes[:'processingOn'] end if attributes.has_key?(:'processorReference') self.processor_reference = attributes[:'processorReference'] end if attributes.has_key?(:'reducedLineItems') if (value = attributes[:'reducedLineItems']).is_a?(Array) self.reduced_line_items = value end end if attributes.has_key?(:'reductions') if (value = attributes[:'reductions']).is_a?(Array) self.reductions = value end end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'succeededOn') self.succeeded_on = attributes[:'succeededOn'] end if attributes.has_key?(:'taxes') if (value = attributes[:'taxes']).is_a?(Array) self.taxes = value end end if attributes.has_key?(:'timeZone') self.time_zone = attributes[:'timeZone'] end if attributes.has_key?(:'timeoutOn') self.timeout_on = attributes[:'timeoutOn'] end if attributes.has_key?(:'totalAppliedFees') self.total_applied_fees = attributes[:'totalAppliedFees'] end if attributes.has_key?(:'totalSettledAmount') self.total_settled_amount = attributes[:'totalSettledAmount'] end if attributes.has_key?(:'transaction') self.transaction = attributes[:'transaction'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'updatedInvoice') self.updated_invoice = attributes[:'updatedInvoice'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end end
Attribute type mapping.
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 158 def self.swagger_types { :'amount' => :'Float', :'base_line_items' => :'Array<LineItem>', :'completion' => :'Integer', :'created_by' => :'Integer', :'created_on' => :'DateTime', :'environment' => :'Environment', :'external_id' => :'String', :'failed_on' => :'DateTime', :'failure_reason' => :'FailureReason', :'id' => :'Integer', :'labels' => :'Array<Label>', :'language' => :'String', :'line_items' => :'Array<LineItem>', :'linked_space_id' => :'Integer', :'merchant_reference' => :'String', :'next_update_on' => :'DateTime', :'planned_purge_date' => :'DateTime', :'processing_on' => :'DateTime', :'processor_reference' => :'String', :'reduced_line_items' => :'Array<LineItem>', :'reductions' => :'Array<LineItemReduction>', :'state' => :'RefundState', :'succeeded_on' => :'DateTime', :'taxes' => :'Array<Tax>', :'time_zone' => :'String', :'timeout_on' => :'DateTime', :'total_applied_fees' => :'Float', :'total_settled_amount' => :'Float', :'transaction' => :'Transaction', :'type' => :'RefundType', :'updated_invoice' => :'Integer', :'version' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 413 def ==(o) return true if self.equal?(o) self.class == o.class && amount == o.amount && base_line_items == o.base_line_items && completion == o.completion && created_by == o.created_by && created_on == o.created_on && environment == o.environment && external_id == o.external_id && failed_on == o.failed_on && failure_reason == o.failure_reason && id == o.id && labels == o.labels && language == o.language && line_items == o.line_items && linked_space_id == o.linked_space_id && merchant_reference == o.merchant_reference && next_update_on == o.next_update_on && planned_purge_date == o.planned_purge_date && processing_on == o.processing_on && processor_reference == o.processor_reference && reduced_line_items == o.reduced_line_items && reductions == o.reductions && state == o.state && succeeded_on == o.succeeded_on && taxes == o.taxes && time_zone == o.time_zone && timeout_on == o.timeout_on && total_applied_fees == o.total_applied_fees && total_settled_amount == o.total_settled_amount && transaction == o.transaction && type == o.type && updated_invoice == o.updated_invoice && version == o.version 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/postfinancecheckout-ruby-sdk/models/refund.rb, line 486 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 = PostFinanceCheckout.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/postfinancecheckout-ruby-sdk/models/refund.rb, line 552 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/postfinancecheckout-ruby-sdk/models/refund.rb, line 465 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/postfinancecheckout-ruby-sdk/models/refund.rb, line 452 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] external_id
Value to be assigned
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 379 def external_id=(external_id) if !external_id.nil? && external_id.to_s.length > 100 fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 100.' end if !external_id.nil? && external_id.to_s.length < 1 fail ArgumentError, 'invalid value for "external_id", the character length must be great than or equal to 1.' end @external_id = external_id end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 458 def hash [amount, base_line_items, completion, created_by, created_on, environment, external_id, failed_on, failure_reason, id, labels, language, line_items, linked_space_id, merchant_reference, next_update_on, planned_purge_date, processing_on, processor_reference, reduced_line_items, reductions, state, succeeded_on, taxes, time_zone, timeout_on, total_applied_fees, total_settled_amount, transaction, type, updated_invoice, version].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 346 def list_invalid_properties invalid_properties = Array.new if !@external_id.nil? && @external_id.to_s.length > 100 invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.') end if !@external_id.nil? && @external_id.to_s.length < 1 invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.') end if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100 invalid_properties.push('invalid value for "merchant_reference", the character length must be smaller than or equal to 100.') end if !@processor_reference.nil? && @processor_reference.to_s.length > 150 invalid_properties.push('invalid value for "processor_reference", the character length must be smaller than or equal to 150.') end invalid_properties end
Custom attribute writer method with validation @param [Object] merchant_reference
Value to be assigned
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 393 def merchant_reference=(merchant_reference) if !merchant_reference.nil? && merchant_reference.to_s.length > 100 fail ArgumentError, 'invalid value for "merchant_reference", the character length must be smaller than or equal to 100.' end @merchant_reference = merchant_reference end
Custom attribute writer method with validation @param [Object] processor_reference
Value to be assigned
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 403 def processor_reference=(processor_reference) if !processor_reference.nil? && processor_reference.to_s.length > 150 fail ArgumentError, 'invalid value for "processor_reference", the character length must be smaller than or equal to 150.' end @processor_reference = processor_reference end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/postfinancecheckout-ruby-sdk/models/refund.rb, line 538 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/postfinancecheckout-ruby-sdk/models/refund.rb, line 526 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/postfinancecheckout-ruby-sdk/models/refund.rb, line 369 def valid? return false if !@external_id.nil? && @external_id.to_s.length > 100 return false if !@external_id.nil? && @external_id.to_s.length < 1 return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100 return false if !@processor_reference.nil? && @processor_reference.to_s.length > 150 true end