From dff6d42e2c532148147cbd9810446a7737742eae Mon Sep 17 00:00:00 2001
From: Jesse Rosalia <jar@stripe.com>
Date: Mon, 7 Oct 2024 10:53:06 -0700
Subject: [PATCH 1/3] renamed NewExample to ExampleTemplate and added comments
 added file comments to other examples renamed stripe_webhook_handler to
 ThinEventWebhookHandler for clarity

---
 examples/ExampleTemplate.php                  | 40 +++++++++++++++++++
 examples/MeterEventStream.php                 | 12 ++++++
 examples/NewExample.php                       | 26 ------------
 examples/README.md                            | 11 +++--
 ...andler.php => ThinEventWebhookHandler.php} |  9 +++++
 5 files changed, 69 insertions(+), 29 deletions(-)
 create mode 100644 examples/ExampleTemplate.php
 delete mode 100644 examples/NewExample.php
 rename examples/{stripe_webhook_handler.php => ThinEventWebhookHandler.php} (70%)

diff --git a/examples/ExampleTemplate.php b/examples/ExampleTemplate.php
new file mode 100644
index 000000000..295d6ed8f
--- /dev/null
+++ b/examples/ExampleTemplate.php
@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * This is a template for defining new examples.  It is not intended to be used directly.
+ *
+ * <describe what this example does>
+ *
+ * In this example, we:
+ *   - <key step 1>
+ *   - <key step 2
+ *   - ...
+ *
+ * <describe assumptions about the user's stripe account, environment, or configuration;
+ * or things to watch out for when running>
+ */
+require 'vendor/autoload.php'; // Make sure to include Composer's autoload file
+// Use this require statement to import the SDK from this repo folder
+// require '../init.php';
+
+class ExampleTemplate
+{
+    private $apiKey;
+
+    public function __construct($apiKey)
+    {
+        $this->apiKey = $apiKey;
+    }
+
+    public function doSomethingGreat()
+    {
+        echo "Hello World\n";
+        // $client = new \Stripe\StripeClient($this->apiKey);
+    }
+}
+
+// Usage
+$apiKey = '{{API_KEY}}';
+
+$example = new ExampleTemplate($apiKey);
+$example->doSomethingGreat();
diff --git a/examples/MeterEventStream.php b/examples/MeterEventStream.php
index cce30a0d6..ef2c663b8 100644
--- a/examples/MeterEventStream.php
+++ b/examples/MeterEventStream.php
@@ -1,5 +1,17 @@
 <?php
 
+/**
+ * Use the high-throughput MeterEventStream to report create billing meter events.
+ *
+ * In this example, we:
+ *   - create a meter event session and store the session's authentication token
+ *   - define an event with a payload
+ *   - use the meterEventStream service to create an event stream that reports this event
+ *
+ * This example expects a billing meter with an event_name of 'alpaca_ai_tokens'.  If you have
+ * a different meter event name, you can change it before running this example.
+ */
+
 require 'vendor/autoload.php'; // Make sure to include Composer's autoload file
 
 class MeterEventStream
diff --git a/examples/NewExample.php b/examples/NewExample.php
deleted file mode 100644
index bde7007dc..000000000
--- a/examples/NewExample.php
+++ /dev/null
@@ -1,26 +0,0 @@
-<?php
-
-require 'vendor/autoload.php'; // Make sure to include Composer's autoload file
-//require '../init.php';
-
-class NewExample
-{
-    private $apiKey;
-
-    public function __construct($apiKey)
-    {
-        $this->apiKey = $apiKey;
-    }
-
-    public function doSomethingGreat()
-    {
-        echo "Hello World\n";
-        // $client = new \Stripe\StripeClient($this->apiKey);
-    }
-}
-
-// Usage
-$apiKey = '{{API_KEY}}';
-
-$example = new NewExample($apiKey);
-$example->doSomethingGreat();
diff --git a/examples/README.md b/examples/README.md
index 8ba8046cb..a3346621b 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -3,9 +3,14 @@
 From the examples folder, run:
 `php your_example.php`
 
+e.g.
+
+`php ThinEventWebhookHandler.php`
+
 ## Adding a new example
 
-1. Clone new_example.php
+1. Clone ExampleTemplate.php
 2. Implement your example
-3. Run it (as per above)
-4. 👍
+3. Fill out the comment at the top with a description and key steps that are being demonstrated
+4. Run it (as per above)
+5. 👍
diff --git a/examples/stripe_webhook_handler.php b/examples/ThinEventWebhookHandler.php
similarity index 70%
rename from examples/stripe_webhook_handler.php
rename to examples/ThinEventWebhookHandler.php
index b81ae2414..e1a3f87c1 100644
--- a/examples/stripe_webhook_handler.php
+++ b/examples/ThinEventWebhookHandler.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * Receive and process thin events like the v1.billing.meter.error_report_triggered event.
+ *
+ * In this example, we:
+ *   - use parseThinEvent to parse the received thin event webhook body
+ *   - call StripeClient.v2.core.events.retrieve to retrieve the full event object
+ *   - if it is a V1BillingMeterErrorReportTriggeredEvent event type, call fetchRelatedObject
+ *     to retrieve the Billing Meter object associated with the event.
+ */
 require 'vendor/autoload.php';
 
 $api_key = getenv('STRIPE_API_KEY');

From 3164ef26f310d064663654789397e9368a793da5 Mon Sep 17 00:00:00 2001
From: Jesse Rosalia <jar@stripe.com>
Date: Mon, 7 Oct 2024 12:43:57 -0700
Subject: [PATCH 2/3] removed blank line after phpdoc

---
 examples/MeterEventStream.php | 1 -
 1 file changed, 1 deletion(-)

diff --git a/examples/MeterEventStream.php b/examples/MeterEventStream.php
index ef2c663b8..84a6b0711 100644
--- a/examples/MeterEventStream.php
+++ b/examples/MeterEventStream.php
@@ -11,7 +11,6 @@
  * This example expects a billing meter with an event_name of 'alpaca_ai_tokens'.  If you have
  * a different meter event name, you can change it before running this example.
  */
-
 require 'vendor/autoload.php'; // Make sure to include Composer's autoload file
 
 class MeterEventStream

From 2333c74eba09d4ecd89b7ccaa4b1e0bdbea0021c Mon Sep 17 00:00:00 2001
From: Jesse Rosalia <jar@stripe.com>
Date: Mon, 7 Oct 2024 17:07:19 -0700
Subject: [PATCH 3/3] changed verbiage in readme

---
 examples/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/examples/README.md b/examples/README.md
index a3346621b..ab6e9b736 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -11,6 +11,6 @@ e.g.
 
 1. Clone ExampleTemplate.php
 2. Implement your example
-3. Fill out the comment at the top with a description and key steps that are being demonstrated
+3. Fill out the file comment. Include a description and key steps that are being demonstrated.
 4. Run it (as per above)
 5. 👍