wallee-ruby-sdk 1.0.0 → 2.2.3

data/lib/{wallee/models/refund_create.rb → wallee-ruby-sdk/models/debt_collection_case.rb}

@@ -1,10 +1,6 @@
 =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
@@ -22,24 +18,42 @@ 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).
-  class RefundCreate
-    # 
+  # 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
 
-    # 
-    attr_accessor :base_line_items
+    # The billing address of the case identifies the debtor.
+    attr_accessor :billing_address
 
-    # 
-    attr_accessor :created_by
+    # 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 external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
+    # 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
 
     # 
@@ -51,62 +65,67 @@ module Wallee
     # 
     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 :merchant_reference
-
-    # 
-    attr_accessor :next_update_on
+    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
 
-    # 
-    attr_accessor :processor_reference
+    # The processing started on date indicates the date on which the processing of the case started on.
+    attr_accessor :processing_started_on
 
     # 
-    attr_accessor :reduced_line_items
+    attr_accessor :processing_timeout_on
 
-    # 
-    attr_accessor :reductions
+    # 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 :state
+    attr_accessor :review_started_on
 
-    # 
-    attr_accessor :succeeded_on
+    # The reviewed on date indicates when the review of the case was conducted on.
+    attr_accessor :reviewed_on
 
-    # 
-    attr_accessor :taxes
+    # The reviewer references the user which has reviewed the case.
+    attr_accessor :reviewer
 
-    # 
-    attr_accessor :timeout_on
+    # 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 :transaction
+    attr_accessor :space_view_id
 
     # 
-    attr_accessor :type
+    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',
-        :'base_line_items' => :'baseLineItems',
-        :'created_by' => :'createdBy',
+        :'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',
@@ -115,18 +134,18 @@ module Wallee
         :'language' => :'language',
         :'line_items' => :'lineItems',
         :'linked_space_id' => :'linkedSpaceId',
-        :'merchant_reference' => :'merchantReference',
-        :'next_update_on' => :'nextUpdateOn',
+        :'next_attempt_on' => :'nextAttemptOn',
         :'planned_purge_date' => :'plannedPurgeDate',
-        :'processor_reference' => :'processorReference',
-        :'reduced_line_items' => :'reducedLineItems',
-        :'reductions' => :'reductions',
+        :'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',
-        :'succeeded_on' => :'succeededOn',
-        :'taxes' => :'taxes',
-        :'timeout_on' => :'timeoutOn',
-        :'transaction' => :'transaction',
-        :'type' => :'type',
         :'version' => :'version'
       }
     end
@@ -135,9 +154,15 @@ module Wallee
     def self.swagger_types
       {
         :'amount' => :'Float',
-        :'base_line_items' => :'Array<LineItem>',
-        :'created_by' => :'Integer',
+        :'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',
@@ -146,18 +171,18 @@ module Wallee
         :'language' => :'String',
         :'line_items' => :'Array<LineItem>',
         :'linked_space_id' => :'Integer',
-        :'merchant_reference' => :'String',
-        :'next_update_on' => :'DateTime',
+        :'next_attempt_on' => :'DateTime',
         :'planned_purge_date' => :'DateTime',
-        :'processor_reference' => :'String',
-        :'reduced_line_items' => :'Array<LineItem>',
-        :'reductions' => :'Array<LineItemReductionCreate>',
-        :'state' => :'RefundState',
-        :'succeeded_on' => :'DateTime',
-        :'taxes' => :'Array<Tax>',
-        :'timeout_on' => :'DateTime',
-        :'transaction' => :'Integer',
-        :'type' => :'RefundType',
+        :'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
@@ -168,26 +193,48 @@ module Wallee
       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}
+      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?(:'baseLineItems')
-        if (value = attributes[:'baseLineItems']).is_a?(Array)
-          self.base_line_items = value
-        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?(:'createdBy')
-        self.created_by = attributes[:'createdBy']
+      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
@@ -224,97 +271,70 @@ module Wallee
         self.linked_space_id = attributes[:'linkedSpaceId']
       end
 
