Merge 5fe9f38 into e6c8951

src/Entities/Schema.php

@@ -120,6 +120,9 @@ public function __construct()
             'subscriptions/{subscriptionId}/change-plan' => function (array $content) {
                 return new Subscription($content);
             },
+            'subscriptions/{subscriptionId}/change-items' => function (array $content) {
+                return new Subscription($content);
+            },
             'subscriptions/{subscriptionId}/interim-invoice' => function (array $content) {
                 return new Invoice($content);
             },

src/Entities/SubscriptionChangeItems.php

@@ -0,0 +1,150 @@
+<?php
+/**
+ * This source file is proprietary and part of Rebilly.
+ *
+ * (c) Rebilly SRL
+ *     Rebilly Ltd.
+ *     Rebilly Inc.
+ *
+ * @see https://www.rebilly.com
+ */
+
+namespace Rebilly\Entities;
+
+use DomainException;
+use Rebilly\Entities\Subscriptions\PlanItem;
+use Rebilly\Rest\Resource;
+
+class SubscriptionChangeItems extends Resource
+{
+    public const UNEXPECTED_RENEWAL_POLICY = 'Unexpected renewalPolicy. Only %s are supported';
+
+    public const RENEWAL_POLICY_RESET = 'reset';
+
+    public const RENEWAL_POLICY_RETAIN = 'retain';
+
+    /**
+     * @return array
+     */
+    public static function renewalPolicies()
+    {
+        return [
+            self::RENEWAL_POLICY_RESET,
+            self::RENEWAL_POLICY_RETAIN,
+        ];
+    }
+
+    /**
+     * @param array $value
+     *
+     * @return $this
+     */
+    public function setItems(array $value)
+    {
+        return $this->setAttribute('items', $value);
+    }
+
+    /**
+     * @param array $data
+     *
+     * @return array|Subscriptions\PlanItem[]
+     */
+    public function createItems(array $data)
+    {
+        return array_map(
+            function ($item) {
+                if ($item instanceof PlanItem) {
+                    return $item;
+                }
+
+                return new Subscriptions\PlanItem($item);
+            },
+            $data
+        );
+    }
+
+    /**
+     * @param $value
+     *
+     * @throws DomainException
+     */
+    public function setRenewalPolicy($value)
+    {
+        if (!in_array($value, self::renewalPolicies(), true)) {
+            throw new DomainException(sprintf(self::UNEXPECTED_RENEWAL_POLICY, implode(', ', self::renewalPolicies())));
+        }
+        $this->setAttribute('renewalPolicy', $value);
+    }
+
+    /**
+     * @param $value
+     */
+    public function setProrated($value)
+    {
+        $this->setAttribute('prorated', $value);
+    }
+
+    /**
+     * @param $value
+     */
+    public function setEffectiveTime($value)
+    {
+        $this->setAttribute('effectiveTime', $value);
+    }
+
+    /**
+     * @param $value
+     */
+    public function setPreview($value)
+    {
+        $this->setAttribute('preview', $value);
+    }
+
+    /**
+     * @param $value
+     */
+    public function setKeepTrial($value)
+    {
+        $this->setAttribute('keepTrial', $value);
+    }
+
+    /**
+     * @return bool
+     */
+    public function getPreview()
+    {
+        return $this->getAttribute('preview');
+    }
+
+    /**
+     * @return bool
+     */
+    public function getProrated()
+    {
+        return $this->getAttribute('prorated');
+    }
+
+    /**
+     * @return string
+     */
+    public function getRenewalPolicy()
+    {
+        return $this->getAttribute('renewalPolicy');
+    }
+
+    /**
+     * @return string
+     */
+    public function getEffectiveTime()
+    {
+        return $this->getAttribute('effectiveTime');
+    }
+
+    /**
+     * @return bool
+     */
+    public function getKeepTrial()
+    {
+        return $this->getAttribute('keepTrial');
+    }
+}

src/Entities/SubscriptionChangePlan.php

@@ -14,6 +14,10 @@
 use DomainException;
 use Rebilly\Rest\Resource;
 
+/**
+ * @deprecated
+ * @see SubscriptionChangeItems
+ */
 class SubscriptionChangePlan extends Resource
 {
     public const UNEXPECTED_RENEWAL_POLICY = 'Unexpected renewalPolicy. Only %s are supported';

src/Services/SubscriptionService.php

@@ -16,6 +16,7 @@
 use Rebilly\Entities\Invoice;
 use Rebilly\Entities\Subscription;
 use Rebilly\Entities\SubscriptionCancel;
+use Rebilly\Entities\SubscriptionChangeItems;
 use Rebilly\Entities\SubscriptionChangePlan;
 use Rebilly\Entities\SubscriptionInterimInvoice;
 use Rebilly\Http\Exception\DataValidationException;
@@ -113,6 +114,9 @@ public function cancel($subscriptionId, $data)
     }
 
     /**
+     * @deprecated
+     * @see changeItems
+     *
      * @param string $subscriptionId
      * @param array|JsonSerializable|SubscriptionChangePlan $data
      *
@@ -176,4 +180,21 @@ public function issueUpcomingInvoice($subscriptionId, $invoiceId)
             ]
         );
     }
+
+    /**
+     * @param string $subscriptionId
+     * @param array|JsonSerializable|SubscriptionChangeItems $data
+     *
+     * @throws DataValidationException The input data does not valid
+     *
+     * @return Subscription
+     */
+    public function changeItems($subscriptionId, $data)
+    {
+        return $this->client()->post(
+            $data,
+            'subscriptions/{subscriptionId}/change-items',
+            ['subscriptionId' => $subscriptionId]
+        );
+    }
 }

tests/Api/ApiTest.php

@@ -230,6 +230,7 @@ public function provideEntityClasses(): iterable
             [Entities\RulesEngine\Actions\TriggerWebhook::class],
             [Entities\RulesEngine\Actions\GatewayAccountPick\AcquirerWeights::class],
             [Entities\RulesEngine\Actions\GatewayAccountPick\AccountWeights::class],
+            [Entities\SubscriptionChangeItems::class],
         ];
 
         foreach ($cases as $case) {

tests/Api/ServiceTest.php

@@ -413,6 +413,9 @@ public function subscriptionService()
 
         $result = $service->issueUpcomingInvoice('dummy', 'invoice-1');
         self::assertInstanceOf(Entities\Subscription::class, $result);
+
+        $result = $service->changeItems('dummy', []);
+        self::assertInstanceOf(Entities\Subscription::class, $result);
     }
 
     /**

tests/TestCase.php

@@ -375,6 +375,7 @@ protected function getFakeValue($attribute, $class)
             case 'items':
                 switch ($class) {
                     case Entities\Subscription::class:
+                    case Entities\SubscriptionChangeItems::class:
                         return [
                             ['planId' => 'plan-1', 'quantity' => 1],
                             ['planId' => 'plan-2', 'quantity' => null],