stripe 10.11.0 → 10.12.0

data/lib/stripe/resources/customer.rb

@@ -9,9 +9,9 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
-    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "customer"
     def self.object_name
@@ -23,6 +23,11 @@ module Stripe
     nested_resource_class_methods :source, operations: %i[create retrieve update delete list]
     nested_resource_class_methods :tax_id, operations: %i[create retrieve delete list]
 
+    # Creates a new customer object.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/customers", params: params, opts: opts)
+    end
+
     # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
     # funding instructions will be created. If funding instructions have already been created for a given customer, the same
     # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
@@ -35,43 +40,43 @@ module Stripe
       )
     end
 
-    # Removes the currently applied discount on a customer.
-    def delete_discount(params = {}, opts = {})
+    # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
+    # funding instructions will be created. If funding instructions have already been created for a given customer, the same
+    # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
+    def self.create_funding_instructions(customer, params = {}, opts = {})
       request_stripe_object(
-        method: :delete,
-        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(self["id"]) }),
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
         params: params,
         opts: opts
       )
     end
 
-    # Returns a list of PaymentMethods for a given Customer
-    def list_payment_methods(params = {}, opts = {})
+    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
+    def self.delete(id, params = {}, opts = {})
       request_stripe_object(
-        method: :get,
-        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(self["id"]) }),
+        method: :delete,
+        path: format("/v1/customers/%<id>s", { id: CGI.escape(id) }),
         params: params,
         opts: opts
       )
     end
 
-    # Retrieves a PaymentMethod object for a given Customer.
-    def retrieve_payment_method(payment_method, params = {}, opts = {})
+    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
+    def delete(params = {}, opts = {})
       request_stripe_object(
-        method: :get,
-        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(self["id"]), payment_method: CGI.escape(payment_method) }),
+        method: :delete,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
-    # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
-    # funding instructions will be created. If funding instructions have already been created for a given customer, the same
-    # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
-    def self.create_funding_instructions(customer, params = {}, opts = {})
+    # Removes the currently applied discount on a customer.
+    def delete_discount(params = {}, opts = {})
       request_stripe_object(
-        method: :post,
-        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -87,62 +92,59 @@ module Stripe
       )
     end
 
+    # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/customers", params: filters, opts: opts)
+    end
+
     # Returns a list of PaymentMethods for a given Customer
-    def self.list_payment_methods(customer, params = {}, opts = {})
+    def list_payment_methods(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
-    # Retrieves a PaymentMethod object for a given Customer.
-    def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {})
+    # Returns a list of PaymentMethods for a given Customer
+    def self.list_payment_methods(customer, params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
         params: params,
         opts: opts
       )
     end
 
-    save_nested_resource :source
-
-    # The API request for deleting a card or bank account and for detaching a
-    # source object are the same.
-    class << self
-      alias detach_source delete_source
-    end
-
-    # Creates a new customer object.
-    def self.create(params = {}, opts = {})
-      request_stripe_object(method: :post, path: "/v1/customers", params: params, opts: opts)
-    end
-
-    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
-    def self.delete(id, params = {}, opts = {})
+    # Retrieves a customer's cash balance.
+    def self.retrieve_cash_balance(customer, params = {}, opts = {})
       request_stripe_object(
-        method: :delete,
-        path: format("/v1/customers/%<id>s", { id: CGI.escape(id) }),
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
         params: params,
         opts: opts
       )
     end
 
-    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
-    def delete(params = {}, opts = {})
+    # Retrieves a PaymentMethod object for a given Customer.
+    def retrieve_payment_method(payment_method, params = {}, opts = {})
       request_stripe_object(
-        method: :delete,
-        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(self["id"]) }),
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(self["id"]), payment_method: CGI.escape(payment_method) }),
         params: params,
         opts: opts
       )
     end
 
-    # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
-    def self.list(filters = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/customers", params: filters, opts: opts)
+    # Retrieves a PaymentMethod object for a given Customer.
+    def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts
+      )
     end
 
     def self.search(params = {}, opts = {})
@@ -165,16 +167,6 @@ module Stripe
       )
     end
 
-    # Retrieves a customer's cash balance.
-    def self.retrieve_cash_balance(customer, params = {}, opts = {})
-      request_stripe_object(
-        method: :get,
-        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
-        params: params,
-        opts: opts
-      )
-    end
-
     # Changes the settings on a customer's cash balance.
     def self.update_cash_balance(customer, params = {}, opts = {})
       request_stripe_object(
@@ -185,6 +177,14 @@ module Stripe
       )
     end
 
+    save_nested_resource :source
+
+    # The API request for deleting a card or bank account and for detaching a
+    # source object are the same.
+    class << self
+      alias detach_source delete_source
+    end
+
     def test_helpers
       TestHelpers.new(self)
     end

data/lib/stripe/resources/ephemeral_key.rb

@@ -11,15 +11,6 @@ module Stripe
       "ephemeral_key"
     end
 
