postfinancecheckout-ruby-sdk 4.5.0 → 5.2.0

data/lib/postfinancecheckout-ruby-sdk/models/charge_flow.rb

@@ -20,7 +20,7 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ChargeFlow
-    # If a transaction meets all selected conditions, the charge flow will be used to process the transaction. If the conditions are not met the next charge flow in line will be chosen according to the priorities.
+    # Conditions allow to define criteria that a transaction must fulfill in order for the charge flow to be considered for processing the payment.
     attr_accessor :conditions
 
     # A unique identifier for the object.
@@ -29,13 +29,13 @@ module PostFinanceCheckout
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The charge flow name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
+    # The name used to identify the charge flow.
     attr_accessor :name
 
     # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     attr_accessor :planned_purge_date
 
-    # The priority orders the charge flows. As such the priority determines together with the conditions the charge flow the selection mechanism for a particular transaction. A change of the priority affects all future selections.
+    # The priority that determines the order in which charge flows are taken into account when processing a payment. Low values are considered first.
     attr_accessor :priority
 
     # The object's current state.

data/lib/postfinancecheckout-ruby-sdk/models/charge_flow_level.rb

@@ -20,40 +20,40 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ChargeFlowLevel
+    # The charge to process the payment asynchronously.
+    attr_accessor :asynchronous_charge
+
+    # The configuration that was used for this charge flow level.
+    attr_accessor :configuration
+
+    # The date and time when the object was created.
+    attr_accessor :created_on
+
     # A unique identifier for the object.
     attr_accessor :id
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The payment transaction this object is linked to.
     attr_accessor :linked_transaction
 
-    # 
-    attr_accessor :asynchronous_charge
-
-    # 
-    attr_accessor :configuration
-
-    # The date and time when the object was created.
-    attr_accessor :created_on
-
     # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     attr_accessor :planned_purge_date
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The charge to process the payment synchronously.
     attr_accessor :synchronous_charge
 
-    # 
+    # The date and time when the charge flow level will expire.
     attr_accessor :timeout_on
 
-    # 
+    # The charge to process the payment using a token.
     attr_accessor :token_charge
 
-    # 
+    # The transaction that the charge flow level belongs to.
     attr_accessor :transaction
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -62,12 +62,12 @@ module PostFinanceCheckout
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'linked_space_id' => :'linkedSpaceId',
-        :'linked_transaction' => :'linkedTransaction',
         :'asynchronous_charge' => :'asynchronousCharge',
         :'configuration' => :'configuration',
         :'created_on' => :'createdOn',
+        :'id' => :'id',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
         :'planned_purge_date' => :'plannedPurgeDate',
         :'state' => :'state',
         :'synchronous_charge' => :'synchronousCharge',
@@ -81,12 +81,12 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
         :'asynchronous_charge' => :'Integer',
         :'configuration' => :'ChargeFlowLevelConfiguration',
         :'created_on' => :'DateTime',
+        :'id' => :'Integer',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
         :'planned_purge_date' => :'DateTime',
         :'state' => :'ChargeFlowLevelState',
         :'synchronous_charge' => :'Integer',
@@ -105,18 +105,6 @@ module PostFinanceCheckout
       # 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?(:'asynchronousCharge')
         self.asynchronous_charge = attributes[:'asynchronousCharge']
       end
@@ -129,6 +117,18 @@ module PostFinanceCheckout
         self.created_on = attributes[:'createdOn']
       end
 
+      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?(:'plannedPurgeDate')
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
@@ -176,12 +176,12 @@ module PostFinanceCheckout
     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 &&
           asynchronous_charge == o.asynchronous_charge &&
           configuration == o.configuration &&
           created_on == o.created_on &&
+          id == o.id &&
+          linked_space_id == o.linked_space_id &&
+          linked_transaction == o.linked_transaction &&
           planned_purge_date == o.planned_purge_date &&
           state == o.state &&
           synchronous_charge == o.synchronous_charge &&
@@ -200,7 +200,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, asynchronous_charge, configuration, created_on, planned_purge_date, state, synchronous_charge, timeout_on, token_charge, transaction, version].hash
+      [asynchronous_charge, configuration, created_on, id, linked_space_id, linked_transaction, planned_purge_date, state, synchronous_charge, timeout_on, token_charge, transaction, version].hash
     end
 
     # Builds the object from hash

