stripe 10.2.0 → 11.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1175af77634044ef0ef6efda0626ace1431bdb4ad52eb78c643af4eba8982faf
-  data.tar.gz: 19863ceeab18b449560dc647213d5873eadb190db544015e88749b5e79414528
+  metadata.gz: d194f568d73d4b7aad08e89250b62192c4577cc97da642287a83b487f3d3e6ce
+  data.tar.gz: e4ba60356e5de058254e19f71ca72f665adedbc1c9fa7cc85bcac7754ac04e0e
 SHA512:
-  metadata.gz: 24f1e67f729c964e150bf991140467c85d2b85430da3a7d736cd6b6ae5a9ce8afac2664e27fb3df51d472eb23b1ae67f5933e019e8c6fd9c7639d32e4713a334
-  data.tar.gz: 28dee05f7251e400ba32ace17cb0e8e78f63bfa156ba36c9d6f3baa7cc6d361d0e86826a962a117e70cd774628183eddf70d0379c9c485a74192b9844c3855c5
+  metadata.gz: f6cbcc13a8f5d0549d8e910f437900f5e52889df9d41f919d617ade29a463f5a101baecf9c3d25ed19f1fdcd1da91e4e0103234f8ba701bc622e8083a1085513
+  data.tar.gz: '08feaf01a76272eb6d9923f88988ef68808b24ced8d9df06c38347809e92dd0223e141ba1078bbf367b5d0f2f4b8e934ae36b82ef6eacd71088d8d0a4a0184be'

data/CHANGELOG.md

@@ -1,4 +1,113 @@
 # Changelog
