stripe 5.55.0 → 13.5.1

data/lib/stripe/resources/terminal/reader.rb

@@ -3,6 +3,9 @@
 
 module Stripe
   module Terminal
+    # A Reader represents a physical device for accepting payment details.
+    #
+    # Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)
     class Reader < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete
@@ -10,43 +13,155 @@ module Stripe
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "terminal.reader"
+      def self.object_name
+        "terminal.reader"
+      end
 
-      custom_method :cancel_action, http_verb: :post
-      custom_method :process_payment_intent, http_verb: :post
-      custom_method :process_setup_intent, http_verb: :post
-      custom_method :set_reader_display, http_verb: :post
-
+      # Cancels the current reader action.
       def cancel_action(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/cancel_action",
+          path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
+      # Cancels the current reader action.
+      def self.cancel_action(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a new Reader object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/terminal/readers",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a Reader object.
+      def self.delete(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a Reader object.
+      def delete(params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of Reader objects.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/terminal/readers",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a payment flow on a Reader.
       def process_payment_intent(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/process_payment_intent",
+          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a payment flow on a Reader.
+      def self.process_payment_intent(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(reader) }),
           params: params,
           opts: opts
         )
       end
 
+      # Initiates a setup intent flow on a Reader.
       def process_setup_intent(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/process_setup_intent",
+          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
+      # Initiates a setup intent flow on a Reader.
+      def self.process_setup_intent(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a refund on a Reader
+      def refund_payment(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a refund on a Reader
+      def self.refund_payment(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Sets reader display to show cart details.
       def set_reader_display(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/set_reader_display",
+          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Sets reader display to show cart details.
+      def self.set_reader_display(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+      def self.update(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
           params: params,
           opts: opts
         )
@@ -58,13 +173,25 @@ module Stripe
 
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = Reader
+        def self.resource_class
+          "Reader"
+        end
 
-        custom_method :present_payment_method, http_verb: :post
+        # Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
+        def self.present_payment_method(reader, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/present_payment_method", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts
+          )
+        end
 
+        # Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
         def present_payment_method(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
-            path: resource_url + "/present_payment_method",
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/present_payment_method", { reader: CGI.escape(@resource["id"]) }),
             params: params,
             opts: opts
           )

data/lib/stripe/resources/test_helpers/test_clock.rb

@@ -3,19 +3,74 @@
 
 module Stripe
   module TestHelpers
+    # A test clock enables deterministic control over objects in testmode. With a test clock, you can create
+    # objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,
+    # you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
     class TestClock < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "test_helpers.test_clock"
+      def self.object_name
+        "test_helpers.test_clock"
+      end
 
-      custom_method :advance, http_verb: :post
-
+      # Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
       def advance(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/advance",
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s/advance", { test_clock: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
+      def self.advance(test_clock, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s/advance", { test_clock: CGI.escape(test_clock) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a new test clock that can be attached to new customers and quotes.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/test_helpers/test_clocks",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a test clock.
+      def self.delete(test_clock, params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s", { test_clock: CGI.escape(test_clock) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a test clock.
+      def delete(params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s", { test_clock: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of your test clocks.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/test_helpers/test_clocks",
           params: params,
           opts: opts
         )

data/lib/stripe/resources/token.rb

@@ -2,9 +2,38 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Tokenization is the process Stripe uses to collect sensitive card or bank
+  # account details, or personally identifiable information (PII), directly from
+  # your customers in a secure manner. A token representing this information is
+  # returned to your server to use. Use our
+  # [recommended payments integrations](https://stripe.com/docs/payments) to perform this process
+  # on the client-side. This guarantees that no sensitive card data touches your server,
+  # and allows your integration to operate in a PCI-compliant way.
+  #
+  # If you can't use client-side tokenization, you can also create tokens using
+  # the API with either your publishable or secret API key. If
+  # your integration uses this method, you're responsible for any PCI compliance
+  # that it might require, and you must keep your secret API key safe. Unlike with
+  # client-side tokenization, your customer's information isn't sent directly to
+  # Stripe, so we can't determine how it's handled or stored.
+  #
+  # 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 [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
     extend Stripe::APIOperations::Create
 
     OBJECT_NAME = "token"
+    def self.object_name
+      "token"
+    end
+
+    # Creates a single-use token that represents a bank account's details.
+    # You can use this token with any v1 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
   end
 end

data/lib/stripe/resources/topup.rb

@@ -2,19 +2,56 @@
 # frozen_string_literal: true
 
 module Stripe
+  # To top up your Stripe balance, you create a top-up object. You can retrieve
+  # individual top-ups, as well as list all top-ups. Top-ups are identified by a
+  # unique, random ID.
+  #
+  # Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)
   class Topup < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "topup"
+    def self.object_name
+      "topup"
+    end
 
-    custom_method :cancel, http_verb: :post
-
+    # Cancels a top-up. Only pending top-ups can be canceled.
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Cancels a top-up. Only pending top-ups can be canceled.
+    def self.cancel(topup, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(topup) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Top up the balance of an account
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/topups", params: params, opts: opts)
+    end
+
+    # Returns a list of top-ups.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/topups", params: params, opts: opts)
+    end
+
+    # Updates the metadata of a top-up. Other top-up details are not editable by design.
+    def self.update(topup, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/topups/%<topup>s", { topup: CGI.escape(topup) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/transfer.rb

@@ -2,23 +2,46 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A `Transfer` object is created when you move funds between Stripe accounts as
+  # part of Connect.
+  #
+  # Before April 6, 2017, transfers also represented movement of funds from a
+  # Stripe account to a card or bank account. This behavior has since been split
+  # out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more
+  # information, read about the
+  # [transfer/payout split](https://stripe.com/docs/transfer-payout-split).
+  #
+  # Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)
   class Transfer < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::NestedResource
+    include Stripe::APIOperations::Save
 
     OBJECT_NAME = "transfer"
+    def self.object_name
+      "transfer"
+    end
 
-    custom_method :cancel, http_verb: :post
+    nested_resource_class_methods :reversal, operations: %i[create retrieve update list]
 
-    nested_resource_class_methods :reversal,
-                                  operations: %i[create retrieve update list]
+    # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/transfers", params: params, opts: opts)
+    end
+
+    # Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/transfers", params: params, opts: opts)
+    end
 
-    def cancel(params = {}, opts = {})
+    # Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    #
+    # This request accepts only metadata as an argument.
+    def self.update(transfer, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/transfers/%<transfer>s", { transfer: CGI.escape(transfer) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/treasury/credit_reversal.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
+    class CreditReversal < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.credit_reversal"
+      def self.object_name
+        "treasury.credit_reversal"
+      end
+
+      # Reverses a ReceivedCredit and creates a CreditReversal object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/treasury/credit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of CreditReversals.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/treasury/credit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/debit_reversal.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
+    class DebitReversal < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.debit_reversal"
+      def self.object_name
+        "treasury.debit_reversal"
+      end
+
+      # Reverses a ReceivedDebit and creates a DebitReversal object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/treasury/debit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of DebitReversals.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/treasury/debit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/financial_account.rb

@@ -0,0 +1,109 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.
+    # FinancialAccounts serve as the source and destination of Treasury's money movement APIs.
+    class FinancialAccount < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "treasury.financial_account"
+      def self.object_name
+        "treasury.financial_account"
+      end
+
+      # Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
+      def close(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/close", { financial_account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
+      def self.close(financial_account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/close", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/treasury/financial_accounts",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of FinancialAccounts.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/treasury/financial_accounts",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieves Features information associated with the FinancialAccount.
+      def retrieve_features(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieves Features information associated with the FinancialAccount.
+      def self.retrieve_features(financial_account, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates the details of a FinancialAccount.
+      def self.update(financial_account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates the Features associated with a FinancialAccount.
+      def update_features(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates the Features associated with a FinancialAccount.
+      def self.update_features(financial_account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/financial_account_features.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
+    # Stripe or the platform can control Features via the requested field.
+    class FinancialAccountFeatures < APIResource
+      OBJECT_NAME = "treasury.financial_account_features"
+      def self.object_name
+        "treasury.financial_account_features"
+      end
+    end
+  end
+end