You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Letter.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
23
23
**send_date** | **datetime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional]
24
24
**extra_service** | **str** | Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. | [optional]
25
25
**tracking_number** | **str, none_type** | The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode. | [optional]
26
-
**tracking_events** | [**[TrackingEventNormal]**](TrackingEventNormal.md) | Tracking events are not populated for registered or regular (no extra service) letters. | [optional]
26
+
**tracking_events** | [**[TrackingEventNormal]**](TrackingEventNormal.md) | An array of tracking_event objects ordered by ascending `time`. Will not be populated for letters created in test mode. | [optional]
27
27
**return_address** | **str** | Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request. | [optional]
**color** | **bool** | Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. | [optional]
send_date (datetime, type(None)): A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. [optional] # noqa: E501
267
267
extra_service (str, type(None)): Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred.. [optional] # noqa: E501
268
268
tracking_number (str, type(None)): The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode.. [optional] # noqa: E501
269
-
tracking_events (list, type(None)): Tracking events are not populated for registered or regular (no extra service) letters.. [optional] # noqa: E501
269
+
tracking_events (list, type(None)): An array of tracking_event objects ordered by ascending `time`. Will not be populated for letters created in test mode.. [optional] # noqa: E501
270
270
return_address (str, AddressEditable, type(None)): Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request.. [optional] # noqa: E501
color (bool, type(None)): Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white.. [optional] # noqa: E501
send_date (datetime, type(None)): A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. [optional] # noqa: E501
389
389
extra_service (str, type(None)): Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred.. [optional] # noqa: E501
390
390
tracking_number (str, type(None)): The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode.. [optional] # noqa: E501
391
-
tracking_events (list, type(None)): Tracking events are not populated for registered or regular (no extra service) letters.. [optional] # noqa: E501
391
+
tracking_events (list, type(None)): An array of tracking_event objects ordered by ascending `time`. Will not be populated for letters created in test mode.. [optional] # noqa: E501
392
392
return_address (str, AddressEditable, type(None)): Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request.. [optional] # noqa: E501
color (bool, type(None)): Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white.. [optional] # noqa: E501
0 commit comments