diff --git a/docs/0.0.0/vf-admin.md b/docs/0.0.0/vf-admin.md index 374c891..29763ce 100644 --- a/docs/0.0.0/vf-admin.md +++ b/docs/0.0.0/vf-admin.md @@ -13,7 +13,9 @@ vf-admin is a CLI to manage vaccine availabilities and other data for the Vaccin * [vf-admin address](vf-admin_address.md) - Manage addresss * [vf-admin configure](vf-admin_configure.md) - Configure a named profile with credentials +* [vf-admin location](vf-admin_location.md) - Manage locations * [vf-admin organization](vf-admin_organization.md) - Manage organizations * [vf-admin requirement](vf-admin_requirement.md) - Manage requirements +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities * [vf-admin version](vf-admin_version.md) - Returns the current version of the CLI diff --git a/docs/0.0.0/vf-admin_location.md b/docs/0.0.0/vf-admin_location.md new file mode 100644 index 0000000..277273c --- /dev/null +++ b/docs/0.0.0/vf-admin_location.md @@ -0,0 +1,25 @@ +## vf-admin location + +Manage locations + +### Options + +``` + -h, --help help for location +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin](vf-admin.md) - vf-admin is a CLI to manage vaccine availabilities and other data for the Vaccine Hunters Finder tool. +* [vf-admin location add](vf-admin_location_add.md) - Add a new location +* [vf-admin location get](vf-admin_location_get.md) - Retrieve a location with a specified id +* [vf-admin location list](vf-admin_location_list.md) - Retrieve a list of locations +* [vf-admin location remove](vf-admin_location_remove.md) - Remove a location with a specified id +* [vf-admin location update](vf-admin_location_update.md) - Update a location with a specified id + diff --git a/docs/0.0.0/vf-admin_location_add.md b/docs/0.0.0/vf-admin_location_add.md new file mode 100644 index 0000000..0efdc23 --- /dev/null +++ b/docs/0.0.0/vf-admin_location_add.md @@ -0,0 +1,41 @@ +## vf-admin location add + +Add a new location + +``` +vf-admin location add [flags] +``` + +### Examples + +``` +# Add a new active location with name "Guelph Hospital", postal code "N1E 4J4", website URL "http://www.gghorg.ca/", phone "(519) 822-5350", notes "Please call ahead to make an appointment.", tags "Guelph, Appointment", organization id 23 and address id 352. +$ vf-admin location add --active 1 --name "Guelph Hospital" --postcode "N1E4J4" --url "http://www.gghorg.ca" --phone "(519) 822-5350" --notes "Please call ahead to make an appointment." --tags "Guelph, Appointment" --organization 23 --address 352 + +``` + +### Options + +``` + --active int is this location active? 1 or 0 (default 1) + --address int id of address of location + -h, --help help for add + --name string name of location + --notes string notes about location + --organization int id of organization running location + --phone string phone number of location + --postcode string postal code of location + --tags string search tags of location + --url string website URL of location +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin location](vf-admin_location.md) - Manage locations + diff --git a/docs/0.0.0/vf-admin_location_get.md b/docs/0.0.0/vf-admin_location_get.md new file mode 100644 index 0000000..6068f48 --- /dev/null +++ b/docs/0.0.0/vf-admin_location_get.md @@ -0,0 +1,32 @@ +## vf-admin location get + +Retrieve a location with a specified id + +``` +vf-admin location get [flags] +``` + +### Examples + +``` +# Get the location with id 1. +$ vf-admin location get 1 + +``` + +### Options + +``` + -h, --help help for get +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin location](vf-admin_location.md) - Manage locations + diff --git a/docs/0.0.0/vf-admin_location_list.md b/docs/0.0.0/vf-admin_location_list.md new file mode 100644 index 0000000..df83645 --- /dev/null +++ b/docs/0.0.0/vf-admin_location_list.md @@ -0,0 +1,24 @@ +## vf-admin location list + +Retrieve a list of locations + +``` +vf-admin location list [flags] +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin location](vf-admin_location.md) - Manage locations + diff --git a/docs/0.0.0/vf-admin_location_remove.md b/docs/0.0.0/vf-admin_location_remove.md new file mode 100644 index 0000000..fad141e --- /dev/null +++ b/docs/0.0.0/vf-admin_location_remove.md @@ -0,0 +1,32 @@ +## vf-admin location remove + +Remove a location with a specified id + +``` +vf-admin location remove [flags] +``` + +### Examples + +``` +# Remove the location with id 8. +$ vf-admin location remove 8 + +``` + +### Options + +``` + -h, --help help for remove +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin location](vf-admin_location.md) - Manage locations + diff --git a/docs/0.0.0/vf-admin_location_update.md b/docs/0.0.0/vf-admin_location_update.md new file mode 100644 index 0000000..0d4d2e3 --- /dev/null +++ b/docs/0.0.0/vf-admin_location_update.md @@ -0,0 +1,41 @@ +## vf-admin location update + +Update a location with a specified id + +``` +vf-admin location update [flags] +``` + +### Examples + +``` +# Update the location with id 15 to be active, have name "Guelph Hospital", postal code "N1E 4J4", website URL "http://www.gghorg.ca/", phone "(519) 822-5350", notes "Please call ahead to make an appointment.", tags "Guelph, Appointment", organization id 23 and address id 352. +$ vf-admin location update 15 --active 1 --name "Guelph Hospital" --postcode "N1E4J4" --url "http://www.gghorg.ca" --phone "(519) 822-5350" --notes "Please call ahead to make an appointment." --tags "Guelph, Appointment" --organization 23 --address 352 + +``` + +### Options + +``` + --active int is this location active? 1 or 0 (default 1) + --address int id of address of location + -h, --help help for update + --name string name of location + --notes string notes about location + --organization int id of organization running location + --phone string phone number of location + --postcode string postal code of location + --tags string search tags of location + --url string website URL of location +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin location](vf-admin_location.md) - Manage locations + diff --git a/docs/0.0.0/vf-admin_va.md b/docs/0.0.0/vf-admin_va.md new file mode 100644 index 0000000..81389a4 --- /dev/null +++ b/docs/0.0.0/vf-admin_va.md @@ -0,0 +1,27 @@ +## vf-admin va + +Manage vaccine availabilities + +### Options + +``` + -h, --help help for va +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin](vf-admin.md) - vf-admin is a CLI to manage vaccine availabilities and other data for the Vaccine Hunters Finder tool. +* [vf-admin va add](vf-admin_va_add.md) - Add a new vaccine availability +* [vf-admin va get](vf-admin_va_get.md) - Retrieve a vaccine availability with a specified id +* [vf-admin va list](vf-admin_va_list.md) - Retrieve a list of vaccine availabilities within the vicinity of a postal code +* [vf-admin va remove](vf-admin_va_remove.md) - Remove a vaccine availability with a specified id +* [vf-admin va requirement](vf-admin_va_requirement.md) - Manage requirements for vaccine availability +* [vf-admin va timeslot](vf-admin_va_timeslot.md) - Manage timeslots for vaccine availability +* [vf-admin va update](vf-admin_va_update.md) - Update a vaccine availability with a specified id + diff --git a/docs/0.0.0/vf-admin_va_add.md b/docs/0.0.0/vf-admin_va_add.md new file mode 100644 index 0000000..5d7f7da --- /dev/null +++ b/docs/0.0.0/vf-admin_va_add.md @@ -0,0 +1,39 @@ +## vf-admin va add + +Add a new vaccine availability + +``` +vf-admin va add [flags] +``` + +### Examples + +``` +# Add new vaccine availability on 2021-05-25 with 3 available input type 1 location 1651 and tags vhc +$ vf-admin va add --date "2021-05-25" --numberavailable 3 --inputtype 1 --location 1651 --tags vhc + +``` + +### Options + +``` + --date string date for availability (YYYY-MM-DD) + -h, --help help for add + --inputtype int input type + --location int id of the location + --numberavailable int number of vaccines available + --numbertotal int total number of vaccines + --tags string tags + --vaccine int id of the vaccine +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities + diff --git a/docs/0.0.0/vf-admin_va_get.md b/docs/0.0.0/vf-admin_va_get.md new file mode 100644 index 0000000..3a3d05f --- /dev/null +++ b/docs/0.0.0/vf-admin_va_get.md @@ -0,0 +1,32 @@ +## vf-admin va get + +Retrieve a vaccine availability with a specified id + +``` +vf-admin va get [flags] +``` + +### Examples + +``` +# Get the vaccine availability with id 014cc133-484f-4320-be3b-444e758b64a7 +$ vf-admin va get 014cc133-484f-4320-be3b-444e758b64a7 + +``` + +### Options + +``` + -h, --help help for get +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities + diff --git a/docs/0.0.0/vf-admin_va_list.md b/docs/0.0.0/vf-admin_va_list.md new file mode 100644 index 0000000..e3b089c --- /dev/null +++ b/docs/0.0.0/vf-admin_va_list.md @@ -0,0 +1,34 @@ +## vf-admin va list + +Retrieve a list of vaccine availabilities within the vicinity of a postal code + +``` +vf-admin va list [flags] +``` + +### Examples + +``` +# List the vaccine availabilities within the vicinity of a postal code. +$ vf-admin va list --postcode K1A + +``` + +### Options + +``` + -h, --help help for list + --mindate string minimum date for availability (YYYY-MM-DD) + --postcode string postal code to search around +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities + diff --git a/docs/0.0.0/vf-admin_va_remove.md b/docs/0.0.0/vf-admin_va_remove.md new file mode 100644 index 0000000..da13c40 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_remove.md @@ -0,0 +1,32 @@ +## vf-admin va remove + +Remove a vaccine availability with a specified id + +``` +vf-admin va remove [flags] +``` + +### Examples + +``` +# Remove vaccine availability id 7d7488e4-cc26-434d-85c4-b7df2f7e3171 +$ vf-admin va remove 7d7488e4-cc26-434d-85c4-b7df2f7e3171 + +``` + +### Options + +``` + -h, --help help for remove +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities + diff --git a/docs/0.0.0/vf-admin_va_requirement.md b/docs/0.0.0/vf-admin_va_requirement.md new file mode 100644 index 0000000..8c37361 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_requirement.md @@ -0,0 +1,24 @@ +## vf-admin va requirement + +Manage requirements for vaccine availability + +### Options + +``` + -h, --help help for requirement +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities +* [vf-admin va requirement add](vf-admin_va_requirement_add.md) - Add a new requirement for vaccine availability +* [vf-admin va requirement list](vf-admin_va_requirement_list.md) - Retrieve a list of requirements for a vaccine availability +* [vf-admin va requirement remove](vf-admin_va_requirement_remove.md) - Remove a requirement from a vaccine availability with specified ids +* [vf-admin va requirement update](vf-admin_va_requirement_update.md) - Update a requirement for vaccine availability with specified ids + diff --git a/docs/0.0.0/vf-admin_va_requirement_add.md b/docs/0.0.0/vf-admin_va_requirement_add.md new file mode 100644 index 0000000..d999526 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_requirement_add.md @@ -0,0 +1,33 @@ +## vf-admin va requirement add + +Add a new requirement for vaccine availability + +``` +vf-admin va requirement add [flags] +``` + +### Examples + +``` +# Add a new requirement 10 for a vaccine availability c7bc794c-9905-4588-81e6-e557e1a494c4 +$ vf-admin va requirement add c7bc794c-9905-4588-81e6-e557e1a494c4 --requirement 10 + +``` + +### Options + +``` + -h, --help help for add + --requirement int id of requirement +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va requirement](vf-admin_va_requirement.md) - Manage requirements for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_requirement_list.md b/docs/0.0.0/vf-admin_va_requirement_list.md new file mode 100644 index 0000000..a4d4be7 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_requirement_list.md @@ -0,0 +1,32 @@ +## vf-admin va requirement list + +Retrieve a list of requirements for a vaccine availability + +``` +vf-admin va requirement list [flags] +``` + +### Examples + +``` +# List the requirements for a vaccine availability. +$ vf-admin va requirement list + +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va requirement](vf-admin_va_requirement.md) - Manage requirements for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_requirement_remove.md b/docs/0.0.0/vf-admin_va_requirement_remove.md new file mode 100644 index 0000000..b95ad28 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_requirement_remove.md @@ -0,0 +1,32 @@ +## vf-admin va requirement remove + +Remove a requirement from a vaccine availability with specified ids + +``` +vf-admin va requirement remove [flags] +``` + +### Examples + +``` +# Remove vaccine availability c7bc794c-9905-4588-81e6-e557e1a494c4 and requirement id a9620b24-0dc4-4c7d-8ca2-a9b06d627d82 +$ vf-admin va requirement remove c7bc794c-9905-4588-81e6-e557e1a494c4 a9620b24-0dc4-4c7d-8ca2-a9b06d627d82 + +``` + +### Options + +``` + -h, --help help for remove +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va requirement](vf-admin_va_requirement.md) - Manage requirements for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_requirement_update.md b/docs/0.0.0/vf-admin_va_requirement_update.md new file mode 100644 index 0000000..cf81cc1 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_requirement_update.md @@ -0,0 +1,34 @@ +## vf-admin va requirement update + +Update a requirement for vaccine availability with specified ids + +``` +vf-admin va requirement update [flags] +``` + +### Examples + +``` +# update vaccine availability c7bc794c-9905-4588-81e6-e557e1a494c4 and requirement id a9620b24-0dc4-4c7d-8ca2-a9b06d627d82 with requirement id 10 and active false +$ vf-admin va requirement update c7bc794c-9905-4588-81e6-e557e1a494c4 a9620b24-0dc4-4c7d-8ca2-a9b06d627d82 --requirement 10 --active=false + +``` + +### Options + +``` + --active if the requirement is active or not + -h, --help help for update + --requirement int id of requirement +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va requirement](vf-admin_va_requirement.md) - Manage requirements for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_timeslot.md b/docs/0.0.0/vf-admin_va_timeslot.md new file mode 100644 index 0000000..5e96325 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_timeslot.md @@ -0,0 +1,24 @@ +## vf-admin va timeslot + +Manage timeslots for vaccine availability + +### Options + +``` + -h, --help help for timeslot +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities +* [vf-admin va timeslot add](vf-admin_va_timeslot_add.md) - Add a new timeslot for vaccine availability +* [vf-admin va timeslot list](vf-admin_va_timeslot_list.md) - Retrieve a list of timeslots for a vaccine availability +* [vf-admin va timeslot remove](vf-admin_va_timeslot_remove.md) - Remove a timeslot from a vaccine availability with specified ids +* [vf-admin va timeslot update](vf-admin_va_timeslot_update.md) - Update a timeslot for vaccine availability with specified ids + diff --git a/docs/0.0.0/vf-admin_va_timeslot_add.md b/docs/0.0.0/vf-admin_va_timeslot_add.md new file mode 100644 index 0000000..63a7fb9 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_timeslot_add.md @@ -0,0 +1,25 @@ +## vf-admin va timeslot add + +Add a new timeslot for vaccine availability + +``` +vf-admin va timeslot add [flags] +``` + +### Options + +``` + -h, --help help for add + --time string time of the slot (RFC 3339) +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va timeslot](vf-admin_va_timeslot.md) - Manage timeslots for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_timeslot_list.md b/docs/0.0.0/vf-admin_va_timeslot_list.md new file mode 100644 index 0000000..04a6eb4 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_timeslot_list.md @@ -0,0 +1,32 @@ +## vf-admin va timeslot list + +Retrieve a list of timeslots for a vaccine availability + +``` +vf-admin va timeslot list [flags] +``` + +### Examples + +``` +# List the timeslots for a vaccine availability. +$ vf-admin va timeslot list + +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va timeslot](vf-admin_va_timeslot.md) - Manage timeslots for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_timeslot_remove.md b/docs/0.0.0/vf-admin_va_timeslot_remove.md new file mode 100644 index 0000000..08d2bb1 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_timeslot_remove.md @@ -0,0 +1,32 @@ +## vf-admin va timeslot remove + +Remove a timeslot from a vaccine availability with specified ids + +``` +vf-admin va timeslot remove [flags] +``` + +### Examples + +``` +# Remove vaccine availability c7bc794c-9905-4588-81e6-e557e1a494c4 and timeslot id a9620b24-0dc4-4c7d-8ca2-a9b06d627d82 +$ vf-admin va timeslot remove c7bc794c-9905-4588-81e6-e557e1a494c4 a9620b24-0dc4-4c7d-8ca2-a9b06d627d82 + +``` + +### Options + +``` + -h, --help help for remove +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va timeslot](vf-admin_va_timeslot.md) - Manage timeslots for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_timeslot_update.md b/docs/0.0.0/vf-admin_va_timeslot_update.md new file mode 100644 index 0000000..3207304 --- /dev/null +++ b/docs/0.0.0/vf-admin_va_timeslot_update.md @@ -0,0 +1,26 @@ +## vf-admin va timeslot update + +Update a timeslot for vaccine availability with specified ids + +``` +vf-admin va timeslot update [flags] +``` + +### Options + +``` + -h, --help help for update + --takenAt string time of the slot was taken (RFC 3339) + --time string time of the slot (RFC 3339) +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va timeslot](vf-admin_va_timeslot.md) - Manage timeslots for vaccine availability + diff --git a/docs/0.0.0/vf-admin_va_update.md b/docs/0.0.0/vf-admin_va_update.md new file mode 100644 index 0000000..664b0ce --- /dev/null +++ b/docs/0.0.0/vf-admin_va_update.md @@ -0,0 +1,39 @@ +## vf-admin va update + +Update a vaccine availability with a specified id + +``` +vf-admin va update [flags] +``` + +### Examples + +``` +# Update vaccine availability id 7d7488e4-cc26-434d-85c4-b7df2f7e3171to be on 2021-05-25 with 3 available input type 1 location 1651 and tags vhc +$ vf-admin va update 7d7488e4-cc26-434d-85c4-b7df2f7e3171 --date "2021-05-25" --numberavailable 3 --inputtype 1 --location 1651 --tags vhc + +``` + +### Options + +``` + --date string date for availability (YYYY-MM-DD) + -h, --help help for update + --inputtype int input type + --location int id of the location + --numberavailable int number of vaccines available + --numbertotal int total number of vaccines + --tags string tags + --vaccine int id of the vaccine +``` + +### Options inherited from parent commands + +``` + --profile string specifies the named profile to use for this command (default "default") +``` + +### SEE ALSO + +* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities +