wallee-ruby-sdk 4.4.0 → 5.2.0

data/lib/wallee-ruby-sdk/models/payment_terminal_transaction_summary_reference.rb

@@ -0,0 +1,221 @@
+=begin
+The wallee API allows an easy interaction with the wallee web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module Wallee
+  # 
+  class PaymentTerminalTransactionSummaryReference
+    # A unique identifier for the object.
+    attr_accessor :id
+
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
+    # The unique identifier of the terminal.
+    attr_accessor :terminal_id
+
+    # The unique identifier of the terminal, that is displayed on the device.
+    attr_accessor :terminal_identifier
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'terminal_id' => :'terminalId',
+        :'terminal_identifier' => :'terminalIdentifier'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'Integer',
+        :'linked_space_id' => :'Integer',
+        :'terminal_id' => :'Integer',
+        :'terminal_identifier' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'terminalId')
+        self.terminal_id = attributes[:'terminalId']
+      end
+
+      if attributes.has_key?(:'terminalIdentifier')
+        self.terminal_identifier = attributes[:'terminalIdentifier']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          linked_space_id == o.linked_space_id &&
+          terminal_id == o.terminal_id &&
+          terminal_identifier == o.terminal_identifier
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, linked_space_id, terminal_id, terminal_identifier].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+end

data/lib/wallee-ruby-sdk/models/product_metered_fee.rb

@@ -20,10 +20,10 @@ require 'date'
 module Wallee
   # 
   class ProductMeteredFee
-    # 
+    # The product component that the fee belongs to.
     attr_accessor :component
 
-    # The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.
+    # The localized description of the fee that is displayed to the customer.
     attr_accessor :description
 
     # A unique identifier for the object.
@@ -32,16 +32,16 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The metric used to determine the resource consumption billed to the customer.
     attr_accessor :metric
 
-    # The name of the fee should describe for the subscriber in few words for what the fee is for.
+    # The localized name of the fee that is displayed to the customer.
     attr_accessor :name
 
-    # The tier pricing determines the calculation method of the tiers. The prices of the different tiers can be applied in different ways. The tier pricing controls this calculation.
+    # The method used to calculate the tier price.
     attr_accessor :tier_pricing
 
-    # 
+    # The type of the fee.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

data/lib/wallee-ruby-sdk/models/product_metered_fee_update.rb

@@ -26,19 +26,19 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # 
+    # The product component that the fee belongs to.
     attr_accessor :component
 
-    # The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.
+    # The localized description of the fee that is displayed to the customer.
     attr_accessor :description
 
-    # 
+    # The metric used to determine the resource consumption billed to the customer.
     attr_accessor :metric
 
-    # The name of the fee should describe for the subscriber in few words for what the fee is for.
+    # The localized name of the fee that is displayed to the customer.
     attr_accessor :name
 
-    # The tier pricing determines the calculation method of the tiers. The prices of the different tiers can be applied in different ways. The tier pricing controls this calculation.
+    # The method used to calculate the tier price.
     attr_accessor :tier_pricing
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/product_metered_tier_fee.rb

@@ -20,16 +20,16 @@ require 'date'
 module Wallee
   # 
   class ProductMeteredTierFee
-    # The fee determines the amount which is charged. The consumed metric is multiplied by the defined fee. The resulting amount is charged at the end of the period.
+    # The amount charged to the customer for each consumed unit at the end of a billing cycle.
     attr_accessor :fee
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The metered fee that this tier belongs to.
     attr_accessor :metered_fee
 
-    # The start range defines the metered consumption of the metric from which on the defined fee gets applied. This means when a subscription consumes a value of 10 or more and the start range is set to 10 the fee defined on the tier will be applied.
+    # Starting from and including this quantity is contained in the tier.
     attr_accessor :start_range
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

data/lib/wallee-ruby-sdk/models/product_metered_tier_fee_update.rb

