maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/product_family.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # ProductFamily Model.
   class ProductFamily < BaseModel
@@ -30,11 +31,11 @@ module AdvancedBilling
     attr_accessor :description
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :created_at
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :updated_at
 
     # A mapping from model property names to API property names.
@@ -77,7 +78,8 @@ module AdvancedBilling
                    accounting_code = SKIP,
                    description = SKIP,
                    created_at = SKIP,
-                   updated_at = SKIP)
+                   updated_at = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @name = name unless name == SKIP
       @handle = handle unless handle == SKIP
@@ -85,6 +87,11 @@ module AdvancedBilling
       @description = description unless description == SKIP
       @created_at = created_at unless created_at == 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.
@@ -98,8 +105,19 @@ module AdvancedBilling
       accounting_code =
         hash.key?('accounting_code') ? hash['accounting_code'] : SKIP
       description = hash.key?('description') ? hash['description'] : SKIP
-      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
-      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      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.
       ProductFamily.new(id,
@@ -108,7 +126,16 @@ module AdvancedBilling
                         accounting_code,
                         description,
                         created_at,
-                        updated_at)
+                        updated_at,
+                        hash)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
     end
   end
 end

data/lib/advanced_billing/models/product_family_response.rb

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

data/lib/advanced_billing/models/product_price_point.rb

@@ -41,9 +41,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
 
@@ -71,7 +71,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
 
@@ -212,7 +212,8 @@ module AdvancedBilling
                    type = SKIP,
                    tax_included = SKIP,
                    subscription_id = SKIP,
-                   currency_prices = SKIP)
+                   currency_prices = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @name = name unless name == SKIP
       @handle = handle unless handle == SKIP
@@ -240,6 +241,11 @@ module AdvancedBilling
       @tax_included = tax_included unless tax_included == SKIP
       @subscription_id = subscription_id unless subscription_id == SKIP
       @currency_prices = currency_prices unless currency_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.
@@ -304,6 +310,9 @@ module AdvancedBilling
 
       currency_prices = SKIP unless hash.key?('currency_prices')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ProductPricePoint.new(id,
                             name,
@@ -328,7 +337,8 @@ module AdvancedBilling
                             type,
                             tax_included,
                             subscription_id,
-                            currency_prices)
+                            currency_prices,
+                            hash)
     end
 
     def to_custom_archived_at

data/lib/advanced_billing/models/product_price_point_errors.rb

@@ -67,13 +67,19 @@ module AdvancedBilling
                    interval_unit = SKIP,
                    name = SKIP,
                    price = SKIP,
-                   price_in_cents = SKIP)
+                   price_in_cents = SKIP,
+                   additional_properties = {})
       @price_point = price_point unless price_point == SKIP
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless interval_unit == SKIP
       @name = name unless name == SKIP
       @price = price unless price == SKIP
       @price_in_cents = price_in_cents unless price_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.
@@ -89,13 +95,17 @@ module AdvancedBilling
       price_in_cents =
         hash.key?('price_in_cents') ? hash['price_in_cents'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ProductPricePointErrors.new(price_point,
                                   interval,
                                   interval_unit,
                                   name,
                                   price,
-                                  price_in_cents)
+                                  price_in_cents,
+                                  hash)
     end
   end
 end

data/lib/advanced_billing/models/product_price_point_response.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 = ProductPricePoint.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.
-      ProductPricePointResponse.new(price_point)
+      ProductPricePointResponse.new(price_point,
+                                    hash)
     end
   end
 end

data/lib/advanced_billing/models/product_response.rb

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

data/lib/advanced_billing/models/proforma_error.rb

@@ -33,8 +33,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(subscription = SKIP)
+    def initialize(subscription = SKIP,
+                   additional_properties = {})
       @subscription = subscription unless subscription == 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.
@@ -44,8 +50,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       subscription = BaseStringError.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.
-      ProformaError.new(subscription)
+      ProformaError.new(subscription,
+                        hash)
     end
   end
 end

data/lib/advanced_billing/models/proforma_invoice.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # ProformaInvoice Model.
   class ProformaInvoice < BaseModel
@@ -34,43 +35,86 @@ module AdvancedBilling
     attr_accessor :sequence_number
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :created_at
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [Date]
     attr_accessor :delivery_date
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [ProformaInvoiceStatus]
     attr_accessor :status
 
-    # 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 :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 [String]
     attr_accessor :payment_instructions
 
