stripe 15.0.0 → 15.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac9a4371f393b1650cd2b5198d4e2ceed046c9676183b0d339fd985c4b8b815
-  data.tar.gz: 3fc59d72c6450657a7797088c39f5c85d9b8bba505992cfc3fdbdc7a8d27fb7d
+  metadata.gz: a2d72c2e4fa9d62e0defa6c35a5ca4555ab0d0e20afb07eb31b185fe1be8eea1
+  data.tar.gz: a5482622bdb95231f47b7444df5d37402b689fd7771d4a209cb695c89141639d
 SHA512:
-  metadata.gz: 4f156649ca332eff3a2837ec1f038ebcc8ab9f5c35194d031e2610b45ef6b74cb0b651b3402d0afa98375a7ac293f0e54761e191dd6237e58e372b42b2cba681
-  data.tar.gz: 1cb72620268bf94d44b0ddd6090b41404efc0b25606759907c2a3d6821577b45b488738bdfdac34b6ba3a6e9fb769d9646ad1b184580d84fac3df6451a0fd172
+  metadata.gz: 73e5f19aebfc269911a6061214abe943dfe29cbc70f578cf9cdc271ba69c6c42d8f99ac462ef6ffe5450d38fe984fa4970b391b45cd573d6064f0b4acc5b2054
+  data.tar.gz: 5fcd5f114f06a5b050702059942f4d3d7563d82a59b42c84ac8fa6c407022b29ee7e428076646a7a3fde6cf77394143ed920782287a747aedc0be9251d04b290

data/API_VERSION

@@ -0,0 +1 @@
+2025-06-30.basil

data/CHANGELOG.md

@@ -1,4 +1,89 @@
 # Changelog