data/lib/postfinancecheckout-ruby-sdk/models/charge_flow_level_configuration.rb

@@ -20,7 +20,7 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ChargeFlowLevelConfiguration
-    # The charge flow level configuration to which the flow is associated.
+    # The charge flow that this level configuration belongs to.
     attr_accessor :flow
 
     # A unique identifier for the object.
@@ -29,22 +29,22 @@ module PostFinanceCheckout
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The charge flow level configuration name is used internally to identify the charge flow level configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
+    # The name used to identify the charge flow level configuration.
     attr_accessor :name
 
-    # The duration of the level before switching to the next one.
+    # The duration specifies how long the level remains active before transitioning to the next one.
     attr_accessor :period
 
     # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     attr_accessor :planned_purge_date
 
-    # The priority indicates the sort order of the level configurations. A low value indicates that the level configuration is executed before any level with a higher value. Any change to this value affects future level configuration selections.
+    # The priority that determines the order in which level configurations are taken into account when processing a charge flow. Low values are considered first.
     attr_accessor :priority
 
     # The object's current state.
     attr_accessor :state
 
-    # The type determines how the payment link is delivered to the customer. Once the type is defined it cannot be changed anymore.
+    # The type defines the method of delivering the payment link to the customer.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

data/lib/postfinancecheckout-ruby-sdk/models/charge_flow_level_configuration_type.rb

@@ -26,7 +26,7 @@ module PostFinanceCheckout
     # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The localized label that describes the action triggered by the configuration type.
     attr_accessor :label
 
     # The localized name of the object.

data/lib/postfinancecheckout-ruby-sdk/models/charge_flow_level_payment_link.rb

@@ -20,28 +20,24 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ChargeFlowLevelPaymentLink
+    # The charge flow level that the payment link belongs to.
+    attr_accessor :charge_flow_level
+
     # A unique identifier for the object.
     attr_accessor :id
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
-    attr_accessor :linked_transaction
-
-    # 
-    attr_accessor :charge_flow_level
-
-    # 
+    # The URL provided to the customer for entering their payment details and completing the transaction.
     attr_accessor :payment_link
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'charge_flow_level' => :'chargeFlowLevel',
         :'id' => :'id',
         :'linked_space_id' => :'linkedSpaceId',
-        :'linked_transaction' => :'linkedTransaction',
-        :'charge_flow_level' => :'chargeFlowLevel',
         :'payment_link' => :'paymentLink'
       }
     end
@@ -49,10 +45,9 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'charge_flow_level' => :'ChargeFlowLevel',
         :'id' => :'Integer',
         :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
-        :'charge_flow_level' => :'ChargeFlowLevel',
         :'payment_link' => :'String'
       }
     end
@@ -65,6 +60,10 @@ module PostFinanceCheckout
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'chargeFlowLevel')
+        self.charge_flow_level = attributes[:'chargeFlowLevel']
+      end
+
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
@@ -73,14 +72,6 @@ module PostFinanceCheckout
         self.linked_space_id = attributes[:'linkedSpaceId']
       end
 
-      if attributes.has_key?(:'linkedTransaction')
-        self.linked_transaction = attributes[:'linkedTransaction']
-      end
-
-      if attributes.has_key?(:'chargeFlowLevel')
-        self.charge_flow_level = attributes[:'chargeFlowLevel']
-      end
-
       if attributes.has_key?(:'paymentLink')
         self.payment_link = attributes[:'paymentLink']
       end
@@ -104,10 +95,9 @@ module PostFinanceCheckout
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          charge_flow_level == o.charge_flow_level &&
           id == o.id &&
           linked_space_id == o.linked_space_id &&
-          linked_transaction == o.linked_transaction &&
-          charge_flow_level == o.charge_flow_level &&
           payment_link == o.payment_link
     end
 
@@ -120,7 +110,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, charge_flow_level, payment_link].hash
+      [charge_flow_level, id, linked_space_id, payment_link].hash
     end
 
     # Builds the object from hash

data/lib/postfinancecheckout-ruby-sdk/models/completion_line_item.rb

@@ -20,13 +20,13 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CompletionLineItem
-    # The total amount of the line item including any tax.
+    # The total amount of the line item to be captured, including taxes.
     attr_accessor :amount
 
-    # The quantity of the line item which should be completed.
+    # The number of items to be captured.
     attr_accessor :quantity
 
