Class: Stripe::Reporting::ReportTypeService

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

Defined Under Namespace

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

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

Returns a full list of Report Types.



26
27
28
29
30
31
32
33
34
 
# File 'lib/stripe/services/reporting/report_type_service.rb', line 26

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

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

Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](stripe.com/docs/keys#test-live-modes).)



37
38
39
40
41
42
43
44
45
 
# File 'lib/stripe/services/reporting/report_type_service.rb', line 37

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