class PostFinanceCheckout::TransactionPending

Attributes

allowed_payment_method_brands[RW]
allowed_payment_method_configurations[RW]
billing_address[RW]
completion_behavior[RW]

The completion behavior controls when the transaction is completed.

currency[RW]
customer_email_address[RW]

The customer email address is the email address of the customer. If no email address is provided on the shipping or billing address this address is used.

customer_id[RW]
failed_url[RW]

The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.

id[RW]

The ID is the primary key of the entity. The ID identifies the entity uniquely.

invoice_merchant_reference[RW]
language[RW]
line_items[RW]
merchant_reference[RW]
meta_data[RW]

Meta data allow to store additional data along the object.

shipping_address[RW]
shipping_method[RW]
success_url[RW]

The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.

time_zone[RW]

The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.

token[RW]
tokenization_mode[RW]

The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.

version[RW]

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 87
def self.attribute_map
  {
    :'allowed_payment_method_brands' => :'allowedPaymentMethodBrands',
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'billing_address' => :'billingAddress',
    :'completion_behavior' => :'completionBehavior',
    :'currency' => :'currency',
    :'customer_email_address' => :'customerEmailAddress',
    :'customer_id' => :'customerId',
    :'failed_url' => :'failedUrl',
    :'invoice_merchant_reference' => :'invoiceMerchantReference',
    :'language' => :'language',
    :'line_items' => :'lineItems',
    :'merchant_reference' => :'merchantReference',
    :'meta_data' => :'metaData',
    :'shipping_address' => :'shippingAddress',
    :'shipping_method' => :'shippingMethod',
    :'success_url' => :'successUrl',
    :'time_zone' => :'timeZone',
    :'token' => :'token',
    :'tokenization_mode' => :'tokenizationMode',
    :'id' => :'id',
    :'version' => :'version'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 142
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?(:'allowedPaymentMethodBrands')
    if (value = attributes[:'allowedPaymentMethodBrands']).is_a?(Array)
      self.allowed_payment_method_brands = value
    end
  end

  if attributes.has_key?(:'allowedPaymentMethodConfigurations')
    if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array)
      self.allowed_payment_method_configurations = value
    end
  end

  if attributes.has_key?(:'billingAddress')
    self.billing_address = attributes[:'billingAddress']
  end

  if attributes.has_key?(:'completionBehavior')
    self.completion_behavior = attributes[:'completionBehavior']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'customerEmailAddress')
    self.customer_email_address = attributes[:'customerEmailAddress']
  end

  if attributes.has_key?(:'customerId')
    self.customer_id = attributes[:'customerId']
  end

  if attributes.has_key?(:'failedUrl')
    self.failed_url = attributes[:'failedUrl']
  end

  if attributes.has_key?(:'invoiceMerchantReference')
    self.invoice_merchant_reference = attributes[:'invoiceMerchantReference']
  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?(:'merchantReference')
    self.merchant_reference = attributes[:'merchantReference']
  end

  if attributes.has_key?(:'metaData')
    if (value = attributes[:'metaData']).is_a?(Hash)
      self.meta_data = value
    end
  end

  if attributes.has_key?(:'shippingAddress')
    self.shipping_address = attributes[:'shippingAddress']
  end

  if attributes.has_key?(:'shippingMethod')
    self.shipping_method = attributes[:'shippingMethod']
  end

  if attributes.has_key?(:'successUrl')
    self.success_url = attributes[:'successUrl']
  end

  if attributes.has_key?(:'timeZone')
    self.time_zone = attributes[:'timeZone']
  end

  if attributes.has_key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.has_key?(:'tokenizationMode')
    self.tokenization_mode = attributes[:'tokenizationMode']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 114
