| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe\Reporting; |
| 6 |
|
| 7 |
/** |
| 8 |
* The Report Run object represents an instance of a report type generated with |
| 9 |
* specific run parameters. Once the object is created, Stripe begins processing |
| 10 |
* the report. When the report has finished running, it will give you a reference |
| 11 |
* to a file where you can retrieve your results. For an overview, see <a |
| 12 |
* href="https://stripe.com/docs/reporting/statements/api">API Access to |
| 13 |
* Reports</a>. |
| 14 |
* |
| 15 |
* Note that certain report types can only be run based on your live-mode data (not |
| 16 |
* test-mode data), and will error when queried without a <a |
| 17 |
* href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>. |
| 18 |
* |
| 19 |
* @property string $id Unique identifier for the object. |
| 20 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 21 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 22 |
* @property null|string $error If something should go wrong during the run, a message about the failure (populated when <code>status=failed</code>). |
| 23 |
* @property bool $livemode <code>true</code> if the report is run on live mode data and <code>false</code> if it is run on test mode data. |
| 24 |
* @property \Stripe\StripeObject $parameters |
| 25 |
* @property string $report_type The ID of the <a href="https://stripe.com/docs/reports/report-types">report type</a> to run, such as <code>"balance.summary.1"</code>. |
| 26 |
* @property null|\Stripe\File $result The file object representing the result of the report run (populated when <code>status=succeeded</code>). |
| 27 |
* @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. |
| 28 |
* @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. |
| 29 |
*/ |
| 30 |
class ReportRun extends \Stripe\ApiResource |
| 31 |
{ |
| 32 |
const OBJECT_NAME = 'reporting.report_run'; |
| 33 |
|
| 34 |
use \Stripe\ApiOperations\All; |
| 35 |
use \Stripe\ApiOperations\Create; |
| 36 |
use \Stripe\ApiOperations\Retrieve; |
| 37 |
} |
| 38 |
|
