wallee-ruby-sdk 1.0.1 → 1.0.2

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

@@ -0,0 +1,502 @@
+=begin
+Wallee API: 1.0.0
+
+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
+  # The debt collection case represents a try to collect the money from the debtor.
+  class DebtCollectionCase
+    # The amount is the total amount of the not paid items. The amount cannot be change once the case is reviewed.
+    attr_accessor :amount
+
+    # The billing address of the case identifies the debtor.
+    attr_accessor :billing_address
+
+    # The closed on date indicates when the case is closed on.
+    attr_accessor :closed_on
+
+    # The collector configuration determines how the debt collection case is processed.
+    attr_accessor :collector_configuration
+
+    # The contract date is the date on which the contract with the debtor was signed on.
+    attr_accessor :contract_date
+
+    # The created on date indicates the date on which the entity was stored into the database.
+    attr_accessor :created_on
+
+    # The creator references the user which has created the debt collection case.
+    attr_accessor :creator
+
+    # The currency defines the billing currency of the debt collection case.
+    attr_accessor :currency
+
+    # The due date indicates the date on which the amount receivable was due. This date has to be always in the past.
+    attr_accessor :due_date
+
+    # The environment in which this case will be processed. There must be a debt collector configuration present which supports the chosen environment.
+    attr_accessor :environment
+
+    # 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
+
+    # The failed on date indicates when the case is failed on.
+    attr_accessor :failed_on
+
+    # 
+    attr_accessor :failure_reason
+
+    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    attr_accessor :id
+
+    # 
+    attr_accessor :labels
+
+    # The language indicates the language to be used in the communication with the debtor.
+    attr_accessor :language
+
+    # The line items of the debt collection case will be shown on documents sent to the debtor and the total of them makes up total amount to collect.
+    attr_accessor :line_items
+
+    # The linked space id holds the ID of the space to which the entity belongs to.
+    attr_accessor :linked_space_id
+
+    # 
+    attr_accessor :next_attempt_on
+
+    # 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
+
+    # The processing started on date indicates the date on which the processing of the case started on.
+    attr_accessor :processing_started_on
+
+    # 
+    attr_accessor :processing_timeout_on
+
+    # The case reference is used in the communication with the debtor. It should be unique and it should be linkable with the source of the debt collection case.
+    attr_accessor :reference
+
+    # 
+    attr_accessor :review_started_on
+
+    # The reviewed on date indicates when the review of the case was conducted on.
+    attr_accessor :reviewed_on
+
+    # The reviewer references the user which has reviewed the case.
+    attr_accessor :reviewer
+
+    # The source of the debt collection case indicates the origin of the amount receivable.
+    attr_accessor :source
+
+    # The source entity ID points to the object which is the origin of the debt collection case. This ID is only set when the case was triggered by an internal process.
+    attr_accessor :source_entity_id
+
+    # 
+    attr_accessor :space_view_id
+
+    # 
+    attr_accessor :state
+
+    # 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
+      {
+        :'amount' => :'amount',
+        :'billing_address' => :'billingAddress',
+        :'closed_on' => :'closedOn',
+        :'collector_configuration' => :'collectorConfiguration',
+        :'contract_date' => :'contractDate',
+        :'created_on' => :'createdOn',
+        :'creator' => :'creator',
+        :'currency' => :'currency',
+        :'due_date' => :'dueDate',
+        :'environment' => :'environment',
+        :'external_id' => :'externalId',
+        :'failed_on' => :'failedOn',
+        :'failure_reason' => :'failureReason',
+        :'id' => :'id',
+        :'labels' => :'labels',
+        :'language' => :'language',
+        :'line_items' => :'lineItems',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'next_attempt_on' => :'nextAttemptOn',
+        :'planned_purge_date' => :'plannedPurgeDate',
+        :'processing_started_on' => :'processingStartedOn',
+        :'processing_timeout_on' => :'processingTimeoutOn',
+        :'reference' => :'reference',
+        :'review_started_on' => :'reviewStartedOn',
+        :'reviewed_on' => :'reviewedOn',
+        :'reviewer' => :'reviewer',
+        :'source' => :'source',
+        :'source_entity_id' => :'sourceEntityId',
+        :'space_view_id' => :'spaceViewId',
+        :'state' => :'state',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'amount' => :'Float',
+        :'billing_address' => :'Address',
+        :'closed_on' => :'DateTime',
+        :'collector_configuration' => :'DebtCollectorConfiguration',
+        :'contract_date' => :'DateTime',
+        :'created_on' => :'DateTime',
+        :'creator' => :'Integer',
+        :'currency' => :'String',
+        :'due_date' => :'DateTime',
+        :'environment' => :'DebtCollectionEnvironment',
+        :'external_id' => :'String',
+        :'failed_on' => :'DateTime',
+        :'failure_reason' => :'FailureReason',
+        :'id' => :'Integer',
+        :'labels' => :'Array<Label>',
+        :'language' => :'String',
+        :'line_items' => :'Array<LineItem>',
+        :'linked_space_id' => :'Integer',
+        :'next_attempt_on' => :'DateTime',
+        :'planned_purge_date' => :'DateTime',
+        :'processing_started_on' => :'DateTime',
+        :'processing_timeout_on' => :'DateTime',
+        :'reference' => :'String',
+        :'review_started_on' => :'DateTime',
+        :'reviewed_on' => :'DateTime',
+        :'reviewer' => :'Integer',
+        :'source' => :'DebtCollectionCaseSource',
+        :'source_entity_id' => :'Integer',
+        :'space_view_id' => :'Integer',
+        :'state' => :'DebtCollectionCaseState',
+        :'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?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'billingAddress')
+        self.billing_address = attributes[:'billingAddress']
+      end
+
+      if attributes.has_key?(:'closedOn')
+        self.closed_on = attributes[:'closedOn']
+      end
+
+      if attributes.has_key?(:'collectorConfiguration')
+        self.collector_configuration = attributes[:'collectorConfiguration']
+      end
+
+      if attributes.has_key?(:'contractDate')
+        self.contract_date = attributes[:'contractDate']
+      end
+
+      if attributes.has_key?(:'createdOn')
+        self.created_on = attributes[:'createdOn']
+      end
+
+      if attributes.has_key?(:'creator')
+        self.creator = attributes[:'creator']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'dueDate')
+        self.due_date = attributes[:'dueDate']
+      end
+
+      if attributes.has_key?(:'environment')
+        self.environment = attributes[:'environment']
+      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?(:'id')
+        self.id = attributes[:'id']
+      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?(:'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?(:'nextAttemptOn')
+        self.next_attempt_on = attributes[:'nextAttemptOn']
+      end
+
+      if attributes.has_key?(:'plannedPurgeDate')
+        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      end
+
+      if attributes.has_key?(:'processingStartedOn')
+        self.processing_started_on = attributes[:'processingStartedOn']
+      end
+
+      if attributes.has_key?(:'processingTimeoutOn')
+        self.processing_timeout_on = attributes[:'processingTimeoutOn']
+      end
+
+      if attributes.has_key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.has_key?(:'reviewStartedOn')
+        self.review_started_on = attributes[:'reviewStartedOn']
+      end
+
+      if attributes.has_key?(:'reviewedOn')
+        self.reviewed_on = attributes[:'reviewedOn']
+      end
+
+      if attributes.has_key?(:'reviewer')
+        self.reviewer = attributes[:'reviewer']
+      end
+
+      if attributes.has_key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.has_key?(:'sourceEntityId')
+        self.source_entity_id = attributes[:'sourceEntityId']
+      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?(:'version')
+        self.version = attributes[:'version']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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 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 &&
+          amount == o.amount &&
+          billing_address == o.billing_address &&
+          closed_on == o.closed_on &&
+          collector_configuration == o.collector_configuration &&
+          contract_date == o.contract_date &&
+          created_on == o.created_on &&
+          creator == o.creator &&
+          currency == o.currency &&
+          due_date == o.due_date &&
+          environment == o.environment &&
+          external_id == o.external_id &&
+          failed_on == o.failed_on &&
+          failure_reason == o.failure_reason &&
+          id == o.id &&
+          labels == o.labels &&
+          language == o.language &&
+          line_items == o.line_items &&
+          linked_space_id == o.linked_space_id &&
+          next_attempt_on == o.next_attempt_on &&
+          planned_purge_date == o.planned_purge_date &&
+          processing_started_on == o.processing_started_on &&
+          processing_timeout_on == o.processing_timeout_on &&
+          reference == o.reference &&
+          review_started_on == o.review_started_on &&
+          reviewed_on == o.reviewed_on &&
+          reviewer == o.reviewer &&
+          source == o.source &&
+          source_entity_id == o.source_entity_id &&
+          space_view_id == o.space_view_id &&
+          state == o.state &&
+          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
+      [amount, billing_address, closed_on, collector_configuration, contract_date, created_on, creator, currency, due_date, environment, external_id, failed_on, failure_reason, id, labels, language, line_items, linked_space_id, next_attempt_on, planned_purge_date, processing_started_on, processing_timeout_on, reference, review_started_on, reviewed_on, reviewer, source, source_entity_id, space_view_id, state, 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 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