maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/create_product_price_point.rb

@@ -36,9 +36,9 @@ module AdvancedBilling
     # @return [Integer]
     attr_accessor :trial_price_in_cents
 
-    # The numerical trial interval. i.e. an interval of ‘30’ coupled with an
-    # trial_interval_unit of day would mean this product price point would renew
-    # every 30 days
+    # The numerical trial interval. i.e. an interval of ‘30’ coupled with a
+    # trial_interval_unit of day would mean this product price point trial would
+    # last 30 days.
     # @return [Integer]
     attr_accessor :trial_interval
 
@@ -62,7 +62,7 @@ module AdvancedBilling
 
     # The numerical expiration interval. i.e. an expiration_interval of ‘30’
     # coupled with an expiration_interval_unit of day would mean this product
-    # price point would expire every 30 days
+    # price point would expire after 30 days.
     # @return [Integer]
     attr_accessor :expiration_interval
 
@@ -130,7 +130,8 @@ module AdvancedBilling
                    initial_charge_after_trial = SKIP,
                    expiration_interval = SKIP,
                    expiration_interval_unit = SKIP,
-                   use_site_exchange_rate = true)
+                   use_site_exchange_rate = true,
+                   additional_properties = {})
       @name = name
       @handle = handle unless handle == SKIP
       @price_in_cents = price_in_cents
@@ -148,6 +149,11 @@ module AdvancedBilling
       @expiration_interval = expiration_interval unless expiration_interval == SKIP
       @expiration_interval_unit = expiration_interval_unit unless expiration_interval_unit == SKIP
       @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == 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.
@@ -178,6 +184,9 @@ module AdvancedBilling
         hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : SKIP
       use_site_exchange_rate = hash['use_site_exchange_rate'] ||= true
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateProductPricePoint.new(name,
                                   price_in_cents,
@@ -192,7 +201,8 @@ module AdvancedBilling
                                   initial_charge_after_trial,
                                   expiration_interval,
                                   expiration_interval_unit,
-                                  use_site_exchange_rate)
+                                  use_site_exchange_rate,
+                                  hash)
     end
   end
 end

data/lib/advanced_billing/models/create_product_price_point_request.rb

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

data/lib/advanced_billing/models/create_quantity_based_component.rb

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

data/lib/advanced_billing/models/create_reason_code.rb

@@ -44,10 +44,16 @@ module AdvancedBilling
 
     def initialize(code = nil,
                    description = nil,
-                   position = SKIP)
+                   position = SKIP,
+                   additional_properties = {})
       @code = code
       @description = description
       @position = position unless position == 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.
@@ -59,10 +65,14 @@ module AdvancedBilling
       description = hash.key?('description') ? hash['description'] : nil
       position = hash.key?('position') ? hash['position'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateReasonCode.new(code,
                            description,
-                           position)
+                           position,
+                           hash)
     end
   end
 end

data/lib/advanced_billing/models/create_reason_code_request.rb

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

data/lib/advanced_billing/models/create_segment.rb

@@ -78,13 +78,19 @@ module AdvancedBilling
                    segment_property_2_value = SKIP,
                    segment_property_3_value = SKIP,
                    segment_property_4_value = SKIP,
-                   prices = SKIP)
+                   prices = SKIP,
+                   additional_properties = {})
       @segment_property_1_value = segment_property_1_value unless segment_property_1_value == SKIP
       @segment_property_2_value = segment_property_2_value unless segment_property_2_value == SKIP
       @segment_property_3_value = segment_property_3_value unless segment_property_3_value == SKIP
       @segment_property_4_value = segment_property_4_value unless segment_property_4_value == SKIP
       @pricing_scheme = pricing_scheme
       @prices = prices unless prices == 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.
@@ -117,13 +123,17 @@ module AdvancedBilling
 
       prices = SKIP unless hash.key?('prices')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateSegment.new(pricing_scheme,
                         segment_property_1_value,
                         segment_property_2_value,
                         segment_property_3_value,
                         segment_property_4_value,
-                        prices)
+                        prices,
+                        hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_segment_request.rb

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

