wallee-ruby-sdk 4.4.0 → 5.2.0

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

@@ -20,27 +20,36 @@ require 'date'
 module Wallee
   # The subscription ledger entry represents a single change on the subscription balance.
   class SubscriptionLedgerEntry
-    # 
+    # The total tax rate applied to the ledger entry, calculated from the rates of all tax lines.
     attr_accessor :aggregated_tax_rate
 
-    # 
+    # The leger entry's amount with discounts applied, excluding taxes.
     attr_accessor :amount_excluding_tax
 
-    # 
+    # The leger entry's amount with discounts applied, including taxes.
     attr_accessor :amount_including_tax
 
     # 
+    attr_accessor :component_reference_name
+
+    # 
+    attr_accessor :component_reference_sku
+
+    # The ID of the user the ledger entry was created by.
     attr_accessor :created_by
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The discount allocated to the ledger entry, including taxes.
     attr_accessor :discount_including_tax
 
-    # 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
 
+    # 
+    attr_accessor :fee_type
+
     # A unique identifier for the object.
     attr_accessor :id
 
@@ -51,21 +60,27 @@ module Wallee
     attr_accessor :planned_purge_date
 
     # 
+    attr_accessor :pro_rata_calculated
+
+    # The number of items that were consumed.
     attr_accessor :quantity
 
     # The object's current state.
     attr_accessor :state
 
     # 
+    attr_accessor :subscription_metric_id
+
+    # The subscription version that the ledger entry belongs to.
     attr_accessor :subscription_version
 
-    # 
+    # The sum of all taxes applied to the ledger entry.
     attr_accessor :tax_amount
 
-    # 
+    # A set of tax lines, each of which specifies a tax applied to the ledger entry.
     attr_accessor :taxes
 
-    # 
+    # The title that indicates what the ledger entry is about.
     attr_accessor :title
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -77,15 +92,20 @@ module Wallee
         :'aggregated_tax_rate' => :'aggregatedTaxRate',
         :'amount_excluding_tax' => :'amountExcludingTax',
         :'amount_including_tax' => :'amountIncludingTax',
+        :'component_reference_name' => :'componentReferenceName',
+        :'component_reference_sku' => :'componentReferenceSku',
         :'created_by' => :'createdBy',
         :'created_on' => :'createdOn',
         :'discount_including_tax' => :'discountIncludingTax',
         :'external_id' => :'externalId',
+        :'fee_type' => :'feeType',
         :'id' => :'id',
         :'linked_space_id' => :'linkedSpaceId',
         :'planned_purge_date' => :'plannedPurgeDate',
+        :'pro_rata_calculated' => :'proRataCalculated',
         :'quantity' => :'quantity',
         :'state' => :'state',
+        :'subscription_metric_id' => :'subscriptionMetricId',
         :'subscription_version' => :'subscriptionVersion',
         :'tax_amount' => :'taxAmount',
         :'taxes' => :'taxes',
@@ -100,15 +120,20 @@ module Wallee
         :'aggregated_tax_rate' => :'Float',
         :'amount_excluding_tax' => :'Float',
         :'amount_including_tax' => :'Float',
+        :'component_reference_name' => :'String',
+        :'component_reference_sku' => :'String',
         :'created_by' => :'Integer',
         :'created_on' => :'DateTime',
         :'discount_including_tax' => :'Float',
         :'external_id' => :'String',
+        :'fee_type' => :'ProductFeeType',
         :'id' => :'Integer',
         :'linked_space_id' => :'Integer',
         :'planned_purge_date' => :'DateTime',
+        :'pro_rata_calculated' => :'BOOLEAN',
         :'quantity' => :'Float',
         :'state' => :'SubscriptionLedgerEntryState',
+        :'subscription_metric_id' => :'Integer',
         :'subscription_version' => :'Integer',
         :'tax_amount' => :'Float',
         :'taxes' => :'Array<Tax>',
