orb-billing 1.35.0 → 1.36.0

data/rbi/orb/models/customer_edited_webhook_event.rbi

@@ -0,0 +1,599 @@
+# typed: strong
+
+module Orb
+  module Models
+    class CustomerEditedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::CustomerEditedWebhookEvent, Orb::Internal::AnyHash)
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The time at which this event was created, to the second.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # A customer is a buyer of your products, and the other party to the billing
+      # relationship.
+      #
+      # In Orb, customers are assigned system generated identifiers automatically, but
+      # it's often desirable to have these match existing identifiers in your system. To
+      # avoid having to denormalize Orb ID information, you can pass in an
+      # `external_customer_id` with your own identifier. See
+      # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      # information about how these aliases work in Orb.
+      #
+      # In addition to having an identifier in your system, a customer may exist in a
+      # payment provider solution like Stripe. Use the `payment_provider_id` and the
+      # `payment_provider` enum field to express this mapping.
+      #
+      # A customer also has a timezone (from the standard
+      # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      # your account's timezone. See [Timezone localization](/essentials/timezones) for
+      # information on what this timezone parameter influences within Orb.
+      sig { returns(Orb::Customer) }
+      attr_reader :customer
+
+      sig { params(customer: Orb::Customer::OrHash).void }
+      attr_writer :customer
+
+      sig { returns(Orb::CustomerEditedWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(
+          properties: Orb::CustomerEditedWebhookEvent::Properties::OrHash
+        ).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::CustomerEditedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a customer is updated.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          customer: Orb::Customer::OrHash,
+          properties: Orb::CustomerEditedWebhookEvent::Properties::OrHash,
+          type: Orb::CustomerEditedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of this webhook event.
+        id:,
+        # The time at which this event was created, to the second.
+        created_at:,
+        # A customer is a buyer of your products, and the other party to the billing
+        # relationship.
+        #
+        # In Orb, customers are assigned system generated identifiers automatically, but
+        # it's often desirable to have these match existing identifiers in your system. To
+        # avoid having to denormalize Orb ID information, you can pass in an
+        # `external_customer_id` with your own identifier. See
+        # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+        # information about how these aliases work in Orb.
+        #
+        # In addition to having an identifier in your system, a customer may exist in a
+        # payment provider solution like Stripe. Use the `payment_provider_id` and the
+        # `payment_provider` enum field to express this mapping.
+        #
+        # A customer also has a timezone (from the standard
+        # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+        # your account's timezone. See [Timezone localization](/essentials/timezones) for
+        # information on what this timezone parameter influences within Orb.
+        customer:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            customer: Orb::Customer,
+            properties: Orb::CustomerEditedWebhookEvent::Properties,
+            type: Orb::CustomerEditedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::CustomerEditedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # metadata values are non-null on the wire (deleting a key removes it from
+        # storage); the Optional[str] values only exist on the new half of a metadata
+        # FieldChange.
+        sig do
+          returns(
+            Orb::CustomerEditedWebhookEvent::Properties::PreviousAttributes
+          )
+        end
+        attr_reader :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::CustomerEditedWebhookEvent::Properties::PreviousAttributes::OrHash
+          ).void
+        end
+        attr_writer :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::CustomerEditedWebhookEvent::Properties::PreviousAttributes::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # metadata values are non-null on the wire (deleting a key removes it from
+          # storage); the Optional[str] values only exist on the new half of a metadata
+          # FieldChange.
+          previous_attributes:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              previous_attributes:
+                Orb::CustomerEditedWebhookEvent::Properties::PreviousAttributes
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class PreviousAttributes < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::CustomerEditedWebhookEvent::Properties::PreviousAttributes,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :auto_collection
+
+          sig { returns(T.nilable(Orb::Address)) }
+          attr_reader :billing_address
+
+          sig { params(billing_address: T.nilable(Orb::Address::OrHash)).void }
+          attr_writer :billing_address
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :default_payment_method_id
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :email
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :email_delivery
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_customer_id
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_accessor :metadata
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :payment_provider
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :payment_provider_id
+
+          sig { returns(T.nilable(Orb::Address)) }
+          attr_reader :shipping_address
+
+          sig { params(shipping_address: T.nilable(Orb::Address::OrHash)).void }
+          attr_writer :shipping_address
+
+          # 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                                                                      |
+          sig { returns(T.nilable(Orb::CustomerTaxID)) }
+          attr_reader :tax_id
+
+          sig { params(tax_id: T.nilable(Orb::CustomerTaxID::OrHash)).void }
+          attr_writer :tax_id
+
+          # metadata values are non-null on the wire (deleting a key removes it from
+          # storage); the Optional[str] values only exist on the new half of a metadata
+          # FieldChange.
+          sig do
+            params(
+              auto_collection: T.nilable(T::Boolean),
+              billing_address: T.nilable(Orb::Address::OrHash),
+              default_payment_method_id: T.nilable(String),
+              email: T.nilable(String),
+              email_delivery: T.nilable(T::Boolean),
+              external_customer_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              name: T.nilable(String),
+              payment_provider: T.nilable(String),
+              payment_provider_id: T.nilable(String),
+              shipping_address: T.nilable(Orb::Address::OrHash),
+              tax_id: T.nilable(Orb::CustomerTaxID::OrHash)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            auto_collection: nil,
+            billing_address: nil,
+            default_payment_method_id: nil,
+            email: nil,
+            email_delivery: nil,
+            external_customer_id: nil,
+            metadata: nil,
+            name: nil,
+            payment_provider: nil,
+            payment_provider_id: nil,
+            shipping_address: nil,
+            # 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                                                                      |
+            tax_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                auto_collection: T.nilable(T::Boolean),
+                billing_address: T.nilable(Orb::Address),
+                default_payment_method_id: T.nilable(String),
+                email: T.nilable(String),
+                email_delivery: T.nilable(T::Boolean),
+                external_customer_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, String]),
+                name: T.nilable(String),
+                payment_provider: T.nilable(String),
+                payment_provider_id: T.nilable(String),
+                shipping_address: T.nilable(Orb::Address),
+                tax_id: T.nilable(Orb::CustomerTaxID)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::CustomerEditedWebhookEvent::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CUSTOMER_EDITED =
+          T.let(
+            :"customer.edited",
+            Orb::CustomerEditedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::CustomerEditedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end