orb-billing 0.1.3 → 0.3.0

data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi

@@ -282,21 +282,150 @@ module Orb
       end
       def self.new(
         accounting_sync_configuration: nil,
+        # Additional email addresses for this customer. If populated, these email
+        # addresses will be CC'd for customer communications.
         additional_emails: nil,
+        # Used to determine if invoices for this customer will automatically attempt to
+        # charge a saved payment method, if available. This parameter defaults to `True`
+        # when a payment provider is provided on customer creation.
         auto_collection: nil,
         billing_address: nil,
+        # An ISO 4217 currency string used for the customer's invoices and balance. If not
+        # set at creation time, will be set at subscription creation time.
         currency: nil,
+        # A valid customer email, to be used for invoicing and notifications.
         email: nil,
         email_delivery: nil,
+        # The external customer ID. This can only be set if empty and the customer has no
+        # past or current subscriptions.
         external_customer_id: nil,
+        # The hierarchical relationships for this customer.
         hierarchy: nil,
+        # User-specified key/value pairs for the resource. Individual keys can be removed
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
         metadata: nil,
+        # The full name of the customer
         name: nil,
+        # This is used for creating charges or invoices in an external system via Orb.
+        # When not in test mode:
+        #
+        # - the connection must first be configured in the Orb webapp.
+        # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
+        #   `bill.com`, `netsuite`), any product mappings must first be configured with
+        #   the Orb team.
         payment_provider: nil,
+        # The ID of this customer in an external payments solution, such as Stripe. This
+        # is used for creating charges or invoices in the external system via Orb.
         payment_provider_id: nil,
         reporting_configuration: nil,
         shipping_address: nil,
         tax_configuration: 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                                                                                             |
+        # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+        # | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
+        # | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
+        # | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
+        # | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
+        # | Austria              | `eu_vat`     | European VAT Number                                                                                     |
+        # | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
+        # | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
+        # | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
+        # | 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                                                                                     |
+        # | 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)                                                                            |
+        # | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
+        # | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
+        # | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
+        # | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
+        # | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
+        # | 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                                                                                     |
+        # | EU                   | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+        # | Finland              | `eu_vat`     | European VAT Number                                                                                     |
+        # | France               | `eu_vat`     | European VAT Number                                                                                     |
+        # | Georgia              | `ge_vat`     | Georgian VAT                                                                                            |
+        # | Germany              | `eu_vat`     | European VAT Number                                                                                     |
+        # | Greece               | `eu_vat`     | European VAT Number                                                                                     |
+        # | 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                                                                                     |
+        # | 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                                                  |
+        # | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
+        # | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
+        # | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
+        # | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
+        # | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
+        # | Nigeria              | `ng_tin`     | Nigerian Tax Identification Number                                                                      |
+        # | Norway               | `no_vat`     | Norwegian VAT Number                                                                                    |
+        # | Norway               | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
+        # | Oman                 | `om_vat`     | Omani VAT Number                                                                                        |
+        # | Peru                 | `pe_ruc`     | Peruvian RUC Number                                                                                     |
+        # | Philippines          | `ph_tin `    | Philippines Tax Identification Number                                                                   |
+        # | Poland               | `eu_vat`     | European VAT 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                                                                                        |
+        # | 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                                                                                     |
+        # | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
+        # | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
+        # | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
+        # | Thailand             | `th_vat`     | Thai VAT                                                                                                |
+        # | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
+        # | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
+        # | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
+        # | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
+        # | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
+        # | United States        | `us_ein`     | United States EIN                                                                                       |
+        # | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
+        # | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
+        # | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
         tax_id: nil,
         request_options: {}
       ); end
@@ -456,8 +585,14 @@ module Orb
           params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String))
             .returns(T.attached_class)
         end
-        def self.new(child_customer_ids: nil, parent_customer_id: nil); end
-
+        def self.new(
+          # A list of child customer IDs to add to the hierarchy. The desired child
+          # customers must not already be part of another hierarchy.
+          child_customer_ids: nil,
+          # The ID of the parent customer in the hierarchy. The desired parent customer must
+          # not be a child of another customer.
+          parent_customer_id: nil
+        ); end
         sig do
           override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)})
         end
