Skip to content

Commit

Permalink
CMB-341: docs to support legal letters
Browse files Browse the repository at this point in the history
  • Loading branch information
sachinmurali committed Feb 12, 2024
1 parent be08aef commit 6fec094
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 22 deletions.
36 changes: 19 additions & 17 deletions docs/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion 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.24
version: 1.19.25
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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lob/openapi",
"version": "1.19.24",
"version": "1.19.25",
"engines": {
"node": ">=14.16.0",
"npm": ">=7.9.0"
Expand Down
2 changes: 2 additions & 0 deletions resources/letters/attributes/extra_service.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ description: |
* `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: <a href="https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf" target="_blank">#10 envelope</a> and <a href="https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf" target="_blank">flat envelope</a> (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet.
* `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter
* `registered` - provides tracking and confirmation for international addresses
Not available for `us_legal` letter size.
nullable: true
10 changes: 10 additions & 0 deletions resources/letters/attributes/ltr_size.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
type: string

enum:
- us_legal

description: >
Specifies the size of the letter. Currently only applicable for legal letters.
To use `us_legal`, set the [Lob-Version header](#tag/Versioning-and-Changelog) to `2024-01-01`. Do not include this attribute as well the header version set to 2024-01-01 if you are not sending a legal letter.
default: us_legal
7 changes: 5 additions & 2 deletions resources/letters/models/letter_editable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ allOf:
$ref: "../attributes/extra_service.yml"

cards:
description: A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information.
description: A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. Not available for `us_legal` letter size.
type: array
items:
$ref: "../../../shared/attributes/model_ids/card_id.yml"
Expand Down Expand Up @@ -69,5 +69,8 @@ allOf:

fsc:
type: boolean
description: This is in beta. Contact [email protected] or your account contact to learn more. Not available for `A4` letter size.
description: This is in beta. Contact [email protected] or your account contact to learn more. Not available for `A4` and `us_legal` letter size.
default: false

size:
$ref: "../attributes/ltr_size.yml"
2 changes: 1 addition & 1 deletion shared/models/qr_code.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
type: object
description: Customize and place a QR code on the creative at the required position.
description: Customize and place a QR code on the creative at the required position. Not available for `us_legal` letter size.
required:
- position
- redirect_url
Expand Down

0 comments on commit 6fec094

Please sign in to comment.