0byt3m1n1
Path:
/
home
/
kassiope
/
www
/
vendor
/
stripe
/
stripe-php
/
lib
/
Reporting
/
[
Home
]
File: ReportRun.php
<?php namespace Stripe\Reporting; /** * 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 <a * href="https://stripe.com/docs/reporting/statements/api">API Access to * Reports</a>. * * Note that reports can only be run based on your live-mode data (not test-mode * data), and thus related requests must be made with a <a * href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $error If something should go wrong during the run, a message about the failure (populated when <code>status=failed</code>). * @property bool $livemode Always <code>true</code>: reports can only be run on live-mode data. * @property \Stripe\StripeObject $parameters * @property string $report_type The ID of the <a href="https://stripe.com/docs/reporting/statements/api#report-types">report type</a> to run, such as <code>"balance.summary.1"</code>. * @property null|\Stripe\File $result The file object representing the result of the report run (populated when <code>status=succeeded</code>). * @property string $status Status of this report run. This will be <code>pending</code> when the run is initially created. When the run finishes, this will be set to <code>succeeded</code> and the <code>result</code> field will be populated. Rarely, we may encounter an error, at which point this will be set to <code>failed</code> and the <code>error</code> field will be populated. * @property null|int $succeeded_at Timestamp at which this run successfully finished (populated when <code>status=succeeded</code>). Measured in seconds since the Unix epoch. */ class ReportRun extends \Stripe\ApiResource { const OBJECT_NAME = 'reporting.report_run'; use \Stripe\ApiOperations\All; use \Stripe\ApiOperations\Create; use \Stripe\ApiOperations\Retrieve; }