-    # 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 [String]
     attr_accessor :currency
 
-    # TODO: Write general description for this method
-    # @return [String]
+    # Consolidation level of the invoice, which is applicable to invoice
+    # consolidation.  It will hold one of the following values:
+    # * "none": A normal invoice with no consolidation.
+    # * "child": An invoice segment which has been combined into a consolidated
+    # invoice.
+    # * "parent": A consolidated invoice, whose contents are composed of invoice
+    # segments.
+    # "Parent" invoices do not have lines of their own, but they have subtotals
+    # and totals which aggregate the member invoice segments.
+    # See also the [invoice consolidation
+    # documentation](https://chargify.zendesk.com/hc/en-us/articles/440774639183
+    # 5).
+    # @return [InvoiceConsolidationLevel]
     attr_accessor :consolidation_level
 
-    # TODO: Write general description for this method
+    # Consolidation level of the invoice, which is applicable to invoice
+    # consolidation.  It will hold one of the following values:
+    # * "none": A normal invoice with no consolidation.
+    # * "child": An invoice segment which has been combined into a consolidated
+    # invoice.
+    # * "parent": A consolidated invoice, whose contents are composed of invoice
+    # segments.
+    # "Parent" invoices do not have lines of their own, but they have subtotals
+    # and totals which aggregate the member invoice segments.
+    # See also the [invoice consolidation
+    # documentation](https://chargify.zendesk.com/hc/en-us/articles/440774639183
+    # 5).
     # @return [String]
     attr_accessor :product_name
 
-    # TODO: Write general description for this method
+    # Consolidation level of the invoice, which is applicable to invoice
+    # consolidation.  It will hold one of the following values:
+    # * "none": A normal invoice with no consolidation.
+    # * "child": An invoice segment which has been combined into a consolidated
+    # invoice.
+    # * "parent": A consolidated invoice, whose contents are composed of invoice
+    # segments.
+    # "Parent" invoices do not have lines of their own, but they have subtotals
+    # and totals which aggregate the member invoice segments.
+    # See also the [invoice consolidation
+    # documentation](https://chargify.zendesk.com/hc/en-us/articles/440774639183
+    # 5).
     # @return [String]
     attr_accessor :product_family_name
 
-    # TODO: Write general description for this method
-    # @return [String]
+    # 'proforma' value is deprecated in favor of proforma_adhoc and
+    # proforma_automatic
+    # @return [ProformaInvoiceRole]
     attr_accessor :role
 
     # Information about the seller (merchant) listed on the masthead of the
@@ -259,7 +303,13 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        customer_id
+        subscription_id
+        number
+        sequence_number
+        public_url
+      ]
     end
 
     def initialize(uid = SKIP,
@@ -271,7 +321,7 @@ module AdvancedBilling
                    created_at = SKIP,
                    delivery_date = SKIP,
                    status = SKIP,
-                   collection_method = SKIP,
+                   collection_method = CollectionMethod::AUTOMATIC,
                    payment_instructions = SKIP,
                    currency = SKIP,
                    consolidation_level = SKIP,
@@ -297,7 +347,8 @@ module AdvancedBilling
                    credits = SKIP,
                    payments = SKIP,
                    custom_fields = SKIP,
-                   public_url = SKIP)
+                   public_url = SKIP,
+                   additional_properties = {})
       @uid = uid unless uid == SKIP
       @site_id = site_id unless site_id == SKIP
       @customer_id = customer_id unless customer_id == SKIP
@@ -334,6 +385,11 @@ module AdvancedBilling
       @payments = payments unless payments == SKIP
       @custom_fields = custom_fields unless custom_fields == SKIP
       @public_url = public_url unless public_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.
@@ -349,11 +405,15 @@ module AdvancedBilling
       number = hash.key?('number') ? hash['number'] : SKIP
       sequence_number =
         hash.key?('sequence_number') ? hash['sequence_number'] : 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
       delivery_date = hash.key?('delivery_date') ? hash['delivery_date'] : SKIP
       status = hash.key?('status') ? hash['status'] : SKIP
       collection_method =
-        hash.key?('collection_method') ? hash['collection_method'] : SKIP
+        hash['collection_method'] ||= CollectionMethod::AUTOMATIC
       payment_instructions =
         hash.key?('payment_instructions') ? hash['payment_instructions'] : SKIP
       currency = hash.key?('currency') ? hash['currency'] : SKIP