@@ -476,8 +611,7 @@ module Orb
 
         TaggedSymbol =
           T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         QUICKBOOKS =
           T.let(:quickbooks, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol)
@@ -748,8 +882,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           AD = T.let(:AD, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol)
           AE = T.let(:AE, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol)
@@ -838,8 +971,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol)
           AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol)

data/rbi/lib/orb/models/customer_update_params.rbi

@@ -267,21 +267,150 @@ module Orb
       end
       def self.new(
         accounting_sync_configuration: nil,
+        # Additional email addresses for this customer. If populated, these email
+        # addresses will be CC'd for customer communications.
         additional_emails: nil,
+        # Used to determine if invoices for this customer will automatically attempt to
+        # charge a saved payment method, if available. This parameter defaults to `True`
+        # when a payment provider is provided on customer creation.
         auto_collection: nil,
         billing_address: nil,
+        # An ISO 4217 currency string used for the customer's invoices and balance. If not
+        # set at creation time, will be set at subscription creation time.
         currency: nil,
+        # A valid customer email, to be used for invoicing and notifications.
         email: nil,
         email_delivery: nil,
+        # The external customer ID. This can only be set if empty and the customer has no
+        # past or current subscriptions.
         external_customer_id: nil,
+        # The hierarchical relationships for this customer.
         hierarchy: nil,
+        # User-specified key/value pairs for the resource. Individual keys can be removed
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
         metadata: nil,
+        # The full name of the customer
         name: nil,
+        # This is used for creating charges or invoices in an external system via Orb.
+        # When not in test mode:
+        #
+        # - the connection must first be configured in the Orb webapp.
+        # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
+        #   `bill.com`, `netsuite`), any product mappings must first be configured with
+        #   the Orb team.
         payment_provider: nil,
+        # The ID of this customer in an external payments solution, such as Stripe. This
+        # is used for creating charges or invoices in the external system via Orb.
         payment_provider_id: nil,
         reporting_configuration: nil,
         shipping_address: nil,
         tax_configuration: 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                                                                                             |
+        # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+        # | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
+        # | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
+        # | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
+        # | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
+        # | Austria              | `eu_vat`     | European VAT Number                                                                                     |
+        # | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
+        # | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
+        # | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
+        # | 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                                                                                     |
+        # | 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)                                                                            |
+        # | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
+        # | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
+        # | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
+        # | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
+        # | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
+        # | 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                                                                                     |
+        # | EU                   | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+        # | Finland              | `eu_vat`     | European VAT Number                                                                                     |
+        # | France               | `eu_vat`     | European VAT Number                                                                                     |
+        # | Georgia              | `ge_vat`     | Georgian VAT                                                                                            |
+        # | Germany              | `eu_vat`     | European VAT Number                                                                                     |
+        # | Greece               | `eu_vat`     | European VAT Number                                                                                     |
+        # | 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                                                                                     |
+        # | 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                                                  |
+        # | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
+        # | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
+        # | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
+        # | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
+        # | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
+        # | Nigeria              | `ng_tin`     | Nigerian Tax Identification Number                                                                      |
+        # | Norway               | `no_vat`     | Norwegian VAT Number                                                                                    |
+        # | Norway               | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
+        # | Oman                 | `om_vat`     | Omani VAT Number                                                                                        |
+        # | Peru                 | `pe_ruc`     | Peruvian RUC Number                                                                                     |
+        # | Philippines          | `ph_tin `    | Philippines Tax Identification Number                                                                   |
+        # | Poland               | `eu_vat`     | European VAT 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                                                                                        |
+        # | 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                                                                                     |
+        # | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
+        # | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
+        # | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
+        # | Thailand             | `th_vat`     | Thai VAT                                                                                                |
+        # | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
+        # | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
+        # | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
+        # | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
+        # | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
+        # | United States        | `us_ein`     | United States EIN                                                                                       |
+        # | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
+        # | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
+        # | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
         tax_id: nil,
         request_options: {}
       ); end
@@ -437,8 +566,14 @@ module Orb
           params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String))
             .returns(T.attached_class)
         end
