Class: Stripe::Reporting::ReportRunService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/reporting/report_run_service.rb

Defined Under Namespace

Classes: CreateParams, 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

#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).)



114
115
116
117
118
119
120
121
122
 
# File 'lib/stripe/services/reporting/report_run_service.rb', line 114

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.



125
126
127
128
129
130
131
132
133
 
# File 'lib/stripe/services/reporting/report_run_service.rb', line 125

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.



136
137
138
139
140
141
142
143
144
 
# File 'lib/stripe/services/reporting/report_run_service.rb', line 136

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