summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php')
-rw-r--r--vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php147
1 files changed, 75 insertions, 72 deletions
diff --git a/vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php b/vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php
index 1de5696..7f8d4dc 100644
--- a/vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php
+++ b/vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php
@@ -1,72 +1,75 @@
-<?php
-
-// File generated from our OpenAPI spec
-
-namespace Stripe\Service;
-
-class PromotionCodeService extends \Stripe\Service\AbstractService
-{
- /**
- * Returns a list of your promotion codes.
- *
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection
- */
- public function all($params = null, $opts = null)
- {
- return $this->requestCollection('get', '/v1/promotion_codes', $params, $opts);
- }
-
- /**
- * A promotion code points to a coupon. You can optionally restrict the code to a
- * specific customer, redemption limit, and expiration date.
- *
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PromotionCode
- */
- public function create($params = null, $opts = null)
- {
- return $this->request('post', '/v1/promotion_codes', $params, $opts);
- }
-
- /**
- * Retrieves the promotion code with the given ID.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PromotionCode
- */
- public function retrieve($id, $params = null, $opts = null)
- {
- return $this->request('get', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
- }
-
- /**
- * Updates the specified promotion code by setting the values of the parameters
- * passed. Most fields are, by design, not editable.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\PromotionCode
- */
- public function update($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
- }
-}
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace Stripe\Service;
+
+class PromotionCodeService extends \Stripe\Service\AbstractService
+{
+ /**
+ * Returns a list of your promotion codes.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Collection<\Stripe\PromotionCode>
+ */
+ public function all($params = null, $opts = null)
+ {
+ return $this->requestCollection('get', '/v1/promotion_codes', $params, $opts);
+ }
+
+ /**
+ * A promotion code points to a coupon. You can optionally restrict the code to a
+ * specific customer, redemption limit, and expiration date.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PromotionCode
+ */
+ public function create($params = null, $opts = null)
+ {
+ return $this->request('post', '/v1/promotion_codes', $params, $opts);
+ }
+
+ /**
+ * Retrieves the promotion code with the given ID. In order to retrieve a promotion
+ * code by the customer-facing <code>code</code> use <a
+ * href="/docs/api/promotion_codes/list">list</a> with the desired
+ * <code>code</code>.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PromotionCode
+ */
+ public function retrieve($id, $params = null, $opts = null)
+ {
+ return $this->request('get', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
+ }
+
+ /**
+ * Updates the specified promotion code by setting the values of the parameters
+ * passed. Most fields are, by design, not editable.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\PromotionCode
+ */
+ public function update($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
+ }
+}