ReportRunService.php
2 years ago
ReportTypeService.php
2 years ago
ReportingServiceFactory.php
4 years ago
ReportRunService.php
56 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe\Service\Reporting; |
| 6 | |
| 7 | class ReportRunService extends \Stripe\Service\AbstractService |
| 8 | { |
| 9 | /** |
| 10 | * Returns a list of Report Runs, with the most recent appearing first. |
| 11 | * |
| 12 | * @param null|array $params |
| 13 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 14 | * |
| 15 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 16 | * |
| 17 | * @return \Stripe\Collection<\Stripe\Reporting\ReportRun> |
| 18 | */ |
| 19 | public function all($params = null, $opts = null) |
| 20 | { |
| 21 | return $this->requestCollection('get', '/v1/reporting/report_runs', $params, $opts); |
| 22 | } |
| 23 | |
| 24 | /** |
| 25 | * Creates a new object and begin running the report. (Certain report types require |
| 26 | * a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.). |
| 27 | * |
| 28 | * @param null|array $params |
| 29 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 30 | * |
| 31 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 32 | * |
| 33 | * @return \Stripe\Reporting\ReportRun |
| 34 | */ |
| 35 | public function create($params = null, $opts = null) |
| 36 | { |
| 37 | return $this->request('post', '/v1/reporting/report_runs', $params, $opts); |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * Retrieves the details of an existing Report Run. |
| 42 | * |
| 43 | * @param string $id |
| 44 | * @param null|array $params |
| 45 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 46 | * |
| 47 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 48 | * |
| 49 | * @return \Stripe\Reporting\ReportRun |
| 50 | */ |
| 51 | public function retrieve($id, $params = null, $opts = null) |
| 52 | { |
| 53 | return $this->request('get', $this->buildPath('/v1/reporting/report_runs/%s', $id), $params, $opts); |
| 54 | } |
| 55 | } |
| 56 |