@@ -442,6 +502,9 @@ module AdvancedBilling
       custom_fields = SKIP unless hash.key?('custom_fields')
       public_url = hash.key?('public_url') ? hash['public_url'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ProformaInvoice.new(uid,
                           site_id,
@@ -478,7 +541,12 @@ module AdvancedBilling
                           credits,
                           payments,
                           custom_fields,
-                          public_url)
+                          public_url,
+                          hash)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
     end
   end
 end

data/lib/advanced_billing/models/proforma_invoice_credit.rb

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

data/lib/advanced_billing/models/proforma_invoice_discount.rb

@@ -9,16 +9,24 @@ module AdvancedBilling
     SKIP = Object.new
     private_constant :SKIP
 
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uid
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :title
 
     # TODO: Write general description for this method
     # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [ProformaInvoiceDiscountSourceType]
     attr_accessor :source_type
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [InvoiceDiscountType]
     attr_accessor :discount_type
 
     # TODO: Write general description for this method
@@ -30,13 +38,15 @@ module AdvancedBilling
     attr_accessor :discount_amount
 
     # TODO: Write general description for this method
-    # @return [Array[ProformaInvoiceDiscountBreakout]]
+    # @return [Array[InvoiceDiscountBreakout]]
     attr_accessor :line_item_breakouts
 
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
       @_hash['title'] = 'title'
+      @_hash['code'] = 'code'
       @_hash['source_type'] = 'source_type'
       @_hash['discount_type'] = 'discount_type'
       @_hash['eligible_amount'] = 'eligible_amount'
@@ -48,7 +58,9 @@ module AdvancedBilling
     # An array for optional fields
     def self.optionals
       %w[
+        uid
         title
+        code
         source_type
         discount_type
         eligible_amount
@@ -62,18 +74,28 @@ module AdvancedBilling
       []
     end
 
-    def initialize(title = SKIP,
+    def initialize(uid = SKIP,
+                   title = SKIP,
+                   code = SKIP,
                    source_type = SKIP,
                    discount_type = SKIP,
                    eligible_amount = SKIP,
                    discount_amount = SKIP,
-                   line_item_breakouts = SKIP)
+                   line_item_breakouts = SKIP,
+                   additional_properties = {})
+      @uid = uid unless uid == SKIP
       @title = title unless title == SKIP
+      @code = code unless code == SKIP
       @source_type = source_type unless source_type == SKIP
       @discount_type = discount_type unless discount_type == SKIP
       @eligible_amount = eligible_amount unless eligible_amount == SKIP
       @discount_amount = discount_amount unless discount_amount == SKIP
       @line_item_breakouts = line_item_breakouts unless line_item_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.
@@ -81,7 +103,9 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
       title = hash.key?('title') ? hash['title'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
       source_type = hash.key?('source_type') ? hash['source_type'] : SKIP
       discount_type = hash.key?('discount_type') ? hash['discount_type'] : SKIP
       eligible_amount =
@@ -93,19 +117,25 @@ module AdvancedBilling
       unless hash['line_item_breakouts'].nil?
         line_item_breakouts = []
         hash['line_item_breakouts'].each do |structure|
-          line_item_breakouts << (ProformaInvoiceDiscountBreakout.from_hash(structure) if structure)
+          line_item_breakouts << (InvoiceDiscountBreakout.from_hash(structure) if structure)
         end
       end
 
       line_item_breakouts = SKIP unless hash.key?('line_item_breakouts')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      ProformaInvoiceDiscount.new(title,
+      ProformaInvoiceDiscount.new(uid,
+                                  title,
+                                  code,
                                   source_type,
                                   discount_type,
                                   eligible_amount,
                                   discount_amount,
-                                  line_item_breakouts)
+                                  line_item_breakouts,
+                                  hash)
     end
   end
 end

data/lib/advanced_billing/models/proforma_invoice_discount_source_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Proforma Invoice Discount Source Type.
+  class ProformaInvoiceDiscountSourceType
+    PROFORMA_INVOICE_DISCOUNT_SOURCE_TYPE = [
+      # TODO: Write general description for COUPON
+      COUPON = 'Coupon'.freeze,
+
+      # TODO: Write general description for REFERRAL
+      REFERRAL = 'Referral'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROFORMA_INVOICE_DISCOUNT_SOURCE_TYPE.include?(value)
+    end
+  end
+end