maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/subscription_component_subscription.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # An optional object, will be returned if provided `include=subscription`
   # query param.
@@ -151,7 +152,7 @@ module AdvancedBilling
     # See [Subscription
     # States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773
     # ) for more info about subscription states and state transitions.
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :updated_at
 
     # A mapping from model property names to API property names.
@@ -176,9 +177,15 @@ module AdvancedBilling
     end
 
     def initialize(state = SKIP,
-                   updated_at = SKIP)
+                   updated_at = SKIP,
+                   additional_properties = {})
       @state = state unless state == SKIP
       @updated_at = updated_at unless updated_at == 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.
@@ -187,11 +194,23 @@ module AdvancedBilling
 
       # Extract variables from the hash.
       state = hash.key?('state') ? hash['state'] : SKIP
-      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       SubscriptionComponentSubscription.new(state,
-                                            updated_at)
+                                            updated_at,
+                                            hash)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
     end
   end
 end

data/lib/advanced_billing/models/subscription_custom_price.rb

@@ -114,7 +114,8 @@ module AdvancedBilling
                    initial_charge_after_trial = SKIP,
                    expiration_interval = SKIP,
                    expiration_interval_unit = SKIP,
-                   tax_included = SKIP)
+                   tax_included = SKIP,
+                   additional_properties = {})
       @name = name unless name == SKIP
       @handle = handle unless handle == SKIP
       @price_in_cents = price_in_cents
@@ -131,6 +132,11 @@ module AdvancedBilling
       @expiration_interval = expiration_interval unless expiration_interval == SKIP
       @expiration_interval_unit = expiration_interval_unit unless expiration_interval_unit == SKIP
       @tax_included = tax_included unless tax_included == 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.
@@ -167,6 +173,9 @@ module AdvancedBilling
         hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : SKIP
       tax_included = hash.key?('tax_included') ? hash['tax_included'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionCustomPrice.new(price_in_cents,
                                   interval,
@@ -180,7 +189,8 @@ module AdvancedBilling
                                   initial_charge_after_trial,
                                   expiration_interval,
                                   expiration_interval_unit,
-                                  tax_included)
+                                  tax_included,
+                                  hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/subscription_group.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # SubscriptionGroup Model.
   class SubscriptionGroup < BaseModel
@@ -17,16 +18,25 @@ module AdvancedBilling
     # @return [SubscriptionGroupPaymentProfile]
     attr_accessor :payment_profile
 
-    # TODO: Write general description for this method
-    # @return [String]
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [CollectionMethod]
     attr_accessor :payment_collection_method
 
-    # TODO: Write general description for this method
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
     # @return [Array[Integer]]
     attr_accessor :subscription_ids
 
-    # TODO: Write general description for this method
-    # @return [String]
+    # The type of payment collection to be used in the subscription. For legacy
+    # Statements Architecture valid options are - `invoice`, `automatic`. For
+    # current Relationship Invoicing Architecture valid options are -
+    # `remittance`, `automatic`, `prepaid`.
+    # @return [DateTime]
     attr_accessor :created_at
 
     # A mapping from model property names to API property names.
@@ -58,9 +68,10 @@ module AdvancedBilling
 
     def initialize(customer_id = SKIP,
                    payment_profile = SKIP,
-                   payment_collection_method = SKIP,
+                   payment_collection_method = CollectionMethod::AUTOMATIC,
                    subscription_ids = SKIP,
-                   created_at = SKIP)
+                   created_at = SKIP,
+                   additional_properties = {})
       @customer_id = customer_id unless customer_id == SKIP
       @payment_profile = payment_profile unless payment_profile == SKIP
       unless payment_collection_method == SKIP
@@ -69,6 +80,11 @@ module AdvancedBilling
       end
       @subscription_ids = subscription_ids unless subscription_ids == SKIP
       @created_at = created_at unless created_at == 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,17 +96,29 @@ module AdvancedBilling
       payment_profile = SubscriptionGroupPaymentProfile.from_hash(hash['payment_profile']) if
         hash['payment_profile']
       payment_collection_method =
