stripe 6.2.0 → 6.5.0

data/lib/stripe/resources/customer.rb

@@ -12,12 +12,6 @@ module Stripe
 
     OBJECT_NAME = "customer"
 
-    custom_method :create_funding_instructions, http_verb: :post, http_path: "funding_instructions"
-    custom_method :list_payment_methods, http_verb: :get, http_path: "payment_methods"
-
-    nested_resource_class_methods :cash_balance,
-                                  operations: %i[retrieve update],
-                                  resource_plural: "cash_balance"
     nested_resource_class_methods :balance_transaction,
                                   operations: %i[create retrieve update list]
     nested_resource_class_methods :tax_id,
@@ -26,7 +20,7 @@ module Stripe
     def create_funding_instructions(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/funding_instructions",
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -35,7 +29,7 @@ module Stripe
     def list_payment_methods(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/payment_methods",
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -50,19 +44,36 @@ module Stripe
       )
     end
 
+    def self.create_funding_instructions(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_payment_methods(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.retrieve_payment_method(
       customer,
       payment_method,
       params = {},
       opts = {}
     )
-      resp, opts = execute_resource_request(
-        :get,
-        format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(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
       )
-      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     custom_method :delete_discount, http_verb: :delete, http_path: "discount"
@@ -83,8 +94,11 @@ module Stripe
     # so you must call `refresh` on it to get a new version with the
     # discount removed.
     def delete_discount
-      resp, opts = execute_resource_request(:delete, resource_url + "/discount")
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :delete,
+        path: resource_url + "/discount",
+        params: {}
+      )
     end
 
     def self.search(params = {}, opts = {})
@@ -94,5 +108,69 @@ module Stripe
     def self.search_auto_paging_each(params = {}, opts = {}, &blk)
       search(params, opts).auto_paging_each(&blk)
     end
+
+    def self.retrieve_cash_balance(
+      customer,
+      opts_or_unused_nested_id = nil,
+      opts = {}
+    )
+      # Support two call patterns for backwards compatibility.
+      # 1. Legacy: (nil unused nested_id, opts)
+      # 2. Fixed pattern: (opts)
+      if !opts_or_unused_nested_id.nil? && opts_or_unused_nested_id.class == Hash && opts.empty?
+        opts = opts_or_unused_nested_id
+      end
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: {},
+        opts: opts
+      )
+    end
+
+    def self.update_cash_balance(
+      customer,
+      unused_nested_id = nil,
+      params = {},
+      opts = {}
+    )
+      # Do not allow passing in a hash as the second argument, as we require a nil for compatibility reasons. We cannot differentiate from a legacy pattern (nil, params) and a modern pattern (nil for params, opts).
+      if !unused_nested_id.nil? && unused_nested_id.class == Hash
+        raise ArgumentError, "update_cash_balance requires the second argument always be nil for legacy reasons."
+      end
+
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def test_helpers
+      TestHelpers.new(self)
+    end
+
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = Customer
+
+      def self.fund_cash_balance(customer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(customer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def fund_cash_balance(params = {}, opts = {})
+        @resource.request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(@resource["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
   end
 end

data/lib/stripe/resources/dispute.rb

@@ -8,12 +8,19 @@ module Stripe
 
     OBJECT_NAME = "dispute"
 
-    custom_method :close, http_verb: :post
-
     def close(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/close",
+        path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.close(dispute, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(dispute) }),
         params: params,
         opts: opts
       )

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

@@ -8,14 +8,10 @@ module Stripe
 
       OBJECT_NAME = "financial_connections.account"
 
-      custom_method :disconnect, http_verb: :post
-      custom_method :list_owners, http_verb: :get, http_path: "owners"
-      custom_method :refresh_account, http_verb: :post, http_path: "refresh"
-
       def disconnect(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/disconnect",
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
@@ -24,7 +20,7 @@ module Stripe
       def list_owners(params = {}, opts = {})
         request_stripe_object(
           method: :get,
-          path: resource_url + "/owners",
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
@@ -33,7 +29,34 @@ module Stripe
       def refresh_account(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/refresh",
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.disconnect(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.list_owners(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.refresh_account(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
           params: params,
           opts: opts
         )

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

@@ -10,13 +10,10 @@ module Stripe
 
       OBJECT_NAME = "identity.verification_session"
 
-      custom_method :cancel, http_verb: :post
-      custom_method :redact, http_verb: :post
-
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/cancel",
+          path: format("/v1/identity/verification_sessions/%<session>s/cancel", { session: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
@@ -25,7 +22,25 @@ module Stripe
       def redact(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/redact",
+          path: format("/v1/identity/verification_sessions/%<session>s/redact", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      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
+
+      def self.redact(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s/redact", { session: CGI.escape(session) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/invoice.rb

@@ -11,16 +11,10 @@ module Stripe
 
     OBJECT_NAME = "invoice"
 
-    custom_method :finalize_invoice, http_verb: :post, http_path: "finalize"
-    custom_method :mark_uncollectible, http_verb: :post
-    custom_method :pay, http_verb: :post
-    custom_method :send_invoice, http_verb: :post, http_path: "send"
-    custom_method :void_invoice, http_verb: :post, http_path: "void"
-
     def finalize_invoice(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/finalize",
+        path: format("/v1/invoices/%<invoice>s/finalize", { invoice: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -29,7 +23,7 @@ module Stripe
     def mark_uncollectible(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/mark_uncollectible",
+        path: format("/v1/invoices/%<invoice>s/mark_uncollectible", { invoice: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -38,7 +32,7 @@ module Stripe
     def pay(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/pay",
+        path: format("/v1/invoices/%<invoice>s/pay", { invoice: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -47,7 +41,7 @@ module Stripe
     def send_invoice(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/send",
+        path: format("/v1/invoices/%<invoice>s/send", { invoice: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -56,20 +50,73 @@ module Stripe
     def void_invoice(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/void",
+        path: format("/v1/invoices/%<invoice>s/void", { invoice: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.finalize_invoice(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/finalize", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.mark_uncollectible(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/mark_uncollectible", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.pay(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/pay", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.send_invoice(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/send", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.void_invoice(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/void", { invoice: CGI.escape(invoice) }),
         params: params,
         opts: opts
       )
     end
 
     def self.upcoming(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/upcoming", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/upcoming",
+        params: params,
+        opts: opts
+      )
     end
 
     def self.list_upcoming_line_items(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/upcoming/lines", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/upcoming/lines",
+        params: params,
+        opts: opts
+      )
     end
 
     def self.search(params = {}, opts = {})

data/lib/stripe/resources/issuing/authorization.rb

@@ -9,13 +9,10 @@ module Stripe
 
       OBJECT_NAME = "issuing.authorization"
 
-      custom_method :approve, http_verb: :post
-      custom_method :decline, http_verb: :post
-
       def approve(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/approve",
+          path: format("/v1/issuing/authorizations/%<authorization>s/approve", { authorization: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
@@ -24,7 +21,25 @@ module Stripe
       def decline(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/decline",
+          path: format("/v1/issuing/authorizations/%<authorization>s/decline", { authorization: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.approve(authorization, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/authorizations/%<authorization>s/approve", { authorization: CGI.escape(authorization) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.decline(authorization, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/authorizations/%<authorization>s/decline", { authorization: CGI.escape(authorization) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/issuing/card.rb

@@ -10,16 +10,103 @@ module Stripe
 
       OBJECT_NAME = "issuing.card"
 
-      custom_method :details, http_verb: :get
-
       def details(params = {}, opts = {})
         request_stripe_object(
           method: :get,
-          path: resource_url + "/details",
+          path: format("/v1/issuing/cards/%<card>s/details", { card: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.details(card, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/issuing/cards/%<card>s/details", { card: CGI.escape(card) }),
           params: params,
           opts: opts
         )
       end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = Card
+
+        def self.deliver_card(card, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/deliver", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.fail_card(card, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/fail", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.return_card(card, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/return", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.ship_card(card, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/ship", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def deliver_card(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/deliver", { card: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def fail_card(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/fail", { card: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def return_card(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/return", { card: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def ship_card(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/ship", { card: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
     end
   end
 end

data/lib/stripe/resources/issuing/dispute.rb

@@ -10,12 +10,19 @@ module Stripe
 
       OBJECT_NAME = "issuing.dispute"
 
-      custom_method :submit, http_verb: :post
-
       def submit(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/submit",
+          path: format("/v1/issuing/disputes/%<dispute>s/submit", { dispute: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.submit(dispute, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/disputes/%<dispute>s/submit", { dispute: CGI.escape(dispute) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/order.rb

@@ -9,15 +9,10 @@ module Stripe
 
     OBJECT_NAME = "order"
 
-    custom_method :cancel, http_verb: :post
-    custom_method :list_line_items, http_verb: :get, http_path: "line_items"
-    custom_method :reopen, http_verb: :post
-    custom_method :submit, http_verb: :post
-
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -26,7 +21,7 @@ module Stripe
     def list_line_items(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/line_items",
+        path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -35,7 +30,7 @@ module Stripe
     def reopen(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/reopen",
+        path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -44,7 +39,43 @@ module Stripe
     def submit(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/submit",
+        path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_line_items(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.reopen(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.submit(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(id) }),
         params: params,
         opts: opts
       )