Class: Stripe::Reporting::ReportRunCreateParams

Inherits:
Stripe::RequestParams show all
Defined in:
lib/stripe/params/reporting/report_run_create_params.rb

Defined Under Namespace

Classes: Parameters

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Stripe::RequestParams

#to_h

Constructor Details

#initialize(expand: nil, parameters: nil, report_type: nil) ⇒ ReportRunCreateParams

Returns a new instance of ReportRunCreateParams.



52
53
54
55
56
 
# File 'lib/stripe/params/reporting/report_run_create_params.rb', line 52

def initialize(expand: nil, parameters: nil, report_type: nil)
  @expand = expand
  @parameters = parameters
  @report_type = report_type
end

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.



46
47
48
 
# File 'lib/stripe/params/reporting/report_run_create_params.rb', line 46

def expand
  @expand
end

#parameters ⇒ Object

Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](stripe.com/docs/reporting/statements/api) documentation.



48
49
50
 
# File 'lib/stripe/params/reporting/report_run_create_params.rb', line 48

def parameters
  @parameters
end

#report_type ⇒ Object

The ID of the [report type](stripe.com/docs/reporting/statements/api#report-types) to run, such as ‘“balance.summary.1”`.



50
51
52
 
# File 'lib/stripe/params/reporting/report_run_create_params.rb', line 50

def report_type
  @report_type
end