maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/segment_price.rb

@@ -83,7 +83,8 @@ module AdvancedBilling
                    unit_price = SKIP,
                    price_point_id = SKIP,
                    formatted_unit_price = SKIP,
-                   segment_id = SKIP)
+                   segment_id = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @component_id = component_id unless component_id == SKIP
       @starting_quantity = starting_quantity unless starting_quantity == SKIP
@@ -92,6 +93,11 @@ module AdvancedBilling
       @price_point_id = price_point_id unless price_point_id == SKIP
       @formatted_unit_price = formatted_unit_price unless formatted_unit_price == SKIP
       @segment_id = segment_id unless segment_id == 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.
@@ -112,6 +118,9 @@ module AdvancedBilling
         hash.key?('formatted_unit_price') ? hash['formatted_unit_price'] : SKIP
       segment_id = hash.key?('segment_id') ? hash['segment_id'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SegmentPrice.new(id,
                        component_id,
@@ -120,7 +129,8 @@ module AdvancedBilling
                        unit_price,
                        price_point_id,
                        formatted_unit_price,
-                       segment_id)
+                       segment_id,
+                       hash)
     end
   end
 end

data/lib/advanced_billing/models/segment_response.rb

@@ -32,8 +32,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(segment = SKIP)
+    def initialize(segment = SKIP,
+                   additional_properties = {})
       @segment = segment unless segment == 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.
@@ -43,8 +49,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       segment = Segment.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.
-      SegmentResponse.new(segment)
+      SegmentResponse.new(segment,
+                          hash)
     end
   end
 end

data/lib/advanced_billing/models/seller.rb

@@ -55,11 +55,17 @@ module AdvancedBilling
     def initialize(name = SKIP,
                    address = SKIP,
                    phone = SKIP,
-                   logo_url = SKIP)
+                   logo_url = SKIP,
+                   additional_properties = {})
       @name = name unless name == SKIP
       @address = address unless address == SKIP
       @phone = phone unless phone == SKIP
       @logo_url = logo_url unless logo_url == 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
       phone = hash.key?('phone') ? hash['phone'] : SKIP
       logo_url = hash.key?('logo_url') ? hash['logo_url'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       Seller.new(name,
                  address,
                  phone,
-                 logo_url)
+                 logo_url,
+                 hash)
     end
   end
 end

data/lib/advanced_billing/models/send_invoice_request.rb

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

data/lib/advanced_billing/models/service_credit.rb

@@ -60,12 +60,18 @@ module AdvancedBilling
                    amount_in_cents = SKIP,
                    ending_balance_in_cents = SKIP,
                    entry_type = SKIP,
-                   memo = SKIP)
+                   memo = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
       @ending_balance_in_cents = ending_balance_in_cents unless ending_balance_in_cents == SKIP
       @entry_type = entry_type unless entry_type == SKIP
       @memo = memo unless memo == 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.
@@ -81,12 +87,16 @@ module AdvancedBilling
       entry_type = hash.key?('entry_type') ? hash['entry_type'] : SKIP
       memo = hash.key?('memo') ? hash['memo'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ServiceCredit.new(id,
                         amount_in_cents,
                         ending_balance_in_cents,
                         entry_type,
-                        memo)
+                        memo,
+                        hash)
     end
   end
 end

data/lib/advanced_billing/models/service_credit_response.rb

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

data/lib/advanced_billing/models/shipping_address.rb

@@ -74,13 +74,19 @@ module AdvancedBilling
                    city = SKIP,
                    state = SKIP,
                    zip = SKIP,
-                   country = SKIP)
+                   country = SKIP,
+                   additional_properties = {})
       @street = street unless street == SKIP
       @line2 = line2 unless line2 == SKIP
       @city = city unless city == SKIP
       @state = state unless state == SKIP
       @zip = zip unless zip == SKIP
       @country = country unless country == 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.
@@ -95,13 +101,17 @@ module AdvancedBilling
       zip = hash.key?('zip') ? hash['zip'] : SKIP
       country = hash.key?('country') ? hash['country'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ShippingAddress.new(street,
                           line2,
                           city,
                           state,
                           zip,
-                          country)
+                          country,
+                          hash)
     end
   end
 end

data/lib/advanced_billing/models/signup_proforma_preview.rb