@@ -26,13 +26,13 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # The fee determines the amount which is charged. The consumed metric is multiplied by the defined fee. The resulting amount is charged at the end of the period.
+    # The amount charged to the customer for each consumed unit at the end of a billing cycle.
     attr_accessor :fee
 
-    # 
+    # The metered fee that this tier belongs to.
     attr_accessor :metered_fee
 
-    # The start range defines the metered consumption of the metric from which on the defined fee gets applied. This means when a subscription consumes a value of 10 or more and the start range is set to 10 the fee defined on the tier will be applied.
+    # Starting from and including this quantity is contained in the tier.
     attr_accessor :start_range
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/product_period_fee.rb

@@ -20,31 +20,31 @@ require 'date'
 module Wallee
   # 
   class ProductPeriodFee
-    # 
+    # The product component that the fee belongs to.
     attr_accessor :component
 
-    # The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.
+    # The localized description of the fee that is displayed to the customer.
     attr_accessor :description
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # The ledger entry title will be used for the title in the ledger entry and in the invoice.
+    # The localized title that be used on ledger entries and invoices.
     attr_accessor :ledger_entry_title
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The name of the fee should describe for the subscriber in few words for what the fee is for.
+    # The localized name of the fee that is displayed to the customer.
     attr_accessor :name
 
-    # The number of free trial periods specify how many periods are free of charge at the begining of the subscription.
+    # The number of subscription billing cycles that count as a trial phase and during which no fees are charged.
     attr_accessor :number_of_free_trial_periods
 
-    # The period fee is charged for every period of the subscription except for those periods which are trial periods.
+    # The amount charged to the customer for each billing cycle during the term of a subscription.
     attr_accessor :period_fee
 
-    # 
+    # The type of the fee.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

data/lib/wallee-ruby-sdk/models/product_period_fee_update.rb

@@ -26,22 +26,22 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # 
+    # The product component that the fee belongs to.
     attr_accessor :component
 
-    # The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.
+    # The localized description of the fee that is displayed to the customer.
     attr_accessor :description
 
-    # The ledger entry title will be used for the title in the ledger entry and in the invoice.
+    # The localized title that be used on ledger entries and invoices.
     attr_accessor :ledger_entry_title
 
-    # The name of the fee should describe for the subscriber in few words for what the fee is for.
+    # The localized name of the fee that is displayed to the customer.
     attr_accessor :name
 
-    # The number of free trial periods specify how many periods are free of charge at the begining of the subscription.
+    # The number of subscription billing cycles that count as a trial phase and during which no fees are charged.
     attr_accessor :number_of_free_trial_periods
 
-    # The period fee is charged for every period of the subscription except for those periods which are trial periods.
+    # The amount charged to the customer for each billing cycle during the term of a subscription.
     attr_accessor :period_fee
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/product_setup_fee.rb

@@ -20,10 +20,10 @@ require 'date'
 module Wallee
   # 
   class ProductSetupFee
-    # 
+    # The product component that the fee belongs to.
     attr_accessor :component
 
-    # The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.
+    # The localized description of the fee that is displayed to the customer.
     attr_accessor :description
 
     # A unique identifier for the object.
@@ -32,19 +32,19 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The name of the fee should describe for the subscriber in few words for what the fee is for.
+    # The localized name of the fee that is displayed to the customer.
     attr_accessor :name
 
-    # When the subscription is changed and the change is considered as a downgrade the amount defined by this property will be credited to the subscriber.
+    # The amount charged to the customer when a subscription is downgraded.
     attr_accessor :on_downgrade_credited_amount
 
-    # When the subscription is changed and the change is considered as a upgrade the amount defined by this property will be credited to the subscriber.
+    # The amount charged to the customer when a subscription is upgraded.
     attr_accessor :on_upgrade_credited_amount
 
-    # The setup fee is charged when the subscriber subscribes to this component. The setup fee is debited with the first charge for the subscriptions.
+    # The amount charged to the customer once when they subscribe to a subscription.
     attr_accessor :setup_fee
 
-    # 
+    # The type of the fee.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

data/lib/wallee-ruby-sdk/models/product_setup_fee_update.rb