-    # The unique id identifies the line item on which the capture is applied on.
+    # The unique identifier of the line item within the set of line items.
     attr_accessor :unique_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/completion_line_item_create.rb

@@ -20,13 +20,13 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CompletionLineItemCreate
-    # The total amount of the line item including any tax.
+    # The total amount of the line item to be captured, including taxes.
     attr_accessor :amount
 
-    # The quantity of the line item which should be completed.
+    # The number of items to be captured.
     attr_accessor :quantity
 
-    # The unique id identifies the line item on which the capture is applied on.
+    # The unique identifier of the line item within the set of line items.
     attr_accessor :unique_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/condition.rb

@@ -18,9 +18,9 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # A condition configuration controls under which condition a payment connector is applied to a transaction.
+  # A connector condition defines criteria that a transaction must meet for a connector configuration to process the payment.
   class Condition
-    # The selected condition type defines how the configuration is applied to the transactions.
+    # The condition type determines the criteria that a transaction must fulfill in order for a connector configuration to be considered for processing the payment.
     attr_accessor :condition_type
 
     # A unique identifier for the object.
@@ -29,7 +29,7 @@ module PostFinanceCheckout
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The condition name is used internally to identify the condition. For example the name is used within search fields and hence it should be distinct and descriptive.
+    # The name used to identify the condition.
     attr_accessor :name
 
     # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.

data/lib/postfinancecheckout-ruby-sdk/models/connector_invocation.rb

@@ -20,28 +20,25 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ConnectorInvocation
+    # The date and time when the object was created.
+    attr_accessor :created_on
+
     # A unique identifier for the object.
     attr_accessor :id
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
-    attr_accessor :linked_transaction
-
-    # The date and time when the object was created.
-    attr_accessor :created_on
-
     # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     attr_accessor :planned_purge_date
 
-    # 
+    # The transaction stage during which the connector invocation was performed.
     attr_accessor :stage
 
-    # 
+    # The duration, in milliseconds, taken to execute the connector invocation.
     attr_accessor :time_took_in_milliseconds
 
-    # 
+    # The transaction that the connector invocation belongs to.
     attr_accessor :transaction
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -50,10 +47,9 @@ module PostFinanceCheckout
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'created_on' => :'createdOn',
         :'id' => :'id',
         :'linked_space_id' => :'linkedSpaceId',
-        :'linked_transaction' => :'linkedTransaction',
-        :'created_on' => :'createdOn',
         :'planned_purge_date' => :'plannedPurgeDate',
         :'stage' => :'stage',
         :'time_took_in_milliseconds' => :'timeTookInMilliseconds',
@@ -65,10 +61,9 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'created_on' => :'DateTime',
         :'id' => :'Integer',
         :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
-        :'created_on' => :'DateTime',
         :'planned_purge_date' => :'DateTime',
         :'stage' => :'ConnectorInvocationStage',
         :'time_took_in_milliseconds' => :'Integer',
@@ -85,6 +80,10 @@ module PostFinanceCheckout
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'createdOn')
+        self.created_on = attributes[:'createdOn']
+      end
+
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
@@ -93,14 +92,6 @@ module PostFinanceCheckout
         self.linked_space_id = attributes[:'linkedSpaceId']
       end
 
-      if attributes.has_key?(:'linkedTransaction')
-        self.linked_transaction = attributes[:'linkedTransaction']
-      end
-
-      if attributes.has_key?(:'createdOn')
-        self.created_on = attributes[:'createdOn']
-      end
-
       if attributes.has_key?(:'plannedPurgeDate')
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
@@ -140,10 +131,9 @@ module PostFinanceCheckout
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          created_on == o.created_on &&
           id == o.id &&
           linked_space_id == o.linked_space_id &&
-          linked_transaction == o.linked_transaction &&
-          created_on == o.created_on &&
           planned_purge_date == o.planned_purge_date &&
           stage == o.stage &&
           time_took_in_milliseconds == o.time_took_in_milliseconds &&
@@ -160,7 +150,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, created_on, planned_purge_date, stage, time_took_in_milliseconds, transaction, version].hash
+      [created_on, id, linked_space_id, planned_purge_date, stage, time_took_in_milliseconds, transaction, version].hash
     end
 
     # Builds the object from hash

data/lib/postfinancecheckout-ruby-sdk/models/currency_bank_account.rb

@@ -20,13 +20,13 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CurrencyBankAccount
-    # 
+    # The bank account this currency bank account belongs to.
     attr_accessor :bank_account
 
