vrpayment-ruby-sdk 5.2.0 → 6.0.0

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

@@ -1,251 +1,291 @@
-=begin
-The VR Payment API allows an easy interaction with the VR Payment web service.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-=end
+# VR Payment Ruby SDK
+#
+# This library allows to interact with the VR Payment payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://www.vr-payment.de
+# Developer email: ecosystem-team@wallee.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 require 'date'
+require 'time'
 
-module VRPayment
-  # 
+module VrpaymentRubySdk
   class SubscriptionProductVersion
-    # The date and time when the product version was activated.
-    attr_accessor :activated_on
+    # The date and time when the product version was retired.
+    attr_accessor :retiring_finished_on
 
-    # The recurring period of time, typically monthly or annually, for which a subscriber is charged.
-    attr_accessor :billing_cycle
+    # The three-letter codes (ISO 4217 format) of the currencies that the product version supports.
+    attr_accessor :enabled_currencies
 
-    # 
-    attr_accessor :billing_cycle_model
+    attr_accessor :product
 
-    # 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's retirement was started.
+    attr_accessor :retiring_started_on
 
-    # The date and time when the product version was created.
-    attr_accessor :created_on
+    attr_accessor :tax_calculation
 
-    # The three-letter code (ISO 4217 format) of the product version's default currency.
-    attr_accessor :default_currency
+    # 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 three-letter codes (ISO 4217 format) of the currencies that the product version supports.
-    attr_accessor :enabled_currencies
+    # The date and time when the product version was created.
+    attr_accessor :created_on
 
-    # A unique identifier for the object.
-    attr_accessor :id
+    # The version is used for optimistic locking and incremented whenever the object is updated.
+    attr_accessor :version
 
-    # Whenever a new version of a product is created, the number is increased and assigned.
-    attr_accessor :increment_number
+    # The reference used to identify the product version.
+    attr_accessor :reference
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The minimum number of periods the subscription will run before it can be terminated.
-    attr_accessor :minimal_number_of_periods
+    # The date and time when the product version was activated.
+    attr_accessor :activated_on
+
+    # The recurring period of time, typically monthly or annually, for which a subscriber is charged.
+    attr_accessor :billing_cycle
+
+    # The three-letter code (ISO 4217 format) of the product version's default currency.
+    attr_accessor :default_currency
 
     # The localized name of the product that is displayed to the customer.
     attr_accessor :name
 
-    # The number of periods the subscription will keep running after its termination was requested.
-    attr_accessor :number_of_notice_periods
+    # The minimum number of periods the subscription will run before it can be terminated.
+    attr_accessor :minimal_number_of_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
-
-    # The product that the version belongs to.
-    attr_accessor :product
+    attr_accessor :billing_cycle_model
 
-    # The reference used to identify the product version.
-    attr_accessor :reference
+    # 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 retired.
-    attr_accessor :retiring_finished_on
+    # A unique identifier for the object.
+    attr_accessor :id
 
-    # The date and time when the product version's retirement was started.
-    attr_accessor :retiring_started_on
+    # Whenever a new version of a product is created, the number is increased and assigned.
+    attr_accessor :increment_number
 
-    # The object's current state.
     attr_accessor :state
 
-    # The way taxes are calculated for fees.
-    attr_accessor :tax_calculation
+    # The number of periods the subscription will keep running after its termination was requested.
+    attr_accessor :number_of_notice_periods
 
-    # The version is used for optimistic locking and incremented whenever the object is updated.
-    attr_accessor :version
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'retiring_finished_on' => :'retiringFinishedOn',
+        :'enabled_currencies' => :'enabledCurrencies',
+        :'product' => :'product',
+        :'retiring_started_on' => :'retiringStartedOn',
+        :'tax_calculation' => :'taxCalculation',
+        :'planned_purge_date' => :'plannedPurgeDate',
+        :'created_on' => :'createdOn',
+        :'version' => :'version',
+        :'reference' => :'reference',
+        :'linked_space_id' => :'linkedSpaceId',
         :'activated_on' => :'activatedOn',
         :'billing_cycle' => :'billingCycle',
+        :'default_currency' => :'defaultCurrency',
+        :'name' => :'name',
+        :'minimal_number_of_periods' => :'minimalNumberOfPeriods',
+        :'obsoleted_on' => :'obsoletedOn',
         :'billing_cycle_model' => :'billingCycleModel',
         :'comment' => :'comment',
-        :'created_on' => :'createdOn',
-        :'default_currency' => :'defaultCurrency',
-        :'enabled_currencies' => :'enabledCurrencies',
         :'id' => :'id',
         :'increment_number' => :'incrementNumber',
-        :'linked_space_id' => :'linkedSpaceId',
-        :'minimal_number_of_periods' => :'minimalNumberOfPeriods',
-        :'name' => :'name',
-        :'number_of_notice_periods' => :'numberOfNoticePeriods',
-        :'obsoleted_on' => :'obsoletedOn',
-        :'planned_purge_date' => :'plannedPurgeDate',
-        :'product' => :'product',
-        :'reference' => :'reference',
-        :'retiring_finished_on' => :'retiringFinishedOn',
-        :'retiring_started_on' => :'retiringStartedOn',
         :'state' => :'state',
