wallee-ruby-sdk 4.4.0 → 5.2.0

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

@@ -20,16 +20,16 @@ require 'date'
 module Wallee
   # 
   class SubscriptionProductComponent
-    # If a product component changes from one with a lower product component tier (e.g. 1) to one with a higher product component tier (e.g. 3), it is considered an upgrade and a one-time fee could be applied.
+    # If switching from a component with a lower tier to a component with a higher one, this is considered an upgrade and a fee may be applied.
     attr_accessor :component_change_weight
 
-    # 
+    # The group that the component belongs to.
     attr_accessor :component_group
 
-    # When a component is marked as a 'default' component it is used as the default component in its group and will be preselected in the product configuration.
+    # Whether this is the default component in its group and preselected.
     attr_accessor :default_component
 
-    # The component description may contain a longer description which gives the subscriber a better understanding of what the component contains.
+    # The localized description of the component that is displayed to the customer.
     attr_accessor :description
 
     # A unique identifier for the object.
@@ -38,25 +38,25 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The maximum quantity defines the maximum value which must be entered for the quantity.
+    # A maximum of the defined quantity can be selected for this component.
     attr_accessor :maximal_quantity
 
-    # The minimal quantity defines the minimum value which must be entered for the quantity.
+    # A minimum of the defined quantity must be selected for this component.
     attr_accessor :minimal_quantity
 
-    # The component name is shown to the subscriber. It should describe in few words what the component does contain.
+    # The localized name of the component that is displayed to the customer.
     attr_accessor :name
 
-    # The quantity step defines at which interval the quantity can be increased.
+    # The quantity step determines the interval in which the quantity can be increased.
     attr_accessor :quantity_step
 
-    # The component reference is used to identify the component by external systems and it marks components to represent the same component within different product versions.
+    # The reference is used to link components across different product versions.
     attr_accessor :reference
 
-    # The sort order controls in which order the component is listed. The sort order is used to order the components in ascending order.
+    # When listing components, they can be sorted by this number.
     attr_accessor :sort_order
 
-    # The tax class of the component determines the taxes which are applicable on all fees linked with the component.
+    # The tax class to be applied to fees.
     attr_accessor :tax_class
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -26,16 +26,16 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The component group name will be shown when the components are selected. This can be visible to the subscriber.
+    # The localized name of the component group that is displayed to the customer.
     attr_accessor :name
 
-    # The component group can be optional. This means no component has to be selected by the subscriber.
+    # Whether the component group is optional, i.e. the customer does not have to select any component.
     attr_accessor :optional
 
-    # 
+    # The product version that the component group belongs to.
     attr_accessor :product_version
 
-    # The sort order controls in which order the component group is listed. The sort order is used to order the component groups in ascending order.
+    # When listing component groups, they can be sorted by this number.
     attr_accessor :sort_order
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -26,16 +26,16 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # The component group name will be shown when the components are selected. This can be visible to the subscriber.
+    # The localized name of the component group that is displayed to the customer.
     attr_accessor :name
 
-    # The component group can be optional. This means no component has to be selected by the subscriber.
+    # Whether the component group is optional, i.e. the customer does not have to select any component.
     attr_accessor :optional
 
-    # 
+    # The product version that the component group belongs to.
     attr_accessor :product_version
 
-    # The sort order controls in which order the component group is listed. The sort order is used to order the component groups in ascending order.
+    # When listing component groups, they can be sorted by this number.
     attr_accessor :sort_order
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,7 +18,7 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # The product component reference binds components from different product versions together. By binding them together the product version migration can be realized.
+  # The product component reference links components from different product versions, which makes it possible to carry out migrations.
   class SubscriptionProductComponentReference
     # A unique identifier for the object.
     attr_accessor :id
@@ -26,14 +26,14 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The component reference name is used internally to identify the reference. For example the name is used within search fields and hence it should be distinct and descriptive.
+    # The name used to identify the component reference.
     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
 
-    # 
-    attr_accessor :space_id
+    # The component reference sku as a unique identifier.
+    attr_accessor :sku
 
     # The object's current state.
     attr_accessor :state
@@ -48,7 +48,7 @@ module Wallee
         :'linked_space_id' => :'linkedSpaceId',
         :'name' => :'name',
         :'planned_purge_date' => :'plannedPurgeDate',
