wallee-ruby-sdk 4.5.0 → 5.2.0

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

@@ -26,13 +26,13 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The space view name is used internally to identify the space view 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 space view.
     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 space to which the view belongs to.
+    # The space that the space view belongs to.
     attr_accessor :space
 
     # The object's current state.

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

@@ -23,7 +23,7 @@ module Wallee
     # The localized description of the object.
     attr_accessor :description
 
-    # 
+    # The features that this static value belongs to.
     attr_accessor :features
 
     # A unique identifier for the object.

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

@@ -20,28 +20,28 @@ require 'date'
 module Wallee
   # A subscriber represents everyone who is subscribed to a product.
   class Subscriber
-    # Those payment methods which are allowed additionally will be available even when the product does not allow those methods.
+    # Allow the subscriber to use these payment methods even if subscription products do not accept them.
     attr_accessor :additional_allowed_payment_method_configurations
 
-    # 
+    # The address associated with the subscriber for invoicing and transaction processing purposes.
     attr_accessor :billing_address
 
-    # The subscriber description can be used to add a description to the subscriber. This is used in the back office to identify the subscriber.
+    # The description used to identify the subscriber.
     attr_accessor :description
 
-    # Those payment methods which are disallowed will not be available to the subscriber even if the product allows those methods.
+    # Prevent the subscriber from using these payment methods even if subscription products do accept them.
     attr_accessor :disallowed_payment_method_configurations
 
-    # The email address is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
+    # The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
     attr_accessor :email_address
 
-    # 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.
     attr_accessor :id
 
-    # The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).
+    # The language that is used when communicating with the subscriber via emails and documents.
     attr_accessor :language
 
     # The ID of the space this object belongs to.
@@ -53,10 +53,10 @@ 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 subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).
+    # The merchant's reference used to identify the subscriber.
     attr_accessor :reference
 
-    # 
+    # The address to where orders will be shipped.
     attr_accessor :shipping_address
 
     # The object's current state.

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

@@ -26,31 +26,31 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # Those payment methods which are allowed additionally will be available even when the product does not allow those methods.
+    # Allow the subscriber to use these payment methods even if subscription products do not accept them.
     attr_accessor :additional_allowed_payment_method_configurations
 
-    # 
+    # The address associated with the subscriber for invoicing and transaction processing purposes.
     attr_accessor :billing_address
 
-    # The subscriber description can be used to add a description to the subscriber. This is used in the back office to identify the subscriber.
+    # The description used to identify the subscriber.
     attr_accessor :description
 
-    # Those payment methods which are disallowed will not be available to the subscriber even if the product allows those methods.
+    # Prevent the subscriber from using these payment methods even if subscription products do accept them.
     attr_accessor :disallowed_payment_method_configurations
 
-    # The email address is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
+    # The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
     attr_accessor :email_address
 
-    # The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).
+    # The language that is used when communicating with the subscriber via emails and documents.
     attr_accessor :language
 
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).
+    # The merchant's reference used to identify the subscriber.
     attr_accessor :reference
 
-    # 
+    # The address to where orders will be shipped.
     attr_accessor :shipping_address
 
     # The object's current state.

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

@@ -20,37 +20,37 @@ require 'date'
 module Wallee
   # A subscriber represents everyone who is subscribed to a product.
   class SubscriberCreate
-    # Those payment methods which are allowed additionally will be available even when the product does not allow those methods.
+    # Allow the subscriber to use these payment methods even if subscription products do not accept them.
     attr_accessor :additional_allowed_payment_method_configurations
 
-    # 
+    # The address associated with the subscriber for invoicing and transaction processing purposes.
     attr_accessor :billing_address
 
-    # The subscriber description can be used to add a description to the subscriber. This is used in the back office to identify the subscriber.
+    # The description used to identify the subscriber.
     attr_accessor :description
 
-    # Those payment methods which are disallowed will not be available to the subscriber even if the product allows those methods.
+    # Prevent the subscriber from using these payment methods even if subscription products do accept them.
     attr_accessor :disallowed_payment_method_configurations
 
