maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/invoice_issued.rb

@@ -227,7 +227,9 @@ module AdvancedBilling
             APIHelper.valid_type?(value.consolidation_level,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.line_items,
-                                  ->(val) { InvoiceLineItemEventData.validate(val) })
+                                  ->(val) { InvoiceLineItemEventData.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
         )
       end
 
@@ -263,7 +265,9 @@ module AdvancedBilling
           APIHelper.valid_type?(value['consolidation_level'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['line_items'],
-                                ->(val) { InvoiceLineItemEventData.validate(val) })
+                                ->(val) { InvoiceLineItemEventData.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/invoice_line_item.rb

@@ -302,9 +302,9 @@ module AdvancedBilling
       price_point_id =
         hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
       hide = hash.key?('hide') ? hash['hide'] : SKIP
-      component_cost_data = hash.key?('component_cost_data') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:InvoiceLineItemComponentCostData2), hash['component_cost_data']
-      ) : SKIP
+      if hash['component_cost_data']
+        component_cost_data = InvoiceLineItemComponentCostData.from_hash(hash['component_cost_data'])
+      end
       product_price_point_id =
         hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
       custom_item = hash.key?('custom_item') ? hash['custom_item'] : SKIP

data/lib/advanced_billing/models/invoice_line_item_event_data.rb

@@ -272,5 +272,15 @@ module AdvancedBilling
                                    custom_item,
                                    hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceLineItemEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_line_item_pricing_detail.rb

@@ -66,5 +66,15 @@ module AdvancedBilling
                                        amount,
                                        hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceLineItemPricingDetail | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_payer.rb

@@ -109,5 +109,15 @@ module AdvancedBilling
                        vat_number,
                        hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePayer | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_payment.rb

@@ -164,5 +164,15 @@ module AdvancedBilling
     def to_custom_transaction_time
       DateTimeHelper.to_rfc3339(transaction_time)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePayment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_payment_method.rb

@@ -130,5 +130,15 @@ module AdvancedBilling
                                masked_card_number,
                                hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePaymentMethod | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_pre_payment.rb

@@ -81,15 +81,5 @@ module AdvancedBilling
                             ending_balance_in_cents,
                             hash)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [InvoicePrePayment | Hash] The value against the validation is performed.
-    def self.validate(value)
-      return true if value.instance_of? self
-
-      return false unless value.instance_of? Hash
-
-      true
-    end
   end
 end

data/lib/advanced_billing/models/invoice_previous_balance.rb

@@ -84,5 +84,15 @@ module AdvancedBilling
     def to_custom_captured_at
       DateTimeHelper.to_rfc3339(captured_at)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePreviousBalance | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_refund.rb

@@ -134,5 +134,15 @@ module AdvancedBilling
                         gateway_handle,
                         hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceRefund | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_seller.rb

@@ -89,5 +89,15 @@ module AdvancedBilling
                         logo_url,
                         hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceSeller | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_status.rb

@@ -5,8 +5,8 @@
 
 module AdvancedBilling
   # The current status of the invoice. See [Invoice
