iamthefij/email-assistant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
master
email-assistant/viewers/main
History
Ian Fijolek 6dc99be7e4 Run linters
2020-12-11 13:06:26 -05:00
..
viewer Run linters 2020-12-11 13:06:26 -05:00
docker-compose.yml POC Viewer for shipping that shows some status info and provides a url UPS only so far 2018-02-06 10:23:40 -08:00
Dockerfile POC Viewer for shipping that shows some status info and provides a url UPS only so far 2018-02-06 10:23:40 -08:00
Readme.md POC Viewer for shipping that shows some status info and provides a url UPS only so far 2018-02-06 10:23:40 -08:00
requirements-dev.txt POC Viewer for shipping that shows some status info and provides a url UPS only so far 2018-02-06 10:23:40 -08:00
requirements.txt Remove flask_bootstrap 2018-02-09 12:32:06 -08:00

Readme.md

Indexer

Simple service to act as data layer for Email Assitant

Healthcheck

Path: / Returns: OK

Tokens

Path: /token

POST

Accepts JSON representation of a EmailToken

Accepts:

Field Type Example
"subject" String "Your shipping info"
"token" String "123456"
"type" String "SHIPPING"
"metadata" Object (optional) {"carrier": "UPS"}
"disabled" Boolean (optional) false

Returns:

Field Type Example
"success" Boolean true
"token" Token Object {"id": 1, ... }

GET

Path: /token Returns all Token Objects

Parameters:

Parameter Description Example
"filter_type" String token type to filter by SHIPPING

Returns:

Field Type Example
"tokens" List of Token Objects [{"id": 1, ... }, ...]

Path: /token/<int:token_id> Returns Token Object with that ID