maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/create_metadata.rb

@@ -39,9 +39,15 @@ module AdvancedBilling
     end
 
     def initialize(name = SKIP,
-                   value = SKIP)
+                   value = SKIP,
+                   additional_properties = {})
       @name = name unless name == SKIP
       @value = value unless value == 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.
@@ -52,9 +58,13 @@ module AdvancedBilling
       name = hash.key?('name') ? hash['name'] : SKIP
       value = hash.key?('value') ? hash['value'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateMetadata.new(name,
-                         value)
+                         value,
+                         hash)
     end
   end
 end

data/lib/advanced_billing/models/create_metadata_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(metadata = nil)
+    def initialize(metadata = nil,
+                   additional_properties = {})
       @metadata = metadata
+
+      # 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.
@@ -50,8 +56,12 @@ module AdvancedBilling
 
       metadata = nil unless hash.key?('metadata')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateMetadataRequest.new(metadata)
+      CreateMetadataRequest.new(metadata,
+                                hash)
     end
   end
 end

data/lib/advanced_billing/models/create_metafield.rb

@@ -59,11 +59,17 @@ module AdvancedBilling
     def initialize(name = SKIP,
                    scope = SKIP,
                    input_type = SKIP,
-                   enum = SKIP)
+                   enum = SKIP,
+                   additional_properties = {})
       @name = name unless name == SKIP
       @scope = scope unless scope == SKIP
       @input_type = input_type unless input_type == SKIP
       @enum = enum unless enum == 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.
@@ -76,11 +82,15 @@ module AdvancedBilling
       input_type = hash.key?('input_type') ? hash['input_type'] : SKIP
       enum = hash.key?('enum') ? hash['enum'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateMetafield.new(name,
                           scope,
                           input_type,
-                          enum)
+                          enum,
+                          hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_metafields_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(metafields = nil)
+    def initialize(metafields = nil,
+                   additional_properties = {})
       @metafields = metafields
+
+      # 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.
@@ -43,8 +49,12 @@ module AdvancedBilling
         UnionTypeLookUp.get(:CreateMetafieldsRequestMetafields), hash['metafields']
       ) : nil
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateMetafieldsRequest.new(metafields)
+      CreateMetafieldsRequest.new(metafields,
+                                  hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_metered_component.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(metered_component = nil)
+    def initialize(metered_component = nil,
+                   additional_properties = {})
       @metered_component = metered_component
+
+      # 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.
@@ -42,8 +48,12 @@ module AdvancedBilling
       metered_component = MeteredComponent.from_hash(hash['metered_component']) if
         hash['metered_component']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateMeteredComponent.new(metered_component)
+      CreateMeteredComponent.new(metered_component,
+                                 hash)
     end
   end
 end

data/lib/advanced_billing/models/create_multi_invoice_payment.rb

@@ -67,13 +67,19 @@ module AdvancedBilling
                    memo = SKIP,
                    details = SKIP,
                    method = SKIP,
-                   received_on = SKIP)
+                   received_on = SKIP,
+                   additional_properties = {})
       @memo = memo unless memo == SKIP
       @details = details unless details == SKIP
       @method = method unless method == SKIP
       @amount = amount
       @received_on = received_on unless received_on == SKIP
       @applications = applications
+
+      # 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.
@@ -99,13 +105,17 @@ module AdvancedBilling
       method = hash.key?('method') ? hash['method'] : SKIP
       received_on = hash.key?('received_on') ? hash['received_on'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateMultiInvoicePayment.new(amount,
                                     applications,
                                     memo,
                                     details,
                                     method,
-                                    received_on)
+                                    received_on,
+                                    hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_multi_invoice_payment_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(payment = nil)
+    def initialize(payment = nil,
+                   additional_properties = {})
       @payment = payment
+
+      # 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.
@@ -41,8 +47,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       payment = CreateMultiInvoicePayment.from_hash(hash['payment']) if hash['payment']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateMultiInvoicePaymentRequest.new(payment)
+      CreateMultiInvoicePaymentRequest.new(payment,
+                                           hash)
     end
   end
 end

data/lib/advanced_billing/models/create_offer.rb

@@ -71,7 +71,8 @@ module AdvancedBilling
                    description = SKIP,
                    product_price_point_id = SKIP,
                    components = SKIP,
-                   coupons = SKIP)
+                   coupons = SKIP,
+                   additional_properties = {})
       @name = name
       @handle = handle
       @description = description unless description == SKIP