-        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
+        hash['payment_collection_method'] ||= CollectionMethod::AUTOMATIC
       subscription_ids =
         hash.key?('subscription_ids') ? hash['subscription_ids'] : 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
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       SubscriptionGroup.new(customer_id,
                             payment_profile,
                             payment_collection_method,
                             subscription_ids,
-                            created_at)
+                            created_at,
+                            hash)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_balances.rb

@@ -53,11 +53,17 @@ module AdvancedBilling
     def initialize(prepayments = SKIP,
                    service_credits = SKIP,
                    open_invoices = SKIP,
-                   pending_discounts = SKIP)
+                   pending_discounts = SKIP,
+                   additional_properties = {})
       @prepayments = prepayments unless prepayments == SKIP
       @service_credits = service_credits unless service_credits == SKIP
       @open_invoices = open_invoices unless open_invoices == SKIP
       @pending_discounts = pending_discounts unless pending_discounts == 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.
@@ -72,11 +78,15 @@ module AdvancedBilling
       pending_discounts = AccountBalance.from_hash(hash['pending_discounts']) if
         hash['pending_discounts']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupBalances.new(prepayments,
                                     service_credits,
                                     open_invoices,
-                                    pending_discounts)
+                                    pending_discounts,
+                                    hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_bank_account.rb

@@ -144,7 +144,8 @@ module AdvancedBilling
                    billing_country = SKIP,
                    chargify_token = SKIP,
                    current_vault = SKIP,
-                   gateway_handle = SKIP)
+                   gateway_handle = SKIP,
+                   additional_properties = {})
       @bank_name = bank_name unless bank_name == SKIP
       @bank_account_number = bank_account_number unless bank_account_number == SKIP
       @bank_routing_number = bank_routing_number unless bank_routing_number == SKIP
@@ -161,6 +162,11 @@ module AdvancedBilling
       @chargify_token = chargify_token unless chargify_token == SKIP
       @current_vault = current_vault unless current_vault == SKIP
       @gateway_handle = gateway_handle unless gateway_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.
@@ -194,6 +200,9 @@ module AdvancedBilling
       gateway_handle =
         hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupBankAccount.new(bank_name,
                                        bank_account_number,
@@ -210,7 +219,8 @@ module AdvancedBilling
                                        billing_country,
                                        chargify_token,
                                        current_vault,
-                                       gateway_handle)
+                                       gateway_handle,
+                                       hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_component_custom_price.rb

@@ -53,10 +53,16 @@ module AdvancedBilling
 
     def initialize(pricing_scheme = SKIP,
                    prices = SKIP,
-                   overage_pricing = SKIP)
+                   overage_pricing = SKIP,
+                   additional_properties = {})
       @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
       @prices = prices unless prices == SKIP
       @overage_pricing = overage_pricing unless overage_pricing == 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.
@@ -87,10 +93,14 @@ module AdvancedBilling
 
       overage_pricing = SKIP unless hash.key?('overage_pricing')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupComponentCustomPrice.new(pricing_scheme,
                                                 prices,
-                                                overage_pricing)
+                                                overage_pricing,
+                                                hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_credit_card.rb

@@ -176,7 +176,8 @@ module AdvancedBilling
                    card_type = SKIP,
                    customer_vault_token = SKIP,
                    cvv = SKIP,
-                   payment_type = SKIP)
+                   payment_type = SKIP,
+                   additional_properties = {})
       @full_number = full_number unless full_number == SKIP
       @expiration_month = expiration_month unless expiration_month == SKIP
       @expiration_year = expiration_year unless expiration_year == SKIP
@@ -197,6 +198,11 @@ module AdvancedBilling
       @customer_vault_token = customer_vault_token unless customer_vault_token == SKIP
       @cvv = cvv unless cvv == SKIP
       @payment_type = payment_type unless payment_type == 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.
