class PostFinanceCheckout::PaymentLink

The payment link defines an URL to automatically create transactions.

Attributes

allowed_payment_method_configurations[RW]

The allowed payment method configurations restrict the payment methods which can be used with this payment link.

applied_space_view[RW]

The payment link can be conducted in a specific space view. The space view may apply a specific design to the payment page.

available_from[RW]

The available from date defines the earliest date on which the payment link can be used. When no date is specified there will be no restriction.

available_until[RW]

The available from date defines the latest date on which the payment link can be used to initialize a transaction. When no date is specified there will be no restriction.

billing_address_handling_mode[RW]

The billing address handling mode controls if the address is collected or not and how it is collected.

currency[RW]

The currency defines in which currency the payment is executed in. If no currency is defined it has to be specified within the request parameter 'currency'.

external_id[RW]

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.

id[RW]

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

language[RW]

The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.

line_items[RW]

The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters.

linked_space_id[RW]

The linked space id holds the ID of the space to which the entity belongs to.

maximal_number_of_transactions[RW]

The maximal number of transactions limits the number of transactions which can be created with this payment link.

name[RW]

The payment link name is used internally to identify the payment link. For example the name is used within search fields and hence it should be distinct and descriptive.

planned_purge_date[RW]

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.

protection_mode[RW]

The protection mode determines if the payment link is protected against tampering and in what way.

shipping_address_handling_mode[RW]

The shipping address handling mode controls if the address is collected or not and how it is collected.

state[RW]
url[RW]

The URL defines the URL to which the user has to be forwarded to initialize the payment.

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/payment_link.rb, line 81
def self.attribute_map
  {
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'applied_space_view' => :'appliedSpaceView',
    :'available_from' => :'availableFrom',
    :'available_until' => :'availableUntil',
    :'billing_address_handling_mode' => :'billingAddressHandlingMode',
    :'currency' => :'currency',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'language' => :'language',
    :'line_items' => :'lineItems',
    :'linked_space_id' => :'linkedSpaceId',
    :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
    :'name' => :'name',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'protection_mode' => :'protectionMode',
    :'shipping_address_handling_mode' => :'shippingAddressHandlingMode',
    :'state' => :'state',
    :'url' => :'url',
    :'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/payment_link.rb, line 132
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?(:'allowedPaymentMethodConfigurations')
    if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array)
      self.allowed_payment_method_configurations = value
    end
  end

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

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

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

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

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

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

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  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?(:'maximalNumberOfTransactions')
    self.maximal_number_of_transactions = attributes[:'maximalNumberOfTransactions']
  end

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

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

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

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

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

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  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/payment_link.rb, line 106
def self.swagger_types
  {
    :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
    :'applied_space_view' => :'Integer',
    :'available_from' => :'DateTime',
    :'available_until' => :'DateTime',
    :'billing_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
    :'currency' => :'String',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'language' => :'String',
    :'line_items' => :'Array<LineItem>',
    :'linked_space_id' => :'Integer',
    :'maximal_number_of_transactions' => :'Integer',
    :'name' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'protection_mode' => :'PaymentLinkProtectionMode',
    :'shipping_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
    :'state' => :'CreationEntityState',
    :'url' => :'String',
    :'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/payment_link.rb, line 249
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
      applied_space_view == o.applied_space_view &&
      available_from == o.available_from &&
      available_until == o.available_until &&
      billing_address_handling_mode == o.billing_address_handling_mode &&
      currency == o.currency &&
      external_id == o.external_id &&
      id == o.id &&
      language == o.language &&
      line_items == o.line_items &&
      linked_space_id == o.linked_space_id &&
      maximal_number_of_transactions == o.maximal_number_of_transactions &&
      name == o.name &&
      planned_purge_date == o.planned_purge_date &&
      protection_mode == o.protection_mode &&
      shipping_address_handling_mode == o.shipping_address_handling_mode &&
      state == o.state &&
      url == o.url &&
      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/payment_link.rb, line 309
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/payment_link.rb, line 375
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/payment_link.rb, line 288
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
eql?(o) click to toggle source

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

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

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

# File lib/postfinancecheckout-ruby-sdk/models/payment_link.rb, line 281
def hash
  [allowed_payment_method_configurations, applied_space_view, available_from, available_until, billing_address_handling_mode, currency, external_id, id, language, line_items, linked_space_id, maximal_number_of_transactions, name, planned_purge_date, protection_mode, shipping_address_handling_mode, state, url, version].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/postfinancecheckout-ruby-sdk/models/payment_link.rb, line 221
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end
name=(name) click to toggle source

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

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

  @name = name
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/payment_link.rb, line 355
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/payment_link.rb, line 361
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/payment_link.rb, line 349
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/payment_link.rb, line 232
def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  true
end