orb-billing 1.35.0 → 1.37.0

data/lib/orb/models/invoice_issued_summary_webhook_event.rb

@@ -0,0 +1,841 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceIssuedSummaryWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute invoice
+      #   #InvoiceApiResourceWithoutLineItems
+      #
+      #   @return [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice]
+      required :invoice, -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Properties]
+      required :properties, -> { Orb::InvoiceIssuedSummaryWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceIssuedSummaryWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   A lightweight variant of invoice.issued for accounts configured to receive a
+      #   summarized invoice payload.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param invoice [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
+      #
+      #   @param properties [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent#invoice
+      class Invoice < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount_due
+        #   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]
+        required :amount_due, String
+
+        # @!attribute auto_collection
+        #
+        #   @return [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection]
+        required :auto_collection, -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection }
+
+        # @!attribute billing_address
+        #
+        #   @return [Orb::Models::Address, nil]
+        required :billing_address, -> { Orb::Address }, nil?: true
+
+        # @!attribute created_at
+        #   The creation time of the resource in Orb.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute credit_notes
+        #   A list of credit notes associated with the invoice
+        #
+        #   @return [Array<Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote>]
+        required :credit_notes,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote] }
+
+        # @!attribute currency
+        #   An ISO 4217 currency string or `credits`
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute customer
+        #
+        #   @return [Orb::Models::CustomerMinified]
+        required :customer, -> { Orb::CustomerMinified }
+
+        # @!attribute customer_balance_transactions
+        #
+        #   @return [Array<Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction>]
+        required :customer_balance_transactions,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction] }
+
+        # @!attribute customer_tax_id
+        #   Tax IDs are commonly required to be displayed on customer invoices, which are
+        #   added to the headers of invoices.
+        #
+        #   ### Supported Tax ID Countries and Types
+        #
+        #   | Country                | Type         | Description                                                                                             |
+        #   | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+        #   | Albania                | `al_tin`     | Albania Tax Identification Number                                                                       |
+        #   | Andorra                | `ad_nrt`     | Andorran NRT Number                                                                                     |
+        #   | Angola                 | `ao_tin`     | Angola Tax Identification Number                                                                        |
+        #   | Argentina              | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
+        #   | Armenia                | `am_tin`     | Armenia Tax Identification Number                                                                       |
+        #   | Aruba                  | `aw_tin`     | Aruba Tax Identification Number                                                                         |
+        #   | Australia              | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
+        #   | Australia              | `au_arn`     | Australian Taxation Office Reference Number                                                             |
+        #   | Austria                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Azerbaijan             | `az_tin`     | Azerbaijan Tax Identification Number                                                                    |
+        #   | Bahamas                | `bs_tin`     | Bahamas Tax Identification Number                                                                       |
+        #   | Bahrain                | `bh_vat`     | Bahraini VAT Number                                                                                     |
+        #   | Bangladesh             | `bd_bin`     | Bangladesh Business Identification Number                                                               |
+        #   | Barbados               | `bb_tin`     | Barbados Tax Identification Number                                                                      |
+        #   | Belarus                | `by_tin`     | Belarus TIN Number                                                                                      |
+        #   | Belgium                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Benin                  | `bj_ifu`     | Benin Tax Identification Number (Identifiant Fiscal Unique)                                             |
+        #   | Bolivia                | `bo_tin`     | Bolivian Tax ID                                                                                         |
+        #   | Bosnia and Herzegovina | `ba_tin`     | Bosnia and Herzegovina Tax Identification Number                                                        |
+        #   | Brazil                 | `br_cnpj`    | Brazilian CNPJ Number                                                                                   |
+        #   | Brazil                 | `br_cpf`     | Brazilian CPF Number                                                                                    |
+        #   | Bulgaria               | `bg_uic`     | Bulgaria Unified Identification Code                                                                    |
+        #   | Bulgaria               | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Burkina Faso           | `bf_ifu`     | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique)                             |
+        #   | Cambodia               | `kh_tin`     | Cambodia Tax Identification Number                                                                      |
+        #   | Cameroon               | `cm_niu`     | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique)                                 |
+        #   | Canada                 | `ca_bn`      | Canadian BN                                                                                             |
+        #   | Canada                 | `ca_gst_hst` | Canadian GST/HST Number                                                                                 |
+        #   | Canada                 | `ca_pst_bc`  | Canadian PST Number (British Columbia)                                                                  |
+        #   | Canada                 | `ca_pst_mb`  | Canadian PST Number (Manitoba)                                                                          |
+        #   | Canada                 | `ca_pst_sk`  | Canadian PST Number (Saskatchewan)                                                                      |
+        #   | Canada                 | `ca_qst`     | Canadian QST Number (Québec)                                                                            |
+        #   | Cape Verde             | `cv_nif`     | Cape Verde Tax Identification Number (Número de Identificação Fiscal)                                   |
+        #   | Chile                  | `cl_tin`     | Chilean TIN                                                                                             |
+        #   | China                  | `cn_tin`     | Chinese Tax ID                                                                                          |
+        #   | Colombia               | `co_nit`     | Colombian NIT Number                                                                                    |
+        #   | Congo-Kinshasa         | `cd_nif`     | Congo (DR) Tax Identification Number (Número de Identificação Fiscal)                                   |
+        #   | Costa Rica             | `cr_tin`     | Costa Rican Tax ID                                                                                      |
+        #   | Croatia                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Croatia                | `hr_oib`     | Croatian Personal Identification Number (OIB)                                                           |
+        #   | Cyprus                 | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Czech Republic         | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Denmark                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Dominican Republic     | `do_rcn`     | Dominican RCN Number                                                                                    |
+        #   | Ecuador                | `ec_ruc`     | Ecuadorian RUC Number                                                                                   |
+        #   | Egypt                  | `eg_tin`     | Egyptian Tax Identification Number                                                                      |
+        #   | El Salvador            | `sv_nit`     | El Salvadorian NIT Number                                                                               |
+        #   | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
+        #   | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+        #   | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
+        #   | Finland                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | France                 | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
+        #   | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
+        #   | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
+        #   | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
+        #   | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
+        #   | Hungary                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Hungary                | `hu_tin`     | Hungary Tax Number (adószám)                                                                            |
+        #   | Iceland                | `is_vat`     | Icelandic VAT                                                                                           |
+        #   | India                  | `in_gst`     | Indian GST Number                                                                                       |
+        #   | Indonesia              | `id_npwp`    | Indonesian NPWP Number                                                                                  |
+        #   | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Israel                 | `il_vat`     | Israel VAT                                                                                              |
+        #   | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
+        #   | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
+        #   | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
+        #   | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
+        #   | Kazakhstan             | `kz_bin`     | Kazakhstani Business Identification Number                                                              |
+        #   | Kenya                  | `ke_pin`     | Kenya Revenue Authority Personal Identification Number                                                  |
+        #   | Kyrgyzstan             | `kg_tin`     | Kyrgyzstan Tax Identification Number                                                                    |
+        #   | Laos                   | `la_tin`     | Laos Tax Identification Number                                                                          |
+        #   | Latvia                 | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Liechtenstein          | `li_uid`     | Liechtensteinian UID Number                                                                             |
+        #   | Liechtenstein          | `li_vat`     | Liechtenstein VAT Number                                                                                |
+        #   | Lithuania              | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Luxembourg             | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Malaysia               | `my_frp`     | Malaysian FRP Number                                                                                    |
+        #   | Malaysia               | `my_itn`     | Malaysian ITN                                                                                           |
+        #   | Malaysia               | `my_sst`     | Malaysian SST Number                                                                                    |
+        #   | Malta                  | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Mauritania             | `mr_nif`     | Mauritania Tax Identification Number (Número de Identificação Fiscal)                                   |
+        #   | Mexico                 | `mx_rfc`     | Mexican RFC Number                                                                                      |
+        #   | Moldova                | `md_vat`     | Moldova VAT Number                                                                                      |
+        #   | Montenegro             | `me_pib`     | Montenegro PIB Number                                                                                   |
+        #   | Morocco                | `ma_vat`     | Morocco VAT Number                                                                                      |
+        #   | Nepal                  | `np_pan`     | Nepal PAN Number                                                                                        |
+        #   | Netherlands            | `eu_vat`     | European VAT Number                                                                                     |
+        #   | New Zealand            | `nz_gst`     | New Zealand GST Number                                                                                  |
+        #   | Nigeria                | `ng_tin`     | Nigerian Tax Identification Number                                                                      |
+        #   | North Macedonia        | `mk_vat`     | North Macedonia VAT Number                                                                              |
+        #   | Northern Ireland       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
+        #   | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
+        #   | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
+        #   | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+        #   | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
+        #   | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
+        #   | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
+        #   | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Poland                 | `pl_nip`     | Polish Tax ID Number                                                                                    |
+        #   | Portugal               | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Romania                | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Romania                | `ro_tin`     | Romanian Tax ID Number                                                                                  |
+        #   | Russia                 | `ru_inn`     | Russian INN                                                                                             |
+        #   | Russia                 | `ru_kpp`     | Russian KPP                                                                                             |
+        #   | Saudi Arabia           | `sa_vat`     | Saudi Arabia VAT                                                                                        |
+        #   | Senegal                | `sn_ninea`   | Senegal NINEA Number                                                                                    |
+        #   | Serbia                 | `rs_pib`     | Serbian PIB Number                                                                                      |
+        #   | Singapore              | `sg_gst`     | Singaporean GST                                                                                         |
+        #   | Singapore              | `sg_uen`     | Singaporean UEN                                                                                         |
+        #   | Slovakia               | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Slovenia               | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Slovenia               | `si_tin`     | Slovenia Tax Number (davčna številka)                                                                   |
+        #   | South Africa           | `za_vat`     | South African VAT Number                                                                                |
+        #   | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
+        #   | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
+        #   | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
+        #   | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
+        #   | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
+        #   | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
+        #   | Switzerland            | `ch_vat`     | Switzerland VAT Number                                                                                  |
+        #   | Taiwan                 | `tw_vat`     | Taiwanese VAT                                                                                           |
+        #   | Tajikistan             | `tj_tin`     | Tajikistan Tax Identification Number                                                                    |
+        #   | Tanzania               | `tz_vat`     | Tanzania VAT Number                                                                                     |
+        #   | Thailand               | `th_vat`     | Thai VAT                                                                                                |
+        #   | Turkey                 | `tr_tin`     | Turkish Tax Identification Number                                                                       |
+        #   | Uganda                 | `ug_tin`     | Uganda Tax Identification Number                                                                        |
+        #   | Ukraine                | `ua_vat`     | Ukrainian VAT                                                                                           |
+        #   | United Arab Emirates   | `ae_trn`     | United Arab Emirates TRN                                                                                |
+        #   | United Kingdom         | `gb_vat`     | United Kingdom VAT Number                                                                               |
+        #   | United States          | `us_ein`     | United States EIN                                                                                       |
+        #   | Uruguay                | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
+        #   | Uzbekistan             | `uz_tin`     | Uzbekistan TIN Number                                                                                   |
+        #   | Uzbekistan             | `uz_vat`     | Uzbekistan VAT Number                                                                                   |
+        #   | Venezuela              | `ve_rif`     | Venezuelan RIF Number                                                                                   |
+        #   | Vietnam                | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
+        #   | Zambia                 | `zm_tin`     | Zambia Tax Identification Number                                                                        |
+        #   | Zimbabwe               | `zw_tin`     | Zimbabwe Tax Identification Number                                                                      |
+        #
+        #   @return [Orb::Models::CustomerTaxID, nil]
+        required :customer_tax_id, -> { Orb::CustomerTaxID }, nil?: true
+
+        # @!attribute due_date
+        #   When the invoice payment is due. The due date is null if the invoice is not yet
+        #   finalized.
+        #
+        #   @return [Time, nil]
+        required :due_date, Time, nil?: true
+
+        # @!attribute 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 [Time, nil]
+        required :eligible_to_issue_at, Time, nil?: true
+
+        # @!attribute hosted_invoice_url
+        #   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, nil]
+        required :hosted_invoice_url, String, nil?: true
+
+        # @!attribute invoice_date
+        #   The scheduled date of the invoice
+        #
+        #   @return [Time]
+        required :invoice_date, Time
+
+        # @!attribute 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 [String]
+        required :invoice_number, String
+
+        # @!attribute invoice_pdf
+        #   The link to download the PDF representation of the `Invoice`.
+        #
+        #   @return [String, nil]
+        required :invoice_pdf, String, nil?: true
+
+        # @!attribute invoice_source
+        #
+        #   @return [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::InvoiceSource]
+        required :invoice_source, enum: -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::InvoiceSource }
+
+        # @!attribute issue_failed_at
+        #   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 [Time, nil]
+        required :issue_failed_at, Time, nil?: true
+
+        # @!attribute issued_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 [Time, nil]
+        required :issued_at, Time, nil?: true
+
+        # @!attribute memo
+        #   Free-form text which is available on the invoice PDF and the Orb invoice portal.
+        #
+        #   @return [String, nil]
+        required :memo, String, nil?: true
+
+        # @!attribute metadata
+        #   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{Symbol=>String}]
+        required :metadata, Orb::Internal::Type::HashOf[String]
+
+        # @!attribute paid_at
+        #   If the invoice has a status of `paid`, this gives a timestamp when the invoice
+        #   was paid.
+        #
+        #   @return [Time, nil]
+        required :paid_at, Time, nil?: true
+
+        # @!attribute payment_attempts
+        #   A list of payment attempts associated with the invoice
+        #
+        #   @return [Array<Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt>]
+        required :payment_attempts,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt] }
+
+        # @!attribute payment_failed_at
+        #   If payment was attempted on this invoice but failed, this will be the time of
+        #   the most recent attempt.
+        #
+        #   @return [Time, nil]
+        required :payment_failed_at, Time, nil?: true
+
+        # @!attribute payment_started_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 [Time, nil]
+        required :payment_started_at, Time, nil?: true
+
+        # @!attribute scheduled_issue_at
+        #   If the invoice is in draft, this timestamp will reflect when the invoice is
+        #   scheduled to be issued.
+        #
+        #   @return [Time, nil]
+        required :scheduled_issue_at, Time, nil?: true
+
+        # @!attribute shipping_address
+        #
+        #   @return [Orb::Models::Address, nil]
+        required :shipping_address, -> { Orb::Address }, nil?: true
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::Status]
+        required :status, enum: -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::Status }
+
+        # @!attribute subscription
+        #
+        #   @return [Orb::Models::SubscriptionMinified, nil]
+        required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
+
+        # @!attribute sync_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 [Time, nil]
+        required :sync_failed_at, Time, nil?: true
+
+        # @!attribute total
+        #   The total after any minimums and discounts have been applied.
+        #
+        #   @return [String]
+        required :total, String
+
+        # @!attribute voided_at
+        #   If the invoice has a status of `void`, this gives a timestamp when the invoice
+        #   was voided.
+        #
+        #   @return [Time, nil]
+        required :voided_at, Time, nil?: true
+
+        # @!attribute will_auto_issue
+        #   This is true if the invoice will be automatically issued in the future, and
+        #   false otherwise.
+        #
+        #   @return [Boolean]
+        required :will_auto_issue, Orb::Internal::Type::Boolean
+
+        # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice} for more details.
+        #
+        #   #InvoiceApiResourceWithoutLineItems
+        #
+        #   @param id [String]
+        #
+        #   @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
+        #
+        #   @param auto_collection [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection]
+        #
+        #   @param billing_address [Orb::Models::Address, nil]
+        #
+        #   @param created_at [Time] The creation time of the resource in Orb.
+        #
+        #   @param credit_notes [Array<Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote>] A list of credit notes associated with the invoice
+        #
+        #   @param currency [String] An ISO 4217 currency string or `credits`
+        #
+        #   @param customer [Orb::Models::CustomerMinified]
+        #
+        #   @param customer_balance_transactions [Array<Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction>]
+        #
+        #   @param customer_tax_id [Orb::Models::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+        #
+        #   @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
+        #
+        #   @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
+        #
+        #   @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 60 days after the
+        #
+        #   @param invoice_date [Time] The scheduled date of the invoice
+        #
+        #   @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
+        #
+        #   @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
+        #
+        #   @param invoice_source [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::InvoiceSource]
+        #
+        #   @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
+        #
+        #   @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
+        #
+        #   @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
+        #
+        #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+        #
+        #   @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
+        #
+        #   @param payment_attempts [Array<Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
+        #
+        #   @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
+        #
+        #   @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
+        #
+        #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
+        #
+        #   @param shipping_address [Orb::Models::Address, nil]
+        #
+        #   @param status [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::Status]
+        #
+        #   @param subscription [Orb::Models::SubscriptionMinified, nil]
+        #
+        #   @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
+        #
+        #   @param total [String] The total after any minimums and discounts have been applied.
+        #
+        #   @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
+        #
+        #   @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
+
+        # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice#auto_collection
+        class AutoCollection < Orb::Internal::Type::BaseModel
+          # @!attribute enabled
+          #   True only if auto-collection is enabled for this invoice.
+          #
+          #   @return [Boolean, nil]
+          required :enabled, Orb::Internal::Type::Boolean, nil?: true
+
+          # @!attribute next_attempt_at
+          #   If the invoice is scheduled for auto-collection, this field will reflect when
+          #   the next attempt will occur. If dunning has been exhausted, or auto-collection
+          #   is not enabled for this invoice, this field will be `null`.
+          #
+          #   @return [Time, nil]
+          required :next_attempt_at, Time, nil?: true
+
+          # @!attribute num_attempts
+          #   Number of auto-collection payment attempts.
+          #
+          #   @return [Integer, nil]
+          required :num_attempts, Integer, nil?: true
+
+          # @!attribute previously_attempted_at
+          #   If Orb has ever attempted payment auto-collection for this invoice, this field
+          #   will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
+          #   this can be used to tell whether the invoice is currently in dunning (that is,
+          #   `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
+          #   dunning has been exhausted (`previously_attempted_at` is non-null, but
+          #   `next_attempt_at` is null).
+          #
+          #   @return [Time, nil]
+          required :previously_attempted_at, Time, nil?: true
+
+          # @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection} for
+          #   more details.
+          #
+          #   @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
+          #
+          #   @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
+          #
+          #   @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
+          #
+          #   @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
+        end
+
+        class CreditNote < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute credit_note_number
+          #
+          #   @return [String]
+          required :credit_note_number, String
+
+          # @!attribute memo
+          #   An optional memo supplied on the credit note.
+          #
+          #   @return [String, nil]
+          required :memo, String, nil?: true
+
+          # @!attribute reason
+          #
+          #   @return [String]
+          required :reason, String
+
+          # @!attribute total
+          #
+          #   @return [String]
+          required :total, String
+
+          # @!attribute type
+          #
+          #   @return [String]
+          required :type, String
+
+          # @!attribute voided_at
+          #   If the credit note has a status of `void`, this gives a timestamp when the
+          #   credit note was voided.
+          #
+          #   @return [Time, nil]
+          required :voided_at, Time, nil?: true
+
+          # @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote} for more
+          #   details.
+          #
+          #   @param id [String]
+          #
+          #   @param credit_note_number [String]
+          #
+          #   @param memo [String, nil] An optional memo supplied on the credit note.
+          #
+          #   @param reason [String]
+          #
+          #   @param total [String]
+          #
+          #   @param type [String]
+          #
+          #   @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
+        end
+
+        class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #   A unique id for this transaction.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute action
+          #
+          #   @return [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::Action]
+          required :action,
+                   enum: -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::Action }
+
+          # @!attribute amount
+          #   The value of the amount changed in the transaction.
+          #
+          #   @return [String]
+          required :amount, String
+
+          # @!attribute created_at
+          #   The creation time of this transaction.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute credit_note
+          #
+          #   @return [Orb::Models::CreditNoteTiny, nil]
+          required :credit_note, -> { Orb::CreditNoteTiny }, nil?: true
+
+          # @!attribute description
+          #   An optional description provided for manual customer balance adjustments.
+          #
+          #   @return [String, nil]
+          required :description, String, nil?: true
+
+          # @!attribute ending_balance
+          #   The new value of the customer's balance prior to the transaction, in the
+          #   customer's currency.
+          #
+          #   @return [String]
+          required :ending_balance, String
+
+          # @!attribute invoice
+          #
+          #   @return [Orb::Models::InvoiceTiny, nil]
+          required :invoice, -> { Orb::InvoiceTiny }, nil?: true
+
+          # @!attribute starting_balance
+          #   The original value of the customer's balance prior to the transaction, in the
+          #   customer's currency.
+          #
+          #   @return [String]
+          required :starting_balance, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::Type]
+          required :type,
+                   enum: -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::Type }
+
+          # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction}
+          #   for more details.
+          #
+          #   @param id [String] A unique id for this transaction.
+          #
+          #   @param action [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::Action]
+          #
+          #   @param amount [String] The value of the amount changed in the transaction.
+          #
+          #   @param created_at [Time] The creation time of this transaction.
+          #
+          #   @param credit_note [Orb::Models::CreditNoteTiny, nil]
+          #
+          #   @param description [String, nil] An optional description provided for manual customer balance adjustments.
+          #
+          #   @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
+          #
+          #   @param invoice [Orb::Models::InvoiceTiny, nil]
+          #
+          #   @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
+          #
+          #   @param type [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::Type]
+
+          # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction#action
+          module Action
+            extend Orb::Internal::Type::Enum
+
+            APPLIED_TO_INVOICE = :applied_to_invoice
+            MANUAL_ADJUSTMENT = :manual_adjustment
+            PRORATED_REFUND = :prorated_refund
+            REVERT_PRORATED_REFUND = :revert_prorated_refund
+            RETURN_FROM_VOIDING = :return_from_voiding
+            CREDIT_NOTE_APPLIED = :credit_note_applied
+            CREDIT_NOTE_VOIDED = :credit_note_voided
+            OVERPAYMENT_REFUND = :overpayment_refund
+            EXTERNAL_PAYMENT = :external_payment
+            SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
+            PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction#type
+          module Type
+            extend Orb::Internal::Type::Enum
+
+            INCREMENT = :increment
+            DECREMENT = :decrement
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice#invoice_source
+        module InvoiceSource
+          extend Orb::Internal::Type::Enum
+
+          SUBSCRIPTION = :subscription
+          PARTIAL = :partial
+          ONE_OFF = :one_off
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class PaymentAttempt < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the payment attempt.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute amount
+          #   The amount of the payment attempt.
+          #
+          #   @return [String]
+          required :amount, String
+
+          # @!attribute created_at
+          #   The time at which the payment attempt was created.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute payment_provider
+          #   The payment provider that attempted to collect the payment.
+          #
+          #   @return [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::PaymentProvider, nil]
+          required :payment_provider,
+                   enum: -> {
+                     Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::PaymentProvider
+                   },
+                   nil?: true
+
+          # @!attribute payment_provider_id
+          #   The ID of the payment attempt in the payment provider.
+          #
+          #   @return [String, nil]
+          required :payment_provider_id, String, nil?: true
+
+          # @!attribute receipt_pdf
+          #   URL to the downloadable PDF version of the receipt. This field will be `null`
+          #   for payment attempts that did not succeed.
+          #
+          #   @return [String, nil]
+          required :receipt_pdf, String, nil?: true
+
+          # @!attribute succeeded
+          #   Whether the payment attempt succeeded.
+          #
+          #   @return [Boolean]
+          required :succeeded, Orb::Internal::Type::Boolean
+
+          # @!method initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, receipt_pdf:, succeeded:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt} for
+          #   more details.
+          #
+          #   @param id [String] The ID of the payment attempt.
+          #
+          #   @param amount [String] The amount of the payment attempt.
+          #
+          #   @param created_at [Time] The time at which the payment attempt was created.
+          #
+          #   @param payment_provider [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
+          #
+          #   @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
+          #
+          #   @param receipt_pdf [String, nil] URL to the downloadable PDF version of the receipt. This field will be `null` fo
+          #
+          #   @param succeeded [Boolean] Whether the payment attempt succeeded.
+
+          # The payment provider that attempted to collect the payment.
+          #
+          # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt#payment_provider
+          module PaymentProvider
+            extend Orb::Internal::Type::Enum
+
+            STRIPE = :stripe
+            ADYEN = :adyen
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice#status
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          ISSUED = :issued
+          PAID = :paid
+          SYNCED = :synced
+          VOID = :void
+          DRAFT = :draft
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute automatically_marked_as_paid
+        #
+        #   @return [Boolean]
+        required :automatically_marked_as_paid, Orb::Internal::Type::Boolean
+
+        # @!method initialize(automatically_marked_as_paid:)
+        #   @param automatically_marked_as_paid [Boolean]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceIssuedSummaryWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_ISSUED_SUMMARY = :"invoice.issued_summary"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end