data/lib/advanced_billing/models/create_signup_proforma_preview_include.rb

@@ -0,0 +1,20 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Create Signup Proforma Preview Include.
+  class CreateSignupProformaPreviewInclude
+    CREATE_SIGNUP_PROFORMA_PREVIEW_INCLUDE = [
+      # TODO: Write general description for NEXT_PROFORMA_INVOICE
+      NEXT_PROFORMA_INVOICE = 'next_proforma_invoice'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREATE_SIGNUP_PROFORMA_PREVIEW_INCLUDE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/create_subscription.rb

@@ -273,7 +273,7 @@ module AdvancedBilling
     # added to your MRR analytics immediately. For this value to be honored, a
     # next_billing_at must be present and set to a future date. This key/value
     # will not be returned in the subscription response body.
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :canceled_at
 
     # Setting this attribute to true will cause the subscription's MRR to be
@@ -478,7 +478,8 @@ module AdvancedBilling
                    ach_agreement = SKIP,
                    dunning_communication_delay_enabled = false,
                    dunning_communication_delay_time_zone = SKIP,
-                   skip_billing_manifest_taxes = false)
+                   skip_billing_manifest_taxes = false,
+                   additional_properties = {})
       @product_handle = product_handle unless product_handle == SKIP
       @product_id = product_id unless product_id == SKIP
       unless product_price_point_handle == SKIP
@@ -555,6 +556,11 @@ module AdvancedBilling
         @skip_billing_manifest_taxes =
           skip_billing_manifest_taxes
       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.
@@ -655,7 +661,11 @@ module AdvancedBilling
                               SKIP
                             end
       import_mrr = hash.key?('import_mrr') ? hash['import_mrr'] : SKIP
-      canceled_at = hash.key?('canceled_at') ? hash['canceled_at'] : SKIP
+      canceled_at = if hash.key?('canceled_at')
+                      (DateTimeHelper.from_rfc3339(hash['canceled_at']) if hash['canceled_at'])
+                    else
+                      SKIP
+                    end
       activated_at = if hash.key?('activated_at')
                        (DateTimeHelper.from_rfc3339(hash['activated_at']) if hash['activated_at'])
                      else
@@ -671,6 +681,9 @@ module AdvancedBilling
       skip_billing_manifest_taxes =
         hash['skip_billing_manifest_taxes'] ||= false
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateSubscription.new(product_handle,
                              product_id,
@@ -720,7 +733,8 @@ module AdvancedBilling
                              ach_agreement,
                              dunning_communication_delay_enabled,
                              dunning_communication_delay_time_zone,
-                             skip_billing_manifest_taxes)
+                             skip_billing_manifest_taxes,
+                             hash)
     end
 
     def to_custom_next_billing_at
@@ -739,6 +753,10 @@ module AdvancedBilling
       DateTimeHelper.to_rfc3339(previous_billing_at)
     end
 
+    def to_custom_canceled_at
+      DateTimeHelper.to_rfc3339(canceled_at)
+    end
+
     def to_custom_activated_at
       DateTimeHelper.to_rfc3339(activated_at)
     end

data/lib/advanced_billing/models/create_subscription_component.rb

@@ -75,7 +75,8 @@ module AdvancedBilling
                    allocated_quantity = SKIP,
                    quantity = SKIP,
                    price_point_id = SKIP,
-                   custom_price = SKIP)
+                   custom_price = SKIP,
+                   additional_properties = {})
       @component_id = component_id unless component_id == SKIP
       @enabled = enabled unless enabled == SKIP
       @unit_balance = unit_balance unless unit_balance == SKIP
@@ -83,6 +84,11 @@ module AdvancedBilling
       @quantity = quantity unless quantity == SKIP
       @price_point_id = price_point_id unless price_point_id == SKIP
       @custom_price = custom_price unless custom_price == 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
       ) : SKIP
       custom_price = ComponentCustomPrice.from_hash(hash['custom_price']) if hash['custom_price']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateSubscriptionComponent.new(component_id,
                                       enabled,
@@ -111,7 +120,8 @@ module AdvancedBilling
                                       allocated_quantity,
                                       quantity,
                                       price_point_id,
-                                      custom_price)
+                                      custom_price,
+                                      hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_subscription_group.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [Object]
+    # @return [Integer]
     attr_accessor :subscription_id
 
     # TODO: Write general description for this method
