stripe 15.0.0 → 15.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/API_VERSION +1 -0
- data/CHANGELOG.md +129 -44
- data/CONTRIBUTING.md +25 -0
- data/Gemfile +1 -1
- data/OPENAPI_VERSION +1 -1
- data/README.md +28 -55
- data/VERSION +1 -1
- data/lib/stripe/api_operations/nested_resource.rb +35 -35
- data/lib/stripe/api_requestor.rb +1 -1
- data/lib/stripe/api_version.rb +2 -1
- data/lib/stripe/connection_manager.rb +1 -3
- data/lib/stripe/event_types.rb +1 -0
- data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +1 -1
- data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +1 -1
- data/lib/stripe/events/v2_core_event_destination_ping_event.rb +21 -0
- data/lib/stripe/oauth.rb +1 -1
- data/lib/stripe/resources/account.rb +198 -28
- data/lib/stripe/resources/account_session.rb +176 -72
- data/lib/stripe/resources/apple_pay_domain.rb +1 -2
- data/lib/stripe/resources/balance.rb +42 -0
- data/lib/stripe/resources/balance_transaction.rb +2 -0
- data/lib/stripe/resources/bank_account.rb +2 -2
- data/lib/stripe/resources/billing_portal/session.rb +3 -3
- data/lib/stripe/resources/capability.rb +1 -1
- data/lib/stripe/resources/charge.rb +43 -20
- data/lib/stripe/resources/checkout/session.rb +120 -19
- data/lib/stripe/resources/confirmation_token.rb +119 -100
- data/lib/stripe/resources/country_spec.rb +1 -1
- data/lib/stripe/resources/coupon.rb +2 -3
- data/lib/stripe/resources/credit_note.rb +21 -18
- data/lib/stripe/resources/customer.rb +4 -6
- data/lib/stripe/resources/customer_session.rb +5 -5
- data/lib/stripe/resources/dispute.rb +2 -2
- data/lib/stripe/resources/event.rb +3 -1
- data/lib/stripe/resources/file.rb +1 -1
- data/lib/stripe/resources/funding_instructions.rb +1 -1
- data/lib/stripe/resources/identity/verification_report.rb +6 -0
- data/lib/stripe/resources/identity/verification_session.rb +51 -11
- data/lib/stripe/resources/invoice.rb +146 -32
- data/lib/stripe/resources/invoice_item.rb +3 -7
- data/lib/stripe/resources/invoice_line_item.rb +1 -1
- data/lib/stripe/resources/invoice_payment.rb +9 -2
- data/lib/stripe/resources/issuing/authorization.rb +8 -8
- data/lib/stripe/resources/issuing/card.rb +1 -1
- data/lib/stripe/resources/issuing/dispute.rb +3 -3
- data/lib/stripe/resources/login_link.rb +2 -1
- data/lib/stripe/resources/mandate.rb +3 -0
- data/lib/stripe/resources/payment_intent.rb +602 -325
- data/lib/stripe/resources/payment_method.rb +76 -117
- data/lib/stripe/resources/payment_method_configuration.rb +356 -2
- data/lib/stripe/resources/payment_method_domain.rb +15 -2
- data/lib/stripe/resources/payout.rb +4 -4
- data/lib/stripe/resources/person.rb +27 -3
- data/lib/stripe/resources/plan.rb +2 -3
- data/lib/stripe/resources/price.rb +1 -1
- data/lib/stripe/resources/product.rb +1 -2
- data/lib/stripe/resources/quote.rb +28 -3
- data/lib/stripe/resources/radar/value_list.rb +1 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -2
- data/lib/stripe/resources/refund.rb +8 -1
- data/lib/stripe/resources/reversal.rb +1 -1
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_attempt.rb +1 -1
- data/lib/stripe/resources/setup_intent.rb +414 -293
- data/lib/stripe/resources/source.rb +1 -1
- data/lib/stripe/resources/subscription.rb +149 -27
- data/lib/stripe/resources/subscription_item.rb +33 -0
- data/lib/stripe/resources/subscription_schedule.rb +141 -4
- data/lib/stripe/resources/tax/calculation.rb +6 -2
- data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
- data/lib/stripe/resources/tax/registration.rb +261 -1
- data/lib/stripe/resources/tax/transaction.rb +1 -1
- data/lib/stripe/resources/tax_id.rb +3 -4
- data/lib/stripe/resources/tax_rate.rb +2 -2
- data/lib/stripe/resources/terminal/configuration.rb +2 -2
- data/lib/stripe/resources/terminal/location.rb +2 -3
- data/lib/stripe/resources/terminal/reader.rb +426 -6
- data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
- data/lib/stripe/resources/token.rb +63 -2
- data/lib/stripe/resources/transfer.rb +1 -1
- data/lib/stripe/resources/treasury/financial_account.rb +5 -1
- data/lib/stripe/resources/v2/billing/meter_event.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +2 -2
- data/lib/stripe/resources/v2/event.rb +2 -2
- data/lib/stripe/resources/v2/event_destination.rb +2 -2
- data/lib/stripe/resources/webhook_endpoint.rb +1 -2
- data/lib/stripe/resources.rb +1 -0
- data/lib/stripe/services/account_external_account_service.rb +3 -4
- data/lib/stripe/services/account_login_link_service.rb +1 -1
- data/lib/stripe/services/account_person_service.rb +85 -2
- data/lib/stripe/services/account_service.rb +169 -20
- data/lib/stripe/services/account_session_service.rb +115 -47
- data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
- data/lib/stripe/services/application_fee_service.rb +1 -1
- data/lib/stripe/services/apps_service.rb +1 -1
- data/lib/stripe/services/balance_service.rb +1 -1
- data/lib/stripe/services/billing/meter_service.rb +1 -1
- data/lib/stripe/services/billing_portal/session_service.rb +1 -1
- data/lib/stripe/services/billing_portal_service.rb +1 -1
- data/lib/stripe/services/billing_service.rb +1 -1
- data/lib/stripe/services/charge_service.rb +4 -4
- data/lib/stripe/services/checkout/session_service.rb +94 -15
- data/lib/stripe/services/checkout_service.rb +1 -1
- data/lib/stripe/services/climate_service.rb +1 -1
- data/lib/stripe/services/coupon_service.rb +1 -2
- data/lib/stripe/services/credit_note_preview_lines_service.rb +3 -3
- data/lib/stripe/services/credit_note_service.rb +14 -15
- data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
- data/lib/stripe/services/customer_payment_method_service.rb +1 -1
- data/lib/stripe/services/customer_payment_source_service.rb +1 -1
- data/lib/stripe/services/customer_service.rb +5 -7
- data/lib/stripe/services/customer_session_service.rb +1 -1
- data/lib/stripe/services/customer_tax_id_service.rb +2 -3
- data/lib/stripe/services/dispute_service.rb +1 -1
- data/lib/stripe/services/entitlements_service.rb +1 -1
- data/lib/stripe/services/file_service.rb +1 -1
- data/lib/stripe/services/financial_connections/account_service.rb +1 -1
- data/lib/stripe/services/financial_connections_service.rb +1 -1
- data/lib/stripe/services/forwarding_service.rb +1 -1
- data/lib/stripe/services/identity/verification_session_service.rb +21 -5
- data/lib/stripe/services/identity_service.rb +1 -1
- data/lib/stripe/services/invoice_item_service.rb +1 -2
- data/lib/stripe/services/invoice_service.rb +122 -28
- data/lib/stripe/services/issuing/authorization_service.rb +4 -4
- data/lib/stripe/services/issuing/card_service.rb +1 -1
- data/lib/stripe/services/issuing/dispute_service.rb +2 -2
- data/lib/stripe/services/issuing_service.rb +1 -1
- data/lib/stripe/services/payment_intent_service.rb +563 -313
- data/lib/stripe/services/payment_link_service.rb +1 -1
- data/lib/stripe/services/payment_method_configuration_service.rb +254 -2
- data/lib/stripe/services/payment_method_domain_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +59 -105
- data/lib/stripe/services/payout_service.rb +2 -2
- data/lib/stripe/services/plan_service.rb +2 -3
- data/lib/stripe/services/price_service.rb +2 -2
- data/lib/stripe/services/product_feature_service.rb +1 -2
- data/lib/stripe/services/product_service.rb +3 -4
- data/lib/stripe/services/promotion_code_service.rb +1 -1
- data/lib/stripe/services/quote_service.rb +21 -4
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
- data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
- data/lib/stripe/services/radar/value_list_service.rb +1 -2
- data/lib/stripe/services/radar_service.rb +1 -1
- data/lib/stripe/services/reporting_service.rb +1 -1
- data/lib/stripe/services/setup_intent_service.rb +403 -291
- data/lib/stripe/services/sigma_service.rb +1 -1
- data/lib/stripe/services/source_service.rb +2 -2
- data/lib/stripe/services/subscription_item_service.rb +26 -0
- data/lib/stripe/services/subscription_schedule_service.rb +106 -3
- data/lib/stripe/services/subscription_service.rb +121 -26
- data/lib/stripe/services/tax/calculation_service.rb +6 -2
- data/lib/stripe/services/tax/registration_service.rb +170 -1
- data/lib/stripe/services/tax/transaction_service.rb +1 -1
- data/lib/stripe/services/tax_id_service.rb +2 -3
- data/lib/stripe/services/tax_service.rb +1 -1
- data/lib/stripe/services/terminal/configuration_service.rb +1 -2
- data/lib/stripe/services/terminal/location_service.rb +2 -3
- data/lib/stripe/services/terminal/reader_service.rb +196 -2
- data/lib/stripe/services/terminal_service.rb +1 -1
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +90 -91
- data/lib/stripe/services/test_helpers/issuing_service.rb +1 -1
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
- data/lib/stripe/services/test_helpers/terminal_service.rb +1 -1
- data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
- data/lib/stripe/services/test_helpers/treasury_service.rb +1 -1
- data/lib/stripe/services/test_helpers_service.rb +1 -1
- data/lib/stripe/services/token_service.rb +62 -1
- data/lib/stripe/services/transfer_service.rb +2 -2
- data/lib/stripe/services/treasury/financial_account_service.rb +6 -2
- data/lib/stripe/services/treasury_service.rb +1 -1
- data/lib/stripe/services/v1_services.rb +1 -1
- data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
- data/lib/stripe/services/v2/billing_service.rb +3 -3
- data/lib/stripe/services/v2/core/event_destination_service.rb +17 -23
- data/lib/stripe/services/v2/core/event_service.rb +1 -2
- data/lib/stripe/services/v2/core_service.rb +1 -1
- data/lib/stripe/services/v2_services.rb +1 -1
- data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe/webhook.rb +1 -1
- data/rbi/stripe/resources/account.rbi +190 -35
- data/rbi/stripe/resources/account_session.rbi +196 -77
- data/rbi/stripe/resources/apple_pay_domain.rbi +1 -3
- data/rbi/stripe/resources/balance.rbi +55 -0
- data/rbi/stripe/resources/balance_transaction.rbi +3 -0
- data/rbi/stripe/resources/bank_account.rbi +2 -2
- data/rbi/stripe/resources/billing/alert.rbi +2 -2
- data/rbi/stripe/resources/billing_portal/session.rbi +3 -3
- data/rbi/stripe/resources/capability.rbi +1 -1
- data/rbi/stripe/resources/charge.rbi +52 -20
- data/rbi/stripe/resources/checkout/session.rbi +133 -24
- data/rbi/stripe/resources/confirmation_token.rbi +140 -115
- data/rbi/stripe/resources/country_spec.rbi +1 -1
- data/rbi/stripe/resources/coupon.rbi +2 -4
- data/rbi/stripe/resources/credit_note.rbi +23 -18
- data/rbi/stripe/resources/customer.rbi +4 -8
- data/rbi/stripe/resources/customer_session.rbi +5 -5
- data/rbi/stripe/resources/dispute.rbi +2 -2
- data/rbi/stripe/resources/event.rbi +4 -1
- data/rbi/stripe/resources/file.rbi +1 -1
- data/rbi/stripe/resources/identity/verification_report.rbi +9 -0
- data/rbi/stripe/resources/identity/verification_session.rbi +59 -12
- data/rbi/stripe/resources/invoice.rbi +149 -40
- data/rbi/stripe/resources/invoice_item.rbi +3 -8
- data/rbi/stripe/resources/invoice_line_item.rbi +2 -2
- data/rbi/stripe/resources/invoice_payment.rbi +9 -2
- data/rbi/stripe/resources/issuing/authorization.rbi +8 -8
- data/rbi/stripe/resources/issuing/card.rbi +1 -1
- data/rbi/stripe/resources/issuing/dispute.rbi +3 -3
- data/rbi/stripe/resources/login_link.rbi +2 -1
- data/rbi/stripe/resources/mandate.rbi +4 -0
- data/rbi/stripe/resources/payment_intent.rbi +637 -381
- data/rbi/stripe/resources/payment_method.rbi +81 -133
- data/rbi/stripe/resources/payment_method_configuration.rbi +400 -4
- data/rbi/stripe/resources/payment_method_domain.rbi +18 -2
- data/rbi/stripe/resources/payout.rbi +4 -4
- data/rbi/stripe/resources/person.rbi +33 -3
- data/rbi/stripe/resources/plan.rbi +2 -4
- data/rbi/stripe/resources/price.rbi +1 -1
- data/rbi/stripe/resources/product.rbi +1 -3
- data/rbi/stripe/resources/quote.rbi +25 -3
- data/rbi/stripe/resources/radar/value_list.rbi +1 -3
- data/rbi/stripe/resources/radar/value_list_item.rbi +1 -3
- data/rbi/stripe/resources/refund.rbi +8 -1
- data/rbi/stripe/resources/reversal.rbi +1 -1
- data/rbi/stripe/resources/review.rbi +1 -1
- data/rbi/stripe/resources/setup_attempt.rbi +1 -1
- data/rbi/stripe/resources/setup_intent.rbi +464 -346
- data/rbi/stripe/resources/source.rbi +1 -1
- data/rbi/stripe/resources/subscription.rbi +150 -34
- data/rbi/stripe/resources/subscription_item.rbi +36 -2
- data/rbi/stripe/resources/subscription_schedule.rbi +161 -11
- data/rbi/stripe/resources/tax/calculation.rbi +7 -3
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +4 -1
- data/rbi/stripe/resources/tax/registration.rbi +249 -2
- data/rbi/stripe/resources/tax/transaction.rbi +1 -1
- data/rbi/stripe/resources/tax_id.rbi +3 -5
- data/rbi/stripe/resources/tax_rate.rbi +2 -2
- data/rbi/stripe/resources/terminal/configuration.rbi +2 -3
- data/rbi/stripe/resources/terminal/location.rbi +4 -6
- data/rbi/stripe/resources/terminal/reader.rbi +415 -8
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +1 -3
- data/rbi/stripe/resources/token.rbi +70 -4
- data/rbi/stripe/resources/transfer.rbi +1 -1
- data/rbi/stripe/resources/treasury/financial_account.rbi +6 -2
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +3 -3
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +3 -3
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +3 -3
- data/rbi/stripe/resources/v2/event.rbi +3 -3
- data/rbi/stripe/resources/v2/event_destination.rbi +3 -3
- data/rbi/stripe/resources/webhook_endpoint.rbi +1 -3
- data/rbi/stripe/services/account_external_account_service.rbi +3 -5
- data/rbi/stripe/services/account_login_link_service.rbi +1 -1
- data/rbi/stripe/services/account_person_service.rbi +93 -5
- data/rbi/stripe/services/account_service.rbi +166 -28
- data/rbi/stripe/services/account_session_service.rbi +126 -52
- data/rbi/stripe/services/apple_pay_domain_service.rbi +1 -3
- data/rbi/stripe/services/balance_service.rbi +1 -1
- data/rbi/stripe/services/billing/alert_service.rbi +2 -2
- data/rbi/stripe/services/billing_portal/session_service.rbi +1 -1
- data/rbi/stripe/services/charge_service.rbi +4 -4
- data/rbi/stripe/services/checkout/session_service.rbi +104 -19
- data/rbi/stripe/services/coupon_service.rbi +1 -3
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +3 -3
- data/rbi/stripe/services/credit_note_service.rbi +13 -14
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +3 -3
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +2 -2
- data/rbi/stripe/services/customer_payment_method_service.rbi +1 -1
- data/rbi/stripe/services/customer_payment_source_service.rbi +1 -1
- data/rbi/stripe/services/customer_service.rbi +4 -8
- data/rbi/stripe/services/customer_session_service.rbi +1 -1
- data/rbi/stripe/services/customer_tax_id_service.rbi +2 -4
- data/rbi/stripe/services/dispute_service.rbi +1 -1
- data/rbi/stripe/services/file_service.rbi +1 -1
- data/rbi/stripe/services/identity/verification_session_service.rbi +22 -6
- data/rbi/stripe/services/invoice_item_service.rbi +1 -3
- data/rbi/stripe/services/invoice_service.rbi +126 -35
- data/rbi/stripe/services/issuing/authorization_service.rbi +4 -4
- data/rbi/stripe/services/issuing/card_service.rbi +1 -1
- data/rbi/stripe/services/issuing/dispute_service.rbi +2 -2
- data/rbi/stripe/services/payment_intent_service.rbi +599 -369
- data/rbi/stripe/services/payment_method_configuration_service.rbi +280 -4
- data/rbi/stripe/services/payment_method_domain_service.rbi +1 -1
- data/rbi/stripe/services/payment_method_service.rbi +62 -121
- data/rbi/stripe/services/payout_service.rbi +2 -2
- data/rbi/stripe/services/plan_service.rbi +2 -4
- data/rbi/stripe/services/price_service.rbi +2 -2
- data/rbi/stripe/services/product_feature_service.rbi +1 -3
- data/rbi/stripe/services/product_service.rbi +2 -4
- data/rbi/stripe/services/promotion_code_service.rbi +1 -1
- data/rbi/stripe/services/quote_service.rbi +16 -3
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +1 -1
- data/rbi/stripe/services/radar/value_list_item_service.rbi +1 -3
- data/rbi/stripe/services/radar/value_list_service.rbi +1 -3
- data/rbi/stripe/services/setup_intent_service.rbi +457 -344
- data/rbi/stripe/services/source_service.rbi +1 -1
- data/rbi/stripe/services/subscription_item_service.rbi +28 -2
- data/rbi/stripe/services/subscription_schedule_service.rbi +119 -10
- data/rbi/stripe/services/subscription_service.rbi +121 -33
- data/rbi/stripe/services/tax/calculation_service.rbi +6 -2
- data/rbi/stripe/services/tax/registration_service.rbi +171 -2
- data/rbi/stripe/services/tax_id_service.rbi +2 -4
- data/rbi/stripe/services/terminal/configuration_service.rbi +1 -3
- data/rbi/stripe/services/terminal/location_service.rbi +4 -6
- data/rbi/stripe/services/terminal/reader_service.rbi +200 -4
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +106 -106
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +31 -0
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +1 -3
- data/rbi/stripe/services/token_service.rbi +71 -3
- data/rbi/stripe/services/transfer_service.rbi +1 -1
- data/rbi/stripe/services/treasury/financial_account_service.rbi +6 -2
- data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +1 -3
- data/rbi/stripe/services/v2/billing_service.rbi +1 -1
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +14 -22
- data/rbi/stripe/services/v2/core/event_service.rbi +1 -3
- data/rbi/stripe/services/webhook_endpoint_service.rbi +1 -3
- metadata +5 -2
@@ -152,6 +152,12 @@ module Stripe
|
|
152
152
|
# The link to download the PDF of the credit note.
|
153
153
|
sig { returns(String) }
|
154
154
|
attr_reader :pdf
|
155
|
+
# The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
|
156
|
+
sig { returns(Integer) }
|
157
|
+
attr_reader :post_payment_amount
|
158
|
+
# The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
|
159
|
+
sig { returns(Integer) }
|
160
|
+
attr_reader :pre_payment_amount
|
155
161
|
# The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
|
156
162
|
sig { returns(T::Array[PretaxCreditAmount]) }
|
157
163
|
attr_reader :pretax_credit_amounts
|
@@ -317,7 +323,7 @@ module Stripe
|
|
317
323
|
sig { params(shipping_rate: T.nilable(String)).void }
|
318
324
|
def initialize(shipping_rate: nil); end
|
319
325
|
end
|
320
|
-
# The integer amount in cents (or local equivalent) representing the total amount of the credit note.
|
326
|
+
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
321
327
|
sig { returns(T.nilable(Integer)) }
|
322
328
|
attr_accessor :amount
|
323
329
|
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
|
@@ -335,7 +341,7 @@ module Stripe
|
|
335
341
|
# ID of the invoice.
|
336
342
|
sig { returns(String) }
|
337
343
|
attr_accessor :invoice
|
338
|
-
# Line items that make up the credit note.
|
344
|
+
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
339
345
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Line])) }
|
340
346
|
attr_accessor :lines
|
341
347
|
# The credit note's memo appears on the credit note PDF.
|
@@ -356,7 +362,7 @@ module Stripe
|
|
356
362
|
# Refunds to link to this credit note.
|
357
363
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::CreateParams::Refund])) }
|
358
364
|
attr_accessor :refunds
|
359
|
-
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
|
365
|
+
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
360
366
|
sig { returns(T.nilable(::Stripe::CreditNote::CreateParams::ShippingCost)) }
|
361
367
|
attr_accessor :shipping_cost
|
362
368
|
sig {
|
@@ -470,7 +476,7 @@ module Stripe
|
|
470
476
|
sig { params(shipping_rate: T.nilable(String)).void }
|
471
477
|
def initialize(shipping_rate: nil); end
|
472
478
|
end
|
473
|
-
# The integer amount in cents (or local equivalent) representing the total amount of the credit note.
|
479
|
+
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
474
480
|
sig { returns(T.nilable(Integer)) }
|
475
481
|
attr_accessor :amount
|
476
482
|
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
|
@@ -488,7 +494,7 @@ module Stripe
|
|
488
494
|
# ID of the invoice.
|
489
495
|
sig { returns(String) }
|
490
496
|
attr_accessor :invoice
|
491
|
-
# Line items that make up the credit note.
|
497
|
+
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
492
498
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Line])) }
|
493
499
|
attr_accessor :lines
|
494
500
|
# The credit note's memo appears on the credit note PDF.
|
@@ -509,7 +515,7 @@ module Stripe
|
|
509
515
|
# Refunds to link to this credit note.
|
510
516
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::PreviewParams::Refund])) }
|
511
517
|
attr_accessor :refunds
|
512
|
-
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
|
518
|
+
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
513
519
|
sig { returns(T.nilable(::Stripe::CreditNote::PreviewParams::ShippingCost)) }
|
514
520
|
attr_accessor :shipping_cost
|
515
521
|
sig {
|
@@ -608,7 +614,7 @@ module Stripe
|
|
608
614
|
sig { params(shipping_rate: T.nilable(String)).void }
|
609
615
|
def initialize(shipping_rate: nil); end
|
610
616
|
end
|
611
|
-
# The integer amount in cents (or local equivalent) representing the total amount of the credit note.
|
617
|
+
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
612
618
|
sig { returns(T.nilable(Integer)) }
|
613
619
|
attr_accessor :amount
|
614
620
|
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
|
@@ -632,7 +638,7 @@ module Stripe
|
|
632
638
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
633
639
|
sig { returns(T.nilable(Integer)) }
|
634
640
|
attr_accessor :limit
|
635
|
-
# Line items that make up the credit note.
|
641
|
+
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
636
642
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Line])) }
|
637
643
|
attr_accessor :lines
|
638
644
|
# The credit note's memo appears on the credit note PDF.
|
@@ -653,7 +659,7 @@ module Stripe
|
|
653
659
|
# Refunds to link to this credit note.
|
654
660
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNote::ListPreviewLineItemsParams::Refund])) }
|
655
661
|
attr_accessor :refunds
|
656
|
-
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
|
662
|
+
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
657
663
|
sig { returns(T.nilable(::Stripe::CreditNote::ListPreviewLineItemsParams::ShippingCost)) }
|
658
664
|
attr_accessor :shipping_cost
|
659
665
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
@@ -689,20 +695,19 @@ module Stripe
|
|
689
695
|
sig { params(expand: T.nilable(T::Array[String])).void }
|
690
696
|
def initialize(expand: nil); end
|
691
697
|
end
|
692
|
-
# Issue a credit note to adjust the amount of a finalized invoice.
|
693
|
-
#
|
694
|
-
# in any combination of the following:
|
698
|
+
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
|
699
|
+
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
|
695
700
|
#
|
696
701
|
#
|
697
|
-
#
|
702
|
+
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
|
698
703
|
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
|
699
704
|
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
|
700
705
|
#
|
701
706
|
#
|
702
|
-
#
|
707
|
+
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
|
703
708
|
#
|
704
|
-
# You may issue multiple credit notes for an invoice. Each credit note
|
705
|
-
# or
|
709
|
+
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
|
710
|
+
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
|
706
711
|
sig {
|
707
712
|
params(params: T.any(::Stripe::CreditNote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
|
708
713
|
}
|
@@ -732,13 +737,13 @@ module Stripe
|
|
732
737
|
}
|
733
738
|
def self.update(id, params = {}, opts = {}); end
|
734
739
|
|
735
|
-
# Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
|
740
|
+
# Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
|
736
741
|
sig {
|
737
742
|
params(params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
|
738
743
|
}
|
739
744
|
def void_credit_note(params = {}, opts = {}); end
|
740
745
|
|
741
|
-
# Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
|
746
|
+
# Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
|
742
747
|
sig {
|
743
748
|
params(id: String, params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
|
744
749
|
}
|
@@ -210,9 +210,7 @@ module Stripe
|
|
210
210
|
# Always true for a deleted object
|
211
211
|
sig { returns(T::Boolean) }
|
212
212
|
attr_reader :deleted
|
213
|
-
class DeleteParams < Stripe::RequestParams
|
214
|
-
|
215
|
-
end
|
213
|
+
class DeleteParams < Stripe::RequestParams; end
|
216
214
|
class UpdateParams < Stripe::RequestParams
|
217
215
|
class Address < Stripe::RequestParams
|
218
216
|
# City, district, suburb, town, or village.
|
@@ -459,9 +457,7 @@ module Stripe
|
|
459
457
|
validate: nil
|
460
458
|
); end
|
461
459
|
end
|
462
|
-
class DeleteDiscountParams < Stripe::RequestParams
|
463
|
-
|
464
|
-
end
|
460
|
+
class DeleteDiscountParams < Stripe::RequestParams; end
|
465
461
|
class ListParams < Stripe::RequestParams
|
466
462
|
class Created < Stripe::RequestParams
|
467
463
|
# Minimum value to filter by (exclusive)
|
@@ -672,7 +668,7 @@ module Stripe
|
|
672
668
|
def initialize(ip_address: nil, validate_location: nil); end
|
673
669
|
end
|
674
670
|
class TaxIdDatum < Stripe::RequestParams
|
675
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `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`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `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`, `kh_tin`, `kr_brn`, `kz_bin`, `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`, `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`
|
671
|
+
# 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`, `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`
|
676
672
|
sig { returns(String) }
|
677
673
|
attr_accessor :type
|
678
674
|
# Value of the tax ID.
|
@@ -776,7 +772,7 @@ module Stripe
|
|
776
772
|
); end
|
777
773
|
end
|
778
774
|
class ListPaymentMethodsParams < Stripe::RequestParams
|
779
|
-
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
|
775
|
+
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
|
780
776
|
sig { returns(T.nilable(String)) }
|
781
777
|
attr_accessor :allow_redisplay
|
782
778
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
@@ -6,9 +6,9 @@ module Stripe
|
|
6
6
|
# A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access
|
7
7
|
# control over a Customer.
|
8
8
|
#
|
9
|
-
# Related guides: [Customer Session with the Payment Element](https://stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
|
10
|
-
# [Customer Session with the Pricing Table](https://stripe.com/payments/checkout/pricing-table#customer-session),
|
11
|
-
# [Customer Session with the Buy Button](https://stripe.com/payment-links/buy-button#pass-an-existing-customer).
|
9
|
+
# Related guides: [Customer Session with the Payment Element](https://docs.stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
|
10
|
+
# [Customer Session with the Pricing Table](https://docs.stripe.com/payments/checkout/pricing-table#customer-session),
|
11
|
+
# [Customer Session with the Buy Button](https://docs.stripe.com/payment-links/buy-button#pass-an-existing-customer).
|
12
12
|
class CustomerSession < APIResource
|
13
13
|
class Components < Stripe::StripeObject
|
14
14
|
class BuyButton < Stripe::StripeObject
|
@@ -26,7 +26,7 @@ module Stripe
|
|
26
26
|
# Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
|
27
27
|
sig { returns(String) }
|
28
28
|
attr_reader :payment_method_redisplay
|
29
|
-
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.
|
29
|
+
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
|
30
30
|
sig { returns(T.nilable(Integer)) }
|
31
31
|
attr_reader :payment_method_redisplay_limit
|
32
32
|
# Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.
|
@@ -109,7 +109,7 @@ module Stripe
|
|
109
109
|
# Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
|
110
110
|
sig { returns(T.nilable(String)) }
|
111
111
|
attr_accessor :payment_method_redisplay
|
112
|
-
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.
|
112
|
+
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
|
113
113
|
sig { returns(T.nilable(Integer)) }
|
114
114
|
attr_accessor :payment_method_redisplay_limit
|
115
115
|
# Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.
|
@@ -340,7 +340,7 @@ module Stripe
|
|
340
340
|
# Attribute for field payment_method_details
|
341
341
|
sig { returns(PaymentMethodDetails) }
|
342
342
|
attr_reader :payment_method_details
|
343
|
-
# Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
|
343
|
+
# Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
|
344
344
|
sig { returns(String) }
|
345
345
|
attr_reader :reason
|
346
346
|
# Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.
|
@@ -752,7 +752,7 @@ module Stripe
|
|
752
752
|
|
753
753
|
# When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
|
754
754
|
#
|
755
|
-
# Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).
|
755
|
+
# Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
|
756
756
|
sig {
|
757
757
|
params(dispute: String, params: T.any(::Stripe::Dispute::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
|
758
758
|
}
|
@@ -53,9 +53,12 @@ module Stripe
|
|
53
53
|
# The connected account that originates the event.
|
54
54
|
sig { returns(String) }
|
55
55
|
attr_reader :account
|
56
|
-
# The Stripe API version used to render `data
|
56
|
+
# The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.
|
57
57
|
sig { returns(T.nilable(String)) }
|
58
58
|
attr_reader :api_version
|
59
|
+
# Authentication context needed to fetch the event or related object.
|
60
|
+
sig { returns(String) }
|
61
|
+
attr_reader :context
|
59
62
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
60
63
|
sig { returns(Integer) }
|
61
64
|
attr_reader :created
|
@@ -7,7 +7,7 @@ module Stripe
|
|
7
7
|
# files with the [create file](https://stripe.com/docs/api#create_file) request
|
8
8
|
# (for example, when uploading dispute evidence). Stripe also
|
9
9
|
# creates files independently (for example, the results of a [Sigma scheduled
|
10
|
-
# query](https://stripe.com/
|
10
|
+
# query](https://docs.stripe.com/api#scheduled_queries)).
|
11
11
|
#
|
12
12
|
# Related guide: [File upload guide](https://stripe.com/docs/file-upload)
|
13
13
|
class File < APIResource
|
@@ -108,12 +108,21 @@ module Stripe
|
|
108
108
|
# Document ID number.
|
109
109
|
sig { returns(T.nilable(String)) }
|
110
110
|
attr_reader :number
|
111
|
+
# Sex of the person in the document.
|
112
|
+
sig { returns(T.nilable(String)) }
|
113
|
+
attr_reader :sex
|
111
114
|
# Status of this `document` check.
|
112
115
|
sig { returns(String) }
|
113
116
|
attr_reader :status
|
114
117
|
# Type of the document.
|
115
118
|
sig { returns(T.nilable(String)) }
|
116
119
|
attr_reader :type
|
120
|
+
# Place of birth as it appears in the document.
|
121
|
+
sig { returns(T.nilable(String)) }
|
122
|
+
attr_reader :unparsed_place_of_birth
|
123
|
+
# Sex as it appears in the document.
|
124
|
+
sig { returns(T.nilable(String)) }
|
125
|
+
attr_reader :unparsed_sex
|
117
126
|
end
|
118
127
|
class Email < Stripe::StripeObject
|
119
128
|
class Error < Stripe::StripeObject
|
@@ -6,11 +6,11 @@ module Stripe
|
|
6
6
|
module Identity
|
7
7
|
# A VerificationSession guides you through the process of collecting and verifying the identities
|
8
8
|
# of your users. It contains details about the type of verification, such as what [verification
|
9
|
-
# check](https://stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
|
9
|
+
# check](https://docs.stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
|
10
10
|
# each verification in your system.
|
11
11
|
#
|
12
12
|
# A VerificationSession transitions through [multiple
|
13
|
-
# statuses](https://stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through
|
13
|
+
# statuses](https://docs.stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through
|
14
14
|
# the verification flow. The VerificationSession contains the user's verified data after
|
15
15
|
# verification checks are complete.
|
16
16
|
#
|
@@ -45,6 +45,14 @@ module Stripe
|
|
45
45
|
attr_reader :require_verification
|
46
46
|
end
|
47
47
|
class IdNumber < Stripe::StripeObject; end
|
48
|
+
class Matching < Stripe::StripeObject
|
49
|
+
# Strictness of the DOB matching policy to apply.
|
50
|
+
sig { returns(String) }
|
51
|
+
attr_reader :dob
|
52
|
+
# Strictness of the name matching policy to apply.
|
53
|
+
sig { returns(String) }
|
54
|
+
attr_reader :name
|
55
|
+
end
|
48
56
|
class Phone < Stripe::StripeObject
|
49
57
|
# Request one time password verification of `provided_details.phone`.
|
50
58
|
sig { returns(T::Boolean) }
|
@@ -59,6 +67,9 @@ module Stripe
|
|
59
67
|
# Attribute for field id_number
|
60
68
|
sig { returns(IdNumber) }
|
61
69
|
attr_reader :id_number
|
70
|
+
# Attribute for field matching
|
71
|
+
sig { returns(Matching) }
|
72
|
+
attr_reader :matching
|
62
73
|
# Attribute for field phone
|
63
74
|
sig { returns(Phone) }
|
64
75
|
attr_reader :phone
|
@@ -76,6 +87,14 @@ module Stripe
|
|
76
87
|
sig { returns(String) }
|
77
88
|
attr_reader :status
|
78
89
|
end
|
90
|
+
class RelatedPerson < Stripe::StripeObject
|
91
|
+
# Token referencing the associated Account of the related Person resource.
|
92
|
+
sig { returns(String) }
|
93
|
+
attr_reader :account
|
94
|
+
# Token referencing the related Person resource.
|
95
|
+
sig { returns(String) }
|
96
|
+
attr_reader :person
|
97
|
+
end
|
79
98
|
class VerifiedOutputs < Stripe::StripeObject
|
80
99
|
class Address < Stripe::StripeObject
|
81
100
|
# City, district, suburb, town, or village.
|
@@ -132,6 +151,15 @@ module Stripe
|
|
132
151
|
# The user's verified phone number
|
133
152
|
sig { returns(T.nilable(String)) }
|
134
153
|
attr_reader :phone
|
154
|
+
# The user's verified sex.
|
155
|
+
sig { returns(T.nilable(String)) }
|
156
|
+
attr_reader :sex
|
157
|
+
# The user's verified place of birth as it appears in the document.
|
158
|
+
sig { returns(T.nilable(String)) }
|
159
|
+
attr_reader :unparsed_place_of_birth
|
160
|
+
# The user's verified sex as it appears in the document.
|
161
|
+
sig { returns(T.nilable(String)) }
|
162
|
+
attr_reader :unparsed_sex
|
135
163
|
end
|
136
164
|
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
|
137
165
|
sig { returns(T.nilable(String)) }
|
@@ -172,6 +200,9 @@ module Stripe
|
|
172
200
|
# Customer ID
|
173
201
|
sig { returns(T.nilable(String)) }
|
174
202
|
attr_reader :related_customer
|
203
|
+
# Attribute for field related_person
|
204
|
+
sig { returns(RelatedPerson) }
|
205
|
+
attr_reader :related_person
|
175
206
|
# Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
|
176
207
|
sig { returns(String) }
|
177
208
|
attr_reader :status
|
@@ -291,6 +322,16 @@ module Stripe
|
|
291
322
|
sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
|
292
323
|
def initialize(email: nil, phone: nil); end
|
293
324
|
end
|
325
|
+
class RelatedPerson < Stripe::RequestParams
|
326
|
+
# A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.
|
327
|
+
sig { returns(String) }
|
328
|
+
attr_accessor :account
|
329
|
+
# A token referencing a Person resource that this verification is being used to verify.
|
330
|
+
sig { returns(String) }
|
331
|
+
attr_accessor :person
|
332
|
+
sig { params(account: String, person: String).void }
|
333
|
+
def initialize(account: nil, person: nil); end
|
334
|
+
end
|
294
335
|
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
|
295
336
|
sig { returns(T.nilable(String)) }
|
296
337
|
attr_accessor :client_reference_id
|
@@ -311,6 +352,11 @@ module Stripe
|
|
311
352
|
# Customer ID
|
312
353
|
sig { returns(T.nilable(String)) }
|
313
354
|
attr_accessor :related_customer
|
355
|
+
# Tokens referencing a Person resource and it's associated account.
|
356
|
+
sig {
|
357
|
+
returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson))
|
358
|
+
}
|
359
|
+
attr_accessor :related_person
|
314
360
|
# The URL that the user will be redirected to upon completing the verification flow.
|
315
361
|
sig { returns(T.nilable(String)) }
|
316
362
|
attr_accessor :return_url
|
@@ -321,7 +367,7 @@ module Stripe
|
|
321
367
|
sig { returns(T.nilable(String)) }
|
322
368
|
attr_accessor :verification_flow
|
323
369
|
sig {
|
324
|
-
params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails), related_customer: T.nilable(String), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
370
|
+
params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::ProvidedDetails), related_customer: T.nilable(String), related_person: T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
325
371
|
}
|
326
372
|
def initialize(
|
327
373
|
client_reference_id: nil,
|
@@ -330,6 +376,7 @@ module Stripe
|
|
330
376
|
options: nil,
|
331
377
|
provided_details: nil,
|
332
378
|
related_customer: nil,
|
379
|
+
related_person: nil,
|
333
380
|
return_url: nil,
|
334
381
|
type: nil,
|
335
382
|
verification_flow: nil
|
@@ -422,17 +469,17 @@ module Stripe
|
|
422
469
|
sig { params(expand: T.nilable(T::Array[String])).void }
|
423
470
|
def initialize(expand: nil); end
|
424
471
|
end
|
425
|
-
# A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
|
472
|
+
# A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
426
473
|
#
|
427
|
-
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
|
474
|
+
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
428
475
|
sig {
|
429
476
|
params(params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
430
477
|
}
|
431
478
|
def cancel(params = {}, opts = {}); end
|
432
479
|
|
433
|
-
# A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
|
480
|
+
# A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
434
481
|
#
|
435
|
-
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
|
482
|
+
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
436
483
|
sig {
|
437
484
|
params(session: String, params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
438
485
|
}
|
@@ -444,7 +491,7 @@ module Stripe
|
|
444
491
|
#
|
445
492
|
# If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
|
446
493
|
#
|
447
|
-
# Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
|
494
|
+
# Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
|
448
495
|
sig {
|
449
496
|
params(params: T.any(::Stripe::Identity::VerificationSession::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
450
497
|
}
|
@@ -461,7 +508,7 @@ module Stripe
|
|
461
508
|
# request logs, etc.
|
462
509
|
#
|
463
510
|
# A VerificationSession object can be redacted when it is in requires_input or verified
|
464
|
-
# [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
|
511
|
+
# [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
|
465
512
|
# state will automatically cancel it.
|
466
513
|
#
|
467
514
|
# The redaction process may take up to four days. When the redaction process is in progress, the
|
@@ -474,7 +521,7 @@ module Stripe
|
|
474
521
|
# placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
|
475
522
|
# used for any purpose.
|
476
523
|
#
|
477
|
-
# [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
|
524
|
+
# [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
478
525
|
sig {
|
479
526
|
params(params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
480
527
|
}
|
@@ -485,7 +532,7 @@ module Stripe
|
|
485
532
|
# request logs, etc.
|
486
533
|
#
|
487
534
|
# A VerificationSession object can be redacted when it is in requires_input or verified
|
488
|
-
# [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
|
535
|
+
# [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
|
489
536
|
# state will automatically cancel it.
|
490
537
|
#
|
491
538
|
# The redaction process may take up to four days. When the redaction process is in progress, the
|
@@ -498,7 +545,7 @@ module Stripe
|
|
498
545
|
# placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
|
499
546
|
# used for any purpose.
|
500
547
|
#
|
501
|
-
# [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
|
548
|
+
# [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
502
549
|
sig {
|
503
550
|
params(session: String, params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
504
551
|
}
|