summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/Service/ChargeService.php
diff options
context:
space:
mode:
authorAnton Luka Šijanec <anton@sijanec.eu>2024-05-27 13:08:29 +0200
committerAnton Luka Šijanec <anton@sijanec.eu>2024-05-27 13:08:29 +0200
commit75160b12821f7f4299cce7f0b69c83c1502ae071 (patch)
tree27e25e4ccaef45f0c58b22831164050d1af1d4db /vendor/stripe/stripe-php/lib/Service/ChargeService.php
parentprvi-commit (diff)
download1ka-75160b12821f7f4299cce7f0b69c83c1502ae071.tar
1ka-75160b12821f7f4299cce7f0b69c83c1502ae071.tar.gz
1ka-75160b12821f7f4299cce7f0b69c83c1502ae071.tar.bz2
1ka-75160b12821f7f4299cce7f0b69c83c1502ae071.tar.lz
1ka-75160b12821f7f4299cce7f0b69c83c1502ae071.tar.xz
1ka-75160b12821f7f4299cce7f0b69c83c1502ae071.tar.zst
1ka-75160b12821f7f4299cce7f0b69c83c1502ae071.zip
Diffstat (limited to 'vendor/stripe/stripe-php/lib/Service/ChargeService.php')
-rw-r--r--vendor/stripe/stripe-php/lib/Service/ChargeService.php223
1 files changed, 122 insertions, 101 deletions
diff --git a/vendor/stripe/stripe-php/lib/Service/ChargeService.php b/vendor/stripe/stripe-php/lib/Service/ChargeService.php
index f5321b8..e24c0f5 100644
--- a/vendor/stripe/stripe-php/lib/Service/ChargeService.php
+++ b/vendor/stripe/stripe-php/lib/Service/ChargeService.php
@@ -1,101 +1,122 @@
-<?php
-
-// File generated from our OpenAPI spec
-
-namespace Stripe\Service;
-
-class ChargeService extends \Stripe\Service\AbstractService
-{
- /**
- * Returns a list of charges you’ve previously created. The charges are returned in
- * sorted order, with the most recent charges appearing first.
- *
- * @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/charges', $params, $opts);
- }
-
- /**
- * Capture the payment of an existing, uncaptured, charge. This is the second half
- * of the two-step payment flow, where first you <a href="#create_charge">created a
- * charge</a> with the capture option set to false.
- *
- * Uncaptured payments expire exactly seven days after they are created. If they
- * are not captured by that point in time, they will be marked as refunded and will
- * no longer be capturable.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Charge
- */
- public function capture($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/charges/%s/capture', $id), $params, $opts);
- }
-
- /**
- * To charge a credit card or other payment source, you create a
- * <code>Charge</code> object. If your API key is in test mode, the supplied
- * payment source (e.g., card) won’t actually be charged, although everything else
- * will occur as if in live mode. (Stripe assumes that the charge would have
- * completed successfully).
- *
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Charge
- */
- public function create($params = null, $opts = null)
- {
- return $this->request('post', '/v1/charges', $params, $opts);
- }
-
- /**
- * Retrieves the details of a charge that has previously been created. Supply the
- * unique charge ID that was returned from your previous request, and Stripe will
- * return the corresponding charge information. The same information is returned
- * when creating or refunding the charge.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Charge
- */
- public function retrieve($id, $params = null, $opts = null)
- {
- return $this->request('get', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
- }
-
- /**
- * Updates the specified charge by setting the values of the parameters passed. Any
- * parameters not provided will be left unchanged.
- *
- * @param string $id
- * @param null|array $params
- * @param null|array|\Stripe\Util\RequestOptions $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Charge
- */
- public function update($id, $params = null, $opts = null)
- {
- return $this->request('post', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
- }
-}
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace Stripe\Service;
+
+class ChargeService extends \Stripe\Service\AbstractService
+{
+ /**
+ * Returns a list of charges you’ve previously created. The charges are returned in
+ * sorted order, with the most recent charges appearing first.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Collection<\Stripe\Charge>
+ */
+ public function all($params = null, $opts = null)
+ {
+ return $this->requestCollection('get', '/v1/charges', $params, $opts);
+ }
+
+ /**
+ * Capture the payment of an existing, uncaptured, charge. This is the second half
+ * of the two-step payment flow, where first you <a href="#create_charge">created a
+ * charge</a> with the capture option set to false.
+ *
+ * Uncaptured payments expire a set number of days after they are created (<a
+ * href="/docs/charges/placing-a-hold">7 by default</a>). If they are not captured
+ * by that point in time, they will be marked as refunded and will no longer be
+ * capturable.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Charge
+ */
+ public function capture($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/charges/%s/capture', $id), $params, $opts);
+ }
+
+ /**
+ * To charge a credit card or other payment source, you create a
+ * <code>Charge</code> object. If your API key is in test mode, the supplied
+ * payment source (e.g., card) won’t actually be charged, although everything else
+ * will occur as if in live mode. (Stripe assumes that the charge would have
+ * completed successfully).
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Charge
+ */
+ public function create($params = null, $opts = null)
+ {
+ return $this->request('post', '/v1/charges', $params, $opts);
+ }
+
+ /**
+ * Retrieves the details of a charge that has previously been created. Supply the
+ * unique charge ID that was returned from your previous request, and Stripe will
+ * return the corresponding charge information. The same information is returned
+ * when creating or refunding the charge.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Charge
+ */
+ public function retrieve($id, $params = null, $opts = null)
+ {
+ return $this->request('get', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
+ }
+
+ /**
+ * Search for charges you’ve previously created using Stripe’s <a
+ * href="/docs/search#search-query-language">Search Query Language</a>. Don’t use
+ * search in read-after-write flows where strict consistency is necessary. Under
+ * normal operating conditions, data is searchable in less than a minute.
+ * Occasionally, propagation of new or updated data can be up to an hour behind
+ * during outages. Search functionality is not available to merchants in India.
+ *
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\SearchResult<\Stripe\Charge>
+ */
+ public function search($params = null, $opts = null)
+ {
+ return $this->requestSearchResult('get', '/v1/charges/search', $params, $opts);
+ }
+
+ /**
+ * Updates the specified charge by setting the values of the parameters passed. Any
+ * parameters not provided will be left unchanged.
+ *
+ * @param string $id
+ * @param null|array $params
+ * @param null|array|\Stripe\Util\RequestOptions $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\Charge
+ */
+ public function update($id, $params = null, $opts = null)
+ {
+ return $this->request('post', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
+ }
+}