Updates to quickstart

Added updates to the readMe, updated outputs to user on successful methods. Added updated sdk version

Author: canderson1538

.gitignore

@@ -0,0 +1,2 @@
+
+*.pem

README.md

@@ -31,25 +31,51 @@ Make sure that the file has `extension="grpc.so"` and  add the line if it doesn'
 
 For detailed steps visit the [gRPC PHP quickstart](https://grpc.io/docs/languages/php/quickstart/).
 
-2. In the certs folder of the repository add the following three PassKit credential files:
+2. Add bindings to composer
+To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
+
+```json
+{
+  "repositories": [
+    {
+      "type": "git",
+      "url": "https://github.com/passkit/passkit-php-grpc-sdk.git"
+    }
+  ],
+  "require": {
+    "passkit/passkit-php-grpc-sdk": "1.1.70"
+  }
+}
+```
+
+Then run `composer install`
+
+Manual Installation
+Clone the repo and include `autoload.php`:
+
+```php
+require_once('/path/to/passkit-php-grpc-sdk/vendor/autoload.php');
+```
+
+3. In the certs folder of the repository add the following three PassKit credential files:
     - certificate.pem
     - ca-chain.pem
     - key.pem
 
     You can disregard the key-java.pem credentials file as it is not compatible with PHP.
 
-3. Now we need to decrypt your `key.pem`. At your project root directory, run `cd ./certs`  `openssl ec -in key.pem -out key.pem`.
+4. Now we need to decrypt your `key.pem`. At your project root directory, run `cd ./certs`  `openssl ec -in key.pem -out key.pem`.
 ![ScreenShot](images/decrypt-key.png)
 For the password use the one-time password that you used for generating the SDK credentials.
 
 Your `key.pem` file should look like below.
    ![ScreenShot](images/decrypted-key.png)
    If you do not see `Proc-Type: 4,ENCEYPTED` on line 2, you have successfully decrypted `key.pem`.
 
-4. Modify the variables with the values for your programs or campaigns in each of the membership, coupons and flights methods. The variables to  modify will be at the top of each method.
+5. Modify the variables with the values for your programs or campaigns in each of the membership, coupons and flights methods. The variables to  modify will be at the top of each method.
 ![ScreenShot](images/variables.png)
 
-5. To run each method go into the directory, for  members `cd membership`, for coupons `cd coupons` and for flights `cd flights`. Then run php plus the name of the method e.g. `php enrol-member.php` to run that method.
+6. To run each method go into the directory, for  members `cd membership`, for coupons `cd coupons` and for flights `cd flights`. Then run php plus the name of the method e.g. `php enrol-member.php` to run that method.
 
 ## Examples
 ###  Membership Cards

composer.json

@@ -21,29 +21,27 @@
         {
             "type": "git",
             "url": "https://github.com/passkit/passkit-php-grpc-sdk.git"
-        },
-        {
-            "type": "vcs",
-            "url": "https://github.com/stanley-cheung/Protobuf-PHP"
         }
     ],
     "require": {
         "grpc/grpc": "^v1.42.0",
-        "google/protobuf": "^v3.13.0",
-        "passkit/passkit-php-grpc-sdk": "1.0.0",
-        "zircote/swagger-php": "^4.4",
-        "protobuf-php/protobuf": "^0.1.3"
+        "google/protobuf": "^v3.21.7",
+        "passkit/passkit-php-grpc-sdk": "1.1.70"
     },
     "autoload": {
         "psr-4": {
             "Analytics\\": "lib/Analytics",
             "Cabin_codes\\": "lib/Cabin_codes",
+            "Ct\\": "lib/Ct",
             "Event_tickets\\": "lib/Event_tickets",
             "Flights\\": "lib/Flights",
             "Io\\": "lib/Io",
             "Members\\": "lib/Members",
+            "Raw\\": "lib/Raw",
+            "Scheduler\\": "lib/Scheduler",
             "Single_use_coupons\\": "lib/Single_use_coupons",
             "GPBMetadata\\Io\\": "lib/GPBMetadata/Io",
+            "GPBMetadata\\Ct\\": "lib/GPBMetadata/Ct",
             "GPBMetadata\\Google\\": "lib/extra/GPBMetadata/Google",
             "Google\\Api\\": "lib/extra/google/api"
         }

coupons/count-coupons.php

@@ -1,14 +1,11 @@
 <?php
-
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 
 // MODIFY WITH THE VARIABLES OF YOUR CAMPAIGN AND OFFER
-$campaignId = "05faUsEvatLifOwxKWmS0Q";
-$offerId = "base";
+$campaignId = "";
+$offerId = "";
 // count-coupons takes search conditions as pagination object and returns the number of coupons who match with the condition.
 try {
     $ca_filename = "ca-chain.pem";
@@ -28,19 +25,22 @@
     // Set the coupon list request body
     $listRequest = new Single_use_coupons\ListRequest();
     $listRequest->setCouponCampaignId($campaignId);
-    $filter = new Io\Filter();
+    $filter = new Io\FieldFilter();
     $filter->setFilterField("offerId");
     $filter->setFilterValue($offerId);
     $filter->setFilterOperator("eq");
-    $listRequest->setFilters($filter);
+    $filterGroup = new Io\FilterGroup();
+    $filterGroup->setFieldFilters([$filter]);
+    $filters = new Io\Filters();
+    $filters->setFilterGroups([$filterGroup]);
+    $listRequest->setFilters($filters);
 
 
-    list($id, $status) = $client->countCouponsByCouponCampaign($listRequest)->wait();
+    list($result, $status) = $client->countCouponsByCouponCampaign($listRequest)->wait();
     if ($status->code !== 0) {
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
-
-    echo $result->getId() . "/n";
+    echo  "Number of coupons " . $result->getTotal() . "\n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/create-campaign.php

@@ -1,6 +1,4 @@
 <?php
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
@@ -24,14 +22,14 @@
     // Set the campaign body
     $campaign = new Single_use_coupons\CouponCampaign();
     $campaign->setName("Quickstart Campaign");
-    $campaign->setStatus(1, 4);
+    $campaign->setStatus([1, 4]);
 
     list($id, $status) = $client->createCouponCampaign($campaign)->wait();
     if ($status->code !== 0) {
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
     //You can use the campaignId displayed below for other coupon methods
-    echo "CampaignId" . $campaign->getId() . "\n";
+    echo "CampaignId " . $id->getId() . "\n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/create-coupon.php

@@ -1,15 +1,12 @@
 <?php
-
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 
 // MODIFY WITH THE VARIABLES OF YOUR CAMPAIGN, OFFER AND EMAIL
-$campaignId = "05faUsEvatLifOwxKWmS0Q";
-$offerId = "base";
-$email = "[email protected]";
+$campaignId = "";
+$offerId = "";
+$email = "";
 // create-coupon takes campaignId, offerId and couponDetails, creates a new coupon record, and sends a welcome email to deliver coupon card url.
 // The method returns the coupon id. Coupon id is a part of card url.
 
@@ -47,8 +44,7 @@
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
     //You can use the couponId displayed below for other coupon methods
-    echo "https://pub1.pskt.io/" . $id->getId() . "\n";
-    echo "CouponId" . $coupon->getId() . "\n";
+    echo "Coupon URL: https://pub1.pskt.io/" . $id->getId() . "\n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/create-offer.php

@@ -1,11 +1,13 @@
 <?php
 
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
+use Google\Protobuf\Timestamp;
+
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 // create-offer takes a campaignId of an existing campaign, creates a new template (based of default template), creates an offer, and links this offer to the campaign.
 // The method returns the offer id.
+$campaignId = "";
 try {
     $ca_filename = "ca-chain.pem";
     $key_filename = "key.pem";
@@ -32,44 +34,45 @@
     $defaultTemplateRequest = new Io\DefaultTemplateRequest();
     $defaultTemplateRequest->setProtocol(101);
     $defaultTemplateRequest->setRevision(1);
-    $defaultPassTemplate = new Io\PassTemplate();
-
-    $defaultPassTemplate->$templatesclient->getDefaultTemplate($defaultTemplateRequest)->wait();
+    list($defaultPassTemplate, $status) = $templatesclient->getDefaultTemplate($defaultTemplateRequest)->wait();
     if ($status->code !== 0) {
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
-
     // If you use the default template, you need to set name, description and timezone because these fields are mandatory.
     $defaultPassTemplate->setName("Quickstart");
     $defaultPassTemplate->setDescription("quick start sample template");
     $defaultPassTemplate->setTimezone("America/New_York");
 
 
-    list($id, $status) = $templatesclient->createTemplate($defaultPassTemplate)->wait();
+    list($template, $status) = $templatesclient->createTemplate($defaultPassTemplate)->wait();
     if ($status->code !== 0) {
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
 
-
     // Set the offer body
     $offer = new Single_use_coupons\CouponOffer();
     $offer->setId("base");
-    $offer->setBeforeRedeemPassTemplateId($defaultPassTemplate->getId());
+    $offer->setCampaignId($campaignId);
+    $offer->setBeforeRedeemPassTemplateId($template->getId());
     $offer->setOfferTitle("BaseOffer");
     $offer->setOfferShortTitle("BaseOffer");
     $offer->setOfferDetails("Base offer");
-    $startdate = new DateTime();
-    $enddate = new DateTime();
-    $enddate->setDate(2022, 6, 28);
-    $offer->setIssueStartDate($startdate->getTimestamp());
-    $offer->setIssueEndDate($enddate->getTimestamp());
+    $date = new DateTime();
+    $date->setDate(2023, 6, 24);
+    $startdate = new Timestamp();
+    $startdate->setSeconds($date->getTimestamp());
+    $enddate = new Timestamp();
+    $date->setDate(2023, 6, 28);
+    $enddate->setSeconds($date->getTimestamp());
+    $offer->setIssueStartDate($startdate);
+    $offer->setIssueEndDate($enddate);
 
     list($id, $status) = $client->createCouponOffer($offer)->wait();
     if ($status->code !== 0) {
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
     //You can use the offerId displayed below for other coupon methods
-    echo "OfferId" . $offer->getId() . "\n";
+    echo "Offer created: " . $offer->getId() . "\n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/delete-campaign.php

@@ -1,12 +1,10 @@
 <?php
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 
 // MODIFY WITH THE VARIABLES OF YOUR CAMPAIGN, OFFER AND COUPON
-$campaignId = "05faUsEvatLifOwxKWmS0Q";
+$campaignId = "";
 // delete-campaign takes the campaignId to delete an existing campaign.
 try {
     $ca_filename = "ca-chain.pem";
@@ -31,6 +29,7 @@
     if ($status->code !== 0) {
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
+    echo "Campaign deleted. \n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/get-single-coupon.php

@@ -1,13 +1,11 @@
 <?php
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 
 // MODIFY WITH THE VARIABLES OF YOUR CAMPAIGN, OFFER AND COUPON
-$campaignId = "05faUsEvatLifOwxKWmS0Q";
-$offerId = "base";
+$campaignId = "";
+$offerId = "";
 $couponId = "";
 
 // get-single-coupon takes couponId and returns the record of that coupon.
@@ -35,7 +33,7 @@
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
 
-    echo $result->getId() . "/n";
+    echo "Coupon Status: " . $id->getStatus() . "\n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/list-coupons.php

@@ -1,13 +1,10 @@
 <?php
-
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 
 // MODIFY WITH THE VARIABLES OF YOUR CAMPAIGN, OFFER AND COUPON
-$campaignId = "05faUsEvatLifOwxKWmS0Q";
+$campaignId = "";
 
 // list-coupons takes search conditions as pagination object and returns list of coupon records which match with the conditions.
 try {
@@ -35,7 +32,7 @@
         echo $coupon->getId() . "\n";
     }
 
-    echo $result->getId() . "/n";
+    echo "/n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/redeem-coupon.php

@@ -1,13 +1,10 @@
 <?php
-
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 
 // MODIFY WITH THE VARIABLES OF YOUR CAMPAIGN, OFFER AND COUPON
-$campaignId = "05faUsEvatLifOwxKWmS0Q";
+$campaignId = "";
 $couponId = "";
 
 // redeem-coupon takes a campaignId of an existing campaign, and couponId of existing coupon to redeem that coupon.
@@ -38,7 +35,7 @@
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
 
-    echo $result->getId() . "/n";
+    echo "Coupon: " . $id->getId() . " has been redeemed. \n";
 } catch (Exception $e) {
     echo $e;
 }

coupons/update-coupon.php

@@ -1,13 +1,10 @@
 <?php
-
-
-require_once "../vendor/passkit/passkit-php-grpc-sdk/lib/extra/google/api/";
 require_once "../vendor/autoload.php";
 
 putenv("GRPC_SSL_CIPHER_SUITES=HIGH+ECDSA");
 
 // MODIFY WITH THE VARIABLES OF YOUR CAMPAIGN, OFFER AND COUPON
-$campaignId = "05faUsEvatLifOwxKWmS0Q";
+$campaignId = "";
 $couponId = "";
 
 // update-coupon takes a campaignId of an existing campaign and couponId of existing coupon to update that coupon.
@@ -40,7 +37,7 @@
         throw new Exception(sprintf('Status Code: %s, Details: %s, Meta: %s', $status->code, $status->details, var_dump($status->metadata)));
     }
 
-    echo $result->getId() . "/n";
+    echo "Coupon: " . $id->getId() . " has been updated. \n";
 } catch (Exception $e) {
     echo $e;
 }