From 21c54e1c21af09b80dea1622e63c35e67624a01c Mon Sep 17 00:00:00 2001 From: Juan Friss Date: Mon, 11 Mar 2024 23:26:54 +0100 Subject: [PATCH 1/2] updates docs --- docs/Letter.md | 2 +- lob_python/model/letter.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Letter.md b/docs/Letter.md index d890d45..ab4fa71 100644 --- a/docs/Letter.md +++ b/docs/Letter.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes **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] **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] **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] -**tracking_events** | [**[TrackingEventNormal]**](TrackingEventNormal.md) | Tracking events are not populated for registered or regular (no extra service) letters. | [optional] +**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] **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] **mail_type** | [**MailType**](MailType.md) | | [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] diff --git a/lob_python/model/letter.py b/lob_python/model/letter.py index 984dbca..fa913b5 100755 --- a/lob_python/model/letter.py +++ b/lob_python/model/letter.py @@ -388,7 +388,7 @@ def __init__(self, to, _from, date_created, date_modified, id, return_envelope, 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 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 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 - tracking_events (list, type(None)): Tracking events are not populated for registered or regular (no extra service) letters.. [optional] # noqa: E501 + 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 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 mail_type (MailType, type(None)): [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 From 857482dbd875664ef8a09e8c88d5c19ee999860f Mon Sep 17 00:00:00 2001 From: Juan Friss Date: Mon, 11 Mar 2024 23:29:06 +0100 Subject: [PATCH 2/2] another fix --- lob_python/model/letter.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lob_python/model/letter.py b/lob_python/model/letter.py index fa913b5..8fdd017 100755 --- a/lob_python/model/letter.py +++ b/lob_python/model/letter.py @@ -266,7 +266,7 @@ def _from_openapi_data(cls, to, _from, date_created, date_modified, id, return_e 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 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 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 - tracking_events (list, type(None)): Tracking events are not populated for registered or regular (no extra service) letters.. [optional] # noqa: E501 + 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 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 mail_type (MailType, type(None)): [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