@@ -137,6 +162,14 @@ module Wallee
         self.amount_including_tax = attributes[:'amountIncludingTax']
       end
 
+      if attributes.has_key?(:'componentReferenceName')
+        self.component_reference_name = attributes[:'componentReferenceName']
+      end
+
+      if attributes.has_key?(:'componentReferenceSku')
+        self.component_reference_sku = attributes[:'componentReferenceSku']
+      end
+
       if attributes.has_key?(:'createdBy')
         self.created_by = attributes[:'createdBy']
       end
@@ -153,6 +186,10 @@ module Wallee
         self.external_id = attributes[:'externalId']
       end
 
+      if attributes.has_key?(:'feeType')
+        self.fee_type = attributes[:'feeType']
+      end
+
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
@@ -165,6 +202,10 @@ module Wallee
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
 
+      if attributes.has_key?(:'proRataCalculated')
+        self.pro_rata_calculated = attributes[:'proRataCalculated']
+      end
+
       if attributes.has_key?(:'quantity')
         self.quantity = attributes[:'quantity']
       end
@@ -173,6 +214,10 @@ module Wallee
         self.state = attributes[:'state']
       end
 
+      if attributes.has_key?(:'subscriptionMetricId')
+        self.subscription_metric_id = attributes[:'subscriptionMetricId']
+      end
+
       if attributes.has_key?(:'subscriptionVersion')
         self.subscription_version = attributes[:'subscriptionVersion']
       end
@@ -200,6 +245,10 @@ module Wallee
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@component_reference_sku.nil? && @component_reference_sku.to_s.length > 100
+        invalid_properties.push('invalid value for "component_reference_sku", the character length must be smaller than or equal to 100.')
+      end
+
       if !@title.nil? && @title.to_s.length > 150
         invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 150.')
       end
@@ -214,11 +263,22 @@ module Wallee
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@component_reference_sku.nil? && @component_reference_sku.to_s.length > 100
       return false if !@title.nil? && @title.to_s.length > 150
       return false if !@title.nil? && @title.to_s.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] component_reference_sku Value to be assigned
+    def component_reference_sku=(component_reference_sku)
+      if !component_reference_sku.nil? && component_reference_sku.to_s.length > 100
+        fail ArgumentError, 'invalid value for "component_reference_sku", the character length must be smaller than or equal to 100.'
+      end
+
+      @component_reference_sku = component_reference_sku
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] title Value to be assigned
     def title=(title)
@@ -241,15 +301,20 @@ module Wallee
           aggregated_tax_rate == o.aggregated_tax_rate &&
           amount_excluding_tax == o.amount_excluding_tax &&
           amount_including_tax == o.amount_including_tax &&
+          component_reference_name == o.component_reference_name &&
+          component_reference_sku == o.component_reference_sku &&
           created_by == o.created_by &&
           created_on == o.created_on &&
           discount_including_tax == o.discount_including_tax &&
           external_id == o.external_id &&
+          fee_type == o.fee_type &&
           id == o.id &&
           linked_space_id == o.linked_space_id &&
           planned_purge_date == o.planned_purge_date &&
+          pro_rata_calculated == o.pro_rata_calculated &&
           quantity == o.quantity &&
           state == o.state &&
+          subscription_metric_id == o.subscription_metric_id &&
           subscription_version == o.subscription_version &&
           tax_amount == o.tax_amount &&
           taxes == o.taxes &&
@@ -266,7 +331,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [aggregated_tax_rate, amount_excluding_tax, amount_including_tax, created_by, created_on, discount_including_tax, external_id, id, linked_space_id, planned_purge_date, quantity, state, subscription_version, tax_amount, taxes, title, version].hash
+      [aggregated_tax_rate, amount_excluding_tax, amount_including_tax, component_reference_name, component_reference_sku, created_by, created_on, discount_including_tax, external_id, fee_type, id, linked_space_id, planned_purge_date, pro_rata_calculated, quantity, state, subscription_metric_id, subscription_version, tax_amount, taxes, title, version].hash
     end
 
     # Builds the object from hash

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

