ScheduledQueryRun.php
70 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace AmeliaVendor\Stripe\Sigma; |
| 6 | |
| 7 | /** |
| 8 | * If you have <a href="https://stripe.com/docs/sigma/scheduled-queries">scheduled a Sigma query</a>, you'll |
| 9 | * receive a <code>sigma.scheduled_query_run.created</code> webhook each time the query |
| 10 | * runs. The webhook contains a <code>ScheduledQueryRun</code> object, which you can use to |
| 11 | * retrieve the query results. |
| 12 | * |
| 13 | * @property string $id Unique identifier for the object. |
| 14 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 15 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 16 | * @property int $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time. |
| 17 | * @property null|(object{message: string}&\AmeliaVendor\Stripe\StripeObject) $error |
| 18 | * @property null|\AmeliaVendor\Stripe\File $file The file object representing the results of the query. |
| 19 | * @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. |
| 20 | * @property int $result_available_until Time at which the result expires and is no longer available for download. |
| 21 | * @property string $sql SQL for the query. |
| 22 | * @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. |
| 23 | * @property string $title Title of the query. |
| 24 | */ |
| 25 | class ScheduledQueryRun extends \AmeliaVendor\Stripe\ApiResource |
| 26 | { |
| 27 | const OBJECT_NAME = 'scheduled_query_run'; |
| 28 | |
| 29 | /** |
| 30 | * Returns a list of scheduled query runs. |
| 31 | * |
| 32 | * @param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params |
| 33 | * @param null|array|string $opts |
| 34 | * |
| 35 | * @return \AmeliaVendor\Stripe\Collection<ScheduledQueryRun> of ApiResources |
| 36 | * |
| 37 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 38 | */ |
| 39 | public static function all($params = null, $opts = null) |
| 40 | { |
| 41 | $url = static::classUrl(); |
| 42 | |
| 43 | return static::_requestPage($url, \AmeliaVendor\Stripe\Collection::class, $params, $opts); |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Retrieves the details of an scheduled query run. |
| 48 | * |
| 49 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 50 | * @param null|array|string $opts |
| 51 | * |
| 52 | * @return ScheduledQueryRun |
| 53 | * |
| 54 | * @throws \AmeliaVendor\Stripe\Exception\ApiErrorException if the request fails |
| 55 | */ |
| 56 | public static function retrieve($id, $opts = null) |
| 57 | { |
| 58 | $opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts); |
| 59 | $instance = new static($id, $opts); |
| 60 | $instance->refresh(); |
| 61 | |
| 62 | return $instance; |
| 63 | } |
| 64 | |
| 65 | public static function classUrl() |
| 66 | { |
| 67 | return '/v1/sigma/scheduled_query_runs'; |
| 68 | } |
| 69 | } |
| 70 |