@@ -237,6 +243,9 @@ module AdvancedBilling
       cvv = hash.key?('cvv') ? hash['cvv'] : SKIP
       payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupCreditCard.new(full_number,
                                       expiration_month,
@@ -257,7 +266,8 @@ module AdvancedBilling
                                       card_type,
                                       customer_vault_token,
                                       cvv,
-                                      payment_type)
+                                      payment_type,
+                                      hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/subscription_group_customer.rb

@@ -60,12 +60,18 @@ module AdvancedBilling
                    last_name = SKIP,
                    organization = SKIP,
                    email = SKIP,
-                   reference = SKIP)
+                   reference = SKIP,
+                   additional_properties = {})
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
       @organization = organization unless organization == SKIP
       @email = email unless email == SKIP
       @reference = reference unless reference == 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.
@@ -79,12 +85,16 @@ module AdvancedBilling
       email = hash.key?('email') ? hash['email'] : SKIP
       reference = hash.key?('reference') ? hash['reference'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupCustomer.new(first_name,
                                     last_name,
                                     organization,
                                     email,
-                                    reference)
+                                    reference,
+                                    hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_include.rb

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

data/lib/advanced_billing/models/subscription_group_item.rb

@@ -99,7 +99,8 @@ module AdvancedBilling
                    currency = SKIP,
                    coupon_code = SKIP,
                    total_revenue_in_cents = SKIP,
-                   balance_in_cents = SKIP)
+                   balance_in_cents = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @reference = reference unless reference == SKIP
       @product_id = product_id unless product_id == SKIP
@@ -113,6 +114,11 @@ module AdvancedBilling
       @coupon_code = coupon_code unless coupon_code == SKIP
       @total_revenue_in_cents = total_revenue_in_cents unless total_revenue_in_cents == SKIP
       @balance_in_cents = balance_in_cents unless 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.
@@ -136,6 +142,9 @@ module AdvancedBilling
       balance_in_cents =
         hash.key?('balance_in_cents') ? hash['balance_in_cents'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupItem.new(id,
                                 reference,
@@ -146,7 +155,8 @@ module AdvancedBilling
                                 currency,
                                 coupon_code,
                                 total_revenue_in_cents,
-                                balance_in_cents)
+                                balance_in_cents,
+                                hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_member_error.rb

@@ -46,10 +46,16 @@ module AdvancedBilling
 
     def initialize(id = SKIP,
                    type = SKIP,
-                   message = SKIP)
+                   message = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @type = type unless type == SKIP
       @message = message unless message == 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
       type = hash.key?('type') ? hash['type'] : SKIP
       message = hash.key?('message') ? hash['message'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupMemberError.new(id,
                                        type,
-                                       message)
+                                       message,
+                                       hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_members_array_error.rb

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

data/lib/advanced_billing/models/subscription_group_payment_profile.rb

@@ -53,11 +53,17 @@ module AdvancedBilling
     def initialize(id = SKIP,
                    first_name = SKIP,
                    last_name = SKIP,
-                   masked_card_number = SKIP)
+                   masked_card_number = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
       @masked_card_number = masked_card_number unless masked_card_number == 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.
@@ -71,11 +77,15 @@ module AdvancedBilling
       masked_card_number =
         hash.key?('masked_card_number') ? hash['masked_card_number'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupPaymentProfile.new(id,
                                           first_name,
                                           last_name,
-                                          masked_card_number)
+                                          masked_card_number,
+                                          hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_prepayment.rb

@@ -48,11 +48,17 @@ module AdvancedBilling
     def initialize(amount = nil,
                    details = nil,
                    memo = nil,
-                   method = nil)
+                   method = nil,
+                   additional_properties = {})
       @amount = amount
       @details = details
       @memo = memo
       @method = method
+
+      # 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.
@@ -65,11 +71,15 @@ module AdvancedBilling
       memo = hash.key?('memo') ? hash['memo'] : nil
       method = hash.key?('method') ? hash['method'] : nil
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionGroupPrepayment.new(amount,
                                       details,
                                       memo,
-                                      method)
+                                      method,
+                                      hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_group_prepayment_request.rb

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