-        :'space_id' => :'spaceId',
+        :'sku' => :'sku',
         :'state' => :'state',
         :'version' => :'version'
       }
@@ -61,7 +61,7 @@ module Wallee
         :'linked_space_id' => :'Integer',
         :'name' => :'String',
         :'planned_purge_date' => :'DateTime',
-        :'space_id' => :'Integer',
+        :'sku' => :'String',
         :'state' => :'SubscriptionProductComponentReferenceState',
         :'version' => :'Integer'
       }
@@ -91,8 +91,8 @@ module Wallee
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
 
-      if attributes.has_key?(:'spaceId')
-        self.space_id = attributes[:'spaceId']
+      if attributes.has_key?(:'sku')
+        self.sku = attributes[:'sku']
       end
 
       if attributes.has_key?(:'state')
@@ -112,6 +112,10 @@ module Wallee
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
       end
 
+      if !@sku.nil? && @sku.to_s.length > 100
+        invalid_properties.push('invalid value for "sku", the character length must be smaller than or equal to 100.')
+      end
+
       invalid_properties
     end
 
@@ -119,6 +123,7 @@ module Wallee
     # @return true if the model is valid
     def valid?
       return false if !@name.nil? && @name.to_s.length > 100
+      return false if !@sku.nil? && @sku.to_s.length > 100
       true
     end
 
@@ -132,6 +137,16 @@ module Wallee
       @name = name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] sku Value to be assigned
+    def sku=(sku)
+      if !sku.nil? && sku.to_s.length > 100
+        fail ArgumentError, 'invalid value for "sku", the character length must be smaller than or equal to 100.'
+      end
+
+      @sku = sku
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -141,7 +156,7 @@ module Wallee
           linked_space_id == o.linked_space_id &&
           name == o.name &&
           planned_purge_date == o.planned_purge_date &&
-          space_id == o.space_id &&
+          sku == o.sku &&
           state == o.state &&
           version == o.version
     end
@@ -155,7 +170,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, name, planned_purge_date, space_id, state, version].hash
+      [id, linked_space_id, name, planned_purge_date, sku, state, version].hash
     end
 
     # Builds the object from hash

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

@@ -26,37 +26,37 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # If a product component changes from one with a lower product component tier (e.g. 1) to one with a higher product component tier (e.g. 3), it is considered an upgrade and a one-time fee could be applied.
+    # If switching from a component with a lower tier to a component with a higher one, this is considered an upgrade and a fee may be applied.
     attr_accessor :component_change_weight
 
-    # 
+    # The group that the component belongs to.
     attr_accessor :component_group
 
-    # When a component is marked as a 'default' component it is used as the default component in its group and will be preselected in the product configuration.
+    # Whether this is the default component in its group and preselected.
     attr_accessor :default_component
 
-    # The component description may contain a longer description which gives the subscriber a better understanding of what the component contains.
+    # The localized description of the component that is displayed to the customer.
     attr_accessor :description
 
-    # The maximum quantity defines the maximum value which must be entered for the quantity.
+    # A maximum of the defined quantity can be selected for this component.
     attr_accessor :maximal_quantity
 
-    # The minimal quantity defines the minimum value which must be entered for the quantity.
+    # A minimum of the defined quantity must be selected for this component.
     attr_accessor :minimal_quantity
 
-    # The component name is shown to the subscriber. It should describe in few words what the component does contain.
+    # The localized name of the component that is displayed to the customer.
     attr_accessor :name
 
-    # The quantity step defines at which interval the quantity can be increased.
+    # The quantity step determines the interval in which the quantity can be increased.
     attr_accessor :quantity_step
 
-    # The component reference is used to identify the component by external systems and it marks components to represent the same component within different product versions.
+    # The reference is used to link components across different product versions.
     attr_accessor :reference
 
-    # The sort order controls in which order the component is listed. The sort order is used to order the components in ascending order.
+    # When listing components, they can be sorted by this number.
     attr_accessor :sort_order
 
-    # The tax class of the component determines the taxes which are applicable on all fees linked with the component.
+    # The tax class to be applied to fees.
     attr_accessor :tax_class
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,25 +20,25 @@ require 'date'
 module Wallee
   # A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.
   class SubscriptionProductCreate
