modern-events-calendar-lite/app/api/Stripe/Service/Reporting/ReportRunService.php

58 lines
1.9 KiB
PHP
Raw Permalink Normal View History

2024-10-15 12:04:03 +02:00
<?php
// File generated from our OpenAPI spec
namespace Stripe\Service\Reporting;
class ReportRunService extends \Stripe\Service\AbstractService
{
/**
* Returns a list of Report Runs, with the most recent appearing first. (Requires a
* <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
*
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Collection
*/
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/reporting/report_runs', $params, $opts);
}
/**
* Creates a new object and begin running the report. (Requires a <a
* href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
*
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Reporting\ReportRun
*/
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/reporting/report_runs', $params, $opts);
}
/**
* Retrieves the details of an existing Report Run. (Requires a <a
* href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Reporting\ReportRun
*/
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/reporting/report_runs/%s', $id), $params, $opts);
}
}