stripe 10.11.0.pre.beta.1 → 10.12.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1903d66d648151dffe456532457d6ae62369c49f60b9b6617f677229bf68bcfb
-  data.tar.gz: 275568d472af593e83f32c70b9451123b62ccc6683bb5b1280c2c71b2e734d03
+  metadata.gz: c161ad9743ceceb2624b6df2f851bb5c58ce3a7dd25c00e0406a41ee307af98d
+  data.tar.gz: d1fea5ff8da6ad1baa4a0e8256d869cf7104ef75175ab14ff3e08b887b695b84
 SHA512:
-  metadata.gz: 8c09ecf5f0b3803e01e62a143c4fe19b4c2836fff37cc86a9b2de432af383377a87ddd026104222fb644f69c88a8d4ab66d219e94e03a6cc40f3200f57ab93d1
-  data.tar.gz: 6d7b088894ff02817dcd2bc7cc69e9b42f86fb02620f3d91e923e271ca590eb7d44dafd7e8d43f001970f12e18046e755bd5a6b50651c9bd0d9b98fcb7492ce3
+  metadata.gz: 8557c142f12cb1dcedba2fc486966ba9bbfb73fb4dfd2bea71490c906484bdd1972d982aefe41f00a0e28f2d9220d7de5cc7bbbf4a575ab1d807bd33408a7fe7
+  data.tar.gz: 9be2fb4c050e44b88a888bd835840ae84371527e5feb56f7d7883e4e0064271f4821b5a2f0ecdf7d6213efaf7aca6fd9ccdb96a209ea32ddaa7ba12fbf9d878a

data/CHANGELOG.md

@@ -1,9 +1,23 @@
 # Changelog
 