-        :'tax_calculation' => :'taxCalculation',
-        :'version' => :'version'
+        :'number_of_notice_periods' => :'numberOfNoticePeriods'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'activated_on' => :'DateTime',
+        :'retiring_finished_on' => :'Time',
+        :'enabled_currencies' => :'Array<String>',
+        :'product' => :'SubscriptionProduct',
+        :'retiring_started_on' => :'Time',
+        :'tax_calculation' => :'TaxCalculation',
+        :'planned_purge_date' => :'Time',
+        :'created_on' => :'Time',
+        :'version' => :'Integer',
+        :'reference' => :'String',
+        :'linked_space_id' => :'Integer',
+        :'activated_on' => :'Time',
         :'billing_cycle' => :'String',
+        :'default_currency' => :'String',
+        :'name' => :'Hash<String, String>',
+        :'minimal_number_of_periods' => :'Integer',
+        :'obsoleted_on' => :'Time',
         :'billing_cycle_model' => :'BillingCycleModel',
         :'comment' => :'String',
-        :'created_on' => :'DateTime',
-        :'default_currency' => :'String',
-        :'enabled_currencies' => :'Array<String>',
         :'id' => :'Integer',
         :'increment_number' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'minimal_number_of_periods' => :'Integer',
-        :'name' => :'Hash<String, String>',
-        :'number_of_notice_periods' => :'Integer',
-        :'obsoleted_on' => :'DateTime',
-        :'planned_purge_date' => :'DateTime',
-        :'product' => :'SubscriptionProduct',
-        :'reference' => :'String',
-        :'retiring_finished_on' => :'DateTime',
-        :'retiring_started_on' => :'DateTime',
         :'state' => :'SubscriptionProductVersionState',
-        :'tax_calculation' => :'TaxCalculation',
-        :'version' => :'Integer'
+        :'number_of_notice_periods' => :'Integer'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VrpaymentRubySdk::SubscriptionProductVersion` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        unless self.class.attribute_map.key?(k.to_sym)
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VrpaymentRubySdk::SubscriptionProductVersion`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'activatedOn')
-        self.activated_on = attributes[:'activatedOn']
+      if attributes.key?(:'retiring_finished_on')
+        self.retiring_finished_on = attributes[:'retiring_finished_on']
       end
 
-      if attributes.has_key?(:'billingCycle')
-        self.billing_cycle = attributes[:'billingCycle']
+      if attributes.key?(:'enabled_currencies')
+        if (value = attributes[:'enabled_currencies']).is_a?(Array)
+          self.enabled_currencies = value
+        end
       end
 
-      if attributes.has_key?(:'billingCycleModel')
-        self.billing_cycle_model = attributes[:'billingCycleModel']
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
       end
 
-      if attributes.has_key?(:'comment')
-        self.comment = attributes[:'comment']
+      if attributes.key?(:'retiring_started_on')
+        self.retiring_started_on = attributes[:'retiring_started_on']
       end
 
-      if attributes.has_key?(:'createdOn')
-        self.created_on = attributes[:'createdOn']
+      if attributes.key?(:'tax_calculation')
+        self.tax_calculation = attributes[:'tax_calculation']
       end
 
-      if attributes.has_key?(:'defaultCurrency')
-        self.default_currency = attributes[:'defaultCurrency']
+      if attributes.key?(:'planned_purge_date')
+        self.planned_purge_date = attributes[:'planned_purge_date']
       end
 
-      if attributes.has_key?(:'enabledCurrencies')
-        if (value = attributes[:'enabledCurrencies']).is_a?(Array)
-          self.enabled_currencies = value
-        end
+      if attributes.key?(:'created_on')
+        self.created_on = attributes[:'created_on']
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
       end
 
-      if attributes.has_key?(:'incrementNumber')
-        self.increment_number = attributes[:'incrementNumber']
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
       end
 
-      if attributes.has_key?(:'linkedSpaceId')
-        self.linked_space_id = attributes[:'linkedSpaceId']
+      if attributes.key?(:'linked_space_id')
+        self.linked_space_id = attributes[:'linked_space_id']
       end
 
-      if attributes.has_key?(:'minimalNumberOfPeriods')
-        self.minimal_number_of_periods = attributes[:'minimalNumberOfPeriods']
+      if attributes.key?(:'activated_on')
+        self.activated_on = attributes[:'activated_on']
       end
 
-      if attributes.has_key?(:'name')
-        if (value = attributes[:'name']).is_a?(Hash)
-          self.name = value
-        end
+      if attributes.key?(:'billing_cycle')
+        self.billing_cycle = attributes[:'billing_cycle']
       end
 
-      if attributes.has_key?(:'numberOfNoticePeriods')
-        self.number_of_notice_periods = attributes[:'numberOfNoticePeriods']
+      if attributes.key?(:'default_currency')
+        self.default_currency = attributes[:'default_currency']
       end
 