@@ -20,30 +20,38 @@ require 'date'
 module Wallee
   # The subscription ledger entry represents a single change on the subscription balance.
   class SubscriptionLedgerEntryCreate
-    # 
+    # The leger entry's amount with discounts applied, including taxes.
     attr_accessor :amount_including_tax
 
-    # 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.
+    # 
+    attr_accessor :component_reference_name
+
+    # 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 number of items that were consumed.
     attr_accessor :quantity
 
     # 
+    attr_accessor :subscription_metric_id
+
+    # The subscription version that the ledger entry belongs to.
     attr_accessor :subscription_version
 
-    # 
+    # A set of tax lines, each of which specifies a tax applied to the ledger entry.
     attr_accessor :taxes
 
-    # 
+    # The title that indicates what the ledger entry is about.
     attr_accessor :title
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'amount_including_tax' => :'amountIncludingTax',
+        :'component_reference_name' => :'componentReferenceName',
         :'external_id' => :'externalId',
         :'quantity' => :'quantity',
+        :'subscription_metric_id' => :'subscriptionMetricId',
         :'subscription_version' => :'subscriptionVersion',
         :'taxes' => :'taxes',
         :'title' => :'title'
@@ -54,8 +62,10 @@ module Wallee
     def self.swagger_types
       {
         :'amount_including_tax' => :'Float',
+        :'component_reference_name' => :'String',
         :'external_id' => :'String',
         :'quantity' => :'Float',
+        :'subscription_metric_id' => :'Integer',
         :'subscription_version' => :'Integer',
         :'taxes' => :'Array<TaxCreate>',
         :'title' => :'String'
@@ -74,6 +84,10 @@ module Wallee
         self.amount_including_tax = attributes[:'amountIncludingTax']
       end
 
+      if attributes.has_key?(:'componentReferenceName')
+        self.component_reference_name = attributes[:'componentReferenceName']
+      end
+
       if attributes.has_key?(:'externalId')
         self.external_id = attributes[:'externalId']
       end
@@ -82,6 +96,10 @@ module Wallee
         self.quantity = attributes[:'quantity']
       end
 
+      if attributes.has_key?(:'subscriptionMetricId')
+        self.subscription_metric_id = attributes[:'subscriptionMetricId']
+      end
+
       if attributes.has_key?(:'subscriptionVersion')
         self.subscription_version = attributes[:'subscriptionVersion']
       end
@@ -169,8 +187,10 @@ module Wallee
       return true if self.equal?(o)
       self.class == o.class &&
           amount_including_tax == o.amount_including_tax &&
+          component_reference_name == o.component_reference_name &&
           external_id == o.external_id &&
           quantity == o.quantity &&
+          subscription_metric_id == o.subscription_metric_id &&
           subscription_version == o.subscription_version &&
           taxes == o.taxes &&
           title == o.title
@@ -185,7 +205,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [amount_including_tax, external_id, quantity, subscription_version, taxes, title].hash
+      [amount_including_tax, component_reference_name, external_id, quantity, subscription_metric_id, subscription_version, taxes, title].hash
     end
 
     # Builds the object from hash

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

@@ -20,7 +20,7 @@ require 'date'
 module Wallee
   # A metric represents the usage of a resource that can be measured.
   class SubscriptionMetric
-    # 
+    # The localized description of the metric that is displayed to the customer.
     attr_accessor :description
 
     # 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 localized name of the metric that is displayed to the customer.
     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.
@@ -38,7 +38,7 @@ module Wallee
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The type of the metric.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -26,10 +26,10 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # 
+    # The localized description of the metric that is displayed to the customer.
     attr_accessor :description
 
-    # 
+    # The localized name of the metric that is displayed to the customer.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,13 +20,13 @@ require 'date'
 module Wallee
   # A metric represents the usage of a resource that can be measured.
   class SubscriptionMetricCreate
-    # 
+    # The localized description of the metric that is displayed to the customer.
     attr_accessor :description
 
-    # 
+    # The localized name of the metric that is displayed to the customer.
     attr_accessor :name
 
-    # 
+    # The type of the metric.
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -46,7 +46,7 @@ module Wallee
     def self.swagger_types
       {
         :'description' => :'Hash<String, String>',
-        :'feature' => :'Feature',
+        :'feature' => :'Integer',
         :'id' => :'Integer',
         :'name' => :'Hash<String, String>'
       }

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

@@ -26,10 +26,10 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
-    # 
+    # The localized description of the metric that is displayed to the customer.
     attr_accessor :description
 
-    # 
+    # The localized name of the metric that is displayed to the customer.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,19 +20,19 @@ require 'date'
 module Wallee
   # The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.
   class SubscriptionMetricUsageReport
-    # The consumed units describe the amount of resources consumed. Those consumed units will be billed in the next billing cycle.
+    # The number of resources consumed, will be charged in the next billing cycle.
     attr_accessor :consumed_units
 
-    # 
+    # The ID of the user the usage report was created by.
     attr_accessor :created_by_user_id
 
-    # 
+    # The date and time when the usage report was created.
     attr_accessor :created_on
 
-    # The metric usage report description describe the reported usage. This description may be shown to the end user.
+    # A description used to identify the usage report.
     attr_accessor :description
 
-    # The external id identifies the metric usage uniquely.
+    # 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.
@@ -41,13 +41,13 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The metric usage report is linked to the metric for which the usage should be recorded.
+    # The metric that the usage report is recorded for.
     attr_accessor :metric
 
     # 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 subscription to which the usage is added to.
+    # The subscription that the usage report is recorded for.
     attr_accessor :subscription
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,19 +20,19 @@ require 'date'
 module Wallee
   # The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.
   class SubscriptionMetricUsageReportCreate
-    # The consumed units describe the amount of resources consumed. Those consumed units will be billed in the next billing cycle.
+    # The number of resources consumed, will be charged in the next billing cycle.
     attr_accessor :consumed_units
 
-    # The metric usage report description describe the reported usage. This description may be shown to the end user.
+    # A description used to identify the usage report.
     attr_accessor :description
 
-    # The external id identifies the metric usage uniquely.
+    # 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 metric usage report is linked to the metric for which the usage should be recorded.
+    # The metric that the usage report is recorded for.
     attr_accessor :metric
 
-    # The subscription to which the usage is added to.
+    # The subscription that the usage report is recorded for.
     attr_accessor :subscription
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -26,22 +26,22 @@ 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
 
-    # 
+    # The merchant's reference used to identify the subscription.
     attr_accessor :reference
 
-    # 
+    # The subscriber that the subscription belongs to.
     attr_accessor :subscriber
 
-    # 
+    # The payment token that is used to charge the customer.
     attr_accessor :token
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,10 +20,10 @@ require 'date'
 module Wallee
   # 
   class SubscriptionPeriodBill
-    # 
+    # The date and time when the period bill was created.
     attr_accessor :created_on
 
-    # 
+    # The date and time when the period actually ended.
     attr_accessor :effective_period_end_date
 
     # A unique identifier for the object.
@@ -35,10 +35,10 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The date and time when the period started.
     attr_accessor :period_start_date
 
-    # 
+    # The date and time when the period is planned to end.
     attr_accessor :planned_period_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.
@@ -47,7 +47,7 @@ module Wallee
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The subscription version that the period bill belongs to.
     attr_accessor :subscription_version
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,10 +20,10 @@ 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 SubscriptionProduct
-    # 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
 
     # A unique identifier for the object.
@@ -32,22 +32,22 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 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
 
     # 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
 
-    # 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 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
 
-    # 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 ID of the space this object belongs to.
     attr_accessor :space_id
 
     # The object's current state.

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

@@ -20,19 +20,19 @@ 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 SubscriptionProductActive
-    # 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.