diff --git a/CODEGEN_VERSION b/CODEGEN_VERSION index ad201bda3..17557a68f 100644 --- a/CODEGEN_VERSION +++ b/CODEGEN_VERSION @@ -1 +1 @@ -9d04866843864b95eb2d5dbea5923816e446f09b \ No newline at end of file +e65e48569f6dfad2d5f1b58018017856520c3ae6 \ No newline at end of file diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 195c486d2..58dae7935 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v2164 \ No newline at end of file +v2186 \ No newline at end of file diff --git a/lib/stripe/api_version.rb b/lib/stripe/api_version.rb index c0beeb266..cf0805161 100644 --- a/lib/stripe/api_version.rb +++ b/lib/stripe/api_version.rb @@ -3,7 +3,7 @@ module Stripe module ApiVersion - CURRENT = "2026-01-28.clover" + CURRENT = "2026-02-25.clover" CURRENT_MAJOR = "clover" end end diff --git a/lib/stripe/object_types.rb b/lib/stripe/object_types.rb index 811340aca..beb7e756b 100644 --- a/lib/stripe/object_types.rb +++ b/lib/stripe/object_types.rb @@ -111,6 +111,9 @@ def self.object_names_to_classes Refund.object_name => Refund, Reporting::ReportRun.object_name => Reporting::ReportRun, Reporting::ReportType.object_name => Reporting::ReportType, + Reserve::Hold.object_name => Reserve::Hold, + Reserve::Plan.object_name => Reserve::Plan, + Reserve::Release.object_name => Reserve::Release, ReserveTransaction.object_name => ReserveTransaction, Reversal.object_name => Reversal, Review.object_name => Review, diff --git a/lib/stripe/params/billing/alert_create_params.rb b/lib/stripe/params/billing/alert_create_params.rb index 953174e65..fba95e024 100644 --- a/lib/stripe/params/billing/alert_create_params.rb +++ b/lib/stripe/params/billing/alert_create_params.rb @@ -18,7 +18,7 @@ def initialize(customer: nil, type: nil) end # The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time. attr_accessor :filters - # Defines at which value the alert will fire. + # Defines the threshold value that triggers the alert. attr_accessor :gte # The [Billing Meter](/api/billing/meter) ID whose usage is monitored. attr_accessor :meter diff --git a/lib/stripe/params/billing_portal/session_create_params.rb b/lib/stripe/params/billing_portal/session_create_params.rb index 5d435be58..c87863e32 100644 --- a/lib/stripe/params/billing_portal/session_create_params.rb +++ b/lib/stripe/params/billing_portal/session_create_params.rb @@ -142,7 +142,7 @@ def initialize( @type = type end end - # The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. + # The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. attr_accessor :configuration # The ID of an existing customer. attr_accessor :customer diff --git a/lib/stripe/params/checkout/session_create_params.rb b/lib/stripe/params/checkout/session_create_params.rb index a9258d46a..54e9a3468 100644 --- a/lib/stripe/params/checkout/session_create_params.rb +++ b/lib/stripe/params/checkout/session_create_params.rb @@ -164,7 +164,7 @@ def initialize(label: nil, value: nil) @value = value end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. attr_accessor :default_value # The options available for the customer to select. Up to 200 options allowed. attr_accessor :options @@ -188,7 +188,7 @@ def initialize(custom: nil, type: nil) end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_accessor :default_value # The maximum character length constraint for the customer's input. attr_accessor :maximum_length @@ -203,7 +203,7 @@ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil) end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_accessor :default_value # The maximum character length constraint for the customer's input. attr_accessor :maximum_length @@ -252,7 +252,7 @@ def initialize( class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -261,7 +261,7 @@ def initialize(message: nil) end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -270,7 +270,7 @@ def initialize(message: nil) end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -279,7 +279,7 @@ def initialize(message: nil) end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -1086,7 +1086,7 @@ def initialize(capture_method: nil, setup_future_usage: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) diff --git a/lib/stripe/params/credit_note_create_params.rb b/lib/stripe/params/credit_note_create_params.rb index b0762e6d6..2a90c5099 100644 --- a/lib/stripe/params/credit_note_create_params.rb +++ b/lib/stripe/params/credit_note_create_params.rb @@ -26,11 +26,11 @@ def initialize(amount: nil, tax_rate: nil, taxable_amount: nil) attr_accessor :invoice_line_item # The line item quantity to credit. attr_accessor :quantity - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :tax_amounts - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. attr_accessor :tax_rates - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :type # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. attr_accessor :unit_amount diff --git a/lib/stripe/params/credit_note_list_preview_line_items_params.rb b/lib/stripe/params/credit_note_list_preview_line_items_params.rb index 580930304..6d520c74b 100644 --- a/lib/stripe/params/credit_note_list_preview_line_items_params.rb +++ b/lib/stripe/params/credit_note_list_preview_line_items_params.rb @@ -26,11 +26,11 @@ def initialize(amount: nil, tax_rate: nil, taxable_amount: nil) attr_accessor :invoice_line_item # The line item quantity to credit. attr_accessor :quantity - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :tax_amounts - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. attr_accessor :tax_rates - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :type # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. attr_accessor :unit_amount diff --git a/lib/stripe/params/credit_note_preview_lines_list_params.rb b/lib/stripe/params/credit_note_preview_lines_list_params.rb index 89f21bd35..36aa605ab 100644 --- a/lib/stripe/params/credit_note_preview_lines_list_params.rb +++ b/lib/stripe/params/credit_note_preview_lines_list_params.rb @@ -26,11 +26,11 @@ def initialize(amount: nil, tax_rate: nil, taxable_amount: nil) attr_accessor :invoice_line_item # The line item quantity to credit. attr_accessor :quantity - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :tax_amounts - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. attr_accessor :tax_rates - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :type # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. attr_accessor :unit_amount diff --git a/lib/stripe/params/credit_note_preview_params.rb b/lib/stripe/params/credit_note_preview_params.rb index 3c3593e05..83b5e0c9b 100644 --- a/lib/stripe/params/credit_note_preview_params.rb +++ b/lib/stripe/params/credit_note_preview_params.rb @@ -26,11 +26,11 @@ def initialize(amount: nil, tax_rate: nil, taxable_amount: nil) attr_accessor :invoice_line_item # The line item quantity to credit. attr_accessor :quantity - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :tax_amounts - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. attr_accessor :tax_rates - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. attr_accessor :type # The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`. attr_accessor :unit_amount diff --git a/lib/stripe/params/customer_create_funding_instructions_params.rb b/lib/stripe/params/customer_create_funding_instructions_params.rb index 305a488fe..435b7bcdc 100644 --- a/lib/stripe/params/customer_create_funding_instructions_params.rb +++ b/lib/stripe/params/customer_create_funding_instructions_params.rb @@ -5,7 +5,7 @@ module Stripe class CustomerCreateFundingInstructionsParams < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) diff --git a/lib/stripe/params/customer_create_params.rb b/lib/stripe/params/customer_create_params.rb index f9037a6f8..dee21fb12 100644 --- a/lib/stripe/params/customer_create_params.rb +++ b/lib/stripe/params/customer_create_params.rb @@ -149,7 +149,7 @@ def initialize(ip_address: nil, validate_location: nil) end class TaxIdDatum < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` attr_accessor :type # Value of the tax ID. attr_accessor :value diff --git a/lib/stripe/params/customer_funding_instructions_create_params.rb b/lib/stripe/params/customer_funding_instructions_create_params.rb index 8f1c3b76f..ef62a1699 100644 --- a/lib/stripe/params/customer_funding_instructions_create_params.rb +++ b/lib/stripe/params/customer_funding_instructions_create_params.rb @@ -5,7 +5,7 @@ module Stripe class CustomerFundingInstructionsCreateParams < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) diff --git a/lib/stripe/params/customer_tax_id_create_params.rb b/lib/stripe/params/customer_tax_id_create_params.rb index e504fe685..d755140f9 100644 --- a/lib/stripe/params/customer_tax_id_create_params.rb +++ b/lib/stripe/params/customer_tax_id_create_params.rb @@ -5,7 +5,7 @@ module Stripe class CustomerTaxIdCreateParams < ::Stripe::RequestParams # Specifies which fields in the response should be expanded. attr_accessor :expand - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` attr_accessor :type # Value of the tax ID. attr_accessor :value diff --git a/lib/stripe/params/invoice_create_params.rb b/lib/stripe/params/invoice_create_params.rb index 774325ab7..c23ec7df7 100644 --- a/lib/stripe/params/invoice_create_params.rb +++ b/lib/stripe/params/invoice_create_params.rb @@ -152,7 +152,7 @@ def initialize(installments: nil, request_three_d_secure: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) diff --git a/lib/stripe/params/invoice_create_preview_params.rb b/lib/stripe/params/invoice_create_preview_params.rb index b9d348fb5..65936ff03 100644 --- a/lib/stripe/params/invoice_create_preview_params.rb +++ b/lib/stripe/params/invoice_create_preview_params.rb @@ -113,7 +113,7 @@ def initialize(ip_address: nil) end class TaxId < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` attr_accessor :type # Value of the tax ID. attr_accessor :value diff --git a/lib/stripe/params/invoice_update_params.rb b/lib/stripe/params/invoice_update_params.rb index 34da78e93..9373b8895 100644 --- a/lib/stripe/params/invoice_update_params.rb +++ b/lib/stripe/params/invoice_update_params.rb @@ -140,7 +140,7 @@ def initialize(installments: nil, request_three_d_secure: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) diff --git a/lib/stripe/params/payment_intent_capture_params.rb b/lib/stripe/params/payment_intent_capture_params.rb index c1ddf0462..ab12d328c 100644 --- a/lib/stripe/params/payment_intent_capture_params.rb +++ b/lib/stripe/params/payment_intent_capture_params.rb @@ -7,7 +7,7 @@ class AmountDetails < ::Stripe::RequestParams class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -16,7 +16,7 @@ def initialize(commodity_code: nil) end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -61,13 +61,13 @@ def initialize(category: nil, description: nil, sold_by: nil) @sold_by = sold_by end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. attr_accessor :card - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. attr_accessor :card_present - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. attr_accessor :klarna - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. attr_accessor :paypal def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil) @@ -98,7 +98,7 @@ def initialize(total_tax_amount: nil) attr_accessor :product_code # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. attr_accessor :product_name # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity @@ -163,7 +163,7 @@ def initialize(total_tax_amount: nil) # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. attr_accessor :enforce_arithmetic_validation # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. attr_accessor :line_items diff --git a/lib/stripe/params/payment_intent_confirm_params.rb b/lib/stripe/params/payment_intent_confirm_params.rb index c3933d100..3d9cc448a 100644 --- a/lib/stripe/params/payment_intent_confirm_params.rb +++ b/lib/stripe/params/payment_intent_confirm_params.rb @@ -7,7 +7,7 @@ class AmountDetails < ::Stripe::RequestParams class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -16,7 +16,7 @@ def initialize(commodity_code: nil) end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -61,13 +61,13 @@ def initialize(category: nil, description: nil, sold_by: nil) @sold_by = sold_by end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. attr_accessor :card - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. attr_accessor :card_present - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. attr_accessor :klarna - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. attr_accessor :paypal def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil) @@ -98,7 +98,7 @@ def initialize(total_tax_amount: nil) attr_accessor :product_code # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. attr_accessor :product_name # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity @@ -163,7 +163,7 @@ def initialize(total_tax_amount: nil) # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. attr_accessor :enforce_arithmetic_validation # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. attr_accessor :line_items @@ -1414,7 +1414,7 @@ def initialize(setup_future_usage: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) @@ -2257,6 +2257,8 @@ def initialize(requested: nil) attr_accessor :setup_future_usage # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. attr_accessor :target_date + # The purpose of the transaction. + attr_accessor :transaction_purpose # Bank account verification method. attr_accessor :verification_method # Preferred transaction settlement speed @@ -2268,6 +2270,7 @@ def initialize( networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ) @@ -2276,6 +2279,7 @@ def initialize( @networks = networks @setup_future_usage = setup_future_usage @target_date = target_date + @transaction_purpose = transaction_purpose @verification_method = verification_method @preferred_settlement_speed = preferred_settlement_speed end diff --git a/lib/stripe/params/payment_intent_create_params.rb b/lib/stripe/params/payment_intent_create_params.rb index 6b220aeee..305c14f01 100644 --- a/lib/stripe/params/payment_intent_create_params.rb +++ b/lib/stripe/params/payment_intent_create_params.rb @@ -7,7 +7,7 @@ class AmountDetails < ::Stripe::RequestParams class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -16,7 +16,7 @@ def initialize(commodity_code: nil) end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -61,13 +61,13 @@ def initialize(category: nil, description: nil, sold_by: nil) @sold_by = sold_by end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. attr_accessor :card - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. attr_accessor :card_present - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. attr_accessor :klarna - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. attr_accessor :paypal def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil) @@ -98,7 +98,7 @@ def initialize(total_tax_amount: nil) attr_accessor :product_code # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. attr_accessor :product_name # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity @@ -163,7 +163,7 @@ def initialize(total_tax_amount: nil) # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. attr_accessor :enforce_arithmetic_validation # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. attr_accessor :line_items @@ -1428,7 +1428,7 @@ def initialize(setup_future_usage: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) @@ -2271,6 +2271,8 @@ def initialize(requested: nil) attr_accessor :setup_future_usage # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. attr_accessor :target_date + # The purpose of the transaction. + attr_accessor :transaction_purpose # Bank account verification method. attr_accessor :verification_method # Preferred transaction settlement speed @@ -2282,6 +2284,7 @@ def initialize( networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ) @@ -2290,6 +2293,7 @@ def initialize( @networks = networks @setup_future_usage = setup_future_usage @target_date = target_date + @transaction_purpose = transaction_purpose @verification_method = verification_method @preferred_settlement_speed = preferred_settlement_speed end diff --git a/lib/stripe/params/payment_intent_increment_authorization_params.rb b/lib/stripe/params/payment_intent_increment_authorization_params.rb index 7bab523d8..5794757c0 100644 --- a/lib/stripe/params/payment_intent_increment_authorization_params.rb +++ b/lib/stripe/params/payment_intent_increment_authorization_params.rb @@ -7,7 +7,7 @@ class AmountDetails < ::Stripe::RequestParams class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -16,7 +16,7 @@ def initialize(commodity_code: nil) end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -61,13 +61,13 @@ def initialize(category: nil, description: nil, sold_by: nil) @sold_by = sold_by end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. attr_accessor :card - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. attr_accessor :card_present - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. attr_accessor :klarna - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. attr_accessor :paypal def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil) @@ -98,7 +98,7 @@ def initialize(total_tax_amount: nil) attr_accessor :product_code # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. attr_accessor :product_name # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity @@ -163,7 +163,7 @@ def initialize(total_tax_amount: nil) # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. attr_accessor :enforce_arithmetic_validation # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. attr_accessor :line_items diff --git a/lib/stripe/params/payment_intent_update_params.rb b/lib/stripe/params/payment_intent_update_params.rb index 5ec7730dc..94245db8c 100644 --- a/lib/stripe/params/payment_intent_update_params.rb +++ b/lib/stripe/params/payment_intent_update_params.rb @@ -7,7 +7,7 @@ class AmountDetails < ::Stripe::RequestParams class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -16,7 +16,7 @@ def initialize(commodity_code: nil) end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. attr_accessor :commodity_code def initialize(commodity_code: nil) @@ -61,13 +61,13 @@ def initialize(category: nil, description: nil, sold_by: nil) @sold_by = sold_by end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. attr_accessor :card - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. attr_accessor :card_present - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. attr_accessor :klarna - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. attr_accessor :paypal def initialize(card: nil, card_present: nil, klarna: nil, paypal: nil) @@ -98,7 +98,7 @@ def initialize(total_tax_amount: nil) attr_accessor :product_code # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. attr_accessor :product_name # The quantity of items. Required for L3 rates. An integer greater than 0. attr_accessor :quantity @@ -163,7 +163,7 @@ def initialize(total_tax_amount: nil) # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. attr_accessor :enforce_arithmetic_validation # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. attr_accessor :line_items @@ -1375,7 +1375,7 @@ def initialize(setup_future_usage: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) @@ -2218,6 +2218,8 @@ def initialize(requested: nil) attr_accessor :setup_future_usage # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. attr_accessor :target_date + # The purpose of the transaction. + attr_accessor :transaction_purpose # Bank account verification method. attr_accessor :verification_method # Preferred transaction settlement speed @@ -2229,6 +2231,7 @@ def initialize( networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ) @@ -2237,6 +2240,7 @@ def initialize( @networks = networks @setup_future_usage = setup_future_usage @target_date = target_date + @transaction_purpose = transaction_purpose @verification_method = verification_method @preferred_settlement_speed = preferred_settlement_speed end diff --git a/lib/stripe/params/payment_link_create_params.rb b/lib/stripe/params/payment_link_create_params.rb index e183829cf..3b9c81503 100644 --- a/lib/stripe/params/payment_link_create_params.rb +++ b/lib/stripe/params/payment_link_create_params.rb @@ -100,7 +100,7 @@ def initialize(label: nil, value: nil) @value = value end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. attr_accessor :default_value # The options available for the customer to select. Up to 200 options allowed. attr_accessor :options @@ -124,7 +124,7 @@ def initialize(custom: nil, type: nil) end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_accessor :default_value # The maximum character length constraint for the customer's input. attr_accessor :maximum_length @@ -139,7 +139,7 @@ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil) end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_accessor :default_value # The maximum character length constraint for the customer's input. attr_accessor :maximum_length @@ -188,7 +188,7 @@ def initialize( class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -197,7 +197,7 @@ def initialize(message: nil) end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -206,7 +206,7 @@ def initialize(message: nil) end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -215,7 +215,7 @@ def initialize(message: nil) end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) diff --git a/lib/stripe/params/payment_link_update_params.rb b/lib/stripe/params/payment_link_update_params.rb index dfbc54c5f..02cd0daa4 100644 --- a/lib/stripe/params/payment_link_update_params.rb +++ b/lib/stripe/params/payment_link_update_params.rb @@ -73,7 +73,7 @@ def initialize(label: nil, value: nil) @value = value end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. attr_accessor :default_value # The options available for the customer to select. Up to 200 options allowed. attr_accessor :options @@ -97,7 +97,7 @@ def initialize(custom: nil, type: nil) end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_accessor :default_value # The maximum character length constraint for the customer's input. attr_accessor :maximum_length @@ -112,7 +112,7 @@ def initialize(default_value: nil, maximum_length: nil, minimum_length: nil) end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_accessor :default_value # The maximum character length constraint for the customer's input. attr_accessor :maximum_length @@ -161,7 +161,7 @@ def initialize( class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -170,7 +170,7 @@ def initialize(message: nil) end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -179,7 +179,7 @@ def initialize(message: nil) end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -188,7 +188,7 @@ def initialize(message: nil) end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_accessor :message def initialize(message: nil) @@ -362,6 +362,35 @@ def initialize(business: nil, individual: nil) end end + class OptionalItem < ::Stripe::RequestParams + class AdjustableQuantity < ::Stripe::RequestParams + # Set to true if the quantity can be adjusted to any non-negative integer. + attr_accessor :enabled + # The maximum quantity of this item the customer can purchase. By default this value is 99. + attr_accessor :maximum + # The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0. + attr_accessor :minimum + + def initialize(enabled: nil, maximum: nil, minimum: nil) + @enabled = enabled + @maximum = maximum + @minimum = minimum + end + end + # When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order. + attr_accessor :adjustable_quantity + # The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. + attr_accessor :price + # The initial quantity of the line item created when a customer chooses to add this optional item to their order. + attr_accessor :quantity + + def initialize(adjustable_quantity: nil, price: nil, quantity: nil) + @adjustable_quantity = adjustable_quantity + @price = price + @quantity = quantity + end + end + class PaymentIntentData < ::Stripe::RequestParams # An arbitrary string attached to the object. Often useful for displaying to users. attr_accessor :description @@ -525,6 +554,10 @@ def initialize(enabled: nil, required: nil) attr_accessor :metadata # Controls settings applied for collecting the customer's name. attr_accessor :name_collection + # A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). + # There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. + # There is a maximum of 20 combined line items and optional items. + attr_accessor :optional_items # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. attr_accessor :payment_intent_data # Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. @@ -565,6 +598,7 @@ def initialize( line_items: nil, metadata: nil, name_collection: nil, + optional_items: nil, payment_intent_data: nil, payment_method_collection: nil, payment_method_types: nil, @@ -589,6 +623,7 @@ def initialize( @line_items = line_items @metadata = metadata @name_collection = name_collection + @optional_items = optional_items @payment_intent_data = payment_intent_data @payment_method_collection = payment_method_collection @payment_method_types = payment_method_types diff --git a/lib/stripe/params/payment_record_report_payment_attempt_canceled_params.rb b/lib/stripe/params/payment_record_report_payment_attempt_canceled_params.rb index 902007748..ddea845e7 100644 --- a/lib/stripe/params/payment_record_report_payment_attempt_canceled_params.rb +++ b/lib/stripe/params/payment_record_report_payment_attempt_canceled_params.rb @@ -7,7 +7,7 @@ class PaymentRecordReportPaymentAttemptCanceledParams < ::Stripe::RequestParams attr_accessor :canceled_at # Specifies which fields in the response should be expanded. attr_accessor :expand - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. attr_accessor :metadata def initialize(canceled_at: nil, expand: nil, metadata: nil) diff --git a/lib/stripe/params/payment_record_report_payment_attempt_failed_params.rb b/lib/stripe/params/payment_record_report_payment_attempt_failed_params.rb index aea5e36f6..04955ae45 100644 --- a/lib/stripe/params/payment_record_report_payment_attempt_failed_params.rb +++ b/lib/stripe/params/payment_record_report_payment_attempt_failed_params.rb @@ -7,7 +7,7 @@ class PaymentRecordReportPaymentAttemptFailedParams < ::Stripe::RequestParams attr_accessor :expand # When the reported payment failed. Measured in seconds since the Unix epoch. attr_accessor :failed_at - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. attr_accessor :metadata def initialize(expand: nil, failed_at: nil, metadata: nil) diff --git a/lib/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rb b/lib/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rb index 0620801d3..ad1791cac 100644 --- a/lib/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rb +++ b/lib/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rb @@ -7,7 +7,7 @@ class PaymentRecordReportPaymentAttemptGuaranteedParams < ::Stripe::RequestParam attr_accessor :expand # When the reported payment was guaranteed. Measured in seconds since the Unix epoch. attr_accessor :guaranteed_at - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. attr_accessor :metadata def initialize(expand: nil, guaranteed_at: nil, metadata: nil) diff --git a/lib/stripe/params/promotion_code_create_params.rb b/lib/stripe/params/promotion_code_create_params.rb index be13406ce..2cb8805cb 100644 --- a/lib/stripe/params/promotion_code_create_params.rb +++ b/lib/stripe/params/promotion_code_create_params.rb @@ -47,7 +47,7 @@ def initialize( end # Whether the promotion code is currently active. attr_accessor :active - # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). # # If left blank, we will generate one automatically. attr_accessor :code diff --git a/lib/stripe/params/subscription_create_params.rb b/lib/stripe/params/subscription_create_params.rb index 953e16e9f..e30fd4583 100644 --- a/lib/stripe/params/subscription_create_params.rb +++ b/lib/stripe/params/subscription_create_params.rb @@ -395,7 +395,7 @@ def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) diff --git a/lib/stripe/params/subscription_item_delete_params.rb b/lib/stripe/params/subscription_item_delete_params.rb index 0ab07f658..9d4bd6902 100644 --- a/lib/stripe/params/subscription_item_delete_params.rb +++ b/lib/stripe/params/subscription_item_delete_params.rb @@ -5,13 +5,27 @@ module Stripe class SubscriptionItemDeleteParams < ::Stripe::RequestParams # Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. attr_accessor :clear_usage + # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + # + # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + # + # Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). + # + # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. + attr_accessor :payment_behavior # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. attr_accessor :proration_behavior # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint. attr_accessor :proration_date - def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil) + def initialize( + clear_usage: nil, + payment_behavior: nil, + proration_behavior: nil, + proration_date: nil + ) @clear_usage = clear_usage + @payment_behavior = payment_behavior @proration_behavior = proration_behavior @proration_date = proration_date end diff --git a/lib/stripe/params/subscription_update_params.rb b/lib/stripe/params/subscription_update_params.rb index 4cbf0366e..096b770d8 100644 --- a/lib/stripe/params/subscription_update_params.rb +++ b/lib/stripe/params/subscription_update_params.rb @@ -390,7 +390,7 @@ def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil) class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_accessor :country def initialize(country: nil) diff --git a/lib/stripe/params/tax/calculation_create_params.rb b/lib/stripe/params/tax/calculation_create_params.rb index 48c5e1218..4a631c6b1 100644 --- a/lib/stripe/params/tax/calculation_create_params.rb +++ b/lib/stripe/params/tax/calculation_create_params.rb @@ -37,7 +37,7 @@ def initialize( end class TaxId < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` attr_accessor :type # Value of the tax ID. attr_accessor :value diff --git a/lib/stripe/params/tax/registration_create_params.rb b/lib/stripe/params/tax/registration_create_params.rb index 95e1cc34f..9a22eec6b 100644 --- a/lib/stripe/params/tax/registration_create_params.rb +++ b/lib/stripe/params/tax/registration_create_params.rb @@ -885,6 +885,15 @@ def initialize(type: nil) end end + class Lk < ::Stripe::RequestParams + # Type of registration to be created in `country`. + attr_accessor :type + + def initialize(type: nil) + @type = type + end + end + class Lt < ::Stripe::RequestParams class Standard < ::Stripe::RequestParams # Place of supply scheme used in an EU standard registration. @@ -1449,7 +1458,7 @@ def initialize(type: nil) class Us < ::Stripe::RequestParams class LocalAmusementTax < ::Stripe::RequestParams - # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `02154` (Arlington Heights), `06613` (Bloomington), `10906` (Campton Hills), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park). + # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `02154` (Arlington Heights), `05248` (Bensenville), `06613` (Bloomington), `10906` (Campton Hills), `14000` (Chicago), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), `64421` (Riverside), `65806` (Roselle), and `68081` (Schiller Park). attr_accessor :jurisdiction def initialize(jurisdiction: nil) @@ -1707,6 +1716,8 @@ def initialize(standard: nil, type: nil) attr_accessor :kz # Options for the registration in LA. attr_accessor :la + # Options for the registration in LK. + attr_accessor :lk # Options for the registration in LT. attr_accessor :lt # Options for the registration in LU. @@ -1854,6 +1865,7 @@ def initialize( kr: nil, kz: nil, la: nil, + lk: nil, lt: nil, lu: nil, lv: nil, @@ -1955,6 +1967,7 @@ def initialize( @kr = kr @kz = kz @la = la + @lk = lk @lt = lt @lu = lu @lv = lv diff --git a/lib/stripe/params/tax_id_create_params.rb b/lib/stripe/params/tax_id_create_params.rb index c00f743a0..7b64cf386 100644 --- a/lib/stripe/params/tax_id_create_params.rb +++ b/lib/stripe/params/tax_id_create_params.rb @@ -24,7 +24,7 @@ def initialize(account: nil, customer: nil, customer_account: nil, type: nil) attr_accessor :expand # The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. attr_accessor :owner - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` attr_accessor :type # Value of the tax ID. attr_accessor :value diff --git a/lib/stripe/params/terminal/configuration_create_params.rb b/lib/stripe/params/terminal/configuration_create_params.rb index ee1ef8018..c78bbc69b 100644 --- a/lib/stripe/params/terminal/configuration_create_params.rb +++ b/lib/stripe/params/terminal/configuration_create_params.rb @@ -22,6 +22,15 @@ def initialize(splashscreen: nil) end end + class Cellular < ::Stripe::RequestParams + # Determines whether to allow the reader to connect to a cellular network. Defaults to false. + attr_accessor :enabled + + def initialize(enabled: nil) + @enabled = enabled + end + end + class Offline < ::Stripe::RequestParams # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. attr_accessor :enabled @@ -52,6 +61,15 @@ def initialize(splashscreen: nil) end end + class StripeS710 < ::Stripe::RequestParams + # A File ID representing an image you want to display on the reader. + attr_accessor :splashscreen + + def initialize(splashscreen: nil) + @splashscreen = splashscreen + end + end + class Tipping < ::Stripe::RequestParams class Aed < ::Stripe::RequestParams # Fixed amounts displayed when collecting a tip @@ -548,6 +566,8 @@ def initialize( attr_accessor :bbpos_wisepad3 # An object containing device type specific settings for BBPOS WisePOS E readers. attr_accessor :bbpos_wisepos_e + # Configuration for cellular connectivity. + attr_accessor :cellular # Specifies which fields in the response should be expanded. attr_accessor :expand # Name of the configuration @@ -558,6 +578,8 @@ def initialize( attr_accessor :reboot_window # An object containing device type specific settings for Stripe S700 readers. attr_accessor :stripe_s700 + # An object containing device type specific settings for Stripe S710 readers. + attr_accessor :stripe_s710 # Tipping configurations for readers that support on-reader tips. attr_accessor :tipping # An object containing device type specific settings for Verifone P400 readers. @@ -568,22 +590,26 @@ def initialize( def initialize( bbpos_wisepad3: nil, bbpos_wisepos_e: nil, + cellular: nil, expand: nil, name: nil, offline: nil, reboot_window: nil, stripe_s700: nil, + stripe_s710: nil, tipping: nil, verifone_p400: nil, wifi: nil ) @bbpos_wisepad3 = bbpos_wisepad3 @bbpos_wisepos_e = bbpos_wisepos_e + @cellular = cellular @expand = expand @name = name @offline = offline @reboot_window = reboot_window @stripe_s700 = stripe_s700 + @stripe_s710 = stripe_s710 @tipping = tipping @verifone_p400 = verifone_p400 @wifi = wifi diff --git a/lib/stripe/params/terminal/configuration_update_params.rb b/lib/stripe/params/terminal/configuration_update_params.rb index e484b2872..44ec22f22 100644 --- a/lib/stripe/params/terminal/configuration_update_params.rb +++ b/lib/stripe/params/terminal/configuration_update_params.rb @@ -22,6 +22,15 @@ def initialize(splashscreen: nil) end end + class Cellular < ::Stripe::RequestParams + # Determines whether to allow the reader to connect to a cellular network. Defaults to false. + attr_accessor :enabled + + def initialize(enabled: nil) + @enabled = enabled + end + end + class Offline < ::Stripe::RequestParams # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. attr_accessor :enabled @@ -52,6 +61,15 @@ def initialize(splashscreen: nil) end end + class StripeS710 < ::Stripe::RequestParams + # A File ID representing an image you want to display on the reader. + attr_accessor :splashscreen + + def initialize(splashscreen: nil) + @splashscreen = splashscreen + end + end + class Tipping < ::Stripe::RequestParams class Aed < ::Stripe::RequestParams # Fixed amounts displayed when collecting a tip @@ -548,6 +566,8 @@ def initialize( attr_accessor :bbpos_wisepad3 # An object containing device type specific settings for BBPOS WisePOS E readers. attr_accessor :bbpos_wisepos_e + # Configuration for cellular connectivity. + attr_accessor :cellular # Specifies which fields in the response should be expanded. attr_accessor :expand # Name of the configuration @@ -558,7 +578,9 @@ def initialize( attr_accessor :reboot_window # An object containing device type specific settings for Stripe S700 readers. attr_accessor :stripe_s700 - # Tipping configurations for readers. supporting on-reader tips + # An object containing device type specific settings for Stripe S710 readers. + attr_accessor :stripe_s710 + # Tipping configurations for readers that support on-reader tips. attr_accessor :tipping # An object containing device type specific settings for Verifone P400 readers. attr_accessor :verifone_p400 @@ -568,22 +590,26 @@ def initialize( def initialize( bbpos_wisepad3: nil, bbpos_wisepos_e: nil, + cellular: nil, expand: nil, name: nil, offline: nil, reboot_window: nil, stripe_s700: nil, + stripe_s710: nil, tipping: nil, verifone_p400: nil, wifi: nil ) @bbpos_wisepad3 = bbpos_wisepad3 @bbpos_wisepos_e = bbpos_wisepos_e + @cellular = cellular @expand = expand @name = name @offline = offline @reboot_window = reboot_window @stripe_s700 = stripe_s700 + @stripe_s710 = stripe_s710 @tipping = tipping @verifone_p400 = verifone_p400 @wifi = wifi diff --git a/lib/stripe/request_params.rb b/lib/stripe/request_params.rb index 1be0526aa..f78710c83 100644 --- a/lib/stripe/request_params.rb +++ b/lib/stripe/request_params.rb @@ -5,11 +5,46 @@ module Stripe # For internal use only. Does not provide a stable API and may be broken # with future non-major changes. class RequestParams + class << self + # Override the object instantiation flow in Ruby in order to track explicitly set keys + # V2 APIs accept null values on the backend. However, we do not want to set a key to nil + # if the user has not explicitly set them to nil + # TODO(major): https://go/j/DEVSDK-2990 + def new(**kwargs) + instance = allocate + # Track explicitly set keys for V2 classes only + instance.instance_variable_set(:@_explicitly_set_keys, kwargs.keys.to_set) if name&.start_with?("Stripe::V2::") + instance.send(:initialize, **kwargs) + instance + end + + # Override attr_accessor to create setters that track explicitly set keys for V2 classes + def attr_accessor(*names) + names.each do |name| + # Define getter + define_method(name) { instance_variable_get("@#{name}") } + + # Define setter that tracks the key as explicitly set + define_method("#{name}=") do |value| + @_explicitly_set_keys&.add(name) + instance_variable_set("@#{name}", value) + end + end + end + end + def to_h instance_variables.each_with_object({}) do |var, hash| + # _explicitly_set_keys is set as an instance variable. + # Ignore the var if it is _explicitly_set_keys itself. + next if var == :@_explicitly_set_keys + key = var.to_s.delete("@").to_sym value = instance_variable_get(var) + # For V2 classes, only include keys that were explicitly set + next if @_explicitly_set_keys && !@_explicitly_set_keys.include?(key) + hash[key] = if value.is_a?(RequestParams) value.to_h # Check if value is an array and contains RequestParams objects diff --git a/lib/stripe/resources.rb b/lib/stripe/resources.rb index 94192dd7f..356a372bd 100644 --- a/lib/stripe/resources.rb +++ b/lib/stripe/resources.rb @@ -100,6 +100,9 @@ require "stripe/resources/refund" require "stripe/resources/reporting/report_run" require "stripe/resources/reporting/report_type" +require "stripe/resources/reserve/hold" +require "stripe/resources/reserve/plan" +require "stripe/resources/reserve/release" require "stripe/resources/reserve_transaction" require "stripe/resources/reversal" require "stripe/resources/review" diff --git a/lib/stripe/resources/charge.rb b/lib/stripe/resources/charge.rb index 8c3eac8d0..d91da0d7d 100644 --- a/lib/stripe/resources/charge.rb +++ b/lib/stripe/resources/charge.rb @@ -1011,6 +1011,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -1023,6 +1025,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt # Attribute for field wallet @@ -1234,6 +1238,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -1242,6 +1248,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt diff --git a/lib/stripe/resources/checkout/session.rb b/lib/stripe/resources/checkout/session.rb index 2badcb49a..22c6f2c15 100644 --- a/lib/stripe/resources/checkout/session.rb +++ b/lib/stripe/resources/checkout/session.rb @@ -301,7 +301,7 @@ def self.field_remappings @field_remappings = {} end end - # The value that will pre-fill on the payment page. + # The value that pre-fills on the payment page. attr_reader :default_value # The options available for the customer to select. Up to 200 options allowed. attr_reader :options @@ -333,7 +333,7 @@ def self.field_remappings end class Numeric < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_reader :default_value # The maximum character length constraint for the customer's input. attr_reader :maximum_length @@ -352,7 +352,7 @@ def self.field_remappings end class Text < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_reader :default_value # The maximum character length constraint for the customer's input. attr_reader :maximum_length @@ -395,7 +395,7 @@ def self.field_remappings class CustomText < ::Stripe::StripeObject class AfterSubmit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types @@ -408,7 +408,7 @@ def self.field_remappings end class ShippingAddress < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types @@ -421,7 +421,7 @@ def self.field_remappings end class Submit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types @@ -434,7 +434,7 @@ def self.field_remappings end class TermsOfServiceAcceptance < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types @@ -493,7 +493,7 @@ def self.field_remappings end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` attr_reader :type # The value of the tax ID. attr_reader :value @@ -1067,7 +1067,7 @@ def self.field_remappings class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_reader :country def self.inner_class_types diff --git a/lib/stripe/resources/confirmation_token.rb b/lib/stripe/resources/confirmation_token.rb index a9368c6c5..a674d8a86 100644 --- a/lib/stripe/resources/confirmation_token.rb +++ b/lib/stripe/resources/confirmation_token.rb @@ -417,6 +417,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -429,6 +431,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt # Attribute for field wallet diff --git a/lib/stripe/resources/invoice.rb b/lib/stripe/resources/invoice.rb index 3e2a9d626..4f4f698a5 100644 --- a/lib/stripe/resources/invoice.rb +++ b/lib/stripe/resources/invoice.rb @@ -181,7 +181,7 @@ def self.field_remappings end class CustomerTaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` attr_reader :type # The value of the tax ID. attr_reader :value @@ -424,7 +424,7 @@ def self.field_remappings class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_reader :country def self.inner_class_types @@ -950,7 +950,7 @@ def self.field_remappings attr_reader :parent # Attribute for field payment_settings attr_reader :payment_settings - # Payments for this invoice + # Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details. attr_reader :payments # End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. attr_reader :period_end diff --git a/lib/stripe/resources/mandate.rb b/lib/stripe/resources/mandate.rb index 71c9ce88b..96aae900b 100644 --- a/lib/stripe/resources/mandate.rb +++ b/lib/stripe/resources/mandate.rb @@ -106,12 +106,16 @@ def self.field_remappings end class BacsDebit < ::Stripe::StripeObject + # The display name for the account on this mandate. + attr_reader :display_name # The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. attr_reader :network_status # The unique reference identifying the mandate on the Bacs network. attr_reader :reference # When the mandate is revoked on the Bacs network this field displays the reason for the revocation. attr_reader :revocation_reason + # The service user number for the account on this mandate. + attr_reader :service_user_number # The URL that will contain the mandate that the customer has signed. attr_reader :url diff --git a/lib/stripe/resources/payment_attempt_record.rb b/lib/stripe/resources/payment_attempt_record.rb index b6e763b97..05c60c347 100644 --- a/lib/stripe/resources/payment_attempt_record.rb +++ b/lib/stripe/resources/payment_attempt_record.rb @@ -207,9 +207,9 @@ def self.field_remappings end class Affirm < ::Stripe::StripeObject - # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + # ID of the location that this reader is assigned to. attr_reader :location - # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + # ID of the reader this transaction was made on. attr_reader :reader # The Affirm transaction ID associated with this payment. attr_reader :transaction_id @@ -226,7 +226,7 @@ def self.field_remappings class AfterpayClearpay < ::Stripe::StripeObject # The Afterpay order ID associated with this payment intent. attr_reader :order_id - # Order identifier shown to the merchant in Afterpay’s online portal. + # Order identifier shown to the merchant in Afterpay's online portal. attr_reader :reference def self.inner_class_types @@ -388,11 +388,9 @@ class Bancontact < ::Stripe::StripeObject attr_reader :generated_sepa_debit_mandate # Last four characters of the IBAN. attr_reader :iban_last4 - # Preferred language of the Bancontact authorization page that the customer is redirected to. - # Can be one of `en`, `de`, `fr`, or `nl` + # Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` attr_reader :preferred_language - # Owner's verified full name. Values are verified or provided by Bancontact directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. + # Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. attr_reader :verified_name def self.inner_class_types @@ -486,11 +484,11 @@ def self.field_remappings class Card < ::Stripe::StripeObject class Checks < ::Stripe::StripeObject - # Attribute for field address_line1_check + # If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. attr_reader :address_line1_check - # Attribute for field address_postal_code_check + # If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. attr_reader :address_postal_code_check - # Attribute for field cvc_check + # If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. attr_reader :cvc_check def self.inner_class_types @@ -519,7 +517,7 @@ def self.field_remappings @field_remappings = {} end end - # Attribute for field plan + # Installment plan selected for the payment. attr_reader :plan def self.inner_class_types @@ -545,13 +543,13 @@ def self.field_remappings end class ThreeDSecure < ::Stripe::StripeObject - # Attribute for field authentication_flow + # For authenticated transactions: Indicates how the issuing bank authenticated the customer. attr_reader :authentication_flow - # Attribute for field result + # Indicates the outcome of 3D Secure authentication. attr_reader :result - # Attribute for field result_reason + # Additional information about why 3D Secure succeeded or failed, based on the `result`. attr_reader :result_reason - # Attribute for field version + # The version of 3D Secure that was used. attr_reader :version def self.inner_class_types @@ -760,6 +758,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -772,6 +772,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt # Attribute for field wallet @@ -791,7 +793,7 @@ class Cashapp < ::Stripe::StripeObject attr_reader :buyer_id # A public identifier for buyers using Cash App. attr_reader :cashtag - # A unique and immutable identifier of payments assigned by Cash App + # A unique and immutable identifier of payments assigned by Cash App. attr_reader :transaction_id def self.inner_class_types @@ -888,9 +890,7 @@ class Giropay < ::Stripe::StripeObject attr_reader :bank_name # Bank Identifier Code of the bank associated with the bank account. attr_reader :bic - # Owner's verified full name. Values are verified or provided by Giropay directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. - # Giropay rarely provides this information so the attribute is usually empty. + # Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. attr_reader :verified_name def self.inner_class_types @@ -998,6 +998,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -1006,6 +1008,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt diff --git a/lib/stripe/resources/payment_intent.rb b/lib/stripe/resources/payment_intent.rb index 07e6f548e..103fb0559 100644 --- a/lib/stripe/resources/payment_intent.rb +++ b/lib/stripe/resources/payment_intent.rb @@ -1710,7 +1710,7 @@ def self.field_remappings class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_reader :country def self.inner_class_types @@ -2476,6 +2476,8 @@ def self.field_remappings attr_reader :setup_future_usage # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. attr_reader :target_date + # The purpose of the transaction. + attr_reader :transaction_purpose # Bank account verification method. attr_reader :verification_method # Preferred transaction settlement speed diff --git a/lib/stripe/resources/payment_intent_amount_details_line_item.rb b/lib/stripe/resources/payment_intent_amount_details_line_item.rb index 110de1cb9..8e5f410e0 100644 --- a/lib/stripe/resources/payment_intent_amount_details_line_item.rb +++ b/lib/stripe/resources/payment_intent_amount_details_line_item.rb @@ -116,7 +116,7 @@ def self.field_remappings attr_reader :product_code # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. attr_reader :product_name # The quantity of items. Required for L3 rates. An integer greater than 0. attr_reader :quantity diff --git a/lib/stripe/resources/payment_link.rb b/lib/stripe/resources/payment_link.rb index 5e58e1bf5..b90fa52d1 100644 --- a/lib/stripe/resources/payment_link.rb +++ b/lib/stripe/resources/payment_link.rb @@ -135,7 +135,7 @@ def self.field_remappings @field_remappings = {} end end - # The value that will pre-fill on the payment page. + # The value that pre-fills on the payment page. attr_reader :default_value # The options available for the customer to select. Up to 200 options allowed. attr_reader :options @@ -165,7 +165,7 @@ def self.field_remappings end class Numeric < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_reader :default_value # The maximum character length constraint for the customer's input. attr_reader :maximum_length @@ -182,7 +182,7 @@ def self.field_remappings end class Text < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. attr_reader :default_value # The maximum character length constraint for the customer's input. attr_reader :maximum_length @@ -223,7 +223,7 @@ def self.field_remappings class CustomText < ::Stripe::StripeObject class AfterSubmit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types @@ -236,7 +236,7 @@ def self.field_remappings end class ShippingAddress < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types @@ -249,7 +249,7 @@ def self.field_remappings end class Submit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types @@ -262,7 +262,7 @@ def self.field_remappings end class TermsOfServiceAcceptance < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. attr_reader :message def self.inner_class_types diff --git a/lib/stripe/resources/payment_method.rb b/lib/stripe/resources/payment_method.rb index 304cb7303..3a91eae97 100644 --- a/lib/stripe/resources/payment_method.rb +++ b/lib/stripe/resources/payment_method.rb @@ -321,6 +321,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -333,6 +335,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt # Attribute for field wallet diff --git a/lib/stripe/resources/payment_record.rb b/lib/stripe/resources/payment_record.rb index b79cf8e78..90c7dca06 100644 --- a/lib/stripe/resources/payment_record.rb +++ b/lib/stripe/resources/payment_record.rb @@ -205,9 +205,9 @@ def self.field_remappings end class Affirm < ::Stripe::StripeObject - # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + # ID of the location that this reader is assigned to. attr_reader :location - # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + # ID of the reader this transaction was made on. attr_reader :reader # The Affirm transaction ID associated with this payment. attr_reader :transaction_id @@ -224,7 +224,7 @@ def self.field_remappings class AfterpayClearpay < ::Stripe::StripeObject # The Afterpay order ID associated with this payment intent. attr_reader :order_id - # Order identifier shown to the merchant in Afterpay’s online portal. + # Order identifier shown to the merchant in Afterpay's online portal. attr_reader :reference def self.inner_class_types @@ -386,11 +386,9 @@ class Bancontact < ::Stripe::StripeObject attr_reader :generated_sepa_debit_mandate # Last four characters of the IBAN. attr_reader :iban_last4 - # Preferred language of the Bancontact authorization page that the customer is redirected to. - # Can be one of `en`, `de`, `fr`, or `nl` + # Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` attr_reader :preferred_language - # Owner's verified full name. Values are verified or provided by Bancontact directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. + # Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. attr_reader :verified_name def self.inner_class_types @@ -484,11 +482,11 @@ def self.field_remappings class Card < ::Stripe::StripeObject class Checks < ::Stripe::StripeObject - # Attribute for field address_line1_check + # If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. attr_reader :address_line1_check - # Attribute for field address_postal_code_check + # If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. attr_reader :address_postal_code_check - # Attribute for field cvc_check + # If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. attr_reader :cvc_check def self.inner_class_types @@ -517,7 +515,7 @@ def self.field_remappings @field_remappings = {} end end - # Attribute for field plan + # Installment plan selected for the payment. attr_reader :plan def self.inner_class_types @@ -543,13 +541,13 @@ def self.field_remappings end class ThreeDSecure < ::Stripe::StripeObject - # Attribute for field authentication_flow + # For authenticated transactions: Indicates how the issuing bank authenticated the customer. attr_reader :authentication_flow - # Attribute for field result + # Indicates the outcome of 3D Secure authentication. attr_reader :result - # Attribute for field result_reason + # Additional information about why 3D Secure succeeded or failed, based on the `result`. attr_reader :result_reason - # Attribute for field version + # The version of 3D Secure that was used. attr_reader :version def self.inner_class_types @@ -758,6 +756,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -770,6 +770,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt # Attribute for field wallet @@ -789,7 +791,7 @@ class Cashapp < ::Stripe::StripeObject attr_reader :buyer_id # A public identifier for buyers using Cash App. attr_reader :cashtag - # A unique and immutable identifier of payments assigned by Cash App + # A unique and immutable identifier of payments assigned by Cash App. attr_reader :transaction_id def self.inner_class_types @@ -886,9 +888,7 @@ class Giropay < ::Stripe::StripeObject attr_reader :bank_name # Bank Identifier Code of the bank associated with the bank account. attr_reader :bic - # Owner's verified full name. Values are verified or provided by Giropay directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. - # Giropay rarely provides this information so the attribute is usually empty. + # Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. attr_reader :verified_name def self.inner_class_types @@ -996,6 +996,8 @@ def self.field_remappings attr_reader :issuer # The last four digits of the card. attr_reader :last4 + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. attr_reader :network # This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. @@ -1004,6 +1006,8 @@ def self.field_remappings attr_reader :preferred_locales # How card details were read in this transaction. attr_reader :read_method + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + attr_reader :reader # A collection of fields required to be displayed on receipts. Only required for EMV transactions. attr_reader :receipt diff --git a/lib/stripe/resources/promotion_code.rb b/lib/stripe/resources/promotion_code.rb index 8a42043ec..7b5243c77 100644 --- a/lib/stripe/resources/promotion_code.rb +++ b/lib/stripe/resources/promotion_code.rb @@ -64,7 +64,7 @@ def self.field_remappings end # Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. attr_reader :active - # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). attr_reader :code # Time at which the object was created. Measured in seconds since the Unix epoch. attr_reader :created diff --git a/lib/stripe/resources/radar/payment_evaluation.rb b/lib/stripe/resources/radar/payment_evaluation.rb index aae0ed441..7223ddf90 100644 --- a/lib/stripe/resources/radar/payment_evaluation.rb +++ b/lib/stripe/resources/radar/payment_evaluation.rb @@ -168,21 +168,6 @@ def self.field_remappings end class Insights < ::Stripe::StripeObject - class CardIssuerDecline < ::Stripe::StripeObject - # Stripe Radar's evaluation of the likelihood that the payment will be declined by the card issuer. Scores range from 0 to 100, with higher values indicating a higher likelihood of decline. - attr_reader :model_score - # Recommended action based on the model score. Possible values are `block` and `continue`. - attr_reader :recommended_action - - def self.inner_class_types - @inner_class_types = {} - end - - def self.field_remappings - @field_remappings = {} - end - end - class FraudulentDispute < ::Stripe::StripeObject # Recommended action based on the risk score. Possible values are `block` and `continue`. attr_reader :recommended_action @@ -197,18 +182,13 @@ def self.field_remappings @field_remappings = {} end end - # Stripe Radar's evaluation of the likelihood of a card issuer decline on this payment. - attr_reader :card_issuer_decline # The timestamp when the evaluation was performed. attr_reader :evaluated_at # Scores, insights and recommended action for one scorer for this PaymentEvaluation. attr_reader :fraudulent_dispute def self.inner_class_types - @inner_class_types = { - card_issuer_decline: CardIssuerDecline, - fraudulent_dispute: FraudulentDispute, - } + @inner_class_types = { fraudulent_dispute: FraudulentDispute } end def self.field_remappings diff --git a/lib/stripe/resources/reserve/hold.rb b/lib/stripe/resources/reserve/hold.rb new file mode 100644 index 000000000..1bc1f5ebf --- /dev/null +++ b/lib/stripe/resources/reserve/hold.rb @@ -0,0 +1,67 @@ +# File generated from our OpenAPI spec +# frozen_string_literal: true + +module Stripe + module Reserve + # ReserveHolds are used to place a temporary ReserveHold on a merchant's funds. + class Hold < APIResource + OBJECT_NAME = "reserve.hold" + def self.object_name + "reserve.hold" + end + + class ReleaseSchedule < ::Stripe::StripeObject + # The time after which the ReserveHold is requested to be released. + attr_reader :release_after + # The time at which the ReserveHold is scheduled to be released, automatically set to midnight UTC of the day after `release_after`. + attr_reader :scheduled_release + + def self.inner_class_types + @inner_class_types = {} + end + + def self.field_remappings + @field_remappings = {} + end + end + # Amount reserved. A positive integer representing how much is reserved in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). + attr_reader :amount + # Amount in cents that can be released from this ReserveHold + attr_reader :amount_releasable + # Time at which the object was created. Measured in seconds since the Unix epoch. + attr_reader :created + # Indicates which party created this ReserveHold. + attr_reader :created_by + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + attr_reader :currency + # Unique identifier for the object. + attr_reader :id + # Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven't been fully released yet. + attr_reader :is_releasable + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + attr_reader :livemode + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + attr_reader :metadata + # String representing the object's type. Objects of the same type share the same value. + attr_reader :object + # The reason for the ReserveHold. + attr_reader :reason + # Attribute for field release_schedule + attr_reader :release_schedule + # The ReservePlan which produced this ReserveHold (i.e., resplan_123) + attr_reader :reserve_plan + # The Charge which funded this ReserveHold (e.g., ch_123) + attr_reader :source_charge + # Which source balance type this ReserveHold reserves funds from. One of `bank_account`, `card`, or `fpx`. + attr_reader :source_type + + def self.inner_class_types + @inner_class_types = { release_schedule: ReleaseSchedule } + end + + def self.field_remappings + @field_remappings = {} + end + end + end +end diff --git a/lib/stripe/resources/reserve/plan.rb b/lib/stripe/resources/reserve/plan.rb new file mode 100644 index 000000000..29b15e546 --- /dev/null +++ b/lib/stripe/resources/reserve/plan.rb @@ -0,0 +1,78 @@ +# File generated from our OpenAPI spec +# frozen_string_literal: true + +module Stripe + module Reserve + # ReservePlans are used to automatically place holds on a merchant's funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account). + class Plan < APIResource + OBJECT_NAME = "reserve.plan" + def self.object_name + "reserve.plan" + end + + class FixedRelease < ::Stripe::StripeObject + # The time after which all reserved funds are requested for release. + attr_reader :release_after + # The time at which reserved funds are scheduled for release, automatically set to midnight UTC of the day after `release_after`. + attr_reader :scheduled_release + + def self.inner_class_types + @inner_class_types = {} + end + + def self.field_remappings + @field_remappings = {} + end + end + + class RollingRelease < ::Stripe::StripeObject + # The number of days to reserve funds before releasing. + attr_reader :days_after_charge + # The time at which the ReservePlan expires. + attr_reader :expires_on + + def self.inner_class_types + @inner_class_types = {} + end + + def self.field_remappings + @field_remappings = {} + end + end + # Time at which the object was created. Measured in seconds since the Unix epoch. + attr_reader :created + # Indicates which party created this ReservePlan. + attr_reader :created_by + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). An unset currency indicates that the plan applies to all currencies. + attr_reader :currency + # Time at which the ReservePlan was disabled. + attr_reader :disabled_at + # Attribute for field fixed_release + attr_reader :fixed_release + # Unique identifier for the object. + attr_reader :id + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + attr_reader :livemode + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + attr_reader :metadata + # String representing the object's type. Objects of the same type share the same value. + attr_reader :object + # The percent of each Charge to reserve. + attr_reader :percent + # Attribute for field rolling_release + attr_reader :rolling_release + # The current status of the ReservePlan. The ReservePlan only affects charges if it is `active`. + attr_reader :status + # The type of the ReservePlan. + attr_reader :type + + def self.inner_class_types + @inner_class_types = { fixed_release: FixedRelease, rolling_release: RollingRelease } + end + + def self.field_remappings + @field_remappings = {} + end + end + end +end diff --git a/lib/stripe/resources/reserve/release.rb b/lib/stripe/resources/reserve/release.rb new file mode 100644 index 000000000..aaa59747b --- /dev/null +++ b/lib/stripe/resources/reserve/release.rb @@ -0,0 +1,65 @@ +# File generated from our OpenAPI spec +# frozen_string_literal: true + +module Stripe + module Reserve + # ReserveReleases represent the release of funds from a ReserveHold. + class Release < APIResource + OBJECT_NAME = "reserve.release" + def self.object_name + "reserve.release" + end + + class SourceTransaction < ::Stripe::StripeObject + # The ID of the dispute. + attr_reader :dispute + # The ID of the refund. + attr_reader :refund + # The type of source transaction. + attr_reader :type + + def self.inner_class_types + @inner_class_types = {} + end + + def self.field_remappings + @field_remappings = {} + end + end + # Amount released. A positive integer representing how much is released in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). + attr_reader :amount + # Time at which the object was created. Measured in seconds since the Unix epoch. + attr_reader :created + # Indicates which party created this ReserveRelease. + attr_reader :created_by + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + attr_reader :currency + # Unique identifier for the object. + attr_reader :id + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + attr_reader :livemode + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + attr_reader :metadata + # String representing the object's type. Objects of the same type share the same value. + attr_reader :object + # The reason for the ReserveRelease, indicating why the funds were released. + attr_reader :reason + # The release timestamp of the funds. + attr_reader :released_at + # The ReserveHold this ReserveRelease is associated with. + attr_reader :reserve_hold + # The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry. + attr_reader :reserve_plan + # Attribute for field source_transaction + attr_reader :source_transaction + + def self.inner_class_types + @inner_class_types = { source_transaction: SourceTransaction } + end + + def self.field_remappings + @field_remappings = {} + end + end + end +end diff --git a/lib/stripe/resources/subscription.rb b/lib/stripe/resources/subscription.rb index 5be70422d..e542482f3 100644 --- a/lib/stripe/resources/subscription.rb +++ b/lib/stripe/resources/subscription.rb @@ -251,7 +251,7 @@ def self.field_remappings class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. attr_reader :country def self.inner_class_types @@ -494,7 +494,7 @@ def self.field_remappings @field_remappings = {} end end - # Defines how a subscription behaves when a free trial ends. + # Defines how a subscription behaves when a trial ends. attr_reader :end_behavior def self.inner_class_types @@ -690,7 +690,7 @@ def self.migrate(subscription, params = {}, opts = {}) ) end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. def resume(params = {}, opts = {}) request_stripe_object( method: :post, @@ -700,7 +700,7 @@ def resume(params = {}, opts = {}) ) end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. def self.resume(subscription, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/tax/calculation.rb b/lib/stripe/resources/tax/calculation.rb index 1f037d4bb..2c81b094d 100644 --- a/lib/stripe/resources/tax/calculation.rb +++ b/lib/stripe/resources/tax/calculation.rb @@ -39,7 +39,7 @@ def self.field_remappings end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` attr_reader :type # The value of the tax ID. attr_reader :value diff --git a/lib/stripe/resources/tax/registration.rb b/lib/stripe/resources/tax/registration.rb index 01d26033b..0aec8b200 100644 --- a/lib/stripe/resources/tax/registration.rb +++ b/lib/stripe/resources/tax/registration.rb @@ -1042,6 +1042,19 @@ def self.field_remappings end end + class Lk < ::Stripe::StripeObject + # Type of registration in `country`. + attr_reader :type + + def self.inner_class_types + @inner_class_types = {} + end + + def self.field_remappings + @field_remappings = {} + end + end + class Lt < ::Stripe::StripeObject class Standard < ::Stripe::StripeObject # Place of supply scheme used in an EU standard registration. @@ -1996,6 +2009,8 @@ def self.field_remappings attr_reader :kz # Attribute for field la attr_reader :la + # Attribute for field lk + attr_reader :lk # Attribute for field lt attr_reader :lt # Attribute for field lu @@ -2144,6 +2159,7 @@ def self.inner_class_types kr: Kr, kz: Kz, la: La, + lk: Lk, lt: Lt, lu: Lu, lv: Lv, diff --git a/lib/stripe/resources/tax/transaction.rb b/lib/stripe/resources/tax/transaction.rb index a8e76bb78..044b3ed03 100644 --- a/lib/stripe/resources/tax/transaction.rb +++ b/lib/stripe/resources/tax/transaction.rb @@ -37,7 +37,7 @@ def self.field_remappings end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` attr_reader :type # The value of the tax ID. attr_reader :value diff --git a/lib/stripe/resources/tax_id.rb b/lib/stripe/resources/tax_id.rb index 79e86d768..693064fd3 100644 --- a/lib/stripe/resources/tax_id.rb +++ b/lib/stripe/resources/tax_id.rb @@ -69,7 +69,7 @@ def self.field_remappings attr_reader :object # The account or customer the tax ID belongs to. attr_reader :owner - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` attr_reader :type # Value of the tax ID. attr_reader :value diff --git a/lib/stripe/resources/terminal/configuration.rb b/lib/stripe/resources/terminal/configuration.rb index 50e662665..1d741818f 100644 --- a/lib/stripe/resources/terminal/configuration.rb +++ b/lib/stripe/resources/terminal/configuration.rb @@ -42,6 +42,19 @@ def self.field_remappings end end + class Cellular < ::Stripe::StripeObject + # Whether a cellular-capable reader can connect to the internet over cellular. + attr_reader :enabled + + def self.inner_class_types + @inner_class_types = {} + end + + def self.field_remappings + @field_remappings = {} + end + end + class Offline < ::Stripe::StripeObject # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. attr_reader :enabled @@ -83,6 +96,19 @@ def self.field_remappings end end + class StripeS710 < ::Stripe::StripeObject + # A File ID representing an image to display on the reader + attr_reader :splashscreen + + def self.inner_class_types + @inner_class_types = {} + end + + def self.field_remappings + @field_remappings = {} + end + end + class Tipping < ::Stripe::StripeObject class Aed < ::Stripe::StripeObject # Fixed amounts displayed when collecting a tip @@ -607,6 +633,8 @@ def self.field_remappings attr_reader :bbpos_wisepad3 # Attribute for field bbpos_wisepos_e attr_reader :bbpos_wisepos_e + # Attribute for field cellular + attr_reader :cellular # Unique identifier for the object. attr_reader :id # Whether this Configuration is the default for your account @@ -623,6 +651,8 @@ def self.field_remappings attr_reader :reboot_window # Attribute for field stripe_s700 attr_reader :stripe_s700 + # Attribute for field stripe_s710 + attr_reader :stripe_s710 # Attribute for field tipping attr_reader :tipping # Attribute for field verifone_p400 @@ -686,9 +716,11 @@ def self.inner_class_types @inner_class_types = { bbpos_wisepad3: BbposWisepad3, bbpos_wisepos_e: BbposWiseposE, + cellular: Cellular, offline: Offline, reboot_window: RebootWindow, stripe_s700: StripeS700, + stripe_s710: StripeS710, tipping: Tipping, verifone_p400: VerifoneP400, wifi: Wifi, diff --git a/lib/stripe/resources/v2/billing/meter_event.rb b/lib/stripe/resources/v2/billing/meter_event.rb index 970493249..15c6f5bb1 100644 --- a/lib/stripe/resources/v2/billing/meter_event.rb +++ b/lib/stripe/resources/v2/billing/meter_event.rb @@ -4,7 +4,7 @@ module Stripe module V2 module Billing - # Fix me empty_doc_string. + # A Meter Event is a usage record that captures billable activity for usage-based billing. Meter Events contain an event name, timestamp, and payload with customer mapping and usage value, enabling accurate usage tracking and billing. class MeterEvent < APIResource OBJECT_NAME = "v2.billing.meter_event" def self.object_name diff --git a/lib/stripe/resources/v2/billing/meter_event_adjustment.rb b/lib/stripe/resources/v2/billing/meter_event_adjustment.rb index 4e19f95b5..ac78c3e72 100644 --- a/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +++ b/lib/stripe/resources/v2/billing/meter_event_adjustment.rb @@ -4,6 +4,7 @@ module Stripe module V2 module Billing + # A Meter Event Adjustment is used to cancel or modify previously recorded meter events. Meter Event Adjustments allow you to correct billing data by canceling individual events or event ranges, with tracking of adjustment status and creation time. class MeterEventAdjustment < APIResource OBJECT_NAME = "v2.billing.meter_event_adjustment" def self.object_name diff --git a/lib/stripe/resources/v2/billing/meter_event_session.rb b/lib/stripe/resources/v2/billing/meter_event_session.rb index 045733d87..abd596925 100644 --- a/lib/stripe/resources/v2/billing/meter_event_session.rb +++ b/lib/stripe/resources/v2/billing/meter_event_session.rb @@ -4,6 +4,7 @@ module Stripe module V2 module Billing + # A Meter Event Session is an authentication session for the high-throughput meter event API. Meter Event Sessions provide temporary authentication tokens with expiration times, enabling secure and efficient bulk submission of usage events. class MeterEventSession < APIResource OBJECT_NAME = "v2.billing.meter_event_session" def self.object_name diff --git a/lib/stripe/resources/v2/core/account.rb b/lib/stripe/resources/v2/core/account.rb index 4b17efe87..82f8fc6e0 100644 --- a/lib/stripe/resources/v2/core/account.rb +++ b/lib/stripe/resources/v2/core/account.rb @@ -4,7 +4,9 @@ module Stripe module V2 module Core - # A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products. + # An Account v2 object represents a company, individual, or other entity that interacts with a platform on Stripe. It contains both identifying information and properties that control its behavior and functionality. An Account can have one or more configurations that enable sets of related features, such as allowing it to act as a merchant or customer. + # The Accounts v2 API supports both the Global Payouts preview feature and the Connect-Billing integration preview feature. However, a particular Account can only access one of them. + # The Connect-Billing integration preview feature allows an Account v2 to pay subscription fees to a platform. An Account v1 required a separate Customer object to pay subscription fees. class Account < APIResource OBJECT_NAME = "v2.core.account" def self.object_name diff --git a/lib/stripe/services/subscription_service.rb b/lib/stripe/services/subscription_service.rb index 37bfc6313..feef61e2c 100644 --- a/lib/stripe/services/subscription_service.rb +++ b/lib/stripe/services/subscription_service.rb @@ -68,7 +68,7 @@ def migrate(subscription, params = {}, opts = {}) ) end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. def resume(subscription, params = {}, opts = {}) request( method: :post, diff --git a/rbi/stripe.rbi b/rbi/stripe.rbi index 85c1f5ce4..d639da6e7 100644 --- a/rbi/stripe.rbi +++ b/rbi/stripe.rbi @@ -1637,6 +1637,73 @@ module Stripe end end # typed: true +module Stripe + module Reserve + # ReserveHolds are used to place a temporary ReserveHold on a merchant's funds. + class Hold < APIResource + class ReleaseSchedule < ::Stripe::StripeObject + # The time after which the ReserveHold is requested to be released. + sig { returns(T.nilable(Integer)) } + def release_after; end + # The time at which the ReserveHold is scheduled to be released, automatically set to midnight UTC of the day after `release_after`. + sig { returns(T.nilable(Integer)) } + def scheduled_release; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + # Amount reserved. A positive integer representing how much is reserved in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). + sig { returns(Integer) } + def amount; end + # Amount in cents that can be released from this ReserveHold + sig { returns(T.nilable(Integer)) } + def amount_releasable; end + # Time at which the object was created. Measured in seconds since the Unix epoch. + sig { returns(Integer) } + def created; end + # Indicates which party created this ReserveHold. + sig { returns(String) } + def created_by; end + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + sig { returns(String) } + def currency; end + # Unique identifier for the object. + sig { returns(String) } + def id; end + # Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven't been fully released yet. + sig { returns(T.nilable(T::Boolean)) } + def is_releasable; end + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + sig { returns(T::Boolean) } + def livemode; end + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + sig { returns(T.nilable(T::Hash[String, String])) } + def metadata; end + # String representing the object's type. Objects of the same type share the same value. + sig { returns(String) } + def object; end + # The reason for the ReserveHold. + sig { returns(String) } + def reason; end + # Attribute for field release_schedule + sig { returns(ReleaseSchedule) } + def release_schedule; end + # The ReservePlan which produced this ReserveHold (i.e., resplan_123) + sig { returns(T.nilable(T.any(String, ::Stripe::Reserve::Plan))) } + def reserve_plan; end + # The Charge which funded this ReserveHold (e.g., ch_123) + sig { returns(T.nilable(T.any(String, ::Stripe::Charge))) } + def source_charge; end + # Which source balance type this ReserveHold reserves funds from. One of `bank_account`, `card`, or `fpx`. + sig { returns(String) } + def source_type; end + end + end +end +# typed: true module Stripe # A line item. class LineItem < APIResource @@ -1741,6 +1808,145 @@ module Stripe end end # typed: true +module Stripe + module Reserve + # ReservePlans are used to automatically place holds on a merchant's funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account). + class Plan < APIResource + class FixedRelease < ::Stripe::StripeObject + # The time after which all reserved funds are requested for release. + sig { returns(Integer) } + def release_after; end + # The time at which reserved funds are scheduled for release, automatically set to midnight UTC of the day after `release_after`. + sig { returns(Integer) } + def scheduled_release; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + class RollingRelease < ::Stripe::StripeObject + # The number of days to reserve funds before releasing. + sig { returns(Integer) } + def days_after_charge; end + # The time at which the ReservePlan expires. + sig { returns(T.nilable(Integer)) } + def expires_on; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + # Time at which the object was created. Measured in seconds since the Unix epoch. + sig { returns(Integer) } + def created; end + # Indicates which party created this ReservePlan. + sig { returns(String) } + def created_by; end + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). An unset currency indicates that the plan applies to all currencies. + sig { returns(T.nilable(String)) } + def currency; end + # Time at which the ReservePlan was disabled. + sig { returns(T.nilable(Integer)) } + def disabled_at; end + # Attribute for field fixed_release + sig { returns(T.nilable(FixedRelease)) } + def fixed_release; end + # Unique identifier for the object. + sig { returns(String) } + def id; end + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + sig { returns(T::Boolean) } + def livemode; end + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + sig { returns(T.nilable(T::Hash[String, String])) } + def metadata; end + # String representing the object's type. Objects of the same type share the same value. + sig { returns(String) } + def object; end + # The percent of each Charge to reserve. + sig { returns(Integer) } + def percent; end + # Attribute for field rolling_release + sig { returns(T.nilable(RollingRelease)) } + def rolling_release; end + # The current status of the ReservePlan. The ReservePlan only affects charges if it is `active`. + sig { returns(String) } + def status; end + # The type of the ReservePlan. + sig { returns(String) } + def type; end + end + end +end +# typed: true +module Stripe + module Reserve + # ReserveReleases represent the release of funds from a ReserveHold. + class Release < APIResource + class SourceTransaction < ::Stripe::StripeObject + # The ID of the dispute. + sig { returns(T.nilable(T.any(String, ::Stripe::Dispute))) } + def dispute; end + # The ID of the refund. + sig { returns(T.nilable(T.any(String, ::Stripe::Refund))) } + def refund; end + # The type of source transaction. + sig { returns(String) } + def type; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + # Amount released. A positive integer representing how much is released in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). + sig { returns(Integer) } + def amount; end + # Time at which the object was created. Measured in seconds since the Unix epoch. + sig { returns(Integer) } + def created; end + # Indicates which party created this ReserveRelease. + sig { returns(String) } + def created_by; end + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + sig { returns(String) } + def currency; end + # Unique identifier for the object. + sig { returns(String) } + def id; end + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + sig { returns(T::Boolean) } + def livemode; end + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + sig { returns(T.nilable(T::Hash[String, String])) } + def metadata; end + # String representing the object's type. Objects of the same type share the same value. + sig { returns(String) } + def object; end + # The reason for the ReserveRelease, indicating why the funds were released. + sig { returns(String) } + def reason; end + # The release timestamp of the funds. + sig { returns(Integer) } + def released_at; end + # The ReserveHold this ReserveRelease is associated with. + sig { returns(T.nilable(T.any(String, ::Stripe::Reserve::Hold))) } + def reserve_hold; end + # The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry. + sig { returns(T.nilable(T.any(String, ::Stripe::Reserve::Plan))) } + def reserve_plan; end + # Attribute for field source_transaction + sig { returns(T.nilable(SourceTransaction)) } + def source_transaction; end + end + end +end +# typed: true module Stripe class ReserveTransaction < APIResource # Attribute for field amount @@ -7680,6 +7886,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -7698,6 +7907,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -7929,6 +8141,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -7941,6 +8156,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -9405,7 +9623,7 @@ module Stripe @field_remappings = {} end end - # The value that will pre-fill on the payment page. + # The value that pre-fills on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The options available for the customer to select. Up to 200 options allowed. @@ -9436,7 +9654,7 @@ module Stripe end end class Numeric < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -9456,7 +9674,7 @@ module Stripe end end class Text < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -9505,7 +9723,7 @@ module Stripe end class CustomText < ::Stripe::StripeObject class AfterSubmit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -9516,7 +9734,7 @@ module Stripe end end class ShippingAddress < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -9527,7 +9745,7 @@ module Stripe end end class Submit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -9538,7 +9756,7 @@ module Stripe end end class TermsOfServiceAcceptance < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -9600,7 +9818,7 @@ module Stripe end end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. @@ -10173,7 +10391,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types @@ -12191,6 +12409,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -12209,6 +12430,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -17871,7 +18095,7 @@ module Stripe end end class CustomerTaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. @@ -18119,7 +18343,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types @@ -18713,7 +18937,7 @@ module Stripe # Attribute for field payment_settings sig { returns(PaymentSettings) } def payment_settings; end - # Payments for this invoice + # Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details. sig { returns(T.nilable(::Stripe::ListObject)) } def payments; end # End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. @@ -21611,6 +21835,9 @@ module Stripe end end class BacsDebit < ::Stripe::StripeObject + # The display name for the account on this mandate. + sig { returns(T.nilable(String)) } + def display_name; end # The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. sig { returns(String) } def network_status; end @@ -21620,6 +21847,9 @@ module Stripe # When the mandate is revoked on the Bacs network this field displays the reason for the revocation. sig { returns(T.nilable(String)) } def revocation_reason; end + # The service user number for the account on this mandate. + sig { returns(T.nilable(String)) } + def service_user_number; end # The URL that will contain the mandate that the customer has signed. sig { returns(String) } def url; end @@ -22100,10 +22330,10 @@ module Stripe end end class Affirm < ::Stripe::StripeObject - # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + # ID of the location that this reader is assigned to. sig { returns(T.nilable(String)) } def location; end - # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + # ID of the reader this transaction was made on. sig { returns(T.nilable(String)) } def reader; end # The Affirm transaction ID associated with this payment. @@ -22120,7 +22350,7 @@ module Stripe # The Afterpay order ID associated with this payment intent. sig { returns(T.nilable(String)) } def order_id; end - # Order identifier shown to the merchant in Afterpay’s online portal. + # Order identifier shown to the merchant in Afterpay's online portal. sig { returns(T.nilable(String)) } def reference; end def self.inner_class_types @@ -22291,12 +22521,10 @@ module Stripe # Last four characters of the IBAN. sig { returns(T.nilable(String)) } def iban_last4; end - # Preferred language of the Bancontact authorization page that the customer is redirected to. - # Can be one of `en`, `de`, `fr`, or `nl` + # Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` sig { returns(T.nilable(String)) } def preferred_language; end - # Owner's verified full name. Values are verified or provided by Bancontact directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. + # Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -22376,7 +22604,7 @@ module Stripe end class Boleto < ::Stripe::StripeObject # The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) - sig { returns(String) } + sig { returns(T.nilable(String)) } def tax_id; end def self.inner_class_types @inner_class_types = {} @@ -22387,13 +22615,13 @@ module Stripe end class Card < ::Stripe::StripeObject class Checks < ::Stripe::StripeObject - # Attribute for field address_line1_check + # If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_line1_check; end - # Attribute for field address_postal_code_check + # If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_postal_code_check; end - # Attribute for field cvc_check + # If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def cvc_check; end def self.inner_class_types @@ -22421,7 +22649,7 @@ module Stripe @field_remappings = {} end end - # Attribute for field plan + # Installment plan selected for the payment. sig { returns(T.nilable(Plan)) } def plan; end def self.inner_class_types @@ -22443,16 +22671,16 @@ module Stripe end end class ThreeDSecure < ::Stripe::StripeObject - # Attribute for field authentication_flow + # For authenticated transactions: Indicates how the issuing bank authenticated the customer. sig { returns(T.nilable(String)) } def authentication_flow; end - # Attribute for field result + # Indicates the outcome of 3D Secure authentication. sig { returns(T.nilable(String)) } def result; end - # Attribute for field result_reason + # Additional information about why 3D Secure succeeded or failed, based on the `result`. sig { returns(T.nilable(String)) } def result_reason; end - # Attribute for field version + # The version of 3D Secure that was used. sig { returns(T.nilable(String)) } def version; end def self.inner_class_types @@ -22699,6 +22927,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -22717,6 +22948,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -22737,7 +22971,7 @@ module Stripe # A public identifier for buyers using Cash App. sig { returns(T.nilable(String)) } def cashtag; end - # A unique and immutable identifier of payments assigned by Cash App + # A unique and immutable identifier of payments assigned by Cash App. sig { returns(T.nilable(String)) } def transaction_id; end def self.inner_class_types @@ -22832,9 +23066,7 @@ module Stripe # Bank Identifier Code of the bank associated with the bank account. sig { returns(T.nilable(String)) } def bic; end - # Owner's verified full name. Values are verified or provided by Giropay directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. - # Giropay rarely provides this information so the attribute is usually empty. + # Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -22962,6 +23194,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -22974,6 +23209,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -25815,7 +26053,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types @@ -26549,6 +26787,9 @@ module Stripe # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. sig { returns(T.nilable(String)) } def target_date; end + # The purpose of the transaction. + sig { returns(T.nilable(String)) } + def transaction_purpose; end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end @@ -27444,7 +27685,7 @@ module Stripe def product_code; end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end # The quantity of items. Required for L3 rates. An integer greater than 0. @@ -27582,7 +27823,7 @@ module Stripe @field_remappings = {} end end - # The value that will pre-fill on the payment page. + # The value that pre-fills on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The options available for the customer to select. Up to 200 options allowed. @@ -27610,7 +27851,7 @@ module Stripe end end class Numeric < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -27627,7 +27868,7 @@ module Stripe end end class Text < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -27673,7 +27914,7 @@ module Stripe end class CustomText < ::Stripe::StripeObject class AfterSubmit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -27684,7 +27925,7 @@ module Stripe end end class ShippingAddress < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -27695,7 +27936,7 @@ module Stripe end end class Submit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -27706,7 +27947,7 @@ module Stripe end end class TermsOfServiceAcceptance < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -30682,6 +30923,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -30700,6 +30944,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -32233,10 +32480,10 @@ module Stripe end end class Affirm < ::Stripe::StripeObject - # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + # ID of the location that this reader is assigned to. sig { returns(T.nilable(String)) } def location; end - # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + # ID of the reader this transaction was made on. sig { returns(T.nilable(String)) } def reader; end # The Affirm transaction ID associated with this payment. @@ -32253,7 +32500,7 @@ module Stripe # The Afterpay order ID associated with this payment intent. sig { returns(T.nilable(String)) } def order_id; end - # Order identifier shown to the merchant in Afterpay’s online portal. + # Order identifier shown to the merchant in Afterpay's online portal. sig { returns(T.nilable(String)) } def reference; end def self.inner_class_types @@ -32424,12 +32671,10 @@ module Stripe # Last four characters of the IBAN. sig { returns(T.nilable(String)) } def iban_last4; end - # Preferred language of the Bancontact authorization page that the customer is redirected to. - # Can be one of `en`, `de`, `fr`, or `nl` + # Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` sig { returns(T.nilable(String)) } def preferred_language; end - # Owner's verified full name. Values are verified or provided by Bancontact directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. + # Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -32509,7 +32754,7 @@ module Stripe end class Boleto < ::Stripe::StripeObject # The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) - sig { returns(String) } + sig { returns(T.nilable(String)) } def tax_id; end def self.inner_class_types @inner_class_types = {} @@ -32520,13 +32765,13 @@ module Stripe end class Card < ::Stripe::StripeObject class Checks < ::Stripe::StripeObject - # Attribute for field address_line1_check + # If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_line1_check; end - # Attribute for field address_postal_code_check + # If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_postal_code_check; end - # Attribute for field cvc_check + # If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def cvc_check; end def self.inner_class_types @@ -32554,7 +32799,7 @@ module Stripe @field_remappings = {} end end - # Attribute for field plan + # Installment plan selected for the payment. sig { returns(T.nilable(Plan)) } def plan; end def self.inner_class_types @@ -32576,16 +32821,16 @@ module Stripe end end class ThreeDSecure < ::Stripe::StripeObject - # Attribute for field authentication_flow + # For authenticated transactions: Indicates how the issuing bank authenticated the customer. sig { returns(T.nilable(String)) } def authentication_flow; end - # Attribute for field result + # Indicates the outcome of 3D Secure authentication. sig { returns(T.nilable(String)) } def result; end - # Attribute for field result_reason + # Additional information about why 3D Secure succeeded or failed, based on the `result`. sig { returns(T.nilable(String)) } def result_reason; end - # Attribute for field version + # The version of 3D Secure that was used. sig { returns(T.nilable(String)) } def version; end def self.inner_class_types @@ -32832,6 +33077,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -32850,6 +33098,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -32870,7 +33121,7 @@ module Stripe # A public identifier for buyers using Cash App. sig { returns(T.nilable(String)) } def cashtag; end - # A unique and immutable identifier of payments assigned by Cash App + # A unique and immutable identifier of payments assigned by Cash App. sig { returns(T.nilable(String)) } def transaction_id; end def self.inner_class_types @@ -32965,9 +33216,7 @@ module Stripe # Bank Identifier Code of the bank associated with the bank account. sig { returns(T.nilable(String)) } def bic; end - # Owner's verified full name. Values are verified or provided by Giropay directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. - # Giropay rarely provides this information so the attribute is usually empty. + # Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -33095,6 +33344,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -33107,6 +33359,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -34987,7 +35242,7 @@ module Stripe # Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. sig { returns(T::Boolean) } def active; end - # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). sig { returns(String) } def code; end # Time at which the object was created. Measured in seconds since the Unix epoch. @@ -35885,20 +36140,6 @@ module Stripe end end class Insights < ::Stripe::StripeObject - class CardIssuerDecline < ::Stripe::StripeObject - # Stripe Radar's evaluation of the likelihood that the payment will be declined by the card issuer. Scores range from 0 to 100, with higher values indicating a higher likelihood of decline. - sig { returns(Float) } - def model_score; end - # Recommended action based on the model score. Possible values are `block` and `continue`. - sig { returns(String) } - def recommended_action; end - def self.inner_class_types - @inner_class_types = {} - end - def self.field_remappings - @field_remappings = {} - end - end class FraudulentDispute < ::Stripe::StripeObject # Recommended action based on the risk score. Possible values are `block` and `continue`. sig { returns(String) } @@ -35913,9 +36154,6 @@ module Stripe @field_remappings = {} end end - # Stripe Radar's evaluation of the likelihood of a card issuer decline on this payment. - sig { returns(T.nilable(CardIssuerDecline)) } - def card_issuer_decline; end # The timestamp when the evaluation was performed. sig { returns(Integer) } def evaluated_at; end @@ -35923,10 +36161,7 @@ module Stripe sig { returns(FraudulentDispute) } def fraudulent_dispute; end def self.inner_class_types - @inner_class_types = { - card_issuer_decline: CardIssuerDecline, - fraudulent_dispute: FraudulentDispute, - } + @inner_class_types = {fraudulent_dispute: FraudulentDispute} end def self.field_remappings @field_remappings = {} @@ -41102,7 +41337,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types @@ -41343,7 +41578,7 @@ module Stripe @field_remappings = {} end end - # Defines how a subscription behaves when a free trial ends. + # Defines how a subscription behaves when a trial ends. sig { returns(EndBehavior) } def end_behavior; end def self.inner_class_types @@ -41562,13 +41797,13 @@ module Stripe } def self.migrate(subscription, params = {}, opts = {}); end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. sig { params(params: T.any(::Stripe::SubscriptionResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::Subscription) } def resume(params = {}, opts = {}); end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. sig { params(subscription: String, params: T.any(::Stripe::SubscriptionResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::Subscription) } @@ -41646,7 +41881,7 @@ module Stripe end end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. @@ -42858,6 +43093,17 @@ module Stripe @field_remappings = {} end end + class Lk < ::Stripe::StripeObject + # Type of registration in `country`. + sig { returns(String) } + def type; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end class Lt < ::Stripe::StripeObject class Standard < ::Stripe::StripeObject # Place of supply scheme used in an EU standard registration. @@ -43777,6 +44023,9 @@ module Stripe # Attribute for field la sig { returns(T.nilable(La)) } def la; end + # Attribute for field lk + sig { returns(T.nilable(Lk)) } + def lk; end # Attribute for field lt sig { returns(T.nilable(Lt)) } def lt; end @@ -43969,6 +44218,7 @@ module Stripe kr: Kr, kz: Kz, la: La, + lk: Lk, lt: Lt, lu: Lu, lv: Lv, @@ -44219,7 +44469,7 @@ module Stripe end end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. @@ -44559,7 +44809,7 @@ module Stripe # The account or customer the tax ID belongs to. sig { returns(T.nilable(Owner)) } def owner; end - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` sig { returns(String) } def type; end # Value of the tax ID. @@ -44719,6 +44969,17 @@ module Stripe @field_remappings = {} end end + class Cellular < ::Stripe::StripeObject + # Whether a cellular-capable reader can connect to the internet over cellular. + sig { returns(T::Boolean) } + def enabled; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end class Offline < ::Stripe::StripeObject # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. sig { returns(T.nilable(T::Boolean)) } @@ -44755,6 +45016,17 @@ module Stripe @field_remappings = {} end end + class StripeS710 < ::Stripe::StripeObject + # A File ID representing an image to display on the reader + sig { returns(T.nilable(T.any(String, ::Stripe::File))) } + def splashscreen; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end class Tipping < ::Stripe::StripeObject class Aed < ::Stripe::StripeObject # Fixed amounts displayed when collecting a tip @@ -45303,6 +45575,9 @@ module Stripe # Attribute for field bbpos_wisepos_e sig { returns(T.nilable(BbposWiseposE)) } def bbpos_wisepos_e; end + # Attribute for field cellular + sig { returns(T.nilable(Cellular)) } + def cellular; end # Unique identifier for the object. sig { returns(String) } def id; end @@ -45327,6 +45602,9 @@ module Stripe # Attribute for field stripe_s700 sig { returns(T.nilable(StripeS700)) } def stripe_s700; end + # Attribute for field stripe_s710 + sig { returns(T.nilable(StripeS710)) } + def stripe_s710; end # Attribute for field tipping sig { returns(T.nilable(Tipping)) } def tipping; end @@ -48633,6 +48911,7 @@ end module Stripe module V2 module Billing + # A Meter Event Adjustment is used to cancel or modify previously recorded meter events. Meter Event Adjustments allow you to correct billing data by canceling individual events or event ranges, with tracking of adjustment status and creation time. class MeterEventAdjustment < APIResource class Cancel < ::Stripe::StripeObject # Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them. @@ -48677,6 +48956,7 @@ end module Stripe module V2 module Billing + # A Meter Event Session is an authentication session for the high-throughput meter event API. Meter Event Sessions provide temporary authentication tokens with expiration times, enabling secure and efficient bulk submission of usage events. class MeterEventSession < APIResource # The authentication token for this session. Use this token when calling the # high-throughput meter event API. @@ -48705,7 +48985,7 @@ end module Stripe module V2 module Billing - # Fix me empty_doc_string. + # A Meter Event is a usage record that captures billable activity for usage-based billing. Meter Events contain an event name, timestamp, and payload with customer mapping and usage value, enabling accurate usage tracking and billing. class MeterEvent < APIResource # The creation time of this meter event. sig { returns(String) } @@ -48887,7 +49167,9 @@ end module Stripe module V2 module Core - # A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products. + # An Account v2 object represents a company, individual, or other entity that interacts with a platform on Stripe. It contains both identifying information and properties that control its behavior and functionality. An Account can have one or more configurations that enable sets of related features, such as allowing it to act as a merchant or customer. + # The Accounts v2 API supports both the Global Payouts preview feature and the Connect-Billing integration preview feature. However, a particular Account can only access one of them. + # The Connect-Billing integration preview feature allows an Account v2 to pay subscription fees to a platform. An Account v1 required a separate Customer object to pay subscription fees. class Account < APIResource class Configuration < ::Stripe::StripeObject class Customer < ::Stripe::StripeObject @@ -56504,7 +56786,7 @@ module Stripe } def migrate(subscription, params = {}, opts = {}); end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. sig { params(subscription: String, params: T.any(::Stripe::SubscriptionResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::Subscription) } @@ -66112,7 +66394,7 @@ module Stripe params(_filters: T.nilable(T::Array[::Stripe::Billing::AlertCreateParams::UsageThreshold::Filter])).returns(T.nilable(T::Array[::Stripe::Billing::AlertCreateParams::UsageThreshold::Filter])) } def filters=(_filters); end - # Defines at which value the alert will fire. + # Defines the threshold value that triggers the alert. sig { returns(Integer) } def gte; end sig { params(_gte: Integer).returns(Integer) } @@ -67816,7 +68098,7 @@ module Stripe type: nil ); end end - # The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. + # The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. sig { returns(T.nilable(String)) } def configuration; end sig { params(_configuration: T.nilable(String)).returns(T.nilable(String)) } @@ -68820,7 +69102,7 @@ module Stripe sig { params(label: String, value: String).void } def initialize(label: nil, value: nil); end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -68854,7 +69136,7 @@ module Stripe def initialize(custom: nil, type: nil); end end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -68875,7 +69157,7 @@ module Stripe def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -68953,7 +69235,7 @@ module Stripe end class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -68962,7 +69244,7 @@ module Stripe def initialize(message: nil); end end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -68971,7 +69253,7 @@ module Stripe def initialize(message: nil); end end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -68980,7 +69262,7 @@ module Stripe def initialize(message: nil); end end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -70147,7 +70429,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -74584,7 +74866,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteCreateParams::Line::TaxAmount]))) } @@ -74593,14 +74875,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteCreateParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteCreateParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -74849,7 +75131,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewParams::Line::TaxAmount]))) } @@ -74858,14 +75140,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -75088,7 +75370,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteListPreviewLineItemsParams::Line::TaxAmount]))) } @@ -75097,14 +75379,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteListPreviewLineItemsParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteListPreviewLineItemsParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -76287,7 +76569,7 @@ module Stripe def initialize(ip_address: nil, validate_location: nil); end end class TaxIdDatum < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -76555,7 +76837,7 @@ module Stripe class CustomerCreateFundingInstructionsParams < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -79679,7 +79961,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -80756,7 +81038,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -82598,7 +82880,7 @@ module Stripe def initialize(ip_address: nil); end end class TaxId < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -90121,7 +90403,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -90130,7 +90412,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -90190,7 +90472,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -90199,7 +90481,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -90208,7 +90490,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -90217,7 +90499,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -90265,7 +90547,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -90355,7 +90637,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -92203,7 +92485,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -93309,6 +93591,13 @@ module Stripe def target_date; end sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) } def target_date=(_target_date); end + # The purpose of the transaction. + sig { returns(T.nilable(T.any(String, String))) } + def transaction_purpose; end + sig { + params(_transaction_purpose: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String))) + } + def transaction_purpose=(_transaction_purpose); end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end @@ -93322,7 +93611,7 @@ module Stripe } def preferred_settlement_speed=(_preferred_settlement_speed); end sig { - params(financial_connections: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void + params(financial_connections: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), transaction_purpose: T.nilable(T.any(String, String)), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void } def initialize( financial_connections: nil, @@ -93330,6 +93619,7 @@ module Stripe networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ); end @@ -94303,7 +94593,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -94312,7 +94602,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -94372,7 +94662,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -94381,7 +94671,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -94390,7 +94680,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -94399,7 +94689,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -94447,7 +94737,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -94537,7 +94827,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -96307,7 +96597,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -97413,6 +97703,13 @@ module Stripe def target_date; end sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) } def target_date=(_target_date); end + # The purpose of the transaction. + sig { returns(T.nilable(T.any(String, String))) } + def transaction_purpose; end + sig { + params(_transaction_purpose: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String))) + } + def transaction_purpose=(_transaction_purpose); end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end @@ -97426,7 +97723,7 @@ module Stripe } def preferred_settlement_speed=(_preferred_settlement_speed); end sig { - params(financial_connections: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void + params(financial_connections: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), transaction_purpose: T.nilable(T.any(String, String)), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void } def initialize( financial_connections: nil, @@ -97434,6 +97731,7 @@ module Stripe networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ); end @@ -98377,7 +98675,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -98386,7 +98684,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -98446,7 +98744,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -98455,7 +98753,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -98464,7 +98762,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -98473,7 +98771,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -98521,7 +98819,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -98611,7 +98909,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -98811,7 +99109,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -98820,7 +99118,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -98880,7 +99178,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -98889,7 +99187,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -98898,7 +99196,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -98907,7 +99205,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -98955,7 +99253,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -99045,7 +99343,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -100889,7 +101187,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -101995,6 +102293,13 @@ module Stripe def target_date; end sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) } def target_date=(_target_date); end + # The purpose of the transaction. + sig { returns(T.nilable(T.any(String, String))) } + def transaction_purpose; end + sig { + params(_transaction_purpose: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String))) + } + def transaction_purpose=(_transaction_purpose); end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end @@ -102008,7 +102313,7 @@ module Stripe } def preferred_settlement_speed=(_preferred_settlement_speed); end sig { - params(financial_connections: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void + params(financial_connections: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), transaction_purpose: T.nilable(T.any(String, String)), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void } def initialize( financial_connections: nil, @@ -102016,6 +102321,7 @@ module Stripe networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ); end @@ -102856,7 +103162,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -102865,7 +103171,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -102925,7 +103231,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -102934,7 +103240,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -102943,7 +103249,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -102952,7 +103258,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -103000,7 +103306,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -103090,7 +103396,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -103483,7 +103789,7 @@ module Stripe sig { params(label: String, value: String).void } def initialize(label: nil, value: nil); end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -103515,7 +103821,7 @@ module Stripe def initialize(custom: nil, type: nil); end end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -103536,7 +103842,7 @@ module Stripe def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -103614,7 +103920,7 @@ module Stripe end class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -103623,7 +103929,7 @@ module Stripe def initialize(message: nil); end end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -103632,7 +103938,7 @@ module Stripe def initialize(message: nil); end end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -103641,7 +103947,7 @@ module Stripe def initialize(message: nil); end end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -104658,7 +104964,7 @@ module Stripe sig { params(label: String, value: String).void } def initialize(label: nil, value: nil); end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -104690,7 +104996,7 @@ module Stripe def initialize(custom: nil, type: nil); end end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -104711,7 +105017,7 @@ module Stripe def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -104789,7 +105095,7 @@ module Stripe end class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -104798,7 +105104,7 @@ module Stripe def initialize(message: nil); end end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -104807,7 +105113,7 @@ module Stripe def initialize(message: nil); end end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -104816,7 +105122,7 @@ module Stripe def initialize(message: nil); end end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -105091,6 +105397,52 @@ module Stripe } def initialize(business: nil, individual: nil); end end + class OptionalItem < ::Stripe::RequestParams + class AdjustableQuantity < ::Stripe::RequestParams + # Set to true if the quantity can be adjusted to any non-negative integer. + sig { returns(T::Boolean) } + def enabled; end + sig { params(_enabled: T::Boolean).returns(T::Boolean) } + def enabled=(_enabled); end + # The maximum quantity of this item the customer can purchase. By default this value is 99. + sig { returns(T.nilable(Integer)) } + def maximum; end + sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) } + def maximum=(_maximum); end + # The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0. + sig { returns(T.nilable(Integer)) } + def minimum; end + sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) } + def minimum=(_minimum); end + sig { + params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void + } + def initialize(enabled: nil, maximum: nil, minimum: nil); end + end + # When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order. + sig { + returns(T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity)) + } + def adjustable_quantity; end + sig { + params(_adjustable_quantity: T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity)) + } + def adjustable_quantity=(_adjustable_quantity); end + # The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. + sig { returns(String) } + def price; end + sig { params(_price: String).returns(String) } + def price=(_price); end + # The initial quantity of the line item created when a customer chooses to add this optional item to their order. + sig { returns(Integer) } + def quantity; end + sig { params(_quantity: Integer).returns(Integer) } + def quantity=(_quantity); end + sig { + params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void + } + def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end + end class PaymentIntentData < ::Stripe::RequestParams # An arbitrary string attached to the object. Often useful for displaying to users. sig { returns(T.nilable(String)) } @@ -105371,6 +105723,17 @@ module Stripe params(_name_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection))) } def name_collection=(_name_collection); end + # A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). + # There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. + # There is a maximum of 20 combined line items and optional items. + sig { + returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem]))) + } + def optional_items; end + sig { + params(_optional_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem]))) + } + def optional_items=(_optional_items); end # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. sig { returns(T.nilable(::Stripe::PaymentLinkUpdateParams::PaymentIntentData)) } def payment_intent_data; end @@ -105439,7 +105802,7 @@ module Stripe } def tax_id_collection=(_tax_id_collection); end sig { - params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLinkUpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLinkUpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::CustomField])), custom_text: T.nilable(::Stripe::PaymentLinkUpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkUpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLinkUpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), name_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection)), payment_intent_data: T.nilable(::Stripe::PaymentLinkUpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.any(String, T::Array[String])), phone_number_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::Restrictions)), shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::ShippingAddressCollection)), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkUpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::TaxIdCollection)).void + params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLinkUpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLinkUpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::CustomField])), custom_text: T.nilable(::Stripe::PaymentLinkUpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkUpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLinkUpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), name_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection)), optional_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem])), payment_intent_data: T.nilable(::Stripe::PaymentLinkUpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.any(String, T::Array[String])), phone_number_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::Restrictions)), shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::ShippingAddressCollection)), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkUpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::TaxIdCollection)).void } def initialize( active: nil, @@ -105456,6 +105819,7 @@ module Stripe line_items: nil, metadata: nil, name_collection: nil, + optional_items: nil, payment_intent_data: nil, payment_method_collection: nil, payment_method_types: nil, @@ -110801,7 +111165,7 @@ module Stripe def expand; end sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) } def expand=(_expand); end - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) } def metadata; end sig { @@ -110827,7 +111191,7 @@ module Stripe def failed_at; end sig { params(_failed_at: Integer).returns(Integer) } def failed_at=(_failed_at); end - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) } def metadata; end sig { @@ -110853,7 +111217,7 @@ module Stripe def guaranteed_at; end sig { params(_guaranteed_at: Integer).returns(Integer) } def guaranteed_at=(_guaranteed_at); end - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) } def metadata; end sig { @@ -113635,7 +113999,7 @@ module Stripe def active; end sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } def active=(_active); end - # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). # # If left blank, we will generate one automatically. sig { returns(T.nilable(String)) } @@ -122758,6 +123122,17 @@ module Stripe def clear_usage; end sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } def clear_usage=(_clear_usage); end + # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + # + # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + # + # Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). + # + # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. + sig { returns(T.nilable(String)) } + def payment_behavior; end + sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) } + def payment_behavior=(_payment_behavior); end # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. sig { returns(T.nilable(String)) } def proration_behavior; end @@ -122769,9 +123144,14 @@ module Stripe sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) } def proration_date=(_proration_date); end sig { - params(clear_usage: T.nilable(T::Boolean), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void + params(clear_usage: T.nilable(T::Boolean), payment_behavior: T.nilable(String), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void } - def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil); end + def initialize( + clear_usage: nil, + payment_behavior: nil, + proration_behavior: nil, + proration_date: nil + ); end end end # typed: true @@ -125885,7 +126265,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -127204,7 +127584,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -127963,7 +128343,7 @@ module Stripe ); end end class TaxId < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -129458,6 +129838,15 @@ module Stripe sig { params(type: String).void } def initialize(type: nil); end end + class Lk < ::Stripe::RequestParams + # Type of registration to be created in `country`. + sig { returns(String) } + def type; end + sig { params(_type: String).returns(String) } + def type=(_type); end + sig { params(type: String).void } + def initialize(type: nil); end + end class Lt < ::Stripe::RequestParams class Standard < ::Stripe::RequestParams # Place of supply scheme used in an EU standard registration. @@ -130202,7 +130591,7 @@ module Stripe end class Us < ::Stripe::RequestParams class LocalAmusementTax < ::Stripe::RequestParams - # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `02154` (Arlington Heights), `06613` (Bloomington), `10906` (Campton Hills), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park). + # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `02154` (Arlington Heights), `05248` (Bensenville), `06613` (Bloomington), `10906` (Campton Hills), `14000` (Chicago), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), `64421` (Riverside), `65806` (Roselle), and `68081` (Schiller Park). sig { returns(String) } def jurisdiction; end sig { params(_jurisdiction: String).returns(String) } @@ -130795,6 +131184,13 @@ module Stripe params(_la: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La)).returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La)) } def la=(_la); end + # Options for the registration in LK. + sig { returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk)) } + def lk; end + sig { + params(_lk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk)).returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk)) + } + def lk=(_lk); end # Options for the registration in LT. sig { returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lt)) } def lt; end @@ -131111,7 +131507,7 @@ module Stripe } def zw=(_zw); end sig { - params(ae: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ae), al: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Al), am: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Am), ao: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ao), at: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::At), au: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Au), aw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Aw), az: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Az), ba: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ba), bb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bb), bd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bd), be: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Be), bf: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bf), bg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bg), bh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bh), bj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bj), bs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bs), by: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::By), ca: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ca), cd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cd), ch: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ch), cl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cl), cm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cm), co: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Co), cr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cr), cv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cv), cy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cy), cz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cz), de: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::De), dk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Dk), ec: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ec), ee: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ee), eg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Eg), es: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Es), et: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Et), fi: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fi), fr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fr), gb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gb), ge: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ge), gn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gn), gr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gr), hr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hr), hu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hu), id: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Id), ie: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ie), in_: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::In), is: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Is), it: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::It), jp: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Jp), ke: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ke), kg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kg), kh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kh), kr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kr), kz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kz), la: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La), lt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lt), lu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lu), lv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lv), ma: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ma), md: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Md), me: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Me), mk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mk), mr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mr), mt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mt), mx: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mx), my: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::My), ng: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ng), nl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nl), no: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::No), np: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Np), nz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nz), om: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Om), pe: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pe), ph: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ph), pl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pl), pt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pt), ro: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ro), rs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Rs), ru: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ru), sa: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sa), se: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Se), sg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sg), si: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Si), sk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sk), sn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sn), sr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sr), th: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Th), tj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tj), tr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tr), tw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tw), tz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tz), ua: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ua), ug: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ug), us: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Us), uy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uy), uz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uz), vn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Vn), za: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Za), zm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zm), zw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zw)).void + params(ae: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ae), al: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Al), am: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Am), ao: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ao), at: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::At), au: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Au), aw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Aw), az: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Az), ba: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ba), bb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bb), bd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bd), be: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Be), bf: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bf), bg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bg), bh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bh), bj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bj), bs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bs), by: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::By), ca: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ca), cd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cd), ch: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ch), cl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cl), cm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cm), co: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Co), cr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cr), cv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cv), cy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cy), cz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cz), de: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::De), dk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Dk), ec: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ec), ee: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ee), eg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Eg), es: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Es), et: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Et), fi: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fi), fr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fr), gb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gb), ge: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ge), gn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gn), gr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gr), hr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hr), hu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hu), id: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Id), ie: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ie), in_: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::In), is: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Is), it: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::It), jp: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Jp), ke: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ke), kg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kg), kh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kh), kr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kr), kz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kz), la: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La), lk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk), lt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lt), lu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lu), lv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lv), ma: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ma), md: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Md), me: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Me), mk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mk), mr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mr), mt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mt), mx: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mx), my: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::My), ng: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ng), nl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nl), no: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::No), np: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Np), nz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nz), om: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Om), pe: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pe), ph: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ph), pl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pl), pt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pt), ro: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ro), rs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Rs), ru: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ru), sa: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sa), se: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Se), sg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sg), si: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Si), sk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sk), sn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sn), sr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sr), th: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Th), tj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tj), tr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tr), tw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tw), tz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tz), ua: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ua), ug: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ug), us: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Us), uy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uy), uz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uz), vn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Vn), za: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Za), zm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zm), zw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zw)).void } def initialize( ae: nil, @@ -131169,6 +131565,7 @@ module Stripe kr: nil, kz: nil, la: nil, + lk: nil, lt: nil, lu: nil, lv: nil, @@ -131726,7 +132123,7 @@ module Stripe params(_owner: T.nilable(::Stripe::TaxIdCreateParams::Owner)).returns(T.nilable(::Stripe::TaxIdCreateParams::Owner)) } def owner=(_owner); end - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -131994,6 +132391,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class Cellular < ::Stripe::RequestParams + # Determines whether to allow the reader to connect to a cellular network. Defaults to false. + sig { returns(T::Boolean) } + def enabled; end + sig { params(_enabled: T::Boolean).returns(T::Boolean) } + def enabled=(_enabled); end + sig { params(enabled: T::Boolean).void } + def initialize(enabled: nil); end + end class Offline < ::Stripe::RequestParams # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. sig { returns(T::Boolean) } @@ -132026,6 +132432,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class StripeS710 < ::Stripe::RequestParams + # A File ID representing an image you want to display on the reader. + sig { returns(T.nilable(String)) } + def splashscreen; end + sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) } + def splashscreen=(_splashscreen); end + sig { params(splashscreen: T.nilable(String)).void } + def initialize(splashscreen: nil); end + end class Tipping < ::Stripe::RequestParams class Aed < ::Stripe::RequestParams # Fixed amounts displayed when collecting a tip @@ -132871,6 +133286,15 @@ module Stripe params(_bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE))) } def bbpos_wisepos_e=(_bbpos_wisepos_e); end + # Configuration for cellular connectivity. + sig { + returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular))) + } + def cellular; end + sig { + params(_cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular))) + } + def cellular=(_cellular); end # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } def expand; end @@ -132908,7 +133332,16 @@ module Stripe params(_stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700))) } def stripe_s700=(_stripe_s700); end - # Tipping configurations for readers. supporting on-reader tips + # An object containing device type specific settings for Stripe S710 readers. + sig { + returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710))) + } + def stripe_s710; end + sig { + params(_stripe_s710: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710))) + } + def stripe_s710=(_stripe_s710); end + # Tipping configurations for readers that support on-reader tips. sig { returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Tipping))) } @@ -132934,16 +133367,18 @@ module Stripe } def wifi=(_wifi); end sig { - params(bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWisepad3)), bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Offline)), reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::RebootWindow)), stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700)), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Tipping)), verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::VerifoneP400)), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Wifi))).void + params(bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWisepad3)), bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE)), cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Offline)), reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::RebootWindow)), stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700)), stripe_s710: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710)), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Tipping)), verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::VerifoneP400)), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Wifi))).void } def initialize( bbpos_wisepad3: nil, bbpos_wisepos_e: nil, + cellular: nil, expand: nil, name: nil, offline: nil, reboot_window: nil, stripe_s700: nil, + stripe_s710: nil, tipping: nil, verifone_p400: nil, wifi: nil @@ -133015,6 +133450,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class Cellular < ::Stripe::RequestParams + # Determines whether to allow the reader to connect to a cellular network. Defaults to false. + sig { returns(T::Boolean) } + def enabled; end + sig { params(_enabled: T::Boolean).returns(T::Boolean) } + def enabled=(_enabled); end + sig { params(enabled: T::Boolean).void } + def initialize(enabled: nil); end + end class Offline < ::Stripe::RequestParams # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. sig { returns(T::Boolean) } @@ -133047,6 +133491,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class StripeS710 < ::Stripe::RequestParams + # A File ID representing an image you want to display on the reader. + sig { returns(T.nilable(String)) } + def splashscreen; end + sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) } + def splashscreen=(_splashscreen); end + sig { params(splashscreen: T.nilable(String)).void } + def initialize(splashscreen: nil); end + end class Tipping < ::Stripe::RequestParams class Aed < ::Stripe::RequestParams # Fixed amounts displayed when collecting a tip @@ -133888,6 +134341,15 @@ module Stripe params(_bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE)).returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE)) } def bbpos_wisepos_e=(_bbpos_wisepos_e); end + # Configuration for cellular connectivity. + sig { + returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular))) + } + def cellular; end + sig { + params(_cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular))) + } + def cellular=(_cellular); end # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } def expand; end @@ -133921,6 +134383,13 @@ module Stripe params(_stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700)).returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700)) } def stripe_s700=(_stripe_s700); end + # An object containing device type specific settings for Stripe S710 readers. + sig { returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710)) } + def stripe_s710; end + sig { + params(_stripe_s710: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710)).returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710)) + } + def stripe_s710=(_stripe_s710); end # Tipping configurations for readers that support on-reader tips. sig { returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Tipping))) @@ -133945,16 +134414,18 @@ module Stripe } def wifi=(_wifi); end sig { - params(bbpos_wisepad3: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWisepad3), bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Offline)), reboot_window: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::RebootWindow), stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Tipping)), verifone_p400: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::VerifoneP400), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Wifi))).void + params(bbpos_wisepad3: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWisepad3), bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE), cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Offline)), reboot_window: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::RebootWindow), stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700), stripe_s710: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Tipping)), verifone_p400: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::VerifoneP400), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Wifi))).void } def initialize( bbpos_wisepad3: nil, bbpos_wisepos_e: nil, + cellular: nil, expand: nil, name: nil, offline: nil, reboot_window: nil, stripe_s700: nil, + stripe_s710: nil, tipping: nil, verifone_p400: nil, wifi: nil @@ -143079,7 +143550,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesListParams::Line::TaxAmount]))) } @@ -143088,14 +143559,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesListParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesListParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } @@ -143533,7 +144004,7 @@ module Stripe class CustomerFundingInstructionsCreateParams < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -143989,7 +144460,7 @@ module Stripe def expand; end sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) } def expand=(_expand); end - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/billing/alert_create_params.rbi b/rbi/stripe/params/billing/alert_create_params.rbi index 2a784a6b5..88f913c60 100644 --- a/rbi/stripe/params/billing/alert_create_params.rbi +++ b/rbi/stripe/params/billing/alert_create_params.rbi @@ -29,7 +29,7 @@ module Stripe params(_filters: T.nilable(T::Array[::Stripe::Billing::AlertCreateParams::UsageThreshold::Filter])).returns(T.nilable(T::Array[::Stripe::Billing::AlertCreateParams::UsageThreshold::Filter])) } def filters=(_filters); end - # Defines at which value the alert will fire. + # Defines the threshold value that triggers the alert. sig { returns(Integer) } def gte; end sig { params(_gte: Integer).returns(Integer) } diff --git a/rbi/stripe/params/billing_portal/session_create_params.rbi b/rbi/stripe/params/billing_portal/session_create_params.rbi index e9847cb3c..4305d7766 100644 --- a/rbi/stripe/params/billing_portal/session_create_params.rbi +++ b/rbi/stripe/params/billing_portal/session_create_params.rbi @@ -225,7 +225,7 @@ module Stripe type: nil ); end end - # The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. + # The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. sig { returns(T.nilable(String)) } def configuration; end sig { params(_configuration: T.nilable(String)).returns(T.nilable(String)) } diff --git a/rbi/stripe/params/checkout/session_create_params.rbi b/rbi/stripe/params/checkout/session_create_params.rbi index 66c3389fa..4131be4c6 100644 --- a/rbi/stripe/params/checkout/session_create_params.rbi +++ b/rbi/stripe/params/checkout/session_create_params.rbi @@ -234,7 +234,7 @@ module Stripe sig { params(label: String, value: String).void } def initialize(label: nil, value: nil); end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -268,7 +268,7 @@ module Stripe def initialize(custom: nil, type: nil); end end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -289,7 +289,7 @@ module Stripe def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -367,7 +367,7 @@ module Stripe end class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -376,7 +376,7 @@ module Stripe def initialize(message: nil); end end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -385,7 +385,7 @@ module Stripe def initialize(message: nil); end end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -394,7 +394,7 @@ module Stripe def initialize(message: nil); end end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -1561,7 +1561,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } diff --git a/rbi/stripe/params/credit_note_create_params.rbi b/rbi/stripe/params/credit_note_create_params.rbi index d1a5cca97..a5990218c 100644 --- a/rbi/stripe/params/credit_note_create_params.rbi +++ b/rbi/stripe/params/credit_note_create_params.rbi @@ -44,7 +44,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteCreateParams::Line::TaxAmount]))) } @@ -53,14 +53,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteCreateParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteCreateParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/credit_note_list_preview_line_items_params.rbi b/rbi/stripe/params/credit_note_list_preview_line_items_params.rbi index dd3099ac3..5eb70586b 100644 --- a/rbi/stripe/params/credit_note_list_preview_line_items_params.rbi +++ b/rbi/stripe/params/credit_note_list_preview_line_items_params.rbi @@ -44,7 +44,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteListPreviewLineItemsParams::Line::TaxAmount]))) } @@ -53,14 +53,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNoteListPreviewLineItemsParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNoteListPreviewLineItemsParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/credit_note_preview_lines_list_params.rbi b/rbi/stripe/params/credit_note_preview_lines_list_params.rbi index 8b83d3925..fba5d41ab 100644 --- a/rbi/stripe/params/credit_note_preview_lines_list_params.rbi +++ b/rbi/stripe/params/credit_note_preview_lines_list_params.rbi @@ -44,7 +44,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesListParams::Line::TaxAmount]))) } @@ -53,14 +53,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesListParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewLinesListParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/credit_note_preview_params.rbi b/rbi/stripe/params/credit_note_preview_params.rbi index 8de9ff167..c2b9906e8 100644 --- a/rbi/stripe/params/credit_note_preview_params.rbi +++ b/rbi/stripe/params/credit_note_preview_params.rbi @@ -44,7 +44,7 @@ module Stripe def quantity; end sig { params(_quantity: T.nilable(Integer)).returns(T.nilable(Integer)) } def quantity=(_quantity); end - # A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`. + # A list of up to 10 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`. sig { returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewParams::Line::TaxAmount]))) } @@ -53,14 +53,14 @@ module Stripe params(_tax_amounts: T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewParams::Line::TaxAmount]))).returns(T.nilable(T.any(String, T::Array[::Stripe::CreditNotePreviewParams::Line::TaxAmount]))) } def tax_amounts=(_tax_amounts); end - # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`. + # The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used. sig { returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates; end sig { params(_tax_rates: T.nilable(T.any(String, T::Array[String]))).returns(T.nilable(T.any(String, T::Array[String]))) } def tax_rates=(_tax_rates); end - # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item` + # Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`. sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/customer_create_funding_instructions_params.rbi b/rbi/stripe/params/customer_create_funding_instructions_params.rbi index d1f4467ce..221061c30 100644 --- a/rbi/stripe/params/customer_create_funding_instructions_params.rbi +++ b/rbi/stripe/params/customer_create_funding_instructions_params.rbi @@ -6,7 +6,7 @@ module Stripe class CustomerCreateFundingInstructionsParams < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } diff --git a/rbi/stripe/params/customer_create_params.rbi b/rbi/stripe/params/customer_create_params.rbi index 59d8a0001..5ed844f5e 100644 --- a/rbi/stripe/params/customer_create_params.rbi +++ b/rbi/stripe/params/customer_create_params.rbi @@ -222,7 +222,7 @@ module Stripe def initialize(ip_address: nil, validate_location: nil); end end class TaxIdDatum < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/customer_funding_instructions_create_params.rbi b/rbi/stripe/params/customer_funding_instructions_create_params.rbi index 11a5739f9..a46011521 100644 --- a/rbi/stripe/params/customer_funding_instructions_create_params.rbi +++ b/rbi/stripe/params/customer_funding_instructions_create_params.rbi @@ -6,7 +6,7 @@ module Stripe class CustomerFundingInstructionsCreateParams < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } diff --git a/rbi/stripe/params/customer_tax_id_create_params.rbi b/rbi/stripe/params/customer_tax_id_create_params.rbi index 4aa3f857d..6bccc0cd0 100644 --- a/rbi/stripe/params/customer_tax_id_create_params.rbi +++ b/rbi/stripe/params/customer_tax_id_create_params.rbi @@ -9,7 +9,7 @@ module Stripe def expand; end sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) } def expand=(_expand); end - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/invoice_create_params.rbi b/rbi/stripe/params/invoice_create_params.rbi index dd3b1e102..e05847dde 100644 --- a/rbi/stripe/params/invoice_create_params.rbi +++ b/rbi/stripe/params/invoice_create_params.rbi @@ -207,7 +207,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } diff --git a/rbi/stripe/params/invoice_create_preview_params.rbi b/rbi/stripe/params/invoice_create_preview_params.rbi index ef71b4ca4..c94422fee 100644 --- a/rbi/stripe/params/invoice_create_preview_params.rbi +++ b/rbi/stripe/params/invoice_create_preview_params.rbi @@ -156,7 +156,7 @@ module Stripe def initialize(ip_address: nil); end end class TaxId < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/invoice_update_params.rbi b/rbi/stripe/params/invoice_update_params.rbi index 2f4bd27e9..97d2f0be5 100644 --- a/rbi/stripe/params/invoice_update_params.rbi +++ b/rbi/stripe/params/invoice_update_params.rbi @@ -193,7 +193,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } diff --git a/rbi/stripe/params/payment_intent_capture_params.rbi b/rbi/stripe/params/payment_intent_capture_params.rbi index c5351adc7..8fbad52f8 100644 --- a/rbi/stripe/params/payment_intent_capture_params.rbi +++ b/rbi/stripe/params/payment_intent_capture_params.rbi @@ -8,7 +8,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -17,7 +17,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -77,7 +77,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -86,7 +86,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -95,7 +95,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -104,7 +104,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCaptureParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -152,7 +152,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -242,7 +242,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { diff --git a/rbi/stripe/params/payment_intent_confirm_params.rbi b/rbi/stripe/params/payment_intent_confirm_params.rbi index 46a9d0dea..4d9d8038a 100644 --- a/rbi/stripe/params/payment_intent_confirm_params.rbi +++ b/rbi/stripe/params/payment_intent_confirm_params.rbi @@ -8,7 +8,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -17,7 +17,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -77,7 +77,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -86,7 +86,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -95,7 +95,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -104,7 +104,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentConfirmParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -152,7 +152,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -242,7 +242,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -2086,7 +2086,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -3192,6 +3192,13 @@ module Stripe def target_date; end sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) } def target_date=(_target_date); end + # The purpose of the transaction. + sig { returns(T.nilable(T.any(String, String))) } + def transaction_purpose; end + sig { + params(_transaction_purpose: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String))) + } + def transaction_purpose=(_transaction_purpose); end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end @@ -3205,7 +3212,7 @@ module Stripe } def preferred_settlement_speed=(_preferred_settlement_speed); end sig { - params(financial_connections: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void + params(financial_connections: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), transaction_purpose: T.nilable(T.any(String, String)), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void } def initialize( financial_connections: nil, @@ -3213,6 +3220,7 @@ module Stripe networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ); end diff --git a/rbi/stripe/params/payment_intent_create_params.rbi b/rbi/stripe/params/payment_intent_create_params.rbi index 611341b8f..3aaf0542b 100644 --- a/rbi/stripe/params/payment_intent_create_params.rbi +++ b/rbi/stripe/params/payment_intent_create_params.rbi @@ -8,7 +8,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -17,7 +17,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -77,7 +77,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -86,7 +86,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -95,7 +95,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -104,7 +104,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentCreateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -152,7 +152,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -242,7 +242,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -2090,7 +2090,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -3196,6 +3196,13 @@ module Stripe def target_date; end sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) } def target_date=(_target_date); end + # The purpose of the transaction. + sig { returns(T.nilable(T.any(String, String))) } + def transaction_purpose; end + sig { + params(_transaction_purpose: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String))) + } + def transaction_purpose=(_transaction_purpose); end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end @@ -3209,7 +3216,7 @@ module Stripe } def preferred_settlement_speed=(_preferred_settlement_speed); end sig { - params(financial_connections: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void + params(financial_connections: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentCreateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), transaction_purpose: T.nilable(T.any(String, String)), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void } def initialize( financial_connections: nil, @@ -3217,6 +3224,7 @@ module Stripe networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ); end diff --git a/rbi/stripe/params/payment_intent_increment_authorization_params.rbi b/rbi/stripe/params/payment_intent_increment_authorization_params.rbi index ba1afe283..3c0894c97 100644 --- a/rbi/stripe/params/payment_intent_increment_authorization_params.rbi +++ b/rbi/stripe/params/payment_intent_increment_authorization_params.rbi @@ -8,7 +8,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -17,7 +17,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -77,7 +77,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -86,7 +86,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -95,7 +95,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -104,7 +104,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentIncrementAuthorizationParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -152,7 +152,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -242,7 +242,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { diff --git a/rbi/stripe/params/payment_intent_update_params.rbi b/rbi/stripe/params/payment_intent_update_params.rbi index 27236c506..6bea84e60 100644 --- a/rbi/stripe/params/payment_intent_update_params.rbi +++ b/rbi/stripe/params/payment_intent_update_params.rbi @@ -8,7 +8,7 @@ module Stripe class LineItem < ::Stripe::RequestParams class PaymentMethodOptions < ::Stripe::RequestParams class Card < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -17,7 +17,7 @@ module Stripe def initialize(commodity_code: nil); end end class CardPresent < ::Stripe::RequestParams - # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc. + # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on. sig { returns(T.nilable(String)) } def commodity_code; end sig { params(_commodity_code: T.nilable(String)).returns(T.nilable(String)) } @@ -77,7 +77,7 @@ module Stripe } def initialize(category: nil, description: nil, sold_by: nil); end end - # This sub-hash contains line item details that are specific to `card` payment method." + # This sub-hash contains line item details that are specific to the `card` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } @@ -86,7 +86,7 @@ module Stripe params(_card: T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)).returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Card)) } def card=(_card); end - # This sub-hash contains line item details that are specific to `card_present` payment method." + # This sub-hash contains line item details that are specific to the `card_present` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } @@ -95,7 +95,7 @@ module Stripe params(_card_present: T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)).returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::CardPresent)) } def card_present=(_card_present); end - # This sub-hash contains line item details that are specific to `klarna` payment method." + # This sub-hash contains line item details that are specific to the `klarna` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } @@ -104,7 +104,7 @@ module Stripe params(_klarna: T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)).returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Klarna)) } def klarna=(_klarna); end - # This sub-hash contains line item details that are specific to `paypal` payment method." + # This sub-hash contains line item details that are specific to the `paypal` payment method. sig { returns(T.nilable(::Stripe::PaymentIntentUpdateParams::AmountDetails::LineItem::PaymentMethodOptions::Paypal)) } @@ -152,7 +152,7 @@ module Stripe def product_code=(_product_code); end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end sig { params(_product_name: String).returns(String) } @@ -242,7 +242,7 @@ module Stripe # # Omit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies. # - # For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks. + # For card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error. sig { returns(T.nilable(T::Boolean)) } def enforce_arithmetic_validation; end sig { @@ -2012,7 +2012,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } @@ -3118,6 +3118,13 @@ module Stripe def target_date; end sig { params(_target_date: T.nilable(String)).returns(T.nilable(String)) } def target_date=(_target_date); end + # The purpose of the transaction. + sig { returns(T.nilable(T.any(String, String))) } + def transaction_purpose; end + sig { + params(_transaction_purpose: T.nilable(T.any(String, String))).returns(T.nilable(T.any(String, String))) + } + def transaction_purpose=(_transaction_purpose); end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end @@ -3131,7 +3138,7 @@ module Stripe } def preferred_settlement_speed=(_preferred_settlement_speed); end sig { - params(financial_connections: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void + params(financial_connections: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::UsBankAccount::Networks), setup_future_usage: T.nilable(T.any(String, String)), target_date: T.nilable(String), transaction_purpose: T.nilable(T.any(String, String)), verification_method: T.nilable(String), preferred_settlement_speed: T.nilable(T.any(String, String))).void } def initialize( financial_connections: nil, @@ -3139,6 +3146,7 @@ module Stripe networks: nil, setup_future_usage: nil, target_date: nil, + transaction_purpose: nil, verification_method: nil, preferred_settlement_speed: nil ); end diff --git a/rbi/stripe/params/payment_link_create_params.rbi b/rbi/stripe/params/payment_link_create_params.rbi index 93a7847f8..6f3ed50ad 100644 --- a/rbi/stripe/params/payment_link_create_params.rbi +++ b/rbi/stripe/params/payment_link_create_params.rbi @@ -141,7 +141,7 @@ module Stripe sig { params(label: String, value: String).void } def initialize(label: nil, value: nil); end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -173,7 +173,7 @@ module Stripe def initialize(custom: nil, type: nil); end end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -194,7 +194,7 @@ module Stripe def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -272,7 +272,7 @@ module Stripe end class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -281,7 +281,7 @@ module Stripe def initialize(message: nil); end end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -290,7 +290,7 @@ module Stripe def initialize(message: nil); end end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -299,7 +299,7 @@ module Stripe def initialize(message: nil); end end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } diff --git a/rbi/stripe/params/payment_link_update_params.rbi b/rbi/stripe/params/payment_link_update_params.rbi index 40a97f808..5e58c30fa 100644 --- a/rbi/stripe/params/payment_link_update_params.rbi +++ b/rbi/stripe/params/payment_link_update_params.rbi @@ -99,7 +99,7 @@ module Stripe sig { params(label: String, value: String).void } def initialize(label: nil, value: nil); end end - # The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array. + # The value that pre-fills the field on the payment page.Must match a `value` in the `options` array. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -131,7 +131,7 @@ module Stripe def initialize(custom: nil, type: nil); end end class Numeric < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -152,7 +152,7 @@ module Stripe def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end end class Text < ::Stripe::RequestParams - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end sig { params(_default_value: T.nilable(String)).returns(T.nilable(String)) } @@ -230,7 +230,7 @@ module Stripe end class CustomText < ::Stripe::RequestParams class AfterSubmit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -239,7 +239,7 @@ module Stripe def initialize(message: nil); end end class ShippingAddress < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -248,7 +248,7 @@ module Stripe def initialize(message: nil); end end class Submit < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -257,7 +257,7 @@ module Stripe def initialize(message: nil); end end class TermsOfServiceAcceptance < ::Stripe::RequestParams - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end sig { params(_message: String).returns(String) } @@ -532,6 +532,52 @@ module Stripe } def initialize(business: nil, individual: nil); end end + class OptionalItem < ::Stripe::RequestParams + class AdjustableQuantity < ::Stripe::RequestParams + # Set to true if the quantity can be adjusted to any non-negative integer. + sig { returns(T::Boolean) } + def enabled; end + sig { params(_enabled: T::Boolean).returns(T::Boolean) } + def enabled=(_enabled); end + # The maximum quantity of this item the customer can purchase. By default this value is 99. + sig { returns(T.nilable(Integer)) } + def maximum; end + sig { params(_maximum: T.nilable(Integer)).returns(T.nilable(Integer)) } + def maximum=(_maximum); end + # The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0. + sig { returns(T.nilable(Integer)) } + def minimum; end + sig { params(_minimum: T.nilable(Integer)).returns(T.nilable(Integer)) } + def minimum=(_minimum); end + sig { + params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void + } + def initialize(enabled: nil, maximum: nil, minimum: nil); end + end + # When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order. + sig { + returns(T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity)) + } + def adjustable_quantity; end + sig { + params(_adjustable_quantity: T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity)).returns(T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity)) + } + def adjustable_quantity=(_adjustable_quantity); end + # The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. + sig { returns(String) } + def price; end + sig { params(_price: String).returns(String) } + def price=(_price); end + # The initial quantity of the line item created when a customer chooses to add this optional item to their order. + sig { returns(Integer) } + def quantity; end + sig { params(_quantity: Integer).returns(Integer) } + def quantity=(_quantity); end + sig { + params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkUpdateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void + } + def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end + end class PaymentIntentData < ::Stripe::RequestParams # An arbitrary string attached to the object. Often useful for displaying to users. sig { returns(T.nilable(String)) } @@ -812,6 +858,17 @@ module Stripe params(_name_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection))).returns(T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection))) } def name_collection=(_name_collection); end + # A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). + # There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. + # There is a maximum of 20 combined line items and optional items. + sig { + returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem]))) + } + def optional_items; end + sig { + params(_optional_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem]))).returns(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem]))) + } + def optional_items=(_optional_items); end # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. sig { returns(T.nilable(::Stripe::PaymentLinkUpdateParams::PaymentIntentData)) } def payment_intent_data; end @@ -880,7 +937,7 @@ module Stripe } def tax_id_collection=(_tax_id_collection); end sig { - params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLinkUpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLinkUpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::CustomField])), custom_text: T.nilable(::Stripe::PaymentLinkUpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkUpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLinkUpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), name_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection)), payment_intent_data: T.nilable(::Stripe::PaymentLinkUpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.any(String, T::Array[String])), phone_number_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::Restrictions)), shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::ShippingAddressCollection)), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkUpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::TaxIdCollection)).void + params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLinkUpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLinkUpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::CustomField])), custom_text: T.nilable(::Stripe::PaymentLinkUpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkUpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLinkUpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), name_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::NameCollection)), optional_items: T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkUpdateParams::OptionalItem])), payment_intent_data: T.nilable(::Stripe::PaymentLinkUpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.any(String, T::Array[String])), phone_number_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::Restrictions)), shipping_address_collection: T.nilable(T.any(String, ::Stripe::PaymentLinkUpdateParams::ShippingAddressCollection)), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkUpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkUpdateParams::TaxIdCollection)).void } def initialize( active: nil, @@ -897,6 +954,7 @@ module Stripe line_items: nil, metadata: nil, name_collection: nil, + optional_items: nil, payment_intent_data: nil, payment_method_collection: nil, payment_method_types: nil, diff --git a/rbi/stripe/params/payment_record_report_payment_attempt_canceled_params.rbi b/rbi/stripe/params/payment_record_report_payment_attempt_canceled_params.rbi index 9a3c88d7d..86a42c686 100644 --- a/rbi/stripe/params/payment_record_report_payment_attempt_canceled_params.rbi +++ b/rbi/stripe/params/payment_record_report_payment_attempt_canceled_params.rbi @@ -14,7 +14,7 @@ module Stripe def expand; end sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) } def expand=(_expand); end - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) } def metadata; end sig { diff --git a/rbi/stripe/params/payment_record_report_payment_attempt_failed_params.rbi b/rbi/stripe/params/payment_record_report_payment_attempt_failed_params.rbi index 41f50370e..015831111 100644 --- a/rbi/stripe/params/payment_record_report_payment_attempt_failed_params.rbi +++ b/rbi/stripe/params/payment_record_report_payment_attempt_failed_params.rbi @@ -14,7 +14,7 @@ module Stripe def failed_at; end sig { params(_failed_at: Integer).returns(Integer) } def failed_at=(_failed_at); end - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) } def metadata; end sig { diff --git a/rbi/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rbi b/rbi/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rbi index 45974ed1a..2f3b253f0 100644 --- a/rbi/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rbi +++ b/rbi/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rbi @@ -14,7 +14,7 @@ module Stripe def guaranteed_at; end sig { params(_guaranteed_at: Integer).returns(Integer) } def guaranteed_at=(_guaranteed_at); end - # Attribute for param field metadata + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. sig { returns(T.nilable(T.any(String, T::Hash[String, String]))) } def metadata; end sig { diff --git a/rbi/stripe/params/promotion_code_create_params.rbi b/rbi/stripe/params/promotion_code_create_params.rbi index 5be9a880a..3b16c093e 100644 --- a/rbi/stripe/params/promotion_code_create_params.rbi +++ b/rbi/stripe/params/promotion_code_create_params.rbi @@ -67,7 +67,7 @@ module Stripe def active; end sig { params(_active: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } def active=(_active); end - # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). # # If left blank, we will generate one automatically. sig { returns(T.nilable(String)) } diff --git a/rbi/stripe/params/subscription_create_params.rbi b/rbi/stripe/params/subscription_create_params.rbi index 1ea1528ad..8ae53c895 100644 --- a/rbi/stripe/params/subscription_create_params.rbi +++ b/rbi/stripe/params/subscription_create_params.rbi @@ -581,7 +581,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } diff --git a/rbi/stripe/params/subscription_item_delete_params.rbi b/rbi/stripe/params/subscription_item_delete_params.rbi index 7057beb09..26583ea74 100644 --- a/rbi/stripe/params/subscription_item_delete_params.rbi +++ b/rbi/stripe/params/subscription_item_delete_params.rbi @@ -9,6 +9,17 @@ module Stripe def clear_usage; end sig { params(_clear_usage: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } def clear_usage=(_clear_usage); end + # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + # + # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + # + # Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). + # + # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. + sig { returns(T.nilable(String)) } + def payment_behavior; end + sig { params(_payment_behavior: T.nilable(String)).returns(T.nilable(String)) } + def payment_behavior=(_payment_behavior); end # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. sig { returns(T.nilable(String)) } def proration_behavior; end @@ -20,8 +31,13 @@ module Stripe sig { params(_proration_date: T.nilable(Integer)).returns(T.nilable(Integer)) } def proration_date=(_proration_date); end sig { - params(clear_usage: T.nilable(T::Boolean), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void + params(clear_usage: T.nilable(T::Boolean), payment_behavior: T.nilable(String), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer)).void } - def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil); end + def initialize( + clear_usage: nil, + payment_behavior: nil, + proration_behavior: nil, + proration_date: nil + ); end end end \ No newline at end of file diff --git a/rbi/stripe/params/subscription_update_params.rbi b/rbi/stripe/params/subscription_update_params.rbi index a18b8d81c..0c729abe9 100644 --- a/rbi/stripe/params/subscription_update_params.rbi +++ b/rbi/stripe/params/subscription_update_params.rbi @@ -571,7 +571,7 @@ module Stripe class CustomerBalance < ::Stripe::RequestParams class BankTransfer < ::Stripe::RequestParams class EuBankTransfer < ::Stripe::RequestParams - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end sig { params(_country: String).returns(String) } diff --git a/rbi/stripe/params/tax/calculation_create_params.rbi b/rbi/stripe/params/tax/calculation_create_params.rbi index 3aaf7122a..5b9e14580 100644 --- a/rbi/stripe/params/tax/calculation_create_params.rbi +++ b/rbi/stripe/params/tax/calculation_create_params.rbi @@ -50,7 +50,7 @@ module Stripe ); end end class TaxId < ::Stripe::RequestParams - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/tax/registration_create_params.rbi b/rbi/stripe/params/tax/registration_create_params.rbi index 42740c8bb..b3c61e452 100644 --- a/rbi/stripe/params/tax/registration_create_params.rbi +++ b/rbi/stripe/params/tax/registration_create_params.rbi @@ -1201,6 +1201,15 @@ module Stripe sig { params(type: String).void } def initialize(type: nil); end end + class Lk < ::Stripe::RequestParams + # Type of registration to be created in `country`. + sig { returns(String) } + def type; end + sig { params(_type: String).returns(String) } + def type=(_type); end + sig { params(type: String).void } + def initialize(type: nil); end + end class Lt < ::Stripe::RequestParams class Standard < ::Stripe::RequestParams # Place of supply scheme used in an EU standard registration. @@ -1945,7 +1954,7 @@ module Stripe end class Us < ::Stripe::RequestParams class LocalAmusementTax < ::Stripe::RequestParams - # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `02154` (Arlington Heights), `06613` (Bloomington), `10906` (Campton Hills), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park). + # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `02154` (Arlington Heights), `05248` (Bensenville), `06613` (Bloomington), `10906` (Campton Hills), `14000` (Chicago), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), `64421` (Riverside), `65806` (Roselle), and `68081` (Schiller Park). sig { returns(String) } def jurisdiction; end sig { params(_jurisdiction: String).returns(String) } @@ -2538,6 +2547,13 @@ module Stripe params(_la: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La)).returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La)) } def la=(_la); end + # Options for the registration in LK. + sig { returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk)) } + def lk; end + sig { + params(_lk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk)).returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk)) + } + def lk=(_lk); end # Options for the registration in LT. sig { returns(T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lt)) } def lt; end @@ -2854,7 +2870,7 @@ module Stripe } def zw=(_zw); end sig { - params(ae: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ae), al: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Al), am: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Am), ao: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ao), at: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::At), au: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Au), aw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Aw), az: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Az), ba: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ba), bb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bb), bd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bd), be: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Be), bf: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bf), bg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bg), bh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bh), bj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bj), bs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bs), by: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::By), ca: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ca), cd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cd), ch: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ch), cl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cl), cm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cm), co: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Co), cr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cr), cv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cv), cy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cy), cz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cz), de: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::De), dk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Dk), ec: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ec), ee: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ee), eg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Eg), es: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Es), et: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Et), fi: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fi), fr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fr), gb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gb), ge: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ge), gn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gn), gr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gr), hr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hr), hu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hu), id: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Id), ie: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ie), in_: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::In), is: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Is), it: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::It), jp: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Jp), ke: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ke), kg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kg), kh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kh), kr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kr), kz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kz), la: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La), lt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lt), lu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lu), lv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lv), ma: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ma), md: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Md), me: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Me), mk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mk), mr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mr), mt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mt), mx: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mx), my: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::My), ng: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ng), nl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nl), no: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::No), np: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Np), nz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nz), om: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Om), pe: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pe), ph: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ph), pl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pl), pt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pt), ro: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ro), rs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Rs), ru: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ru), sa: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sa), se: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Se), sg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sg), si: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Si), sk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sk), sn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sn), sr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sr), th: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Th), tj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tj), tr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tr), tw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tw), tz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tz), ua: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ua), ug: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ug), us: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Us), uy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uy), uz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uz), vn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Vn), za: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Za), zm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zm), zw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zw)).void + params(ae: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ae), al: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Al), am: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Am), ao: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ao), at: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::At), au: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Au), aw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Aw), az: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Az), ba: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ba), bb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bb), bd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bd), be: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Be), bf: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bf), bg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bg), bh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bh), bj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bj), bs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Bs), by: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::By), ca: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ca), cd: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cd), ch: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ch), cl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cl), cm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cm), co: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Co), cr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cr), cv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cv), cy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cy), cz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Cz), de: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::De), dk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Dk), ec: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ec), ee: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ee), eg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Eg), es: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Es), et: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Et), fi: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fi), fr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Fr), gb: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gb), ge: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ge), gn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gn), gr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Gr), hr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hr), hu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Hu), id: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Id), ie: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ie), in_: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::In), is: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Is), it: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::It), jp: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Jp), ke: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ke), kg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kg), kh: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kh), kr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kr), kz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Kz), la: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::La), lk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lk), lt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lt), lu: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lu), lv: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Lv), ma: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ma), md: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Md), me: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Me), mk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mk), mr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mr), mt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mt), mx: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Mx), my: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::My), ng: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ng), nl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nl), no: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::No), np: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Np), nz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Nz), om: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Om), pe: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pe), ph: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ph), pl: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pl), pt: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Pt), ro: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ro), rs: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Rs), ru: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ru), sa: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sa), se: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Se), sg: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sg), si: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Si), sk: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sk), sn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sn), sr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Sr), th: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Th), tj: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tj), tr: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tr), tw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tw), tz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Tz), ua: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ua), ug: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Ug), us: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Us), uy: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uy), uz: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Uz), vn: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Vn), za: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Za), zm: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zm), zw: T.nilable(::Stripe::Tax::RegistrationCreateParams::CountryOptions::Zw)).void } def initialize( ae: nil, @@ -2912,6 +2928,7 @@ module Stripe kr: nil, kz: nil, la: nil, + lk: nil, lt: nil, lu: nil, lv: nil, diff --git a/rbi/stripe/params/tax_id_create_params.rbi b/rbi/stripe/params/tax_id_create_params.rbi index 3ac212e36..1ed145e45 100644 --- a/rbi/stripe/params/tax_id_create_params.rbi +++ b/rbi/stripe/params/tax_id_create_params.rbi @@ -42,7 +42,7 @@ module Stripe params(_owner: T.nilable(::Stripe::TaxIdCreateParams::Owner)).returns(T.nilable(::Stripe::TaxIdCreateParams::Owner)) } def owner=(_owner); end - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` sig { returns(String) } def type; end sig { params(_type: String).returns(String) } diff --git a/rbi/stripe/params/terminal/configuration_create_params.rbi b/rbi/stripe/params/terminal/configuration_create_params.rbi index d579b3308..d720eefb7 100644 --- a/rbi/stripe/params/terminal/configuration_create_params.rbi +++ b/rbi/stripe/params/terminal/configuration_create_params.rbi @@ -23,6 +23,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class Cellular < ::Stripe::RequestParams + # Determines whether to allow the reader to connect to a cellular network. Defaults to false. + sig { returns(T::Boolean) } + def enabled; end + sig { params(_enabled: T::Boolean).returns(T::Boolean) } + def enabled=(_enabled); end + sig { params(enabled: T::Boolean).void } + def initialize(enabled: nil); end + end class Offline < ::Stripe::RequestParams # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. sig { returns(T::Boolean) } @@ -55,6 +64,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class StripeS710 < ::Stripe::RequestParams + # A File ID representing an image you want to display on the reader. + sig { returns(T.nilable(String)) } + def splashscreen; end + sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) } + def splashscreen=(_splashscreen); end + sig { params(splashscreen: T.nilable(String)).void } + def initialize(splashscreen: nil); end + end class Tipping < ::Stripe::RequestParams class Aed < ::Stripe::RequestParams # Fixed amounts displayed when collecting a tip @@ -896,6 +914,15 @@ module Stripe params(_bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE)).returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE)) } def bbpos_wisepos_e=(_bbpos_wisepos_e); end + # Configuration for cellular connectivity. + sig { + returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular))) + } + def cellular; end + sig { + params(_cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular))) + } + def cellular=(_cellular); end # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } def expand; end @@ -929,6 +956,13 @@ module Stripe params(_stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700)).returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700)) } def stripe_s700=(_stripe_s700); end + # An object containing device type specific settings for Stripe S710 readers. + sig { returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710)) } + def stripe_s710; end + sig { + params(_stripe_s710: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710)).returns(T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710)) + } + def stripe_s710=(_stripe_s710); end # Tipping configurations for readers that support on-reader tips. sig { returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Tipping))) @@ -953,16 +987,18 @@ module Stripe } def wifi=(_wifi); end sig { - params(bbpos_wisepad3: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWisepad3), bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Offline)), reboot_window: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::RebootWindow), stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Tipping)), verifone_p400: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::VerifoneP400), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Wifi))).void + params(bbpos_wisepad3: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWisepad3), bbpos_wisepos_e: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::BbposWiseposE), cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Cellular)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Offline)), reboot_window: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::RebootWindow), stripe_s700: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS700), stripe_s710: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::StripeS710), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Tipping)), verifone_p400: T.nilable(::Stripe::Terminal::ConfigurationCreateParams::VerifoneP400), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationCreateParams::Wifi))).void } def initialize( bbpos_wisepad3: nil, bbpos_wisepos_e: nil, + cellular: nil, expand: nil, name: nil, offline: nil, reboot_window: nil, stripe_s700: nil, + stripe_s710: nil, tipping: nil, verifone_p400: nil, wifi: nil diff --git a/rbi/stripe/params/terminal/configuration_update_params.rbi b/rbi/stripe/params/terminal/configuration_update_params.rbi index 94f8b9c1a..3c6599691 100644 --- a/rbi/stripe/params/terminal/configuration_update_params.rbi +++ b/rbi/stripe/params/terminal/configuration_update_params.rbi @@ -23,6 +23,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class Cellular < ::Stripe::RequestParams + # Determines whether to allow the reader to connect to a cellular network. Defaults to false. + sig { returns(T::Boolean) } + def enabled; end + sig { params(_enabled: T::Boolean).returns(T::Boolean) } + def enabled=(_enabled); end + sig { params(enabled: T::Boolean).void } + def initialize(enabled: nil); end + end class Offline < ::Stripe::RequestParams # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. sig { returns(T::Boolean) } @@ -55,6 +64,15 @@ module Stripe sig { params(splashscreen: T.nilable(String)).void } def initialize(splashscreen: nil); end end + class StripeS710 < ::Stripe::RequestParams + # A File ID representing an image you want to display on the reader. + sig { returns(T.nilable(String)) } + def splashscreen; end + sig { params(_splashscreen: T.nilable(String)).returns(T.nilable(String)) } + def splashscreen=(_splashscreen); end + sig { params(splashscreen: T.nilable(String)).void } + def initialize(splashscreen: nil); end + end class Tipping < ::Stripe::RequestParams class Aed < ::Stripe::RequestParams # Fixed amounts displayed when collecting a tip @@ -900,6 +918,15 @@ module Stripe params(_bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE))) } def bbpos_wisepos_e=(_bbpos_wisepos_e); end + # Configuration for cellular connectivity. + sig { + returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular))) + } + def cellular; end + sig { + params(_cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular))) + } + def cellular=(_cellular); end # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } def expand; end @@ -937,7 +964,16 @@ module Stripe params(_stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700))) } def stripe_s700=(_stripe_s700); end - # Tipping configurations for readers. supporting on-reader tips + # An object containing device type specific settings for Stripe S710 readers. + sig { + returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710))) + } + def stripe_s710; end + sig { + params(_stripe_s710: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710))).returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710))) + } + def stripe_s710=(_stripe_s710); end + # Tipping configurations for readers that support on-reader tips. sig { returns(T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Tipping))) } @@ -963,16 +999,18 @@ module Stripe } def wifi=(_wifi); end sig { - params(bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWisepad3)), bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Offline)), reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::RebootWindow)), stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700)), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Tipping)), verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::VerifoneP400)), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Wifi))).void + params(bbpos_wisepad3: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWisepad3)), bbpos_wisepos_e: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::BbposWiseposE)), cellular: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Cellular)), expand: T.nilable(T::Array[String]), name: T.nilable(String), offline: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Offline)), reboot_window: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::RebootWindow)), stripe_s700: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS700)), stripe_s710: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::StripeS710)), tipping: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Tipping)), verifone_p400: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::VerifoneP400)), wifi: T.nilable(T.any(String, ::Stripe::Terminal::ConfigurationUpdateParams::Wifi))).void } def initialize( bbpos_wisepad3: nil, bbpos_wisepos_e: nil, + cellular: nil, expand: nil, name: nil, offline: nil, reboot_window: nil, stripe_s700: nil, + stripe_s710: nil, tipping: nil, verifone_p400: nil, wifi: nil diff --git a/rbi/stripe/resources/charge.rbi b/rbi/stripe/resources/charge.rbi index a9efe7a5f..98b87e88f 100644 --- a/rbi/stripe/resources/charge.rbi +++ b/rbi/stripe/resources/charge.rbi @@ -1084,6 +1084,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -1102,6 +1105,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -1333,6 +1339,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -1345,6 +1354,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end diff --git a/rbi/stripe/resources/checkout/session.rbi b/rbi/stripe/resources/checkout/session.rbi index 933b9cafc..dd6e19f4d 100644 --- a/rbi/stripe/resources/checkout/session.rbi +++ b/rbi/stripe/resources/checkout/session.rbi @@ -300,7 +300,7 @@ module Stripe @field_remappings = {} end end - # The value that will pre-fill on the payment page. + # The value that pre-fills on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The options available for the customer to select. Up to 200 options allowed. @@ -331,7 +331,7 @@ module Stripe end end class Numeric < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -351,7 +351,7 @@ module Stripe end end class Text < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -400,7 +400,7 @@ module Stripe end class CustomText < ::Stripe::StripeObject class AfterSubmit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -411,7 +411,7 @@ module Stripe end end class ShippingAddress < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -422,7 +422,7 @@ module Stripe end end class Submit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -433,7 +433,7 @@ module Stripe end end class TermsOfServiceAcceptance < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -495,7 +495,7 @@ module Stripe end end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. @@ -1068,7 +1068,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types diff --git a/rbi/stripe/resources/confirmation_token.rbi b/rbi/stripe/resources/confirmation_token.rbi index 0bbaa6450..3b4b79dd1 100644 --- a/rbi/stripe/resources/confirmation_token.rbi +++ b/rbi/stripe/resources/confirmation_token.rbi @@ -420,6 +420,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -438,6 +441,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end diff --git a/rbi/stripe/resources/invoice.rbi b/rbi/stripe/resources/invoice.rbi index 72c3fb54c..9edd06867 100644 --- a/rbi/stripe/resources/invoice.rbi +++ b/rbi/stripe/resources/invoice.rbi @@ -177,7 +177,7 @@ module Stripe end end class CustomerTaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. @@ -425,7 +425,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types @@ -1019,7 +1019,7 @@ module Stripe # Attribute for field payment_settings sig { returns(PaymentSettings) } def payment_settings; end - # Payments for this invoice + # Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details. sig { returns(T.nilable(::Stripe::ListObject)) } def payments; end # End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. diff --git a/rbi/stripe/resources/mandate.rbi b/rbi/stripe/resources/mandate.rbi index e6e6888e8..594c59b67 100644 --- a/rbi/stripe/resources/mandate.rbi +++ b/rbi/stripe/resources/mandate.rbi @@ -96,6 +96,9 @@ module Stripe end end class BacsDebit < ::Stripe::StripeObject + # The display name for the account on this mandate. + sig { returns(T.nilable(String)) } + def display_name; end # The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. sig { returns(String) } def network_status; end @@ -105,6 +108,9 @@ module Stripe # When the mandate is revoked on the Bacs network this field displays the reason for the revocation. sig { returns(T.nilable(String)) } def revocation_reason; end + # The service user number for the account on this mandate. + sig { returns(T.nilable(String)) } + def service_user_number; end # The URL that will contain the mandate that the customer has signed. sig { returns(String) } def url; end diff --git a/rbi/stripe/resources/payment_attempt_record.rbi b/rbi/stripe/resources/payment_attempt_record.rbi index 0459e7559..4aed1267e 100644 --- a/rbi/stripe/resources/payment_attempt_record.rbi +++ b/rbi/stripe/resources/payment_attempt_record.rbi @@ -203,10 +203,10 @@ module Stripe end end class Affirm < ::Stripe::StripeObject - # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + # ID of the location that this reader is assigned to. sig { returns(T.nilable(String)) } def location; end - # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + # ID of the reader this transaction was made on. sig { returns(T.nilable(String)) } def reader; end # The Affirm transaction ID associated with this payment. @@ -223,7 +223,7 @@ module Stripe # The Afterpay order ID associated with this payment intent. sig { returns(T.nilable(String)) } def order_id; end - # Order identifier shown to the merchant in Afterpay’s online portal. + # Order identifier shown to the merchant in Afterpay's online portal. sig { returns(T.nilable(String)) } def reference; end def self.inner_class_types @@ -394,12 +394,10 @@ module Stripe # Last four characters of the IBAN. sig { returns(T.nilable(String)) } def iban_last4; end - # Preferred language of the Bancontact authorization page that the customer is redirected to. - # Can be one of `en`, `de`, `fr`, or `nl` + # Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` sig { returns(T.nilable(String)) } def preferred_language; end - # Owner's verified full name. Values are verified or provided by Bancontact directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. + # Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -479,7 +477,7 @@ module Stripe end class Boleto < ::Stripe::StripeObject # The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) - sig { returns(String) } + sig { returns(T.nilable(String)) } def tax_id; end def self.inner_class_types @inner_class_types = {} @@ -490,13 +488,13 @@ module Stripe end class Card < ::Stripe::StripeObject class Checks < ::Stripe::StripeObject - # Attribute for field address_line1_check + # If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_line1_check; end - # Attribute for field address_postal_code_check + # If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_postal_code_check; end - # Attribute for field cvc_check + # If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def cvc_check; end def self.inner_class_types @@ -524,7 +522,7 @@ module Stripe @field_remappings = {} end end - # Attribute for field plan + # Installment plan selected for the payment. sig { returns(T.nilable(Plan)) } def plan; end def self.inner_class_types @@ -546,16 +544,16 @@ module Stripe end end class ThreeDSecure < ::Stripe::StripeObject - # Attribute for field authentication_flow + # For authenticated transactions: Indicates how the issuing bank authenticated the customer. sig { returns(T.nilable(String)) } def authentication_flow; end - # Attribute for field result + # Indicates the outcome of 3D Secure authentication. sig { returns(T.nilable(String)) } def result; end - # Attribute for field result_reason + # Additional information about why 3D Secure succeeded or failed, based on the `result`. sig { returns(T.nilable(String)) } def result_reason; end - # Attribute for field version + # The version of 3D Secure that was used. sig { returns(T.nilable(String)) } def version; end def self.inner_class_types @@ -802,6 +800,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -820,6 +821,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -840,7 +844,7 @@ module Stripe # A public identifier for buyers using Cash App. sig { returns(T.nilable(String)) } def cashtag; end - # A unique and immutable identifier of payments assigned by Cash App + # A unique and immutable identifier of payments assigned by Cash App. sig { returns(T.nilable(String)) } def transaction_id; end def self.inner_class_types @@ -935,9 +939,7 @@ module Stripe # Bank Identifier Code of the bank associated with the bank account. sig { returns(T.nilable(String)) } def bic; end - # Owner's verified full name. Values are verified or provided by Giropay directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. - # Giropay rarely provides this information so the attribute is usually empty. + # Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -1065,6 +1067,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -1077,6 +1082,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end diff --git a/rbi/stripe/resources/payment_intent.rbi b/rbi/stripe/resources/payment_intent.rbi index 3673e8225..804c7348e 100644 --- a/rbi/stripe/resources/payment_intent.rbi +++ b/rbi/stripe/resources/payment_intent.rbi @@ -1811,7 +1811,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types @@ -2545,6 +2545,9 @@ module Stripe # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. sig { returns(T.nilable(String)) } def target_date; end + # The purpose of the transaction. + sig { returns(T.nilable(String)) } + def transaction_purpose; end # Bank account verification method. sig { returns(T.nilable(String)) } def verification_method; end diff --git a/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi b/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi index 2b9fbb4af..89f776ffa 100644 --- a/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi +++ b/rbi/stripe/resources/payment_intent_amount_details_line_item.rbi @@ -115,7 +115,7 @@ module Stripe def product_code; end # The product name of the line item. Required for L3 rates. At most 1024 characters long. # - # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters. + # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. sig { returns(String) } def product_name; end # The quantity of items. Required for L3 rates. An integer greater than 0. diff --git a/rbi/stripe/resources/payment_link.rbi b/rbi/stripe/resources/payment_link.rbi index 10bed2c4a..1f27a4ef9 100644 --- a/rbi/stripe/resources/payment_link.rbi +++ b/rbi/stripe/resources/payment_link.rbi @@ -122,7 +122,7 @@ module Stripe @field_remappings = {} end end - # The value that will pre-fill on the payment page. + # The value that pre-fills on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The options available for the customer to select. Up to 200 options allowed. @@ -150,7 +150,7 @@ module Stripe end end class Numeric < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -167,7 +167,7 @@ module Stripe end end class Text < ::Stripe::StripeObject - # The value that will pre-fill the field on the payment page. + # The value that pre-fills the field on the payment page. sig { returns(T.nilable(String)) } def default_value; end # The maximum character length constraint for the customer's input. @@ -213,7 +213,7 @@ module Stripe end class CustomText < ::Stripe::StripeObject class AfterSubmit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -224,7 +224,7 @@ module Stripe end end class ShippingAddress < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -235,7 +235,7 @@ module Stripe end end class Submit < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types @@ -246,7 +246,7 @@ module Stripe end end class TermsOfServiceAcceptance < ::Stripe::StripeObject - # Text may be up to 1200 characters in length. + # Text can be up to 1200 characters in length. sig { returns(String) } def message; end def self.inner_class_types diff --git a/rbi/stripe/resources/payment_method.rbi b/rbi/stripe/resources/payment_method.rbi index 40c90e328..c66dbd4e3 100644 --- a/rbi/stripe/resources/payment_method.rbi +++ b/rbi/stripe/resources/payment_method.rbi @@ -324,6 +324,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -342,6 +345,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end diff --git a/rbi/stripe/resources/payment_record.rbi b/rbi/stripe/resources/payment_record.rbi index 192419da2..3d0503872 100644 --- a/rbi/stripe/resources/payment_record.rbi +++ b/rbi/stripe/resources/payment_record.rbi @@ -203,10 +203,10 @@ module Stripe end end class Affirm < ::Stripe::StripeObject - # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + # ID of the location that this reader is assigned to. sig { returns(T.nilable(String)) } def location; end - # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + # ID of the reader this transaction was made on. sig { returns(T.nilable(String)) } def reader; end # The Affirm transaction ID associated with this payment. @@ -223,7 +223,7 @@ module Stripe # The Afterpay order ID associated with this payment intent. sig { returns(T.nilable(String)) } def order_id; end - # Order identifier shown to the merchant in Afterpay’s online portal. + # Order identifier shown to the merchant in Afterpay's online portal. sig { returns(T.nilable(String)) } def reference; end def self.inner_class_types @@ -394,12 +394,10 @@ module Stripe # Last four characters of the IBAN. sig { returns(T.nilable(String)) } def iban_last4; end - # Preferred language of the Bancontact authorization page that the customer is redirected to. - # Can be one of `en`, `de`, `fr`, or `nl` + # Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` sig { returns(T.nilable(String)) } def preferred_language; end - # Owner's verified full name. Values are verified or provided by Bancontact directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. + # Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -479,7 +477,7 @@ module Stripe end class Boleto < ::Stripe::StripeObject # The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) - sig { returns(String) } + sig { returns(T.nilable(String)) } def tax_id; end def self.inner_class_types @inner_class_types = {} @@ -490,13 +488,13 @@ module Stripe end class Card < ::Stripe::StripeObject class Checks < ::Stripe::StripeObject - # Attribute for field address_line1_check + # If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_line1_check; end - # Attribute for field address_postal_code_check + # If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def address_postal_code_check; end - # Attribute for field cvc_check + # If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. sig { returns(T.nilable(String)) } def cvc_check; end def self.inner_class_types @@ -524,7 +522,7 @@ module Stripe @field_remappings = {} end end - # Attribute for field plan + # Installment plan selected for the payment. sig { returns(T.nilable(Plan)) } def plan; end def self.inner_class_types @@ -546,16 +544,16 @@ module Stripe end end class ThreeDSecure < ::Stripe::StripeObject - # Attribute for field authentication_flow + # For authenticated transactions: Indicates how the issuing bank authenticated the customer. sig { returns(T.nilable(String)) } def authentication_flow; end - # Attribute for field result + # Indicates the outcome of 3D Secure authentication. sig { returns(T.nilable(String)) } def result; end - # Attribute for field result_reason + # Additional information about why 3D Secure succeeded or failed, based on the `result`. sig { returns(T.nilable(String)) } def result_reason; end - # Attribute for field version + # The version of 3D Secure that was used. sig { returns(T.nilable(String)) } def version; end def self.inner_class_types @@ -802,6 +800,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -820,6 +821,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end @@ -840,7 +844,7 @@ module Stripe # A public identifier for buyers using Cash App. sig { returns(T.nilable(String)) } def cashtag; end - # A unique and immutable identifier of payments assigned by Cash App + # A unique and immutable identifier of payments assigned by Cash App. sig { returns(T.nilable(String)) } def transaction_id; end def self.inner_class_types @@ -935,9 +939,7 @@ module Stripe # Bank Identifier Code of the bank associated with the bank account. sig { returns(T.nilable(String)) } def bic; end - # Owner's verified full name. Values are verified or provided by Giropay directly - # (if supported) at the time of authorization or settlement. They cannot be set or mutated. - # Giropay rarely provides this information so the attribute is usually empty. + # Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. sig { returns(T.nilable(String)) } def verified_name; end def self.inner_class_types @@ -1065,6 +1067,9 @@ module Stripe # The last four digits of the card. sig { returns(T.nilable(String)) } def last4; end + # ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(T.nilable(String)) } + def location; end # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. sig { returns(T.nilable(String)) } def network; end @@ -1077,6 +1082,9 @@ module Stripe # How card details were read in this transaction. sig { returns(T.nilable(String)) } def read_method; end + # ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. + sig { returns(T.nilable(String)) } + def reader; end # A collection of fields required to be displayed on receipts. Only required for EMV transactions. sig { returns(T.nilable(Receipt)) } def receipt; end diff --git a/rbi/stripe/resources/promotion_code.rbi b/rbi/stripe/resources/promotion_code.rbi index e36af7c4f..69e1f876a 100644 --- a/rbi/stripe/resources/promotion_code.rbi +++ b/rbi/stripe/resources/promotion_code.rbi @@ -57,7 +57,7 @@ module Stripe # Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. sig { returns(T::Boolean) } def active; end - # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). sig { returns(String) } def code; end # Time at which the object was created. Measured in seconds since the Unix epoch. diff --git a/rbi/stripe/resources/radar/payment_evaluation.rbi b/rbi/stripe/resources/radar/payment_evaluation.rbi index 3f72eb986..ca1c1e8e5 100644 --- a/rbi/stripe/resources/radar/payment_evaluation.rbi +++ b/rbi/stripe/resources/radar/payment_evaluation.rbi @@ -163,20 +163,6 @@ module Stripe end end class Insights < ::Stripe::StripeObject - class CardIssuerDecline < ::Stripe::StripeObject - # Stripe Radar's evaluation of the likelihood that the payment will be declined by the card issuer. Scores range from 0 to 100, with higher values indicating a higher likelihood of decline. - sig { returns(Float) } - def model_score; end - # Recommended action based on the model score. Possible values are `block` and `continue`. - sig { returns(String) } - def recommended_action; end - def self.inner_class_types - @inner_class_types = {} - end - def self.field_remappings - @field_remappings = {} - end - end class FraudulentDispute < ::Stripe::StripeObject # Recommended action based on the risk score. Possible values are `block` and `continue`. sig { returns(String) } @@ -191,9 +177,6 @@ module Stripe @field_remappings = {} end end - # Stripe Radar's evaluation of the likelihood of a card issuer decline on this payment. - sig { returns(T.nilable(CardIssuerDecline)) } - def card_issuer_decline; end # The timestamp when the evaluation was performed. sig { returns(Integer) } def evaluated_at; end @@ -201,10 +184,7 @@ module Stripe sig { returns(FraudulentDispute) } def fraudulent_dispute; end def self.inner_class_types - @inner_class_types = { - card_issuer_decline: CardIssuerDecline, - fraudulent_dispute: FraudulentDispute, - } + @inner_class_types = {fraudulent_dispute: FraudulentDispute} end def self.field_remappings @field_remappings = {} diff --git a/rbi/stripe/resources/reserve/hold.rbi b/rbi/stripe/resources/reserve/hold.rbi new file mode 100644 index 000000000..f6e6fcc28 --- /dev/null +++ b/rbi/stripe/resources/reserve/hold.rbi @@ -0,0 +1,70 @@ +# File generated from our OpenAPI spec +# frozen_string_literal: true + +# typed: true +module Stripe + module Reserve + # ReserveHolds are used to place a temporary ReserveHold on a merchant's funds. + class Hold < APIResource + class ReleaseSchedule < ::Stripe::StripeObject + # The time after which the ReserveHold is requested to be released. + sig { returns(T.nilable(Integer)) } + def release_after; end + # The time at which the ReserveHold is scheduled to be released, automatically set to midnight UTC of the day after `release_after`. + sig { returns(T.nilable(Integer)) } + def scheduled_release; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + # Amount reserved. A positive integer representing how much is reserved in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). + sig { returns(Integer) } + def amount; end + # Amount in cents that can be released from this ReserveHold + sig { returns(T.nilable(Integer)) } + def amount_releasable; end + # Time at which the object was created. Measured in seconds since the Unix epoch. + sig { returns(Integer) } + def created; end + # Indicates which party created this ReserveHold. + sig { returns(String) } + def created_by; end + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + sig { returns(String) } + def currency; end + # Unique identifier for the object. + sig { returns(String) } + def id; end + # Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven't been fully released yet. + sig { returns(T.nilable(T::Boolean)) } + def is_releasable; end + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + sig { returns(T::Boolean) } + def livemode; end + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + sig { returns(T.nilable(T::Hash[String, String])) } + def metadata; end + # String representing the object's type. Objects of the same type share the same value. + sig { returns(String) } + def object; end + # The reason for the ReserveHold. + sig { returns(String) } + def reason; end + # Attribute for field release_schedule + sig { returns(ReleaseSchedule) } + def release_schedule; end + # The ReservePlan which produced this ReserveHold (i.e., resplan_123) + sig { returns(T.nilable(T.any(String, ::Stripe::Reserve::Plan))) } + def reserve_plan; end + # The Charge which funded this ReserveHold (e.g., ch_123) + sig { returns(T.nilable(T.any(String, ::Stripe::Charge))) } + def source_charge; end + # Which source balance type this ReserveHold reserves funds from. One of `bank_account`, `card`, or `fpx`. + sig { returns(String) } + def source_type; end + end + end +end \ No newline at end of file diff --git a/rbi/stripe/resources/reserve/plan.rbi b/rbi/stripe/resources/reserve/plan.rbi new file mode 100644 index 000000000..706dfb69d --- /dev/null +++ b/rbi/stripe/resources/reserve/plan.rbi @@ -0,0 +1,78 @@ +# File generated from our OpenAPI spec +# frozen_string_literal: true + +# typed: true +module Stripe + module Reserve + # ReservePlans are used to automatically place holds on a merchant's funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account). + class Plan < APIResource + class FixedRelease < ::Stripe::StripeObject + # The time after which all reserved funds are requested for release. + sig { returns(Integer) } + def release_after; end + # The time at which reserved funds are scheduled for release, automatically set to midnight UTC of the day after `release_after`. + sig { returns(Integer) } + def scheduled_release; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + class RollingRelease < ::Stripe::StripeObject + # The number of days to reserve funds before releasing. + sig { returns(Integer) } + def days_after_charge; end + # The time at which the ReservePlan expires. + sig { returns(T.nilable(Integer)) } + def expires_on; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + # Time at which the object was created. Measured in seconds since the Unix epoch. + sig { returns(Integer) } + def created; end + # Indicates which party created this ReservePlan. + sig { returns(String) } + def created_by; end + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). An unset currency indicates that the plan applies to all currencies. + sig { returns(T.nilable(String)) } + def currency; end + # Time at which the ReservePlan was disabled. + sig { returns(T.nilable(Integer)) } + def disabled_at; end + # Attribute for field fixed_release + sig { returns(T.nilable(FixedRelease)) } + def fixed_release; end + # Unique identifier for the object. + sig { returns(String) } + def id; end + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + sig { returns(T::Boolean) } + def livemode; end + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + sig { returns(T.nilable(T::Hash[String, String])) } + def metadata; end + # String representing the object's type. Objects of the same type share the same value. + sig { returns(String) } + def object; end + # The percent of each Charge to reserve. + sig { returns(Integer) } + def percent; end + # Attribute for field rolling_release + sig { returns(T.nilable(RollingRelease)) } + def rolling_release; end + # The current status of the ReservePlan. The ReservePlan only affects charges if it is `active`. + sig { returns(String) } + def status; end + # The type of the ReservePlan. + sig { returns(String) } + def type; end + end + end +end \ No newline at end of file diff --git a/rbi/stripe/resources/reserve/release.rbi b/rbi/stripe/resources/reserve/release.rbi new file mode 100644 index 000000000..f7d863ccb --- /dev/null +++ b/rbi/stripe/resources/reserve/release.rbi @@ -0,0 +1,67 @@ +# File generated from our OpenAPI spec +# frozen_string_literal: true + +# typed: true +module Stripe + module Reserve + # ReserveReleases represent the release of funds from a ReserveHold. + class Release < APIResource + class SourceTransaction < ::Stripe::StripeObject + # The ID of the dispute. + sig { returns(T.nilable(T.any(String, ::Stripe::Dispute))) } + def dispute; end + # The ID of the refund. + sig { returns(T.nilable(T.any(String, ::Stripe::Refund))) } + def refund; end + # The type of source transaction. + sig { returns(String) } + def type; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end + # Amount released. A positive integer representing how much is released in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). + sig { returns(Integer) } + def amount; end + # Time at which the object was created. Measured in seconds since the Unix epoch. + sig { returns(Integer) } + def created; end + # Indicates which party created this ReserveRelease. + sig { returns(String) } + def created_by; end + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + sig { returns(String) } + def currency; end + # Unique identifier for the object. + sig { returns(String) } + def id; end + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + sig { returns(T::Boolean) } + def livemode; end + # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + sig { returns(T.nilable(T::Hash[String, String])) } + def metadata; end + # String representing the object's type. Objects of the same type share the same value. + sig { returns(String) } + def object; end + # The reason for the ReserveRelease, indicating why the funds were released. + sig { returns(String) } + def reason; end + # The release timestamp of the funds. + sig { returns(Integer) } + def released_at; end + # The ReserveHold this ReserveRelease is associated with. + sig { returns(T.nilable(T.any(String, ::Stripe::Reserve::Hold))) } + def reserve_hold; end + # The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry. + sig { returns(T.nilable(T.any(String, ::Stripe::Reserve::Plan))) } + def reserve_plan; end + # Attribute for field source_transaction + sig { returns(T.nilable(SourceTransaction)) } + def source_transaction; end + end + end +end \ No newline at end of file diff --git a/rbi/stripe/resources/subscription.rbi b/rbi/stripe/resources/subscription.rbi index d23fe8711..8c602cf7a 100644 --- a/rbi/stripe/resources/subscription.rbi +++ b/rbi/stripe/resources/subscription.rbi @@ -237,7 +237,7 @@ module Stripe class CustomerBalance < ::Stripe::StripeObject class BankTransfer < ::Stripe::StripeObject class EuBankTransfer < ::Stripe::StripeObject - # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + # The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. sig { returns(String) } def country; end def self.inner_class_types @@ -478,7 +478,7 @@ module Stripe @field_remappings = {} end end - # Defines how a subscription behaves when a free trial ends. + # Defines how a subscription behaves when a trial ends. sig { returns(EndBehavior) } def end_behavior; end def self.inner_class_types @@ -697,13 +697,13 @@ module Stripe } def self.migrate(subscription, params = {}, opts = {}); end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. sig { params(params: T.any(::Stripe::SubscriptionResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::Subscription) } def resume(params = {}, opts = {}); end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. sig { params(subscription: String, params: T.any(::Stripe::SubscriptionResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::Subscription) } diff --git a/rbi/stripe/resources/tax/calculation.rbi b/rbi/stripe/resources/tax/calculation.rbi index 175c070ab..a503dbf33 100644 --- a/rbi/stripe/resources/tax/calculation.rbi +++ b/rbi/stripe/resources/tax/calculation.rbi @@ -36,7 +36,7 @@ module Stripe end end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. diff --git a/rbi/stripe/resources/tax/registration.rbi b/rbi/stripe/resources/tax/registration.rbi index 3e6582714..6381760db 100644 --- a/rbi/stripe/resources/tax/registration.rbi +++ b/rbi/stripe/resources/tax/registration.rbi @@ -924,6 +924,17 @@ module Stripe @field_remappings = {} end end + class Lk < ::Stripe::StripeObject + # Type of registration in `country`. + sig { returns(String) } + def type; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end class Lt < ::Stripe::StripeObject class Standard < ::Stripe::StripeObject # Place of supply scheme used in an EU standard registration. @@ -1843,6 +1854,9 @@ module Stripe # Attribute for field la sig { returns(T.nilable(La)) } def la; end + # Attribute for field lk + sig { returns(T.nilable(Lk)) } + def lk; end # Attribute for field lt sig { returns(T.nilable(Lt)) } def lt; end @@ -2035,6 +2049,7 @@ module Stripe kr: Kr, kz: Kz, la: La, + lk: Lk, lt: Lt, lu: Lu, lv: Lv, diff --git a/rbi/stripe/resources/tax/transaction.rbi b/rbi/stripe/resources/tax/transaction.rbi index 5a2d1c90b..770904396 100644 --- a/rbi/stripe/resources/tax/transaction.rbi +++ b/rbi/stripe/resources/tax/transaction.rbi @@ -36,7 +36,7 @@ module Stripe end end class TaxId < ::Stripe::StripeObject - # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` + # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` sig { returns(String) } def type; end # The value of the tax ID. diff --git a/rbi/stripe/resources/tax_id.rbi b/rbi/stripe/resources/tax_id.rbi index 0bc953d74..e0e158ae4 100644 --- a/rbi/stripe/resources/tax_id.rbi +++ b/rbi/stripe/resources/tax_id.rbi @@ -72,7 +72,7 @@ module Stripe # The account or customer the tax ID belongs to. sig { returns(T.nilable(Owner)) } def owner; end - # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` + # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` sig { returns(String) } def type; end # Value of the tax ID. diff --git a/rbi/stripe/resources/terminal/configuration.rbi b/rbi/stripe/resources/terminal/configuration.rbi index b7265765a..c76f0e2d2 100644 --- a/rbi/stripe/resources/terminal/configuration.rbi +++ b/rbi/stripe/resources/terminal/configuration.rbi @@ -29,6 +29,17 @@ module Stripe @field_remappings = {} end end + class Cellular < ::Stripe::StripeObject + # Whether a cellular-capable reader can connect to the internet over cellular. + sig { returns(T::Boolean) } + def enabled; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end class Offline < ::Stripe::StripeObject # Determines whether to allow transactions to be collected while reader is offline. Defaults to false. sig { returns(T.nilable(T::Boolean)) } @@ -65,6 +76,17 @@ module Stripe @field_remappings = {} end end + class StripeS710 < ::Stripe::StripeObject + # A File ID representing an image to display on the reader + sig { returns(T.nilable(T.any(String, ::Stripe::File))) } + def splashscreen; end + def self.inner_class_types + @inner_class_types = {} + end + def self.field_remappings + @field_remappings = {} + end + end class Tipping < ::Stripe::StripeObject class Aed < ::Stripe::StripeObject # Fixed amounts displayed when collecting a tip @@ -613,6 +635,9 @@ module Stripe # Attribute for field bbpos_wisepos_e sig { returns(T.nilable(BbposWiseposE)) } def bbpos_wisepos_e; end + # Attribute for field cellular + sig { returns(T.nilable(Cellular)) } + def cellular; end # Unique identifier for the object. sig { returns(String) } def id; end @@ -637,6 +662,9 @@ module Stripe # Attribute for field stripe_s700 sig { returns(T.nilable(StripeS700)) } def stripe_s700; end + # Attribute for field stripe_s710 + sig { returns(T.nilable(StripeS710)) } + def stripe_s710; end # Attribute for field tipping sig { returns(T.nilable(Tipping)) } def tipping; end diff --git a/rbi/stripe/resources/v2/billing/meter_event.rbi b/rbi/stripe/resources/v2/billing/meter_event.rbi index 64745d229..5365a4860 100644 --- a/rbi/stripe/resources/v2/billing/meter_event.rbi +++ b/rbi/stripe/resources/v2/billing/meter_event.rbi @@ -5,7 +5,7 @@ module Stripe module V2 module Billing - # Fix me empty_doc_string. + # A Meter Event is a usage record that captures billable activity for usage-based billing. Meter Events contain an event name, timestamp, and payload with customer mapping and usage value, enabling accurate usage tracking and billing. class MeterEvent < APIResource # The creation time of this meter event. sig { returns(String) } diff --git a/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi b/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi index adf288ea1..55285c256 100644 --- a/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +++ b/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi @@ -5,6 +5,7 @@ module Stripe module V2 module Billing + # A Meter Event Adjustment is used to cancel or modify previously recorded meter events. Meter Event Adjustments allow you to correct billing data by canceling individual events or event ranges, with tracking of adjustment status and creation time. class MeterEventAdjustment < APIResource class Cancel < ::Stripe::StripeObject # Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them. diff --git a/rbi/stripe/resources/v2/billing/meter_event_session.rbi b/rbi/stripe/resources/v2/billing/meter_event_session.rbi index 7b4bea274..fbca85609 100644 --- a/rbi/stripe/resources/v2/billing/meter_event_session.rbi +++ b/rbi/stripe/resources/v2/billing/meter_event_session.rbi @@ -5,6 +5,7 @@ module Stripe module V2 module Billing + # A Meter Event Session is an authentication session for the high-throughput meter event API. Meter Event Sessions provide temporary authentication tokens with expiration times, enabling secure and efficient bulk submission of usage events. class MeterEventSession < APIResource # The authentication token for this session. Use this token when calling the # high-throughput meter event API. diff --git a/rbi/stripe/resources/v2/core/account.rbi b/rbi/stripe/resources/v2/core/account.rbi index 9dd384c5f..8a03a7350 100644 --- a/rbi/stripe/resources/v2/core/account.rbi +++ b/rbi/stripe/resources/v2/core/account.rbi @@ -5,7 +5,9 @@ module Stripe module V2 module Core - # A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products. + # An Account v2 object represents a company, individual, or other entity that interacts with a platform on Stripe. It contains both identifying information and properties that control its behavior and functionality. An Account can have one or more configurations that enable sets of related features, such as allowing it to act as a merchant or customer. + # The Accounts v2 API supports both the Global Payouts preview feature and the Connect-Billing integration preview feature. However, a particular Account can only access one of them. + # The Connect-Billing integration preview feature allows an Account v2 to pay subscription fees to a platform. An Account v1 required a separate Customer object to pay subscription fees. class Account < APIResource class Configuration < ::Stripe::StripeObject class Customer < ::Stripe::StripeObject diff --git a/rbi/stripe/services/subscription_service.rbi b/rbi/stripe/services/subscription_service.rbi index c019fba32..2d7768ff8 100644 --- a/rbi/stripe/services/subscription_service.rbi +++ b/rbi/stripe/services/subscription_service.rbi @@ -44,7 +44,7 @@ module Stripe } def migrate(subscription, params = {}, opts = {}); end - # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date. + # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused. sig { params(subscription: String, params: T.any(::Stripe::SubscriptionResumeParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::Subscription) } diff --git a/test/stripe/request_params_test.rb b/test/stripe/request_params_test.rb index 09f8990a9..f16b22d24 100644 --- a/test/stripe/request_params_test.rb +++ b/test/stripe/request_params_test.rb @@ -269,5 +269,77 @@ def initialize(games: nil) assert_equal expected, params.to_h end end + + context "V2 RequestParams explicit key tracking" do + should "only serialize explicitly set fields for V2 classes" do + params = Stripe::V2::Billing::MeterEventCreateParams.new( + event_name: "my_event", + payload: { stripe_customer_id: "cus_123", value: "25" } + ) + + result = params.to_h + + assert_equal "my_event", result[:event_name] + assert_equal({ stripe_customer_id: "cus_123", value: "25" }, result[:payload]) + refute result.key?(:identifier), "identifier was not set and should not be in the hash" + refute result.key?(:timestamp), "timestamp was not set and should not be in the hash" + end + + should "serialize fields explicitly set to nil for V2 classes" do + params = Stripe::V2::Billing::MeterEventCreateParams.new( + event_name: "my_event", + identifier: nil, + payload: { stripe_customer_id: "cus_123", value: "25" } + ) + + result = params.to_h + + assert_equal "my_event", result[:event_name] + assert result.key?(:identifier), "identifier was explicitly set to nil and should be in the hash" + assert_nil result[:identifier] + assert_equal({ stripe_customer_id: "cus_123", value: "25" }, result[:payload]) + refute result.key?(:timestamp), "timestamp was not set and should not be in the hash" + end + + should "serialize fields explicitly set after initialization for V2 classes" do + params = Stripe::V2::Billing::MeterEventCreateParams.new( + event_name: "my_event", + payload: { stripe_customer_id: "cus_123", value: "25" } + ) + + params.identifier = "Something" + params.timestamp = nil + + result = params.to_h + + assert_equal "my_event", result[:event_name] + assert_equal "Something", result[:identifier] + assert_equal({ stripe_customer_id: "cus_123", value: "25" }, result[:payload]) + assert result.key?(:timestamp) + assert_nil result[:timestamp] + end + + should "serialize all fields even if some fields are set after initialization for V1 classes" do + params = FooCreateParams.new + + params.fun = "games" + + result = params.to_h + + assert_equal "games", result[:fun] + assert result.key?(:team), "V1 classes should include all fields even if not explicitly set" + assert_nil result[:team] + end + + should "serialize all fields including nil defaults for V1 classes" do + params = FooCreateParams.new(fun: "games") + + result = params.to_h + + assert_equal "games", result[:fun] + assert result.key?(:team), "V1 classes should include all fields even if not explicitly set" + assert_nil result[:team] + end + end end end