stripe 5.55.0 → 13.5.1

data/lib/stripe/services/test_helpers/issuing/authorization_service.rb

@@ -0,0 +1,87 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Issuing
+      class AuthorizationService < StripeService
+        # Capture a test-mode authorization.
+        def capture(authorization, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/capture", { authorization: CGI.escape(authorization) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Create a test-mode authorization.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v1/test_helpers/issuing/authorizations",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Expire a test-mode Authorization.
+        def expire(authorization, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/expire", { authorization: CGI.escape(authorization) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
+        def finalize_amount(authorization, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/finalize_amount", { authorization: CGI.escape(authorization) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Increment a test-mode Authorization.
+        def increment(authorization, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/increment", { authorization: CGI.escape(authorization) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.
+        def respond(authorization, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/fraud_challenges/respond", { authorization: CGI.escape(authorization) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Reverse a test-mode Authorization.
+        def reverse(authorization, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/reverse", { authorization: CGI.escape(authorization) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers/issuing/card_service.rb

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Issuing
+      class CardService < StripeService
+        # Updates the shipping status of the specified Issuing Card object to delivered.
+        def deliver_card(card, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/deliver", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Updates the shipping status of the specified Issuing Card object to failure.
+        def fail_card(card, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/fail", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Updates the shipping status of the specified Issuing Card object to returned.
+        def return_card(card, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/return", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Updates the shipping status of the specified Issuing Card object to shipped.
+        def ship_card(card, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/ship", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia' or later.
+        def submit_card(card, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/submit", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Issuing
+      class PersonalizationDesignService < StripeService
+        # Updates the status of the specified testmode personalization design object to active.
+        def activate(personalization_design, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/activate", { personalization_design: CGI.escape(personalization_design) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Updates the status of the specified testmode personalization design object to inactive.
+        def deactivate(personalization_design, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/deactivate", { personalization_design: CGI.escape(personalization_design) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Updates the status of the specified testmode personalization design object to rejected.
+        def reject(personalization_design, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/personalization_designs/%<personalization_design>s/reject", { personalization_design: CGI.escape(personalization_design) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers/issuing/transaction_service.rb

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Issuing
+      class TransactionService < StripeService
+        # Allows the user to capture an arbitrary amount, also known as a forced capture.
+        def create_force_capture(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v1/test_helpers/issuing/transactions/create_force_capture",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Allows the user to refund an arbitrary amount, also known as a unlinked refund.
+        def create_unlinked_refund(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v1/test_helpers/issuing/transactions/create_unlinked_refund",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Refund a test-mode Transaction.
+        def refund(transaction, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/transactions/%<transaction>s/refund", { transaction: CGI.escape(transaction) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class IssuingService < StripeService
+      attr_reader :authorizations, :cards, :personalization_designs, :transactions
+
+      def initialize(requestor)
+        super(requestor)
+        @authorizations = Stripe::TestHelpers::Issuing::AuthorizationService.new(@requestor)
+        @cards = Stripe::TestHelpers::Issuing::CardService.new(@requestor)
+        @personalization_designs = Stripe::TestHelpers::Issuing::PersonalizationDesignService
+                                   .new(@requestor)
+        @transactions = Stripe::TestHelpers::Issuing::TransactionService.new(@requestor)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class RefundService < StripeService
+      # Expire a refund with a status of requires_action.
+      def expire(refund, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/test_helpers/refunds/%<refund>s/expire", { refund: CGI.escape(refund) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/test_helpers/terminal/reader_service.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Terminal
+      class ReaderService < StripeService
+        # 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(reader, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/present_payment_method", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class TerminalService < StripeService
+      attr_reader :readers
+
+      def initialize(requestor)
+        super(requestor)
+        @readers = Stripe::TestHelpers::Terminal::ReaderService.new(@requestor)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class TestClockService < StripeService
+      # Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
+      def advance(test_clock, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s/advance", { test_clock: CGI.escape(test_clock) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a new test clock that can be attached to new customers and quotes.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/test_helpers/test_clocks",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deletes a test clock.
+      def delete(test_clock, params = {}, opts = {})
+        request(
+          method: :delete,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s", { test_clock: CGI.escape(test_clock) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of your test clocks.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/test_helpers/test_clocks",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a test clock.
+      def retrieve(test_clock, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s", { test_clock: CGI.escape(test_clock) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Treasury
+      class InboundTransferService < StripeService
+        # Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
+        def fail(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/fail", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
+        def return_inbound_transfer(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/return", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
+        def succeed(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/succeed", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

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

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 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 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