+## 11.3.0 - 2024-05-02
+* [#1387](https://github.com/stripe/stripe-ruby/pull/1387) Update generated code
+
+* [#1392](https://github.com/stripe/stripe-ruby/pull/1392) Deprecate Ruby methods based on OpenAPI spec
+  - Mark as deprecated the `approve` and `decline` methods in `lib/stripe/resources/issuing/authorization.rb`. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
+* [#1391](https://github.com/stripe/stripe-ruby/pull/1391) Add Ruby 3.3 to CI test matrix
+
+## 11.2.0 - 2024-04-18
+* [#1385](https://github.com/stripe/stripe-ruby/pull/1385) Update generated code
+  * Add support for `create_preview` method on resource `Invoice`
+
+## 11.1.0 - 2024-04-16
+* [#1379](https://github.com/stripe/stripe-ruby/pull/1379) Update generated code
+  * Add support for new resource `Entitlements.ActiveEntitlementSummary`
+
+## 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.
+  
+  ### ⚠️ Breaking changes
+  
+  * When no `x-stripe-should-retry` header is set in the response, the library now retries all requests with `status >= 500`, not just non-POST methods.
+
+## 10.15.0 - 2024-04-09
+* [#1377](https://github.com/stripe/stripe-ruby/pull/1377) Add last_response to StripeObject
+  * Users can now retrieve raw response from the returned resource, using the `last_response` property. See [README](https://github.com/stripe/stripe-ruby/blob/master/README.md) for an example.
+* [#1372](https://github.com/stripe/stripe-ruby/pull/1372) Update generated code
+  * Add support for new resources `Entitlements.ActiveEntitlement` and `Entitlements.Feature`
+  * Add support for `list` and `retrieve` methods on resource `ActiveEntitlement`
+  * Add support for `create`, `list`, `retrieve`, and `update` methods on resource `Feature`
+* [#1366](https://github.com/stripe/stripe-ruby/pull/1366) Move executables to `exe` folder
+
+## 10.14.0 - 2024-03-28
+* [#1369](https://github.com/stripe/stripe-ruby/pull/1369) Update generated code
+  * Add support for new resources `Billing.MeterEventAdjustment`, `Billing.MeterEvent`, and `Billing.Meter`
+  * Add support for `create`, `deactivate`, `list`, `reactivate`, `retrieve`, and `update` methods on resource `Meter`
+  * Add support for `create` method on resources `MeterEventAdjustment` and `MeterEvent`
+
+## 10.13.0 - 2024-03-21
+* [#1367](https://github.com/stripe/stripe-ruby/pull/1367) Update generated code
+  * Add support for new resources `ConfirmationToken` and `Forwarding.Request`
+  * Add support for `retrieve` method on resource `ConfirmationToken`
+  * Add support for `create`, `list`, and `retrieve` methods on resource `Request`
+* [#1362](https://github.com/stripe/stripe-ruby/pull/1362) Exclude sorbet directory and tapioca script when packing gem
+
+## 10.12.0 - 2024-03-14
+* [#1359](https://github.com/stripe/stripe-ruby/pull/1359) Update generated code
+  * Add support for new resources `Issuing.PersonalizationDesign` and `Issuing.PhysicalBundle`
+  * Add support for `create`, `list`, `retrieve`, and `update` methods on resource `PersonalizationDesign`
+  * Add support for `list` and `retrieve` methods on resource `PhysicalBundle`
+* [#1354](https://github.com/stripe/stripe-ruby/pull/1354) Refactor after SDK based generation pattern
+* [#1347](https://github.com/stripe/stripe-ruby/pull/1347) Reorder methods with lexographical sort
+* [#1355](https://github.com/stripe/stripe-ruby/pull/1355) Disable Metrics/ClassLength
+* [#1351](https://github.com/stripe/stripe-ruby/pull/1351) Update CHANGELOG.md
+
+## 10.11.0 - 2024-02-29
+* [#1348](https://github.com/stripe/stripe-ruby/pull/1348) Use sorbet gem instead of sorbet-static
+* [#1342](https://github.com/stripe/stripe-ruby/pull/1342) Update generated code
+  * Add `list_refunds` and `retrieve_refund` methods on resource `Charge`.
+* [#1345](https://github.com/stripe/stripe-ruby/pull/1345) Update README to use add_beta_version
+
+## 10.10.0 - 2024-02-22
+* [#1336](https://github.com/stripe/stripe-ruby/pull/1336) Update generated code
+  - Add `InvoiceLineItem.update` method.
+* [#1334](https://github.com/stripe/stripe-ruby/pull/1334) Add TaxIds API
+  * Add support for `all`, `create`, and `retrieve` methods on resource `TaxId`
+  * The `delete` method now sends a DELETE request to `/v1/tax_ids/{id}` instead of `/v1/customers/{customer}/tax_ids/{id}`. The endpoints are functionally the same when operating on a Customer Tax ID.
+  * The `resource_url` method on `TaxId` now returns the top-level `/v1/tax_ids/{id}` path instead of the `/v1/customers/{customer}/tax_ids/{id}` path.
+
+## 10.9.0 - 2024-02-15
+* [#1329](https://github.com/stripe/stripe-ruby/pull/1329) Update generated code
+  * Fixed bug where `TaxId` resource `delete` method sent request to wrong URL (https://github.com/stripe/stripe-ruby/issues/1333)
+* [#1324](https://github.com/stripe/stripe-ruby/pull/1324) Start running Sorbet in CI
+* [#1327](https://github.com/stripe/stripe-ruby/pull/1327) Add methods for dynamically referenced constants
+
+## 10.8.0 - 2024-02-08
+* [#1322](https://github.com/stripe/stripe-ruby/pull/1322) Update generated code
+* [#1323](https://github.com/stripe/stripe-ruby/pull/1323) Extract other CRUDL api operations from mixins
+  * Extract more CRUDL operations, namely `create`, `delete`, `update`, and `list` into the resources. These methods will no longer rely on the APIOperation mixins.
+* [#1314](https://github.com/stripe/stripe-ruby/pull/1314) Update mocha gem to 1.16
+
+## 10.7.1 - 2024-02-05
+* [#1320](https://github.com/stripe/stripe-ruby/pull/1320) Remove spurious _search deprecation messages (https://github.com/stripe/stripe-ruby/issues/1319)
+
+## 10.7.0 - 2024-02-01
+* [#1317](https://github.com/stripe/stripe-ruby/pull/1317) Remove list method in child resources
+  * Removes list method mixin from child resources, as these methods always return `InvalidRequestError` and never succeed
+* [#1311](https://github.com/stripe/stripe-ruby/pull/1311) Use the deprecation gem in search and clean up usage of the gem
+
+## 10.6.0 - 2024-01-12
+* [#1310](https://github.com/stripe/stripe-ruby/pull/1310) Update generated code
+  * Add support for new resource `CustomerSession`
+  * Add support for `create` method on resource `CustomerSession`
+
+## 10.5.0 - 2024-01-04
+* [#1306](https://github.com/stripe/stripe-ruby/pull/1306) Update generated code
+  * Add support for `retrieve` method on resource `Tax.Registration`
+
+## 10.4.0 - 2023-12-22
+* [#1303](https://github.com/stripe/stripe-ruby/pull/1303) Update generated code
+  * Add support for new resource `FinancialConnections.Transaction`
+  * Add support for `list` and `retrieve` methods on resource `Transaction`
+  * Add support for `subscribe` and `unsubscribe` methods on resource `FinancialConnections.Account`
+* [#1304](https://github.com/stripe/stripe-ruby/pull/1304) Add support for updatable singleton resources
+
+## 10.3.0 - 2023-12-14
+* [#1294](https://github.com/stripe/stripe-ruby/pull/1294) Support sending parameters inside singleton retrieve
+
 ## 10.2.0 - 2023-11-30
 * [#1292](https://github.com/stripe/stripe-ruby/pull/1292) Update generated code
   * Add support for new resources `Climate.Order`, `Climate.Product`, and `Climate.Supplier`
@@ -53,32 +162,32 @@
 **⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️**
 
 * [#1253](https://github.com/stripe/stripe-ruby/pull/1253) [#1260](https://github.com/stripe/stripe-ruby/pull/1260) Pin latest API version as the default
-  
+
   In this release, Stripe API Version `2023-08-16` (the latest at time of release) will be sent by default on all requests. This is a significant change with wide ramifications. The API version affects the properties you see on responses, the parameters you are allowed to send on requests, and so on. The previous default was to use your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version).
-  
+
   To successfully upgrade to stripe-ruby v9, you must either
-  
+
   1. **(Recommended) Upgrade your integration to be compatible with API Version `2023-08-16`.**
-  
+
      Please read the API Changelog carefully for each API Version from `2023-08-16` back to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe [Test Mode](https://stripe.com/docs/keys#test-live-modes) before deploying them to production.
-  
+
      You can read the [v9 migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v9) for more detailed instructions.
   2. **(Alternative option) Specify a version other than `2023-08-16` when initializing `stripe-ruby`.**
-  
+
      If you were previously initializing stripe-ruby without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). For example:
-  
+
      ```diff
        require 'stripe'
        Stripe.api_key = "sk_test_..."
      + Stripe.api_version = '2020-08-27'
      ```
-  
+
      If you were already initializing stripe-ruby with an explicit API Version, upgrading to v9 will not affect your integration.
-  
+
      Read the [v9 migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v9) for more details.
-  
+
   Going forward, each major release of this library will be *pinned* by default to the latest Stripe API Version at the time of release.
-  
+
   That is, instead of upgrading stripe-ruby and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-ruby, you should also upgrade your integration to be compatible with the latest Stripe API version.
 
 ## 8.7.0 - 2023-08-10
@@ -105,7 +214,7 @@
 
 * [#1225](https://github.com/stripe/stripe-ruby/pull/1225) Downgrade jaro_winkler
 * [#1219](https://github.com/stripe/stripe-ruby/pull/1219) Update generated code
-  
+
   Documentation updates.
 * [#1215](https://github.com/stripe/stripe-ruby/pull/1215) Update generated code
 
@@ -153,7 +262,7 @@ Breaking changes that arose during code generation of the library that we postpo
   refund = Stripe::Refund.retrieve("re_123")
   refund.description = "Refund description"
   refund.save
-  
+
   # after
   Stripe::Refund.update("re_123", description: "Refund description")
   ```
@@ -217,7 +326,7 @@ Breaking changes that arose during code generation of the library that we postpo
 * [#1072](https://github.com/stripe/stripe-ruby/pull/1072) Trigger workflows on beta branches
 * [#1071](https://github.com/stripe/stripe-ruby/pull/1071) Use request_stripe_object for all requests
 * [#1070](https://github.com/stripe/stripe-ruby/pull/1070) API Updates
-  
+
   Switch from using meta-programing to generating explicit methods for custom methods.
 * [#1069](https://github.com/stripe/stripe-ruby/pull/1069) chore: Stop special implementation of Account.persons method.
 
@@ -233,15 +342,15 @@ Breaking changes that arose during code generation of the library that we postpo
   * Add support for new resources `Treasury.CreditReversal`, `Treasury.DebitReversal`, `Treasury.FinancialAccountFeatures`, `Treasury.FinancialAccount`, `Treasury.FlowDetails`, `Treasury.InboundTransfer`, `Treasury.OutboundPayment`, `Treasury.OutboundTransfer`, `Treasury.ReceivedCredit`, `Treasury.ReceivedDebit`, `Treasury.TransactionEntry`, and `Treasury.Transaction`
   * Add support for `retrieve_payment_method` method on resource `Customer`
   * Add support for `list_owners` and `list` methods on resource `FinancialConnections.Account`
-  
-  
+
+
 
 ## 6.0.0 - 2022-05-09
 * [#1056](https://github.com/stripe/stripe-ruby/pull/1056) API Updates
   Major version release. The [migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-Guide-for-v6) contains more information.
-  
+
   (⚠️ = breaking changes):
-  * ⚠️ Replace the legacy `Order` API with the new `Order` API. 
+  * ⚠️ Replace the legacy `Order` API with the new `Order` API.
     * New methods: `cancel`, `list_line_items`, `reopen`, and `submit`
     * Removed methods: `pay` and `return_order`
     * Removed resources: `OrderItem` and `OrderReturn`
@@ -250,7 +359,7 @@ Breaking changes that arose during code generation of the library that we postpo
 ## 5.55.0 - 2022-05-05
 * [#1055](https://github.com/stripe/stripe-ruby/pull/1055) API Updates
   * Add support for new resources `FinancialConnections.AccountOwner`, `FinancialConnections.AccountOwnership`, `FinancialConnections.Account`, and `FinancialConnections.Session`
-  
+
 
 ## 5.54.0 - 2022-05-03
 * [#1053](https://github.com/stripe/stripe-ruby/pull/1053) API Updates
@@ -261,7 +370,7 @@ Breaking changes that arose during code generation of the library that we postpo
   * Add support for `expire` test helper method on resource `Refund`
 
 ## 5.52.0 - 2022-04-18
-* [#1046](https://github.com/stripe/stripe-ruby/pull/1046) [#1047](https://github.com/stripe/stripe-ruby/pull/1047) API Updates 
+* [#1046](https://github.com/stripe/stripe-ruby/pull/1046) [#1047](https://github.com/stripe/stripe-ruby/pull/1047) API Updates
   * Add support for new resources `FundingInstructions` and `Terminal.Configuration`
 
 ## 5.51.0 - 2022-04-15
@@ -283,7 +392,7 @@ Breaking changes that arose during code generation of the library that we postpo
 * [#1040](https://github.com/stripe/stripe-ruby/pull/1040) API Updates
   * Add support for Search API
     * Add support for `search` method on resources `Charge`, `Customer`, `Invoice`, `PaymentIntent`, `Price`, `Product`, and `Subscription`
-  
+
 * [#1034](https://github.com/stripe/stripe-ruby/pull/1034) Add supporting classes for test helper generation
 
 ## 5.46.0 - 2022-03-23

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 
 group :development do
   gem "coveralls_reborn", "~> 0.25.0" if RUBY_VERSION >= "3.1"
-  gem "mocha", "~> 0.13.2"
+  gem "mocha", "~> 1.16.0"
   gem "rack", ">= 2.0.6"
   gem "rake"
 
@@ -31,6 +31,9 @@ group :development do
   # don't install on truffleruby
   gem "jaro_winkler", "1.5.4" unless RUBY_ENGINE == "truffleruby"
 
+  gem "sorbet"
+  gem "tapioca"
+
   platforms :mri do
     gem "byebug"
     gem "pry"

data/Makefile

@@ -5,9 +5,16 @@ update-version:
 
 codegen-format:
 	bundle install --quiet
-	bundle exec rubocop -o /dev/null --auto-correct
+	bundle exec rubocop -o /dev/null --autocorrect
 
 ci-test:
 	bundle install && bundle exec rake test
+	@version=$$(ruby -e "puts RUBY_VERSION.split('.')[0..1].join.to_i"); \
+	if [ $$version -ge 27 ]; then \
+		echo "Ruby version >= 2.7, continue with srb tc"; \
+		bundle exec srb tc; \
+	else \
+		echo "Ruby version < 2.7, skipping srb tc"; \
+	fi
 
 test: ci-test

data/OPENAPI_VERSION

@@ -1 +1 @@
-v682
+v1005

data/README.md

@@ -23,7 +23,6 @@ See the [Ruby API docs](https://stripe.com/docs/api?lang=ruby).
 
 See [video demonstrations][youtube-playlist] covering how to use the library.
 
-
 ## Installation
 
 You don't need this source code unless you want to modify the gem. If you just
@@ -131,17 +130,33 @@ Keep in mind that there are different method signatures depending on the action:
   `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.
 
+### Accessing resource properties
+
+Both indexer and accessors can be used to retrieve values of resource properties.
+
+```ruby
+customer = Stripe::Customer.retrieve('cus_123456789')
+puts customer['id']
+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')
+puts customer['unknown'] # nil
+puts customer.unknown # raises NoMethodError
+```
+
 ### Accessing a response object
 
-Get access to response objects by initializing a client and using its `request`
-method:
+Get access to response objects by using the `last_response` property of the returned resource:
 
 ```ruby
-client = Stripe::StripeClient.new
-customer, resp = client.request do
-  Stripe::Customer.retrieve('cus_123456789',)
-end
-puts resp.request_id
+customer = Stripe::Customer.retrieve('cus_123456789')
+
+print(customer.last_response.http_status) # to retrieve status code
+print(customer.last_response.http_headers) # to retrieve headers
 ```
 
 ### Configuring a proxy
@@ -291,10 +306,11 @@ Stripe.set_app_info('MyAwesomePlugin', version: '1.2.34', url: 'https://myawesom
 This information is passed along when the library makes calls to the Stripe
 API.
 
-### Request latency telemetry
+### Telemetry
 
-By default, the library sends request latency telemetry to Stripe. These
-numbers help Stripe improve the overall latency of its API for all users.
+By default, the library sends telemetry to Stripe regarding request latency and feature usage. These
+numbers help Stripe improve the overall latency of its API for all users, and
+improve popular features.
 
 You can disable this behavior if you prefer:
 
@@ -317,10 +333,10 @@ gem install stripe -v 7.1.0.pre.beta.2
 
 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, use the `Stripe.api_version` field to set it:
+If your beta feature requires a `Stripe-Version` header to be sent, set the `Stripe.api_version` field using `Stripe.add_beta_version`:
 
 ```python
-Stripe.api_version += "; feature_beta=v3"
+Stripe.add_beta_version("feature_beta", "v3")
 ```
 
 ## Support

data/VERSION

@@ -1 +1 @@
-10.2.0
+11.3.0

data/lib/stripe/api_operations/request.rb

@@ -5,14 +5,14 @@ module Stripe
     module Request
       module ClassMethods
         def execute_resource_request(method, url,
-                                     params = {}, opts = {})
+                                     params = {}, opts = {}, usage = [])
           execute_resource_request_internal(
-            :execute_request, method, url, params, opts
+            :execute_request, method, url, params, opts, usage
           )
         end
 
         def execute_resource_request_stream(method, url,
-                                            params = {}, opts = {},
+                                            params = {}, opts = {}, usage = [],
                                             &read_body_chunk_block)
           execute_resource_request_internal(
             :execute_request_stream,
@@ -20,18 +20,19 @@ module Stripe
             url,
             params,
             opts,
+            usage,
             &read_body_chunk_block
           )
         end
 
-        private def request_stripe_object(method:, path:, params:, opts: {})
-          resp, opts = execute_resource_request(method, path, params, opts)
-          Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+        private def request_stripe_object(method:, path:, params:, opts: {}, usage: [])
+          resp, opts = execute_resource_request(method, path, params, opts, usage)
+          Util.convert_to_stripe_object_with_params(resp.data, params, opts, resp)
         end
 
         private def execute_resource_request_internal(client_request_method_sym,
                                                       method, url,
-                                                      params, opts,
+                                                      params, opts, usage,
                                                       &read_body_chunk_block)
           params ||= {}
 
@@ -53,7 +54,7 @@ module Stripe
             client_request_method_sym,
             method, url,
             api_base: api_base, api_key: api_key,
-            headers: headers, params: params,
+            headers: headers, params: params, usage: usage,
             &read_body_chunk_block
           )
 
@@ -66,6 +67,7 @@ module Stripe
           [resp, opts_to_persist]
         end
 
+        # TODO: (major)
         # This method used to be called `request`, but it's such a short name
         # that it eventually conflicted with the name of a field on an API
         # resource (specifically, `Event#request`), so it was renamed to
@@ -111,9 +113,9 @@ module Stripe
       end
 
       protected def execute_resource_request(method, url,
-                                             params = {}, opts = {})
+                                             params = {}, opts = {}, usage = [])
         opts = @opts.merge(Util.normalize_opts(opts))
-        self.class.execute_resource_request(method, url, params, opts)
+        self.class.execute_resource_request(method, url, params, opts, usage)
       end
 
       protected def execute_resource_request_stream(method, url,
@@ -125,9 +127,9 @@ module Stripe
         )
       end
 
-      private def request_stripe_object(method:, path:, params:, opts: {})
-        resp, opts = execute_resource_request(method, path, params, opts)
-        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+      private def request_stripe_object(method:, path:, params:, opts: {}, usage: [])
+        resp, opts = execute_resource_request(method, path, params, opts, usage)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts, resp)
       end
 
       # See notes on `alias` above.

data/lib/stripe/api_operations/save.rb

@@ -66,8 +66,8 @@ module Stripe
         # generated a uri for this object with an identifier baked in
         values.delete(:id)
 
-        resp, opts = execute_resource_request(:post, save_url, values, opts)
-        initialize_from(resp.data, opts)
+        resp, opts = execute_resource_request(:post, save_url, values, opts, ["save"])
+        initialize_from(resp.data, opts, resp)
       end
       extend Gem::Deprecate
       deprecate :save, "the `update` class method (for examples " \

data/lib/stripe/api_operations/search.rb

@@ -2,6 +2,8 @@
 
 module Stripe
   module APIOperations
+    # The _search method via API Operations is deprecated.
+    # Please use the search method from within the resource instead.
     module Search
       def _search(search_url, filters = {}, opts = {})
         request_stripe_object(
@@ -11,6 +13,9 @@ module Stripe
           opts: opts
         )
       end
+
+      extend Gem::Deprecate
+      deprecate :_search, "request_stripe_object", 2024, 1
     end
   end
 end

data/lib/stripe/api_operations/singleton_save.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Stripe
+  module APIOperations
+    module SingletonSave
+      module ClassMethods
+        # Updates a singleton API resource
+        #
+        # Updates the identified resource with the passed in parameters.
+        #
+        # ==== Attributes
+        #
+        # * +params+ - A hash of parameters to pass to the API
+        # * +opts+ - A Hash of additional options (separate from the params /
+        #   object values) to be added to the request. E.g. to allow for an
+        #   idempotency_key to be passed in the request headers, or for the
+        #   api_key to be overwritten. See
+        #   {APIOperations::Request.execute_resource_request}.
+        def update(params = {}, opts = {})
+          params.each_key do |k|
+            raise ArgumentError, "Cannot update protected field: #{k}" if protected_fields.include?(k)
+          end
+
+          request_stripe_object(
+            method: :post,
+            path: resource_url,
+            params: params,
+            opts: opts
+          )
+        end
+      end
+
+      # The `save` method is DEPRECATED and will be removed in a future major
+      # version of the library. Use the `update` method on the resource instead.
+      #
+      # Updates a singleton API resource.
+      #
+      # If the resource doesn't yet have an assigned ID and the resource is one
+      # that can be created, then the method attempts to create the resource.
+      # The resource is updated otherwise.
+      #
+      # ==== Attributes
+      #
+      # * +params+ - Overrides any parameters in the resource's serialized data
+      #   and includes them in the create or update. If +:req_url:+ is included
+      #   in the list, it overrides the update URL used for the create or
+      #   update.
+      # * +opts+ - A Hash of additional options (separate from the params /
+      #   object values) to be added to the request. E.g. to allow for an
+      #   idempotency_key to be passed in the request headers, or for the
+      #   api_key to be overwritten. See
+      #   {APIOperations::Request.execute_resource_request}.
+      def save(params = {}, opts = {})
+        # We started unintentionally (sort of) allowing attributes sent to
+        # +save+ to override values used during the update. So as not to break
+        # the API, this makes that official here.
+        update_attributes(params)
+
+        # Now remove any parameters that look like object attributes.
+        params = params.reject { |k, _| respond_to?(k) }
+
+        values = serialize_params(self).merge(params)
+
+        resp, opts = execute_resource_request(:post, resource_url, values, opts, ["save"])
+        initialize_from(resp.data, opts, resp)
+      end
+      extend Gem::Deprecate
+      deprecate :save, "the `update` class method (for examples " \
+                       "see https://github.com/stripe/stripe-ruby" \
+                       "/wiki/Migration-guide-for-v8)", 2022, 11
+
+      def self.included(base)
+        # Set `metadata` as additive so that when it's set directly we remember
+        # to clear keys that may have been previously set by sending empty
+        # values for them.
+        #
+        # It's possible that not every object with `Save` has `metadata`, but
+        # it's a close enough heuristic, and having this option set when there
+        # is no `metadata` field is not harmful.
+        base.additive_object_param(:metadata)
+
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/stripe/api_resource.rb

@@ -11,6 +11,15 @@ module Stripe
     # for example, where this is allowed.
     attr_accessor :save_with_parent
 
+    # TODO: (major) Remove OBJECT_NAME and stop using const_get here
+    # This is a workaround to avoid breaking users who have defined their own
+    # APIResource subclasses with a custom OBJECT_NAME. We should never fallback
+    # on this case otherwise.
+    OBJECT_NAME = ""
+    def self.object_name
+      const_get(:OBJECT_NAME)
+    end
+
     def self.class_name
       name.split("::")[-1]
     end
@@ -23,7 +32,7 @@ module Stripe
       end
       # Namespaces are separated in object names with periods (.) and in URLs
       # with forward slashes (/), so replace the former with the latter.
-      "/v1/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
+      "/v1/#{object_name.downcase.tr('.', '/')}s"
     end
 
     # A metaprogramming call that specifies that a field of a resource can be
@@ -80,7 +89,7 @@ module Stripe
     def refresh
       resp, opts = execute_resource_request(:get, resource_url,
                                             @retrieve_params)
-      initialize_from(resp.data, opts)
+      initialize_from(resp.data, opts, resp)
     end
 
     def self.retrieve(id, opts = {})
@@ -95,9 +104,9 @@ module Stripe
 
       # If we're getting back this thing, update; otherwise, instantiate.
       if Util.object_name_matches_class?(resp.data[:object], self.class)
-        initialize_from(resp.data, opts)
+        initialize_from(resp.data, opts, resp)
       else
-        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts, resp)
       end
     end
 

data/lib/stripe/api_resource_test_helpers.rb

@@ -14,6 +14,10 @@ module Stripe
       @resource = resource
     end
 
+    def self.resource_class
+      nil
+    end
+
     # Adds a custom method to a test helper. This is used to add support for
     # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
     # following parameters:
@@ -27,12 +31,12 @@ module Stripe
     # adds a `capture` class method to the resource class that, when called,
     # will send a POST request to `/v1/<object_name>/capture`.
     def self.custom_method(name, http_verb:, http_path: nil)
-      Util.custom_method self::RESOURCE_CLASS, self, name, http_verb, http_path
+      Util.custom_method resource_class, self, name, http_verb, http_path
     end
 
     def self.resource_url
       "/v1/test_helpers/" \
-        "#{self::RESOURCE_CLASS::OBJECT_NAME.downcase.tr('.', '/')}s"
+        "#{resource_class.object_name.downcase.tr('.', '/')}s"
     end
 
     def resource_url

data/lib/stripe/api_version.rb

@@ -3,6 +3,6 @@
 
 module Stripe
   module ApiVersion
-    CURRENT = "2023-10-16"
+    CURRENT = "2024-04-10"
   end
 end

data/lib/stripe/list_object.rb

@@ -8,6 +8,9 @@ module Stripe
     include Stripe::APIOperations::Create
 
     OBJECT_NAME = "list"
+    def self.object_name
+      "list"
+    end
 
     # This accessor allows a `ListObject` to inherit various filters that were
     # given to a predecessor. This allows for things like consistent limits,