wallee-ruby-sdk 1.0.0 → 2.2.3

data/lib/{wallee/models/refund.rb → wallee-ruby-sdk/models/payment_link.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,111 +18,86 @@ 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 Refund
-    # 
-    attr_accessor :amount
+  # The payment link defines an URL to automatically create transactions.
+  class PaymentLink
+    # The allowed payment method configurations restrict the payment methods which can be used with this payment link.
+    attr_accessor :allowed_payment_method_configurations
 
-    # 
-    attr_accessor :base_line_items
+    # The payment link can be conducted in a specific space view. The space view may apply a specific design to the payment page.
+    attr_accessor :applied_space_view
 
-    # 
-    attr_accessor :created_by
+    # The available from date defines the earliest date on which the payment link can be used. When no date is specified there will be no restriction.
+    attr_accessor :available_from
 
-    # The created on date indicates the date on which the entity was stored into the database.
-    attr_accessor :created_on
+    # The available from date defines the latest date on which the payment link can be used to initialize a transaction. When no date is specified there will be no restriction.
+    attr_accessor :available_until
 
-    # The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
-    attr_accessor :external_id
+    # By making the billing address required the transaction can only be created when a billing address is provided within the request.
+    attr_accessor :billing_address_required
 
-    # 
-    attr_accessor :failed_on
+    # The currency defines in which currency the payment is executed in. If no currency is defined it has to be specified within the request parameter 'currency'.
+    attr_accessor :currency
 
-    # 
-    attr_accessor :failure_reason
+    # 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 ID is the primary key of the entity. The ID identifies the entity uniquely.
     attr_accessor :id
 
-    # 
-    attr_accessor :labels
-
-    # 
+    # The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.
     attr_accessor :language
 
-    # 
+    # The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters.
     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
+    # The maximal number of transactions limits the number of transactions which can be created with this payment link.
+    attr_accessor :maximal_number_of_transactions
 
-    # 
-    attr_accessor :next_update_on
+    # The payment link name is used internally to identify the payment link. For example the name is used within search fields and hence it should be distinct and descriptive.
+    attr_accessor :name
 
     # 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 protection mode determines if the payment link is protected against tampering and in what way.
+    attr_accessor :protection_mode
 
-    # 
-    attr_accessor :reduced_line_items
-
-    # 
-    attr_accessor :reductions
+    # By making the shipping address required the transaction can only be created when a shipping address is provided within the request.
+    attr_accessor :shipping_address_required
 
     # 
     attr_accessor :state
 
-    # 
-    attr_accessor :succeeded_on
-
-    # 
-    attr_accessor :taxes
-
-    # 
-    attr_accessor :timeout_on
-
-    # 
-    attr_accessor :transaction
-
-    # 
-    attr_accessor :type
+    # The URL defines the URL to which the user has to be forwarded to initialize the payment.
+    attr_accessor :url
 
     # 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',
-        :'created_on' => :'createdOn',
+        :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
+        :'applied_space_view' => :'appliedSpaceView',
+        :'available_from' => :'availableFrom',
+        :'available_until' => :'availableUntil',
+        :'billing_address_required' => :'billingAddressRequired',
+        :'currency' => :'currency',
         :'external_id' => :'externalId',
-        :'failed_on' => :'failedOn',
-        :'failure_reason' => :'failureReason',
         :'id' => :'id',
-        :'labels' => :'labels',
         :'language' => :'language',
         :'line_items' => :'lineItems',
         :'linked_space_id' => :'linkedSpaceId',
-        :'merchant_reference' => :'merchantReference',
-        :'next_update_on' => :'nextUpdateOn',
+        :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
+        :'name' => :'name',
         :'planned_purge_date' => :'plannedPurgeDate',
-        :'processor_reference' => :'processorReference',
-        :'reduced_line_items' => :'reducedLineItems',
-        :'reductions' => :'reductions',
+        :'protection_mode' => :'protectionMode',
+        :'shipping_address_required' => :'shippingAddressRequired',
         :'state' => :'state',
-        :'succeeded_on' => :'succeededOn',
-        :'taxes' => :'taxes',
-        :'timeout_on' => :'timeoutOn',
-        :'transaction' => :'transaction',
-        :'type' => :'type',
+        :'url' => :'url',
         :'version' => :'version'
       }
     end
@@ -134,30 +105,24 @@ module Wallee
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'amount' => :'Float',
-        :'base_line_items' => :'Array<LineItem>',
-        :'created_by' => :'Integer',
-        :'created_on' => :'DateTime',
+        :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
+        :'applied_space_view' => :'Integer',
+        :'available_from' => :'DateTime',
+        :'available_until' => :'DateTime',
+        :'billing_address_required' => :'BOOLEAN',
+        :'currency' => :'String',
         :'external_id' => :'String',
-        :'failed_on' => :'DateTime',
-        :'failure_reason' => :'FailureReason',
         :'id' => :'Integer',
-        :'labels' => :'Array<Label>',
         :'language' => :'String',
         :'line_items' => :'Array<LineItem>',
         :'linked_space_id' => :'Integer',
-        :'merchant_reference' => :'String',
-        :'next_update_on' => :'DateTime',
+        :'maximal_number_of_transactions' => :'Integer',
+        :'name' => :'String',
         :'planned_purge_date' => :'DateTime',