@@ -39,9 +39,15 @@ module AdvancedBilling
     end
 
     def initialize(current_proforma_invoice = SKIP,
-                   next_proforma_invoice = SKIP)
+                   next_proforma_invoice = SKIP,
+                   additional_properties = {})
       @current_proforma_invoice = current_proforma_invoice unless current_proforma_invoice == SKIP
       @next_proforma_invoice = next_proforma_invoice unless next_proforma_invoice == 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.
@@ -54,9 +60,13 @@ module AdvancedBilling
       next_proforma_invoice = ProformaInvoice.from_hash(hash['next_proforma_invoice']) if
         hash['next_proforma_invoice']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SignupProformaPreview.new(current_proforma_invoice,
-                                next_proforma_invoice)
+                                next_proforma_invoice,
+                                hash)
     end
   end
 end

data/lib/advanced_billing/models/signup_proforma_preview_response.rb

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

data/lib/advanced_billing/models/site.rb

@@ -139,7 +139,8 @@ module AdvancedBilling
                    organization_address = SKIP,
                    tax_configuration = SKIP,
                    net_terms = SKIP,
-                   test = SKIP)
+                   test = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @name = name unless name == SKIP
       @subdomain = subdomain unless subdomain == SKIP
@@ -165,6 +166,11 @@ module AdvancedBilling
       @tax_configuration = tax_configuration unless tax_configuration == SKIP
       @net_terms = net_terms unless net_terms == SKIP
       @test = test unless test == 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.
@@ -198,6 +204,9 @@ module AdvancedBilling
       net_terms = NetTerms.from_hash(hash['net_terms']) if hash['net_terms']
       test = hash.key?('test') ? hash['test'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       Site.new(id,
                name,
@@ -214,7 +223,8 @@ module AdvancedBilling
                organization_address,
                tax_configuration,
                net_terms,
-               test)
+               test,
+               hash)
     end
   end
 end

data/lib/advanced_billing/models/site_response.rb

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

data/lib/advanced_billing/models/site_statistics.rb

@@ -38,19 +38,19 @@ module AdvancedBilling
     attr_accessor :total_canceled_subscriptions
 
     # TODO: Write general description for this method
-    # @return [Float]
+    # @return [Integer]
     attr_accessor :total_active_subscriptions
 
     # TODO: Write general description for this method
-    # @return [Float]
+    # @return [Integer]
     attr_accessor :total_past_due_subscriptions
 
     # TODO: Write general description for this method
-    # @return [Float]
+    # @return [Integer]
     attr_accessor :total_unpaid_subscriptions
 
     # TODO: Write general description for this method
-    # @return [Float]
+    # @return [Integer]
     attr_accessor :total_dunning_subscriptions
 
     # A mapping from model property names to API property names.
@@ -102,7 +102,8 @@ module AdvancedBilling
                    total_active_subscriptions = SKIP,
                    total_past_due_subscriptions = SKIP,
                    total_unpaid_subscriptions = SKIP,
-                   total_dunning_subscriptions = SKIP)
+                   total_dunning_subscriptions = SKIP,
+                   additional_properties = {})
       @total_subscriptions = total_subscriptions unless total_subscriptions == SKIP
       @subscriptions_today = subscriptions_today unless subscriptions_today == SKIP
       @total_revenue = total_revenue unless total_revenue == SKIP
@@ -129,6 +130,11 @@ module AdvancedBilling
         @total_dunning_subscriptions =
           total_dunning_subscriptions
       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.
@@ -157,6 +163,9 @@ module AdvancedBilling
       total_dunning_subscriptions =
         hash.key?('total_dunning_subscriptions') ? hash['total_dunning_subscriptions'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SiteStatistics.new(total_subscriptions,
                          subscriptions_today,
@@ -168,7 +177,8 @@ module AdvancedBilling
                          total_active_subscriptions,
                          total_past_due_subscriptions,
                          total_unpaid_subscriptions,
-                         total_dunning_subscriptions)
+                         total_dunning_subscriptions,
+                         hash)
     end
   end
 end

data/lib/advanced_billing/models/site_summary.rb

@@ -60,12 +60,18 @@ module AdvancedBilling
                    site_name = SKIP,
                    site_id = SKIP,
                    site_currency = SKIP,
-                   stats = SKIP)
+                   stats = SKIP,
+                   additional_properties = {})
       @seller_name = seller_name unless seller_name == SKIP
       @site_name = site_name unless site_name == SKIP
       @site_id = site_id unless site_id == SKIP
       @site_currency = site_currency unless site_currency == SKIP
       @stats = stats unless stats == 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
       site_currency = hash.key?('site_currency') ? hash['site_currency'] : SKIP
       stats = SiteStatistics.from_hash(hash['stats']) if hash['stats']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SiteSummary.new(seller_name,
                       site_name,
                       site_id,
                       site_currency,
-                      stats)
+                      stats,
+                      hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription.rb

