stripe 10.11.0 → 10.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28c08ac3bb74417f42f5d45630f1efdad13075deec60589cea4c8b88c8db9a3b
-  data.tar.gz: 1b2560d8edde07beba5f2534efc3f7ca3009cdd4b431d10539d5e6542ef2a58f
+  metadata.gz: 9e52a05420bec18e9240d0d9c32a9d71021d6d3ca55a29ddcc131f1a1f6c7729
+  data.tar.gz: a16df9ff4b6fa6b4ecbf0c85aa981f3e6a79554a57999ad05d22ae92ae292df5
 SHA512:
-  metadata.gz: 86ec1cc29d4876d59b00854f73d6a7e10c19bcb91bd5b708dd943e2e36d16c07d74b8766fc47093a584926257f37d4c150c716c0ac73e4b3820311b250a942ec
-  data.tar.gz: 51ae5ff315ca40fdfab8eae78945ffea6f96d06a41d7cabfb5bf3c3b437534cf5ca9a9a437c3ec87d46c39f7d8aed4698beb88ca16ca84ac64ea6d480eb9e82a
+  metadata.gz: 680a5346daf24fbff0ce55bfa9a2e6c4b8dd91a495ff40307ed40f60b2453b7928eebd17b0e1a15e08be67fb3e1d30ae648b5c02ab953642b70efaa5fb53186e
+  data.tar.gz: 1f3c9cd397e61df0e7a355fdb05b8f5fb6fd90d5df77c2c5ee5f3093ae08808dd82bd598203f5c6019cf76e0724cddcbb2200a1c6ad6722508800e32fa86a5c2

data/CHANGELOG.md

@@ -1,17 +1,18 @@
 # Changelog
-## 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 - 2024-02-29
-* [#1348](https://github.com/stripe/stripe-ruby/pull/1348) Use sorbet gem instead of sorbet-static
+## 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`
+  * 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

data/OPENAPI_VERSION

@@ -1 +1 @@
-v841
+v878

data/VERSION

@@ -1 +1 @@
-10.11.0
+10.12.0

data/lib/stripe/object_types.rb

@@ -1,4 +1,3 @@
-# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/MethodLength
@@ -11,9 +10,9 @@ module Stripe
         # data structures
         ListObject.object_name => ListObject,
         SearchResultObject.object_name => SearchResultObject,
-
-        # business objects
         File.object_name_alt => File,
+
+        # The beginning of the section generated from our OpenAPI spec
         Account.object_name => Account,
         AccountLink.object_name => AccountLink,
         AccountSession.object_name => AccountSession,
@@ -51,8 +50,7 @@ module Stripe
         FileLink.object_name => FileLink,
         FinancialConnections::Account.object_name => FinancialConnections::Account,
         FinancialConnections::AccountOwner.object_name => FinancialConnections::AccountOwner,
-        FinancialConnections::AccountOwnership.object_name =>
-        FinancialConnections::AccountOwnership,
+        FinancialConnections::AccountOwnership.object_name => FinancialConnections::AccountOwnership,
         FinancialConnections::Session.object_name => FinancialConnections::Session,
         FinancialConnections::Transaction.object_name => FinancialConnections::Transaction,
         FundingInstructions.object_name => FundingInstructions,
@@ -65,6 +63,8 @@ module Stripe
         Issuing::Card.object_name => Issuing::Card,
         Issuing::Cardholder.object_name => Issuing::Cardholder,
         Issuing::Dispute.object_name => Issuing::Dispute,
+        Issuing::PersonalizationDesign.object_name => Issuing::PersonalizationDesign,
+        Issuing::PhysicalBundle.object_name => Issuing::PhysicalBundle,
         Issuing::Token.object_name => Issuing::Token,
         Issuing::Transaction.object_name => Issuing::Transaction,
         LineItem.object_name => LineItem,
@@ -130,6 +130,7 @@ module Stripe
         UsageRecord.object_name => UsageRecord,
         UsageRecordSummary.object_name => UsageRecordSummary,
         WebhookEndpoint.object_name => WebhookEndpoint,
+        # The end of the section generated from our OpenAPI spec
       }
     end
   end

data/lib/stripe/resources/account.rb

@@ -13,8 +13,8 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::NestedResource
+    include Stripe::APIOperations::Save
 
     OBJECT_NAME = "account"
     def self.object_name
@@ -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/charge.rb

@@ -9,9 +9,9 @@ module Stripe
   class Charge < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
-    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "charge"
     def self.object_name

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
       )