def self.swagger_types
  {
    :'allowed_payment_method_brands' => :'Array<PaymentMethodBrand>',
    :'allowed_payment_method_configurations' => :'Array<Integer>',
    :'billing_address' => :'AddressCreate',
    :'completion_behavior' => :'TransactionCompletionBehavior',
    :'currency' => :'String',
    :'customer_email_address' => :'String',
    :'customer_id' => :'String',
    :'failed_url' => :'String',
    :'invoice_merchant_reference' => :'String',
    :'language' => :'String',
    :'line_items' => :'Array<LineItemCreate>',
    :'merchant_reference' => :'String',
    :'meta_data' => :'Hash<String, String>',
    :'shipping_address' => :'AddressCreate',
    :'shipping_method' => :'String',
    :'success_url' => :'String',
    :'time_zone' => :'String',
    :'token' => :'Integer',
    :'tokenization_mode' => :'TokenizationMode',
    :'id' => :'Integer',
    :'version' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 374
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_payment_method_brands == o.allowed_payment_method_brands &&
      allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
      billing_address == o.billing_address &&
      completion_behavior == o.completion_behavior &&
      currency == o.currency &&
      customer_email_address == o.customer_email_address &&
      customer_id == o.customer_id &&
      failed_url == o.failed_url &&
      invoice_merchant_reference == o.invoice_merchant_reference &&
      language == o.language &&
      line_items == o.line_items &&
      merchant_reference == o.merchant_reference &&
      meta_data == o.meta_data &&
      shipping_address == o.shipping_address &&
      shipping_method == o.shipping_method &&
      success_url == o.success_url &&
      time_zone == o.time_zone &&
      token == o.token &&
      tokenization_mode == o.tokenization_mode &&
      id == o.id &&
      version == o.version
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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 436
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
_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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 502
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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 415
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
customer_email_address=(customer_email_address) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 306
def customer_email_address=(customer_email_address)
  if !customer_email_address.nil? && customer_email_address.to_s.length > 254
    fail ArgumentError, 'invalid value for "customer_email_address", the character length must be smaller than or equal to 254.'
  end

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

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 402
def eql?(o)
  self == o
end
failed_url=(failed_url) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 316
def failed_url=(failed_url)
  if !failed_url.nil? && failed_url.to_s.length > 1000
    fail ArgumentError, 'invalid value for "failed_url", the character length must be smaller than or equal to 1000.'
  end

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

  @failed_url = failed_url
end
hash() click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 408
def hash
  [allowed_payment_method_brands, allowed_payment_method_configurations, billing_address, completion_behavior, currency, customer_email_address, customer_id, failed_url, invoice_merchant_reference, language, line_items, merchant_reference, meta_data, shipping_address, shipping_method, success_url, time_zone, token, tokenization_mode, id, version].hash
end
invoice_merchant_reference=(invoice_merchant_reference) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 330
def invoice_merchant_reference=(invoice_merchant_reference)
  if !invoice_merchant_reference.nil? && invoice_merchant_reference.to_s.length > 100
    fail ArgumentError, 'invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.'
  end

  @invoice_merchant_reference = invoice_merchant_reference
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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 243
def list_invalid_properties
  invalid_properties = Array.new
  if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254
    invalid_properties.push('invalid value for "customer_email_address", the character length must be smaller than or equal to 254.')
  end

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

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

  if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
    invalid_properties.push('invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.')
  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 !@shipping_method.nil? && @shipping_method.to_s.length > 200
    invalid_properties.push('invalid value for "shipping_method", the character length must be smaller than or equal to 200.')
  end

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

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

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @version.nil?
    invalid_properties.push('invalid value for "version", version cannot be nil.')
  end

  invalid_properties
end
merchant_reference=(merchant_reference) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 340
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
shipping_method=(shipping_method) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 350
def shipping_method=(shipping_method)
  if !shipping_method.nil? && shipping_method.to_s.length > 200
    fail ArgumentError, 'invalid value for "shipping_method", the character length must be smaller than or equal to 200.'
  end

  @shipping_method = shipping_method
end
success_url=(success_url) click to toggle source

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

# File lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 360
def success_url=(success_url)
  if !success_url.nil? && success_url.to_s.length > 1000
    fail ArgumentError, 'invalid value for "success_url", the character length must be smaller than or equal to 1000.'
  end

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

  @success_url = success_url
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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 482
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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 488
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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 476
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/postfinancecheckout-ruby-sdk/models/transaction_pending.rb, line 290
def valid?
  return false if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254
  return false if !@failed_url.nil? && @failed_url.to_s.length > 1000
  return false if !@failed_url.nil? && @failed_url.to_s.length < 9
  return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
  return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
  return false if !@shipping_method.nil? && @shipping_method.to_s.length > 200
  return false if !@success_url.nil? && @success_url.to_s.length > 1000
  return false if !@success_url.nil? && @success_url.to_s.length < 9
  return false if @id.nil?
  return false if @version.nil?
  true
end