maxio-advanced-billing-sdk 5.1.0 → 6.0.0

data/lib/advanced_billing/models/coupon_payload.rb

@@ -0,0 +1,244 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CouponPayload Model.
+  class CouponPayload < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required when creating a new coupon. This name is not displayed to
+    # customers and is limited to 255 characters.
+    # @return [String]
+    attr_accessor :name
+
+    # Required when creating a new coupon. The code is limited to 255
+    # characters. May contain uppercase alphanumeric characters and these
+    # special characters (which allow for email addresses to be used): “%”, “@”,
+    # “+”, “-”, “_”, and “.”
+    # @return [String]
+    attr_accessor :code
+
+    # Required when creating a new coupon. A description of the coupon that can
+    # be displayed to customers in transactions and on statements. The
+    # description is limited to 255 characters.
+    # @return [String]
+    attr_accessor :description
+
+    # Required when creating a new percentage coupon. Can't be used together
+    # with amount_in_cents. Percentage discount
+    # @return [Object]
+    attr_accessor :percentage
+
+    # Required when creating a new flat amount coupon. Can't be used together
+    # with percentage. Flat USD discount
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # If set to true, discount is not limited (credits will carry forward to
+    # next billing). Can't be used together with restrictions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_negative_balance
+
+    # If set to true, discount is not limited (credits will carry forward to
+    # next billing). Can't be used together with restrictions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recurring
+
+    # After the end of the given day, this coupon code will be invalid for new
+    # signups. Recurring discounts started before this date will continue to
+    # recur even after this date.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # After the end of the given day, this coupon code will be invalid for new
+    # signups. Recurring discounts started before this date will continue to
+    # recur even after this date.
+    # @return [String]
+    attr_accessor :product_family_id
+
+    # A stackable coupon can be combined with other coupons on a Subscription.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :stackable
+
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
+    # @return [CompoundingStrategy]
+    attr_accessor :compounding_strategy
+
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclude_mid_period_allocations
+
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :apply_on_cancel_at_end_of_period
+
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :apply_on_subscription_expiration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash['percentage'] = 'percentage'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['allow_negative_balance'] = 'allow_negative_balance'
+      @_hash['recurring'] = 'recurring'
+      @_hash['end_date'] = 'end_date'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['stackable'] = 'stackable'
+      @_hash['compounding_strategy'] = 'compounding_strategy'
+      @_hash['exclude_mid_period_allocations'] =
+        'exclude_mid_period_allocations'
+      @_hash['apply_on_cancel_at_end_of_period'] =
+        'apply_on_cancel_at_end_of_period'
+      @_hash['apply_on_subscription_expiration'] =
+        'apply_on_subscription_expiration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        code
+        description
+        percentage
+        amount_in_cents
+        allow_negative_balance
+        recurring
+        end_date
+        product_family_id
+        stackable
+        compounding_strategy
+        exclude_mid_period_allocations
+        apply_on_cancel_at_end_of_period
+        apply_on_subscription_expiration
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, code: SKIP, description: SKIP, percentage: SKIP,
+                   amount_in_cents: SKIP, allow_negative_balance: SKIP,
+                   recurring: SKIP, end_date: SKIP, product_family_id: SKIP,
+                   stackable: SKIP, compounding_strategy: SKIP,
+                   exclude_mid_period_allocations: SKIP,
+                   apply_on_cancel_at_end_of_period: SKIP,
+                   apply_on_subscription_expiration: SKIP,
+                   additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @name = name unless name == SKIP
+      @code = code unless code == SKIP
+      @description = description unless description == SKIP
+      @percentage = percentage unless percentage == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @allow_negative_balance = allow_negative_balance unless allow_negative_balance == SKIP
+      @recurring = recurring unless recurring == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @stackable = stackable unless stackable == SKIP
+      @compounding_strategy = compounding_strategy unless compounding_strategy == SKIP
+      unless exclude_mid_period_allocations == SKIP
+        @exclude_mid_period_allocations =
+          exclude_mid_period_allocations
+      end
+      unless apply_on_cancel_at_end_of_period == SKIP
+        @apply_on_cancel_at_end_of_period =
+          apply_on_cancel_at_end_of_period
+      end
+      unless apply_on_subscription_expiration == SKIP
+        @apply_on_subscription_expiration =
+          apply_on_subscription_expiration
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      percentage = hash.key?('percentage') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CouponPayloadPercentage), hash['percentage']
+      ) : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      allow_negative_balance =
+        hash.key?('allow_negative_balance') ? hash['allow_negative_balance'] : SKIP
+      recurring = hash.key?('recurring') ? hash['recurring'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      product_family_id =
+        hash.key?('product_family_id') ? hash['product_family_id'] : SKIP
+      stackable = hash.key?('stackable') ? hash['stackable'] : SKIP
+      compounding_strategy =
+        hash.key?('compounding_strategy') ? hash['compounding_strategy'] : SKIP
+      exclude_mid_period_allocations =
+        hash.key?('exclude_mid_period_allocations') ? hash['exclude_mid_period_allocations'] : SKIP
+      apply_on_cancel_at_end_of_period =
+        hash.key?('apply_on_cancel_at_end_of_period') ? hash['apply_on_cancel_at_end_of_period'] : SKIP
+      apply_on_subscription_expiration =
+        hash.key?('apply_on_subscription_expiration') ? hash['apply_on_subscription_expiration'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      CouponPayload.new(name: name,
+                        code: code,
+                        description: description,
+                        percentage: percentage,
+                        amount_in_cents: amount_in_cents,
+                        allow_negative_balance: allow_negative_balance,
+                        recurring: recurring,
+                        end_date: end_date,
+                        product_family_id: product_family_id,
+                        stackable: stackable,
+                        compounding_strategy: compounding_strategy,
+                        exclude_mid_period_allocations: exclude_mid_period_allocations,
+                        apply_on_cancel_at_end_of_period: apply_on_cancel_at_end_of_period,
+                        apply_on_subscription_expiration: apply_on_subscription_expiration,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CouponPayload | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/{create_or_update_coupon.rb → coupon_request.rb}

@@ -4,13 +4,13 @@
 # ( https://apimatic.io ).
 
 module AdvancedBilling
-  # CreateOrUpdateCoupon Model.
-  class CreateOrUpdateCoupon < BaseModel
+  # CouponRequest Model.
+  class CouponRequest < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [Object]
+    # @return [CouponPayload]
     attr_accessor :coupon
 
     # An object where the keys are product_ids and the values are booleans
@@ -48,14 +48,14 @@ module AdvancedBilling
 
     def initialize(coupon: SKIP, restricted_products: SKIP,
                    restricted_components: SKIP, additional_properties: {})
-      @coupon = coupon unless coupon == SKIP
-      @restricted_products = restricted_products unless restricted_products == SKIP
-      @restricted_components = restricted_components unless restricted_components == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @coupon = coupon unless coupon == SKIP
+      @restricted_products = restricted_products unless restricted_products == SKIP
+      @restricted_components = restricted_components unless restricted_components == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -63,32 +63,20 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      coupon = hash.key?('coupon') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CreateOrUpdateCouponCoupon), hash['coupon']
-      ) : SKIP
+      coupon = CouponPayload.from_hash(hash['coupon']) if hash['coupon']
       restricted_products =
         hash.key?('restricted_products') ? hash['restricted_products'] : SKIP
       restricted_components =
         hash.key?('restricted_components') ? hash['restricted_components'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
-      CreateOrUpdateCoupon.new(coupon: coupon,
-                               restricted_products: restricted_products,
-                               restricted_components: restricted_components,
-                               additional_properties: hash)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [CreateOrUpdateCoupon | Hash] The value against the validation is performed.
-    def self.validate(value)
-      return true if value.instance_of? self
-
-      return false unless value.instance_of? Hash
-
-      true
+      CouponRequest.new(coupon: coupon,
+                        restricted_products: restricted_products,
+                        restricted_components: restricted_components,
+                        additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon_response.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(coupon: SKIP, additional_properties: {})
-      @coupon = coupon unless coupon == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @coupon = coupon unless coupon == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       coupon = Coupon.from_hash(hash['coupon']) if hash['coupon']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponResponse.new(coupon: coupon,
-                         additional_properties: hash)
+                         additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon_restriction.rb

@@ -60,16 +60,16 @@ module AdvancedBilling
 
     def initialize(id: SKIP, item_type: SKIP, item_id: SKIP, name: SKIP,
                    handle: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id unless id == SKIP
       @item_type = item_type unless item_type == SKIP
       @item_id = item_id unless item_id == SKIP
       @name = name unless name == SKIP
       @handle = handle unless handle == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -84,7 +84,7 @@ module AdvancedBilling
       handle = hash.key?('handle') ? hash['handle'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponRestriction.new(id: id,
@@ -92,7 +92,7 @@ module AdvancedBilling
                             item_id: item_id,
                             name: name,
                             handle: handle,
-                            additional_properties: hash)
+                            additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon_subcodes.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(codes: SKIP, additional_properties: {})
-      @codes = codes unless codes == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @codes = codes unless codes == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       codes = hash.key?('codes') ? hash['codes'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponSubcodes.new(codes: codes,
-                         additional_properties: hash)
+                         additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon_subcodes_response.rb

@@ -46,14 +46,14 @@ module AdvancedBilling
 
     def initialize(created_codes: SKIP, duplicate_codes: SKIP,
                    invalid_codes: SKIP, additional_properties: {})
-      @created_codes = created_codes unless created_codes == SKIP
-      @duplicate_codes = duplicate_codes unless duplicate_codes == SKIP
-      @invalid_codes = invalid_codes unless invalid_codes == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @created_codes = created_codes unless created_codes == SKIP
+      @duplicate_codes = duplicate_codes unless duplicate_codes == SKIP
+      @invalid_codes = invalid_codes unless invalid_codes == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -67,13 +67,13 @@ module AdvancedBilling
       invalid_codes = hash.key?('invalid_codes') ? hash['invalid_codes'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponSubcodesResponse.new(created_codes: created_codes,
                                  duplicate_codes: duplicate_codes,
                                  invalid_codes: invalid_codes,
-                                 additional_properties: hash)
+                                 additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon_usage.rb

@@ -77,6 +77,11 @@ module AdvancedBilling
     def initialize(id: SKIP, name: SKIP, signups: SKIP, savings: SKIP,
                    savings_in_cents: SKIP, revenue: SKIP,
                    revenue_in_cents: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id unless id == SKIP
       @name = name unless name == SKIP
       @signups = signups unless signups == SKIP
@@ -84,11 +89,6 @@ module AdvancedBilling
       @savings_in_cents = savings_in_cents unless savings_in_cents == SKIP
       @revenue = revenue unless revenue == SKIP
       @revenue_in_cents = revenue_in_cents unless revenue_in_cents == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -107,7 +107,7 @@ module AdvancedBilling
         hash.key?('revenue_in_cents') ? hash['revenue_in_cents'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponUsage.new(id: id,
@@ -117,7 +117,7 @@ module AdvancedBilling
                       savings_in_cents: savings_in_cents,
                       revenue: revenue,
                       revenue_in_cents: revenue_in_cents,
-                      additional_properties: hash)
+                      additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/create_allocation.rb

@@ -121,6 +121,11 @@ module AdvancedBilling
                    downgrade_credit: SKIP, upgrade_charge: SKIP,
                    initiate_dunning: SKIP, price_point_id: SKIP,
                    billing_schedule: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @quantity = quantity
       @component_id = component_id unless component_id == SKIP
       @memo = memo unless memo == SKIP
@@ -135,11 +140,6 @@ module AdvancedBilling
       @initiate_dunning = initiate_dunning unless initiate_dunning == SKIP
       @price_point_id = price_point_id unless price_point_id == SKIP
       @billing_schedule = billing_schedule unless billing_schedule == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -168,7 +168,7 @@ module AdvancedBilling
         hash['billing_schedule']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CreateAllocation.new(quantity: quantity,
@@ -182,7 +182,7 @@ module AdvancedBilling
                            initiate_dunning: initiate_dunning,
                            price_point_id: price_point_id,
                            billing_schedule: billing_schedule,
-                           additional_properties: hash)
+                           additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_allocation_request.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(allocation:, additional_properties: {})
-      @allocation = allocation
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @allocation = allocation
     end
 
     # Creates an instance of the object from a hash.
@@ -47,11 +47,11 @@ module AdvancedBilling
       allocation = CreateAllocation.from_hash(hash['allocation']) if hash['allocation']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CreateAllocationRequest.new(allocation: allocation,
-                                  additional_properties: hash)
+                                  additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/create_component_price_point.rb

@@ -30,11 +30,13 @@ module AdvancedBilling
     attr_accessor :prices
 
     # Whether to use the site level exchange rate or define your own prices for
-    # each currency if you have multiple currencies defined on the site.
+    # each currency if you have multiple currencies defined on the site. Setting
+    # not supported when creating price points in bulk.
     # @return [TrueClass | FalseClass]
     attr_accessor :use_site_exchange_rate
 
-    # Whether or not the price point includes tax
+    # Whether or not the price point includes tax. Setting not supported when
+    # creating price points in bulk.
     # @return [TrueClass | FalseClass]
     attr_accessor :tax_included
 
@@ -87,6 +89,11 @@ module AdvancedBilling
                    use_site_exchange_rate: true, tax_included: SKIP,
                    interval: SKIP, interval_unit: SKIP,
                    additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @name = name
       @handle = handle unless handle == SKIP
       @pricing_scheme = pricing_scheme
@@ -95,11 +102,6 @@ module AdvancedBilling
       @tax_included = tax_included unless tax_included == SKIP
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless interval_unit == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -127,7 +129,7 @@ module AdvancedBilling
       interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CreateComponentPricePoint.new(name: name,
@@ -138,7 +140,7 @@ module AdvancedBilling
                                     tax_included: tax_included,
                                     interval: interval,
                                     interval_unit: interval_unit,
-                                    additional_properties: hash)
+                                    additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_component_price_point_request.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(price_point:, additional_properties: {})
-      @price_point = price_point
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @price_point = price_point
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       ) : nil
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CreateComponentPricePointRequest.new(price_point: price_point,
-                                           additional_properties: hash)
+                                           additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.