+## 10.12.0-beta.1 - 2024-02-29
+* [#1352](https://github.com/stripe/stripe-ruby/pull/1352) Update generated code for beta
+  Release specs are identical.
+* [#1350](https://github.com/stripe/stripe-ruby/pull/1350) Update generated code for beta
+
+* [#1341](https://github.com/stripe/stripe-ruby/pull/1341) Update generated code for beta
+  * Remove support for resource `Entitlements.Event`
+* [#1343](https://github.com/stripe/stripe-ruby/pull/1343) Add a helper to add a beta version
+
+## 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.11.0-beta.1 - 2024-02-22
 * [#1335](https://github.com/stripe/stripe-ruby/pull/1335) Update generated code for beta
 
-
 ## 10.10.0 - 2024-02-22
 * [#1336](https://github.com/stripe/stripe-ruby/pull/1336) Update generated code
   - Add `InvoiceLineItem.update` method.

data/Gemfile

@@ -31,7 +31,7 @@ group :development do
   # don't install on truffleruby
   gem "jaro_winkler", "1.5.4" unless RUBY_ENGINE == "truffleruby"
 
-  gem "sorbet-static"
+  gem "sorbet"
   gem "tapioca"
 
   platforms :mri do

data/OPENAPI_VERSION

@@ -1 +1 @@
-v840
+v857

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
@@ -336,10 +335,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")
 ```
 
 ### Custom requests

data/VERSION

@@ -1 +1 @@
-10.11.0-beta.1
+10.12.0-beta.1

data/lib/stripe/object_types.rb

@@ -51,7 +51,6 @@ module Stripe
         CustomerSession.object_name => CustomerSession,
         Discount.object_name => Discount,
         Dispute.object_name => Dispute,
-        Entitlements::Event.object_name => Entitlements::Event,
         Entitlements::Feature.object_name => Entitlements::Feature,
         EphemeralKey.object_name => EphemeralKey,
         Event.object_name => Event,

data/lib/stripe/resources/account.rb

@@ -29,6 +29,49 @@ module Stripe
     nested_resource_class_methods :login_link, operations: %i[create]
     nested_resource_class_methods :person, operations: %i[create retrieve update delete list]
 
+    # With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users.
+    # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
+    #
+    # If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when
+    # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
+    # You can prefill any information on the account.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/accounts", params: params, opts: opts)
+    end
+
+    # With [Connect](https://stripe.com/docs/connect), you can delete accounts you manage.
+    #
+    # Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
+    #
+    # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
+    def self.delete(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/accounts/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # With [Connect](https://stripe.com/docs/connect), you can delete accounts you manage.
+    #
+    # Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
+    #
+    # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/accounts/%<account>s", { account: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/accounts", params: filters, opts: opts)
+    end
+
     # Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
     def persons(params = {}, opts = {})
       request_stripe_object(
@@ -39,6 +82,16 @@ module Stripe
       )
     end
 
+    # Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
+    def self.persons(account, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # With [Connect](https://stripe.com/docs/connect), you may flag accounts as suspicious.
     #
     # Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.
@@ -51,23 +104,31 @@ module Stripe
       )
     end
 
-    # Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
-    def self.persons(account, params = {}, opts = {})
+    # With [Connect](https://stripe.com/docs/connect), you may flag accounts as suspicious.
+    #
+    # Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.
+    def self.reject(account, params = {}, opts = {})
       request_stripe_object(
-        method: :get,
-        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(account) }),
+        method: :post,
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(account) }),
         params: params,
         opts: opts
       )
     end
 
-    # With [Connect](https://stripe.com/docs/connect), you may flag accounts as suspicious.
+    # Updates a [connected account](https://stripe.com/docs/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
+    # left unchanged.
     #
-    # Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.
-    def self.reject(account, params = {}, opts = {})
+    # For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that
+    # account has started to go through Connect Onboarding. Once you create an [Account Link or <a href="/docs/api/account_sessions">Account Session](https://stripe.com/docs/api/account_links),
+    # some properties can only be changed or updated for Custom accounts.
+    #
+    # To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
+    # [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
+    def self.update(id, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(account) }),
+        path: format("/v1/accounts/%<id>s", { id: CGI.escape(id) }),
         params: params,
         opts: opts
       )
@@ -196,66 +257,5 @@ module Stripe
       end
       update_hash
     end
-
-    # With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users.
-    # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
-    #
-    # If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when
-    # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
-    # You can prefill any information on the account.
-    def self.create(params = {}, opts = {})
-      request_stripe_object(method: :post, path: "/v1/accounts", params: params, opts: opts)
-    end
-
-    # With [Connect](https://stripe.com/docs/connect), you can delete accounts you manage.
-    #
-    # Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
-    #
-    # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
-    def self.delete(id, params = {}, opts = {})
-      request_stripe_object(
-        method: :delete,
-        path: format("/v1/accounts/%<id>s", { id: CGI.escape(id) }),
-        params: params,
-        opts: opts
-      )
-    end
-
-    # With [Connect](https://stripe.com/docs/connect), you can delete accounts you manage.
-    #
-    # Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
-    #
-    # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
-    def delete(params = {}, opts = {})
-      request_stripe_object(
-        method: :delete,
-        path: format("/v1/accounts/%<account>s", { account: CGI.escape(self["id"]) }),
-        params: params,
-        opts: opts
-      )
-    end
-
-    # Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty.
-    def self.list(filters = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/accounts", params: filters, opts: opts)
-    end
-
-    # Updates a [connected account](https://stripe.com/docs/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
-    # left unchanged.
-    #
-    # For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that
-    # account has started to go through Connect Onboarding. Once you create an [Account Link or <a href="/docs/api/account_sessions">Account Session](https://stripe.com/docs/api/account_links),
-    # some properties can only be changed or updated for Custom accounts.
-    #
-    # To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
-    # [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
-    def self.update(id, params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/accounts/%<id>s", { id: CGI.escape(id) }),
-        params: params,
-        opts: opts
-      )
-    end
   end
 end

data/lib/stripe/resources/apple_pay_domain.rb

@@ -13,10 +13,6 @@ module Stripe
       "apple_pay_domain"
     end
 
-    def self.resource_url
-      "/v1/apple_pay/domains"
-    end
-
     # Create an apple pay domain.
     def self.create(params = {}, opts = {})
       request_stripe_object(
@@ -56,5 +52,9 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.resource_url
+      "/v1/apple_pay/domains"
+    end
   end
 end

data/lib/stripe/resources/apps/secret.rb

@@ -21,6 +21,11 @@ module Stripe
         "apps.secret"
       end
 
+      # Create or replace a secret in the secret store.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/apps/secrets", params: params, opts: opts)
+      end
+
       # Deletes a secret from the secret store by name and scope.
       def self.delete_where(params = {}, opts = {})
         request_stripe_object(
@@ -41,11 +46,6 @@ module Stripe
         )
       end
 
-      # Create or replace a secret in the secret store.
-      def self.create(params = {}, opts = {})
-        request_stripe_object(method: :post, path: "/v1/apps/secrets", params: params, opts: opts)
-      end
-
       # List all secrets stored on the given scope.
       def self.list(filters = {}, opts = {})
         request_stripe_object(method: :get, path: "/v1/apps/secrets", params: filters, opts: opts)

data/lib/stripe/resources/capital/financing_offer.rb

@@ -13,6 +13,16 @@ module Stripe
         "capital.financing_offer"
       end
 
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: filters,
+          opts: opts
+        )
+      end
+
       # Acknowledges that platform has received and delivered the financing_offer to
       # the intended merchant recipient.
       def mark_delivered(params = {}, opts = {})
@@ -34,16 +44,6 @@ module Stripe
           opts: opts
         )
       end
-
-      # Retrieves the financing offers available for Connected accounts that belong to your platform.
-      def self.list(filters = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/capital/financing_offers",
-          params: filters,
-          opts: opts
-        )
-      end
     end
   end
 end

data/lib/stripe/resources/charge.rb

@@ -11,12 +11,15 @@ module Stripe
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "charge"
     def self.object_name
       "charge"
     end
 
+    nested_resource_class_methods :refund, operations: %i[retrieve list]
+
     # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
     #
     # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.

data/lib/stripe/resources/checkout/session.rb

@@ -26,23 +26,23 @@ module Stripe
         "checkout.session"
       end
 
-      # A Session can be expired when it is in one of these statuses: open
-      #
-      # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
-      def expire(params = {}, opts = {})
+      # Creates a Session object.
+      def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(self["id"]) }),
+          path: "/v1/checkout/sessions",
           params: params,
           opts: opts
         )
       end
 
-      # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
-      def list_line_items(params = {}, opts = {})
+      # A Session can be expired when it is in one of these statuses: open
+      #
+      # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
+      def expire(params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(self["id"]) }),
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
@@ -60,32 +60,32 @@ module Stripe
         )
       end
 
-      # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
-      def self.list_line_items(session, params = {}, opts = {})
+      # Returns a list of Checkout Sessions.
+      def self.list(filters = {}, opts = {})
         request_stripe_object(
           method: :get,
-          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(session) }),
-          params: params,
+          path: "/v1/checkout/sessions",
+          params: filters,
           opts: opts
         )
       end
 
-      # Creates a Session object.
-      def self.create(params = {}, opts = {})
+      # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+      def list_line_items(params = {}, opts = {})
         request_stripe_object(
-          method: :post,
-          path: "/v1/checkout/sessions",
+          method: :get,
+          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Returns a list of Checkout Sessions.
-      def self.list(filters = {}, opts = {})
+      # When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+      def self.list_line_items(session, params = {}, opts = {})
         request_stripe_object(
           method: :get,
-          path: "/v1/checkout/sessions",
-          params: filters,
+          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(session) }),
+          params: params,
           opts: opts
         )
       end

data/lib/stripe/resources/credit_note.rb

@@ -15,14 +15,27 @@ module Stripe
       "credit_note"
     end
 
-    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
-    def void_credit_note(params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(self["id"]) }),
-        params: params,
-        opts: opts
-      )
+    # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
+    # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
+    # in any combination of the following:
+    #
+    #
+    # Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
+    # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
+    # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
+    #
+    #
+    # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
+    #
+    # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
+    # or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/credit_notes", params: params, opts: opts)
+    end
+
+    # Returns a list of credit notes.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/credit_notes", params: filters, opts: opts)
     end
 
     # When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
@@ -45,44 +58,31 @@ module Stripe
       )
     end
 
-    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
-    def self.void_credit_note(id, params = {}, opts = {})
+    # Updates an existing credit note.
+    def self.update(id, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
+        path: format("/v1/credit_notes/%<id>s", { id: CGI.escape(id) }),
         params: params,
         opts: opts
       )
     end
 
-    # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
-    # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
-    # in any combination of the following:
-    #
-    #
-    # Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
-    # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
-    # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
-    #
-    #
-    # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
-    #
-    # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
-    # or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
-    def self.create(params = {}, opts = {})
-      request_stripe_object(method: :post, path: "/v1/credit_notes", params: params, opts: opts)
-    end
-
-    # Returns a list of credit notes.
-    def self.list(filters = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/credit_notes", params: filters, opts: opts)
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
+    def void_credit_note(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
     end
 
-    # Updates an existing credit note.
-    def self.update(id, params = {}, opts = {})
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
+    def self.void_credit_note(id, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/credit_notes/%<id>s", { id: CGI.escape(id) }),
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
         params: params,
         opts: opts
       )