SessionService.php
93 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe\Service\Checkout; |
| 6 | |
| 7 | class SessionService extends \Stripe\Service\AbstractService |
| 8 | { |
| 9 | /** |
| 10 | * Returns a list of Checkout Sessions. |
| 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\Checkout\Session> |
| 18 | */ |
| 19 | public function all($params = null, $opts = null) |
| 20 | { |
| 21 | return $this->requestCollection('get', '/v1/checkout/sessions', $params, $opts); |
| 22 | } |
| 23 | |
| 24 | /** |
| 25 | * When retrieving a Checkout Session, there is an includable |
| 26 | * <strong>line_items</strong> property containing the first handful of those |
| 27 | * items. There is also a URL where you can retrieve the full (paginated) list of |
| 28 | * line items. |
| 29 | * |
| 30 | * @param string $parentId |
| 31 | * @param null|array $params |
| 32 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 33 | * |
| 34 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 35 | * |
| 36 | * @return \Stripe\Collection<\Stripe\LineItem> |
| 37 | */ |
| 38 | public function allLineItems($parentId, $params = null, $opts = null) |
| 39 | { |
| 40 | return $this->requestCollection('get', $this->buildPath('/v1/checkout/sessions/%s/line_items', $parentId), $params, $opts); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Creates a Session object. |
| 45 | * |
| 46 | * @param null|array $params |
| 47 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 48 | * |
| 49 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 50 | * |
| 51 | * @return \Stripe\Checkout\Session |
| 52 | */ |
| 53 | public function create($params = null, $opts = null) |
| 54 | { |
| 55 | return $this->request('post', '/v1/checkout/sessions', $params, $opts); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * A Session can be expired when it is in one of these statuses: <code>open</code>. |
| 60 | * |
| 61 | * After it expires, a customer can’t complete a Session and customers loading the |
| 62 | * Session see a message saying the Session is expired. |
| 63 | * |
| 64 | * @param string $id |
| 65 | * @param null|array $params |
| 66 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 67 | * |
| 68 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 69 | * |
| 70 | * @return \Stripe\Checkout\Session |
| 71 | */ |
| 72 | public function expire($id, $params = null, $opts = null) |
| 73 | { |
| 74 | return $this->request('post', $this->buildPath('/v1/checkout/sessions/%s/expire', $id), $params, $opts); |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Retrieves a Session object. |
| 79 | * |
| 80 | * @param string $id |
| 81 | * @param null|array $params |
| 82 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 83 | * |
| 84 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 85 | * |
| 86 | * @return \Stripe\Checkout\Session |
| 87 | */ |
| 88 | public function retrieve($id, $params = null, $opts = null) |
| 89 | { |
| 90 | return $this->request('get', $this->buildPath('/v1/checkout/sessions/%s', $id), $params, $opts); |
| 91 | } |
| 92 | } |
| 93 |