-    # The email address is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
+    # The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
     attr_accessor :email_address
 
-    # The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).
+    # The language that is used when communicating with the subscriber via emails and documents.
     attr_accessor :language
 
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).
+    # The merchant's reference used to identify the subscriber.
     attr_accessor :reference
 
-    # 
+    # The address to where orders will be shipped.
     attr_accessor :shipping_address
 
     # The object's current state.
     attr_accessor :state
 
-    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -26,31 +26,31 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # Those payment methods which are allowed additionally will be available even when the product does not allow those methods.
+    # Allow the subscriber to use these payment methods even if subscription products do not accept them.
     attr_accessor :additional_allowed_payment_method_configurations
 
-    # 
+    # The address associated with the subscriber for invoicing and transaction processing purposes.
     attr_accessor :billing_address
 
-    # The subscriber description can be used to add a description to the subscriber. This is used in the back office to identify the subscriber.
+    # The description used to identify the subscriber.
     attr_accessor :description
 
-    # Those payment methods which are disallowed will not be available to the subscriber even if the product allows those methods.
+    # Prevent the subscriber from using these payment methods even if subscription products do accept them.
     attr_accessor :disallowed_payment_method_configurations
 
-    # The email address is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
+    # The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
     attr_accessor :email_address
 
-    # The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).
+    # The language that is used when communicating with the subscriber via emails and documents.
     attr_accessor :language
 
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).
+    # The merchant's reference used to identify the subscriber.
     attr_accessor :reference
 
-    # 
+    # The address to where orders will be shipped.
     attr_accessor :shipping_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,25 +20,25 @@ require 'date'
 module Wallee
   # 
   class Subscription
-    # 
+    # The date and time when the subscription was activate.
     attr_accessor :activated_on
 
-    # 
+    # The affiliate that led to the creation of the subscription.
     attr_accessor :affiliate
 
-    # 
+    # The date and time when the subscription was created.
     attr_accessor :created_on
 
-    # 
+    # The version of the product that the subscription is currently linked to.
     attr_accessor :current_product_version
 
-    # 
+    # A description used to identify the subscription.
     attr_accessor :description
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The date and time when the subscription was initialized.
     attr_accessor :initialized_on
 
     # The language that is linked to the object.
@@ -50,31 +50,31 @@ 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 subscription is planned to be terminated.
     attr_accessor :planned_termination_date
 
-    # 
+    # The merchant's reference used to identify the subscription.
     attr_accessor :reference
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The subscriber that the subscription belongs to.
     attr_accessor :subscriber
 
-    # 
+    # The ID of the user the subscription was terminated by.
     attr_accessor :terminated_by
 
-    # 
+    # The date and time when the subscription was terminated.
     attr_accessor :terminated_on
 
-    # 
+    # The date and time when the termination of the subscription started.
     attr_accessor :terminating_on
 
-    # 
+    # The date and time when the subscription was scheduled to be terminated.
     attr_accessor :termination_scheduled_on
 
-    # 
+    # The payment token that is used to charge the customer.
     attr_accessor :token
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,7 +20,7 @@ require 'date'
 module Wallee
   # 
   class SubscriptionAffiliate
-    # 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.
@@ -35,13 +35,13 @@ module Wallee
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The name used to identify the affiliate.
     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 reference used to identify the affiliate.
     attr_accessor :reference
 
     # The object's current state.

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

@@ -26,16 +26,16 @@ module Wallee
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The name used to identify the affiliate.
     attr_accessor :name
 
     # The object's current state.
     attr_accessor :state
 
-    # 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 reference used to identify the affiliate.
     attr_accessor :reference
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,7 +20,7 @@ require 'date'
 module Wallee
   # 
   class SubscriptionAffiliateDeleted
-    # 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.
@@ -35,13 +35,13 @@ module Wallee
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The name used to identify the affiliate.
     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 reference used to identify the affiliate.
     attr_accessor :reference
 
     # The object's current state.

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

