PromotionCodeService.php — GiveWP – Donation Plugin and Fundraising Platform 4.16.3

give / vendor / stripe / stripe-php / lib / Service / PromotionCodeService.php

give / vendor / stripe / stripe-php / lib / Service Last commit date

PromotionCodeService.php

76 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class PromotionCodeService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of your promotion codes.
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\PromotionCode>
18	*/
19	public function all($params = null, $opts = null)
20	{
21	return $this->requestCollection('get', '/v1/promotion_codes', $params, $opts);
22	}
23
24	/**
25	* A promotion code points to a coupon. You can optionally restrict the code to a
26	* specific customer, redemption limit, and expiration date.
27	*
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\PromotionCode
34	*/
35	public function create($params = null, $opts = null)
36	{
37	return $this->request('post', '/v1/promotion_codes', $params, $opts);
38	}
39
40	/**
41	* Retrieves the promotion code with the given ID. In order to retrieve a promotion
42	* code by the customer-facing <code>code</code> use <a
43	* href="/docs/api/promotion_codes/list">list</a> with the desired
44	* <code>code</code>.
45	*
46	* @param string $id
47	* @param null\|array $params
48	* @param null\|array\|\Stripe\Util\RequestOptions $opts
49	*
50	* @throws \Stripe\Exception\ApiErrorException if the request fails
51	*
52	* @return \Stripe\PromotionCode
53	*/
54	public function retrieve($id, $params = null, $opts = null)
55	{
56	return $this->request('get', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
57	}
58
59	/**
60	* Updates the specified promotion code by setting the values of the parameters
61	* passed. Most fields are, by design, not editable.
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\PromotionCode
70	*/
71	public function update($id, $params = null, $opts = null)
72	{
73	return $this->request('post', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
74	}
75	}
76