ScheduledQueryRun.php 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe\Sigma;
  4. /**
  5. * If you have <a href="https://stripe.com/docs/sigma/scheduled-queries">scheduled
  6. * a Sigma query</a>, you'll receive a
  7. * <code>sigma.scheduled_query_run.created</code> webhook each time the query runs.
  8. * The webhook contains a <code>ScheduledQueryRun</code> object, which you can use
  9. * to retrieve the query results.
  10. *
  11. * @property string $id Unique identifier for the object.
  12. * @property string $object String representing the object's type. Objects of the same type share the same value.
  13. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  14. * @property int $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time.
  15. * @property \Stripe\StripeObject $error
  16. * @property null|\Stripe\File $file The file object representing the results of the query.
  17. * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  18. * @property int $result_available_until Time at which the result expires and is no longer available for download.
  19. * @property string $sql SQL for the query.
  20. * @property string $status The query's execution status, which will be <code>completed</code> for successful runs, and <code>canceled</code>, <code>failed</code>, or <code>timed_out</code> otherwise.
  21. * @property string $title Title of the query.
  22. */
  23. class ScheduledQueryRun extends \Stripe\ApiResource
  24. {
  25. const OBJECT_NAME = 'scheduled_query_run';
  26. use \Stripe\ApiOperations\All;
  27. use \Stripe\ApiOperations\Retrieve;
  28. public static function classUrl()
  29. {
  30. return '/v1/sigma/scheduled_query_runs';
  31. }
  32. }