| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869 |
- <?php
- // File generated from our OpenAPI spec
- namespace Stripe\Sigma;
- /**
- * If you have <a href="https://stripe.com/docs/sigma/scheduled-queries">scheduled a Sigma query</a>, you'll
- * receive a <code>sigma.scheduled_query_run.created</code> webhook each time the query
- * runs. The webhook contains a <code>ScheduledQueryRun</code> object, which you can use to
- * retrieve the query results.
- *
- * @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 int $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time.
- * @property null|\Stripe\StripeObject $error
- * @property null|\Stripe\File $file The file object representing the results of the query.
- * @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.
- * @property int $result_available_until Time at which the result expires and is no longer available for download.
- * @property string $sql SQL for the query.
- * @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.
- * @property string $title Title of the query.
- */
- class ScheduledQueryRun extends \Stripe\ApiResource
- {
- const OBJECT_NAME = 'scheduled_query_run';
- /**
- * Returns a list of scheduled query runs.
- *
- * @param null|array $params
- * @param null|array|string $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection<\Stripe\Sigma\ScheduledQueryRun> of ApiResources
- */
- public static function all($params = null, $opts = null)
- {
- $url = static::classUrl();
- return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
- }
- /**
- * Retrieves the details of an scheduled query run.
- *
- * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
- * @param null|array|string $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Sigma\ScheduledQueryRun
- */
- public static function retrieve($id, $opts = null)
- {
- $opts = \Stripe\Util\RequestOptions::parse($opts);
- $instance = new static($id, $opts);
- $instance->refresh();
- return $instance;
- }
- public static function classUrl()
- {
- return '/v1/sigma/scheduled_query_runs';
- }
- }
|