From 75160b12821f7f4299cce7f0b69c83c1502ae071 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anton=20Luka=20=C5=A0ijanec?= Date: Mon, 27 May 2024 13:08:29 +0200 Subject: 2024-02-19 upstream --- .../lib/Service/SubscriptionItemService.php | 302 ++++++++++----------- 1 file changed, 151 insertions(+), 151 deletions(-) (limited to 'vendor/stripe/stripe-php/lib/Service/SubscriptionItemService.php') diff --git a/vendor/stripe/stripe-php/lib/Service/SubscriptionItemService.php b/vendor/stripe/stripe-php/lib/Service/SubscriptionItemService.php index 3b2aa2b..d0a76e3 100644 --- a/vendor/stripe/stripe-php/lib/Service/SubscriptionItemService.php +++ b/vendor/stripe/stripe-php/lib/Service/SubscriptionItemService.php @@ -1,151 +1,151 @@ -requestCollection('get', '/v1/subscription_items', $params, $opts); - } - - /** - * For the specified subscription item, returns a list of summary objects. Each - * object in the list provides usage information that’s been summarized from - * multiple usage records and over a subscription billing period (e.g., 15 usage - * records in the month of September). - * - * The list is sorted in reverse-chronological order (newest first). The first list - * item represents the most current usage period that hasn’t ended yet. Since new - * usage records can still be added, the returned summary information for the - * subscription item’s ID should be seen as unstable until the subscription billing - * period ends. - * - * @param string $parentId - * @param null|array $params - * @param null|array|\Stripe\Util\RequestOptions $opts - * - * @throws \Stripe\Exception\ApiErrorException if the request fails - * - * @return \Stripe\Collection - */ - public function allUsageRecordSummaries($parentId, $params = null, $opts = null) - { - return $this->requestCollection('get', $this->buildPath('/v1/subscription_items/%s/usage_record_summaries', $parentId), $params, $opts); - } - - /** - * Adds a new item to an existing subscription. No existing items will be changed - * or replaced. - * - * @param null|array $params - * @param null|array|\Stripe\Util\RequestOptions $opts - * - * @throws \Stripe\Exception\ApiErrorException if the request fails - * - * @return \Stripe\SubscriptionItem - */ - public function create($params = null, $opts = null) - { - return $this->request('post', '/v1/subscription_items', $params, $opts); - } - - /** - * Creates a usage record for a specified subscription item and date, and fills it - * with a quantity. - * - * Usage records provide quantity information that Stripe uses to - * track how much a customer is using your service. With usage information and the - * pricing model set up by the metered - * billing plan, Stripe helps you send accurate invoices to your customers. - * - * The default calculation for usage is to add up all the quantity - * values of the usage records within a billing period. You can change this default - * behavior with the billing plan’s aggregate_usage parameter. When - * there is more than one usage record with the same timestamp, Stripe adds the - * quantity values together. In most cases, this is the desired - * resolution, however, you can change this behavior with the action - * parameter. - * - * The default pricing model for metered billing is per-unit pricing. - * For finer granularity, you can configure metered billing to have a tiered pricing - * model. - * - * @param string $parentId - * @param null|array $params - * @param null|array|\Stripe\Util\RequestOptions $opts - * - * @throws \Stripe\Exception\ApiErrorException if the request fails - * - * @return \Stripe\UsageRecord - */ - public function createUsageRecord($parentId, $params = null, $opts = null) - { - return $this->request('post', $this->buildPath('/v1/subscription_items/%s/usage_records', $parentId), $params, $opts); - } - - /** - * Deletes an item from the subscription. Removing a subscription item from a - * subscription will not cancel the subscription. - * - * @param string $id - * @param null|array $params - * @param null|array|\Stripe\Util\RequestOptions $opts - * - * @throws \Stripe\Exception\ApiErrorException if the request fails - * - * @return \Stripe\SubscriptionItem - */ - public function delete($id, $params = null, $opts = null) - { - return $this->request('delete', $this->buildPath('/v1/subscription_items/%s', $id), $params, $opts); - } - - /** - * Retrieves the subscription item 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\SubscriptionItem - */ - public function retrieve($id, $params = null, $opts = null) - { - return $this->request('get', $this->buildPath('/v1/subscription_items/%s', $id), $params, $opts); - } - - /** - * Updates the plan or quantity of an item on a current subscription. - * - * @param string $id - * @param null|array $params - * @param null|array|\Stripe\Util\RequestOptions $opts - * - * @throws \Stripe\Exception\ApiErrorException if the request fails - * - * @return \Stripe\SubscriptionItem - */ - public function update($id, $params = null, $opts = null) - { - return $this->request('post', $this->buildPath('/v1/subscription_items/%s', $id), $params, $opts); - } -} + + */ + public function all($params = null, $opts = null) + { + return $this->requestCollection('get', '/v1/subscription_items', $params, $opts); + } + + /** + * For the specified subscription item, returns a list of summary objects. Each + * object in the list provides usage information that’s been summarized from + * multiple usage records and over a subscription billing period (e.g., 15 usage + * records in the month of September). + * + * The list is sorted in reverse-chronological order (newest first). The first list + * item represents the most current usage period that hasn’t ended yet. Since new + * usage records can still be added, the returned summary information for the + * subscription item’s ID should be seen as unstable until the subscription billing + * period ends. + * + * @param string $parentId + * @param null|array $params + * @param null|array|\Stripe\Util\RequestOptions $opts + * + * @throws \Stripe\Exception\ApiErrorException if the request fails + * + * @return \Stripe\Collection<\Stripe\UsageRecordSummary> + */ + public function allUsageRecordSummaries($parentId, $params = null, $opts = null) + { + return $this->requestCollection('get', $this->buildPath('/v1/subscription_items/%s/usage_record_summaries', $parentId), $params, $opts); + } + + /** + * Adds a new item to an existing subscription. No existing items will be changed + * or replaced. + * + * @param null|array $params + * @param null|array|\Stripe\Util\RequestOptions $opts + * + * @throws \Stripe\Exception\ApiErrorException if the request fails + * + * @return \Stripe\SubscriptionItem + */ + public function create($params = null, $opts = null) + { + return $this->request('post', '/v1/subscription_items', $params, $opts); + } + + /** + * Creates a usage record for a specified subscription item and date, and fills it + * with a quantity. + * + * Usage records provide quantity information that Stripe uses to + * track how much a customer is using your service. With usage information and the + * pricing model set up by the metered + * billing plan, Stripe helps you send accurate invoices to your customers. + * + * The default calculation for usage is to add up all the quantity + * values of the usage records within a billing period. You can change this default + * behavior with the billing plan’s aggregate_usage parameter. When + * there is more than one usage record with the same timestamp, Stripe adds the + * quantity values together. In most cases, this is the desired + * resolution, however, you can change this behavior with the action + * parameter. + * + * The default pricing model for metered billing is per-unit pricing. + * For finer granularity, you can configure metered billing to have a tiered pricing + * model. + * + * @param string $parentId + * @param null|array $params + * @param null|array|\Stripe\Util\RequestOptions $opts + * + * @throws \Stripe\Exception\ApiErrorException if the request fails + * + * @return \Stripe\UsageRecord + */ + public function createUsageRecord($parentId, $params = null, $opts = null) + { + return $this->request('post', $this->buildPath('/v1/subscription_items/%s/usage_records', $parentId), $params, $opts); + } + + /** + * Deletes an item from the subscription. Removing a subscription item from a + * subscription will not cancel the subscription. + * + * @param string $id + * @param null|array $params + * @param null|array|\Stripe\Util\RequestOptions $opts + * + * @throws \Stripe\Exception\ApiErrorException if the request fails + * + * @return \Stripe\SubscriptionItem + */ + public function delete($id, $params = null, $opts = null) + { + return $this->request('delete', $this->buildPath('/v1/subscription_items/%s', $id), $params, $opts); + } + + /** + * Retrieves the subscription item 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\SubscriptionItem + */ + public function retrieve($id, $params = null, $opts = null) + { + return $this->request('get', $this->buildPath('/v1/subscription_items/%s', $id), $params, $opts); + } + + /** + * Updates the plan or quantity of an item on a current subscription. + * + * @param string $id + * @param null|array $params + * @param null|array|\Stripe\Util\RequestOptions $opts + * + * @throws \Stripe\Exception\ApiErrorException if the request fails + * + * @return \Stripe\SubscriptionItem + */ + public function update($id, $params = null, $opts = null) + { + return $this->request('post', $this->buildPath('/v1/subscription_items/%s', $id), $params, $opts); + } +} -- cgit v1.2.3