orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/invoice.rb

@@ -0,0 +1,843 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+  # representing the request for payment for a single subscription. This
+  # includes a set of line items, which correspond to prices in the
+  # subscription's plan and can represent fixed recurring fees or usage-based
+  # fees. They are generated at the end of a billing period, or as the result of
+  # an action, such as a cancellation.
+  class Invoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # If the invoice has a status of `void`, this gives a timestamp when the
+    # invoice was voided.
+    # @return [DateTime]
+    attr_accessor :voided_at
+
+    # If the invoice has a status of `paid`, this gives a timestamp when the
+    # invoice was paid.
+    # @return [DateTime]
+    attr_accessor :paid_at
+
+    # If the invoice has been issued, this will be the time it transitioned to
+    # `issued` (even if it is now in a different state.)
+    # @return [DateTime]
+    attr_accessor :issued_at
+
+    # If the invoice is in draft, this timestamp will reflect when the invoice
+    # is scheduled to be issued.
+    # @return [DateTime]
+    attr_accessor :scheduled_issue_at
+
+    # If the invoice is in draft, this timestamp will reflect when the invoice
+    # is scheduled to be issued.
+    # @return [AutoCollection]
+    attr_accessor :auto_collection
+
+    # If the invoice failed to issue, this will be the last time it failed to
+    # issue (even if it is now in a different state.)
+    # @return [DateTime]
+    attr_accessor :issue_failed_at
+
+    # If the invoice failed to sync, this will be the last time an external
+    # invoicing provider sync was attempted. This field will always be `null`
+    # for invoices using Orb Invoicing.
+    # @return [DateTime]
+    attr_accessor :sync_failed_at
+
+    # If payment was attempted on this invoice but failed, this will be the time
+    # of the most recent attempt.
+    # @return [DateTime]
+    attr_accessor :payment_failed_at
+
+    # If payment was attempted on this invoice, this will be the start time of
+    # the most recent attempt. This field is especially useful for
+    # delayed-notification payment mechanisms (like bank transfers), where
+    # payment can take 3 days or more.
+    # @return [DateTime]
+    attr_accessor :payment_started_at
+
+    # This is the final amount required to be charged to the customer and
+    # reflects the application of the customer balance to the `total` of the
+    # invoice.
+    # @return [String]
+    attr_accessor :amount_due
+
+    # The creation time of the resource in Orb.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # An ISO 4217 currency string or `credits`
+    # @return [String]
+    attr_accessor :currency
+
+    # An ISO 4217 currency string or `credits`
+    # @return [CustomerMinified]
+    attr_accessor :customer
+
+    # When the invoice payment is due. The due date is null if the invoice is
+    # not yet finalized.
+    # @return [DateTime]
+    attr_accessor :due_date
+
+    # When the invoice payment is due. The due date is null if the invoice is
+    # not yet finalized.
+    # @return [String]
+    attr_accessor :id
+
+    # The link to download the PDF representation of the `Invoice`.
+    # @return [String]
+    attr_accessor :invoice_pdf
+
+    # Automatically generated invoice number to help track and reconcile
+    # invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be
+    # sequential per account or customer.
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # Automatically generated invoice number to help track and reconcile
+    # invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be
+    # sequential per account or customer.
+    # @return [SubscriptionMinified]
+    attr_accessor :subscription
+
+    # The total after any minimums and discounts have been applied.
+    # @return [String]
+    attr_accessor :total
+
+    # The total after any minimums and discounts have been applied.
+    # @return [Array[CustomerBalanceTransaction]]
+    attr_accessor :customer_balance_transactions
+
+    # The total after any minimums and discounts have been applied.
+    # @return [Status1]
+    attr_accessor :status
+
+    # The total after any minimums and discounts have been applied.
+    # @return [InvoiceSource]
+    attr_accessor :invoice_source
+
+    # The total after any minimums and discounts have been applied.
+    # @return [Address]
+    attr_accessor :shipping_address
+
+    # The total after any minimums and discounts have been applied.
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # A URL for the customer-facing invoice portal. This URL expires 60 days
+    # after the link is generated, or 30 days after the invoice's due date —
+    # whichever is later.
+    # @return [String]
+    attr_accessor :hosted_invoice_url
+
+    # This is true if the invoice will be automatically issued in the future,
+    # and false otherwise.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :will_auto_issue
+
+    # If the invoice has a status of `draft`, this will be the time that the
+    # invoice will be eligible to be issued, otherwise it will be `null`. If
+    # `auto-issue` is true, the invoice will automatically begin issuing at this
+    # time.
+    # @return [DateTime]
+    attr_accessor :eligible_to_issue_at
+
+    # If the invoice has a status of `draft`, this will be the time that the
+    # invoice will be eligible to be issued, otherwise it will be `null`. If
+    # `auto-issue` is true, the invoice will automatically begin issuing at this
+    # time.
+    # @return [CustomerTaxId]
+    attr_accessor :customer_tax_id
+
+    # Free-form text which is available on the invoice PDF and the Orb invoice
+    # portal.
+    # @return [String]
+    attr_accessor :memo
+
+    # A list of credit notes associated with the invoice
+    # @return [Array[CreditNoteSummary]]
+    attr_accessor :credit_notes
+
+    # A list of payment attempts associated with the invoice
+    # @return [Array[PaymentAttempt]]
+    attr_accessor :payment_attempts
+
+    # This field is deprecated in favor of `discounts`. If a `discounts` list is
+    # provided, the first discount in the list will be returned. If the list is
+    # empty, `None` will be returned.
+    # @return [Object]
+    attr_accessor :discount
+
+    # This field is deprecated in favor of `discounts`. If a `discounts` list is
+    # provided, the first discount in the list will be returned. If the list is
+    # empty, `None` will be returned.
+    # @return [Array[Object]]
+    attr_accessor :discounts
+
+    # This field is deprecated in favor of `discounts`. If a `discounts` list is
+    # provided, the first discount in the list will be returned. If the list is
+    # empty, `None` will be returned.
+    # @return [Minimum]
+    attr_accessor :minimum
+
+    # This field is deprecated in favor of `discounts`. If a `discounts` list is
+    # provided, the first discount in the list will be returned. If the list is
+    # empty, `None` will be returned.
+    # @return [String]
+    attr_accessor :minimum_amount
+
+    # This field is deprecated in favor of `discounts`. If a `discounts` list is
+    # provided, the first discount in the list will be returned. If the list is
+    # empty, `None` will be returned.
+    # @return [Maximum]
+    attr_accessor :maximum
+
+    # This field is deprecated in favor of `discounts`. If a `discounts` list is
+    # provided, the first discount in the list will be returned. If the list is
+    # empty, `None` will be returned.
+    # @return [String]
+    attr_accessor :maximum_amount
+
+    # The breakdown of prices in this invoice.
+    # @return [Array[InvoiceLineItem]]
+    attr_accessor :line_items
+
+    # The total before any discounts and minimums are applied.
+    # @return [String]
+    attr_accessor :subtotal
+
+    # The scheduled date of the invoice
+    # @return [DateTime]
+    attr_accessor :invoice_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['voided_at'] = 'voided_at'
+      @_hash['paid_at'] = 'paid_at'
+      @_hash['issued_at'] = 'issued_at'
+      @_hash['scheduled_issue_at'] = 'scheduled_issue_at'
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['issue_failed_at'] = 'issue_failed_at'
+      @_hash['sync_failed_at'] = 'sync_failed_at'
+      @_hash['payment_failed_at'] = 'payment_failed_at'
+      @_hash['payment_started_at'] = 'payment_started_at'
+      @_hash['amount_due'] = 'amount_due'
+      @_hash['created_at'] = 'created_at'
+      @_hash['currency'] = 'currency'
+      @_hash['customer'] = 'customer'
+      @_hash['due_date'] = 'due_date'
+      @_hash['id'] = 'id'
+      @_hash['invoice_pdf'] = 'invoice_pdf'
+      @_hash['invoice_number'] = 'invoice_number'
+      @_hash['subscription'] = 'subscription'
+      @_hash['total'] = 'total'
+      @_hash['customer_balance_transactions'] =
+        'customer_balance_transactions'
+      @_hash['status'] = 'status'
+      @_hash['invoice_source'] = 'invoice_source'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['hosted_invoice_url'] = 'hosted_invoice_url'
+      @_hash['will_auto_issue'] = 'will_auto_issue'
+      @_hash['eligible_to_issue_at'] = 'eligible_to_issue_at'
+      @_hash['customer_tax_id'] = 'customer_tax_id'
+      @_hash['memo'] = 'memo'
+      @_hash['credit_notes'] = 'credit_notes'
+      @_hash['payment_attempts'] = 'payment_attempts'
+      @_hash['discount'] = 'discount'
+      @_hash['discounts'] = 'discounts'
+      @_hash['minimum'] = 'minimum'
+      @_hash['minimum_amount'] = 'minimum_amount'
+      @_hash['maximum'] = 'maximum'
+      @_hash['maximum_amount'] = 'maximum_amount'
+      @_hash['line_items'] = 'line_items'
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['invoice_date'] = 'invoice_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        voided_at
+        paid_at
+        issued_at
+        scheduled_issue_at
+        issue_failed_at
+        sync_failed_at
+        payment_failed_at
+        payment_started_at
+        due_date
+        invoice_pdf
+        subscription
+        shipping_address
+        billing_address
+        hosted_invoice_url
+        eligible_to_issue_at
+        customer_tax_id
+        memo
+        discount
+        minimum
+        minimum_amount
+        maximum
+        maximum_amount
+      ]
+    end
+
+    def initialize(metadata:, voided_at:, paid_at:, issued_at:,
+                   scheduled_issue_at:, auto_collection:, issue_failed_at:,
+                   sync_failed_at:, payment_failed_at:, payment_started_at:,
+                   amount_due:, created_at:, currency:, customer:, due_date:,
+                   id:, invoice_pdf:, invoice_number:, subscription:, total:,
+                   customer_balance_transactions:, status:, invoice_source:,
+                   shipping_address:, billing_address:, hosted_invoice_url:,
+                   will_auto_issue:, eligible_to_issue_at:, customer_tax_id:,
+                   memo:, credit_notes:, payment_attempts:, discount:,
+                   discounts:, minimum:, minimum_amount:, maximum:,
+                   maximum_amount:, line_items:, subtotal:, invoice_date:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @voided_at = voided_at
+      @paid_at = paid_at
+      @issued_at = issued_at
+      @scheduled_issue_at = scheduled_issue_at
+      @auto_collection = auto_collection
+      @issue_failed_at = issue_failed_at
+      @sync_failed_at = sync_failed_at
+      @payment_failed_at = payment_failed_at
+      @payment_started_at = payment_started_at
+      @amount_due = amount_due
+      @created_at = created_at
+      @currency = currency
+      @customer = customer
+      @due_date = due_date
+      @id = id
+      @invoice_pdf = invoice_pdf
+      @invoice_number = invoice_number
+      @subscription = subscription
+      @total = total
+      @customer_balance_transactions = customer_balance_transactions
+      @status = status
+      @invoice_source = invoice_source
+      @shipping_address = shipping_address
+      @billing_address = billing_address
+      @hosted_invoice_url = hosted_invoice_url
+      @will_auto_issue = will_auto_issue
+      @eligible_to_issue_at = eligible_to_issue_at
+      @customer_tax_id = customer_tax_id
+      @memo = memo
+      @credit_notes = credit_notes
+      @payment_attempts = payment_attempts
+      @discount = discount
+      @discounts = discounts
+      @minimum = minimum
+      @minimum_amount = minimum_amount
+      @maximum = maximum
+      @maximum_amount = maximum_amount
+      @line_items = line_items
+      @subtotal = subtotal
+      @invoice_date = invoice_date
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      voided_at = if hash.key?('voided_at')
+                    (DateTimeHelper.from_rfc3339(hash['voided_at']) if hash['voided_at'])
+                  end
+      paid_at = if hash.key?('paid_at')
+                  (DateTimeHelper.from_rfc3339(hash['paid_at']) if hash['paid_at'])
+                end
+      issued_at = if hash.key?('issued_at')
+                    (DateTimeHelper.from_rfc3339(hash['issued_at']) if hash['issued_at'])
+                  end
+      scheduled_issue_at = if hash.key?('scheduled_issue_at')
+                             (DateTimeHelper.from_rfc3339(hash['scheduled_issue_at']) if hash['scheduled_issue_at'])
+                           end
+      auto_collection = AutoCollection.from_hash(hash['auto_collection']) if
+        hash['auto_collection']
+      issue_failed_at = if hash.key?('issue_failed_at')
+                          (DateTimeHelper.from_rfc3339(hash['issue_failed_at']) if hash['issue_failed_at'])
+                        end
+      sync_failed_at = if hash.key?('sync_failed_at')
+                         (DateTimeHelper.from_rfc3339(hash['sync_failed_at']) if hash['sync_failed_at'])
+                       end
+      payment_failed_at = if hash.key?('payment_failed_at')
+                            (DateTimeHelper.from_rfc3339(hash['payment_failed_at']) if hash['payment_failed_at'])
+                          end
+      payment_started_at = if hash.key?('payment_started_at')
+                             (DateTimeHelper.from_rfc3339(hash['payment_started_at']) if hash['payment_started_at'])
+                           end
+      amount_due = hash.key?('amount_due') ? hash['amount_due'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      customer = CustomerMinified.from_hash(hash['customer']) if hash['customer']
+      due_date = if hash.key?('due_date')
+                   (DateTimeHelper.from_rfc3339(hash['due_date']) if hash['due_date'])
+                 end
+      id = hash.key?('id') ? hash['id'] : nil
+      invoice_pdf = hash.key?('invoice_pdf') ? hash['invoice_pdf'] : nil
+      invoice_number =
+        hash.key?('invoice_number') ? hash['invoice_number'] : nil
+      subscription = SubscriptionMinified.from_hash(hash['subscription']) if hash['subscription']
+      total = hash.key?('total') ? hash['total'] : nil
+      # Parameter is an array, so we need to iterate through it
+      customer_balance_transactions = nil
+      unless hash['customer_balance_transactions'].nil?
+        customer_balance_transactions = []
+        hash['customer_balance_transactions'].each do |structure|
+          customer_balance_transactions << (CustomerBalanceTransaction.from_hash(structure) if structure)
+        end
+      end
+
+      customer_balance_transactions = nil unless hash.key?('customer_balance_transactions')
+      status = hash.key?('status') ? hash['status'] : nil
+      invoice_source =
+        hash.key?('invoice_source') ? hash['invoice_source'] : nil
+      shipping_address = Address.from_hash(hash['shipping_address']) if hash['shipping_address']
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+      hosted_invoice_url =
+        hash.key?('hosted_invoice_url') ? hash['hosted_invoice_url'] : nil
+      will_auto_issue =
+        hash.key?('will_auto_issue') ? hash['will_auto_issue'] : nil
+      eligible_to_issue_at = if hash.key?('eligible_to_issue_at')
+                               (DateTimeHelper.from_rfc3339(hash['eligible_to_issue_at']) if hash['eligible_to_issue_at'])
+                             end
+      customer_tax_id = CustomerTaxId.from_hash(hash['customer_tax_id']) if
+        hash['customer_tax_id']
+      memo = hash.key?('memo') ? hash['memo'] : nil
+      # Parameter is an array, so we need to iterate through it
+      credit_notes = nil
+      unless hash['credit_notes'].nil?
+        credit_notes = []
+        hash['credit_notes'].each do |structure|
+          credit_notes << (CreditNoteSummary.from_hash(structure) if structure)
+        end
+      end
+
+      credit_notes = nil unless hash.key?('credit_notes')
+      # Parameter is an array, so we need to iterate through it
+      payment_attempts = nil
+      unless hash['payment_attempts'].nil?
+        payment_attempts = []
+        hash['payment_attempts'].each do |structure|
+          payment_attempts << (PaymentAttempt.from_hash(structure) if structure)
+        end
+      end
+
+      payment_attempts = nil unless hash.key?('payment_attempts')
+      discount = hash.key?('discount') ? hash['discount'] : nil
+      discounts = hash.key?('discounts') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InvoiceLevelDiscount), hash['discounts']
+      ) : nil
+      minimum = Minimum.from_hash(hash['minimum']) if hash['minimum']
+      minimum_amount =
+        hash.key?('minimum_amount') ? hash['minimum_amount'] : nil
+      maximum = Maximum.from_hash(hash['maximum']) if hash['maximum']
+      maximum_amount =
+        hash.key?('maximum_amount') ? hash['maximum_amount'] : nil
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (InvoiceLineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
+      invoice_date = if hash.key?('invoice_date')
+                       (DateTimeHelper.from_rfc3339(hash['invoice_date']) if hash['invoice_date'])
+                     end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Invoice.new(metadata: metadata,
+                  voided_at: voided_at,
+                  paid_at: paid_at,
+                  issued_at: issued_at,
+                  scheduled_issue_at: scheduled_issue_at,
+                  auto_collection: auto_collection,
+                  issue_failed_at: issue_failed_at,
+                  sync_failed_at: sync_failed_at,
+                  payment_failed_at: payment_failed_at,
+                  payment_started_at: payment_started_at,
+                  amount_due: amount_due,
+                  created_at: created_at,
+                  currency: currency,
+                  customer: customer,
+                  due_date: due_date,
+                  id: id,
+                  invoice_pdf: invoice_pdf,
+                  invoice_number: invoice_number,
+                  subscription: subscription,
+                  total: total,
+                  customer_balance_transactions: customer_balance_transactions,
+                  status: status,
+                  invoice_source: invoice_source,
+                  shipping_address: shipping_address,
+                  billing_address: billing_address,
+                  hosted_invoice_url: hosted_invoice_url,
+                  will_auto_issue: will_auto_issue,
+                  eligible_to_issue_at: eligible_to_issue_at,
+                  customer_tax_id: customer_tax_id,
+                  memo: memo,
+                  credit_notes: credit_notes,
+                  payment_attempts: payment_attempts,
+                  discount: discount,
+                  discounts: discounts,
+                  minimum: minimum,
+                  minimum_amount: minimum_amount,
+                  maximum: maximum,
+                  maximum_amount: maximum_amount,
+                  line_items: line_items,
+                  subtotal: subtotal,
+                  invoice_date: invoice_date,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_voided_at
+      DateTimeHelper.to_rfc3339(voided_at)
+    end
+
+    def to_custom_paid_at
+      DateTimeHelper.to_rfc3339(paid_at)
+    end
+
+    def to_custom_issued_at
+      DateTimeHelper.to_rfc3339(issued_at)
+    end
+
+    def to_custom_scheduled_issue_at
+      DateTimeHelper.to_rfc3339(scheduled_issue_at)
+    end
+
+    def to_custom_issue_failed_at
+      DateTimeHelper.to_rfc3339(issue_failed_at)
+    end
+
+    def to_custom_sync_failed_at
+      DateTimeHelper.to_rfc3339(sync_failed_at)
+    end
+
+    def to_custom_payment_failed_at
+      DateTimeHelper.to_rfc3339(payment_failed_at)
+    end
+
+    def to_custom_payment_started_at
+      DateTimeHelper.to_rfc3339(payment_started_at)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_due_date
+      DateTimeHelper.to_rfc3339(due_date)
+    end
+
+    def to_custom_eligible_to_issue_at
+      DateTimeHelper.to_rfc3339(eligible_to_issue_at)
+    end
+
+    def to_custom_invoice_date
+      DateTimeHelper.to_rfc3339(invoice_date)
+    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)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.metadata,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.voided_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.paid_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.issued_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.scheduled_issue_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.auto_collection,
+                                  ->(val) { AutoCollection.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.issue_failed_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.sync_failed_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.payment_failed_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.payment_started_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.amount_due,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { CustomerMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.due_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.invoice_pdf,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.invoice_number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.subscription,
+                                  ->(val) { SubscriptionMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.total,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.customer_balance_transactions,
+                                  ->(val) { CustomerBalanceTransaction.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { Status1.validate(val) }) and
+            APIHelper.valid_type?(value.invoice_source,
+                                  ->(val) { InvoiceSource.validate(val) }) and
+            APIHelper.valid_type?(value.shipping_address,
+                                  ->(val) { Address.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.billing_address,
+                                  ->(val) { Address.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.hosted_invoice_url,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.will_auto_issue,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.eligible_to_issue_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.customer_tax_id,
+                                  ->(val) { CustomerTaxId.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.credit_notes,
+                                  ->(val) { CreditNoteSummary.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.payment_attempts,
+                                  ->(val) { PaymentAttempt.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.discount,
+                                  ->(val) { val.instance_of? Object }) and
+            UnionTypeLookUp.get(:InvoiceLevelDiscount)
+                           .validate(value.discounts) and
+            APIHelper.valid_type?(value.minimum,
+                                  ->(val) { Minimum.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.minimum_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.maximum,
+                                  ->(val) { Maximum.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.maximum_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.line_items,
+                                  ->(val) { InvoiceLineItem.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.subtotal,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.invoice_date,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['metadata'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['voided_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['paid_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['issued_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['scheduled_issue_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['auto_collection'],
+                                ->(val) { AutoCollection.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['issue_failed_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['sync_failed_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['payment_failed_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['payment_started_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount_due'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { CustomerMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['due_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice_pdf'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice_number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['subscription'],
+                                ->(val) { SubscriptionMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['total'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['customer_balance_transactions'],
+                                ->(val) { CustomerBalanceTransaction.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { Status1.validate(val) }) and
+          APIHelper.valid_type?(value['invoice_source'],
+                                ->(val) { InvoiceSource.validate(val) }) and
+          APIHelper.valid_type?(value['shipping_address'],
+                                ->(val) { Address.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['billing_address'],
+                                ->(val) { Address.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['hosted_invoice_url'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['will_auto_issue'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['eligible_to_issue_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['customer_tax_id'],
+                                ->(val) { CustomerTaxId.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_notes'],
+                                ->(val) { CreditNoteSummary.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['payment_attempts'],
+                                ->(val) { PaymentAttempt.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['discount'],
+                                ->(val) { val.instance_of? Object }) and
+          UnionTypeLookUp.get(:InvoiceLevelDiscount)
+                         .validate(value['discounts']) and
+          APIHelper.valid_type?(value['minimum'],
+                                ->(val) { Minimum.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['minimum_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['maximum'],
+                                ->(val) { Maximum.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['maximum_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['line_items'],
+                                ->(val) { InvoiceLineItem.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['subtotal'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice_date'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, voided_at: #{@voided_at}, paid_at: #{@paid_at},"\
+      " issued_at: #{@issued_at}, scheduled_issue_at: #{@scheduled_issue_at}, auto_collection:"\
+      " #{@auto_collection}, issue_failed_at: #{@issue_failed_at}, sync_failed_at:"\
+      " #{@sync_failed_at}, payment_failed_at: #{@payment_failed_at}, payment_started_at:"\
+      " #{@payment_started_at}, amount_due: #{@amount_due}, created_at: #{@created_at}, currency:"\
+      " #{@currency}, customer: #{@customer}, due_date: #{@due_date}, id: #{@id}, invoice_pdf:"\
+      " #{@invoice_pdf}, invoice_number: #{@invoice_number}, subscription: #{@subscription},"\
+      " total: #{@total}, customer_balance_transactions: #{@customer_balance_transactions},"\
+      " status: #{@status}, invoice_source: #{@invoice_source}, shipping_address:"\
+      " #{@shipping_address}, billing_address: #{@billing_address}, hosted_invoice_url:"\
+      " #{@hosted_invoice_url}, will_auto_issue: #{@will_auto_issue}, eligible_to_issue_at:"\
+      " #{@eligible_to_issue_at}, customer_tax_id: #{@customer_tax_id}, memo: #{@memo},"\
+      " credit_notes: #{@credit_notes}, payment_attempts: #{@payment_attempts}, discount:"\
+      " #{@discount}, discounts: #{@discounts}, minimum: #{@minimum}, minimum_amount:"\
+      " #{@minimum_amount}, maximum: #{@maximum}, maximum_amount: #{@maximum_amount}, line_items:"\
+      " #{@line_items}, subtotal: #{@subtotal}, invoice_date: #{@invoice_date},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, voided_at: #{@voided_at.inspect}, paid_at:"\
+      " #{@paid_at.inspect}, issued_at: #{@issued_at.inspect}, scheduled_issue_at:"\
+      " #{@scheduled_issue_at.inspect}, auto_collection: #{@auto_collection.inspect},"\
+      " issue_failed_at: #{@issue_failed_at.inspect}, sync_failed_at: #{@sync_failed_at.inspect},"\
+      " payment_failed_at: #{@payment_failed_at.inspect}, payment_started_at:"\
+      " #{@payment_started_at.inspect}, amount_due: #{@amount_due.inspect}, created_at:"\
+      " #{@created_at.inspect}, currency: #{@currency.inspect}, customer: #{@customer.inspect},"\
+      " due_date: #{@due_date.inspect}, id: #{@id.inspect}, invoice_pdf: #{@invoice_pdf.inspect},"\
+      " invoice_number: #{@invoice_number.inspect}, subscription: #{@subscription.inspect}, total:"\
+      " #{@total.inspect}, customer_balance_transactions:"\
+      " #{@customer_balance_transactions.inspect}, status: #{@status.inspect}, invoice_source:"\
+      " #{@invoice_source.inspect}, shipping_address: #{@shipping_address.inspect},"\
+      " billing_address: #{@billing_address.inspect}, hosted_invoice_url:"\
+      " #{@hosted_invoice_url.inspect}, will_auto_issue: #{@will_auto_issue.inspect},"\
+      " eligible_to_issue_at: #{@eligible_to_issue_at.inspect}, customer_tax_id:"\
+      " #{@customer_tax_id.inspect}, memo: #{@memo.inspect}, credit_notes:"\
+      " #{@credit_notes.inspect}, payment_attempts: #{@payment_attempts.inspect}, discount:"\
+      " #{@discount.inspect}, discounts: #{@discounts.inspect}, minimum: #{@minimum.inspect},"\
+      " minimum_amount: #{@minimum_amount.inspect}, maximum: #{@maximum.inspect}, maximum_amount:"\
+      " #{@maximum_amount.inspect}, line_items: #{@line_items.inspect}, subtotal:"\
+      " #{@subtotal.inspect}, invoice_date: #{@invoice_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end