-        :'processor_reference' => :'String',
-        :'reduced_line_items' => :'Array<LineItem>',
-        :'reductions' => :'Array<LineItemReduction>',
-        :'state' => :'RefundState',
-        :'succeeded_on' => :'DateTime',
-        :'taxes' => :'Array<Tax>',
-        :'timeout_on' => :'DateTime',
-        :'transaction' => :'Transaction',
-        :'type' => :'RefundType',
+        :'protection_mode' => :'PaymentLinkProtectionMode',
+        :'shipping_address_required' => :'BOOLEAN',
+        :'state' => :'CreationEntityState',
+        :'url' => :'String',
         :'version' => :'Integer'
       }
     end
@@ -168,48 +133,42 @@ 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']
+      if attributes.has_key?(:'allowedPaymentMethodConfigurations')
+        if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array)
+          self.allowed_payment_method_configurations = value
+        end
       end
 
-      if attributes.has_key?(:'baseLineItems')
-        if (value = attributes[:'baseLineItems']).is_a?(Array)
-          self.base_line_items = value
-        end
+      if attributes.has_key?(:'appliedSpaceView')
+        self.applied_space_view = attributes[:'appliedSpaceView']
       end
 
-      if attributes.has_key?(:'createdBy')
-        self.created_by = attributes[:'createdBy']
+      if attributes.has_key?(:'availableFrom')
+        self.available_from = attributes[:'availableFrom']
       end
 
-      if attributes.has_key?(:'createdOn')
-        self.created_on = attributes[:'createdOn']
+      if attributes.has_key?(:'availableUntil')
+        self.available_until = attributes[:'availableUntil']
       end
 
-      if attributes.has_key?(:'externalId')
-        self.external_id = attributes[:'externalId']
+      if attributes.has_key?(:'billingAddressRequired')
+        self.billing_address_required = attributes[:'billingAddressRequired']
       end
 
-      if attributes.has_key?(:'failedOn')
-        self.failed_on = attributes[:'failedOn']
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
       end
 
-      if attributes.has_key?(:'failureReason')
-        self.failure_reason = attributes[:'failureReason']
+      if attributes.has_key?(:'externalId')
+        self.external_id = attributes[:'externalId']
       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
@@ -224,77 +183,89 @@ module Wallee
         self.linked_space_id = attributes[:'linkedSpaceId']
       end
 
-      if attributes.has_key?(:'merchantReference')
-        self.merchant_reference = attributes[:'merchantReference']
+      if attributes.has_key?(:'maximalNumberOfTransactions')
+        self.maximal_number_of_transactions = attributes[:'maximalNumberOfTransactions']
       end
 
-      if attributes.has_key?(:'nextUpdateOn')
-        self.next_update_on = attributes[:'nextUpdateOn']
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
       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?(:'protectionMode')
+        self.protection_mode = attributes[:'protectionMode']
       end
 
-      if attributes.has_key?(:'reducedLineItems')
-        if (value = attributes[:'reducedLineItems']).is_a?(Array)
-          self.reduced_line_items = value
-        end
-      end
-
-      if attributes.has_key?(:'reductions')
-        if (value = attributes[:'reductions']).is_a?(Array)
-          self.reductions = value
-        end
+      if attributes.has_key?(:'shippingAddressRequired')
+        self.shipping_address_required = attributes[:'shippingAddressRequired']
       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?(:'taxes')
-        if (value = attributes[:'taxes']).is_a?(Array)
-          self.taxes = value
-        end
-      end
-
-      if attributes.has_key?(:'timeoutOn')
-        self.timeout_on = attributes[:'timeoutOn']
-      end
-
-      if attributes.has_key?(:'transaction')
-        self.transaction = attributes[:'transaction']
-      end
-
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.has_key?(:'url')
+        self.url = attributes[:'url']
       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
-      return invalid_properties
+      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 !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", 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 true
+      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 !@name.nil? && @name.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] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
     end
 
     # Checks equality by comparing each attribute.
@@ -302,30 +273,24 @@ module Wallee
     def ==(o)
       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 &&
-          created_on == o.created_on &&
+          allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
+          applied_space_view == o.applied_space_view &&
+          available_from == o.available_from &&
+          available_until == o.available_until &&
+          billing_address_required == o.billing_address_required &&
+          currency == o.currency &&
           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 &&
-          merchant_reference == o.merchant_reference &&
-          next_update_on == o.next_update_on &&
+          maximal_number_of_transactions == o.maximal_number_of_transactions &&
+          name == o.name &&
           planned_purge_date == o.planned_purge_date &&
-          processor_reference == o.processor_reference &&
-          reduced_line_items == o.reduced_line_items &&
-          reductions == o.reductions &&
+          protection_mode == o.protection_mode &&
+          shipping_address_required == o.shipping_address_required &&
           state == o.state &&
-          succeeded_on == o.succeeded_on &&
-          taxes == o.taxes &&
-          timeout_on == o.timeout_on &&
-          transaction == o.transaction &&
-          type == o.type &&
+          url == o.url &&
           version == o.version
     end
 
@@ -338,7 +303,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
+      [allowed_payment_method_configurations, applied_space_view, available_from, available_until, billing_address_required, currency, external_id, id, language, line_items, linked_space_id, maximal_number_of_transactions, name, planned_purge_date, protection_mode, shipping_address_required, state, url, version].hash
     end
 
     # Builds the object from hash
@@ -348,7 +313,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) } )
@@ -446,5 +411,4 @@ module Wallee
     end
 
   end
-
 end