@@ -26,22 +26,22 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # 
+    # The product component that the fee belongs to.
     attr_accessor :component
 
-    # The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.
+    # The localized description of the fee that is displayed to the customer.
     attr_accessor :description
 
-    # The name of the fee should describe for the subscriber in few words for what the fee is for.
+    # The localized name of the fee that is displayed to the customer.
     attr_accessor :name
 
-    # When the subscription is changed and the change is considered as a downgrade the amount defined by this property will be credited to the subscriber.
+    # The amount charged to the customer when a subscription is downgraded.
     attr_accessor :on_downgrade_credited_amount
 
-    # When the subscription is changed and the change is considered as a upgrade the amount defined by this property will be credited to the subscriber.
+    # The amount charged to the customer when a subscription is upgraded.
     attr_accessor :on_upgrade_credited_amount
 
-    # The setup fee is charged when the subscriber subscribes to this component. The setup fee is debited with the first charge for the subscriptions.
+    # The amount charged to the customer once when they subscribe to a subscription.
     attr_accessor :setup_fee
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/refund.rb

@@ -18,99 +18,99 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).
+  # A refund is a credit issued to the customer, which can be initiated either by the merchant or by the customer as a reversal.
   class Refund
-    # 
+    # The total monetary amount of the refund, representing the exact credit issued to the customer.
     attr_accessor :amount
 
-    # 
+    # The original base line items from the transaction prior to the refund, serving as a reference for the refunded amounts.
     attr_accessor :base_line_items
 
-    # 
+    # The transaction completion that the refund belongs to.
     attr_accessor :completion
 
-    # 
+    # The ID of the user the refund was created by.
     attr_accessor :created_by
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The environment used when rendering resources.
     attr_accessor :environment
 
-    # The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
+    # A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
     attr_accessor :external_id
 
-    # 
+    # The date and time when the refund failed.
     attr_accessor :failed_on
 
-    # 
+    # The reason for the failure of the refund.
     attr_accessor :failure_reason
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The labels providing additional information about the object.
     attr_accessor :labels
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # 
+    # The line items included in the refund, representing the reductions.
     attr_accessor :line_items
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The merchant's reference used to identify the refund.
     attr_accessor :merchant_reference
 
-    # 
+    # The date and time when the next update of the object's state is planned.
     attr_accessor :next_update_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 date and time when the processing of the refund was started.
     attr_accessor :processing_on
 
-    # 
+    # The reference ID provided by the payment processor, used to trace the refund through the external payment system.
     attr_accessor :processor_reference
 
-    # 
+    # The line items from the original transaction, adjusted to reflect any reductions applied during the refund process.
     attr_accessor :reduced_line_items
 
-    # 
+    # The reductions applied on the original transaction items, detailing specific adjustments associated with the refund.
     attr_accessor :reductions
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The date and time when the refund succeeded.
     attr_accessor :succeeded_on
 
-    # 
+    # The tax breakdown applied to the refund amount, helping with tax calculations or reporting.
     attr_accessor :taxes
 
-    # 
+    # The time zone that this object is associated with.
     attr_accessor :time_zone
 
-    # 
+    # The date and time when the object will expire.
     attr_accessor :timeout_on
 
-    # The total applied fees is the sum of all fees that have been applied so far.
+    # The sum of fees applied to the refund transaction, such as processing or service charges.
     attr_accessor :total_applied_fees
 
-    # The total settled amount is the total amount which has been settled so far.
+    # The total amount settled for the refund, factoring in reductions, taxes, and any additional applied fees.
     attr_accessor :total_settled_amount
 
-    # 
+    # The transaction that the refund belongs to.
     attr_accessor :transaction
 
-    # 
+    # The type specifying the method and origin of the refund (e.g., initiated by the customer or merchant).
     attr_accessor :type
 
-    # 
+    # An updated invoice reflecting adjustments made by the refund.
     attr_accessor :updated_invoice
 
     # The version is used for optimistic locking and incremented whenever the object is updated.