-        def self.new(child_customer_ids: nil, parent_customer_id: nil); end
-
+        def self.new(
+          # A list of child customer IDs to add to the hierarchy. The desired child
+          # customers must not already be part of another hierarchy.
+          child_customer_ids: nil,
+          # The ID of the parent customer in the hierarchy. The desired parent customer must
+          # not be a child of another customer.
+          parent_customer_id: nil
+        ); end
         sig do
           override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)})
         end
@@ -456,8 +591,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol)
         BILL_COM = T.let(:"bill.com", Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol)
@@ -723,8 +857,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           AD = T.let(:AD, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol)
           AE = T.let(:AE, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol)
@@ -813,8 +946,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol)
           AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol)

data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi

@@ -26,8 +26,13 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(amount:, type:, description: nil, request_options: {}); end
-
+        def self.new(
+          amount:,
+          type:,
+          # An optional description that can be specified around this entry.
+          description: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(
@@ -46,8 +51,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
           DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)

data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi

@@ -82,14 +82,22 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # A unique id for this transaction.
           id:,
           action:,
+          # The value of the amount changed in the transaction.
           amount:,
+          # The creation time of this transaction.
           created_at:,
           credit_note:,
+          # An optional description provided for manual customer balance adjustments.
           description:,
+          # The new value of the customer's balance prior to the transaction, in the
+          # customer's currency.
           ending_balance:,
           invoice:,
+          # The original value of the customer's balance prior to the transaction, in the
+          # customer's currency.
           starting_balance:,
           type:
         ); end
@@ -117,8 +125,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           APPLIED_TO_INVOICE =
             T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
@@ -158,8 +165,10 @@ module Orb
           attr_accessor :id
 
           sig { params(id: String).returns(T.attached_class) }
-          def self.new(id:); end
-
+          def self.new(
+            # The id of the Credit note
+            id:
+          ); end
           sig { override.returns({id: String}) }
           def to_hash; end
         end
@@ -170,8 +179,10 @@ module Orb
           attr_accessor :id
 
           sig { params(id: String).returns(T.attached_class) }
-          def self.new(id:); end
-
+          def self.new(
+            # The Invoice id
+            id:
+          ); end
           sig { override.returns({id: String}) }
           def to_hash; end
         end
@@ -181,8 +192,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           INCREMENT =
             T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol)

data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi

@@ -44,7 +44,10 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
           cursor: nil,
+          # The number of items to fetch. Defaults to 20.
           limit: nil,
           operation_time_gt: nil,
           operation_time_gte: nil,

data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi

@@ -78,14 +78,22 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # A unique id for this transaction.
           id:,
           action:,
+          # The value of the amount changed in the transaction.
           amount:,
+          # The creation time of this transaction.
           created_at:,
           credit_note:,
+          # An optional description provided for manual customer balance adjustments.
           description:,
+          # The new value of the customer's balance prior to the transaction, in the
+          # customer's currency.
           ending_balance:,
           invoice:,
+          # The original value of the customer's balance prior to the transaction, in the
+          # customer's currency.
           starting_balance:,
           type:
         ); end
@@ -113,8 +121,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           APPLIED_TO_INVOICE =
             T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
@@ -148,8 +155,10 @@ module Orb
           attr_accessor :id
 
           sig { params(id: String).returns(T.attached_class) }
-          def self.new(id:); end
-
+          def self.new(
+            # The id of the Credit note
+            id:
+          ); end
           sig { override.returns({id: String}) }
           def to_hash; end
         end
@@ -160,8 +169,10 @@ module Orb
           attr_accessor :id
 
           sig { params(id: String).returns(T.attached_class) }
-          def self.new(id:); end
-
+          def self.new(
+            # The Invoice id
+            id:
+          ); end
           sig { override.returns({id: String}) }
           def to_hash; end
         end
@@ -171,8 +182,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
           DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)

data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi

@@ -37,14 +37,19 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # The currency or custom pricing unit to use.
           currency: nil,
+          # Costs returned are exclusive of `timeframe_end`.
           timeframe_end: nil,
+          # Costs returned are inclusive of `timeframe_start`.
           timeframe_start: nil,
+          # Controls whether Orb returns cumulative costs since the start of the billing
+          # period, or incremental day-by-day costs. If your customer has minimums or
+          # discounts, it's strongly recommended that you use the default cumulative
+          # behavior.
           view_mode: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(
@@ -68,8 +73,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol)
           CUMULATIVE =