maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/subscription_group_signup_success_data.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # SubscriptionGroupSignupSuccessData Model.
   class SubscriptionGroupSignupSuccessData < BaseModel
@@ -34,7 +35,7 @@ module AdvancedBilling
     attr_accessor :primary_subscription_id
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :next_assessment_at
 
     # TODO: Write general description for this method
@@ -78,7 +79,8 @@ module AdvancedBilling
                    primary_subscription_id = nil,
                    next_assessment_at = nil,
                    state = nil,
-                   cancel_at_end_of_period = nil)
+                   cancel_at_end_of_period = nil,
+                   additional_properties = {})
       @uid = uid
       @scheme = scheme
       @customer_id = customer_id
@@ -88,6 +90,11 @@ module AdvancedBilling
       @next_assessment_at = next_assessment_at
       @state = state
       @cancel_at_end_of_period = cancel_at_end_of_period
+
+      # 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,12 +111,16 @@ module AdvancedBilling
         hash.key?('subscription_ids') ? hash['subscription_ids'] : nil
       primary_subscription_id =
         hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : nil
-      next_assessment_at =
-        hash.key?('next_assessment_at') ? hash['next_assessment_at'] : nil
+      next_assessment_at = if hash.key?('next_assessment_at')
+                             (DateTimeHelper.from_rfc3339(hash['next_assessment_at']) if hash['next_assessment_at'])
+                           end
       state = hash.key?('state') ? hash['state'] : nil
       cancel_at_end_of_period =
         hash.key?('cancel_at_end_of_period') ? hash['cancel_at_end_of_period'] : nil
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupSignupSuccessData.new(uid,
                                              scheme,
@@ -119,7 +130,12 @@ module AdvancedBilling
                                              primary_subscription_id,
                                              next_assessment_at,
                                              state,
-                                             cancel_at_end_of_period)
+                                             cancel_at_end_of_period,
+                                             hash)
+    end
+
+    def to_custom_next_assessment_at
+      DateTimeHelper.to_rfc3339(next_assessment_at)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_single_error.rb

@@ -0,0 +1,73 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupSingleError Model.
+  class SubscriptionGroupSingleError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :subscription_group
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription_group'] = 'subscription_group'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      subscription_group =
+        hash.key?('subscription_group') ? hash['subscription_group'] : nil
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      SubscriptionGroupSingleError.new(subscription_group,
+                                       hash)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupSingleError | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.subscription_group,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['subscription_group'],
+                            ->(val) { val.instance_of? String })
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group_subscription_error.rb

@@ -25,6 +25,22 @@ module AdvancedBilling
     # @return [Array[String]]
     attr_accessor :payment_profile_chargify_token
 
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :base
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :payment_profile_expiration_month
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :payment_profile_expiration_year
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :payment_profile_full_number
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -33,6 +49,12 @@ module AdvancedBilling
       @_hash['payment_profile'] = 'payment_profile'
       @_hash['payment_profile_chargify_token'] =
         'payment_profile.chargify_token'
+      @_hash['base'] = 'base'
+      @_hash['payment_profile_expiration_month'] =
+        'payment_profile.expiration_month'
+      @_hash['payment_profile_expiration_year'] =
+        'payment_profile.expiration_year'
+      @_hash['payment_profile_full_number'] = 'payment_profile.full_number'
       @_hash
     end
 
@@ -43,6 +65,10 @@ module AdvancedBilling
         product_price_point_id
         payment_profile
         payment_profile_chargify_token
+        base
+        payment_profile_expiration_month
+        payment_profile_expiration_year
+        payment_profile_full_number
       ]
     end
 
@@ -54,7 +80,12 @@ module AdvancedBilling
     def initialize(product = SKIP,
                    product_price_point_id = SKIP,
                    payment_profile = SKIP,
-                   payment_profile_chargify_token = SKIP)
+                   payment_profile_chargify_token = SKIP,
+                   base = SKIP,
+                   payment_profile_expiration_month = SKIP,
+                   payment_profile_expiration_year = SKIP,
+                   payment_profile_full_number = SKIP,
+                   additional_properties = {})
       @product = product unless product == SKIP
       @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
       @payment_profile = payment_profile unless payment_profile == SKIP
