Merge pull request #1386 from stripe/latest-codegen-beta

Update generated code for beta

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, jruby-9.4.0.0, truffleruby-head]
+        ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, '3.3', jruby-9.4.0.0, truffleruby-head]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby

CHANGELOG.md

@@ -3,6 +3,9 @@
 ## 11.3.0-beta.1 - 2024-04-18
 * [#1383](https://github.com/stripe/stripe-ruby/pull/1383) Update generated code for beta
 
+## 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

OPENAPI_VERSION

@@ -1 +1 @@
-v962
+v1005

lib/stripe/resources/account.rb

@@ -6,9 +6,14 @@ module Stripe
   # properties on the account like its current requirements or if the account is
   # enabled to make live charges or receive payouts.
   #
-  # For Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that
-  # account has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links) or [Account Session](https://stripe.com/docs/api/account_sessions),
-  # some properties are only returned for Custom accounts. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts).
+  # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
+  # is `application`, which includes Custom accounts, the properties below are always
+  # returned.
+  #
+  # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
+  # is `stripe`, which includes Standard and Express accounts, some properties are only returned
+  # until you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions)
+  # to start Connect Onboarding. Learn about the [differences between accounts](https://stripe.com/connect/accounts).
   class Account < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
@@ -39,9 +44,11 @@ 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.
+    # With [Connect](https://stripe.com/connect), you can delete accounts you manage.
+    #
+    # Test-mode accounts can be deleted at any time.
     #
-    # 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.
+    # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balanace_object) 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 = {})
@@ -53,9 +60,11 @@ def self.delete(id, params = {}, opts = {})
       )
     end
 
-    # With [Connect](https://stripe.com/docs/connect), you can delete accounts you manage.
+    # With [Connect](https://stripe.com/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.
+    # Test-mode accounts can be deleted at any time.
+    #
+    # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balanace_object) 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 = {})
@@ -92,9 +101,9 @@ def self.persons(account, params = {}, opts = {})
       )
     end
 
-    # With [Connect](https://stripe.com/docs/connect), you may flag accounts as suspicious.
+    # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged 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.
+    # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
     def reject(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -104,9 +113,9 @@ def reject(params = {}, opts = {})
       )
     end
 
-    # With [Connect](https://stripe.com/docs/connect), you may flag accounts as suspicious.
+    # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged 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.
+    # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
     def self.reject(account, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -116,12 +125,16 @@ def self.reject(account, params = {}, 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
+    # Updates a [connected account](https://stripe.com/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.
+    # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
+    # is application, which includes Custom accounts, you can update any information on the account.
+    #
+    # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
+    # is stripe, which includes Standard and Express accounts, you can update all information until you create
+    # an [Account Link or <a href="/api/account_sessions">Account Session](https://stripe.com/api/account_links) to start Connect onboarding,
+    # after which some properties can no longer be updated.
     #
     # 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.

lib/stripe/resources/bank_account.rb

@@ -4,11 +4,12 @@
 module Stripe
   # These bank accounts are payment methods on `Customer` objects.
   #
-  # On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer
-  # destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).
+  # On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer
+  # destinations on `Account` objects for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
+  # is `application`, which includes [Custom accounts](https://stripe.com/connect/custom-accounts).
   # They can be bank accounts or debit cards as well, and are documented in the links above.
   #
-  # Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)
+  # Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers)
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

lib/stripe/resources/event.rb

@@ -23,10 +23,10 @@ module Stripe
   # `Event` objects directly to an endpoint on your server. You can manage
   # webhooks in your
   # [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
-  # to [listen for events](https://stripe.com/docs/webhooks)
+  # to [listen for events](https://docs.stripe.com/webhooks)
   # so that your integration can automatically trigger reactions.
   #
-  # When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications
+  # When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications
   # that occur in connected accounts. For these events, there's an
   # additional `account` attribute in the received `Event` object.
   #
@@ -40,7 +40,7 @@ def self.object_name
       "event"
     end
 
-    # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://stripe.com/docs/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
+    # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
     def self.list(filters = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/events", params: filters, opts: opts)
     end

lib/stripe/resources/invoice.rb

@@ -115,6 +115,8 @@ def self.create(params = {}, opts = {})
     # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
     #
     # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.
+    #
+    # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
     def self.create_preview(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -275,7 +277,9 @@ def self.send_invoice(invoice, params = {}, opts = {})
     #
     # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
     #
-    # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date value passed in the request.
+    # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.
+    #
+    # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
     def self.upcoming(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/invoices/upcoming", params: params, opts: opts)
     end

lib/stripe/resources/issuing/authorization.rb

@@ -9,6 +9,7 @@ module Issuing
     #
     # Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)
     class Authorization < APIResource
+      extend Gem::Deprecate
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save
 
@@ -27,6 +28,7 @@ def approve(params = {}, opts = {})
           opts: opts
         )
       end
+      deprecate :approve, :none, 2024, 3
 
       # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
       # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
@@ -38,6 +40,10 @@ def self.approve(authorization, params = {}, opts = {})
           opts: opts
         )
       end
+      class << self
+        extend Gem::Deprecate
+        deprecate :approve, :none, 2024, 3
+      end
 
       # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
       # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
@@ -49,6 +55,7 @@ def decline(params = {}, opts = {})
           opts: opts
         )
       end
+      deprecate :decline, :none, 2024, 3
 
       # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
       # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
@@ -60,6 +67,10 @@ def self.decline(authorization, params = {}, opts = {})
           opts: opts
         )
       end
+      class << self
+        extend Gem::Deprecate
+        deprecate :decline, :none, 2024, 3
+      end
 
       # Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
       def self.list(filters = {}, opts = {})

lib/stripe/resources/login_link.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  # Login Links are single-use login link for an Express account to access their Stripe dashboard.
+  # Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](https://stripe.com/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard.
   class LoginLink < APIResource
     OBJECT_NAME = "login_link"
     def self.object_name

lib/stripe/resources/person.rb

@@ -4,10 +4,9 @@
 module Stripe
   # This is an object representing a person associated with a Stripe account.
   #
-  # A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.
-  # See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps.
+  # A platform cannot access a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
   #
-  # Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information)
+  # See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
   class Person < APIResource
     include Stripe::APIOperations::Save
 

lib/stripe/resources/token.rb

@@ -19,7 +19,7 @@ module Stripe
   #
   # You can't store or use tokens more than once. To store card or bank account
   # information for later use, create [Customer](https://stripe.com/docs/api#customers)
-  # objects or [Custom accounts](https://stripe.com/docs/api#external_accounts).
+  # objects or [External accounts](https://stripe.com/api#external_accounts).
   # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
   # performs best with integrations that use client-side tokenization.
   class Token < APIResource
@@ -31,7 +31,7 @@ def self.object_name
     end
 
     # Creates a single-use token that represents a bank account's details.
-    # You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [Custom account](https://stripe.com/docs/api#accounts).
+    # You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/tokens", params: params, opts: opts)
     end