wallee-ruby-sdk 4.5.0 → 5.2.0

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

@@ -29,13 +29,13 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The product version that is to be retired.
     attr_accessor :product_version
 
-    # 
-    attr_accessor :respect_terminiation_periods_enabled
+    # Whether the subscriptions' termination periods should be respected.
+    attr_accessor :respect_termination_periods
 
-    # When a target product is not chosen, all customers with the retired product will be terminated.
+    # The product to which the subscriptions with the retiring product version 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_version' => :'productVersion',
-        :'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_version' => :'SubscriptionProductVersion',
-        :'respect_terminiation_periods_enabled' => :'BOOLEAN',
+        :'respect_termination_periods' => :'BOOLEAN',
         :'target_product' => :'SubscriptionProduct',
         :'version' => :'Integer'
       }
@@ -91,8 +91,8 @@ module Wallee
         self.product_version = attributes[:'productVersion']
       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_version == o.product_version &&
-          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_version, respect_terminiation_periods_enabled, target_product, version].hash
+      [created_on, id, linked_space_id, product_version, respect_termination_periods, target_product, version].hash
     end
 
     # Builds the object from hash

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

@@ -20,20 +20,20 @@ require 'date'
 module Wallee
   # 
   class SubscriptionProductVersionRetirementCreate
-    # 
+    # The product version that is to be retired.
     attr_accessor :product_version
 
-    # 
-    attr_accessor :respect_terminiation_periods_enabled
+    # Whether the subscriptions' termination periods should be respected.
+    attr_accessor :respect_termination_periods
 
-    # When a target product is not chosen, all customers with the retired product will be terminated.
+    # The product to which the subscriptions with the retiring product version 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_version' => :'productVersion',
-        :'respect_terminiation_periods_enabled' => :'respectTerminiationPeriodsEnabled',
+        :'respect_termination_periods' => :'respectTerminationPeriods',
         :'target_product' => :'targetProduct'
       }
     end
@@ -42,7 +42,7 @@ module Wallee
     def self.swagger_types
       {
         :'product_version' => :'Integer',
-        :'respect_terminiation_periods_enabled' => :'BOOLEAN',
+        :'respect_termination_periods' => :'BOOLEAN',
         :'target_product' => :'Integer'
       }
     end
@@ -59,8 +59,8 @@ module Wallee
         self.product_version = attributes[:'productVersion']
       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_version == o.product_version &&
-          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_version, respect_terminiation_periods_enabled, target_product].hash
+      [product_version, respect_termination_periods, target_product].hash
     end
 
     # Builds the object from hash

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

@@ -23,10 +23,10 @@ module Wallee
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The date and time when the suspension ended.
     attr_accessor :effective_end_date
 
-    # When the suspension reaches the planned end date the end action will be carried out. This action is only executed when the suspension is ended automatically based on the end date.
+    # Whether the subscription should be terminated or reactivated after the suspension has reached its end date.
     attr_accessor :end_action
 
     # 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 note may contain some internal information for the suspension. The note will not be disclosed to the subscriber.
+    # A note that contains details about the suspension. It is not disclosed to the subscriber.
     attr_accessor :note
 
-    # 
+    # The period bill that led to the suspension of the subscription.
     attr_accessor :period_bill
 
-    # The planned end date of the suspension identifies the date on which the suspension will be ended automatically.
+    # The date and time when the suspension is planned to end.
     attr_accessor :planned_end_date
 
     # 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 suspension reason indicates why a suspension has been created.
+    # The reason why the subscription was suspended.
     attr_accessor :reason
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The subscription that this suspension belongs to.
     attr_accessor :subscription
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,16 +20,16 @@ require 'date'
 module Wallee
   # 
   class SubscriptionSuspensionCreate
-    # When the suspension reaches the planned end date the end action will be carried out. This action is only executed when the suspension is ended automatically based on the end date.
+    # Whether the subscription should be terminated or reactivated after the suspension has reached its end date.
     attr_accessor :end_action
 
-    # The note may contain some internal information for the suspension. The note will not be disclosed to the subscriber.
+    # A note that contains details about the suspension. It is not disclosed to the subscriber.
     attr_accessor :note
 
-    # The planned end date of the suspension identifies the date on which the suspension will be ended automatically.
+    # The date and time when the suspension is planned to end.
     attr_accessor :planned_end_date
 
-    # 
+    # The subscription that this suspension belongs to.
     attr_accessor :subscription
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -23,10 +23,10 @@ module Wallee
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The date and time when the suspension ended.
     attr_accessor :effective_end_date
 
-    # When the suspension reaches the planned end date the end action will be carried out. This action is only executed when the suspension is ended automatically based on the end date.
+    # Whether the subscription should be terminated or reactivated after the suspension has reached its end date.
     attr_accessor :end_action
 
     # 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 note may contain some internal information for the suspension. The note will not be disclosed to the subscriber.
+    # A note that contains details about the suspension. It is not disclosed to the subscriber.
     attr_accessor :note
 
-    # 
+    # The period bill that led to the suspension of the subscription.
     attr_accessor :period_bill
 
