stripe 13.6.0.pre.beta.1 → 14.0.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/CHANGELOG.md +699 -1457
- data/OPENAPI_VERSION +1 -1
- data/README.md +29 -0
- data/VERSION +1 -1
- data/lib/stripe/api_requestor.rb +2 -0
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +0 -7
- data/lib/stripe/object_types.rb +0 -26
- data/lib/stripe/resources/account.rb +83 -614
- data/lib/stripe/resources/account_session.rb +1 -247
- data/lib/stripe/resources/apple_pay_domain.rb +0 -9
- data/lib/stripe/resources/application_fee.rb +1 -10
- data/lib/stripe/resources/balance.rb +0 -9
- data/lib/stripe/resources/balance_transaction.rb +2 -11
- data/lib/stripe/resources/bank_account.rb +1 -1
- data/lib/stripe/resources/billing/alert.rb +0 -9
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -48
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -9
- data/lib/stripe/resources/billing/credit_grant.rb +4 -13
- data/lib/stripe/resources/billing/meter.rb +1 -10
- data/lib/stripe/resources/billing_portal/configuration.rb +0 -9
- data/lib/stripe/resources/card.rb +2 -4
- data/lib/stripe/resources/charge.rb +35 -1457
- data/lib/stripe/resources/checkout/session.rb +100 -293
- data/lib/stripe/resources/climate/order.rb +0 -9
- data/lib/stripe/resources/climate/product.rb +0 -9
- data/lib/stripe/resources/climate/supplier.rb +0 -9
- data/lib/stripe/resources/confirmation_token.rb +74 -156
- data/lib/stripe/resources/country_spec.rb +0 -9
- data/lib/stripe/resources/coupon.rb +0 -9
- data/lib/stripe/resources/credit_note.rb +14 -35
- data/lib/stripe/resources/credit_note_line_item.rb +14 -12
- data/lib/stripe/resources/customer.rb +12 -28
- data/lib/stripe/resources/customer_balance_transaction.rb +3 -1
- data/lib/stripe/resources/dispute.rb +0 -9
- data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -9
- data/lib/stripe/resources/entitlements/feature.rb +0 -9
- data/lib/stripe/resources/event.rb +0 -40
- data/lib/stripe/resources/exchange_rate.rb +0 -9
- data/lib/stripe/resources/file.rb +0 -9
- data/lib/stripe/resources/file_link.rb +0 -9
- data/lib/stripe/resources/financial_connections/account.rb +0 -23
- data/lib/stripe/resources/financial_connections/session.rb +1 -65
- data/lib/stripe/resources/financial_connections/transaction.rb +0 -9
- data/lib/stripe/resources/forwarding/request.rb +0 -9
- data/lib/stripe/resources/identity/verification_report.rb +0 -9
- data/lib/stripe/resources/identity/verification_session.rb +0 -9
- data/lib/stripe/resources/invoice.rb +225 -5120
- data/lib/stripe/resources/invoice_item.rb +65 -110
- data/lib/stripe/resources/invoice_line_item.rb +106 -89
- data/lib/stripe/resources/invoice_payment.rb +53 -4
- data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
- data/lib/stripe/resources/issuing/authorization.rb +0 -9
- data/lib/stripe/resources/issuing/card.rb +0 -9
- data/lib/stripe/resources/issuing/cardholder.rb +1 -11
- data/lib/stripe/resources/issuing/dispute.rb +0 -9
- data/lib/stripe/resources/issuing/personalization_design.rb +0 -9
- data/lib/stripe/resources/issuing/physical_bundle.rb +0 -9
- data/lib/stripe/resources/issuing/token.rb +0 -9
- data/lib/stripe/resources/issuing/transaction.rb +0 -15
- data/lib/stripe/resources/line_item.rb +0 -28
- data/lib/stripe/resources/mandate.rb +6 -33
- data/lib/stripe/resources/payment_intent.rb +642 -4975
- data/lib/stripe/resources/payment_link.rb +84 -15
- data/lib/stripe/resources/payment_method.rb +74 -187
- data/lib/stripe/resources/payment_method_configuration.rb +87 -214
- data/lib/stripe/resources/payment_method_domain.rb +9 -18
- data/lib/stripe/resources/payout.rb +0 -9
- data/lib/stripe/resources/person.rb +9 -9
- data/lib/stripe/resources/plan.rb +0 -15
- data/lib/stripe/resources/price.rb +2 -47
- data/lib/stripe/resources/product.rb +0 -68
- data/lib/stripe/resources/promotion_code.rb +0 -9
- data/lib/stripe/resources/quote.rb +8 -2037
- data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -9
- data/lib/stripe/resources/radar/value_list.rb +0 -9
- data/lib/stripe/resources/radar/value_list_item.rb +0 -9
- data/lib/stripe/resources/refund.rb +13 -18
- data/lib/stripe/resources/reporting/report_run.rb +0 -9
- data/lib/stripe/resources/reporting/report_type.rb +0 -9
- data/lib/stripe/resources/review.rb +2 -11
- data/lib/stripe/resources/setup_attempt.rb +11 -16
- data/lib/stripe/resources/setup_intent.rb +158 -540
- data/lib/stripe/resources/shipping_rate.rb +0 -9
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -9
- data/lib/stripe/resources/source.rb +0 -41
- data/lib/stripe/resources/subscription.rb +14 -385
- data/lib/stripe/resources/subscription_item.rb +9 -134
- data/lib/stripe/resources/subscription_schedule.rb +14 -1135
- data/lib/stripe/resources/tax/calculation.rb +0 -9
- data/lib/stripe/resources/tax/registration.rb +1 -10
- data/lib/stripe/resources/tax/settings.rb +0 -9
- data/lib/stripe/resources/tax/transaction.rb +0 -9
- data/lib/stripe/resources/tax_code.rb +0 -9
- data/lib/stripe/resources/tax_id.rb +0 -9
- data/lib/stripe/resources/tax_rate.rb +0 -9
- data/lib/stripe/resources/terminal/configuration.rb +214 -14
- data/lib/stripe/resources/terminal/location.rb +0 -9
- data/lib/stripe/resources/terminal/reader.rb +0 -408
- data/lib/stripe/resources/test_helpers/test_clock.rb +0 -9
- data/lib/stripe/resources/token.rb +1 -10
- data/lib/stripe/resources/topup.rb +0 -9
- data/lib/stripe/resources/transfer.rb +0 -9
- data/lib/stripe/resources/treasury/credit_reversal.rb +0 -9
- data/lib/stripe/resources/treasury/debit_reversal.rb +0 -9
- data/lib/stripe/resources/treasury/financial_account.rb +4 -32
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
- data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -9
- data/lib/stripe/resources/treasury/outbound_payment.rb +0 -9
- data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -46
- data/lib/stripe/resources/treasury/received_credit.rb +1 -47
- data/lib/stripe/resources/treasury/received_debit.rb +1 -49
- data/lib/stripe/resources/treasury/transaction.rb +0 -9
- data/lib/stripe/resources/treasury/transaction_entry.rb +0 -9
- data/lib/stripe/resources/v2/event.rb +1 -0
- data/lib/stripe/resources/v2/event_destination.rb +1 -0
- data/lib/stripe/resources/webhook_endpoint.rb +0 -9
- data/lib/stripe/resources.rb +0 -25
- data/lib/stripe/services/account_external_account_service.rb +1 -1
- data/lib/stripe/services/account_service.rb +68 -509
- data/lib/stripe/services/account_session_service.rb +1 -217
- data/lib/stripe/services/balance_transaction_service.rb +1 -1
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +2 -2
- data/lib/stripe/services/billing/credit_grant_service.rb +2 -2
- data/lib/stripe/services/billing/meter_service.rb +1 -1
- data/lib/stripe/services/charge_service.rb +1 -1335
- data/lib/stripe/services/checkout/session_service.rb +60 -168
- data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -4
- data/lib/stripe/services/credit_note_service.rb +0 -8
- data/lib/stripe/services/customer_service.rb +0 -16
- data/lib/stripe/services/financial_connections/account_service.rb +1 -3
- data/lib/stripe/services/financial_connections/session_service.rb +1 -30
- data/lib/stripe/services/financial_connections_service.rb +1 -2
- data/lib/stripe/services/invoice_item_service.rb +34 -88
- data/lib/stripe/services/invoice_line_item_service.rb +25 -41
- data/lib/stripe/services/invoice_payment_service.rb +33 -5
- data/lib/stripe/services/invoice_service.rb +210 -3147
- data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
- data/lib/stripe/services/issuing/transaction_service.rb +0 -4
- data/lib/stripe/services/issuing_service.rb +1 -5
- data/lib/stripe/services/payment_intent_service.rb +568 -4513
- data/lib/stripe/services/payment_link_service.rb +59 -6
- data/lib/stripe/services/payment_method_configuration_service.rb +62 -146
- data/lib/stripe/services/payment_method_domain_service.rb +6 -6
- data/lib/stripe/services/payment_method_service.rb +49 -119
- data/lib/stripe/services/plan_service.rb +0 -4
- data/lib/stripe/services/price_service.rb +2 -25
- data/lib/stripe/services/product_service.rb +0 -38
- data/lib/stripe/services/quote_service.rb +9 -1716
- data/lib/stripe/services/setup_intent_service.rb +158 -492
- data/lib/stripe/services/subscription_item_service.rb +5 -111
- data/lib/stripe/services/subscription_schedule_service.rb +14 -1005
- data/lib/stripe/services/subscription_service.rb +13 -323
- data/lib/stripe/services/tax/registration_service.rb +1 -1
- data/lib/stripe/services/tax_service.rb +1 -3
- data/lib/stripe/services/terminal/configuration_service.rb +170 -4
- data/lib/stripe/services/terminal/reader_service.rb +0 -177
- data/lib/stripe/services/terminal_service.rb +1 -2
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +49 -87
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
- data/lib/stripe/services/token_service.rb +1 -1
- data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
- data/lib/stripe/services/treasury/financial_account_service.rb +3 -17
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
- data/lib/stripe/services/v1_services.rb +2 -8
- data/lib/stripe/services/v2/core/event_destination_service.rb +1 -4
- data/lib/stripe/services/v2/core/event_service.rb +1 -4
- data/lib/stripe/services.rb +0 -27
- data/lib/stripe/stripe_client.rb +1 -0
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/util.rb +1 -7
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +0 -45
- data/rbi/stripe/resources/account.rbi +1131 -1479
- data/rbi/stripe/resources/account_link.rbi +9 -9
- data/rbi/stripe/resources/account_session.rbi +118 -367
- data/rbi/stripe/resources/apple_pay_domain.rbi +8 -15
- data/rbi/stripe/resources/application_fee.rbi +15 -20
- data/rbi/stripe/resources/apps/secret.rbi +20 -20
- data/rbi/stripe/resources/balance.rbi +0 -7
- data/rbi/stripe/resources/balance_transaction.rbi +19 -24
- data/rbi/stripe/resources/bank_account.rbi +1 -1
- data/rbi/stripe/resources/billing/alert.rbi +23 -28
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -53
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +6 -13
- data/rbi/stripe/resources/billing/credit_grant.rbi +30 -37
- data/rbi/stripe/resources/billing/meter.rbi +19 -26
- data/rbi/stripe/resources/billing/meter_event.rbi +4 -4
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +5 -5
- data/rbi/stripe/resources/billing_portal/configuration.rbi +86 -81
- data/rbi/stripe/resources/billing_portal/session.rbi +31 -27
- data/rbi/stripe/resources/card.rbi +2 -5
- data/rbi/stripe/resources/charge.rbi +136 -1576
- data/rbi/stripe/resources/checkout/session.rbi +631 -748
- data/rbi/stripe/resources/climate/order.rbi +20 -25
- data/rbi/stripe/resources/climate/product.rbi +5 -12
- data/rbi/stripe/resources/climate/supplier.rbi +5 -12
- data/rbi/stripe/resources/confirmation_token.rbi +274 -268
- data/rbi/stripe/resources/country_spec.rbi +5 -12
- data/rbi/stripe/resources/coupon.rbi +34 -39
- data/rbi/stripe/resources/credit_note.rbi +134 -146
- data/rbi/stripe/resources/credit_note_line_item.rbi +20 -18
- data/rbi/stripe/resources/customer.rbi +172 -164
- data/rbi/stripe/resources/customer_balance_transaction.rbi +4 -1
- data/rbi/stripe/resources/customer_session.rbi +19 -15
- data/rbi/stripe/resources/dispute.rbi +92 -95
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +5 -12
- data/rbi/stripe/resources/entitlements/feature.rbi +15 -22
- data/rbi/stripe/resources/ephemeral_key.rbi +2 -2
- data/rbi/stripe/resources/event.rbi +16 -60
- data/rbi/stripe/resources/exchange_rate.rbi +5 -12
- data/rbi/stripe/resources/file.rbi +20 -25
- data/rbi/stripe/resources/file_link.rbi +23 -28
- data/rbi/stripe/resources/financial_connections/account.rbi +25 -44
- data/rbi/stripe/resources/financial_connections/session.rbi +12 -75
- data/rbi/stripe/resources/financial_connections/transaction.rbi +16 -19
- data/rbi/stripe/resources/forwarding/request.rbi +21 -24
- data/rbi/stripe/resources/identity/verification_report.rbi +18 -21
- data/rbi/stripe/resources/identity/verification_session.rbi +60 -61
- data/rbi/stripe/resources/invoice.rbi +723 -5918
- data/rbi/stripe/resources/invoice_item.rbi +138 -177
- data/rbi/stripe/resources/invoice_line_item.rbi +199 -264
- data/rbi/stripe/resources/invoice_payment.rbi +51 -7
- data/rbi/stripe/resources/invoice_rendering_template.rbi +10 -20
- data/rbi/stripe/resources/issuing/authorization.rbi +216 -199
- data/rbi/stripe/resources/issuing/card.rbi +104 -101
- data/rbi/stripe/resources/issuing/cardholder.rbi +120 -108
- data/rbi/stripe/resources/issuing/dispute.rbi +164 -151
- data/rbi/stripe/resources/issuing/personalization_design.rbi +61 -56
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +7 -14
- data/rbi/stripe/resources/issuing/token.rbi +16 -21
- data/rbi/stripe/resources/issuing/transaction.rbi +180 -176
- data/rbi/stripe/resources/line_item.rbi +0 -36
- data/rbi/stripe/resources/mandate.rbi +8 -40
- data/rbi/stripe/resources/payment_intent.rbi +2252 -6482
- data/rbi/stripe/resources/payment_link.rbi +346 -211
- data/rbi/stripe/resources/payment_method.rbi +226 -330
- data/rbi/stripe/resources/payment_method_configuration.rbi +602 -685
- data/rbi/stripe/resources/payment_method_domain.rbi +26 -31
- data/rbi/stripe/resources/payout.rbi +43 -42
- data/rbi/stripe/resources/person.rbi +9 -9
- data/rbi/stripe/resources/plan.rbi +51 -63
- data/rbi/stripe/resources/price.rbi +114 -151
- data/rbi/stripe/resources/product.rbi +90 -152
- data/rbi/stripe/resources/promotion_code.rbi +42 -47
- data/rbi/stripe/resources/quote.rbi +168 -2231
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +17 -20
- data/rbi/stripe/resources/radar/value_list.rbi +24 -29
- data/rbi/stripe/resources/radar/value_list_item.rbi +18 -21
- data/rbi/stripe/resources/refund.rbi +52 -51
- data/rbi/stripe/resources/reporting/report_run.rbi +27 -30
- data/rbi/stripe/resources/reporting/report_type.rbi +2 -9
- data/rbi/stripe/resources/review.rbi +17 -22
- data/rbi/stripe/resources/setup_attempt.rbi +25 -32
- data/rbi/stripe/resources/setup_intent.rbi +900 -1102
- data/rbi/stripe/resources/shipping_rate.rbi +41 -46
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +5 -12
- data/rbi/stripe/resources/source.rbi +132 -179
- data/rbi/stripe/resources/subscription.rbi +363 -707
- data/rbi/stripe/resources/subscription_item.rbi +69 -177
- data/rbi/stripe/resources/subscription_schedule.rbi +289 -1447
- data/rbi/stripe/resources/tax/calculation.rbi +43 -48
- data/rbi/stripe/resources/tax/registration.rbi +217 -170
- data/rbi/stripe/resources/tax/settings.rbi +14 -21
- data/rbi/stripe/resources/tax/transaction.rbi +20 -25
- data/rbi/stripe/resources/tax_code.rbi +5 -12
- data/rbi/stripe/resources/tax_id.rbi +15 -22
- data/rbi/stripe/resources/tax_rate.rbi +34 -39
- data/rbi/stripe/resources/terminal/configuration.rbi +457 -212
- data/rbi/stripe/resources/terminal/connection_token.rbi +3 -3
- data/rbi/stripe/resources/terminal/location.rbi +28 -35
- data/rbi/stripe/resources/terminal/reader.rbi +71 -441
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +12 -17
- data/rbi/stripe/resources/token.rbi +288 -263
- data/rbi/stripe/resources/topup.rbi +35 -38
- data/rbi/stripe/resources/transfer.rbi +27 -32
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +10 -17
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +11 -18
- data/rbi/stripe/resources/treasury/financial_account.rbi +125 -130
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -3
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +22 -29
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +82 -79
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +44 -86
- data/rbi/stripe/resources/treasury/received_credit.rbi +18 -64
- data/rbi/stripe/resources/treasury/received_debit.rbi +17 -66
- data/rbi/stripe/resources/treasury/transaction.rbi +27 -28
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +25 -26
- data/rbi/stripe/resources/v2/amount.rbi +1 -1
- data/rbi/stripe/resources/v2/event.rbi +1 -0
- data/rbi/stripe/resources/v2/event_destination.rbi +1 -0
- data/rbi/stripe/resources/webhook_endpoint.rbi +18 -25
- data/rbi/stripe/services/account_capability_service.rbi +7 -7
- data/rbi/stripe/services/account_external_account_service.rbi +52 -52
- data/rbi/stripe/services/account_link_service.rbi +9 -9
- data/rbi/stripe/services/account_login_link_service.rbi +2 -2
- data/rbi/stripe/services/account_person_service.rbi +221 -201
- data/rbi/stripe/services/account_service.rbi +1221 -1345
- data/rbi/stripe/services/account_session_service.rbi +115 -346
- data/rbi/stripe/services/apple_pay_domain_service.rbi +10 -10
- data/rbi/stripe/services/application_fee_refund_service.rbi +16 -14
- data/rbi/stripe/services/application_fee_service.rbi +18 -14
- data/rbi/stripe/services/apps/secret_service.rbi +20 -20
- data/rbi/stripe/services/balance_service.rbi +2 -2
- data/rbi/stripe/services/balance_transaction_service.rbi +22 -18
- data/rbi/stripe/services/billing/alert_service.rbi +23 -23
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +10 -10
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +8 -8
- data/rbi/stripe/services/billing/credit_grant_service.rbi +32 -30
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +7 -5
- data/rbi/stripe/services/billing/meter_event_service.rbi +4 -4
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +6 -6
- data/rbi/stripe/services/billing/meter_service.rbi +21 -21
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +90 -76
- data/rbi/stripe/services/billing_portal/session_service.rbi +29 -27
- data/rbi/stripe/services/charge_service.rbi +96 -1464
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +5 -5
- data/rbi/stripe/services/checkout/session_service.rbi +555 -591
- data/rbi/stripe/services/climate/order_service.rbi +22 -20
- data/rbi/stripe/services/climate/product_service.rbi +7 -7
- data/rbi/stripe/services/climate/supplier_service.rbi +7 -7
- data/rbi/stripe/services/confirmation_token_service.rbi +2 -2
- data/rbi/stripe/services/country_spec_service.rbi +7 -7
- data/rbi/stripe/services/coupon_service.rbi +40 -34
- data/rbi/stripe/services/credit_note_line_item_service.rbi +5 -5
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +35 -35
- data/rbi/stripe/services/credit_note_service.rbi +81 -85
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +15 -15
- data/rbi/stripe/services/customer_cash_balance_service.rbi +7 -7
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +7 -7
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +5 -5
- data/rbi/stripe/services/customer_payment_method_service.rbi +9 -9
- data/rbi/stripe/services/customer_payment_source_service.rbi +48 -44
- data/rbi/stripe/services/customer_service.rbi +143 -139
- data/rbi/stripe/services/customer_session_service.rbi +21 -15
- data/rbi/stripe/services/customer_tax_id_service.rbi +9 -9
- data/rbi/stripe/services/dispute_service.rbi +92 -90
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +7 -7
- data/rbi/stripe/services/entitlements/feature_service.rbi +17 -17
- data/rbi/stripe/services/ephemeral_key_service.rbi +8 -8
- data/rbi/stripe/services/event_service.rbi +18 -16
- data/rbi/stripe/services/exchange_rate_service.rbi +7 -7
- data/rbi/stripe/services/file_link_service.rbi +25 -23
- data/rbi/stripe/services/file_service.rbi +22 -20
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +5 -5
- data/rbi/stripe/services/financial_connections/account_service.rbi +22 -21
- data/rbi/stripe/services/financial_connections/session_service.rbi +16 -39
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +16 -14
- data/rbi/stripe/services/financial_connections_service.rbi +0 -1
- data/rbi/stripe/services/forwarding/request_service.rbi +21 -19
- data/rbi/stripe/services/identity/verification_report_service.rbi +18 -16
- data/rbi/stripe/services/identity/verification_session_service.rbi +62 -56
- data/rbi/stripe/services/invoice_item_service.rbi +99 -155
- data/rbi/stripe/services/invoice_line_item_service.rbi +71 -82
- data/rbi/stripe/services/invoice_payment_service.rbi +39 -12
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +13 -13
- data/rbi/stripe/services/invoice_service.rbi +679 -3799
- data/rbi/stripe/services/issuing/authorization_service.rbi +32 -26
- data/rbi/stripe/services/issuing/card_service.rbi +102 -86
- data/rbi/stripe/services/issuing/cardholder_service.rbi +122 -103
- data/rbi/stripe/services/issuing/dispute_service.rbi +152 -146
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +52 -42
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +9 -9
- data/rbi/stripe/services/issuing/token_service.rbi +20 -16
- data/rbi/stripe/services/issuing/transaction_service.rbi +25 -23
- data/rbi/stripe/services/issuing_service.rbi +0 -3
- data/rbi/stripe/services/mandate_service.rbi +2 -2
- data/rbi/stripe/services/payment_intent_service.rbi +2312 -6081
- data/rbi/stripe/services/payment_link_line_item_service.rbi +5 -5
- data/rbi/stripe/services/payment_link_service.rbi +303 -201
- data/rbi/stripe/services/payment_method_configuration_service.rbi +616 -620
- data/rbi/stripe/services/payment_method_domain_service.rbi +25 -23
- data/rbi/stripe/services/payment_method_service.rbi +192 -249
- data/rbi/stripe/services/payout_service.rbi +45 -37
- data/rbi/stripe/services/plan_service.rbi +53 -55
- data/rbi/stripe/services/price_service.rbi +124 -129
- data/rbi/stripe/services/product_feature_service.rbi +9 -9
- data/rbi/stripe/services/product_service.rbi +94 -122
- data/rbi/stripe/services/promotion_code_service.rbi +46 -42
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +5 -5
- data/rbi/stripe/services/quote_line_item_service.rbi +5 -5
- data/rbi/stripe/services/quote_service.rbi +159 -1863
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +17 -15
- data/rbi/stripe/services/radar/value_list_item_service.rbi +20 -16
- data/rbi/stripe/services/radar/value_list_service.rbi +28 -24
- data/rbi/stripe/services/refund_service.rbi +37 -33
- data/rbi/stripe/services/reporting/report_run_service.rbi +29 -25
- data/rbi/stripe/services/reporting/report_type_service.rbi +4 -4
- data/rbi/stripe/services/review_service.rbi +17 -15
- data/rbi/stripe/services/setup_attempt_service.rbi +13 -11
- data/rbi/stripe/services/setup_intent_service.rbi +1028 -1062
- data/rbi/stripe/services/shipping_rate_service.rbi +47 -41
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +7 -7
- data/rbi/stripe/services/source_service.rbi +149 -133
- data/rbi/stripe/services/source_transaction_service.rbi +5 -5
- data/rbi/stripe/services/subscription_item_service.rbi +61 -159
- data/rbi/stripe/services/subscription_schedule_service.rbi +289 -1305
- data/rbi/stripe/services/subscription_service.rbi +366 -640
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +5 -5
- data/rbi/stripe/services/tax/calculation_service.rbi +40 -38
- data/rbi/stripe/services/tax/registration_service.rbi +337 -165
- data/rbi/stripe/services/tax/settings_service.rbi +16 -16
- data/rbi/stripe/services/tax/transaction_line_item_service.rbi +5 -5
- data/rbi/stripe/services/tax/transaction_service.rbi +19 -15
- data/rbi/stripe/services/tax_code_service.rbi +7 -7
- data/rbi/stripe/services/tax_id_service.rbi +17 -17
- data/rbi/stripe/services/tax_rate_service.rbi +36 -34
- data/rbi/stripe/services/tax_service.rbi +0 -2
- data/rbi/stripe/services/terminal/configuration_service.rbi +464 -204
- data/rbi/stripe/services/terminal/connection_token_service.rbi +3 -3
- data/rbi/stripe/services/terminal/location_service.rbi +30 -30
- data/rbi/stripe/services/terminal/reader_service.rbi +57 -226
- data/rbi/stripe/services/terminal_service.rbi +0 -1
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +157 -198
- data/rbi/stripe/services/test_helpers/customer_service.rbi +3 -3
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +180 -168
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +10 -10
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +11 -9
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +151 -145
- data/rbi/stripe/services/test_helpers/refund_service.rbi +2 -2
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +10 -39
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +14 -12
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +9 -9
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +20 -18
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +20 -18
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +11 -38
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +11 -38
- data/rbi/stripe/services/token_service.rbi +292 -258
- data/rbi/stripe/services/topup_service.rbi +37 -33
- data/rbi/stripe/services/transfer_reversal_service.rbi +18 -16
- data/rbi/stripe/services/transfer_service.rbi +29 -27
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +12 -12
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +13 -13
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +23 -26
- data/rbi/stripe/services/treasury/financial_account_service.rbi +92 -96
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +15 -15
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +60 -56
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +24 -49
- data/rbi/stripe/services/treasury/received_credit_service.rbi +11 -9
- data/rbi/stripe/services/treasury/received_debit_service.rbi +8 -8
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +25 -21
- data/rbi/stripe/services/treasury/transaction_service.rbi +31 -23
- data/rbi/stripe/services/v1_services.rbi +1 -7
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +3 -3
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +3 -3
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +21 -24
- data/rbi/stripe/services/v2/core/event_service.rbi +3 -6
- data/rbi/stripe/services/webhook_endpoint_service.rbi +20 -20
- metadata +4 -109
- data/lib/stripe/request_signing_authenticator.rb +0 -79
- data/lib/stripe/resources/account_notice.rb +0 -132
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
- data/lib/stripe/resources/capital/financing_offer.rb +0 -188
- data/lib/stripe/resources/capital/financing_summary.rb +0 -64
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -123
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
- data/lib/stripe/resources/financial_connections/institution.rb +0 -99
- data/lib/stripe/resources/gift_cards/card.rb +0 -217
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -281
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -611
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -84
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -95
- data/lib/stripe/resources/issuing/settlement.rb +0 -49
- data/lib/stripe/resources/margin.rb +0 -124
- data/lib/stripe/resources/order.rb +0 -2868
- data/lib/stripe/resources/payment_attempt_record.rb +0 -184
- data/lib/stripe/resources/payment_record.rb +0 -715
- data/lib/stripe/resources/quote_line.rb +0 -274
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -652
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -362
- data/lib/stripe/resources/tax/association.rb +0 -89
- data/lib/stripe/resources/tax/form.rb +0 -220
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -40
- data/lib/stripe/resources/usage_record.rb +0 -30
- data/lib/stripe/resources/usage_record_summary.rb +0 -33
- data/lib/stripe/services/account_notice_service.rb +0 -101
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
- data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
- data/lib/stripe/services/capital_service.rb +0 -15
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
- data/lib/stripe/services/gift_cards/card_service.rb +0 -170
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
- data/lib/stripe/services/gift_cards_service.rb +0 -14
- data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -1881
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
- data/lib/stripe/services/margin_service.rb +0 -119
- data/lib/stripe/services/order_line_item_service.rb +0 -35
- data/lib/stripe/services/order_service.rb +0 -2268
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
- data/lib/stripe/services/payment_record_service.rb +0 -542
- data/lib/stripe/services/quote_line_service.rb +0 -35
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -35
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
- data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -41
- data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -37
- data/lib/stripe/services/tax/association_service.rb +0 -31
- data/lib/stripe/services/tax/form_service.rb +0 -100
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
- data/rbi/stripe/resources/account_notice.rbi +0 -139
- data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -71
- data/rbi/stripe/resources/capital/financing_offer.rbi +0 -190
- data/rbi/stripe/resources/capital/financing_summary.rbi +0 -74
- data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -130
- data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -27
- data/rbi/stripe/resources/financial_connections/institution.rbi +0 -99
- data/rbi/stripe/resources/gift_cards/card.rbi +0 -206
- data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -257
- data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -622
- data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -83
- data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -90
- data/rbi/stripe/resources/issuing/settlement.rbi +0 -62
- data/rbi/stripe/resources/margin.rbi +0 -127
- data/rbi/stripe/resources/order.rbi +0 -3036
- data/rbi/stripe/resources/payment_attempt_record.rbi +0 -215
- data/rbi/stripe/resources/payment_record.rbi +0 -722
- data/rbi/stripe/resources/quote_line.rbi +0 -350
- data/rbi/stripe/resources/quote_preview_invoice.rbi +0 -850
- data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -474
- data/rbi/stripe/resources/tax/association.rbi +0 -94
- data/rbi/stripe/resources/tax/form.rbi +0 -224
- data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -41
- data/rbi/stripe/resources/usage_record.rbi +0 -32
- data/rbi/stripe/resources/usage_record_summary.rbi +0 -38
- data/rbi/stripe/services/account_notice_service.rbi +0 -90
- data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -95
- data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -22
- data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -68
- data/rbi/stripe/services/capital_service.rbi +0 -11
- data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -33
- data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -46
- data/rbi/stripe/services/gift_cards/card_service.rbi +0 -142
- data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -174
- data/rbi/stripe/services/gift_cards_service.rbi +0 -10
- data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +0 -2023
- data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -498
- data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -55
- data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -73
- data/rbi/stripe/services/margin_service.rbi +0 -104
- data/rbi/stripe/services/order_line_item_service.rbi +0 -31
- data/rbi/stripe/services/order_service.rbi +0 -2320
- data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -36
- data/rbi/stripe/services/payment_record_service.rbi +0 -521
- data/rbi/stripe/services/quote_line_service.rbi +0 -31
- data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -31
- data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -31
- data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -37
- data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -33
- data/rbi/stripe/services/tax/association_service.rbi +0 -25
- data/rbi/stripe/services/tax/form_service.rbi +0 -85
- data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -22
@@ -16,33 +16,33 @@ module Stripe
|
|
16
16
|
end
|
17
17
|
class RetrieveParams < Stripe::RequestParams
|
18
18
|
# Specifies which fields in the response should be expanded.
|
19
|
-
sig { returns(T::Array[String]) }
|
19
|
+
sig { returns(T.nilable(T::Array[String])) }
|
20
20
|
attr_accessor :expand
|
21
|
-
sig { params(expand: T::Array[String]).void }
|
21
|
+
sig { params(expand: T.nilable(T::Array[String])).void }
|
22
22
|
def initialize(expand: nil); end
|
23
23
|
end
|
24
24
|
class UpdateParams < Stripe::RequestParams
|
25
25
|
class Address < Stripe::RequestParams
|
26
26
|
# City, district, suburb, town, or village.
|
27
|
-
sig { returns(String) }
|
27
|
+
sig { returns(T.nilable(String)) }
|
28
28
|
attr_accessor :city
|
29
29
|
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
30
|
-
sig { returns(String) }
|
30
|
+
sig { returns(T.nilable(String)) }
|
31
31
|
attr_accessor :country
|
32
32
|
# Address line 1 (e.g., street, PO Box, or company name).
|
33
|
-
sig { returns(String) }
|
33
|
+
sig { returns(T.nilable(String)) }
|
34
34
|
attr_accessor :line1
|
35
35
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
36
|
-
sig { returns(String) }
|
36
|
+
sig { returns(T.nilable(String)) }
|
37
37
|
attr_accessor :line2
|
38
38
|
# ZIP or postal code.
|
39
|
-
sig { returns(String) }
|
39
|
+
sig { returns(T.nilable(String)) }
|
40
40
|
attr_accessor :postal_code
|
41
41
|
# State, county, province, or region.
|
42
|
-
sig { returns(String) }
|
42
|
+
sig { returns(T.nilable(String)) }
|
43
43
|
attr_accessor :state
|
44
44
|
sig {
|
45
|
-
params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
|
45
|
+
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
|
46
46
|
}
|
47
47
|
def initialize(
|
48
48
|
city: nil,
|
@@ -56,17 +56,17 @@ module Stripe
|
|
56
56
|
class CashBalance < Stripe::RequestParams
|
57
57
|
class Settings < Stripe::RequestParams
|
58
58
|
# Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
|
59
|
-
sig { returns(String) }
|
59
|
+
sig { returns(T.nilable(String)) }
|
60
60
|
attr_accessor :reconciliation_mode
|
61
|
-
sig { params(reconciliation_mode: String).void }
|
61
|
+
sig { params(reconciliation_mode: T.nilable(String)).void }
|
62
62
|
def initialize(reconciliation_mode: nil); end
|
63
63
|
end
|
64
64
|
# Settings controlling the behavior of the customer's cash balance,
|
65
65
|
# such as reconciliation of funds received.
|
66
|
-
sig { returns(::Stripe::CustomerService::UpdateParams::CashBalance::Settings) }
|
66
|
+
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance::Settings)) }
|
67
67
|
attr_accessor :settings
|
68
68
|
sig {
|
69
|
-
params(settings: ::Stripe::CustomerService::UpdateParams::CashBalance::Settings).void
|
69
|
+
params(settings: T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance::Settings)).void
|
70
70
|
}
|
71
71
|
def initialize(settings: nil); end
|
72
72
|
end
|
@@ -83,32 +83,34 @@ module Stripe
|
|
83
83
|
end
|
84
84
|
class RenderingOptions < Stripe::RequestParams
|
85
85
|
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
86
|
-
sig { returns(T.nilable(String)) }
|
86
|
+
sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
|
87
87
|
attr_accessor :amount_tax_display
|
88
88
|
# ID of the invoice rendering template to use for future invoices.
|
89
|
-
sig { returns(String) }
|
89
|
+
sig { returns(T.nilable(String)) }
|
90
90
|
attr_accessor :template
|
91
|
-
sig {
|
91
|
+
sig {
|
92
|
+
params(amount_tax_display: T.nilable(T.nilable(T.any(String, String))), template: T.nilable(String)).void
|
93
|
+
}
|
92
94
|
def initialize(amount_tax_display: nil, template: nil); end
|
93
95
|
end
|
94
96
|
# The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
|
95
97
|
sig {
|
96
|
-
returns(T.nilable(T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField]))
|
98
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField]))))
|
97
99
|
}
|
98
100
|
attr_accessor :custom_fields
|
99
101
|
# ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
|
100
|
-
sig { returns(String) }
|
102
|
+
sig { returns(T.nilable(String)) }
|
101
103
|
attr_accessor :default_payment_method
|
102
104
|
# Default footer to be displayed on invoices for this customer.
|
103
|
-
sig { returns(String) }
|
105
|
+
sig { returns(T.nilable(String)) }
|
104
106
|
attr_accessor :footer
|
105
107
|
# Default options for invoice PDF rendering for this customer.
|
106
108
|
sig {
|
107
|
-
returns(T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions))
|
109
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions))))
|
108
110
|
}
|
109
111
|
attr_accessor :rendering_options
|
110
112
|
sig {
|
111
|
-
params(custom_fields: T.nilable(T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField]), default_payment_method: String, footer: String, rendering_options: T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions)).void
|
113
|
+
params(custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::UpdateParams::InvoiceSettings::CustomField]))), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::InvoiceSettings::RenderingOptions)))).void
|
112
114
|
}
|
113
115
|
def initialize(
|
114
116
|
custom_fields: nil,
|
@@ -120,25 +122,25 @@ module Stripe
|
|
120
122
|
class Shipping < Stripe::RequestParams
|
121
123
|
class Address < Stripe::RequestParams
|
122
124
|
# City, district, suburb, town, or village.
|
123
|
-
sig { returns(String) }
|
125
|
+
sig { returns(T.nilable(String)) }
|
124
126
|
attr_accessor :city
|
125
127
|
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
126
|
-
sig { returns(String) }
|
128
|
+
sig { returns(T.nilable(String)) }
|
127
129
|
attr_accessor :country
|
128
130
|
# Address line 1 (e.g., street, PO Box, or company name).
|
129
|
-
sig { returns(String) }
|
131
|
+
sig { returns(T.nilable(String)) }
|
130
132
|
attr_accessor :line1
|
131
133
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
132
|
-
sig { returns(String) }
|
134
|
+
sig { returns(T.nilable(String)) }
|
133
135
|
attr_accessor :line2
|
134
136
|
# ZIP or postal code.
|
135
|
-
sig { returns(String) }
|
137
|
+
sig { returns(T.nilable(String)) }
|
136
138
|
attr_accessor :postal_code
|
137
139
|
# State, county, province, or region.
|
138
|
-
sig { returns(String) }
|
140
|
+
sig { returns(T.nilable(String)) }
|
139
141
|
attr_accessor :state
|
140
142
|
sig {
|
141
|
-
params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
|
143
|
+
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
|
142
144
|
}
|
143
145
|
def initialize(
|
144
146
|
city: nil,
|
@@ -156,98 +158,97 @@ module Stripe
|
|
156
158
|
sig { returns(String) }
|
157
159
|
attr_accessor :name
|
158
160
|
# Customer phone (including extension).
|
159
|
-
sig { returns(String) }
|
161
|
+
sig { returns(T.nilable(String)) }
|
160
162
|
attr_accessor :phone
|
161
163
|
sig {
|
162
|
-
params(address: ::Stripe::CustomerService::UpdateParams::Shipping::Address, name: String, phone: String).void
|
164
|
+
params(address: ::Stripe::CustomerService::UpdateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
|
163
165
|
}
|
164
166
|
def initialize(address: nil, name: nil, phone: nil); end
|
165
167
|
end
|
166
168
|
class Tax < Stripe::RequestParams
|
167
169
|
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
|
168
|
-
sig { returns(T.nilable(String)) }
|
170
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
169
171
|
attr_accessor :ip_address
|
170
172
|
# A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
|
171
|
-
sig { returns(String) }
|
173
|
+
sig { returns(T.nilable(String)) }
|
172
174
|
attr_accessor :validate_location
|
173
|
-
sig {
|
175
|
+
sig {
|
176
|
+
params(ip_address: T.nilable(T.nilable(String)), validate_location: T.nilable(String)).void
|
177
|
+
}
|
174
178
|
def initialize(ip_address: nil, validate_location: nil); end
|
175
179
|
end
|
176
180
|
# The customer's address.
|
177
|
-
sig {
|
181
|
+
sig {
|
182
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Address))))
|
183
|
+
}
|
178
184
|
attr_accessor :address
|
179
185
|
# An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
|
180
|
-
sig { returns(Integer) }
|
186
|
+
sig { returns(T.nilable(Integer)) }
|
181
187
|
attr_accessor :balance
|
182
188
|
# Balance information and default balance settings for this customer.
|
183
|
-
sig { returns(::Stripe::CustomerService::UpdateParams::CashBalance) }
|
189
|
+
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance)) }
|
184
190
|
attr_accessor :cash_balance
|
185
|
-
# Attribute for param field coupon
|
186
|
-
sig { returns(String) }
|
187
|
-
attr_accessor :coupon
|
188
191
|
# If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.
|
189
192
|
#
|
190
193
|
# Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
|
191
194
|
#
|
192
195
|
# If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.
|
193
|
-
sig { returns(String) }
|
196
|
+
sig { returns(T.nilable(String)) }
|
194
197
|
attr_accessor :default_source
|
195
198
|
# An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
|
196
|
-
sig { returns(String) }
|
199
|
+
sig { returns(T.nilable(String)) }
|
197
200
|
attr_accessor :description
|
198
201
|
# Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
|
199
|
-
sig { returns(String) }
|
202
|
+
sig { returns(T.nilable(String)) }
|
200
203
|
attr_accessor :email
|
201
204
|
# Specifies which fields in the response should be expanded.
|
202
|
-
sig { returns(T::Array[String]) }
|
205
|
+
sig { returns(T.nilable(T::Array[String])) }
|
203
206
|
attr_accessor :expand
|
204
207
|
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
|
205
|
-
sig { returns(String) }
|
208
|
+
sig { returns(T.nilable(String)) }
|
206
209
|
attr_accessor :invoice_prefix
|
207
210
|
# Default invoice settings for this customer.
|
208
|
-
sig { returns(::Stripe::CustomerService::UpdateParams::InvoiceSettings) }
|
211
|
+
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings)) }
|
209
212
|
attr_accessor :invoice_settings
|
210
213
|
# Set of [key-value pairs](https://stripe.com/docs/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`.
|
211
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
214
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
212
215
|
attr_accessor :metadata
|
213
216
|
# The customer's full name or business name.
|
214
|
-
sig { returns(String) }
|
217
|
+
sig { returns(T.nilable(String)) }
|
215
218
|
attr_accessor :name
|
216
219
|
# The sequence to be used on the customer's next invoice. Defaults to 1.
|
217
|
-
sig { returns(Integer) }
|
220
|
+
sig { returns(T.nilable(Integer)) }
|
218
221
|
attr_accessor :next_invoice_sequence
|
219
222
|
# The customer's phone number.
|
220
|
-
sig { returns(String) }
|
223
|
+
sig { returns(T.nilable(String)) }
|
221
224
|
attr_accessor :phone
|
222
225
|
# Customer's preferred languages, ordered by preference.
|
223
|
-
sig { returns(T::Array[String]) }
|
226
|
+
sig { returns(T.nilable(T::Array[String])) }
|
224
227
|
attr_accessor :preferred_locales
|
225
|
-
# The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
|
226
|
-
sig { returns(String) }
|
227
|
-
attr_accessor :promotion_code
|
228
228
|
# The customer's shipping information. Appears on invoices emailed to this customer.
|
229
|
-
sig {
|
229
|
+
sig {
|
230
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Shipping))))
|
231
|
+
}
|
230
232
|
attr_accessor :shipping
|
231
233
|
# Attribute for param field source
|
232
|
-
sig { returns(String) }
|
234
|
+
sig { returns(T.nilable(String)) }
|
233
235
|
attr_accessor :source
|
234
236
|
# Tax details about the customer.
|
235
|
-
sig { returns(::Stripe::CustomerService::UpdateParams::Tax) }
|
237
|
+
sig { returns(T.nilable(::Stripe::CustomerService::UpdateParams::Tax)) }
|
236
238
|
attr_accessor :tax
|
237
239
|
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
|
238
|
-
sig { returns(T.nilable(String)) }
|
240
|
+
sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
|
239
241
|
attr_accessor :tax_exempt
|
240
242
|
# Attribute for param field validate
|
241
|
-
sig { returns(T::Boolean) }
|
243
|
+
sig { returns(T.nilable(T::Boolean)) }
|
242
244
|
attr_accessor :validate
|
243
245
|
sig {
|
244
|
-
params(address: T.nilable(::Stripe::CustomerService::UpdateParams::Address), balance: Integer, cash_balance: ::Stripe::CustomerService::UpdateParams::CashBalance,
|
246
|
+
params(address: T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Address))), balance: T.nilable(Integer), cash_balance: T.nilable(::Stripe::CustomerService::UpdateParams::CashBalance), default_source: T.nilable(String), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::CustomerService::UpdateParams::InvoiceSettings), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::UpdateParams::Shipping))), source: T.nilable(String), tax: T.nilable(::Stripe::CustomerService::UpdateParams::Tax), tax_exempt: T.nilable(T.nilable(T.any(String, String))), validate: T.nilable(T::Boolean)).void
|
245
247
|
}
|
246
248
|
def initialize(
|
247
249
|
address: nil,
|
248
250
|
balance: nil,
|
249
251
|
cash_balance: nil,
|
250
|
-
coupon: nil,
|
251
252
|
default_source: nil,
|
252
253
|
description: nil,
|
253
254
|
email: nil,
|
@@ -259,7 +260,6 @@ module Stripe
|
|
259
260
|
next_invoice_sequence: nil,
|
260
261
|
phone: nil,
|
261
262
|
preferred_locales: nil,
|
262
|
-
promotion_code: nil,
|
263
263
|
shipping: nil,
|
264
264
|
source: nil,
|
265
265
|
tax: nil,
|
@@ -273,43 +273,45 @@ module Stripe
|
|
273
273
|
class ListParams < Stripe::RequestParams
|
274
274
|
class Created < Stripe::RequestParams
|
275
275
|
# Minimum value to filter by (exclusive)
|
276
|
-
sig { returns(Integer) }
|
276
|
+
sig { returns(T.nilable(Integer)) }
|
277
277
|
attr_accessor :gt
|
278
278
|
# Minimum value to filter by (inclusive)
|
279
|
-
sig { returns(Integer) }
|
279
|
+
sig { returns(T.nilable(Integer)) }
|
280
280
|
attr_accessor :gte
|
281
281
|
# Maximum value to filter by (exclusive)
|
282
|
-
sig { returns(Integer) }
|
282
|
+
sig { returns(T.nilable(Integer)) }
|
283
283
|
attr_accessor :lt
|
284
284
|
# Maximum value to filter by (inclusive)
|
285
|
-
sig { returns(Integer) }
|
285
|
+
sig { returns(T.nilable(Integer)) }
|
286
286
|
attr_accessor :lte
|
287
|
-
sig {
|
287
|
+
sig {
|
288
|
+
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
|
289
|
+
}
|
288
290
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
289
291
|
end
|
290
292
|
# Only return customers that were created during the given date interval.
|
291
|
-
sig { returns(T.any(::Stripe::CustomerService::ListParams::Created, Integer)) }
|
293
|
+
sig { returns(T.nilable(T.any(::Stripe::CustomerService::ListParams::Created, Integer))) }
|
292
294
|
attr_accessor :created
|
293
295
|
# A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
|
294
|
-
sig { returns(String) }
|
296
|
+
sig { returns(T.nilable(String)) }
|
295
297
|
attr_accessor :email
|
296
298
|
# 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.
|
297
|
-
sig { returns(String) }
|
299
|
+
sig { returns(T.nilable(String)) }
|
298
300
|
attr_accessor :ending_before
|
299
301
|
# Specifies which fields in the response should be expanded.
|
300
|
-
sig { returns(T::Array[String]) }
|
302
|
+
sig { returns(T.nilable(T::Array[String])) }
|
301
303
|
attr_accessor :expand
|
302
304
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
303
|
-
sig { returns(Integer) }
|
305
|
+
sig { returns(T.nilable(Integer)) }
|
304
306
|
attr_accessor :limit
|
305
307
|
# 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.
|
306
|
-
sig { returns(String) }
|
308
|
+
sig { returns(T.nilable(String)) }
|
307
309
|
attr_accessor :starting_after
|
308
310
|
# Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.
|
309
|
-
sig { returns(String) }
|
311
|
+
sig { returns(T.nilable(String)) }
|
310
312
|
attr_accessor :test_clock
|
311
313
|
sig {
|
312
|
-
params(created: T.any(::Stripe::CustomerService::ListParams::Created, Integer), email: String, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, test_clock: String).void
|
314
|
+
params(created: T.nilable(T.any(::Stripe::CustomerService::ListParams::Created, Integer)), email: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), test_clock: T.nilable(String)).void
|
313
315
|
}
|
314
316
|
def initialize(
|
315
317
|
created: nil,
|
@@ -324,25 +326,25 @@ module Stripe
|
|
324
326
|
class CreateParams < Stripe::RequestParams
|
325
327
|
class Address < Stripe::RequestParams
|
326
328
|
# City, district, suburb, town, or village.
|
327
|
-
sig { returns(String) }
|
329
|
+
sig { returns(T.nilable(String)) }
|
328
330
|
attr_accessor :city
|
329
331
|
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
330
|
-
sig { returns(String) }
|
332
|
+
sig { returns(T.nilable(String)) }
|
331
333
|
attr_accessor :country
|
332
334
|
# Address line 1 (e.g., street, PO Box, or company name).
|
333
|
-
sig { returns(String) }
|
335
|
+
sig { returns(T.nilable(String)) }
|
334
336
|
attr_accessor :line1
|
335
337
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
336
|
-
sig { returns(String) }
|
338
|
+
sig { returns(T.nilable(String)) }
|
337
339
|
attr_accessor :line2
|
338
340
|
# ZIP or postal code.
|
339
|
-
sig { returns(String) }
|
341
|
+
sig { returns(T.nilable(String)) }
|
340
342
|
attr_accessor :postal_code
|
341
343
|
# State, county, province, or region.
|
342
|
-
sig { returns(String) }
|
344
|
+
sig { returns(T.nilable(String)) }
|
343
345
|
attr_accessor :state
|
344
346
|
sig {
|
345
|
-
params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
|
347
|
+
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
|
346
348
|
}
|
347
349
|
def initialize(
|
348
350
|
city: nil,
|
@@ -356,17 +358,17 @@ module Stripe
|
|
356
358
|
class CashBalance < Stripe::RequestParams
|
357
359
|
class Settings < Stripe::RequestParams
|
358
360
|
# Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
|
359
|
-
sig { returns(String) }
|
361
|
+
sig { returns(T.nilable(String)) }
|
360
362
|
attr_accessor :reconciliation_mode
|
361
|
-
sig { params(reconciliation_mode: String).void }
|
363
|
+
sig { params(reconciliation_mode: T.nilable(String)).void }
|
362
364
|
def initialize(reconciliation_mode: nil); end
|
363
365
|
end
|
364
366
|
# Settings controlling the behavior of the customer's cash balance,
|
365
367
|
# such as reconciliation of funds received.
|
366
|
-
sig { returns(::Stripe::CustomerService::CreateParams::CashBalance::Settings) }
|
368
|
+
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::CashBalance::Settings)) }
|
367
369
|
attr_accessor :settings
|
368
370
|
sig {
|
369
|
-
params(settings: ::Stripe::CustomerService::CreateParams::CashBalance::Settings).void
|
371
|
+
params(settings: T.nilable(::Stripe::CustomerService::CreateParams::CashBalance::Settings)).void
|
370
372
|
}
|
371
373
|
def initialize(settings: nil); end
|
372
374
|
end
|
@@ -383,32 +385,34 @@ module Stripe
|
|
383
385
|
end
|
384
386
|
class RenderingOptions < Stripe::RequestParams
|
385
387
|
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
386
|
-
sig { returns(T.nilable(String)) }
|
388
|
+
sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
|
387
389
|
attr_accessor :amount_tax_display
|
388
390
|
# ID of the invoice rendering template to use for future invoices.
|
389
|
-
sig { returns(String) }
|
391
|
+
sig { returns(T.nilable(String)) }
|
390
392
|
attr_accessor :template
|
391
|
-
sig {
|
393
|
+
sig {
|
394
|
+
params(amount_tax_display: T.nilable(T.nilable(T.any(String, String))), template: T.nilable(String)).void
|
395
|
+
}
|
392
396
|
def initialize(amount_tax_display: nil, template: nil); end
|
393
397
|
end
|
394
398
|
# The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
|
395
399
|
sig {
|
396
|
-
returns(T.nilable(T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField]))
|
400
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField]))))
|
397
401
|
}
|
398
402
|
attr_accessor :custom_fields
|
399
403
|
# ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
|
400
|
-
sig { returns(String) }
|
404
|
+
sig { returns(T.nilable(String)) }
|
401
405
|
attr_accessor :default_payment_method
|
402
406
|
# Default footer to be displayed on invoices for this customer.
|
403
|
-
sig { returns(String) }
|
407
|
+
sig { returns(T.nilable(String)) }
|
404
408
|
attr_accessor :footer
|
405
409
|
# Default options for invoice PDF rendering for this customer.
|
406
410
|
sig {
|
407
|
-
returns(T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions))
|
411
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions))))
|
408
412
|
}
|
409
413
|
attr_accessor :rendering_options
|
410
414
|
sig {
|
411
|
-
params(custom_fields: T.nilable(T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField]), default_payment_method: String, footer: String, rendering_options: T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions)).void
|
415
|
+
params(custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::CustomerService::CreateParams::InvoiceSettings::CustomField]))), default_payment_method: T.nilable(String), footer: T.nilable(String), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::InvoiceSettings::RenderingOptions)))).void
|
412
416
|
}
|
413
417
|
def initialize(
|
414
418
|
custom_fields: nil,
|
@@ -420,25 +424,25 @@ module Stripe
|
|
420
424
|
class Shipping < Stripe::RequestParams
|
421
425
|
class Address < Stripe::RequestParams
|
422
426
|
# City, district, suburb, town, or village.
|
423
|
-
sig { returns(String) }
|
427
|
+
sig { returns(T.nilable(String)) }
|
424
428
|
attr_accessor :city
|
425
429
|
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
426
|
-
sig { returns(String) }
|
430
|
+
sig { returns(T.nilable(String)) }
|
427
431
|
attr_accessor :country
|
428
432
|
# Address line 1 (e.g., street, PO Box, or company name).
|
429
|
-
sig { returns(String) }
|
433
|
+
sig { returns(T.nilable(String)) }
|
430
434
|
attr_accessor :line1
|
431
435
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
432
|
-
sig { returns(String) }
|
436
|
+
sig { returns(T.nilable(String)) }
|
433
437
|
attr_accessor :line2
|
434
438
|
# ZIP or postal code.
|
435
|
-
sig { returns(String) }
|
439
|
+
sig { returns(T.nilable(String)) }
|
436
440
|
attr_accessor :postal_code
|
437
441
|
# State, county, province, or region.
|
438
|
-
sig { returns(String) }
|
442
|
+
sig { returns(T.nilable(String)) }
|
439
443
|
attr_accessor :state
|
440
444
|
sig {
|
441
|
-
params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
|
445
|
+
params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
|
442
446
|
}
|
443
447
|
def initialize(
|
444
448
|
city: nil,
|
@@ -456,21 +460,23 @@ module Stripe
|
|
456
460
|
sig { returns(String) }
|
457
461
|
attr_accessor :name
|
458
462
|
# Customer phone (including extension).
|
459
|
-
sig { returns(String) }
|
463
|
+
sig { returns(T.nilable(String)) }
|
460
464
|
attr_accessor :phone
|
461
465
|
sig {
|
462
|
-
params(address: ::Stripe::CustomerService::CreateParams::Shipping::Address, name: String, phone: String).void
|
466
|
+
params(address: ::Stripe::CustomerService::CreateParams::Shipping::Address, name: String, phone: T.nilable(String)).void
|
463
467
|
}
|
464
468
|
def initialize(address: nil, name: nil, phone: nil); end
|
465
469
|
end
|
466
470
|
class Tax < Stripe::RequestParams
|
467
471
|
# A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
|
468
|
-
sig { returns(T.nilable(String)) }
|
472
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
469
473
|
attr_accessor :ip_address
|
470
474
|
# A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.
|
471
|
-
sig { returns(String) }
|
475
|
+
sig { returns(T.nilable(String)) }
|
472
476
|
attr_accessor :validate_location
|
473
|
-
sig {
|
477
|
+
sig {
|
478
|
+
params(ip_address: T.nilable(T.nilable(String)), validate_location: T.nilable(String)).void
|
479
|
+
}
|
474
480
|
def initialize(ip_address: nil, validate_location: nil); end
|
475
481
|
end
|
476
482
|
class TaxIdDatum < Stripe::RequestParams
|
@@ -484,82 +490,79 @@ module Stripe
|
|
484
490
|
def initialize(type: nil, value: nil); end
|
485
491
|
end
|
486
492
|
# The customer's address.
|
487
|
-
sig {
|
493
|
+
sig {
|
494
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Address))))
|
495
|
+
}
|
488
496
|
attr_accessor :address
|
489
497
|
# An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
|
490
|
-
sig { returns(Integer) }
|
498
|
+
sig { returns(T.nilable(Integer)) }
|
491
499
|
attr_accessor :balance
|
492
500
|
# Balance information and default balance settings for this customer.
|
493
|
-
sig { returns(::Stripe::CustomerService::CreateParams::CashBalance) }
|
501
|
+
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::CashBalance)) }
|
494
502
|
attr_accessor :cash_balance
|
495
|
-
# Attribute for param field coupon
|
496
|
-
sig { returns(String) }
|
497
|
-
attr_accessor :coupon
|
498
503
|
# An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
|
499
|
-
sig { returns(String) }
|
504
|
+
sig { returns(T.nilable(String)) }
|
500
505
|
attr_accessor :description
|
501
506
|
# Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
|
502
|
-
sig { returns(String) }
|
507
|
+
sig { returns(T.nilable(String)) }
|
503
508
|
attr_accessor :email
|
504
509
|
# Specifies which fields in the response should be expanded.
|
505
|
-
sig { returns(T::Array[String]) }
|
510
|
+
sig { returns(T.nilable(T::Array[String])) }
|
506
511
|
attr_accessor :expand
|
507
512
|
# The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
|
508
|
-
sig { returns(String) }
|
513
|
+
sig { returns(T.nilable(String)) }
|
509
514
|
attr_accessor :invoice_prefix
|
510
515
|
# Default invoice settings for this customer.
|
511
|
-
sig { returns(::Stripe::CustomerService::CreateParams::InvoiceSettings) }
|
516
|
+
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings)) }
|
512
517
|
attr_accessor :invoice_settings
|
513
518
|
# Set of [key-value pairs](https://stripe.com/docs/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`.
|
514
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
519
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
515
520
|
attr_accessor :metadata
|
516
521
|
# The customer's full name or business name.
|
517
|
-
sig { returns(String) }
|
522
|
+
sig { returns(T.nilable(String)) }
|
518
523
|
attr_accessor :name
|
519
524
|
# The sequence to be used on the customer's next invoice. Defaults to 1.
|
520
|
-
sig { returns(Integer) }
|
525
|
+
sig { returns(T.nilable(Integer)) }
|
521
526
|
attr_accessor :next_invoice_sequence
|
522
527
|
# Attribute for param field payment_method
|
523
|
-
sig { returns(String) }
|
528
|
+
sig { returns(T.nilable(String)) }
|
524
529
|
attr_accessor :payment_method
|
525
530
|
# The customer's phone number.
|
526
|
-
sig { returns(String) }
|
531
|
+
sig { returns(T.nilable(String)) }
|
527
532
|
attr_accessor :phone
|
528
533
|
# Customer's preferred languages, ordered by preference.
|
529
|
-
sig { returns(T::Array[String]) }
|
534
|
+
sig { returns(T.nilable(T::Array[String])) }
|
530
535
|
attr_accessor :preferred_locales
|
531
|
-
# The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
|
532
|
-
sig { returns(String) }
|
533
|
-
attr_accessor :promotion_code
|
534
536
|
# The customer's shipping information. Appears on invoices emailed to this customer.
|
535
|
-
sig {
|
537
|
+
sig {
|
538
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Shipping))))
|
539
|
+
}
|
536
540
|
attr_accessor :shipping
|
537
541
|
# Attribute for param field source
|
538
|
-
sig { returns(String) }
|
542
|
+
sig { returns(T.nilable(String)) }
|
539
543
|
attr_accessor :source
|
540
544
|
# Tax details about the customer.
|
541
|
-
sig { returns(::Stripe::CustomerService::CreateParams::Tax) }
|
545
|
+
sig { returns(T.nilable(::Stripe::CustomerService::CreateParams::Tax)) }
|
542
546
|
attr_accessor :tax
|
543
547
|
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
|
544
|
-
sig { returns(T.nilable(String)) }
|
548
|
+
sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
|
545
549
|
attr_accessor :tax_exempt
|
546
550
|
# The customer's tax IDs.
|
547
|
-
sig { returns(T::Array[::Stripe::CustomerService::CreateParams::TaxIdDatum]) }
|
551
|
+
sig { returns(T.nilable(T::Array[::Stripe::CustomerService::CreateParams::TaxIdDatum])) }
|
548
552
|
attr_accessor :tax_id_data
|
549
553
|
# ID of the test clock to attach to the customer.
|
550
|
-
sig { returns(String) }
|
554
|
+
sig { returns(T.nilable(String)) }
|
551
555
|
attr_accessor :test_clock
|
552
556
|
# Attribute for param field validate
|
553
|
-
sig { returns(T::Boolean) }
|
557
|
+
sig { returns(T.nilable(T::Boolean)) }
|
554
558
|
attr_accessor :validate
|
555
559
|
sig {
|
556
|
-
params(address: T.nilable(::Stripe::CustomerService::CreateParams::Address), balance: Integer, cash_balance: ::Stripe::CustomerService::CreateParams::CashBalance,
|
560
|
+
params(address: T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Address))), balance: T.nilable(Integer), cash_balance: T.nilable(::Stripe::CustomerService::CreateParams::CashBalance), description: T.nilable(String), email: T.nilable(String), expand: T.nilable(T::Array[String]), invoice_prefix: T.nilable(String), invoice_settings: T.nilable(::Stripe::CustomerService::CreateParams::InvoiceSettings), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String), next_invoice_sequence: T.nilable(Integer), payment_method: T.nilable(String), phone: T.nilable(String), preferred_locales: T.nilable(T::Array[String]), shipping: T.nilable(T.nilable(T.any(String, ::Stripe::CustomerService::CreateParams::Shipping))), source: T.nilable(String), tax: T.nilable(::Stripe::CustomerService::CreateParams::Tax), tax_exempt: T.nilable(T.nilable(T.any(String, String))), tax_id_data: T.nilable(T::Array[::Stripe::CustomerService::CreateParams::TaxIdDatum]), test_clock: T.nilable(String), validate: T.nilable(T::Boolean)).void
|
557
561
|
}
|
558
562
|
def initialize(
|
559
563
|
address: nil,
|
560
564
|
balance: nil,
|
561
565
|
cash_balance: nil,
|
562
|
-
coupon: nil,
|
563
566
|
description: nil,
|
564
567
|
email: nil,
|
565
568
|
expand: nil,
|
@@ -571,7 +574,6 @@ module Stripe
|
|
571
574
|
payment_method: nil,
|
572
575
|
phone: nil,
|
573
576
|
preferred_locales: nil,
|
574
|
-
promotion_code: nil,
|
575
577
|
shipping: nil,
|
576
578
|
source: nil,
|
577
579
|
tax: nil,
|
@@ -583,18 +585,20 @@ module Stripe
|
|
583
585
|
end
|
584
586
|
class SearchParams < Stripe::RequestParams
|
585
587
|
# Specifies which fields in the response should be expanded.
|
586
|
-
sig { returns(T::Array[String]) }
|
588
|
+
sig { returns(T.nilable(T::Array[String])) }
|
587
589
|
attr_accessor :expand
|
588
590
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
589
|
-
sig { returns(Integer) }
|
591
|
+
sig { returns(T.nilable(Integer)) }
|
590
592
|
attr_accessor :limit
|
591
593
|
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
|
592
|
-
sig { returns(String) }
|
594
|
+
sig { returns(T.nilable(String)) }
|
593
595
|
attr_accessor :page
|
594
596
|
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).
|
595
597
|
sig { returns(String) }
|
596
598
|
attr_accessor :query
|
597
|
-
sig {
|
599
|
+
sig {
|
600
|
+
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
|
601
|
+
}
|
598
602
|
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
|
599
603
|
end
|
600
604
|
# Creates a new customer object.
|