Class: Stripe::TestHelpers::TestClockService

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

Defined Under Namespace

Classes: AdvanceParams, CreateParams, DeleteParams, ListParams, RetrieveParams

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.



65
66
67
68
69
70
71
72
73
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 65

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.



76
77
78
79
80
81
82
83
84
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 76

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.



87
88
89
90
91
92
93
94
95
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 87

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.



98
99
100
101
102
103
104
105
106
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 98

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.



109
110
111
112
113
114
115
116
117
 
# File 'lib/stripe/services/test_helpers/test_clock_service.rb', line 109

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