class

Stripe::ReportingReportRun

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports. Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [reporting.report_run]."
MAX_LENGTH_FOR_ERROR = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_REPORT_TYPE = 5000
MAX_LENGTH_FOR_STATUS = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("reporting.report_run")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, created : Int64 | Nil = nil, error : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, parameters : Stripe::FinancialReportingFinanceReportRunRunParameters | Nil = nil, report_type : String | Nil = nil, result : Stripe::ReportingReportRunResult | Nil = nil, status : String | Nil = nil, succeeded_at : Int64 | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
error

If something should go wrong during the run, a message about the failure (populated when status=failed).

Source
error=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] error Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

true if the report is run on live mode data and false if it is run on test mode data.

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
parameters
Source
parameters=(new_value : Stripe::FinancialReportingFinanceReportRunRunParameters | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] parameters Object to be assigned

Source
report_type

The ID of the report type to run, such as \"balance.summary.1\".

Source
report_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] report_type Object to be assigned

Source
result
Source
result=(new_value : Stripe::ReportingReportRunResult | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] result Object to be assigned

Source
status

Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
succeeded_at

Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.

Source
succeeded_at=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] succeeded_at Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source