postfinancecheckout-ruby-sdk 3.0.2

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

@@ -0,0 +1,528 @@
+=begin
+The PostFinance Checkout API allows an easy interaction with the PostFinance Checkout 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 PostFinanceCheckout
+  # 
+  class TransactionCompletion
+    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    attr_accessor :id
+
+    # The linked space id holds the ID of the space to which the entity belongs to.
+    attr_accessor :linked_space_id
+
+    # 
+    attr_accessor :linked_transaction
+
+    # The amount which is captured. The amount represents sum of line items including taxes.
+    attr_accessor :amount
+
+    # The base line items on which the completion is applied on.
+    attr_accessor :base_line_items
+
+    # 
+    attr_accessor :created_by
+
+    # The created on date indicates the date on which the entity was stored into the database.
+    attr_accessor :created_on
+
+    # The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
+    attr_accessor :external_id
+
+    # 
+    attr_accessor :failed_on
+
+    # 
+    attr_accessor :failure_reason
+
+    # 
+    attr_accessor :invoice_merchant_reference
+
+    # 
+    attr_accessor :labels
+
+    # 
+    attr_accessor :language
+
+    # Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.
+    attr_accessor :last_completion
+
+    # 
+    attr_accessor :line_item_version
+
+    # The line items which are captured.
+    attr_accessor :line_items
+
+    # 
+    attr_accessor :mode
+
+    # 
+    attr_accessor :next_update_on
+
+    # 
+    attr_accessor :payment_information
+
+    # The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
+    attr_accessor :planned_purge_date
+
+    # 
+    attr_accessor :processing_on
+
+    # 
+    attr_accessor :processor_reference
+
+    # 
+    attr_accessor :remaining_line_items
+
+    # 
+    attr_accessor :space_view_id
+
+    # 
+    attr_accessor :state
+
+    # 
+    attr_accessor :succeeded_on
+
+    # The total sum of all taxes of line items.
+    attr_accessor :tax_amount
+
+    # 
+    attr_accessor :time_zone
+
+    # 
+    attr_accessor :timeout_on
+
+    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
+        :'amount' => :'amount',
+        :'base_line_items' => :'baseLineItems',
+        :'created_by' => :'createdBy',
+        :'created_on' => :'createdOn',
+        :'external_id' => :'externalId',
+        :'failed_on' => :'failedOn',
+        :'failure_reason' => :'failureReason',
+        :'invoice_merchant_reference' => :'invoiceMerchantReference',
+        :'labels' => :'labels',
+        :'language' => :'language',
+        :'last_completion' => :'lastCompletion',
+        :'line_item_version' => :'lineItemVersion',
+        :'line_items' => :'lineItems',
+        :'mode' => :'mode',
+        :'next_update_on' => :'nextUpdateOn',
+        :'payment_information' => :'paymentInformation',
+        :'planned_purge_date' => :'plannedPurgeDate',
+        :'processing_on' => :'processingOn',
+        :'processor_reference' => :'processorReference',
+        :'remaining_line_items' => :'remainingLineItems',
+        :'space_view_id' => :'spaceViewId',
+        :'state' => :'state',
+        :'succeeded_on' => :'succeededOn',
+        :'tax_amount' => :'taxAmount',
+        :'time_zone' => :'timeZone',
+        :'timeout_on' => :'timeoutOn',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'Integer',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
+        :'amount' => :'Float',
+        :'base_line_items' => :'Array<LineItem>',
+        :'created_by' => :'Integer',
+        :'created_on' => :'DateTime',
+        :'external_id' => :'String',
+        :'failed_on' => :'DateTime',
+        :'failure_reason' => :'FailureReason',
+        :'invoice_merchant_reference' => :'String',
+        :'labels' => :'Array<Label>',
+        :'language' => :'String',
+        :'last_completion' => :'BOOLEAN',
+        :'line_item_version' => :'TransactionLineItemVersion',
+        :'line_items' => :'Array<LineItem>',
+        :'mode' => :'TransactionCompletionMode',
+        :'next_update_on' => :'DateTime',
+        :'payment_information' => :'String',
+        :'planned_purge_date' => :'DateTime',
+        :'processing_on' => :'DateTime',
+        :'processor_reference' => :'String',
+        :'remaining_line_items' => :'Array<LineItem>',
+        :'space_view_id' => :'Integer',
+        :'state' => :'TransactionCompletionState',
+        :'succeeded_on' => :'DateTime',
+        :'tax_amount' => :'Float',
+        :'time_zone' => :'String',
+        :'timeout_on' => :'DateTime',
+        :'version' => :'Integer'
+      }
+    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?(:'linkedTransaction')
+        self.linked_transaction = attributes[:'linkedTransaction']
+      end
+
+      if attributes.has_key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'baseLineItems')
+        if (value = attributes[:'baseLineItems']).is_a?(Array)
+          self.base_line_items = value
+        end
+      end
+
+      if attributes.has_key?(:'createdBy')
+        self.created_by = attributes[:'createdBy']
+      end
+
+      if attributes.has_key?(:'createdOn')
+        self.created_on = attributes[:'createdOn']
+      end
+
+      if attributes.has_key?(:'externalId')
+        self.external_id = attributes[:'externalId']
+      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?(:'invoiceMerchantReference')
+        self.invoice_merchant_reference = attributes[:'invoiceMerchantReference']
+      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?(:'lastCompletion')
+        self.last_completion = attributes[:'lastCompletion']
+      end
+
+      if attributes.has_key?(:'lineItemVersion')
+        self.line_item_version = attributes[:'lineItemVersion']
+      end
+
+      if attributes.has_key?(:'lineItems')
+        if (value = attributes[:'lineItems']).is_a?(Array)
+          self.line_items = value
+        end
+      end
+
+      if attributes.has_key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.has_key?(:'nextUpdateOn')
+        self.next_update_on = attributes[:'nextUpdateOn']
+      end
+
+      if attributes.has_key?(:'paymentInformation')
+        self.payment_information = attributes[:'paymentInformation']
+      end
+
+      if attributes.has_key?(:'plannedPurgeDate')
+        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      end
+
+      if attributes.has_key?(:'processingOn')
+        self.processing_on = attributes[:'processingOn']
+      end
+
+      if attributes.has_key?(:'processorReference')
+        self.processor_reference = attributes[:'processorReference']
+      end
+
+      if attributes.has_key?(:'remainingLineItems')
+        if (value = attributes[:'remainingLineItems']).is_a?(Array)
+          self.remaining_line_items = value
+        end
+      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?(:'taxAmount')
+        self.tax_amount = attributes[:'taxAmount']
+      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?(:'version')
+        self.version = attributes[:'version']
+      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
+      if !@external_id.nil? && @external_id.to_s.length > 100
+        invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@external_id.nil? && @external_id.to_s.length < 1
+        invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
+      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
+
+      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?
+      return false if !@external_id.nil? && @external_id.to_s.length > 100
+      return false if !@external_id.nil? && @external_id.to_s.length < 1
+      return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] external_id Value to be assigned
+    def external_id=(external_id)
+      if !external_id.nil? && external_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 100.'
+      end
+
+      if !external_id.nil? && external_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "external_id", the character length must be great than or equal to 1.'
+      end
+
+      @external_id = external_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_merchant_reference Value to be assigned
+    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
+
+    # 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 &&
+          linked_transaction == o.linked_transaction &&
+          amount == o.amount &&
+          base_line_items == o.base_line_items &&
+          created_by == o.created_by &&
+          created_on == o.created_on &&
+          external_id == o.external_id &&
+          failed_on == o.failed_on &&
+          failure_reason == o.failure_reason &&
+          invoice_merchant_reference == o.invoice_merchant_reference &&
+          labels == o.labels &&
+          language == o.language &&
+          last_completion == o.last_completion &&
+          line_item_version == o.line_item_version &&
+          line_items == o.line_items &&
+          mode == o.mode &&
+          next_update_on == o.next_update_on &&
+          payment_information == o.payment_information &&
+          planned_purge_date == o.planned_purge_date &&
+          processing_on == o.processing_on &&
+          processor_reference == o.processor_reference &&
+          remaining_line_items == o.remaining_line_items &&
+          space_view_id == o.space_view_id &&
+          state == o.state &&
+          succeeded_on == o.succeeded_on &&
+          tax_amount == o.tax_amount &&
+          time_zone == o.time_zone &&
+          timeout_on == o.timeout_on &&
+          version == o.version
+    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, linked_transaction, amount, base_line_items, created_by, created_on, external_id, failed_on, failure_reason, invoice_merchant_reference, labels, language, last_completion, line_item_version, line_items, mode, next_update_on, payment_information, planned_purge_date, processing_on, processor_reference, remaining_line_items, space_view_id, state, succeeded_on, tax_amount, time_zone, timeout_on, version].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 = PostFinanceCheckout.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