-    # The allowed payment method configurations control which payment methods can be used with this product. When none is selected all methods will be allowed.
+    # The payment methods that can be used to subscribe to this product. If none are selected, no restriction is applied.
     attr_accessor :allowed_payment_method_configurations
 
-    # When a payment fails, the subscription to which the payment belongs to will be suspended. When the suspension is not removed within the specified period the subscription will be terminated. A payment is considered as failed when the subscriber issues a refund or when a subscription charge fails.
+    # The period after which a subscription that has been suspended due to a failed payment is terminated.
     attr_accessor :failed_payment_suspension_period
 
-    # The product name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
+    # The name used to identify the product.
     attr_accessor :name
 
-    # Marks the product as locked. Meaning that customer can not change away from this product or change to this product later on.
+    # Whether subscriptions can be switched to or from this product, or whether they are locked in.
     attr_accessor :product_locked
 
-    # The sort order controls in which order the product is listed. The sort order is used to order the products in ascending order.
+    # When listing products, they can be sorted by this number.
     attr_accessor :sort_order
 
     # The object's current state.
     attr_accessor :state
 
-    # The product reference identifies the product for external systems. This field may contain the product's SKU.
+    # The merchant's reference used to identify the product, e.g. the SKU.
     attr_accessor :reference
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -29,13 +29,13 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The product that is to be retired.
     attr_accessor :product
 
-    # 
-    attr_accessor :respect_terminiation_periods_enabled
+    # Whether the subscriptions' termination periods should be respected.
+    attr_accessor :respect_termination_periods
 
-    # 
+    # The product to which the subscriptions with the retiring product are to be migrated. If none is defined, the subscriptions are terminated.
     attr_accessor :target_product
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -48,7 +48,7 @@ module Wallee
         :'id' => :'id',
         :'linked_space_id' => :'linkedSpaceId',
         :'product' => :'product',
-        :'respect_terminiation_periods_enabled' => :'respectTerminiationPeriodsEnabled',
+        :'respect_termination_periods' => :'respectTerminationPeriods',
         :'target_product' => :'targetProduct',
         :'version' => :'version'
       }
@@ -61,7 +61,7 @@ module Wallee
         :'id' => :'Integer',
         :'linked_space_id' => :'Integer',
         :'product' => :'SubscriptionProduct',
-        :'respect_terminiation_periods_enabled' => :'BOOLEAN',
+        :'respect_termination_periods' => :'BOOLEAN',
         :'target_product' => :'SubscriptionProduct',
         :'version' => :'Integer'
       }
@@ -91,8 +91,8 @@ module Wallee
         self.product = attributes[:'product']
       end
 
-      if attributes.has_key?(:'respectTerminiationPeriodsEnabled')
-        self.respect_terminiation_periods_enabled = attributes[:'respectTerminiationPeriodsEnabled']
+      if attributes.has_key?(:'respectTerminationPeriods')
+        self.respect_termination_periods = attributes[:'respectTerminationPeriods']
       end
 
       if attributes.has_key?(:'targetProduct')
@@ -126,7 +126,7 @@ module Wallee
           id == o.id &&
           linked_space_id == o.linked_space_id &&
           product == o.product &&
-          respect_terminiation_periods_enabled == o.respect_terminiation_periods_enabled &&
+          respect_termination_periods == o.respect_termination_periods &&
           target_product == o.target_product &&
           version == o.version
     end
@@ -140,7 +140,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [created_on, id, linked_space_id, product, respect_terminiation_periods_enabled, target_product, version].hash
+      [created_on, id, linked_space_id, product, respect_termination_periods, target_product, version].hash
     end
 
     # Builds the object from hash

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

@@ -20,20 +20,20 @@ require 'date'
 module Wallee
   # 
   class SubscriptionProductRetirementCreate
-    # 
+    # The product that is to be retired.
     attr_accessor :product
 
-    # 
-    attr_accessor :respect_terminiation_periods_enabled
+    # Whether the subscriptions' termination periods should be respected.
+    attr_accessor :respect_termination_periods
 
