Add failed status for webhooks on the docs (#459)

lob · Aug 30, 2023 · fb20bc6 · fb20bc6
1 parent fa0b2b5
commit fb20bc6
Show file tree

Hide file tree

Showing 9 changed files with 86 additions and 18 deletions.
diff --git a/dist/lob-api-bundled.yml b/dist/lob-api-bundled.yml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Lob
-  version: 1.19.12
+  version: 1.19.13
   description: >
     The Lob API is organized around REST. Our API is designed to have
     predictable, resource-oriented URLs and uses HTTP response codes to indicate
@@ -655,6 +655,11 @@ tags:
           <td style="white-space: nowrap"><code>false</code></td>
           <td style="white-space: nowrap">A postcard receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>postcard.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A postcard receives a "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>postcard.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>
@@ -733,6 +738,11 @@ tags:
           <td style="white-space: nowrap"><code>true</code></td>
           <td style="white-space: nowrap">A self_mailer receives an "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>self_mailer.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A self_mailer receives an "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>self_mailer.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>
@@ -811,6 +821,11 @@ tags:
           <td style="white-space: nowrap"><code>true</code></td>
           <td style="white-space: nowrap">A letter receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>letter.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A letter receives a "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>letter.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>
@@ -964,6 +979,11 @@ tags:
           <td style="white-space: nowrap"><code>true</code></td>
           <td style="white-space: nowrap">A check receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>check.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A check receives a "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>check.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>
@@ -10066,6 +10086,7 @@ components:
         - postcard.rendered_thumbnails
         - postcard.deleted
         - postcard.delivered
+        - postcard.failed
         - postcard.mailed
         - postcard.in_transit
         - postcard.in_local_area
@@ -10083,6 +10104,7 @@ components:
         - self_mailer.rendered_thumbnails
         - self_mailer.deleted
         - self_mailer.delivered
+        - self_mailer.failed
         - self_mailer.mailed
         - self_mailer.in_transit
         - self_mailer.in_local_area
@@ -10100,6 +10122,7 @@ components:
         - letter.rendered_thumbnails
         - letter.deleted
         - letter.delivered
+        - letter.failed
         - letter.mailed
         - letter.in_transit
         - letter.in_local_area
@@ -10134,6 +10157,7 @@ components:
         - check.rendered_thumbnails
         - check.deleted
         - check.delivered
+        - check.failed
         - check.mailed
         - check.in_transit
         - check.in_local_area

diff --git a/docs/index.html b/docs/index.html
diff --git a/lob-api-public.yml b/lob-api-public.yml
@@ -2,7 +2,7 @@ openapi: 3.0.3
 
 info:
   title: Lob
-  version: "1.19.12"
+  version: "1.19.13"
   description: >
     The Lob API is organized around REST. Our API is designed to have predictable,
     resource-oriented URLs and uses HTTP response codes to indicate any API errors.
@@ -551,6 +551,11 @@ tags:
           <td style="white-space: nowrap"><code>false</code></td>
           <td style="white-space: nowrap">A postcard receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>postcard.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A postcard receives a "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>postcard.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>
@@ -627,6 +632,11 @@ tags:
           <td style="white-space: nowrap"><code>true</code></td>
           <td style="white-space: nowrap">A self_mailer receives an "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>self_mailer.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A self_mailer receives an "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>self_mailer.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>
@@ -703,6 +713,11 @@ tags:
           <td style="white-space: nowrap"><code>true</code></td>
           <td style="white-space: nowrap">A letter receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>letter.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A letter receives a "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>letter.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>
@@ -854,6 +869,11 @@ tags:
           <td style="white-space: nowrap"><code>true</code></td>
           <td style="white-space: nowrap">A check receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
         </tr>
+        <tr>
+          <td style="white-space: nowrap"><code>check.failed</code></td>
+          <td style="white-space: nowrap"><code>false</code></td>
+          <td style="white-space: nowrap">A check receives a "Failed" <a href='#operation/tracking_event'>tracking event</a>.</td>
+        </tr>
         <tr>
           <td style="white-space: nowrap"><code>check.re-routed</code></td>
           <td style="white-space: nowrap"><code>true</code></td>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@lob/openapi",
-  "version": "1.19.12",
+  "version": "1.19.13",
   "engines": {
     "node": ">=14.16.0",
     "npm": ">=7.9.0"

diff --git a/resources/events/attributes/check_types.yml b/resources/events/attributes/check_types.yml
@@ -6,6 +6,7 @@ enum:
   - check.rendered_thumbnails
   - check.deleted
   - check.delivered
+  - check.failed
   - check.mailed
   - check.in_transit
   - check.in_local_area

diff --git a/resources/events/attributes/letter_types.yml b/resources/events/attributes/letter_types.yml
@@ -6,6 +6,7 @@ enum:
   - letter.rendered_thumbnails
   - letter.deleted
   - letter.delivered
+  - letter.failed
   - letter.mailed
   - letter.in_transit
   - letter.in_local_area

diff --git a/resources/events/attributes/postcard_types.yml b/resources/events/attributes/postcard_types.yml
@@ -6,6 +6,7 @@ enum:
   - postcard.rendered_thumbnails
   - postcard.deleted
   - postcard.delivered
+  - postcard.failed
   - postcard.mailed
   - postcard.in_transit
   - postcard.in_local_area

diff --git a/resources/events/attributes/self_mailer_types.yml b/resources/events/attributes/self_mailer_types.yml
@@ -6,6 +6,7 @@ enum:
   - self_mailer.rendered_thumbnails
   - self_mailer.deleted
   - self_mailer.delivered
+  - self_mailer.failed
   - self_mailer.mailed
   - self_mailer.in_transit
   - self_mailer.in_local_area