ReportRun.php
83 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Reporting; |
| 5 | |
| 6 | /** |
| 7 | * The Report Run object represents an instance of a report type generated with |
| 8 | * specific run parameters. Once the object is created, Stripe begins processing the report. |
| 9 | * When the report has finished running, it will give you a reference to a file |
| 10 | * where you can retrieve your results. For an overview, see |
| 11 | * <a href="https://stripe.com/docs/reporting/statements/api">API Access to Reports</a>. |
| 12 | * |
| 13 | * Note that certain report types can only be run based on your live-mode data (not test-mode |
| 14 | * data), and will error when queried without a <a 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 <code>true</code> if the report is run on live mode data and <code>false</code> if it is run on test 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>"balance.summary.1"</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 \ProfilePressVendor\Stripe\ApiResource |
| 28 | { |
| 29 | const OBJECT_NAME = 'reporting.report_run'; |
| 30 | /** |
| 31 | * Creates a new object and begin running the report. (Certain report types require |
| 32 | * a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.). |
| 33 | * |
| 34 | * @param null|array $params |
| 35 | * @param null|array|string $options |
| 36 | * |
| 37 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 38 | * |
| 39 | * @return \Stripe\Reporting\ReportRun the created resource |
| 40 | */ |
| 41 | public static function create($params = null, $options = null) |
| 42 | { |
| 43 | self::_validateParams($params); |
| 44 | $url = static::classUrl(); |
| 45 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 46 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 47 | $obj->setLastResponse($response); |
| 48 | return $obj; |
| 49 | } |
| 50 | /** |
| 51 | * Returns a list of Report Runs, with the most recent appearing first. |
| 52 | * |
| 53 | * @param null|array $params |
| 54 | * @param null|array|string $opts |
| 55 | * |
| 56 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 57 | * |
| 58 | * @return \Stripe\Collection<\Stripe\Reporting\ReportRun> of ApiResources |
| 59 | */ |
| 60 | public static function all($params = null, $opts = null) |
| 61 | { |
| 62 | $url = static::classUrl(); |
| 63 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 64 | } |
| 65 | /** |
| 66 | * Retrieves the details of an existing Report Run. |
| 67 | * |
| 68 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 69 | * @param null|array|string $opts |
| 70 | * |
| 71 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 72 | * |
| 73 | * @return \Stripe\Reporting\ReportRun |
| 74 | */ |
| 75 | public static function retrieve($id, $opts = null) |
| 76 | { |
| 77 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 78 | $instance = new static($id, $opts); |
| 79 | $instance->refresh(); |
| 80 | return $instance; |
| 81 | } |
| 82 | } |
| 83 |