@@ -38,9 +38,15 @@ module AdvancedBilling
     end
 
     def initialize(subscription_id = nil,
-                   member_ids = SKIP)
+                   member_ids = SKIP,
+                   additional_properties = {})
       @subscription_id = subscription_id
       @member_ids = member_ids unless member_ids == 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.
@@ -48,28 +54,17 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      subscription_id = hash.key?('subscription_id') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CreateSubscriptionGroupSubscriptionId), hash['subscription_id']
-      ) : nil
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : nil
       member_ids = hash.key?('member_ids') ? hash['member_ids'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateSubscriptionGroup.new(subscription_id,
-                                  member_ids)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [CreateSubscriptionGroup | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return UnionTypeLookUp.get(:CreateSubscriptionGroupSubscriptionId)
-                              .validate(value.subscription_id)
-      end
-
-      return false unless value.instance_of? Hash
-
-      UnionTypeLookUp.get(:CreateSubscriptionGroupSubscriptionId)
-                     .validate(value['subscription_id'])
+                                  member_ids,
+                                  hash)
     end
   end
 end

data/lib/advanced_billing/models/create_subscription_group_request.rb

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

data/lib/advanced_billing/models/create_subscription_request.rb

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

data/lib/advanced_billing/models/create_usage.rb

@@ -59,11 +59,17 @@ module AdvancedBilling
     def initialize(quantity = SKIP,
                    price_point_id = SKIP,
                    memo = SKIP,
-                   billing_schedule = SKIP)
+                   billing_schedule = SKIP,
+                   additional_properties = {})
       @quantity = quantity unless quantity == SKIP
       @price_point_id = price_point_id unless price_point_id == SKIP
       @memo = memo unless memo == 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.
@@ -78,11 +84,15 @@ module AdvancedBilling
       billing_schedule = BillingSchedule.from_hash(hash['billing_schedule']) if
         hash['billing_schedule']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateUsage.new(quantity,
                       price_point_id,
                       memo,
-                      billing_schedule)
+                      billing_schedule,
+                      hash)
     end
   end
 end

data/lib/advanced_billing/models/create_usage_request.rb

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

data/lib/advanced_billing/models/created_prepayment.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # CreatedPrepayment Model.
   class CreatedPrepayment < BaseModel
@@ -26,7 +27,7 @@ module AdvancedBilling
     attr_accessor :memo
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :created_at
 
     # TODO: Write general description for this method
@@ -74,7 +75,8 @@ module AdvancedBilling
                    memo = SKIP,
                    created_at = SKIP,
                    starting_balance_in_cents = SKIP,
-                   ending_balance_in_cents = SKIP)
+                   ending_balance_in_cents = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @subscription_id = subscription_id unless subscription_id == SKIP
       @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
@@ -85,6 +87,11 @@ module AdvancedBilling
           starting_balance_in_cents
       end
       @ending_balance_in_cents = ending_balance_in_cents unless ending_balance_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.
@@ -98,12 +105,19 @@ module AdvancedBilling
       amount_in_cents =
         hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
       memo = hash.key?('memo') ? hash['memo'] : SKIP
-      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
       starting_balance_in_cents =
         hash.key?('starting_balance_in_cents') ? hash['starting_balance_in_cents'] : SKIP
       ending_balance_in_cents =
         hash.key?('ending_balance_in_cents') ? hash['ending_balance_in_cents'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreatedPrepayment.new(id,
                             subscription_id,
@@ -111,7 +125,12 @@ module AdvancedBilling
                             memo,
                             created_at,
                             starting_balance_in_cents,
-                            ending_balance_in_cents)
+                            ending_balance_in_cents,
+                            hash)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
     end
   end
 end