-    def self.create(params = {}, opts = {})
-      opts = Util.normalize_opts(opts)
-      unless opts[:stripe_version]
-        raise ArgumentError,
-              "stripe_version must be specified to create an ephemeral key"
-      end
-      super
-    end
-
     # Invalidates a short-lived API key for a given resource.
     def self.delete(id, params = {}, opts = {})
       request_stripe_object(
@@ -39,5 +30,14 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.create(params = {}, opts = {})
+      opts = Util.normalize_opts(opts)
+      unless opts[:stripe_version]
+        raise ArgumentError,
+              "stripe_version must be specified to create an ephemeral key"
+      end
+      super
+    end
   end
 end

data/lib/stripe/resources/file.rb

@@ -18,6 +18,11 @@ module Stripe
       "file"
     end
 
+    # Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/files", params: filters, opts: opts)
+    end
+
     # This resource can have two different object names. In latter API
     # versions, only `file` is used, but since stripe-ruby may be used with
     # any API version, we need to support deserializing the older
@@ -43,10 +48,5 @@ module Stripe
       }.merge(Util.normalize_opts(opts))
       super
     end
-
-    # Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
-    def self.list(filters = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/files", params: filters, opts: opts)
-    end
   end
 end

data/lib/stripe/resources/financial_connections/account.rb

@@ -22,71 +22,71 @@ module Stripe
         )
       end
 
-      # Lists all owners for a given Account
-      def list_owners(params = {}, opts = {})
+      # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
+      def self.disconnect(account, params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(self["id"]) }),
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
           params: params,
           opts: opts
         )
       end
 
-      # Refreshes the data associated with a Financial Connections Account.
-      def refresh_account(params = {}, opts = {})
+      # Returns a list of Financial Connections Account objects.
+      def self.list(filters = {}, opts = {})
         request_stripe_object(
-          method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(self["id"]) }),
-          params: params,
+          method: :get,
+          path: "/v1/financial_connections/accounts",
+          params: filters,
           opts: opts
         )
       end
 
-      # Subscribes to periodic refreshes of data associated with a Financial Connections Account.
-      def subscribe(params = {}, opts = {})
+      # Lists all owners for a given Account
+      def list_owners(params = {}, opts = {})
         request_stripe_object(
-          method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(self["id"]) }),
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
-      def unsubscribe(params = {}, opts = {})
+      # Lists all owners for a given Account
+      def self.list_owners(account, params = {}, opts = {})
         request_stripe_object(
-          method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(self["id"]) }),
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
           params: params,
           opts: opts
         )
       end
 
-      # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
-      def self.disconnect(account, params = {}, opts = {})
+      # Refreshes the data associated with a Financial Connections Account.
+      def refresh_account(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Lists all owners for a given Account
-      def self.list_owners(account, params = {}, opts = {})
+      # Refreshes the data associated with a Financial Connections Account.
+      def self.refresh_account(account, params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
           params: params,
           opts: opts
         )
       end
 
-      # Refreshes the data associated with a Financial Connections Account.
-      def self.refresh_account(account, params = {}, opts = {})
+      # Subscribes to periodic refreshes of data associated with a Financial Connections Account.
+      def subscribe(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
@@ -103,21 +103,21 @@ module Stripe
       end
 
       # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
-      def self.unsubscribe(account, params = {}, opts = {})
+      def unsubscribe(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Returns a list of Financial Connections Account objects.
-      def self.list(filters = {}, opts = {})
+      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
+      def self.unsubscribe(account, params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: "/v1/financial_connections/accounts",
-          params: filters,
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
+          params: params,
           opts: opts
         )
       end

data/lib/stripe/resources/identity/verification_session.rb

@@ -36,6 +36,44 @@ module Stripe
         )
       end
 
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      #
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
+      def self.cancel(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s/cancel", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a VerificationSession object.
+      #
+      # After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
+      #
+      # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
+      #
+      # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/identity/verification_sessions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of VerificationSessions
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/identity/verification_sessions",
+          params: filters,
+          opts: opts
+        )
+      end
+
       # Redact a VerificationSession to remove all collected information from Stripe. This will redact
       # the VerificationSession and all objects related to it, including VerificationReports, Events,
       # request logs, etc.
@@ -64,18 +102,6 @@ module Stripe
         )
       end
 
-      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
-      #
-      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
-      def self.cancel(session, params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: format("/v1/identity/verification_sessions/%<session>s/cancel", { session: CGI.escape(session) }),
-          params: params,
-          opts: opts
-        )
-      end
-
       # Redact a VerificationSession to remove all collected information from Stripe. This will redact
       # the VerificationSession and all objects related to it, including VerificationReports, Events,
       # request logs, etc.
@@ -104,32 +130,6 @@ module Stripe
         )
       end
 
-      # Creates a VerificationSession object.
-      #
-      # After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
-      #
-      # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
-      #
-      # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
-      def self.create(params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: "/v1/identity/verification_sessions",
-          params: params,
-          opts: opts
-        )
-      end
-
-      # Returns a list of VerificationSessions
-      def self.list(filters = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/identity/verification_sessions",
-          params: filters,
-          opts: opts
-        )
-      end
-
       # Updates a VerificationSession object.
       #
       # When the session status is requires_input, you can use this method to update the