-    # The planned end date of the suspension identifies the date on which the suspension will be ended automatically.
+    # The date and time when the suspension is planned to end.
     attr_accessor :planned_end_date
 
     # 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 suspension reason indicates why a suspension has been created.
+    # The reason why the subscription was suspended.
     attr_accessor :reason
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The subscription that this suspension belongs to.
     attr_accessor :subscription
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -26,13 +26,13 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # 
+    # The affiliate that led to the creation of the subscription.
     attr_accessor :affiliate
 
-    # 
+    # A description used to identify the subscription.
     attr_accessor :description
 
-    # 
+    # The date and time when the subscription is planned to be terminated.
     attr_accessor :planned_termination_date
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,9 +18,9 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # The subscription update request allows to change a subscription properites.
+  # 
   class SubscriptionUpdateRequest
-    # 
+    # A description used to identify the subscription.
     attr_accessor :description
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,22 +20,25 @@ require 'date'
 module Wallee
   # 
   class SubscriptionVersion
-    # 
+    # The date and time when the subscription version was activated.
     attr_accessor :activated_on
 
-    # The subscriber is charged in the billing currency. The billing currency has to be one of the enabled currencies on the subscription product.
+    # The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.
     attr_accessor :billing_currency
 
     # 
+    attr_accessor :billing_cycle_model
+
+    # The configurations of the subscription's components.
     attr_accessor :component_configurations
 
-    # 
+    # The date and time when the subscription version was created.
     attr_accessor :created_on
 
-    # The expected last period end is the date on which the projected end date of the last period is. This is only a projection and as such the actual date may be different.
+    # The date and time when the last period is expected to end.
     attr_accessor :expected_last_period_end
 
-    # 
+    # The date and time when the subscription version failed.
     attr_accessor :failed_on
 
     # A unique identifier for the object.
@@ -50,28 +53,25 @@ 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 date and time when the termination of the subscription version is planned.
     attr_accessor :planned_termination_date
 
-    # 
+    # The product version that is subscribed to.
     attr_accessor :product_version
 
-    # 
-    attr_accessor :selected_components
-
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The subscription that this version belongs to.
     attr_accessor :subscription
 
-    # 
+    # The date and time when the subscription version was terminated.
     attr_accessor :terminated_on
 
-    # 
+    # The date and time when the termination of the subscription version started.
     attr_accessor :terminating_on
 
-    # 
+    # The date and time when the termination of the subscription version was issued.
     attr_accessor :termination_issued_on
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -82,6 +82,7 @@ module Wallee
       {
         :'activated_on' => :'activatedOn',
         :'billing_currency' => :'billingCurrency',
+        :'billing_cycle_model' => :'billingCycleModel',
         :'component_configurations' => :'componentConfigurations',
         :'created_on' => :'createdOn',
         :'expected_last_period_end' => :'expectedLastPeriodEnd',
@@ -92,7 +93,6 @@ module Wallee
         :'planned_purge_date' => :'plannedPurgeDate',
         :'planned_termination_date' => :'plannedTerminationDate',
         :'product_version' => :'productVersion',
-        :'selected_components' => :'selectedComponents',
         :'state' => :'state',
         :'subscription' => :'subscription',
         :'terminated_on' => :'terminatedOn',
@@ -107,6 +107,7 @@ module Wallee
       {
         :'activated_on' => :'DateTime',
         :'billing_currency' => :'String',
+        :'billing_cycle_model' => :'BillingCycleModel',
         :'component_configurations' => :'Array<SubscriptionComponentConfiguration>',
         :'created_on' => :'DateTime',
         :'expected_last_period_end' => :'DateTime',
@@ -117,7 +118,6 @@ module Wallee
         :'planned_purge_date' => :'DateTime',
         :'planned_termination_date' => :'DateTime',
         :'product_version' => :'SubscriptionProductVersion',
-        :'selected_components' => :'Array<SubscriptionProductComponent>',
         :'state' => :'SubscriptionVersionState',
         :'subscription' => :'Subscription',
         :'terminated_on' => :'DateTime',
@@ -143,6 +143,10 @@ module Wallee
         self.billing_currency = attributes[:'billingCurrency']
       end
 
+      if attributes.has_key?(:'billingCycleModel')
+        self.billing_cycle_model = attributes[:'billingCycleModel']
+      end
+
       if attributes.has_key?(:'componentConfigurations')
         if (value = attributes[:'componentConfigurations']).is_a?(Array)
           self.component_configurations = value
@@ -185,12 +189,6 @@ module Wallee
         self.product_version = attributes[:'productVersion']
       end
 
-      if attributes.has_key?(:'selectedComponents')
-        if (value = attributes[:'selectedComponents']).is_a?(Array)
-          self.selected_components = value
-        end
-      end
-
       if attributes.has_key?(:'state')
         self.state = attributes[:'state']
       end
@@ -236,6 +234,7 @@ module Wallee
       self.class == o.class &&
           activated_on == o.activated_on &&
           billing_currency == o.billing_currency &&
+          billing_cycle_model == o.billing_cycle_model &&
           component_configurations == o.component_configurations &&
           created_on == o.created_on &&
           expected_last_period_end == o.expected_last_period_end &&
@@ -246,7 +245,6 @@ module Wallee
           planned_purge_date == o.planned_purge_date &&
           planned_termination_date == o.planned_termination_date &&
           product_version == o.product_version &&
-          selected_components == o.selected_components &&
           state == o.state &&
           subscription == o.subscription &&
           terminated_on == o.terminated_on &&
@@ -264,7 +262,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activated_on, billing_currency, component_configurations, created_on, expected_last_period_end, failed_on, id, language, linked_space_id, planned_purge_date, planned_termination_date, product_version, selected_components, state, subscription, terminated_on, terminating_on, termination_issued_on, version].hash
+      [activated_on, billing_currency, billing_cycle_model, component_configurations, created_on, expected_last_period_end, failed_on, id, language, linked_space_id, planned_purge_date, planned_termination_date, product_version, state, subscription, terminated_on, terminating_on, termination_issued_on, version].hash
     end
 
     # Builds the object from hash

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

@@ -20,10 +20,10 @@ require 'date'
 module Wallee
   # 
   class Tax
-    # 
+    # The tax rate to be applied.
     attr_accessor :rate
 
-    # 
+    # The name of the tax.
     attr_accessor :title
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -26,15 +26,12 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The tax class name is used internally to identify the tax class 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 tax class.
     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 object's current state.
     attr_accessor :state
 
@@ -48,7 +45,6 @@ module Wallee
         :'linked_space_id' => :'linkedSpaceId',
         :'name' => :'name',
         :'planned_purge_date' => :'plannedPurgeDate',
-        :'space_id' => :'spaceId',
         :'state' => :'state',
         :'version' => :'version'
       }
