class Wallee::ChargeAttempt

Attributes

charge[RW]
completion_behavior[RW]
connector_configuration[RW]
created_on[RW]

The created on date indicates the date on which the entity was stored into the database.

environment[RW]
failed_on[RW]
failure_reason[RW]
id[RW]

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

initializing_token_version[RW]
invocation[RW]
labels[RW]
language[RW]
linked_space_id[RW]

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

linked_transaction[RW]
next_update_on[RW]
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.

redirection_url[RW]
sales_channel[RW]
space_view_id[RW]
state[RW]
succeeded_on[RW]
terminal[RW]
time_zone[RW]
timeout_on[RW]
token_version[RW]
user_failure_message[RW]

The user failure message contains the message for the user in case the attempt failed. The message is localized into the language specified on 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/wallee-ruby-sdk/models/charge_attempt.rb, line 105
def self.attribute_map
  {
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'linked_transaction' => :'linkedTransaction',
    :'charge' => :'charge',
    :'completion_behavior' => :'completionBehavior',
    :'connector_configuration' => :'connectorConfiguration',
    :'created_on' => :'createdOn',
    :'environment' => :'environment',
    :'failed_on' => :'failedOn',
    :'failure_reason' => :'failureReason',
    :'initializing_token_version' => :'initializingTokenVersion',
    :'invocation' => :'invocation',
    :'labels' => :'labels',
    :'language' => :'language',
    :'next_update_on' => :'nextUpdateOn',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'redirection_url' => :'redirectionUrl',
    :'sales_channel' => :'salesChannel',
    :'space_view_id' => :'spaceViewId',
    :'state' => :'state',
    :'succeeded_on' => :'succeededOn',
    :'terminal' => :'terminal',
    :'time_zone' => :'timeZone',
    :'timeout_on' => :'timeoutOn',
    :'token_version' => :'tokenVersion',
    :'user_failure_message' => :'userFailureMessage',
    :'version' => :'version'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/wallee-ruby-sdk/models/charge_attempt.rb, line 172
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

  if attributes.has_key?(:'connectorConfiguration')
    self.connector_configuration = attributes[:'connectorConfiguration']
  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?(:'failedOn')
    self.failed_on = attributes[:'failedOn']
  end

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

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

  if attributes.has_key?(:'invocation')
    self.invocation = attributes[:'invocation']
  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?(:'nextUpdateOn')
    self.next_update_on = attributes[:'nextUpdateOn']
  end

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

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

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

  if attributes.has_key?(:'spaceViewId')
    self.space_view_id = attributes[:'spaceViewId']
  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?(:'terminal')
    self.terminal = attributes[:'terminal']
  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?(:'tokenVersion')
    self.token_version = attributes[:'tokenVersion']
  end

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

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

Attribute type mapping.

# File lib/wallee-ruby-sdk/models/charge_attempt.rb, line 138
def self.swagger_types
  {
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'linked_transaction' => :'Integer',
    :'charge' => :'Charge',
    :'completion_behavior' => :'TransactionCompletionBehavior',
    :'connector_configuration' => :'PaymentConnectorConfiguration',
    :'created_on' => :'DateTime',
    :'environment' => :'ChargeAttemptEnvironment',
    :'failed_on' => :'DateTime',
    :'failure_reason' => :'FailureReason',
    :'initializing_token_version' => :'BOOLEAN',
    :'invocation' => :'ConnectorInvocation',
    :'labels' => :'Array<Label>',
    :'language' => :'String',
    :'next_update_on' => :'DateTime',
    :'planned_purge_date' => :'DateTime',
    :'redirection_url' => :'String',
    :'sales_channel' => :'Integer',
    :'space_view_id' => :'Integer',
    :'state' => :'ChargeAttemptState',
    :'succeeded_on' => :'DateTime',
    :'terminal' => :'PaymentTerminal',
    :'time_zone' => :'String',
    :'timeout_on' => :'DateTime',
    :'token_version' => :'TokenVersion',
    :'user_failure_message' => :'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/wallee-ruby-sdk/models/charge_attempt.rb, line 319
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      linked_transaction == o.linked_transaction &&
      charge == o.charge &&
      completion_behavior == o.completion_behavior &&
      connector_configuration == o.connector_configuration &&
      created_on == o.created_on &&
      environment == o.environment &&
      failed_on == o.failed_on &&
      failure_reason == o.failure_reason &&
      initializing_token_version == o.initializing_token_version &&
      invocation == o.invocation &&
      labels == o.labels &&
      language == o.language &&
      next_update_on == o.next_update_on &&
      planned_purge_date == o.planned_purge_date &&
      redirection_url == o.redirection_url &&
      sales_channel == o.sales_channel &&
      space_view_id == o.space_view_id &&
      state == o.state &&
      succeeded_on == o.succeeded_on &&
      terminal == o.terminal &&
      time_zone == o.time_zone &&
      timeout_on == o.timeout_on &&
      token_version == o.token_version &&
      user_failure_message == o.user_failure_message &&
      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/wallee-ruby-sdk/models/charge_attempt.rb, line 387
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 = Wallee.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/wallee-ruby-sdk/models/charge_attempt.rb, line 453
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/wallee-ruby-sdk/models/charge_attempt.rb, line 366
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/wallee-ruby-sdk/models/charge_attempt.rb, line 353
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/wallee-ruby-sdk/models/charge_attempt.rb, line 359
def hash
  [id, linked_space_id, linked_transaction, charge, completion_behavior, connector_configuration, created_on, environment, failed_on, failure_reason, initializing_token_version, invocation, labels, language, next_update_on, planned_purge_date, redirection_url, sales_channel, space_view_id, state, succeeded_on, terminal, time_zone, timeout_on, token_version, user_failure_message, 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/wallee-ruby-sdk/models/charge_attempt.rb, line 291
def list_invalid_properties
  invalid_properties = Array.new
  if !@user_failure_message.nil? && @user_failure_message.to_s.length > 2000
    invalid_properties.push('invalid value for "user_failure_message", the character length must be smaller than or equal to 2000.')
  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/wallee-ruby-sdk/models/charge_attempt.rb, line 433
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/wallee-ruby-sdk/models/charge_attempt.rb, line 439
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/wallee-ruby-sdk/models/charge_attempt.rb, line 427
def to_s
  to_hash.to_s
end
user_failure_message=(user_failure_message) click to toggle source

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

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

  @user_failure_message = user_failure_message
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/wallee-ruby-sdk/models/charge_attempt.rb, line 302
def valid?
  return false if !@user_failure_message.nil? && @user_failure_message.to_s.length > 2000
  true
end