-      if attributes.has_key?(:'merchantReference')
-        self.merchant_reference = attributes[:'merchantReference']
-      end
-
-      if attributes.has_key?(:'nextUpdateOn')
-        self.next_update_on = attributes[:'nextUpdateOn']
+      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?(:'processorReference')
-        self.processor_reference = attributes[:'processorReference']
+      if attributes.has_key?(:'processingStartedOn')
+        self.processing_started_on = attributes[:'processingStartedOn']
       end
 
-      if attributes.has_key?(:'reducedLineItems')
-        if (value = attributes[:'reducedLineItems']).is_a?(Array)
-          self.reduced_line_items = value
-        end
+      if attributes.has_key?(:'processingTimeoutOn')
+        self.processing_timeout_on = attributes[:'processingTimeoutOn']
       end
 
-      if attributes.has_key?(:'reductions')
-        if (value = attributes[:'reductions']).is_a?(Array)
-          self.reductions = value
-        end
+      if attributes.has_key?(:'reference')
+        self.reference = attributes[:'reference']
       end
 
-      if attributes.has_key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.has_key?(:'reviewStartedOn')
+        self.review_started_on = attributes[:'reviewStartedOn']
       end
 
-      if attributes.has_key?(:'succeededOn')
-        self.succeeded_on = attributes[:'succeededOn']
+      if attributes.has_key?(:'reviewedOn')
+        self.reviewed_on = attributes[:'reviewedOn']
       end
 
-      if attributes.has_key?(:'taxes')
-        if (value = attributes[:'taxes']).is_a?(Array)
-          self.taxes = value
-        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?(:'timeoutOn')
-        self.timeout_on = attributes[:'timeoutOn']
+      if attributes.has_key?(:'sourceEntityId')
+        self.source_entity_id = attributes[:'sourceEntityId']
       end
 
-      if attributes.has_key?(:'transaction')
-        self.transaction = attributes[:'transaction']
+      if attributes.has_key?(:'spaceViewId')
+        self.space_view_id = attributes[:'spaceViewId']
       end
 
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
+      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
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @external_id.nil?
-        invalid_properties.push("invalid value for 'external_id', external_id cannot be nil.")
-      end
-
-      if @reductions.nil?
-        invalid_properties.push("invalid value for 'reductions', reductions cannot be nil.")
-      end
-
-      if @transaction.nil?
-        invalid_properties.push("invalid value for 'transaction', transaction cannot be nil.")
-      end
-
-      if @type.nil?
-        invalid_properties.push("invalid value for 'type', type cannot be nil.")
-      end
-
-      return invalid_properties
+      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?
-      return false if @reductions.nil?
-      return false if @transaction.nil?
-      return false if @type.nil?
-      return true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -323,9 +343,15 @@ module Wallee
       return true if self.equal?(o)
       self.class == o.class &&
           amount == o.amount &&
-          base_line_items == o.base_line_items &&
-          created_by == o.created_by &&
+          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 &&
@@ -334,18 +360,18 @@ module Wallee
           language == o.language &&
           line_items == o.line_items &&
           linked_space_id == o.linked_space_id &&
-          merchant_reference == o.merchant_reference &&
-          next_update_on == o.next_update_on &&
+          next_attempt_on == o.next_attempt_on &&
           planned_purge_date == o.planned_purge_date &&
-          processor_reference == o.processor_reference &&
-          reduced_line_items == o.reduced_line_items &&
-          reductions == o.reductions &&
+          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 &&
-          succeeded_on == o.succeeded_on &&
-          taxes == o.taxes &&
-          timeout_on == o.timeout_on &&
-          transaction == o.transaction &&
-          type == o.type &&
           version == o.version
     end
 
@@ -358,7 +384,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [amount, base_line_items, created_by, created_on, external_id, failed_on, failure_reason, id, labels, language, line_items, linked_space_id, merchant_reference, next_update_on, planned_purge_date, processor_reference, reduced_line_items, reductions, state, succeeded_on, taxes, timeout_on, transaction, type, version].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
@@ -368,7 +394,7 @@ module Wallee
       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
+          # 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) } )
@@ -466,5 +492,4 @@ module Wallee
     end
 
   end
-
 end