Merge pull request #29 from duffelhq/jc/docs-add-return-example

docs: Add return example

.github/workflows/examples.yml

@@ -42,8 +42,11 @@ jobs:
       - name: Run exploring data example
         run: php ./examples/exploring-data.php
 
-      - name: Run search and book example
-        run: php ./examples/search-and-book.php
+      - name: Run search and book example (one way)
+        run: php ./examples/search-and-book-one-way.php
+
+      - name: Run search and book example (return)
+        run: php ./examples/search-and-book-return.php
 
       - name: Run book and change example
         run: php ./examples/book-and-change.php

examples/search-and-book.php → examples/search-and-book-one-way.php

@@ -6,7 +6,7 @@
 
 use Duffel\Client;
 
-echo "Duffel Flights API - search and book example\n";
+echo "Duffel Flights API - search and book (one way) example\n";
 $start = time();
 
 $client = new Client();
@@ -15,14 +15,14 @@
 $departureDate = (new DateTime)->add(new DateInterval("P10D"))->format('Y-m-d');
 
 $offerRequest = $client->offerRequests()->create(
-  "economy", 
+  "economy",
   array(
     array("type" => "adult")
   ),
   array(
     array(
       "origin" => "LHR",
-      "destination" => "STN", 
+      "destination" => "STN",
       "departure_date" => $departureDate
     )
   )

examples/search-and-book-return.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Duffel\Client;
+
+echo "Duffel Flights API - search and book (return) example\n";
+$start = time();
+
+$client = new Client();
+$client->setAccessToken(getenv('DUFFEL_ACCESS_TOKEN'));
+
+$departureDate_1 = (new DateTime)->add(new DateInterval("P10D"))->format('Y-m-d');
+$departureDate_2 = (new DateTime)->add(new DateInterval("P14D"))->format('Y-m-d');
+
+$offerRequest = $client->offerRequests()->create(
+  "economy",
+  array(
+    array("type" => "adult")
+  ),
+  array(
+    array(
+      "origin" => "LHR",
+      "destination" => "STN",
+      "departure_date" => $departureDate_1
+    ),
+    array(
+      "origin" => "STN",
+      "destination" => "LHR",
+      "departure_date" => $departureDate_2
+    )
+  )
+);
+
+echo sprintf("Created offer request: %s\n", $offerRequest["id"]);
+
+$offers = $client->offers()->all($offerRequest["id"]);
+
+echo sprintf("Got %s offers\n", count($offers));
+
+$selectedOffer = array_shift($offers);
+
+echo sprintf("Selected offer %s to book\n", $selectedOffer["id"]);
+
+$pricedOffer = $client->offers()->show($selectedOffer["id"], true);
+
+echo sprintf("The final price for offer %s is %s (%s)\n", $pricedOffer["id"],
+  $pricedOffer["total_amount"],
+  $pricedOffer["total_currency"]
+);
+
+$availableService = array_shift($pricedOffer["available_services"]);
+
+echo sprintf("Adding an extra bag with service %s costing %s (%s)\n", $availableService["id"],
+  $availableService["total_amount"],
+  $availableService["total_currency"],
+);
+
+$totalAmount = round(($pricedOffer["total_amount"] + $availableService["total_amount"]), 2);
+
+echo sprintf("Total amount is %s\n", $totalAmount);
+
+$order = $client->orders()->create(array(
+  "selected_offers" => array($pricedOffer["id"]),
+  "services" => array(
+    array(
+      "id" => $availableService["id"],
+      "quantity" => 1,
+    )
+  ),
+  "payments" => array(
+    array(
+      "type" => "balance",
+      "amount" => $totalAmount,
+      "currency" => $pricedOffer["total_currency"]
+    )
+  ),
+  "passengers" => array(
+    array(
+      "id" => $pricedOffer["passengers"][0]["id"],
+      "title" => "mr",
+      "gender" => "m",
+      "given_name" => "Zepp",
+      "family_name" => "Lin",
+      "born_on" => "1990-01-26",
+      "phone_number" => "+441234567890",
+      "email" => "z.e.l@zeppelin.aero",
+    )
+  )
+));
+
+echo sprintf("Created order %s with booking reference %s\n", $order["id"], $order["booking_reference"]);
+
+$orderCancellation = $client->orderCancellations()->create($order["id"]);
+
+echo sprintf("Requested refund quote for order %s – %s (%s) is available\n", $order["id"], $orderCancellation["refund_amount"], $orderCancellation["refund_currency"]);
+
+$client->orderCancellations()->confirm($orderCancellation["id"]);
+
+echo sprintf("Confirmed refund quote for order %s\n", $order["id"]);
+
+$finish = time();
+echo sprintf("Finished in %d seconds.\n", ($finish - $start));