wallee-ruby-sdk 4.4.0 → 5.2.0

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

@@ -20,91 +20,91 @@ 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.
+    # The sum of all unpaid item prices in the case's currency. The amount can no longer be changed once the case has been reviewed.
     attr_accessor :amount
 
-    # The billing address of the case identifies the debtor.
+    # The billing address that identifies the debtor.
     attr_accessor :billing_address
 
-    # The closed on date indicates when the case is closed on.
+    # The date and time when the case was closed.
     attr_accessor :closed_on
 
-    # The collector configuration determines how the debt collection case is processed.
+    # The configuration that the case is processed with.
     attr_accessor :collector_configuration
 
-    # The contract date is the date on which the contract with the debtor was signed on.
+    # The date and time when the contract with the debtor was signed.
     attr_accessor :contract_date
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The creator references the user which has created the debt collection case.
+    # The ID of the user the case was created by.
     attr_accessor :creator
 
-    # The currency defines the billing currency of the debt collection case.
+    # The three-letter code (ISO 4217 format) of the case's currency.
     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.
+    # The date and time when the claim was due.
     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.
+    # The environment in which the case is processed.
     attr_accessor :environment
 
-    # A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
+    # 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 failed on date indicates when the case is failed on.
+    # The date and time when the case failed.
     attr_accessor :failed_on
 
-    # 
+    # The reason for the failure of the case.
     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 indicates the language to be used in the communication with the debtor.
+    # The language that is linked to the object.
     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.
+    # The line items that are subject of this debt collection case.
     attr_accessor :line_items
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The date and time when the next attempt at processing the case will be made.
     attr_accessor :next_attempt_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 processing started on date indicates the date on which the processing of the case started on.
+    # The date and time when the processing of the case was started.
     attr_accessor :processing_started_on
 
-    # 
+    # The date and time when the processing of the case times out.
     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.
+    # A unique reference to identify the debt collection case in communication with the debtor.
     attr_accessor :reference
 
-    # 
+    # The date and time when the review of the case was started.
     attr_accessor :review_started_on
 
-    # The reviewed on date indicates when the review of the case was conducted on.
+    # The date and time when the case was reviewed.
     attr_accessor :reviewed_on
 
-    # The reviewer references the user which has reviewed the case.
+    # The ID of the user the case was reviewed by.
     attr_accessor :reviewer
 
-    # The source of the debt collection case indicates the origin of the amount receivable.
+    # The source of the case stating the origin of the claim.
     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.
+    # The ID of the object that is the source of the case. Only defined if the case was created by an internal process.
     attr_accessor :source_entity_id
 
-    # 
+    # The ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
     # The object's current state.

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

@@ -20,37 +20,37 @@ require 'date'
 module Wallee
   # The debt collection case represents a try to collect the money from the debtor.
   class DebtCollectionCaseCreate
-    # The billing address of the case identifies the debtor.
+    # The billing address that identifies the debtor.
     attr_accessor :billing_address
 
-    # The contract date is the date on which the contract with the debtor was signed on.
+    # The date and time when the contract with the debtor was signed.
     attr_accessor :contract_date
 
-    # The currency defines the billing currency of the debt collection case.
+    # The three-letter code (ISO 4217 format) of the case's currency.
     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.
+    # The date and time when the claim was due.
     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.
+    # The environment in which the case is processed.
     attr_accessor :environment
 
-    # The language indicates the language to be used in the communication with the debtor.
+    # The language that is linked to the object.
     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.
+    # The line items that are subject of this debt collection case.
     attr_accessor :line_items
 
-    # 
+    # The ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
-    # The collector configuration determines how the debt collection case is processed.
+    # The configuration that the case is processed with.
     attr_accessor :collector_configuration
 
-    # A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
+    # 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 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.
+    # A unique reference to identify the debt collection case in communication with the debtor.
     attr_accessor :reference
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -23,31 +23,28 @@ module Wallee
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The debt collection case that this document belongs to.
     attr_accessor :debt_collection_case
 
-    # 
+    # The file name of the document.
     attr_accessor :file_name
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The labels providing additional information about the object.
     attr_accessor :labels
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The MIME type of the document's content.
     attr_accessor :mime_type
 
     # 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
 
