Added a test case and documentation

This commit is contained in:
Liam Steckler
2021-11-17 17:16:12 -08:00
parent b6309da893
commit 13ff67f12c
2 changed files with 8 additions and 1 deletions

View File

@@ -11,6 +11,7 @@ TEST_CASES = {
"City Hall": {"street_address": "600 4th Ave"},
"Ballard Builders": {"street_address": "7022 12th Ave NW"},
"Carmona Court": {"street_address": "1127 17th Ave E"},
"2111 E John St": {"street_address":"2111 E John St","prem_code": "DRMGcnGxUEg+gu8pN8vesQ=="}
}

View File

@@ -10,6 +10,7 @@ waste_collection_schedule:
- name: seattle_gov
args:
street_address: STREET_ADDRESS
prem_code: PREM_CODE
```
### Configuration Variables
@@ -17,6 +18,9 @@ waste_collection_schedule:
**street_address**<br>
*(string) (required)*
**prem_code**<br>
*(string) (optional)*
## Example
```yaml
@@ -29,4 +33,6 @@ waste_collection_schedule:
## How to get the source argument
The source argument is simply the house mailing address. Road type (eg. St, Ave) and cardinal direction if applicable (eg. N/S/NW) are required, so "501 23rd Ave" and "501 23rd Ave E" will give different results.
The street_address argument is simply the house mailing address. Road type (eg. St, Ave) and cardinal direction if applicable (eg. N/S/NW) are required, so "501 23rd Ave" and "501 23rd Ave E" will give different results.
If the service cannot be identified based on street address alone (in some multi-family houses, etc), a `prem_code` can be extracted by inspecting the "findAccount" call when looking up your service on the Collection Calendar.