-    # 
+    # The currency associated with the bank account.
     attr_accessor :currency
 
-    # 
+    # Whether the bank account operates in a test or production environment.
     attr_accessor :environment
 
     # A unique identifier for the object.

data/lib/postfinancecheckout-ruby-sdk/models/delivery_indication.rb

@@ -20,34 +20,34 @@ require 'date'
 module PostFinanceCheckout
   # 
   class DeliveryIndication
-    # A unique identifier for the object.
-    attr_accessor :id
-
-    # The ID of the space this object belongs to.
-    attr_accessor :linked_space_id
-
-    # 
-    attr_accessor :linked_transaction
-
-    # 
+    # The reason for the automatic system decision about the delivery indication.
     attr_accessor :automatic_decision_reason
 
-    # 
+    # The date and time when an automatic decision was made.
     attr_accessor :automatically_decided_on
 
-    # 
+    # The transaction completion that the delivery indication is linked to.
     attr_accessor :completion
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # A unique identifier for the object.
+    attr_accessor :id
+
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
+    # The payment transaction this object is linked to.
+    attr_accessor :linked_transaction
+
+    # The date and time by which a decision must be made before the system automatically proceeds according to the connector's predefined settings.
     attr_accessor :manual_decision_timeout_on
 
-    # 
+    # The ID of the user who manually decided the delivery indication's state.
     attr_accessor :manually_decided_by
 
-    # 
+    # The date and time when a manual decision was made.
     attr_accessor :manually_decided_on
 
     # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
@@ -56,22 +56,22 @@ module PostFinanceCheckout
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The date and time when the delivery indication will expire.
     attr_accessor :timeout_on
 
-    # 
+    # The payment transaction that the delivery indication is linked to.
     attr_accessor :transaction
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'linked_space_id' => :'linkedSpaceId',
-        :'linked_transaction' => :'linkedTransaction',
         :'automatic_decision_reason' => :'automaticDecisionReason',
         :'automatically_decided_on' => :'automaticallyDecidedOn',
         :'completion' => :'completion',
         :'created_on' => :'createdOn',
+        :'id' => :'id',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
         :'manual_decision_timeout_on' => :'manualDecisionTimeoutOn',
         :'manually_decided_by' => :'manuallyDecidedBy',
         :'manually_decided_on' => :'manuallyDecidedOn',
@@ -85,13 +85,13 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
         :'automatic_decision_reason' => :'DeliveryIndicationDecisionReason',
         :'automatically_decided_on' => :'DateTime',
         :'completion' => :'Integer',
         :'created_on' => :'DateTime',
+        :'id' => :'Integer',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
         :'manual_decision_timeout_on' => :'DateTime',
         :'manually_decided_by' => :'Integer',
         :'manually_decided_on' => :'DateTime',
@@ -110,18 +110,6 @@ module PostFinanceCheckout
       # 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?(:'automaticDecisionReason')
         self.automatic_decision_reason = attributes[:'automaticDecisionReason']
       end
@@ -138,6 +126,18 @@ module PostFinanceCheckout
         self.created_on = attributes[:'createdOn']
       end
 
+      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?(:'manualDecisionTimeoutOn')
         self.manual_decision_timeout_on = attributes[:'manualDecisionTimeoutOn']
       end
@@ -185,13 +185,13 @@ module PostFinanceCheckout
     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 &&
           automatic_decision_reason == o.automatic_decision_reason &&
           automatically_decided_on == o.automatically_decided_on &&
           completion == o.completion &&
           created_on == o.created_on &&
+          id == o.id &&
+          linked_space_id == o.linked_space_id &&
+          linked_transaction == o.linked_transaction &&
           manual_decision_timeout_on == o.manual_decision_timeout_on &&
           manually_decided_by == o.manually_decided_by &&
           manually_decided_on == o.manually_decided_on &&
@@ -210,7 +210,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, automatic_decision_reason, automatically_decided_on, completion, created_on, manual_decision_timeout_on, manually_decided_by, manually_decided_on, planned_purge_date, state, timeout_on, transaction].hash
+      [automatic_decision_reason, automatically_decided_on, completion, created_on, id, linked_space_id, linked_transaction, manual_decision_timeout_on, manually_decided_by, manually_decided_on, planned_purge_date, state, timeout_on, transaction].hash
     end
 
     # Builds the object from hash