-  # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#line-
-  # item-breakdowns) for more.
+  # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405078794253
+  # -Introduction-to-Invoices#invoice-statuses) for more.
   class InvoiceStatus
     INVOICE_STATUS = [
       # TODO: Write general description for DRAFT

data/lib/advanced_billing/models/invoice_tax.rb

@@ -178,5 +178,15 @@ module AdvancedBilling
                      tax_component_breakouts,
                      hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceTax | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_tax_breakout.rb

@@ -88,5 +88,15 @@ module AdvancedBilling
                              tax_exempt_amount,
                              hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceTaxBreakout | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/invoice_tax_component_breakout.rb

@@ -87,5 +87,15 @@ module AdvancedBilling
                                       subdivision_code,
                                       hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceTaxComponentBreakout | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/issue_invoice_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # IssueInvoiceEvent Model.
+  class IssueInvoiceEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # TODO: Write general description for this method
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # Example schema for an `issue_invoice` event
+    # @return [IssueInvoiceEventData]
+    attr_accessor :event_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   timestamp = nil,
+                   invoice = nil,
+                   event_type = InvoiceEventType::ISSUE_INVOICE,
+                   event_data = nil,
+                   additional_properties = {})
+      @id = id
+      @timestamp = timestamp
+      @invoice = invoice
+      @event_type = event_type
+      @event_data = event_data
+
+      # 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+      event_type = hash['event_type'] ||= InvoiceEventType::ISSUE_INVOICE
+      event_data = IssueInvoiceEventData.from_hash(hash['event_data']) if hash['event_data']
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      IssueInvoiceEvent.new(id,
+                            timestamp,
+                            invoice,
+                            event_type,
+                            event_data,
+                            hash)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IssueInvoiceEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { Invoice.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { InvoiceEventType.validate(val) }) and
+            APIHelper.valid_type?(value.event_data,
+                                  ->(val) { IssueInvoiceEventData.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { Invoice.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { InvoiceEventType.validate(val) }) and
+          APIHelper.valid_type?(value['event_data'],
+                                ->(val) { IssueInvoiceEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/issue_invoice_event_data.rb

@@ -24,15 +24,15 @@ module AdvancedBilling
     # @return [InvoiceConsolidationLevel]
     attr_accessor :consolidation_level
 
-    # The status of the invoice before event occurence. See [Invoice
-    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
-    # e-item-breakdowns) for more.
+    # The status of the invoice before event occurrence. See [Invoice
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statusess) for more.
     # @return [InvoiceStatus]
     attr_accessor :from_status
 
-    # The status of the invoice after event occurence. See [Invoice
-    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
-    # e-item-breakdowns) for more.
+    # The status of the invoice after event occurrence. See [Invoice
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statusess) for more.
     # @return [InvoiceStatus]
     attr_accessor :to_status
 

data/lib/advanced_billing/models/issue_service_credit.rb

@@ -27,7 +27,9 @@ module AdvancedBilling
 
     # An array for optional fields
     def self.optionals
-      []
+      %w[
+        memo
+      ]
     end
 
     # An array for nullable fields
@@ -36,10 +38,10 @@ module AdvancedBilling
     end
 
     def initialize(amount = nil,
-                   memo = nil,
+                   memo = SKIP,
                    additional_properties = {})
       @amount = amount
-      @memo = memo
+      @memo = memo unless memo == SKIP
 
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
@@ -55,7 +57,7 @@ module AdvancedBilling
       amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
         UnionTypeLookUp.get(:IssueServiceCreditAmount), hash['amount']
       ) : nil
-      memo = hash.key?('memo') ? hash['memo'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -70,22 +72,14 @@ module AdvancedBilling
     # @param [IssueServiceCredit | Hash] The value against the validation is performed.
     def self.validate(value)
       if value.instance_of? self
-        return (
-          UnionTypeLookUp.get(:IssueServiceCreditAmount)
-                         .validate(value.amount) and
-            APIHelper.valid_type?(value.memo,
-                                  ->(val) { val.instance_of? String })
-        )
+        return UnionTypeLookUp.get(:IssueServiceCreditAmount)
+                              .validate(value.amount)
       end
 
       return false unless value.instance_of? Hash
 
-      (
-        UnionTypeLookUp.get(:IssueServiceCreditAmount)
-                       .validate(value['amount']) and
-          APIHelper.valid_type?(value['memo'],
-                                ->(val) { val.instance_of? String })
-      )
+      UnionTypeLookUp.get(:IssueServiceCreditAmount)
+                     .validate(value['amount'])
     end
   end
 end

data/lib/advanced_billing/models/item_price_point_changed.rb

@@ -116,9 +116,11 @@ module AdvancedBilling
             APIHelper.valid_type?(value.item_name,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.previous_price_point,
-                                  ->(val) { ItemPricePointData.validate(val) }) and
+                                  ->(val) { ItemPricePointData.validate(val) },
+                                  is_model_hash: true) and
             APIHelper.valid_type?(value.current_price_point,
-                                  ->(val) { ItemPricePointData.validate(val) })
+                                  ->(val) { ItemPricePointData.validate(val) },
+                                  is_model_hash: true)
         )
       end
 
@@ -134,9 +136,11 @@ module AdvancedBilling
           APIHelper.valid_type?(value['item_name'],
                                 ->(val) { val.instance_of? String }) and
           APIHelper.valid_type?(value['previous_price_point'],
-                                ->(val) { ItemPricePointData.validate(val) }) and
+                                ->(val) { ItemPricePointData.validate(val) },
+                                is_model_hash: true) and
           APIHelper.valid_type?(value['current_price_point'],
-                                ->(val) { ItemPricePointData.validate(val) })
+                                ->(val) { ItemPricePointData.validate(val) },
+                                is_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/item_price_point_data.rb

@@ -76,5 +76,15 @@ module AdvancedBilling
                              name,
                              hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ItemPricePointData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/list_components_filter.rb

@@ -0,0 +1,74 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListComponentsFilter Model.
+  class ListComponentsFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allows fetching components with matching id based on provided value. Use
+    # in query `filter[ids]=1,2,3`.
+    # @return [Array[Integer]]
+    attr_accessor :ids
+
+    # Allows fetching components with matching use_site_exchange_rate based on
+    # provided value (refers to default price point). Use in query
+    # `filter[use_site_exchange_rate]=true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ids
+        use_site_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = SKIP,
+                   use_site_exchange_rate = SKIP,
+                   additional_properties = {})
+      @ids = ids unless ids == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+      use_site_exchange_rate =
+        hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      ListComponentsFilter.new(ids,
+                               use_site_exchange_rate,
+                               hash)
+    end
+  end
+end