@@ -79,6 +80,11 @@ module AdvancedBilling
       @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
       @components = components unless components == SKIP
       @coupons = coupons unless coupons == 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.
@@ -104,6 +110,9 @@ module AdvancedBilling
       components = SKIP unless hash.key?('components')
       coupons = hash.key?('coupons') ? hash['coupons'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateOffer.new(name,
                       handle,
@@ -111,7 +120,8 @@ module AdvancedBilling
                       description,
                       product_price_point_id,
                       components,
-                      coupons)
+                      coupons,
+                      hash)
     end
   end
 end

data/lib/advanced_billing/models/create_offer_component.rb

@@ -39,9 +39,15 @@ module AdvancedBilling
     end
 
     def initialize(component_id = SKIP,
-                   starting_quantity = SKIP)
+                   starting_quantity = SKIP,
+                   additional_properties = {})
       @component_id = component_id unless component_id == SKIP
       @starting_quantity = starting_quantity unless starting_quantity == 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.
@@ -53,9 +59,13 @@ module AdvancedBilling
       starting_quantity =
         hash.key?('starting_quantity') ? hash['starting_quantity'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateOfferComponent.new(component_id,
-                               starting_quantity)
+                               starting_quantity,
+                               hash)
     end
   end
 end

data/lib/advanced_billing/models/create_offer_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(offer = nil)
+    def initialize(offer = nil,
+                   additional_properties = {})
       @offer = offer
+
+      # 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.
@@ -41,8 +47,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       offer = CreateOffer.from_hash(hash['offer']) if hash['offer']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateOfferRequest.new(offer)
+      CreateOfferRequest.new(offer,
+                             hash)
     end
   end
 end

data/lib/advanced_billing/models/create_on_off_component.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(on_off_component = nil)
+    def initialize(on_off_component = nil,
+                   additional_properties = {})
       @on_off_component = on_off_component
+
+      # 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.
@@ -42,8 +48,12 @@ module AdvancedBilling
       on_off_component = OnOffComponent.from_hash(hash['on_off_component']) if
         hash['on_off_component']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateOnOffComponent.new(on_off_component)
+      CreateOnOffComponent.new(on_off_component,
+                               hash)
     end
   end
 end

data/lib/advanced_billing/models/create_or_update_coupon.rb

@@ -48,10 +48,16 @@ module AdvancedBilling
 
     def initialize(coupon = SKIP,
                    restricted_products = SKIP,
-                   restricted_components = 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
     end
 
     # Creates an instance of the object from a hash.
@@ -67,10 +73,14 @@ module AdvancedBilling
       restricted_components =
         hash.key?('restricted_components') ? hash['restricted_components'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateOrUpdateCoupon.new(coupon,
                                restricted_products,
-                               restricted_components)
+                               restricted_components,
+                               hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/{update_endpoint.rb → create_or_update_endpoint.rb}

@@ -5,7 +5,7 @@
 
 module AdvancedBilling
   # Used to Create or Update Endpoint
-  class UpdateEndpoint < BaseModel
+  class CreateOrUpdateEndpoint < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -36,9 +36,15 @@ module AdvancedBilling
     end
 
     def initialize(url = nil,
-                   webhook_subscriptions = nil)
+                   webhook_subscriptions = nil,
+                   additional_properties = {})
       @url = url
       @webhook_subscriptions = webhook_subscriptions
+
+      # 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.
@@ -50,9 +56,13 @@ module AdvancedBilling
       webhook_subscriptions =
         hash.key?('webhook_subscriptions') ? hash['webhook_subscriptions'] : nil
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      UpdateEndpoint.new(url,
-                         webhook_subscriptions)
+      CreateOrUpdateEndpoint.new(url,
+                                 webhook_subscriptions,
+                                 hash)
     end
   end
 end

data/lib/advanced_billing/models/{update_endpoint_request.rb → create_or_update_endpoint_request.rb}

@@ -5,12 +5,12 @@
 
 module AdvancedBilling
   # Used to Create or Update Endpoint
-  class UpdateEndpointRequest < BaseModel
+  class CreateOrUpdateEndpointRequest < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
     # Used to Create or Update Endpoint
-    # @return [UpdateEndpoint]
+    # @return [CreateOrUpdateEndpoint]
     attr_accessor :endpoint
 
     # A mapping from model property names to API property names.
@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(endpoint = nil)
+    def initialize(endpoint = nil,
+                   additional_properties = {})
       @endpoint = endpoint
+
+      # 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.
@@ -39,10 +45,14 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      endpoint = UpdateEndpoint.from_hash(hash['endpoint']) if hash['endpoint']
+      endpoint = CreateOrUpdateEndpoint.from_hash(hash['endpoint']) if hash['endpoint']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
-      UpdateEndpointRequest.new(endpoint)
+      CreateOrUpdateEndpointRequest.new(endpoint,
+                                        hash)
     end
   end
 end

data/lib/advanced_billing/models/create_or_update_flat_amount_coupon.rb

@@ -80,6 +80,12 @@ module AdvancedBilling
     # @return [TrueClass | FalseClass]
     attr_accessor :apply_on_cancel_at_end_of_period
 
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @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?
@@ -97,6 +103,8 @@ module AdvancedBilling
         '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
 
@@ -112,6 +120,7 @@ module AdvancedBilling
         compounding_strategy
         exclude_mid_period_allocations
         apply_on_cancel_at_end_of_period
+        apply_on_subscription_expiration
       ]
     end
 
