ConfigurationService.php
2 years ago
ConnectionTokenService.php
4 years ago
LocationService.php
2 years ago
ReaderService.php
2 years ago
TerminalServiceFactory.php
2 years ago
ReaderService.php
152 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe\Service\Terminal; |
| 6 | |
| 7 | class ReaderService extends \Stripe\Service\AbstractService |
| 8 | { |
| 9 | /** |
| 10 | * Returns a list of <code>Reader</code> objects. |
| 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\Terminal\Reader> |
| 18 | */ |
| 19 | public function all($params = null, $opts = null) |
| 20 | { |
| 21 | return $this->requestCollection('get', '/v1/terminal/readers', $params, $opts); |
| 22 | } |
| 23 | |
| 24 | /** |
| 25 | * Cancels the current reader action. |
| 26 | * |
| 27 | * @param string $id |
| 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\Terminal\Reader |
| 34 | */ |
| 35 | public function cancelAction($id, $params = null, $opts = null) |
| 36 | { |
| 37 | return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/cancel_action', $id), $params, $opts); |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * Creates a new <code>Reader</code> object. |
| 42 | * |
| 43 | * @param null|array $params |
| 44 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 45 | * |
| 46 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 47 | * |
| 48 | * @return \Stripe\Terminal\Reader |
| 49 | */ |
| 50 | public function create($params = null, $opts = null) |
| 51 | { |
| 52 | return $this->request('post', '/v1/terminal/readers', $params, $opts); |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * Deletes a <code>Reader</code> object. |
| 57 | * |
| 58 | * @param string $id |
| 59 | * @param null|array $params |
| 60 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 61 | * |
| 62 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 63 | * |
| 64 | * @return \Stripe\Terminal\Reader |
| 65 | */ |
| 66 | public function delete($id, $params = null, $opts = null) |
| 67 | { |
| 68 | return $this->request('delete', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts); |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Initiates a payment flow on a Reader. |
| 73 | * |
| 74 | * @param string $id |
| 75 | * @param null|array $params |
| 76 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 77 | * |
| 78 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 79 | * |
| 80 | * @return \Stripe\Terminal\Reader |
| 81 | */ |
| 82 | public function processPaymentIntent($id, $params = null, $opts = null) |
| 83 | { |
| 84 | return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/process_payment_intent', $id), $params, $opts); |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * Initiates a setup intent flow on a Reader. |
| 89 | * |
| 90 | * @param string $id |
| 91 | * @param null|array $params |
| 92 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 93 | * |
| 94 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 95 | * |
| 96 | * @return \Stripe\Terminal\Reader |
| 97 | */ |
| 98 | public function processSetupIntent($id, $params = null, $opts = null) |
| 99 | { |
| 100 | return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/process_setup_intent', $id), $params, $opts); |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Retrieves a <code>Reader</code> object. |
| 105 | * |
| 106 | * @param string $id |
| 107 | * @param null|array $params |
| 108 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 109 | * |
| 110 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 111 | * |
| 112 | * @return \Stripe\Terminal\Reader |
| 113 | */ |
| 114 | public function retrieve($id, $params = null, $opts = null) |
| 115 | { |
| 116 | return $this->request('get', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts); |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Sets reader display to show cart details. |
| 121 | * |
| 122 | * @param string $id |
| 123 | * @param null|array $params |
| 124 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 125 | * |
| 126 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 127 | * |
| 128 | * @return \Stripe\Terminal\Reader |
| 129 | */ |
| 130 | public function setReaderDisplay($id, $params = null, $opts = null) |
| 131 | { |
| 132 | return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/set_reader_display', $id), $params, $opts); |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Updates a <code>Reader</code> object by setting the values of the parameters |
| 137 | * passed. Any parameters not provided will be left unchanged. |
| 138 | * |
| 139 | * @param string $id |
| 140 | * @param null|array $params |
| 141 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 142 | * |
| 143 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 144 | * |
| 145 | * @return \Stripe\Terminal\Reader |
| 146 | */ |
| 147 | public function update($id, $params = null, $opts = null) |
| 148 | { |
| 149 | return $this->request('post', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts); |
| 150 | } |
| 151 | } |
| 152 |