stripe 12.7.0.pre.beta.2 → 13.0.0

data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Treasury
+      class OutboundTransferService < StripeService
+        # Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
+        def fail(outbound_transfer, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/fail", { outbound_transfer: CGI.escape(outbound_transfer) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
+        def post(outbound_transfer, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/post", { outbound_transfer: CGI.escape(outbound_transfer) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
+        def return_outbound_transfer(outbound_transfer, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/return", { outbound_transfer: CGI.escape(outbound_transfer) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
+        def update(outbound_transfer, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s", { outbound_transfer: CGI.escape(outbound_transfer) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Treasury
+      class ReceivedCreditService < StripeService
+        # Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_credits",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Treasury
+      class ReceivedDebitService < StripeService
+        # Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can't directly create ReceivedDebits initiated by third parties.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_debits",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers/treasury_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class TreasuryService < StripeService
+      attr_reader :inbound_transfers, :outbound_payments, :outbound_transfers, :received_credits, :received_debits
+
+      def initialize(requestor)
+        super(requestor)
+        @inbound_transfers = Stripe::TestHelpers::Treasury::InboundTransferService.new(@requestor)
+        @outbound_payments = Stripe::TestHelpers::Treasury::OutboundPaymentService.new(@requestor)
+        @outbound_transfers = Stripe::TestHelpers::Treasury::OutboundTransferService.new(@requestor)
+        @received_credits = Stripe::TestHelpers::Treasury::ReceivedCreditService.new(@requestor)
+        @received_debits = Stripe::TestHelpers::Treasury::ReceivedDebitService.new(@requestor)
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TestHelpersService < StripeService
+    attr_reader :confirmation_tokens, :customers, :issuing, :refunds, :terminal, :test_clocks, :treasury
+
+    def initialize(requestor)
+      super(requestor)
+      @confirmation_tokens = Stripe::TestHelpers::ConfirmationTokenService.new(@requestor)
+      @customers = Stripe::TestHelpers::CustomerService.new(@requestor)
+      @issuing = Stripe::TestHelpers::IssuingService.new(@requestor)
+      @refunds = Stripe::TestHelpers::RefundService.new(@requestor)
+      @terminal = Stripe::TestHelpers::TerminalService.new(@requestor)
+      @test_clocks = Stripe::TestHelpers::TestClockService.new(@requestor)
+      @treasury = Stripe::TestHelpers::TreasuryService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/token_service.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TokenService < StripeService
+    # Creates a single-use token that represents a bank account's details.
+    # You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [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 create(params = {}, opts = {})
+      request(method: :post, path: "/v1/tokens", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the token with the given ID.
+    def retrieve(token, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/tokens/%<token>s", { token: CGI.escape(token) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/topup_service.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TopupService < StripeService
+    # Cancels a top-up. Only pending top-ups can be canceled.
+    def cancel(topup, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(topup) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Top up the balance of an account
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/topups", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of top-ups.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/topups", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
+    def retrieve(topup, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/topups/%<topup>s", { topup: CGI.escape(topup) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the metadata of a top-up. Other top-up details are not editable by design.
+    def update(topup, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/topups/%<topup>s", { topup: CGI.escape(topup) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/transfer_reversal_service.rb

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferReversalService < StripeService
+    # When you create a new reversal, you must specify a transfer to create it on.
+    #
+    # When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.
+    #
+    # Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.
+    def create(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/transfers/%<id>s/reversals", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.
+    def list(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/transfers/%<id>s/reversals", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
+    def retrieve(transfer, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/transfers/%<transfer>s/reversals/%<id>s", { transfer: CGI.escape(transfer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    #
+    # This request only accepts metadata and description as arguments.
+    def update(transfer, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/transfers/%<transfer>s/reversals/%<id>s", { transfer: CGI.escape(transfer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/transfer_service.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TransferService < StripeService
+    attr_reader :reversals
+
+    def initialize(requestor)
+      super(requestor)
+      @reversals = Stripe::TransferReversalService.new(@requestor)
+    end
+
+    # 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 create(params = {}, opts = {})
+      request(method: :post, path: "/v1/transfers", params: params, opts: opts, base_address: :api)
+    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 list(params = {}, opts = {})
+      request(method: :get, path: "/v1/transfers", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
+    def retrieve(transfer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/transfers/%<transfer>s", { transfer: CGI.escape(transfer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # 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 update(transfer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/transfers/%<transfer>s", { transfer: CGI.escape(transfer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/treasury/credit_reversal_service.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class CreditReversalService < StripeService
+      # Reverses a ReceivedCredit and creates a CreditReversal object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/treasury/credit_reversals",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of CreditReversals.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/credit_reversals",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list
+      def retrieve(credit_reversal, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/credit_reversals/%<credit_reversal>s", { credit_reversal: CGI.escape(credit_reversal) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/debit_reversal_service.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class DebitReversalService < StripeService
+      # Reverses a ReceivedDebit and creates a DebitReversal object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/treasury/debit_reversals",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of DebitReversals.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/debit_reversals",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a DebitReversal object.
+      def retrieve(debit_reversal, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/debit_reversals/%<debit_reversal>s", { debit_reversal: CGI.escape(debit_reversal) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/financial_account_features_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class FinancialAccountFeaturesService < StripeService
+      # Retrieves Features information associated with the FinancialAccount.
+      def retrieve(financial_account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates the Features associated with a FinancialAccount.
+      def update(financial_account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/financial_account_service.rb

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class FinancialAccountService < StripeService
+      attr_reader :features
+
+      def initialize(requestor)
+        super(requestor)
+        @features = Stripe::Treasury::FinancialAccountFeaturesService.new(@requestor)
+      end
+
+      # Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/treasury/financial_accounts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of FinancialAccounts.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/financial_accounts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a FinancialAccount.
+      def retrieve(financial_account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates the details of a FinancialAccount.
+      def update(financial_account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/inbound_transfer_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferService < StripeService
+      # Cancels an InboundTransfer.
+      def cancel(inbound_transfer, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/treasury/inbound_transfers/%<inbound_transfer>s/cancel", { inbound_transfer: CGI.escape(inbound_transfer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates an InboundTransfer.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/treasury/inbound_transfers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of InboundTransfers sent from the specified FinancialAccount.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/inbound_transfers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an existing InboundTransfer.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/inbound_transfers/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/outbound_payment_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundPaymentService < StripeService
+      # Cancel an OutboundPayment.
+      def cancel(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/treasury/outbound_payments/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates an OutboundPayment.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/treasury/outbound_payments",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of OutboundPayments sent from the specified FinancialAccount.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/outbound_payments",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/outbound_payments/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/outbound_transfer_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundTransferService < StripeService
+      # An OutboundTransfer can be canceled if the funds have not yet been paid out.
+      def cancel(outbound_transfer, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/treasury/outbound_transfers/%<outbound_transfer>s/cancel", { outbound_transfer: CGI.escape(outbound_transfer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates an OutboundTransfer.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/treasury/outbound_transfers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of OutboundTransfers sent from the specified FinancialAccount.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/outbound_transfers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
+      def retrieve(outbound_transfer, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/outbound_transfers/%<outbound_transfer>s", { outbound_transfer: CGI.escape(outbound_transfer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/received_credit_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class ReceivedCreditService < StripeService
+      # Returns a list of ReceivedCredits.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/received_credits",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/received_credits/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end