Add docs for the new action archive_package (#34372)

* add docs for the new action archive_package

* lint
This commit is contained in:
Shai Ungar 2024-09-05 10:04:00 +03:00 committed by GitHub
parent 4463c59d26
commit c92ccdf5ea
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -79,7 +79,6 @@ content: >
The `seventeentrack.get_packages` action allows you to query the 17track API for the latest package data.
| Data attribute | Optional | Description |
|------------------------|----------|---------------------------------------------|
| `config_entry_id` | No | The ID of the 17Track service config entry. |
@ -92,3 +91,20 @@ The `seventeentrack.get_packages` action allows you to query the 17track API for
config_entry_id: 2b4be47a1fa7c3764f14cf756dc98991
package_state: ["Delivered", "In transit"]
```
### Action `seventeentrack.archive_package`
The `seventeentrack.archive_package` action allows you to archive a package using the 17track API.
| Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------|
| `config_entry_id` | No | The ID of the 17Track service config entry. |
| `package_tracking_number` | No | The package tracking number. |
```yaml
# Example automation action to archive a package with a tracking number
- action: seventeentrack.archive_package
data:
config_entry_id: 2b4be47a1fa7c3764f14cf756dc98991
package_tracking_number: RU0103445624A
```