-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CMB-341: docs to support legal letters
- Loading branch information
1 parent
be08aef
commit 6fec094
Showing
7 changed files
with
39 additions
and
22 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
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
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 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
|
@@ -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" |
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