@@ -131,7 +140,9 @@ module AdvancedBilling
                    stackable = SKIP,
                    compounding_strategy = SKIP,
                    exclude_mid_period_allocations = SKIP,
-                   apply_on_cancel_at_end_of_period = SKIP)
+                   apply_on_cancel_at_end_of_period = SKIP,
+                   apply_on_subscription_expiration = SKIP,
+                   additional_properties = {})
       @name = name
       @code = code
       @description = description unless description == SKIP
@@ -150,6 +161,15 @@ module AdvancedBilling
         @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
+
+      # 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.
@@ -179,6 +199,11 @@ module AdvancedBilling
         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.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       CreateOrUpdateFlatAmountCoupon.new(name,
@@ -192,7 +217,9 @@ module AdvancedBilling
                                          stackable,
                                          compounding_strategy,
                                          exclude_mid_period_allocations,
-                                         apply_on_cancel_at_end_of_period)
+                                         apply_on_cancel_at_end_of_period,
+                                         apply_on_subscription_expiration,
+                                         hash)
     end
 
     def to_custom_end_date

data/lib/advanced_billing/models/create_or_update_percentage_coupon.rb

@@ -80,6 +80,12 @@ module AdvancedBilling
     # @return [TrueClass | FalseClass]
     attr_accessor :apply_on_cancel_at_end_of_period
 
+    # may contain uppercase alphanumeric characters and these special characters
+    # (which allow for email addresses to be used): “%”, “@”, “+”, “-”, “_”, and
+    # “.”
+    # @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?
@@ -97,6 +103,8 @@ module AdvancedBilling
         '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
 
@@ -112,6 +120,7 @@ module AdvancedBilling
         compounding_strategy
         exclude_mid_period_allocations
         apply_on_cancel_at_end_of_period
+        apply_on_subscription_expiration
       ]
     end
 
@@ -131,7 +140,9 @@ module AdvancedBilling
                    stackable = SKIP,
                    compounding_strategy = SKIP,
                    exclude_mid_period_allocations = SKIP,
-                   apply_on_cancel_at_end_of_period = SKIP)
+                   apply_on_cancel_at_end_of_period = SKIP,
+                   apply_on_subscription_expiration = SKIP,
+                   additional_properties = {})
       @name = name
       @code = code
       @description = description unless description == SKIP
@@ -150,6 +161,15 @@ module AdvancedBilling
         @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
+
+      # 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.
@@ -180,6 +200,11 @@ module AdvancedBilling
         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.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       CreateOrUpdatePercentageCoupon.new(name,
@@ -193,7 +218,9 @@ module AdvancedBilling
                                          stackable,
                                          compounding_strategy,
                                          exclude_mid_period_allocations,
-                                         apply_on_cancel_at_end_of_period)
+                                         apply_on_cancel_at_end_of_period,
+                                         apply_on_subscription_expiration,
+                                         hash)
     end
 
     def to_custom_end_date