+## 15.3.0 - 2025-07-01
+* [#1618](https://github.com/stripe/stripe-ruby/pull/1618) Update generated code
+  * Add support for `migrate` method on resource `Subscription`
+  * Add support for `collect_payment_method` and `confirm_payment_intent` methods on resource `Terminal::Reader`
+  * Add support for `crypto_payments` on `Account::Capability`, `Account::CreateParams::Capability`, and `Account::UpdateParams::Capability`
+  * Add support for `proof_of_address` on `Account::CreateParams::Document` and `Account::UpdateParams::Document`
+  * Add support for `monthly_payout_days` and `weekly_payout_days` on `Account::CreateParams::Setting::Payout::Schedule`, `Account::Setting::Payout::Schedule`, and `Account::UpdateParams::Setting::Payout::Schedule`
+  * Change `Account::Setting::Invoice.hosted_payment_method_save` to be required
+  * Add support for `crypto` on `Charge::PaymentMethodDetail`, `ConfirmationToken::CreateParams::PaymentMethodDatum`, `ConfirmationToken::PaymentMethodPreview`, `PaymentIntent::ConfirmParams::PaymentMethodDatum`, `PaymentIntent::ConfirmParams::PaymentMethodOption`, `PaymentIntent::CreateParams::PaymentMethodDatum`, `PaymentIntent::CreateParams::PaymentMethodOption`, `PaymentIntent::PaymentMethodOption`, `PaymentIntent::UpdateParams::PaymentMethodDatum`, `PaymentIntent::UpdateParams::PaymentMethodOption`, `PaymentMethod::CreateParams`, `PaymentMethod`, `SetupIntent::ConfirmParams::PaymentMethodDatum`, `SetupIntent::CreateParams::PaymentMethodDatum`, and `SetupIntent::UpdateParams::PaymentMethodDatum`
+  * Change type of `Charge::PaymentMethodDetail::Card::Installment::Plan.type`, `ConfirmationToken::CreateParams::PaymentMethodOption::Card::Installment::Plan.type`, `ConfirmationToken::PaymentMethodOption::Card::Installment::Plan.type`, `Invoice::CreateParams::PaymentSetting::PaymentMethodOption::Card::Installment::Plan.type`, `Invoice::UpdateParams::PaymentSetting::PaymentMethodOption::Card::Installment::Plan.type`, `PaymentIntent::ConfirmParams::PaymentMethodOption::Card::Installment::Plan.type`, `PaymentIntent::CreateParams::PaymentMethodOption::Card::Installment::Plan.type`, `PaymentIntent::PaymentMethodOption::Card::Installment::AvailablePlan.type`, `PaymentIntent::PaymentMethodOption::Card::Installment::Plan.type`, and `PaymentIntent::UpdateParams::PaymentMethodOption::Card::Installment::Plan.type` from `literal('fixed_count')` to `enum('bonus'|'fixed_count'|'revolving')`
+  * Add support for `subscriptions` on `Checkout::Session::CreateParams::PaymentMethodOption::Klarna`, `PaymentIntent::ConfirmParams::PaymentMethodOption::Klarna`, `PaymentIntent::CreateParams::PaymentMethodOption::Klarna`, and `PaymentIntent::UpdateParams::PaymentMethodOption::Klarna`
+  * Add support for `billing_mode` on `Checkout::Session::CreateParams::SubscriptionDatum`, `Invoice::CreatePreviewParams::ScheduleDetail`, `Invoice::CreatePreviewParams::SubscriptionDetail`, `Quote::CreateParams::SubscriptionDatum`, `Quote::SubscriptionDatum`, `Subscription::CreateParams`, `SubscriptionSchedule::CreateParams`, `SubscriptionSchedule`, and `Subscription`
+  * Change type of `Dispute.enhanced_eligibility_types` from `literal('visa_compelling_evidence_3')` to `enum('visa_compelling_evidence_3'|'visa_compliance')`
+  * Add support for `related_person` on `Identity::VerificationSession::CreateParams` and `Identity::VerificationSession`
+  * Add support for `matching` on `Identity::VerificationSession::Option`
+  * Add support for `klarna` on `Mandate::PaymentMethodDetail`, `SetupIntent::ConfirmParams::PaymentMethodOption`, `SetupIntent::CreateParams::PaymentMethodOption`, `SetupIntent::PaymentMethodOption`, and `SetupIntent::UpdateParams::PaymentMethodOption`
+  * Add support for `on_demand` on `PaymentIntent::ConfirmParams::PaymentMethodOption::Klarna`, `PaymentIntent::CreateParams::PaymentMethodOption::Klarna`, and `PaymentIntent::UpdateParams::PaymentMethodOption::Klarna`
+  * Change type of `PaymentIntent::ConfirmParams::PaymentMethodOption::Klarna.setup_future_usage`, `PaymentIntent::CreateParams::PaymentMethodOption::Klarna.setup_future_usage`, `PaymentIntent::PaymentMethodOption::Klarna.setup_future_usage`, and `PaymentIntent::UpdateParams::PaymentMethodOption::Klarna.setup_future_usage` from `literal('none')` to `enum('none'|'off_session'|'on_session')`
+  * Add support for `ua` on `Tax::Registration::CountryOption` and `Tax::Registration::CreateParams::CountryOption`
+  * Change type of `Terminal::Location::UpdateParams.display_name` from `string` to `emptyable(string)`
+  * Add support for `collect_payment_method` and `confirm_payment_intent` on `Terminal::Reader::Action`
+  * Add support for `status` on `Treasury::FinancialAccount::ListParams`
+* [#1615](https://github.com/stripe/stripe-ruby/pull/1615) Update README to mention that APIResource.request was removed
+* [#1619](https://github.com/stripe/stripe-ruby/pull/1619) Updated StripeClient snippets in README
+* [#1621](https://github.com/stripe/stripe-ruby/pull/1621) Disable flaky test in jruby/truffleruby
+* [#1620](https://github.com/stripe/stripe-ruby/pull/1620) Fix `raw_request` example in README
+
+## 15.2.1 - 2025-06-04
+* [#1617](https://github.com/stripe/stripe-ruby/pull/1617) Fix `nil` requestor in `Webhook.construct_event` to allow for event data refresh
+  * Fix bug where `Event` constructed from `Webhook.construct_event` could not be refreshed due to a `nil` APIRequestor
+    * Raised in https://github.com/stripe/stripe-ruby/issues/1616
+
+## 15.2.0 - 2025-05-29
+ This release changes the pinned API version to `2025-05-28.basil`.
+
+* [#1605](https://github.com/stripe/stripe-ruby/pull/1605) Update generated code
+  * Add support for `attach_payment` method on resource `Invoice`
+  * Add support for `collect_inputs` method on resource `Terminal::Reader`
+  * Add support for `succeed_input_collection` and `timeout_input_collection` test helper methods on resource `Terminal::Reader`
+  * Add support for `pix_payments` on `Account::Capability`, `Account::CreateParams::Capability`, and `Account::UpdateParams::Capability`
+  * Add support for `disputes_list` and `payment_disputes` on `AccountSession::Component` and `AccountSession::CreateParams::Component`
+  * Add support for `refund_and_dispute_prefunding` on `Balance`
+  * Add support for `balance_type` on `BalanceTransaction`
+  * Change `Billing::Alert::CreateParams::UsageThreshold.meter` to be required
+  * Add support for `location` and `reader` on `Charge::PaymentMethodDetail::Affirm` and `Charge::PaymentMethodDetail::WechatPay`
+  * Add support for `payment_method_remove` on `Checkout::Session::CreateParams::SavedPaymentMethodOption`
+  * Add support for `setup_future_usage` on `Checkout::Session::PaymentMethodOption::NaverPay`
+  * Change `ConfirmationToken::PaymentMethodPreview::NaverPay.buyer_id` and `PaymentMethod::NaverPay.buyer_id` to be required
+  * Add support for `post_payment_amount` and `pre_payment_amount` on `CreditNote`
+  * Add support for `sex`, `unparsed_place_of_birth`, and `unparsed_sex` on `Identity::VerificationReport::Document` and `Identity::VerificationSession::VerifiedOutput`
+  * Add support for `billing_thresholds` on `Invoice::CreatePreviewParams::ScheduleDetail::Phase::Item`, `Invoice::CreatePreviewParams::ScheduleDetail::Phase`, `Invoice::CreatePreviewParams::SubscriptionDetail::Item`, `Subscription::CreateParams::Item`, `Subscription::CreateParams`, `Subscription::UpdateParams::Item`, `Subscription::UpdateParams`, `SubscriptionItem::CreateParams`, `SubscriptionItem::UpdateParams`, `SubscriptionItem`, `SubscriptionSchedule::CreateParams::DefaultSetting`, `SubscriptionSchedule::CreateParams::Phase::Item`, `SubscriptionSchedule::CreateParams::Phase`, `SubscriptionSchedule::DefaultSetting`, `SubscriptionSchedule::Phase::Item`, `SubscriptionSchedule::Phase`, `SubscriptionSchedule::UpdateParams::DefaultSetting`, `SubscriptionSchedule::UpdateParams::Phase::Item`, `SubscriptionSchedule::UpdateParams::Phase`, and `Subscription`
+  * Add support for `satispay` on `PaymentIntent::ConfirmParams::PaymentMethodOption`, `PaymentIntent::CreateParams::PaymentMethodOption`, `PaymentIntent::PaymentMethodOption`, and `PaymentIntent::UpdateParams::PaymentMethodOption`
+  * Add support for `capture_method` on `PaymentIntent::PaymentMethodOption::Billie`
+  * Add support for `kakao_pay`, `kr_card`, `naver_pay`, `payco`, and `samsung_pay` on `PaymentMethodConfiguration::CreateParams`, `PaymentMethodConfiguration::UpdateParams`, and `PaymentMethodConfiguration`
+  * Add support for `network_decline_code` on `Refund::DestinationDetail::Paypal`
+  * Add support for `metadata` on `Tax::Calculation::CreateParams::LineItem` and `Tax::CalculationLineItem`
+  * Add support for `return_url` on `Terminal::Reader::Action::ProcessPaymentIntent::ProcessConfig` and `Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig`
+  * Add support for `collect_inputs` on `Terminal::Reader::Action`
+* [#1601](https://github.com/stripe/stripe-ruby/pull/1601) Adds CONTRIBUTING.md
+
+## 15.1.0 - 2025-04-30
+
+  This release changes the pinned API version to `2025-04-30.basil`.
+
+* [#1566](https://github.com/stripe/stripe-ruby/pull/1566) Update generated code
+  * Add support for `minority_owned_business_designation` on `Account::BusinessProfile`, `Account::CreateParams::BusinessProfile`, and `Account::UpdateParams::BusinessProfile`
+  * Add support for `registration_date` on `Account::Company`, `Account::CreateParams::Company`, `Account::UpdateParams::Company`, and `Token::CreateParams::Account::Company`
+  * Add support for `us_cfpb_data` on `Account::CreateParams`, `Account::UpdateParams`, `AccountPerson::CreateParams`, `AccountPerson::UpdateParams`, `Person`, and `Token::CreateParams::Person`
+  * Add support for `tax_id` on `Charge::BillingDetail`, `ConfirmationToken::CreateParams::PaymentMethodDatum::BillingDetail`, `ConfirmationToken::PaymentMethodPreview::BillingDetail`, `PaymentIntent::ConfirmParams::PaymentMethodDatum::BillingDetail`, `PaymentIntent::CreateParams::PaymentMethodDatum::BillingDetail`, `PaymentIntent::UpdateParams::PaymentMethodDatum::BillingDetail`, `PaymentMethod::BillingDetail`, `PaymentMethod::CreateParams::BillingDetail`, `PaymentMethod::UpdateParams::BillingDetail`, `SetupIntent::ConfirmParams::PaymentMethodDatum::BillingDetail`, `SetupIntent::CreateParams::PaymentMethodDatum::BillingDetail`, `SetupIntent::UpdateParams::PaymentMethodDatum::BillingDetail`, `TestHelpers::ConfirmationToken::CreateParams::PaymentMethodDatum::BillingDetail`, and `Treasury::OutboundPayment::CreateParams::DestinationPaymentMethodDatum::BillingDetail`
+  * Add support for `wallet_options` on `Checkout::Session::CreateParams` and `Checkout::Session`
+  * Add support for `provider` on `Checkout::Session::AutomaticTax`, `Invoice::AutomaticTax`, and `Quote::AutomaticTax`
+  * Add support for `payment_method_options` on `ConfirmationToken::CreateParams` and `TestHelpers::ConfirmationToken::CreateParams`
+  * Add support for `installments` on `ConfirmationToken::PaymentMethodOption::Card`
+  * Add support for `context` on `Event`
+  * Change type of `InvoiceLineItem::Parent::SubscriptionItemDetail.subscription` from `string` to `nullable(string)`
+  * Add support for `billie` on `PaymentIntent::ConfirmParams::PaymentMethodOption`, `PaymentIntent::CreateParams::PaymentMethodOption`, `PaymentIntent::PaymentMethodOption`, and `PaymentIntent::UpdateParams::PaymentMethodOption`
+  * Add support for `pix` on `PaymentMethodConfiguration::CreateParams`, `PaymentMethodConfiguration::UpdateParams`, and `PaymentMethodConfiguration`
+  * Add support for `klarna` on `PaymentMethodDomain`
+  * Add support for `pending_reason` on `Refund`
+  * Change type of `Tax::CalculationLineItem.reference` from `nullable(string)` to `string`
+  * Add support for `aw`, `az`, `bd`, `bf`, `bj`, `cm`, `cv`, `et`, `in`, `kg`, `la`, and `ph` on `Tax::Registration::CountryOption` and `Tax::Registration::CreateParams::CountryOption`
+* [#1585](https://github.com/stripe/stripe-ruby/pull/1585) Updated rubocop from 1.57.2 to 1.75.2
+* [#1583](https://github.com/stripe/stripe-ruby/pull/1583) Include new Ruby 3.4 in CI
+* [#1581](https://github.com/stripe/stripe-ruby/pull/1581) Added rubocop exclusion for generated tests
+
 ## 15.0.0 - 2025-04-09
 
 ### Breaking change
@@ -9,12 +94,12 @@
 * [#1576](https://github.com/stripe/stripe-ruby/pull/1576) Explicitly pass through custom headers in retrieve
   * Fix custom options passing for resource-based retrieve
 * [#1571](https://github.com/stripe/stripe-ruby/pull/1571) Validate all instance variable keys returned from the API
-  * Validate all keys returned from the API, including custom response fields, to make sure they can be set in an instance variable, as brought up in https://github.com/stripe/stripe-ruby/issues/1564
-    * We do not set instance variables for invalid field names (as defined by the [Ruby spec](https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html#ident)). We recommend for custom hash map response fields, use the `[]` accessor.
-       ```ruby
-       c = client.v1.customers.retrieve("cus_123")
-       c.metadata["invalid-variable-name!"]
-       c.metadata["valid_key_name_works_too"]
+  * Validate all keys returned from the API, including custom response fields, to make sure they can be set in an instance variable, as brought up in https://github.com/stripe/stripe-ruby/issues/1564
+    * We do not set instance variables for invalid field names (as defined by the [Ruby spec](https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html#ident)). We recommend for custom hash map response fields, use the `[]` accessor.
+       ```ruby
+       c = client.v1.customers.retrieve("cus_123")
+       c.metadata["invalid-variable-name!"]
+       c.metadata["valid_key_name_works_too"]
       ```
 * [#1575](https://github.com/stripe/stripe-ruby/pull/1575) Remove unused youtube playlist link
 * [#1573](https://github.com/stripe/stripe-ruby/pull/1573) Remove link for stale youtube video playlist
@@ -24,15 +109,15 @@
   * Adds explicit field types for resources and parameters for methods, and add RBI static annotations for all resources and services
   ![image](https://github.com/user-attachments/assets/1b6cd994-d3ea-4f47-8487-f5c7b9ebf885)
   * See [the wiki](https://github.com/stripe/stripe-ruby/wiki/Static-Type-Annotations) for more details
-  
+
 * [#1543](https://github.com/stripe/stripe-ruby/pull/1543) Support for APIs in the new API version 2025-03-31.basil
 
   This release changes the pinned API version to `2025-03-31.basil`.
-  
+
   ### ⚠️ Breaking changes  due to changes in the Stripe API
 
   Please review details for the breaking changes and alternatives in the [Stripe API changelog](https://docs.stripe.com/changelog/basil) before upgrading.
-  
+
   * Remove support for resources `SubscriptionItemUsageRecordSummary` and `SubscriptionItemUsageRecord`
   * Remove support for `create` method on resource `SubscriptionItemUsageRecord`
   * Remove support for `list` method on resource `SubscriptionItemUsageRecordSummary`
@@ -42,16 +127,16 @@
   * [#1553](https://github.com/stripe/stripe-ruby/pull/1553) Remove public idempotent_replayed? method
     * ⚠️ Remove the `idempotent_replayed?` method on `StripeError`
       * The information is accessible indirectly via the raw response headers, `StripeResponse.http_headers`. For example, use `resource.last_response.http_headers['Idempotent-Replayed']`
-  
+
   ### Additions to the Stripe API
-  
+
   * Add support for new resource `InvoicePayment`
   * Add support for `list` and `retrieve` methods on resource `InvoicePayment`
-  
+
 
 ## 13.5.0 - 2025-02-24
 * [#1534](https://github.com/stripe/stripe-ruby/pull/1534) Update generated code
-  * Fixed `Stripe::InvoiceLineItem.update` method. 
+  * Fixed `Stripe::InvoiceLineItem.update` method.
 * [#1536](https://github.com/stripe/stripe-ruby/pull/1536) Fix InvoiceLineItem parent class
   * Fix bug where `Stripe::InvoiceLineItem` had the incorrect parent class, making it error when `update` was called
 * [#1533](https://github.com/stripe/stripe-ruby/pull/1533) add codeowners file
@@ -80,7 +165,7 @@
 * [#1500](https://github.com/stripe/stripe-ruby/pull/1500) This release changes the pinned API version to `2024-12-18.acacia`.
 
 * [#1507](https://github.com/stripe/stripe-ruby/pull/1507) Pass requestor to all deserialized objects including lists
-  
+
   * Fixes bug where `StripeObject` retrieved from lists could not be used to make requests, such as `refresh`
 
 ## 13.2.0 - 2024-11-20
@@ -103,24 +188,24 @@
 
 ## 13.0.2 - 2024-10-23
 * [#1473](https://github.com/stripe/stripe-ruby/pull/1473) Always return the result of APIResource#refresh in APIResource.retrieve
-  
+
   * Fix bug where we would not return the mutated `self` object when calling `APIResource.retrieve`
 
 ## 13.0.1 - 2024-10-18
 * [#1471](https://github.com/stripe/stripe-ruby/pull/1471) update object tags for meter-related classes
-  
+
   - fixes a bug where the `object` property of the `MeterEvent`, `MeterEventAdjustment`, and `MeterEventSession` didn't match the server.
 * [#1470](https://github.com/stripe/stripe-ruby/pull/1470) Cleaned up examples and added documentation
 
 ## 13.0.0 - 2024-10-01
 * [#1458](https://github.com/stripe/stripe-ruby/pull/1458) Support for APIs in the new API version 2024-09-30.acacia
-  
-  This release changes the pinned API version to `2024-09-30.acacia`. Please read the [API Upgrade Guide](https://stripe.com/docs/upgrades#2024-09-30.acacia) and carefully review the API changes before upgrading.
-  
-  ### ⚠️ Breaking changes 
-  
+
+  This release changes the pinned API version to `2024-09-30.acacia`. Please read the [API Changelog](https://docs.stripe.com/changelog/acacia#2024-09-30.acacia) and carefully review the API changes before upgrading.
+
+  ### ⚠️ Breaking changes
+
   Please refer to our [migration guide for v13](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v13) for more information about the backwards incompatible changes.
-  
+
   #### ❗ `StripeClient` and related changes
   * Move `StripeClient` and requestor logic to `APIRequestor`.
     * `StripeClient#request` is still available, but is deprecated and will be removed. We encourage `StripeClient#raw_request` as a replacement (see other breaking changes for more detail).
@@ -128,21 +213,21 @@
       * No global config: you can simultaneously use multiple clients with different configuration options (such as API keys)
       * No extra API calls. All API endpoints can be accessed with a single method call. You don't have to call `retrieve` before doing an `update`.
       * No static methods. Much easier mocking.
-  
+
   #### Other breaking changes
-  
+
   * Adjust default values around retries for HTTP requests. You can use the old defaults by setting them explicitly. New values are:
     - max retries: `0` -> `2`
     - max retry delay (seconds) `2` -> `5`
   * Remove `StripeClient#connection_manager`. This was a legacy method from years ago.
-  * Singleton `retrieve` method now requires `params` to be passed as the first argument. Existing calls to singleton `retrieve` method with only `opts` argument will have to be updated to account for the addition of `params` argument. 
+  * Singleton `retrieve` method now requires `params` to be passed as the first argument. Existing calls to singleton `retrieve` method with only `opts` argument will have to be updated to account for the addition of `params` argument.
       ```ruby
       params = { expand: ["available"] }
       opts = { stripe_account: "acct_123" }
-  
+
       # ❌ No longer works
       Stripe::Balance.retrieve(opts)
-  
+
       # ✅ Correct way to call retrieve method
       Stripe::Balance.retrieve(params, opts)
       ```
@@ -151,7 +236,7 @@
       ```ruby
       # Instead of
       Stripe::APIResource.request(:get, "/v1/endpoint", params, opts)
-  
+
       # do
       client = Stripe::StripeClient.new(...)
       resp = client.raw_request(:get, "/v1/endpoint", params: params, opts: opts)
@@ -167,18 +252,18 @@
     # Before
     obj, api_key = StripeClient.execute_request(method, path, api_base: nil,
                                                 api_key: nil, headers: {}, params: {}, usage: [])
-  
+
     # is now, with base_address being one of [:api, :files, :connect, :meter_events]
-  
+
     obj, opts = APIRequestor.execute_request(method, path, base_address,
                                             params: {}, opts: {}, usage: [])
     puts(opts) # will output {api_key: "sk_test_123", stripe_account: "acct_123"}
     ```
-  
-   
+
+
   ### Additions
   * Add support for new Usage Billing APIs `Billing.MeterEvent`, `Billing.MeterEventAdjustments`, `Billing.MeterEventSession`, `Billing.MeterEventStream` and the new Events API `Core.Events` in the [v2 namespace ](https://docs.corp.stripe.com/api-v2-overview)
-  * Add method `parse_thin_event()` on the `StripeClient` class to parse [thin events](https://docs.corp.stripe.com/event-destinations#events-overview). 
+  * Add method `parse_thin_event()` on the `StripeClient` class to parse [thin events](https://docs.corp.stripe.com/event-destinations#events-overview).
 
 
 ## 12.6.0 - 2024-09-12
@@ -206,15 +291,15 @@
 
 * [#1433](https://github.com/stripe/stripe-ruby/pull/1433) Add usage to raw_request call
 * [#1431](https://github.com/stripe/stripe-ruby/pull/1431) Add `raw_request`
-  
+
   - Adds the ability to make raw requests to the Stripe API, by providing an HTTP method and url. This is an alternative to using `Stripe::APIResource.request(...)` to make custom requests, which is discouraged and will be broken in a future major version.
 
 ## 12.1.0 - 2024-07-05
 * [#1425](https://github.com/stripe/stripe-ruby/pull/1425) Update generated code
   * Add support for `add_lines`, `remove_lines`, and `update_lines` methods on resource `Invoice`
 * [#1420](https://github.com/stripe/stripe-ruby/pull/1420) Update static methods for delete/list on BankAccount/Card to throw NotImplementedError
-  * The below methods have been throwing `InvalidRequestError` because the urls used to make the requests have been buggy. Updating them to throw `NotImplementedError` instead just like their counterparts for update & retrieve because they cannot be implemented without the parent id. 
-  
+  * The below methods have been throwing `InvalidRequestError` because the urls used to make the requests have been buggy. Updating them to throw `NotImplementedError` instead just like their counterparts for update & retrieve because they cannot be implemented without the parent id.
+
   Methods affected | Use these instead in the context of payment method | Use these in the context of external accounts
   ------ | ------ | ----
   Stripe:: BankAccount.delete | Stripe::Customer.delete_source | Stripe::Account.delete_external_account
@@ -226,12 +311,12 @@
 
 ## 12.0.0 - 2024-06-24
 * [#1418](https://github.com/stripe/stripe-ruby/pull/1418) Add missing static method for verify on BankAccount
-* [#1419](https://github.com/stripe/stripe-ruby/pull/1419) 
-  
-  This release changes the pinned API version to 2024-06-20. Please read the [API Upgrade Guide](https://stripe.com/docs/upgrades#2024-06-20) and carefully review the API changes before upgrading.
+* [#1419](https://github.com/stripe/stripe-ruby/pull/1419)
+
+  This release changes the pinned API version to 2024-06-20. Please read the [API Changelog](https://docs.stripe.com/changelog/2024-06-20) and carefully review the API changes before upgrading.
 
   ### Additions
-  
+
   * Add support for `finalize_amount` test helper method on resource `Issuing.Authorization`
 
 ## 11.7.0 - 2024-06-13
@@ -271,7 +356,7 @@
 ## 11.0.0 - 2024-04-10
 * [#1374](https://github.com/stripe/stripe-ruby/pull/1374)
 
-  * This release changes the pinned API version to `2024-04-10`. Please read the [API Upgrade Guide](https://stripe.com/docs/upgrades#2024-04-10) and carefully review the API changes before upgrading.
+  * This release changes the pinned API version to `2024-04-10`. Please read the [API Changelog](https://docs.stripe.com/changelog/2024-04-10) and carefully review the API changes before upgrading.
 
   ### ⚠️ Breaking changes
 
@@ -381,7 +466,7 @@
   * Add support for `create`, `list`, and `update` methods on resource `Registration`
 
 ## 10.0.0 - 2023-10-16
-* This release changes the pinned API version to `2023-10-16`. Please read the [API Upgrade Guide](https://stripe.com/docs/upgrades#2023-10-16) and carefully review the API changes before upgrading `stripe-ruby`.
+* This release changes the pinned API version to `2023-10-16`. Please read the [API Changelog](https://docs.stripe.com/changelog/2023-10-16) and carefully review the API changes before upgrading `stripe-ruby`.
 * [#1283](https://github.com/stripe/stripe-ruby/pull/1283) Update generated code
   - Updated pinned API version
 * [#1281](https://github.com/stripe/stripe-ruby/pull/1281) Update generated code
@@ -505,7 +590,7 @@
 ## 8.0.0 - 2022-11-16
 * [#1144](https://github.com/stripe/stripe-ruby/pull/1144) Next major release changes
 
-Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-11-15.
+Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the Stripe products, read more at https://docs.stripe.com/changelog/2022-11-15.
 
 "⚠️" symbol highlights breaking changes.
 
@@ -543,7 +628,7 @@ Breaking changes that arose during code generation of the library that we postpo
 
 ## 7.0.0 - 2022-08-02
 
-Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the SDK, read more detailed description at https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v7. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-08-01.
+Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the SDK, read more detailed description at https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v7. For changes to the Stripe products, read more at https://docs.stripe.com/changelog/2022-08-01.
 
 "⚠️" symbol highlights breaking changes.
 

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+
+# Contributing
+
+We welcome bug reports, feature requests, and code contributions in a pull request.
+
+For most pull requests, we request that you identify or create an associated issue that has the necessary context. We use these issues to reach agreement on an approach and save the PR author from having to redo work. Fixing typos or documentation issues likely do not need an issue; for any issue that introduces substantial code changes, changes the public interface, or if you aren't sure, please find or [create an issue](https://www.github.com/stripe/stripe-ruby/issues/new/choose).
+
+## Contributor License Agreement
+
+All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agreement, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant.
+
+## Generated code
+
+This project has a combination of manually maintained code and code generated from our private code generator. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution.
+
+To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. 
+
+## Compatibility with supported language and runtime versions
+
+This project supports [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward.
+
+## Set up your dev environment
+
+Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment.
+

data/Gemfile

@@ -24,7 +24,7 @@ group :development do
   # up-to-date, but it's not the end of the world if it's not.
   #
   # The latest version of rubocop is only compatible with Ruby 2.7+
-  gem "rubocop", "1.57.2" if RUBY_VERSION >= "2.7"
+  gem "rubocop", "1.75.2" if RUBY_VERSION >= "2.7"
 
   gem "sorbet"
   gem "tapioca"

data/OPENAPI_VERSION

@@ -1 +1 @@
-v1642
+v1819

data/README.md

@@ -60,13 +60,14 @@ value:
 
 ```ruby
 require 'stripe'
-Stripe.api_key = 'sk_test_...'
+
+client = Stripe::StripeClient.new("sk_test_...")
 
 # list customers
-Stripe::Customer.list()
+customers = client.v1.customers.list()
 
-# retrieve single customer
-Stripe::Customer.retrieve('cus_123456789')
+# retrieve single customer 
+customer = client.v1.customers.retrieve('cus_123456789')
 ```
 
 ### Per-request Configuration
@@ -78,61 +79,30 @@ per-request key and/or account:
 ```ruby
 require "stripe"
 
-Stripe::Customer.list(
-  {},
-  {
-    api_key: 'sk_test_...',
-    stripe_account: 'acct_...',
-    stripe_version: '2018-02-28',
-  }
-)
+client = Stripe::StripeClient.new("sk_test_...")
 
-Stripe::Customer.retrieve(
-  'cus_123456789',
+client.v1.customers.list(
+  {},
   {
     api_key: 'sk_test_...',
     stripe_account: 'acct_...',
     stripe_version: '2018-02-28',
   }
 )
-
-Stripe::Customer.retrieve(
-  {
-    id: 'cus_123456789',
-    expand: %w(balance_transaction)
-  },
-  {
-    stripe_version: '2018-02-28',
-    api_key: 'sk_test_...',
-  }
-)
-
-Stripe::Customer.capture(
-  'cus_123456789',
-  {},
-  {
-    stripe_version: '2018-02-28',
-    api_key: 'sk_test_...',
-  }
-)
 ```
 
-Keep in mind that there are different method signatures depending on the action:
+### StripeClient vs legacy pattern
 
-- When operating on a collection (e.g. `.list`, `.create`) the method signature is
-  `method(params, opts)`.
-- When operating on resource (e.g. `.capture`, `.update`) the method signature is
-  `method(id, params, opts)`.
-- One exception is that `retrieve`, despite being an operation on a resource, has the signature
-  `retrieve(id, opts)`. In addition, it will accept a Hash for the `id` param but will extract the
-  `id` key out and use the others as options.
+We introduced the `StripeClient` class in v13 of the Ruby SDK. The legacy pattern used prior to that version is still available to use but will be marked as deprecated soon. Review the [migration guide to use StripeClient](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v13) to move from the legacy pattern.
+
+Once the legacy pattern is deprecated, new API endpoints will only be accessible in the StripeClient. While there are no current plans to remove the legacy pattern for existing API endpoints, this may change in the future.
 
 ### Accessing resource properties
 
 Both indexer and accessors can be used to retrieve values of resource properties.
 
 ```ruby
-customer = Stripe::Customer.retrieve('cus_123456789')
+customer = client.v1.customers.retrieve('cus_123456789')
 puts customer['id']
 puts customer.id
 ```
@@ -140,7 +110,7 @@ puts customer.id
 NOTE: If the resource property is not defined, the accessors will raise an exception, while the indexer will return `nil`.
 
 ```ruby
-customer = Stripe::Customer.retrieve('cus_123456789')
+customer = client.v1.customers.retrieve('cus_123456789')
 puts customer['unknown'] # nil
 puts customer.unknown # raises NoMethodError
 ```
@@ -150,7 +120,7 @@ puts customer.unknown # raises NoMethodError
 Get access to response objects by using the `last_response` property of the returned resource:
 
 ```ruby
-customer = Stripe::Customer.retrieve('cus_123456789')
+customer = client.v1.customers.retrieve('cus_123456789')
 
 print(customer.last_response.http_status) # to retrieve status code
 print(customer.last_response.http_headers) # to retrieve headers
@@ -347,22 +317,25 @@ by default. If you are overriding `Stripe.api_version` / `stripe_version` on the
 or using a webhook endpoint tied to an older version, be aware that the data
 you see at runtime may not match the types.
 
-### Beta SDKs
+### Public Preview SDKs
+
+Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `-beta.X` suffix like `11.2.0-beta.2`.
+We would love for you to try these as we incrementally release new features and improve them based on your feedback.
 
-Stripe has features in the beta phase that can be accessed via the beta version of this package.
-We would love for you to try these and share feedback with us before these features reach the stable phase.
-To install a beta version use `gem install` with the exact version you'd like to use:
+To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-ruby/releases/) and use it in the `gem install` command:
 
 ```sh
-gem install stripe -v 7.1.0.pre.beta.2
+gem install stripe -v <replace-with-the-version-of-your-choice>
 ```
 
+You can find the latest version to use in this command from the [releases page](https://github.com/stripe/stripe-ruby/releases/)
+
 > **Note**
-> There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your Gemfile. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.
+> There can be breaking changes between two versions of the public preview SDKs without a bump in the major version. Therefore we recommend pinning the package version to a specific version in your Gemfile. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest version of the public preview SDK.
 
 We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version.
 
-If your beta feature requires a `Stripe-Version` header to be sent, set the `Stripe.api_version` field using `Stripe.add_beta_version`:
+Some preview features require a name and version to be set in the `Stripe-Version` header like `feature_beta=v3`. If your preview feature has this requirement, use the `Stripe.add_beta_version` function (available only in the public preview SDKs):
 
 ```python
 Stripe.add_beta_version("feature_beta", "v3")
@@ -374,13 +347,13 @@ If you:
 
 - would like to send a request to an undocumented API (for example you are in a private beta)
 - prefer to bypass the method definitions in the library and specify your request details directly,
-- used the method `Stripe::APIResource.request(...)` to specify your own requests, which will soon be broken
+- used the method `Stripe::APIResource.request(...)` to specify your own requests, which was removed in v13+
 
 you can now use the `raw_request` method on `StripeClient`.
 
 ```ruby
-client = Stripe::StripeClient.new(...)
-resp = client.raw_request(:post, "/v1/beta_endpoint", {param: 123}, {stripe_version: "2022-11-15; feature_beta=v3"})
+client = Stripe::StripeClient.new('sk_test_...')
+resp = client.raw_request(:post, "/v1/beta_endpoint", params: {param: 123}, opts: {stripe_version: "2022-11-15; feature_beta=v3"})
 
 # (Optional) resp is a StripeResponse. You can use `Stripe.deserialize` to get a StripeObject.
 deserialized_resp = client.deserialize(resp.http_body)

data/VERSION

@@ -1 +1 @@
-15.0.0
+15.3.0

data/lib/stripe/api_operations/nested_resource.rb

@@ -45,53 +45,53 @@ module Stripe
         when :create
           define_singleton_method(:"create_#{resource}") \
               do |id, params = {}, opts = {}|
-            request_stripe_object(
-              method: :post,
-              path: send(resource_url_method, id),
-              params: params,
-              opts: opts
-            )
-          end
+                request_stripe_object(
+                  method: :post,
+                  path: send(resource_url_method, id),
+                  params: params,
+                  opts: opts
+                )
+              end
         when :retrieve
           define_singleton_method(:"retrieve_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-            request_stripe_object(
-              method: :get,
-              path: send(resource_url_method, id, nested_id),
-              params: params,
-              opts: opts
-            )
-          end
+                request_stripe_object(
+                  method: :get,
+                  path: send(resource_url_method, id, nested_id),
+                  params: params,
+                  opts: opts
+                )
+              end
         when :update
           define_singleton_method(:"update_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-            request_stripe_object(
-              method: :post,
-              path: send(resource_url_method, id, nested_id),
-              params: params,
-              opts: opts
-            )
-          end
+                request_stripe_object(
+                  method: :post,
+                  path: send(resource_url_method, id, nested_id),
+                  params: params,
+                  opts: opts
+                )
+              end
         when :delete
           define_singleton_method(:"delete_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-            request_stripe_object(
-              method: :delete,
-              path: send(resource_url_method, id, nested_id),
-              params: params,
-              opts: opts
-            )
-          end
+                request_stripe_object(
+                  method: :delete,
+                  path: send(resource_url_method, id, nested_id),
+                  params: params,
+                  opts: opts
+                )
+              end
         when :list
           define_singleton_method(:"list_#{resource_plural}") \
               do |id, params = {}, opts = {}|
-            request_stripe_object(
-              method: :get,
-              path: send(resource_url_method, id),
-              params: params,
-              opts: opts
-            )
-          end
+                request_stripe_object(
+                  method: :get,
+                  path: send(resource_url_method, id),
+                  params: params,
+                  opts: opts
+                )
+              end
         else
           raise ArgumentError, "Unknown operation: #{operation.inspect}"
         end