class Stripe::ReportingReportRun

• Stripe::ReportingReportRun
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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

Instance Method Summary

• #==(other : self)

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

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #error : String | Nil
• #error=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #parameters : Stripe::FinancialReportingFinanceReportRunRunParameters | Nil
• #parameters=(new_value : Stripe::FinancialReportingFinanceReportRunRunParameters | Nil)

  Custom attribute writer method checking allowed values (enum).

• #report_type : String | Nil
• #report_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #result : Stripe::ReportingReportRunResult | Nil
• #result=(new_value : Stripe::ReportingReportRunResult | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : String | Nil
• #status=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #succeeded_at : Int64 | Nil
• #succeeded_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail