| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596 |
- <?php
- // File generated from our OpenAPI spec
- namespace Stripe\Service\Checkout;
- /**
- * @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
- * @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
- */
- class SessionService extends \Stripe\Service\AbstractService
- {
- /**
- * Returns a list of Checkout Sessions.
- *
- * @param null|array $params
- * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection<\Stripe\Checkout\Session>
- */
- public function all($params = null, $opts = null)
- {
- return $this->requestCollection('get', '/v1/checkout/sessions', $params, $opts);
- }
- /**
- * When retrieving a Checkout Session, there is an includable
- * <strong>line_items</strong> property containing the first handful of those
- * items. There is also a URL where you can retrieve the full (paginated) list of
- * line items.
- *
- * @param string $id
- * @param null|array $params
- * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection<\Stripe\LineItem>
- */
- public function allLineItems($id, $params = null, $opts = null)
- {
- return $this->requestCollection('get', $this->buildPath('/v1/checkout/sessions/%s/line_items', $id), $params, $opts);
- }
- /**
- * Creates a Session object.
- *
- * @param null|array $params
- * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Checkout\Session
- */
- public function create($params = null, $opts = null)
- {
- return $this->request('post', '/v1/checkout/sessions', $params, $opts);
- }
- /**
- * A Session can be expired when it is in one of these statuses: <code>open</code>.
- *
- * After it expires, a customer can’t complete a Session and customers loading the
- * Session see a message saying the Session is expired.
- *
- * @param string $id
- * @param null|array $params
- * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Checkout\Session
- */
- public function expire($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/checkout/sessions/%s/expire', $id), $params, $opts);
- }
- /**
- * Retrieves a Session object.
- *
- * @param string $id
- * @param null|array $params
- * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Checkout\Session
- */
- public function retrieve($id, $params = null, $opts = null)
- {
- return $this->request('get', $this->buildPath('/v1/checkout/sessions/%s', $id), $params, $opts);
- }
- }
|