EarlyFraudWarningService.php
2 years ago
RadarServiceFactory.php
4 years ago
ValueListItemService.php
2 years ago
ValueListService.php
2 years ago
ValueListService.php
94 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe\Service\Radar; |
| 6 | |
| 7 | class ValueListService extends \Stripe\Service\AbstractService |
| 8 | { |
| 9 | /** |
| 10 | * Returns a list of <code>ValueList</code> objects. The objects are sorted in |
| 11 | * descending order by creation date, with the most recently created object |
| 12 | * appearing first. |
| 13 | * |
| 14 | * @param null|array $params |
| 15 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 16 | * |
| 17 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 18 | * |
| 19 | * @return \Stripe\Collection<\Stripe\Radar\ValueList> |
| 20 | */ |
| 21 | public function all($params = null, $opts = null) |
| 22 | { |
| 23 | return $this->requestCollection('get', '/v1/radar/value_lists', $params, $opts); |
| 24 | } |
| 25 | |
| 26 | /** |
| 27 | * Creates a new <code>ValueList</code> object, which can then be referenced in |
| 28 | * rules. |
| 29 | * |
| 30 | * @param null|array $params |
| 31 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 32 | * |
| 33 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 34 | * |
| 35 | * @return \Stripe\Radar\ValueList |
| 36 | */ |
| 37 | public function create($params = null, $opts = null) |
| 38 | { |
| 39 | return $this->request('post', '/v1/radar/value_lists', $params, $opts); |
| 40 | } |
| 41 | |
| 42 | /** |
| 43 | * Deletes a <code>ValueList</code> object, also deleting any items contained |
| 44 | * within the value list. To be deleted, a value list must not be referenced in any |
| 45 | * rules. |
| 46 | * |
| 47 | * @param string $id |
| 48 | * @param null|array $params |
| 49 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 50 | * |
| 51 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 52 | * |
| 53 | * @return \Stripe\Radar\ValueList |
| 54 | */ |
| 55 | public function delete($id, $params = null, $opts = null) |
| 56 | { |
| 57 | return $this->request('delete', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Retrieves a <code>ValueList</code> object. |
| 62 | * |
| 63 | * @param string $id |
| 64 | * @param null|array $params |
| 65 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 66 | * |
| 67 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 68 | * |
| 69 | * @return \Stripe\Radar\ValueList |
| 70 | */ |
| 71 | public function retrieve($id, $params = null, $opts = null) |
| 72 | { |
| 73 | return $this->request('get', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Updates a <code>ValueList</code> object by setting the values of the parameters |
| 78 | * passed. Any parameters not provided will be left unchanged. Note that |
| 79 | * <code>item_type</code> is immutable. |
| 80 | * |
| 81 | * @param string $id |
| 82 | * @param null|array $params |
| 83 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 84 | * |
| 85 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 86 | * |
| 87 | * @return \Stripe\Radar\ValueList |
| 88 | */ |
| 89 | public function update($id, $params = null, $opts = null) |
| 90 | { |
| 91 | return $this->request('post', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts); |
| 92 | } |
| 93 | } |
| 94 |