CMB-341: docs to support legal letters #481
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
juanfriss
reviewed
Feb 13, 2024
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@lob/openapi", | |||
| "version": "1.19.24", | |||
| "version": "1.19.25", | |||
There was a problem hiding this comment.
do we need to upgrade package-lock.json too?
There was a problem hiding this comment.
Yeah probably. I wasn't sure about committing the package-lock.json too. I'll push it.
juanfriss
reviewed
Feb 13, 2024
|
|
||
| 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. |
There was a problem hiding this comment.
can this be a little bit clearer?
There was a problem hiding this comment.
Suggested change
| 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. | |
| To use `us_legal`, set the [Lob-Version header](#tag/Versioning-and-Changelog) to `2024-01-01`. Do not include neither this attribute nor the header version set to 2024-01-01 if you are not sending a legal letter. |
There was a problem hiding this comment.
@juanfriss updated the verbiage to be less confusing.
juanfriss
approved these changes
Feb 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #<CMB-341>
https://lobsters.atlassian.net/browse/CMB-341
Checklist
mainnpm run bundleoutputs nothing suspectnpm run postmanoutputs nothing suspectChanges
Adds support for legal letters. Legal letters are supported via the
sizeproperty with theLob-Versionheader set to2024-01-01. The following properties are not applicable / available to legal letters.cardsextra_serviceqr_codefscAreas of Concern
First time contributing to the repo. Let me know if I've missed anything.