stripe 12.7.0.pre.beta.1 → 13.0.0

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

@@ -0,0 +1,118 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderService < StripeService
+      # Cancels the current reader action.
+      def cancel_action(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a new Reader object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/terminal/readers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deletes a Reader object.
+      def delete(reader, params = {}, opts = {})
+        request(
+          method: :delete,
+          path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of Reader objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/terminal/readers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Initiates a payment flow on a Reader.
+      def process_payment_intent(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Initiates a setup intent flow on a Reader.
+      def process_setup_intent(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Initiates a refund on a Reader
+      def refund_payment(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a Reader object.
+      def retrieve(reader, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Sets reader display to show cart details.
+      def set_reader_display(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+      def update(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/terminal_service.rb

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

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class ConfirmationTokenService < StripeService
+      # Creates a test mode Confirmation Token server side for your integration tests.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/test_helpers/confirmation_tokens",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class CustomerService < StripeService
+      # Create an incoming testmode bank transfer
+      def fund_cash_balance(customer, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(customer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# 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
+
+        # 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,54 @@
+# 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
+      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