Class: Stripe::Reporting::ReportRunService

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

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

Creates a new object and begin running the report. (Certain report types require a [live-mode API key](stripe.com/docs/keys#test-live-modes).)



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

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

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

Returns a list of Report Runs, with the most recent appearing first.



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

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

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

Retrieves the details of an existing Report Run.



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

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