-    # 
-    attr_accessor :storage_id
-
-    # 
+    # A unique identifier of the document.
     attr_accessor :unique_id
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -64,7 +61,6 @@ module Wallee
         :'linked_space_id' => :'linkedSpaceId',
         :'mime_type' => :'mimeType',
         :'planned_purge_date' => :'plannedPurgeDate',
-        :'storage_id' => :'storageId',
         :'unique_id' => :'uniqueId',
         :'version' => :'version'
       }
@@ -81,7 +77,6 @@ module Wallee
         :'linked_space_id' => :'Integer',
         :'mime_type' => :'String',
         :'planned_purge_date' => :'DateTime',
-        :'storage_id' => :'String',
         :'unique_id' => :'String',
         :'version' => :'Integer'
       }
@@ -129,10 +124,6 @@ module Wallee
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
 
-      if attributes.has_key?(:'storageId')
-        self.storage_id = attributes[:'storageId']
-      end
-
       if attributes.has_key?(:'uniqueId')
         self.unique_id = attributes[:'uniqueId']
       end
@@ -150,10 +141,6 @@ module Wallee
         invalid_properties.push('invalid value for "file_name", the character length must be smaller than or equal to 100.')
       end
 
-      if !@storage_id.nil? && @storage_id.to_s.length > 100
-        invalid_properties.push('invalid value for "storage_id", the character length must be smaller than or equal to 100.')
-      end
-
       if !@unique_id.nil? && @unique_id.to_s.length > 500
         invalid_properties.push('invalid value for "unique_id", the character length must be smaller than or equal to 500.')
       end
@@ -165,7 +152,6 @@ module Wallee
     # @return true if the model is valid
     def valid?
       return false if !@file_name.nil? && @file_name.to_s.length > 100
-      return false if !@storage_id.nil? && @storage_id.to_s.length > 100
       return false if !@unique_id.nil? && @unique_id.to_s.length > 500
       true
     end
@@ -180,16 +166,6 @@ module Wallee
       @file_name = file_name
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] storage_id Value to be assigned
-    def storage_id=(storage_id)
-      if !storage_id.nil? && storage_id.to_s.length > 100
-        fail ArgumentError, 'invalid value for "storage_id", the character length must be smaller than or equal to 100.'
-      end
-
-      @storage_id = storage_id
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] unique_id Value to be assigned
     def unique_id=(unique_id)
@@ -213,7 +189,6 @@ module Wallee
           linked_space_id == o.linked_space_id &&
           mime_type == o.mime_type &&
           planned_purge_date == o.planned_purge_date &&
-          storage_id == o.storage_id &&
           unique_id == o.unique_id &&
           version == o.version
     end
@@ -227,7 +202,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [created_on, debt_collection_case, file_name, id, labels, linked_space_id, mime_type, planned_purge_date, storage_id, unique_id, version].hash
+      [created_on, debt_collection_case, file_name, id, labels, linked_space_id, mime_type, planned_purge_date, unique_id, version].hash
     end
 
     # Builds the object from hash

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

@@ -18,12 +18,12 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # The debt collection case source represents the origin of the case. It allows to understand from where the amount receivable is coming from.
+  # The debt collection case source represents the origin of the case. It allows to understand where the amount receivable is coming from.
   class DebtCollectionCaseSource
     # The localized description of the object.
     attr_accessor :description
 
-    # 
+    # Whether debt collection cases created from this source will skip review and directly enter preparing state.
     attr_accessor :forced_preparing_state
 
     # A unique identifier for the object.

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

@@ -20,28 +20,28 @@ require 'date'
 module Wallee
   # The debt collection case represents a try to collect the money from the debtor.
   class DebtCollectionCaseUpdate
-    # The billing address of the case identifies the debtor.
+    # The billing address that identifies the debtor.
     attr_accessor :billing_address
 
-    # The contract date is the date on which the contract with the debtor was signed on.
+    # The date and time when the contract with the debtor was signed.
     attr_accessor :contract_date
 
-    # The currency defines the billing currency of the debt collection case.
+    # The three-letter code (ISO 4217 format) of the case's currency.
     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.
+    # The date and time when the claim was due.
     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.
+    # The environment in which the case is processed.
     attr_accessor :environment
 
-    # The language indicates the language to be used in the communication with the debtor.
+    # The language that is linked to the object.
     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.