@@ -62,6 +93,24 @@ module AdvancedBilling
         @payment_profile_chargify_token =
           payment_profile_chargify_token
       end
+      @base = base unless base == SKIP
+      unless payment_profile_expiration_month == SKIP
+        @payment_profile_expiration_month =
+          payment_profile_expiration_month
+      end
+      unless payment_profile_expiration_year == SKIP
+        @payment_profile_expiration_year =
+          payment_profile_expiration_year
+      end
+      unless payment_profile_full_number == SKIP
+        @payment_profile_full_number =
+          payment_profile_full_number
+      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.
@@ -76,12 +125,27 @@ module AdvancedBilling
         hash.key?('payment_profile') ? hash['payment_profile'] : SKIP
       payment_profile_chargify_token =
         hash.key?('payment_profile.chargify_token') ? hash['payment_profile.chargify_token'] : SKIP
+      base = hash.key?('base') ? hash['base'] : SKIP
+      payment_profile_expiration_month =
+        hash.key?('payment_profile.expiration_month') ? hash['payment_profile.expiration_month'] : SKIP
+      payment_profile_expiration_year =
+        hash.key?('payment_profile.expiration_year') ? hash['payment_profile.expiration_year'] : SKIP
+      payment_profile_full_number =
+        hash.key?('payment_profile.full_number') ? hash['payment_profile.full_number'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       SubscriptionGroupSubscriptionError.new(product,
                                              product_price_point_id,
                                              payment_profile,
-                                             payment_profile_chargify_token)
+                                             payment_profile_chargify_token,
+                                             base,
+                                             payment_profile_expiration_month,
+                                             payment_profile_expiration_year,
+                                             payment_profile_full_number,
+                                             hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_update_error.rb

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

data/lib/advanced_billing/models/subscription_groups_list_include.rb

@@ -0,0 +1,20 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Groups List Include.
+  class SubscriptionGroupsListInclude
+    SUBSCRIPTION_GROUPS_LIST_INCLUDE = [
+      # TODO: Write general description for ACCOUNT_BALANCES
+      ACCOUNT_BALANCES = 'account_balances'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_GROUPS_LIST_INCLUDE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_included_coupon.rb

@@ -78,7 +78,8 @@ module AdvancedBilling
                    expires_at = SKIP,
                    recurring = SKIP,
                    amount_in_cents = SKIP,
-                   percentage = SKIP)
+                   percentage = SKIP,
+                   additional_properties = {})
       @code = code unless code == SKIP
       @use_count = use_count unless use_count == SKIP
       @uses_allowed = uses_allowed unless uses_allowed == SKIP
@@ -86,6 +87,11 @@ module AdvancedBilling
       @recurring = recurring unless recurring == SKIP
       @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
       @percentage = percentage unless percentage == 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.
@@ -102,6 +108,9 @@ module AdvancedBilling
         hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
       percentage = hash.key?('percentage') ? hash['percentage'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionIncludedCoupon.new(code,
                                      use_count,
@@ -109,7 +118,8 @@ module AdvancedBilling
                                      expires_at,
                                      recurring,
                                      amount_in_cents,
-                                     percentage)
+                                     percentage,
+                                     hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_migration_preview.rb

@@ -56,7 +56,8 @@ module AdvancedBilling
     def initialize(prorated_adjustment_in_cents = SKIP,
                    charge_in_cents = SKIP,
                    payment_due_in_cents = SKIP,
-                   credit_applied_in_cents = SKIP)
+                   credit_applied_in_cents = SKIP,
+                   additional_properties = {})
       unless prorated_adjustment_in_cents == SKIP
         @prorated_adjustment_in_cents =
           prorated_adjustment_in_cents
@@ -64,6 +65,11 @@ module AdvancedBilling
       @charge_in_cents = charge_in_cents unless charge_in_cents == SKIP
       @payment_due_in_cents = payment_due_in_cents unless payment_due_in_cents == SKIP
       @credit_applied_in_cents = credit_applied_in_cents unless credit_applied_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.
