class Yapstone::ProcessPayment

Process payment object

Attributes

channel[RW]

The mode of communication (or channel) used to process the payment.

client_correlation_id[RW]

A unique identifier that is attached to all transactions that have to do with a particular payment. You can track all the steps a payment went through using this ID.

client_unique_transaction_id[RW]

This is the unique transaction ID for one transaction to do with a payment being processed. You can use this to retrieve a specific transaction vs. a set of associated transactions (which is what you would use the clientCorrelationId for). You can use this to identify duplicate requests.

custom_data[RW]
customer[RW]
marketplace[RW]
payment_details[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/yapstone-payments/models/process_payment.rb, line 36
def self.attribute_map
  {
    :'channel' => :'channel',
    :'client_correlation_id' => :'clientCorrelationId',
    :'client_unique_transaction_id' => :'clientUniqueTransactionId',
    :'marketplace' => :'marketplace',
    :'customer' => :'customer',
    :'payment_details' => :'paymentDetails',
    :'custom_data' => :'customData'
  }
end
build_from_hash(attributes) click to toggle source

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/process_payment.rb, line 197
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/yapstone-payments/models/process_payment.rb, line 63
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::ProcessPayment` 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::ProcessPayment`. 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?(:'channel')
    self.channel = attributes[:'channel']
  end

  if attributes.key?(:'client_correlation_id')
    self.client_correlation_id = attributes[:'client_correlation_id']
  end

  if attributes.key?(:'client_unique_transaction_id')
    self.client_unique_transaction_id = attributes[:'client_unique_transaction_id']
  end

  if attributes.key?(:'marketplace')
    self.marketplace = attributes[:'marketplace']
  end

  if attributes.key?(:'customer')
    self.customer = attributes[:'customer']
  end

  if attributes.key?(:'payment_details')
    self.payment_details = attributes[:'payment_details']
  end

  if attributes.key?(:'custom_data')
    if (value = attributes[:'custom_data']).is_a?(Hash)
      self.custom_data = value
    end
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/yapstone-payments/models/process_payment.rb, line 49
def self.openapi_types
  {
    :'channel' => :'String',
    :'client_correlation_id' => :'String',
    :'client_unique_transaction_id' => :'String',
    :'marketplace' => :'MarketplaceData',
    :'customer' => :'Customer',
    :'payment_details' => :'PaymentDetails',
    :'custom_data' => :'Hash<String, String>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/yapstone-payments/models/process_payment.rb, line 170
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channel == o.channel &&
      client_correlation_id == o.client_correlation_id &&
      client_unique_transaction_id == o.client_unique_transaction_id &&
      marketplace == o.marketplace &&
      customer == o.customer &&
      payment_details == o.payment_details &&
      custom_data == o.custom_data
end
_deserialize(type, value) click to toggle source

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/process_payment.rb, line 225
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
_to_hash(value) click to toggle source

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/process_payment.rb, line 290
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
build_from_hash(attributes) click to toggle source

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/process_payment.rb, line 204
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
client_correlation_id=(client_correlation_id) click to toggle source

Custom attribute writer method with validation @param [Object] client_correlation_id Value to be assigned

# File lib/yapstone-payments/models/process_payment.rb, line 142
def client_correlation_id=(client_correlation_id)
  if !client_correlation_id.nil? && client_correlation_id.to_s.length > 128
    fail ArgumentError, 'invalid value for "client_correlation_id", the character length must be smaller than or equal to 128.'
  end

  if !client_correlation_id.nil? && client_correlation_id.to_s.length < 0
    fail ArgumentError, 'invalid value for "client_correlation_id", the character length must be great than or equal to 0.'
  end

  @client_correlation_id = client_correlation_id
end
client_unique_transaction_id=(client_unique_transaction_id) click to toggle source

Custom attribute writer method with validation @param [Object] client_unique_transaction_id Value to be assigned

# File lib/yapstone-payments/models/process_payment.rb, line 156
def client_unique_transaction_id=(client_unique_transaction_id)
  if !client_unique_transaction_id.nil? && client_unique_transaction_id.to_s.length > 128
    fail ArgumentError, 'invalid value for "client_unique_transaction_id", the character length must be smaller than or equal to 128.'
  end

  if !client_unique_transaction_id.nil? && client_unique_transaction_id.to_s.length < 0
    fail ArgumentError, 'invalid value for "client_unique_transaction_id", the character length must be great than or equal to 0.'
  end

  @client_unique_transaction_id = client_unique_transaction_id
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/yapstone-payments/models/process_payment.rb, line 184
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/yapstone-payments/models/process_payment.rb, line 190
def hash
  [channel, client_correlation_id, client_unique_transaction_id, marketplace, customer, payment_details, custom_data].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/yapstone-payments/models/process_payment.rb, line 109
def list_invalid_properties
  invalid_properties = Array.new
  if !@client_correlation_id.nil? && @client_correlation_id.to_s.length > 128
    invalid_properties.push('invalid value for "client_correlation_id", the character length must be smaller than or equal to 128.')
  end

  if !@client_correlation_id.nil? && @client_correlation_id.to_s.length < 0
    invalid_properties.push('invalid value for "client_correlation_id", the character length must be great than or equal to 0.')
  end

  if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length > 128
    invalid_properties.push('invalid value for "client_unique_transaction_id", the character length must be smaller than or equal to 128.')
  end

  if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length < 0
    invalid_properties.push('invalid value for "client_unique_transaction_id", the character length must be great than or equal to 0.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/yapstone-payments/models/process_payment.rb, line 270
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/yapstone-payments/models/process_payment.rb, line 276
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/yapstone-payments/models/process_payment.rb, line 264
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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/process_payment.rb, line 132
def valid?
  return false if !@client_correlation_id.nil? && @client_correlation_id.to_s.length > 128
  return false if !@client_correlation_id.nil? && @client_correlation_id.to_s.length < 0
  return false if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length > 128
  return false if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length < 0
  true
end