stripe 5.38.0 → 15.2.1

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

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class RefundService < StripeService
+      class ExpireParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # 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,108 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Terminal
+      class ReaderService < StripeService
+        class PresentPaymentMethodParams < Stripe::RequestParams
+          class CardPresent < Stripe::RequestParams
+            # The card number, as a string without any separators.
+            attr_accessor :number
+
+            def initialize(number: nil)
+              @number = number
+            end
+          end
+
+          class InteracPresent < Stripe::RequestParams
+            # Card Number
+            attr_accessor :number
+
+            def initialize(number: nil)
+              @number = number
+            end
+          end
+          # Simulated on-reader tip amount.
+          attr_accessor :amount_tip
+          # Simulated data for the card_present payment method.
+          attr_accessor :card_present
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # Simulated data for the interac_present payment method.
+          attr_accessor :interac_present
+          # Simulated payment type.
+          attr_accessor :type
+
+          def initialize(
+            amount_tip: nil,
+            card_present: nil,
+            expand: nil,
+            interac_present: nil,
+            type: nil
+          )
+            @amount_tip = amount_tip
+            @card_present = card_present
+            @expand = expand
+            @interac_present = interac_present
+            @type = type
+          end
+        end
+
+        class SucceedInputCollectionParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # This parameter defines the skip behavior for input collection.
+          attr_accessor :skip_non_required_inputs
+
+          def initialize(expand: nil, skip_non_required_inputs: nil)
+            @expand = expand
+            @skip_non_required_inputs = skip_non_required_inputs
+          end
+        end
+
+        class TimeoutInputCollectionParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        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(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
+
+        # Use this endpoint to trigger a successful input collection on a simulated reader.
+        def succeed_input_collection(reader, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/succeed_input_collection", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Use this endpoint to complete an input collection with a timeout error on a simulated reader.
+        def timeout_input_collection(reader, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/timeout_input_collection", { 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
+        @readers = Stripe::TestHelpers::Terminal::ReaderService.new(@requestor)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class TestClockService < StripeService
+      class DeleteParams < Stripe::RequestParams; end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The initial frozen time for this test clock.
+        attr_accessor :frozen_time
+        # The name for this test clock.
+        attr_accessor :name
+
+        def initialize(expand: nil, frozen_time: nil, name: nil)
+          @expand = expand
+          @frozen_time = frozen_time
+          @name = name
+        end
+      end
+
+      class AdvanceParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.
+        attr_accessor :frozen_time
+
+        def initialize(expand: nil, frozen_time: nil)
+          @expand = expand
+          @frozen_time = frozen_time
+        end
+      end
+
+      # 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,81 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Treasury
+      class InboundTransferService < StripeService
+        class FailParams < Stripe::RequestParams
+          class FailureDetails < Stripe::RequestParams
+            # Reason for the failure.
+            attr_accessor :code
+
+            def initialize(code: nil)
+              @code = code
+            end
+          end
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # Details about a failed InboundTransfer.
+          attr_accessor :failure_details
+
+          def initialize(expand: nil, failure_details: nil)
+            @expand = expand
+            @failure_details = failure_details
+          end
+        end
+
+        class ReturnInboundTransferParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        end
+
+        class SucceedParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        end
+
+        # 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,141 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Treasury
+      class OutboundPaymentService < StripeService
+        class UpdateParams < Stripe::RequestParams
+          class TrackingDetails < Stripe::RequestParams
+            class Ach < Stripe::RequestParams
+              # ACH trace ID for funds sent over the `ach` network.
+              attr_accessor :trace_id
+
+              def initialize(trace_id: nil)
+                @trace_id = trace_id
+              end
+            end
+
+            class UsDomesticWire < Stripe::RequestParams
+              # CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
+              attr_accessor :chips
+              # IMAD for funds sent over the `us_domestic_wire` network.
+              attr_accessor :imad
+              # OMAD for funds sent over the `us_domestic_wire` network.
+              attr_accessor :omad
+
+              def initialize(chips: nil, imad: nil, omad: nil)
+                @chips = chips
+                @imad = imad
+                @omad = omad
+              end
+            end
+            # ACH network tracking details.
+            attr_accessor :ach
+            # The US bank account network used to send funds.
+            attr_accessor :type
+            # US domestic wire network tracking details.
+            attr_accessor :us_domestic_wire
+
+            def initialize(ach: nil, type: nil, us_domestic_wire: nil)
+              @ach = ach
+              @type = type
+              @us_domestic_wire = us_domestic_wire
+            end
+          end
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # Details about network-specific tracking information.
+          attr_accessor :tracking_details
+
+          def initialize(expand: nil, tracking_details: nil)
+            @expand = expand
+            @tracking_details = tracking_details
+          end
+        end
+
+        class FailParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        end
+
+        class PostParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        end
+
+        class ReturnOutboundPaymentParams < Stripe::RequestParams
+          class ReturnedDetails < Stripe::RequestParams
+            # The return code to be set on the OutboundPayment object.
+            attr_accessor :code
+
+            def initialize(code: nil)
+              @code = code
+            end
+          end
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # Optional hash to set the return code.
+          attr_accessor :returned_details
+
+          def initialize(expand: nil, returned_details: nil)
+            @expand = expand
+            @returned_details = returned_details
+          end
+        end
+
+        # 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,141 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    module Treasury
+      class OutboundTransferService < StripeService
+        class UpdateParams < Stripe::RequestParams
+          class TrackingDetails < Stripe::RequestParams
+            class Ach < Stripe::RequestParams
+              # ACH trace ID for funds sent over the `ach` network.
+              attr_accessor :trace_id
+
+              def initialize(trace_id: nil)
+                @trace_id = trace_id
+              end
+            end
+
+            class UsDomesticWire < Stripe::RequestParams
+              # CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
+              attr_accessor :chips
+              # IMAD for funds sent over the `us_domestic_wire` network.
+              attr_accessor :imad
+              # OMAD for funds sent over the `us_domestic_wire` network.
+              attr_accessor :omad
+
+              def initialize(chips: nil, imad: nil, omad: nil)
+                @chips = chips
+                @imad = imad
+                @omad = omad
+              end
+            end
+            # ACH network tracking details.
+            attr_accessor :ach
+            # The US bank account network used to send funds.
+            attr_accessor :type
+            # US domestic wire network tracking details.
+            attr_accessor :us_domestic_wire
+
+            def initialize(ach: nil, type: nil, us_domestic_wire: nil)
+              @ach = ach
+              @type = type
+              @us_domestic_wire = us_domestic_wire
+            end
+          end
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # Details about network-specific tracking information.
+          attr_accessor :tracking_details
+
+          def initialize(expand: nil, tracking_details: nil)
+            @expand = expand
+            @tracking_details = tracking_details
+          end
+        end
+
+        class FailParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        end
+
+        class PostParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        end
+
+        class ReturnOutboundTransferParams < Stripe::RequestParams
+          class ReturnedDetails < Stripe::RequestParams
+            # Reason for the return.
+            attr_accessor :code
+
+            def initialize(code: nil)
+              @code = code
+            end
+          end
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # Details about a returned OutboundTransfer.
+          attr_accessor :returned_details
+
+          def initialize(expand: nil, returned_details: nil)
+            @expand = expand
+            @returned_details = returned_details
+          end
+        end
+
+        # 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