stripe-ruby/lib/stripe/services/test_helpers/test_clock_service.rb

# 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