@@ -80,11 +86,15 @@ module AdvancedBilling
       credit_applied_in_cents =
         hash.key?('credit_applied_in_cents') ? hash['credit_applied_in_cents'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionMigrationPreview.new(prorated_adjustment_in_cents,
                                        charge_in_cents,
                                        payment_due_in_cents,
-                                       credit_applied_in_cents)
+                                       credit_applied_in_cents,
+                                       hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_migration_preview_options.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # SubscriptionMigrationPreviewOptions Model.
   class SubscriptionMigrationPreviewOptions < BaseModel
@@ -62,7 +63,7 @@ module AdvancedBilling
     attr_accessor :proration
 
     # The date that the proration is calculated from for the preview
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :proration_date
 
     # A mapping from model property names to API property names.
@@ -111,7 +112,8 @@ module AdvancedBilling
                    product_handle = SKIP,
                    product_price_point_handle = SKIP,
                    proration = SKIP,
-                   proration_date = SKIP)
+                   proration_date = SKIP,
+                   additional_properties = {})
       @product_id = product_id unless product_id == SKIP
       @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
       @include_trial = include_trial unless include_trial == SKIP
@@ -125,6 +127,11 @@ module AdvancedBilling
       end
       @proration = proration unless proration == SKIP
       @proration_date = proration_date unless proration_date == 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.
@@ -144,8 +151,14 @@ module AdvancedBilling
       product_price_point_handle =
         hash.key?('product_price_point_handle') ? hash['product_price_point_handle'] : SKIP
       proration = Proration.from_hash(hash['proration']) if hash['proration']
-      proration_date =
-        hash.key?('proration_date') ? hash['proration_date'] : SKIP
+      proration_date = if hash.key?('proration_date')
+                         (DateTimeHelper.from_rfc3339(hash['proration_date']) if hash['proration_date'])
+                       else
+                         SKIP
+                       end
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       SubscriptionMigrationPreviewOptions.new(product_id,
@@ -157,7 +170,12 @@ module AdvancedBilling
                                               product_handle,
                                               product_price_point_handle,
                                               proration,
-                                              proration_date)
+                                              proration_date,
+                                              hash)
+    end
+
+    def to_custom_proration_date
+      DateTimeHelper.to_rfc3339(proration_date)
     end
   end
 end

data/lib/advanced_billing/models/subscription_migration_preview_request.rb

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

data/lib/advanced_billing/models/subscription_migration_preview_response.rb

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

data/lib/advanced_billing/models/subscription_mrr.rb

@@ -44,10 +44,16 @@ module AdvancedBilling
 
     def initialize(subscription_id = nil,
                    mrr_amount_in_cents = nil,
-                   breakouts = SKIP)
+                   breakouts = SKIP,
+                   additional_properties = {})
       @subscription_id = subscription_id
       @mrr_amount_in_cents = mrr_amount_in_cents
       @breakouts = breakouts unless breakouts == 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.
@@ -61,10 +67,14 @@ module AdvancedBilling
         hash.key?('mrr_amount_in_cents') ? hash['mrr_amount_in_cents'] : nil
       breakouts = SubscriptionMRRBreakout.from_hash(hash['breakouts']) if hash['breakouts']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionMRR.new(subscription_id,
                           mrr_amount_in_cents,
-                          breakouts)
+                          breakouts,
+                          hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_mrr_breakout.rb

@@ -36,9 +36,15 @@ module AdvancedBilling
     end
 
     def initialize(plan_amount_in_cents = nil,
-                   usage_amount_in_cents = nil)
+                   usage_amount_in_cents = nil,
+                   additional_properties = {})
       @plan_amount_in_cents = plan_amount_in_cents
       @usage_amount_in_cents = usage_amount_in_cents
+
+      # 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.
@@ -51,9 +57,13 @@ module AdvancedBilling
       usage_amount_in_cents =
         hash.key?('usage_amount_in_cents') ? hash['usage_amount_in_cents'] : nil
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionMRRBreakout.new(plan_amount_in_cents,
-                                  usage_amount_in_cents)
+                                  usage_amount_in_cents,
+                                  hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_mrr_response.rb

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