@@ -624,7 +624,8 @@ module AdvancedBilling
                    credit_balance_in_cents = SKIP,
                    prepayment_balance_in_cents = SKIP,
                    prepaid_configuration = SKIP,
-                   self_service_page_token = SKIP)
+                   self_service_page_token = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @state = state unless state == SKIP
       @balance_in_cents = balance_in_cents unless balance_in_cents == SKIP
@@ -714,6 +715,11 @@ module AdvancedBilling
       end
       @prepaid_configuration = prepaid_configuration unless prepaid_configuration == SKIP
       @self_service_page_token = self_service_page_token unless self_service_page_token == 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.
@@ -880,6 +886,9 @@ module AdvancedBilling
       self_service_page_token =
         hash.key?('self_service_page_token') ? hash['self_service_page_token'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       Subscription.new(id,
                        state,
@@ -942,7 +951,8 @@ module AdvancedBilling
                        credit_balance_in_cents,
                        prepayment_balance_in_cents,
                        prepaid_configuration,
-                       self_service_page_token)
+                       self_service_page_token,
+                       hash)
     end
 
     def to_custom_current_period_ends_at

data/lib/advanced_billing/models/subscription_component.rb

@@ -92,7 +92,7 @@ module AdvancedBilling
     # The type of credit to be created when upgrading/downgrading. Defaults to
     # the component and then site setting if one is not provided.
     # Available values: `full`, `prorated`, `none`.
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :archived_at
 
     # The type of credit to be created when upgrading/downgrading. Defaults to
@@ -304,7 +304,8 @@ module AdvancedBilling
                    subscription = SKIP,
                    display_on_hosted_page = SKIP,
                    interval = SKIP,
-                   interval_unit = SKIP)
+                   interval_unit = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @name = name unless name == SKIP
       @kind = kind unless kind == SKIP
@@ -339,6 +340,11 @@ module AdvancedBilling
       @display_on_hosted_page = display_on_hosted_page unless display_on_hosted_page == SKIP
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless interval_unit == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
     end
 
     # Creates an instance of the object from a hash.
@@ -369,7 +375,11 @@ module AdvancedBilling
         hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
       downgrade_credit =
         hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
-      archived_at = hash.key?('archived_at') ? hash['archived_at'] : SKIP
+      archived_at = if hash.key?('archived_at')
+                      (DateTimeHelper.from_rfc3339(hash['archived_at']) if hash['archived_at'])
+                    else
+                      SKIP
+                    end
       price_point_id =
         hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
       price_point_handle =
@@ -405,6 +415,9 @@ module AdvancedBilling
       interval = hash.key?('interval') ? hash['interval'] : SKIP
       interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       SubscriptionComponent.new(id,
                                 name,
@@ -436,7 +449,12 @@ module AdvancedBilling
                                 subscription,
                                 display_on_hosted_page,
                                 interval,
-                                interval_unit)
+                                interval_unit,
+                                hash)
+    end
+
+    def to_custom_archived_at
+      DateTimeHelper.to_rfc3339(archived_at)
     end
 
     def to_custom_created_at

data/lib/advanced_billing/models/subscription_component_allocation_error_item.rb

@@ -39,9 +39,15 @@ module AdvancedBilling
     end
 
     def initialize(kind = SKIP,
-                   message = SKIP)
+                   message = SKIP,
+                   additional_properties = {})
       @kind = kind unless kind == 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.
@@ -52,9 +58,13 @@ module AdvancedBilling
       kind = hash.key?('kind') ? hash['kind'] : 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.
       SubscriptionComponentAllocationErrorItem.new(kind,
-                                                   message)
+                                                   message,
+                                                   hash)
     end
   end
 end

data/lib/advanced_billing/models/subscription_component_response.rb

@@ -32,8 +32,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(component = SKIP)
+    def initialize(component = SKIP,
+                   additional_properties = {})
       @component = component unless component == 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.
@@ -43,8 +49,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       component = SubscriptionComponent.from_hash(hash['component']) if hash['component']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      SubscriptionComponentResponse.new(component)
+      SubscriptionComponentResponse.new(component,
+                                        hash)
     end
   end
 end