Class: Stripe::Billing::AlertService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/billing/alert_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

#activate(id, params = {}, opts = {}) ⇒ Object

Reactivates this alert, allowing it to trigger again.



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

def activate(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#archive(id, params = {}, opts = {}) ⇒ Object

Archives this alert, removing it from the list view and APIs. This is non-reversible.



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

def archive(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Creates a billing alert



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/stripe/services/billing/alert_service.rb', line 30

def create(params = {}, opts = {})
  params = Billing::AlertCreateParams.coerce_params(params) unless params.is_a?(Stripe::RequestParams)

  request(
    method: :post,
    path: "/v1/billing/alerts",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#deactivate(id, params = {}, opts = {}) ⇒ Object

Deactivates this alert, preventing it from triggering.



43
44
45
46
47
48
49
50
51
 
# File 'lib/stripe/services/billing/alert_service.rb', line 43

def deactivate(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Lists billing active and inactive alerts



54
55
56
57
58
59
60
61
62
 
# File 'lib/stripe/services/billing/alert_service.rb', line 54

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

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

Retrieves a billing alert given an ID



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

def retrieve(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/billing/alerts/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end