maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/failed_payment_event.rb

@@ -0,0 +1,139 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # FailedPaymentEvent Model.
+  class FailedPaymentEvent < 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 `failed_payment` event
+    # @return [FailedPaymentEventData]
+    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::FAILED_PAYMENT,
+                   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::FAILED_PAYMENT
+      event_data = FailedPaymentEventData.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.
+      FailedPaymentEvent.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 [FailedPaymentEvent | 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) { FailedPaymentEventData.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) { FailedPaymentEventData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/failed_payment_event_data.rb

@@ -0,0 +1,132 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Example schema for an `failed_payment` event
+  class FailedPaymentEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary value of the payment, expressed in cents.
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # The monetary value of the payment, expressed in dollars.
+    # @return [Integer]
+    attr_accessor :applied_amount
+
+    # The memo passed when the payment was created.
+    # @return [String]
+    attr_accessor :memo
+
+    # The memo passed when the payment was created.
+    # @return [InvoicePaymentMethodType]
+    attr_accessor :payment_method
+
+    # The transaction ID of the failed payment.
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['memo'] = 'memo'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        memo
+      ]
+    end
+
+    def initialize(amount_in_cents = nil,
+                   applied_amount = nil,
+                   payment_method = nil,
+                   transaction_id = nil,
+                   memo = SKIP,
+                   additional_properties = {})
+      @amount_in_cents = amount_in_cents
+      @applied_amount = applied_amount
+      @memo = memo unless memo == SKIP
+      @payment_method = payment_method
+      @transaction_id = transaction_id
+
+      # 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.
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : nil
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : nil
+      payment_method =
+        hash.key?('payment_method') ? hash['payment_method'] : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : nil
+      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.
+      FailedPaymentEventData.new(amount_in_cents,
+                                 applied_amount,
+                                 payment_method,
+                                 transaction_id,
+                                 memo,
+                                 hash)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FailedPaymentEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount_in_cents,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.applied_amount,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.payment_method,
+                                  ->(val) { InvoicePaymentMethodType.validate(val) }) and
+            APIHelper.valid_type?(value.transaction_id,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount_in_cents'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['applied_amount'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['payment_method'],
+                                ->(val) { InvoicePaymentMethodType.validate(val) }) and
+          APIHelper.valid_type?(value['transaction_id'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/group_billing.rb

@@ -83,5 +83,15 @@ module AdvancedBilling
                        prorate,
                        hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [GroupBilling | 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/group_settings.rb

@@ -73,13 +73,15 @@ module AdvancedBilling
     def self.validate(value)
       if value.instance_of? self
         return APIHelper.valid_type?(value.target,
-                                     ->(val) { GroupTarget.validate(val) })
+                                     ->(val) { GroupTarget.validate(val) },
+                                     is_model_hash: true)
       end
 
       return false unless value.instance_of? Hash
 
       APIHelper.valid_type?(value['target'],
-                            ->(val) { GroupTarget.validate(val) })
+                            ->(val) { GroupTarget.validate(val) },
+                            is_model_hash: true)
     end
   end
 end

data/lib/advanced_billing/models/group_target.rb

@@ -68,5 +68,19 @@ module AdvancedBilling
                       id,
                       hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [GroupTarget | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { GroupTargetType.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { GroupTargetType.validate(val) })
+    end
   end
 end

data/lib/advanced_billing/models/historic_usage.rb

@@ -0,0 +1,109 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Optional for Event Based Components. If the `include=historic_usages` query
+  # param is provided, the last ten billing periods will be returned.
+  class HistoricUsage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total usage of a component for billing period
+    # @return [Float]
+    attr_accessor :total_usage_quantity
+
+    # Start date of billing period
+    # @return [DateTime]
+    attr_accessor :billing_period_starts_at
+
+    # End date of billing period
+    # @return [DateTime]
+    attr_accessor :billing_period_ends_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_usage_quantity'] = 'total_usage_quantity'
+      @_hash['billing_period_starts_at'] = 'billing_period_starts_at'
+      @_hash['billing_period_ends_at'] = 'billing_period_ends_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_usage_quantity
+        billing_period_starts_at
+        billing_period_ends_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_usage_quantity = SKIP,
+                   billing_period_starts_at = SKIP,
+                   billing_period_ends_at = SKIP,
+                   additional_properties = {})
+      @total_usage_quantity = total_usage_quantity unless total_usage_quantity == SKIP
+      @billing_period_starts_at = billing_period_starts_at unless billing_period_starts_at == SKIP
+      @billing_period_ends_at = billing_period_ends_at unless billing_period_ends_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.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_usage_quantity =
+        hash.key?('total_usage_quantity') ? hash['total_usage_quantity'] : SKIP
+      billing_period_starts_at = if hash.key?('billing_period_starts_at')
+                                   (DateTimeHelper.from_rfc3339(hash['billing_period_starts_at']) if hash['billing_period_starts_at'])
+                                 else
+                                   SKIP
+                                 end
+      billing_period_ends_at = if hash.key?('billing_period_ends_at')
+                                 (DateTimeHelper.from_rfc3339(hash['billing_period_ends_at']) if hash['billing_period_ends_at'])
+                               else
+                                 SKIP
+                               end
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
+      # Create object from extracted values.
+      HistoricUsage.new(total_usage_quantity,
+                        billing_period_starts_at,
+                        billing_period_ends_at,
+                        hash)
+    end
+
+    def to_custom_billing_period_starts_at
+      DateTimeHelper.to_rfc3339(billing_period_starts_at)
+    end
+
+    def to_custom_billing_period_ends_at
+      DateTimeHelper.to_rfc3339(billing_period_ends_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [HistoricUsage | 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/include_null_or_not_null.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Allows to filter by `not_null` or `null`.
+  class IncludeNullOrNotNull
+    INCLUDE_NULL_OR_NOT_NULL = [
+      # TODO: Write general description for NOT_NULL
+      NOT_NULL = 'not_null'.freeze,
+
+      # TODO: Write general description for NULL
+      NULL = 'null'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INCLUDE_NULL_OR_NOT_NULL.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice.rb

@@ -81,20 +81,20 @@ module AdvancedBilling
     attr_accessor :paid_date
 
     # The current status of the invoice. See [Invoice
-    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
-    # e-item-breakdowns) for more.
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statuses) for more.
     # @return [InvoiceStatus]
     attr_accessor :status
 
     # The current status of the invoice. See [Invoice
-    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
-    # e-item-breakdowns) for more.
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statuses) for more.
     # @return [InvoiceRole]
     attr_accessor :role
 
     # The current status of the invoice. See [Invoice
-    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
-    # e-item-breakdowns) for more.
+    # Statuses](https://maxio-chargify.zendesk.com/hc/en-us/articles/54050787942
+    # 53-Introduction-to-Invoices#invoice-statuses) for more.
     # @return [Integer]
     attr_accessor :parent_invoice_id
 
@@ -420,7 +420,7 @@ module AdvancedBilling
                    status = SKIP,
                    role = SKIP,
                    parent_invoice_id = SKIP,
-                   collection_method = CollectionMethod::AUTOMATIC,
+                   collection_method = SKIP,
                    payment_instructions = SKIP,
                    currency = SKIP,
                    consolidation_level = SKIP,
@@ -556,7 +556,7 @@ module AdvancedBilling
       parent_invoice_id =
         hash.key?('parent_invoice_id') ? hash['parent_invoice_id'] : SKIP
       collection_method =
-        hash['collection_method'] ||= CollectionMethod::AUTOMATIC
+        hash.key?('collection_method') ? hash['collection_method'] : SKIP
       payment_instructions =
         hash.key?('payment_instructions') ? hash['payment_instructions'] : SKIP
       currency = hash.key?('currency') ? hash['currency'] : SKIP
@@ -740,5 +740,15 @@ module AdvancedBilling
     def to_custom_updated_at
       DateTimeHelper.to_rfc3339(updated_at)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [Invoice | 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_address.rb

@@ -113,5 +113,15 @@ module AdvancedBilling
                          country,
                          hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceAddress | 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_balance_item.rb

@@ -77,5 +77,15 @@ module AdvancedBilling
                              outstanding_amount,
                              hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceBalanceItem | 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_credit.rb

@@ -129,5 +129,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 [InvoiceCredit | 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_custom_field.rb

@@ -96,5 +96,15 @@ module AdvancedBilling
                              metadatum_id,
                              hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceCustomField | 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_customer.rb

@@ -122,5 +122,15 @@ module AdvancedBilling
                           reference,
                           hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceCustomer | 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_discount.rb

@@ -180,5 +180,15 @@ module AdvancedBilling
                           line_item_breakouts,
                           hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceDiscount | 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_discount_breakout.rb

@@ -78,5 +78,15 @@ module AdvancedBilling
                                   discount_amount,
                                   hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceDiscountBreakout | 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_display_settings.rb

@@ -71,5 +71,15 @@ module AdvancedBilling
                                  include_discounts_on_lines,
                                  hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceDisplaySettings | 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_event_type.rb

@@ -22,6 +22,9 @@ module AdvancedBilling
       # TODO: Write general description for APPLY_DEBIT_NOTE
       APPLY_DEBIT_NOTE = 'apply_debit_note'.freeze,
 
+      # TODO: Write general description for CREATE_DEBIT_NOTE
+      CREATE_DEBIT_NOTE = 'create_debit_note'.freeze,
+
       # TODO: Write general description for REFUND_INVOICE
       REFUND_INVOICE = 'refund_invoice'.freeze,