Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added rejected event to docs #506

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36,484 changes: 17,010 additions & 19,474 deletions dist/lob-api-bundled.yml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/lob-api-postman.json

Large diffs are not rendered by default.

22 changes: 21 additions & 1 deletion docs/index.html

Large diffs are not rendered by default.

24 changes: 22 additions & 2 deletions lob-api-public.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3

Check warning on line 1 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

oas3-valid-media-example

This format violates OpenAPI 3.1 rules
info:
title: Lob
version: 1.19.41
version: 1.19.42
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. <p>
license:
Expand Down Expand Up @@ -492,6 +492,11 @@
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard was not successfully created (Usually happens when one or more postcards fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
Expand Down Expand Up @@ -572,6 +577,11 @@
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer was not successfully created (Usually happens when one or more self_mailers fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
Expand Down Expand Up @@ -653,6 +663,11 @@
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter was not successfully created (Usually happens when one or more letters fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
Expand Down Expand Up @@ -810,6 +825,11 @@
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check was not successfully created (Usually happens when one or more checks fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
Expand Down Expand Up @@ -914,7 +934,7 @@
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Getting Started
x-traitTag: true
description: |

Check warning on line 937 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

no-script-tags-in-markdown

Markdown descriptions must not have "<script>" tags.
### 1. Get Setup
* Create an account at <a href="https://dashboard.lob.com/#/register" target="_blank">Lob.com</a>
* Obtain your API keys in the Lob dashboard <a href="https://dashboard.lob.com/settings/api-keys" target="_blank">settings</a>
Expand Down Expand Up @@ -1163,7 +1183,7 @@
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: QR Codes
description: |

Lob QR codes allow you to generate a QR code that is unique to each mailpiece, thereby allowing each and every customers to receive a personalized link. See the Create endpoint for <a href="#tag/Letters/operation/letter_create">Letters</a>, <a href="#tag/Postcards/operation/postcard_create">Postcards</a> or <a href="#tag/Self-Mailers/operation/self_mailer_create">Self Mailers</a> to learn how to embed a QR code into your mail piece.

Webhooks can be used to integrate Lob QR code scans into your omni channel marketing strategy. See the <a href="#tag/Webhooks">Webhooks</a> section of our documentation to learn how to enable the `letter.viewed`, `postcard.viewed` and `self_mailer.viewed` event notifications for your mail pieces.
Expand Down
20 changes: 14 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lob/openapi",
"version": "1.19.41",
"version": "1.19.42",
"engines": {
"node": ">=14.16.0",
"npm": ">=7.9.0"
Expand Down Expand Up @@ -106,7 +106,7 @@
"mini-css-extract-plugin": "^2.6.0",
"openapi-to-postmanv2": "^3.2.0",
"prettier": "^2.6.2",
"redoc-cli": "^0.13.16",
"redoc-cli": "^0.13.21",
"sass": "^1.52.1",
"sass-loader": "^13.0.0",
"uuid": "^8.3.2",
Expand Down
1 change: 1 addition & 0 deletions resources/events/attributes/check_types.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ type: string
description: Unique identifier referring to status of check
enum:
- check.created
- check.rejected
- check.rendered_pdf
- check.rendered_thumbnails
- check.deleted
Expand Down
1 change: 1 addition & 0 deletions resources/events/attributes/letter_types.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ type: string
description: Unique identifier referring to status of letter
enum:
- letter.created
- letter.rejected
- letter.rendered_pdf
- letter.rendered_thumbnails
- letter.deleted
Expand Down
1 change: 1 addition & 0 deletions resources/events/attributes/postcard_types.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ type: string
description: Unique identifier referring to status of postcard
enum:
- postcard.created
- postcard.rejected
- postcard.rendered_pdf
- postcard.rendered_thumbnails
- postcard.deleted
Expand Down
1 change: 1 addition & 0 deletions resources/events/attributes/self_mailer_types.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ type: string
description: Unique identifier referring to status of self mailer
enum:
- self_mailer.created
- self_mailer.rejected
- self_mailer.rendered_pdf
- self_mailer.rendered_thumbnails
- self_mailer.deleted
Expand Down
Loading