+    # The line items that are subject of this debt collection case.
     attr_accessor :line_items
 
-    # 
+    # The ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
     # The ID is the primary key of the entity. The ID identifies the entity uniquely.

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

@@ -20,19 +20,19 @@ require 'date'
 module Wallee
   # 
   class DebtCollectionReceipt
-    # 
+    # The amount that was collected.
     attr_accessor :amount
 
-    # The created by field indicates the user which has created the receipt.
+    # The ID of the user the receipt was created by.
     attr_accessor :created_by
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The debt collection case that this document belongs to.
     attr_accessor :debt_collection_case
 
-    # The external id is a unique identifier for the receipt. The external id has to be unique in combination with the debt collection case. When a receipt is sent with an existing external id the existing one is returned rather than a new one is created.
+    # A client-generated nonce which uniquely identifies the receipt.Subsequent requests with the same external ID do not lead to the creation of another receipt, but return the original one.
     attr_accessor :external_id
 
     # A unique identifier for the object.
@@ -44,7 +44,7 @@ module Wallee
     # 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 source stating where the receipt is coming from.
     attr_accessor :source
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -18,7 +18,7 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # The debt collector connects to an external service to process the debt collection case and as such directs the debt collection process.
+  # The debt collector connects to an external service to process debt collection cases and directs the debt collection process.
   class DebtCollector
     # The localized description of the object.
     attr_accessor :description

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

@@ -26,7 +26,7 @@ module Wallee
     # 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.
@@ -35,7 +35,7 @@ module Wallee
     # The object's current state.
     attr_accessor :state
 
-    # The condition type determines the condition realization.
+    # The condition type determines the criteria that a debt collection case must fulfill in order for a debt collector configuration to be considered for handling the case.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -18,7 +18,7 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # The debt collection condition type controls how a condition is applied to a case.
+  # 
   class DebtCollectorConditionType
     # The localized description of the object.
     attr_accessor :description

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

@@ -20,13 +20,13 @@ require 'date'
 module Wallee
   # The debt collector configuration defines the behavior of the collection process for a particular collector.
   class DebtCollectorConfiguration
-    # The collector handles the debt collection case based on the settings of this configuration.
+    # The debt collector that the configuration is for.
     attr_accessor :collector
 
-    # The conditions applied to the collector configuration restricts the application of this configuration onto a particular debt collection case.
+    # Conditions allow to define criteria that a debt collection case must fulfill in order for the debt collector configuration to be considered for processing the case.
     attr_accessor :conditions
 
-    # The collector configuration is only enabled for the selected space views. In case the set is empty the collector configuration is enabled for all space views.
+    # The space views for which the debt collector configuration is enabled. If empty, it is enabled for all space views.
     attr_accessor :enabled_space_views
 
     # A unique identifier for the object.
@@ -35,16 +35,16 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The collector configuration name is used internally to identify a specific collector configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
+    # The name used to identify the debt collector configuration.
     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 defines the order in which the collector configuration is tried to be applied onto a debt collection case. The higher the value the less likely the configuration is applied on a case.
+    # The priority that determines the order in which debt collector configurations are taken into account when processing a case. Low values are considered first.
     attr_accessor :priority
 
-    # When the review is skipped there will be no review for cases which use this configuration.
+    # Whether the review of debt collection cases is skipped.
     attr_accessor :skip_review_enabled
 
     # The object's current state.

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

@@ -20,34 +20,34 @@ require 'date'
 module Wallee
   # 
   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 Wallee
     # 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 Wallee
     # 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 Wallee
       # 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 Wallee
         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 Wallee
     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 Wallee
     # 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

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

@@ -0,0 +1,40 @@
+=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 DisplayableDayOfWeek
+    
+    MONDAY = 'MONDAY'.freeze
+    TUESDAY = 'TUESDAY'.freeze
+    WEDNESDAY = 'WEDNESDAY'.freeze
+    THURSDAY = 'THURSDAY'.freeze
+    FRIDAY = 'FRIDAY'.freeze
+    SATURDAY = 'SATURDAY'.freeze
+    SUNDAY = 'SUNDAY'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = DisplayableDayOfWeek.constants.select { |c| DisplayableDayOfWeek::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #DisplayableDayOfWeek" if constantValues.empty?
+      value
+    end
+  end
+end