ReportRun.php 2.3 KB

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