Merge pull request #2 from spira/feature/promo-code

Adding preview/promo functionality to subscribe call.
spira · Jun 3, 2016 · 9b7eb9a · 9b7eb9a
2 parents 41b7a39 + 364327a
commit 9b7eb9a
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 4 deletions.
diff --git a/src/DataObjects/Subscription.php b/src/DataObjects/Subscription.php
@@ -26,6 +26,8 @@ class Subscription extends DataObject
  const TERM_TYPE_TERMED = 'TERMED';
  const TERM_TYPE_EVERGREEN = 'EVERGREEN';
 
+ const RENEWAL_SETTING_EVERGREEN = 'RENEW_TO_EVERGREEN';
+
  public static function getDefaultColumns()
  {
  return [

diff --git a/src/Zuora.php b/src/Zuora.php
@@ -285,7 +285,9 @@ public function subscribe(
  ProductRatePlanCharge $ratePlanCharge = null,
  PaymentMethod $paymentMethod = null,
  Contact $contact = null,
- SubscribeOptions $subscribeOptions = null
+ SubscribeOptions $subscribeOptions = null,
+ ProductRatePlan $promoPlan = null,
+ $preview = false
  ) {
  $data = [];
 
@@ -294,7 +296,16 @@ public function subscribe(
  $contact && $data['BillToContact'] = $contact->toArray();
  $subscribeOptions && $data['SubscribeOptions'] = $subscribeOptions->toArray();
 
- $ratePlanData = ['RatePlan' => ['ProductRatePlanId' => $ratePlan['Id']]];
+ $ratePlanData = [];
+ array_push($ratePlanData, [
+ 'RatePlan' => ['ProductRatePlanId' => $ratePlan['Id']]
+ ]);
+ if ($promoPlan) {
+ array_push($ratePlanData, [
+ 'RatePlan' => ['ProductRatePlanId' => $promoPlan['Id']]
+ ]);
+ }
+
  if ($ratePlanCharge) {
  $ratePlanData['RatePlanChargeData'] = [
  ['RatePlanCharge' => ['ProductRatePlanChargeId' => $ratePlanCharge['Id']]],
@@ -306,6 +317,13 @@ public function subscribe(
  'RatePlanData' => $ratePlanData,
  ];
 
+ if ($preview) {
+ $data['PreviewOptions'] = [
+ 'EnablePreviewMode' => true,
+ 'NumberOfPeriods' => 1
+ ];
+ }
+
  return $this->api->subscribe($data);
  }
 

diff --git a/tests/SubscriptionTest.php b/tests/SubscriptionTest.php
@@ -2,6 +2,7 @@
 
 use Spira\ZuoraSdk\DataObjects\Account;
 use Spira\ZuoraSdk\DataObjects\Subscription;
+use Spira\ZuoraSdk\QueryBuilder;
 
 class SubscriptionTest extends TestCase
 {
@@ -61,6 +62,57 @@ public function testSubscribeAndCreateAccount()
  $zuora->getApi()->delete('Account', $result->result->AccountId);
  }
 
+ public function testSubscribePreviewPromotion()
+ {
+ $zuora = $this->getZuora();
+
+ /** @var \Spira\ZuoraSdk\DataObjects\RatePlan $promoRatePlan */
+ $promoRatePlan = current($zuora->getAllProductRatePlans([
+ 'Id',
+ 'Name',
+ 'Description',
+ 'ProductId',
+ 'EffectiveEndDate',
+ 'EffectiveStartDate',
+ 'CreatedById',
+ 'CreatedDate',
+ 'UpdatedById',
+ 'UpdatedDate',
+ 'PromoCode__c'
+ ], 1, function (QueryBuilder $query) {
+ $query->where('PromoCode__c', '=', 'IQSSTAFF');
+ }));
+
+ if (!$promoRatePlan) {
+ $this->markTestSkipped('If you want to run this test please ensure that a discount rate plan exists in Zuora.');
+ }
+
+ $product = $zuora->getOneProduct($promoRatePlan->ProductId);
+
+ $ratePlan = current($zuora->getRatePlansForProduct($product, null, 1));
+
+ if (!$ratePlan) {
+ $this->markTestSkipped('If you want to run this test please ensure that a rate plan exists in Zuora for product ' . $promoRatePlan->ProductId);
+ }
+
+ $account = $this->makeAccount();
+ $contact = $this->makeContact();
+ $subscription = $this->makeSubscription(true);
+
+ try {
+ $result = $zuora->subscribe($account, $subscription, $ratePlan, null, null, $contact, null, $promoRatePlan, true);
+
+ $this->assertNotEmpty($result->result->InvoiceData);
+ $this->assertNotEmpty($result->result->InvoiceData->Invoice);
+ $this->assertNotEmpty($result->result->InvoiceData->InvoiceItem);
+ $this->assertGreaterThanOrEqual(2, count($result->result->InvoiceData->InvoiceItem));
+ } catch (\Exception $e) {
+ print_r($zuora->getApi()->getClient()->__getLastRequest());
+
+ throw $e;
+ }
+ }
+
  public function testGetAllSubscriptions()
  {
  $zuora = $this->getZuora();

diff --git a/tests/support/TestCase.php b/tests/support/TestCase.php
@@ -101,6 +101,8 @@ protected function makeAccount()
  {
  return new Account(
  [
+ 'AccountNumber' => null,
+ 'AutoPay' => false,
  'Batch' => 'Batch1',
  'Status' => Account::STATUS_DRAFT,
  'Currency' => 'AUD',
@@ -137,11 +139,28 @@ protected function makePaymentMethod()
  );
  }
 
- protected function makeSubscription()
+ protected function makeSubscription($termed = false)
  {
+ if ($termed) {
+ $date = Date('Y-m-d');
+
+ return new Subscription(
+ [
+ 'TermType' => Subscription::TERM_TYPE_TERMED,
+ 'InitialTermPeriodType' => 'Day',
+ 'InitialTerm' => 74,
+ 'AutoRenew' => false,
+ 'ContractEffectiveDate' => $date,
+ 'ServiceActivationDate' => $date,
+ 'TermStartDate' => $date,
+ 'RenewalSetting' => Subscription::RENEWAL_SETTING_EVERGREEN
+ ]
+ );
+ }
+
  return new Subscription(
  [
- 'TermType' => Subscription::TERM_TYPE_EVERGREEN,
+ 'TermType' => Subscription::TERM_TYPE_EVERGREEN
  ]
  );
  }