@@ -20,7 +20,7 @@ require 'date'
 module Wallee
   # 
   class SubscriptionAffiliateDeleting
-    # 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.
@@ -35,13 +35,13 @@ module Wallee
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The name used to identify the affiliate.
     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 reference used to identify the affiliate.
     attr_accessor :reference
 
     # The object's current state.

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

@@ -32,7 +32,7 @@ module Wallee
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The name used to identify the affiliate.
     attr_accessor :name
 
     # The object's current state.

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

@@ -32,7 +32,7 @@ module Wallee
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The name used to identify the affiliate.
     attr_accessor :name
 
     # The object's current state.

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

@@ -20,22 +20,22 @@ require 'date'
 module Wallee
   # The subscription charge represents a single charge carried out for a particular subscription.
   class SubscriptionCharge
-    # 
+    # The date and time when the charge was created.
     attr_accessor :created_on
 
-    # 
+    # The ID of the user the charge was discarded by.
     attr_accessor :discarded_by
 
-    # 
+    # The date and time when the charge was discarded.
     attr_accessor :discarded_on
 
-    # 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 date and time when the charge failed.
     attr_accessor :failed_on
 
-    # The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
+    # The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
     attr_accessor :failed_url
 
     # A unique identifier for the object.
@@ -44,40 +44,40 @@ module Wallee
     # The language that is linked to the object.
     attr_accessor :language
 
-    # 
+    # The ledger entries that belong to the charge.
     attr_accessor :ledger_entries
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The date and time when the execution of the charge is planned.
     attr_accessor :planned_execution_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 processing type specifies how the charge is to be processed.
     attr_accessor :processing_type
 
-    # 
+    # The merchant's reference used to identify the charge.
     attr_accessor :reference
 
     # The object's current state.
     attr_accessor :state
 
-    # The field subscription indicates the subscription to which the charge belongs to.
+    # The subscription that the charge belongs to.
     attr_accessor :subscription
 
-    # 
+    # The date and time when the charge succeeded.
     attr_accessor :succeed_on
 
-    # The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
+    # The URL to redirect the customer back to after they successfully authenticated their payment.
     attr_accessor :success_url
 
-    # 
+    # The transaction used to process the charge.
     attr_accessor :transaction
 
-    # 
+    # The type specified how the charge was initiated.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,25 +20,25 @@ require 'date'
 module Wallee
   # The subscription charge represents a single charge carried out for a particular subscription.
   class SubscriptionChargeCreate
-    # 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 user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
+    # The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
     attr_accessor :failed_url
 
-    # 
+    # The date and time when the execution of the charge is planned.
     attr_accessor :planned_execution_date
 
-    # 
+    # The processing type specifies how the charge is to be processed.
     attr_accessor :processing_type
 
-    # 
+    # The merchant's reference used to identify the charge.
     attr_accessor :reference
 
-    # The field subscription indicates the subscription to which the charge belongs to.
+    # The subscription that the charge belongs to.
     attr_accessor :subscription
 
-    # The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
+    # The URL to redirect the customer back to after they successfully authenticated their payment.
     attr_accessor :success_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,7 +20,7 @@ require 'date'
 module Wallee
   # 
   class SubscriptionComponentConfiguration
-    # 
+    # The component that is being configured.
     attr_accessor :component
 
     # A unique identifier for the object.
@@ -29,7 +29,7 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The quantity that should be applied to the component.
     attr_accessor :quantity
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,10 +20,10 @@ require 'date'
 module Wallee
   # The component reference configuration adjusts the product component for a particular subscription.
   class SubscriptionComponentReferenceConfiguration
-    # 
+    # The ID of the component reference that is being configured.
     attr_accessor :product_component_reference_id
 
-    # 
+    # The quantity that should be applied to the component.
     attr_accessor :quantity
 
     # Attribute mapping from ruby-style variable name to JSON key.