-    # 
+    # The product to which the subscriptions with the retiring product are to be migrated. If none is defined, the subscriptions are terminated.
     attr_accessor :target_product
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'product' => :'product',
-        :'respect_terminiation_periods_enabled' => :'respectTerminiationPeriodsEnabled',
+        :'respect_termination_periods' => :'respectTerminationPeriods',
         :'target_product' => :'targetProduct'
       }
     end
@@ -42,7 +42,7 @@ module Wallee
     def self.swagger_types
       {
         :'product' => :'Integer',
-        :'respect_terminiation_periods_enabled' => :'BOOLEAN',
+        :'respect_termination_periods' => :'BOOLEAN',
         :'target_product' => :'Integer'
       }
     end
@@ -59,8 +59,8 @@ module Wallee
         self.product = attributes[:'product']
       end
 
-      if attributes.has_key?(:'respectTerminiationPeriodsEnabled')
-        self.respect_terminiation_periods_enabled = attributes[:'respectTerminiationPeriodsEnabled']
+      if attributes.has_key?(:'respectTerminationPeriods')
+        self.respect_termination_periods = attributes[:'respectTerminationPeriods']
       end
 
       if attributes.has_key?(:'targetProduct')
@@ -92,7 +92,7 @@ module Wallee
       return true if self.equal?(o)
       self.class == o.class &&
           product == o.product &&
-          respect_terminiation_periods_enabled == o.respect_terminiation_periods_enabled &&
+          respect_termination_periods == o.respect_termination_periods &&
           target_product == o.target_product
     end
 
@@ -105,7 +105,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [product, respect_terminiation_periods_enabled, target_product].hash
+      [product, respect_termination_periods, target_product].hash
     end
 
     # Builds the object from hash

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

@@ -20,64 +20,67 @@ require 'date'
 module Wallee
   # 
   class SubscriptionProductVersion
-    # 
+    # The date and time when the product version was activated.
     attr_accessor :activated_on
 
-    # The billing cycle determines the rhythm with which the subscriber is billed. The charging may have different rhythm.
+    # The recurring period of time, typically monthly or annually, for which a subscriber is charged.
     attr_accessor :billing_cycle
 
-    # The comment allows to provide a internal comment for the version. It helps to document why a product was changed. The comment is not disclosed to the subscriber.
+    # 
+    attr_accessor :billing_cycle_model
+
+    # A comment that describes the product version and why it was created. It is not disclosed to the subscriber.
     attr_accessor :comment
 
-    # 
+    # The date and time when the product version was created.
     attr_accessor :created_on
 
-    # The default currency has to be used in all fees.
+    # The three-letter code (ISO 4217 format) of the product version's default currency.
     attr_accessor :default_currency
 
-    # The currencies which are enabled can be selected to define component fees. Currencies which are not enabled cannot be used to define fees.
+    # The three-letter codes (ISO 4217 format) of the currencies that the product version supports.
     attr_accessor :enabled_currencies
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # The increment number represents the version number incremented whenever a new version is activated.
+    # Whenever a new version of a product is created, the number is increased and assigned.
     attr_accessor :increment_number
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The minimal number of periods determines how long the subscription has to run before the subscription can be terminated.
+    # The minimum number of periods the subscription will run before it can be terminated.
     attr_accessor :minimal_number_of_periods
 
-    # The product version name is the name of the product which is shown to the user for the version. When the visible product name should be changed for a particular product a new version has to be created which contains the new name of the product.
+    # The localized name of the product that is displayed to the customer.
     attr_accessor :name
 
-    # The number of notice periods determines the number of periods which need to be paid between the request to terminate the subscription and the final period.
+    # The number of periods the subscription will keep running after its termination was requested.
     attr_accessor :number_of_notice_periods
 
-    # 
+    # The date and time when the product version was made obsolete.
     attr_accessor :obsoleted_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
 
-    # Each product version is linked to a product.
+    # The product that the version belongs to.
     attr_accessor :product
 
-    # The product version reference helps to identify the version. The reference is generated out of the product reference.
+    # The reference used to identify the product version.
     attr_accessor :reference
 
-    # 
+    # The date and time when the product version was retired.
     attr_accessor :retiring_finished_on
 
