Class: Stripe::TestHelpers::TestClockService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/test_helpers/test_clock_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#advance(test_clock, params = {}, opts = {}) ⇒ Object

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.



8
9
10
11
12
13
14
15
16
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 8

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

#create(params = {}, opts = {}) ⇒ Object

Creates a new test clock that can be attached to new customers and quotes.



19
20
21
22
23
24
25
26
27
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 19

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/test_helpers/test_clocks",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#delete(test_clock, params = {}, opts = {}) ⇒ Object

Deletes a test clock.



30
31
32
33
34
35
36
37
38
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 30

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

#list(params = {}, opts = {}) ⇒ Object

Returns a list of your test clocks.



41
42
43
44
45
46
47
48
49
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 41

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/test_helpers/test_clocks",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(test_clock, params = {}, opts = {}) ⇒ Object

Retrieves a test clock.



52
53
54
55
56
57
58
59
60
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 52

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