@@ -61,7 +57,6 @@ module Wallee
         :'linked_space_id' => :'Integer',
         :'name' => :'String',
         :'planned_purge_date' => :'DateTime',
-        :'space_id' => :'Integer',
         :'state' => :'CreationEntityState',
         :'version' => :'Integer'
       }
@@ -91,10 +86,6 @@ module Wallee
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
 
-      if attributes.has_key?(:'spaceId')
-        self.space_id = attributes[:'spaceId']
-      end
-
       if attributes.has_key?(:'state')
         self.state = attributes[:'state']
       end
@@ -141,7 +132,6 @@ module Wallee
           linked_space_id == o.linked_space_id &&
           name == o.name &&
           planned_purge_date == o.planned_purge_date &&
-          space_id == o.space_id &&
           state == o.state &&
           version == o.version
     end
@@ -155,7 +145,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, state, version].hash
     end
 
     # Builds the object from hash

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

@@ -20,10 +20,10 @@ require 'date'
 module Wallee
   # 
   class TaxCreate
-    # 
+    # The tax rate to be applied.
     attr_accessor :rate
 
-    # 
+    # The name of the tax.
     attr_accessor :title
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wallee-ruby-sdk/models/{shopify_subscription_model_tax_line.rb → tax_line.rb}

@@ -19,7 +19,7 @@ require 'date'
 
 module Wallee
   # 
-  class ShopifySubscriptionModelTaxLine
+  class TaxLine
     # 
     attr_accessor :rate
 

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

@@ -23,16 +23,16 @@ module Wallee
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The customer email address is the email address of the customer.
+    # The customer's email address.
     attr_accessor :customer_email_address
 
-    # The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
+    # The unique identifier of the customer in the external system.
     attr_accessor :customer_id
 
-    # When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
+    # Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
     attr_accessor :enabled_for_one_click_payment
 
-    # 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
 
     # A unique identifier for the object.
@@ -50,10 +50,10 @@ module Wallee
     # The object's current state.
     attr_accessor :state
 
-    # The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
+    # The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
     attr_accessor :time_zone
 
-    # Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
+    # The reference used to identify the payment token (e.g. the customer's ID or email address).
     attr_accessor :token_reference
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,25 +20,25 @@ require 'date'
 module Wallee
   # 
   class TokenCreate
-    # The customer email address is the email address of the customer.
+    # The customer's email address.
     attr_accessor :customer_email_address
 
-    # The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
+    # The unique identifier of the customer in the external system.
     attr_accessor :customer_id
 
-    # When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
+    # Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
     attr_accessor :enabled_for_one_click_payment
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
+    # The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
     attr_accessor :time_zone
 
-    # Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
+    # The reference used to identify the payment token (e.g. the customer's ID or email address).
     attr_accessor :token_reference
 
-    # 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 object's current state.

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

@@ -20,22 +20,22 @@ require 'date'
 module Wallee
   # 
   class TokenUpdate
-    # The customer email address is the email address of the customer.
+    # The customer's email address.
     attr_accessor :customer_email_address
 
-    # The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
+    # The unique identifier of the customer in the external system.
     attr_accessor :customer_id
 
-    # When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
+    # Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
     attr_accessor :enabled_for_one_click_payment
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
+    # The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
     attr_accessor :time_zone
 
-    # Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
+    # The reference used to identify the payment token (e.g. the customer's ID or email address).
     attr_accessor :token_reference
 
     # The ID is the primary key of the entity. The ID identifies the entity uniquely.