-      if attributes.has_key?(:'obsoletedOn')
-        self.obsoleted_on = attributes[:'obsoletedOn']
+      if attributes.key?(:'name')
+        if (value = attributes[:'name']).is_a?(Hash)
+          self.name = value
+        end
       end
 
-      if attributes.has_key?(:'plannedPurgeDate')
-        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      if attributes.key?(:'minimal_number_of_periods')
+        self.minimal_number_of_periods = attributes[:'minimal_number_of_periods']
       end
 
-      if attributes.has_key?(:'product')
-        self.product = attributes[:'product']
+      if attributes.key?(:'obsoleted_on')
+        self.obsoleted_on = attributes[:'obsoleted_on']
       end
 
-      if attributes.has_key?(:'reference')
-        self.reference = attributes[:'reference']
+      if attributes.key?(:'billing_cycle_model')
+        self.billing_cycle_model = attributes[:'billing_cycle_model']
       end
 
-      if attributes.has_key?(:'retiringFinishedOn')
-        self.retiring_finished_on = attributes[:'retiringFinishedOn']
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
       end
 
-      if attributes.has_key?(:'retiringStartedOn')
-        self.retiring_started_on = attributes[:'retiringStartedOn']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'increment_number')
+        self.increment_number = attributes[:'increment_number']
       end
 
-      if attributes.has_key?(:'taxCalculation')
-        self.tax_calculation = attributes[:'taxCalculation']
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       end
 
-      if attributes.has_key?(:'version')
-        self.version = attributes[:'version']
+      if attributes.key?(:'number_of_notice_periods')
+        self.number_of_notice_periods = attributes[:'number_of_notice_periods']
       end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if !@reference.nil? && @reference.to_s.length > 125
         invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 125.')
@@ -257,14 +297,29 @@ module VRPayment
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@reference.nil? && @reference.to_s.length > 125
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] enabled_currencies Value to be assigned
+    def enabled_currencies=(enabled_currencies)
+      if enabled_currencies.nil?
+        fail ArgumentError, 'enabled_currencies cannot be nil'
+      end
+
+      @enabled_currencies = enabled_currencies
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] reference Value to be assigned
     def reference=(reference)
-      if !reference.nil? && reference.to_s.length > 125
+      if reference.nil?
+        fail ArgumentError, 'reference cannot be nil'
+      end
+
+      if reference.to_s.length > 125
         fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 125.'
       end
 
@@ -276,28 +331,28 @@ module VRPayment
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          retiring_finished_on == o.retiring_finished_on &&
+          enabled_currencies == o.enabled_currencies &&
+          product == o.product &&
+          retiring_started_on == o.retiring_started_on &&
+          tax_calculation == o.tax_calculation &&
+          planned_purge_date == o.planned_purge_date &&
+          created_on == o.created_on &&
+          version == o.version &&
+          reference == o.reference &&
+          linked_space_id == o.linked_space_id &&
           activated_on == o.activated_on &&
           billing_cycle == o.billing_cycle &&
+          default_currency == o.default_currency &&
+          name == o.name &&
+          minimal_number_of_periods == o.minimal_number_of_periods &&
+          obsoleted_on == o.obsoleted_on &&
           billing_cycle_model == o.billing_cycle_model &&
           comment == o.comment &&
-          created_on == o.created_on &&
-          default_currency == o.default_currency &&
-          enabled_currencies == o.enabled_currencies &&
           id == o.id &&
           increment_number == o.increment_number &&
-          linked_space_id == o.linked_space_id &&
-          minimal_number_of_periods == o.minimal_number_of_periods &&
-          name == o.name &&
-          number_of_notice_periods == o.number_of_notice_periods &&
-          obsoleted_on == o.obsoleted_on &&
-          planned_purge_date == o.planned_purge_date &&
-          product == o.product &&
-          reference == o.reference &&
-          retiring_finished_on == o.retiring_finished_on &&
-          retiring_started_on == o.retiring_started_on &&
           state == o.state &&
-          tax_calculation == o.tax_calculation &&
-          version == o.version
+          number_of_notice_periods == o.number_of_notice_periods
     end
 
     # @see the `==` method
@@ -307,39 +362,40 @@ module VRPayment
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def 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
+      [retiring_finished_on, enabled_currencies, product, retiring_started_on, tax_calculation, planned_purge_date, created_on, version, reference, linked_space_id, activated_on, billing_cycle, default_currency, name, minimal_number_of_periods, obsoleted_on, billing_cycle_model, comment, id, increment_number, state, number_of_notice_periods].hash
+    end    # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
+    def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -348,7 +404,7 @@ module VRPayment
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -369,8 +425,9 @@ module VRPayment
           end
         end
       else # model
-        temp_model = VRPayment.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = VrpaymentRubySdk.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -392,7 +449,11 @@ module VRPayment
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -404,7 +465,7 @@ module VRPayment
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -415,6 +476,5 @@ module VRPayment
         value
       end
     end
-
   end
 end