timesys.vigiles.products module
- timesys.vigiles.products.create_product(product_name, product_description=None)
Create a new product for the current user
- Parameters
product_name (str) -- Name for the new product
product_description (str, optional) -- Description for the new product
- Returns
- namestr
Name of product
- descriptionstr
Description of product
- tokenstr
Token of the new product
- Return type
dict
- timesys.vigiles.products.get_product_info(product_token=None)
Get product information from a product_token
If a token is passed, it will be used. If no token is passed, but a product_token is configured on the llapi object, it will be used. If neither are provided, an Exception will be raised.
- Parameters
product_token (str, optional) -- Token of the product to retrieve info for
- Returns
- name
Name of product
- description
Description of product
- token
Token for the product
- is_default
True if product is default product for user, otherwise False
- created
Date that the product was created
- Return type
dict
- timesys.vigiles.products.get_products()
Get product info for all products available to the current user
- Returns
- List of product information dictionaries which contains keys:
"name", "description", "token"
- Return type
list of dict