-    # 
+    # The date and time when the product version's retirement was started.
     attr_accessor :retiring_started_on
 
     # The object's current state.
     attr_accessor :state
 
-    # Strategy that is used for tax calculation in fees.
+    # The way taxes are calculated for fees.
     attr_accessor :tax_calculation
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -88,6 +91,7 @@ module Wallee
       {
         :'activated_on' => :'activatedOn',
         :'billing_cycle' => :'billingCycle',
+        :'billing_cycle_model' => :'billingCycleModel',
         :'comment' => :'comment',
         :'created_on' => :'createdOn',
         :'default_currency' => :'defaultCurrency',
@@ -115,6 +119,7 @@ module Wallee
       {
         :'activated_on' => :'DateTime',
         :'billing_cycle' => :'String',
+        :'billing_cycle_model' => :'BillingCycleModel',
         :'comment' => :'String',
         :'created_on' => :'DateTime',
         :'default_currency' => :'String',
@@ -153,6 +158,10 @@ module Wallee
         self.billing_cycle = attributes[:'billingCycle']
       end
 
+      if attributes.has_key?(:'billingCycleModel')
+        self.billing_cycle_model = attributes[:'billingCycleModel']
+      end
+
       if attributes.has_key?(:'comment')
         self.comment = attributes[:'comment']
       end
@@ -269,6 +278,7 @@ module Wallee
       self.class == o.class &&
           activated_on == o.activated_on &&
           billing_cycle == o.billing_cycle &&
+          billing_cycle_model == o.billing_cycle_model &&
           comment == o.comment &&
           created_on == o.created_on &&
           default_currency == o.default_currency &&
@@ -299,7 +309,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activated_on, billing_cycle, comment, created_on, default_currency, enabled_currencies, id, increment_number, linked_space_id, minimal_number_of_periods, name, number_of_notice_periods, obsoleted_on, planned_purge_date, product, reference, retiring_finished_on, retiring_started_on, state, tax_calculation, version].hash
+      [activated_on, billing_cycle, billing_cycle_model, comment, created_on, default_currency, enabled_currencies, id, increment_number, linked_space_id, minimal_number_of_periods, name, number_of_notice_periods, obsoleted_on, planned_purge_date, product, reference, retiring_finished_on, retiring_started_on, state, tax_calculation, version].hash
     end
 
     # Builds the object from hash

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

@@ -26,34 +26,34 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # The billing cycle determines the rhythm with which the subscriber is billed. The charging may have different rhythm.
+    # The recurring period of time, typically monthly or annually, for which a subscriber is charged.
     attr_accessor :billing_cycle
 
-    # The comment allows to provide a internal comment for the version. It helps to document why a product was changed. The comment is not disclosed to the subscriber.
+    # A comment that describes the product version and why it was created. It is not disclosed to the subscriber.
     attr_accessor :comment
 
-    # The default currency has to be used in all fees.
+    # The three-letter code (ISO 4217 format) of the product version's default currency.
     attr_accessor :default_currency
 
-    # The currencies which are enabled can be selected to define component fees. Currencies which are not enabled cannot be used to define fees.
+    # The three-letter codes (ISO 4217 format) of the currencies that the product version supports.
     attr_accessor :enabled_currencies
 
-    # The minimal number of periods determines how long the subscription has to run before the subscription can be terminated.
+    # The minimum number of periods the subscription will run before it can be terminated.
     attr_accessor :minimal_number_of_periods
 
-    # The product version name is the name of the product which is shown to the user for the version. When the visible product name should be changed for a particular product a new version has to be created which contains the new name of the product.
+    # The localized name of the product that is displayed to the customer.
     attr_accessor :name
 
-    # The number of notice periods determines the number of periods which need to be paid between the request to terminate the subscription and the final period.
+    # The number of periods the subscription will keep running after its termination was requested.
     attr_accessor :number_of_notice_periods
 
-    # Each product version is linked to a product.
+    # The product that the version belongs to.
     attr_accessor :product
 
     # The object's current state.
     attr_accessor :state
 
-    # Strategy that is used for tax calculation in fees.
+    # The way taxes are calculated for fees.
     attr_accessor :tax_calculation
 
     # Attribute mapping from ruby-style variable name to JSON key.