' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/api/modules.html b/api/modules.html new file mode 100644 index 0000000..fd16cac --- /dev/null +++ b/api/modules.html @@ -0,0 +1,165 @@ + + + + + + + +
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/api/sxapi.cli.html b/api/sxapi.cli.html
new file mode 100644
index 0000000..9f1514f
--- /dev/null
+++ b/api/sxapi.cli.html
@@ -0,0 +1,254 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sxapi¶
+
+
+-
+
- sxapi package
-
+
- Subpackages + +
- Submodules +
- sxapi.base module + +
- Module contents +
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/api/sxapi.cli.subparser.html b/api/sxapi.cli.subparser.html
new file mode 100644
index 0000000..bfdec7d
--- /dev/null
+++ b/api/sxapi.cli.subparser.html
@@ -0,0 +1,213 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sxapi.cli package¶
+Subpackages¶
+
+
+
+Submodules¶
+sxapi.cli.cli module¶
+ + + + +sxapi.cli.cli_user module¶
+-
+
- +class sxapi.cli.cli_user.CliUser[source]¶ +
Bases:
+objectCliUser class used for initializing, storing, retrieving and deleting +credentials and creating/holding Instances of supported API +Client.
+This class should only be used in the cli package.
+ + + + +-
+
- +static get_token_environment()[source]¶ +
Gets token named ‘SMAXTEC_API_ACCESS_TOKEN’ from the systems’ environment.
+
-
+
- +init_user(config_dict, args_token, args_keyring)[source]¶ +
This function retrieves the token from the specified resource +(keyring, environment or args) and initializes clients +of the supported APIs (PublicV2, IntegrationV2).
+If no token can be found the token is retrieved via +the username and password.
+If username and password are also missing, no credentials get +stored and not API clients are created.
+
Module contents¶
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/api/sxapi.html b/api/sxapi.html
new file mode 100644
index 0000000..a8e178e
--- /dev/null
+++ b/api/sxapi.html
@@ -0,0 +1,333 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sxapi.cli.subparser namespace¶
+Submodules¶
+sxapi.cli.subparser.get_sensor_data module¶
+-
+
- +sxapi.cli.subparser.get_sensor_data.create_gsd_parser(subparsers)[source]¶ +
get_sensor_data subparser for cli_tests. +Responsible for performing api-call to get the sensor data for a given animal.
+The ‘animals_id’ is mandatory argument ‘animal_id’. +It represents the animal you want to get data from.
+The following flag are only optional. +The –metrics/-m Flag defines the metrics you want to get from the animal sensor. +It expects at most two arguments ‘temp’, ‘act’ or both together. Where ‘temp’ means +getting the temperature metric and ‘act’ means the activity metric.
+The –from_date Flag defines the start-date of window you want to get data from. +It expects exactly one argument, a datetime in the format ‘YYYY-MM-DD’ +(e.g. 2022.01.12).
+The –to_date Flag defines the end-date of window you want to get data from. +It expects exactly one argument, a datetime in the format ‘YYYY-MM-DD’ +(e.g. 2022.01.12).
+
sxapi.cli.subparser.token module¶
+-
+
- +sxapi.cli.subparser.token.create_token_parser(subparsers)[source]¶ +
Token subparser for cli_tests. +Responsible for managing tokens/credentials.
+The –print_token/-p Flag prints the token, stored in keyring or in +environment, to stdout. It expects exactly only one argument -> ‘e’ +for printing the token stored in the environment, ‘k’ for printing +the token stored in keyring and ‘ek’ for printing both at the same time.
+The –set_keyring/-s flag stores the token (given as argument) in the keyring. +It expects exactly one argument -> the token you want to store.
+The –clear_keyring/-c Flag deletes the token from the keyring. +This flag doesn’t expect any argument.
+The –new_token/-n Flag calls api to get new token and prints it to stdout. +It expects exactly two arguments -> smaxtec-username and smaxtec-password.
+It is not possible to use more than one of those flags at the same time
+
-
+
- +sxapi.cli.subparser.token.handle_clear_token()[source]¶ +
Logic behind the token subparser –clear_keyring flag.
+Deletes the token from the keyring.
+
-
+
- +sxapi.cli.subparser.token.handle_new_token(args)[source]¶ +
Logic behind the token subparser –new_token flag.
+Parses the args, creates an PublicAPIV2 instance to get new token and +print the new token to stdout.
+
-
+
- +sxapi.cli.subparser.token.handle_print_token(args)[source]¶ +
Logic behind the token subparser –print_token flag.
+Prints the token from the desired source (environment or keyring) to stdout.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/api/sxapi.publicV2.html b/api/sxapi.publicV2.html
new file mode 100644
index 0000000..10af285
--- /dev/null
+++ b/api/sxapi.publicV2.html
@@ -0,0 +1,1376 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sxapi package¶
+Subpackages¶
+
+
+-
+
- sxapi.cli package + +
- sxapi.publicV2 package
-
+
- Submodules +
- sxapi.publicV2.alarms module + +
- sxapi.publicV2.data module
-
+
Data-
+
Data.get_data_animals()
+Data.get_data_devices()
+Data.get_data_feedrations()
+Data.get_data_groups()
+Data.get_download_animal_data()
+Data.get_download_device_data()
+Data.get_download_group_data()
+Data.get_downloads()
+Data.get_metrics_animals()
+Data.get_metrics_devices()
+Data.get_metrics_groups()
+Data.post_downloads_excel_report()
+Data.post_downloads_messages_excel_report()
+Data.post_downloads_organisation_messages_excel_report()
+
+
+ - sxapi.publicV2.feedrations module + +
- sxapi.publicV2.groups module + +
- sxapi.publicV2.sensordata module + +
- sxapi.publicV2.todos module + +
- sxapi.publicV2.users module
-
+
Users-
+
Users.delete_tokens()
+Users.get()
+Users.get_account()
+Users.get_alarms()
+Users.get_credentials()
+Users.get_reset_password_request()
+Users.get_shares()
+Users.post_activate()
+Users.post_credentials()
+Users.post_password_strength()
+Users.post_reset_password()
+Users.post_test_email()
+Users.post_test_push()
+Users.post_tokens()
+Users.post_update_metadata()
+Users.put_change_password()
+Users.put_tokens()
+
+
+ - Module contents
-
+
PublicAPIV2
+
+
+
Submodules¶
+sxapi.base module¶
+-
+
- +class sxapi.base.ApiTypes(value)[source]¶ +
Bases:
+EnumAn enumeration.
+-
+
- +INTEGRATION = 2¶ +
-
+
- +PUBLIC = 1¶ +
Module contents¶
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/authors.html b/authors.html
new file mode 100644
index 0000000..7bf6764
--- /dev/null
+++ b/authors.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sxapi.publicV2 package¶
+Submodules¶
+sxapi.publicV2.alarms module¶
+-
+
- +class sxapi.publicV2.alarms.Alarms(api=None)[source]¶ +
Bases:
+objectThis class represents the /alarms API endpoint of the PublicAPIV2. +https://api.smaxtec.com/api/v2/
+-
+
- +delete(alarm_id, **kwargs)[source]¶ +
Delete one alarm.
+-
+
- Parameters: +
-
+
alarm_id (str) – ID of the alarm to delete
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Deleted alarm on success, error message else.
+
+- Return type: +
- + +
-
+
- +get(alarm_id, **kwargs)[source]¶ +
Get one alarm.
+-
+
- Parameters: +
-
+
alarm_id (str) – ID of the desired alarm
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Queried alarm on success, error message else.
+
+- Return type: +
- + +
-
+
- +get_categories(**kwargs)[source]¶ +
Get all alarms categories for a user or organisation. +If no user or organisation is given, this +function return a BadRequestError
+-
+
- Parameters: +
**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. List of alarms on success, error message else.
+
+- Return type: +
- + +
-
+
- +post(organisation_id, title, **kwargs)[source]¶ +
Creates a new alarm.
+-
+
- Parameters: +
-
+
organisation_id (str) – ID of organisation the alarm should be created for
+title (str) – Title of the alarm
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Created alarm on success, error message else.
+
+- Return type: +
- + +
-
+
- +put(alarm_id, organisation_id, **kwargs)[source]¶ +
Updates an existing alarm.
+-
+
- Parameters: +
-
+
alarm_id (str) – ID of the alarm which should be updated.
+organisation_id (str) – ID of organisation the alarm should be updated for
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Updated alarm on success, error message else.
+
+- Return type: +
- + +
sxapi.publicV2.data module¶
+-
+
- +class sxapi.publicV2.data.Data(api=None)[source]¶ +
Bases:
+objectThis Class represents the /data endpoint fo the PublicAPIV2
+-
+
- +get_data_animals(animal_id, metrics, from_date, to_date, **kwargs)[source]¶ +
Query sensordata for an animal.
+-
+
- Parameters: +
- + +
- Returns: +
-
+
- Response from the API. Requested Metric values on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_data_devices(device_id, metrics, from_date, to_date, **kwargs)[source]¶ +
Query sensordata for a device.
+-
+
- Parameters: +
- + +
- Returns: +
-
+
- Response from the API. Requested Metric values on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_data_feedrations(feedration_id, metrics, from_date, to_date, **kwargs)[source]¶ +
Query feedration data.
+-
+
- Parameters: +
- + +
- Returns: +
-
+
- Response from the API. Requested Metric values on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_data_groups(group_id, metrics, from_date, to_date, **kwargs)[source]¶ +
Query group data.
+-
+
- Parameters: +
- + +
- Returns: +
-
+
- Response from the API. Requested Metric values on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_download_animal_data(animal_ids, metrics, from_date, to_date, **kwargs)[source]¶ +
Download sensordata for animals.
+-
+
- Parameters: +
- + +
- Returns: +
-
+
- Response from the API. Requested Metric values on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_download_device_data(device_ids, metrics, from_date, to_date, **kwargs)[source]¶ +
Download sensordata for devices.
+-
+
- Parameters: +
- + +
- Returns: +
-
+
- Response from the API. Requested Metric values on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_download_group_data(group_ids, metrics, from_date, to_date, **kwargs)[source]¶ +
Download sensordata for groups.
+-
+
- Parameters: +
- + +
- Returns: +
-
+
- Response from the API. Requested Metric values on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_downloads(download_id, **kwargs)[source]¶ +
Download a generated Excel report.
+-
+
- Parameters: +
-
+
download_id (str) – ID of the download
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+
Returns:
+
-
+
- +get_metrics_animals(animal_id, **kwargs)[source]¶ +
List available metrics for an animal.
+-
+
- Parameters: +
-
+
animal_id (str) – ID of the animal
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response from the API. List of available metrics on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_metrics_devices(device_id, **kwargs)[source]¶ +
List available metrics for a device.
+-
+
- Parameters: +
-
+
device_id (str) – ID of the device
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response from the API. List of available metrics on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_metrics_groups(group_id, **kwargs)[source]¶ +
List available metrics for a group.
+-
+
- Parameters: +
-
+
group_id (str) – ID of the group
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response from the API. List of available metrics on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +post_downloads_excel_report(from_date, to_date, **kwargs)[source]¶ +
Generates an Excel report and sends an email +containing a download link for the Excel report to the user.
+-
+
- Parameters: +
-
+
from_date (str) – Query from date
+to_date (str) – Query end date
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Empty dict on success, error message else.
+
+- Return type: +
- + +
-
+
- +post_downloads_messages_excel_report(from_date, to_date, **kwargs)[source]¶ +
Generates an Excel report and sends an email +containing a download link for the Excel report to the user.
+-
+
- Parameters: +
-
+
from_date (str) – Query from date
+to_date (str) – Query end date
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Empty dict on success, error message else.
+
+- Return type: +
- + +
-
+
- +post_downloads_organisation_messages_excel_report(organisation_id, from_date, to_date, **kwargs)[source]¶ +
Generates an Excel report and sends an email +containing a download link for the Excel report to the user.
+-
+
- Parameters: +
-
+
organisation_id (str) – ID of organisation the report should be created for
+from_date (str) – Query from date
+to_date (str) – Query end date
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Empty dict on success, error message else.
+
+- Return type: +
- + +
sxapi.publicV2.feedrations module¶
+-
+
- +class sxapi.publicV2.feedrations.Feedrations(api=None)[source]¶ +
Bases:
+objectThis Class represents the /feedrations endpoint of the PublicAPIV2. +https://api.smaxtec.com/api/v2/
+-
+
- +delete(feedration_id, **kwargs)[source]¶ +
Deletes a feedration.
+-
+
- Parameters: +
-
+
feedration_id (str) – ID of the feedration which should be deleted.
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Result on success, error message else.
+
+- Return type: +
- + +
-
+
- +get(feedration_id, **kwargs)[source]¶ +
Get one feedration.
+-
+
- Parameters: +
-
+
feedration_id (str) – ID of the desired feedration
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response of API call. Feedration on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +post(name, organisation_id, **kwargs)[source]¶ +
Creates a new feedration.
+-
+
- Parameters: +
-
+
name (str) – Name of the feedration to be created
+organisation_id (str) – ID of the organisation the feedration +should be created for
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response of API call. Created feedration on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +put(feedration_id, name, organisation_id, **kwargs)[source]¶ +
Updates an existing feedration.
+-
+
- Parameters: +
-
+
feedration_id (str) – ID of the feedration which should be updated.
+name (str) – Name of the feedration to be updated
+organisation_id (str) – ID of the organisation the feedration +should be updated for
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response of API call. Updated feedration on success,
error message else.
+
+
+- Return type: +
- + +
sxapi.publicV2.groups module¶
+-
+
- +class sxapi.publicV2.groups.Groups(api=None)[source]¶ +
Bases:
+objectThis Class represents the /groups endpoint of the PublicAPIV2. +https://api.smaxtec.com/api/v2/
+-
+
- +delete_actions(group_id, action_id, **kwargs)[source]¶ +
Delete an action from a group.
+-
+
- Parameters: +
-
+
group_id (str) – ID of the group which should be updated.
+action_id (str) – ID of the action which should be deleted.
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Result on success, error message else.
+
+- Return type: +
- + +
-
+
- +get_actions(group_id, **kwargs)[source]¶ +
Get all actions of a group.
+-
+
- Parameters: +
-
+
group_id (str) – ID of the group which should be updated.
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Updated group on success, error message else.
+
+- Return type: +
- + +
-
+
- +put_actions(group_id, **kwargs)[source]¶ +
Add an action to a group.
+-
+
- Parameters: +
-
+
group_id (str) – ID of the group which should be updated.
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Updated group on success, error message else.
+
+- Return type: +
- + +
sxapi.publicV2.sensordata module¶
+ + +sxapi.publicV2.todos module¶
+-
+
- +class sxapi.publicV2.todos.Todos(api=None)[source]¶ +
Bases:
+objectThis Class represents the /todos endpoint of the PublicAPIV2.
+ + + + +-
+
- +post(todo_type, organisation_id, **kwargs)[source]¶ +
Creates a new todo.
+-
+
- Parameters: +
-
+
todo_type (str) – Type of the todo to be created
+organisation_id (str) – Id of organisation the todo should be created for
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Created todo on success, error message else.
+
+- Return type: +
- + +
-
+
- +put(todo_id, **kwargs)[source]¶ +
Updates an existing todo.
+-
+
- Parameters: +
-
+
todo_id (str) – Id of the todo which should be updated.
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Updated todo on success, error message else.
+
+- Return type: +
- + +
sxapi.publicV2.users module¶
+-
+
- +class sxapi.publicV2.users.Users(api=None)[source]¶ +
Bases:
+objectThis Class represents the /users endpoint fo the PublicAPIV2 +https://api.smaxtec.com/api/v2/
+-
+
- +delete_tokens(user_id, token, **kwargs)[source]¶ +
Deletes the token from the user.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+token (str) – token to be deleted
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Request result on success, error message else.
+
+- Return type: +
- + +
-
+
- +get(user_id, **kwargs)[source]¶ +
Get one user by id.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. User object on success, error message else.
+
+- Return type: +
- + +
-
+
- +get_account(user_id, **kwargs)[source]¶ +
Get a list of all Accounts of the given user
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response of API call. List of Account objects on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_alarms(user_id, **kwargs)[source]¶ +
Get a list of all Alarms of the given user
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response of API call. List of Alarm objects on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +get_credentials(**kwargs)[source]¶ +
Retrieve smaxtec api-access-tokens with a JWT Token.
+-
+
- Parameters: +
**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Current tokens and additional user +information on success, error message else.
+
+- Return type: +
- + +
-
+
- +get_reset_password_request(email, **kwargs)[source]¶ +
Request a password reset email.
+-
+
- Parameters: +
-
+
email (str) – email of the user.
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Request result on success, error message else.
+
+- Return type: +
- + +
-
+
+
Get a list of all Shares of the given user
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response of API call. List of Share objects on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +post_credentials(user, password, **kwargs)[source]¶ +
Create smaxtec api-access-token and an optional firestore-token.
+-
+
- Parameters: +
-
+
user (str) – Username/email
+password (str) – User password
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Requested tokens and additional user +information on success, error message else.
+
+- Return type: +
- + +
-
+
- +post_password_strength(user_id, email, password, **kwargs)[source]¶ +
Check password strength.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+email (str) – email of the user
+password (str) – password to check
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
-
+
- Response of API call. Request result and password strength on success,
error message else.
+
+
+- Return type: +
- + +
-
+
- +post_reset_password(secret, new_password, **kwargs)[source]¶ +
Reset password with secret.
+-
+
- Parameters: +
-
+
secret (str) – secret received from email request.
+new_password (str) – new password for the user.
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Updated User on success, error message else.
+
+- Return type: +
- + +
-
+
- +post_test_email(user_id, **kwargs)[source]¶ +
Send a test email to the user.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Empty dict on success, error message else.
+
+- Return type: +
- + +
-
+
- +post_test_push(user_id, **kwargs)[source]¶ +
Send a test push notification to the user.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Empty dict on success, error message else.
+
+- Return type: +
- + +
-
+
- +post_tokens(user_id, token, platform, token_type, **kwargs)[source]¶ +
Adds the token to the user.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+token (str) – some kind of token
+platform (str) – platform of the token device
+token_type (str) – type of the token (add push_ if push token)
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Request result on success, error message else.
+
+- Return type: +
- + +
-
+
- +post_update_metadata(user_id, metadata, **kwargs)[source]¶ +
Update metadata of a user.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+metadata (dict) – updated metadata
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Updated user on success, error message else.
+
+- Return type: +
- + +
-
+
- +put_change_password(user_id, old_password, new_password, **kwargs)[source]¶ +
Change password of a user with old password.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+old_password (str) – old password of the user
+new_password (str) – new password of the user
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Request result on success, error message else.
+
+- Return type: +
- + +
-
+
- +put_tokens(user_id, token, platform, token_type, **kwargs)[source]¶ +
Adds the token if it does not exist, else updates the token.
+-
+
- Parameters: +
-
+
user_id (str) – ID of the desired user
+token (str) – some kind of token
+platform (str) – platform of the token device
+token_type (str) – type of the token (add push_ if push token)
+**kwargs – Optional parameters of the API call. +Find supported parameters under +https://api.smaxtec.com/api/v2/
+
+- Returns: +
Response of API call. Request result on success, error message else.
+
+- Return type: +
- + +
Module contents¶
+ + +
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/changelog.html b/changelog.html
new file mode 100644
index 0000000..eb598a6
--- /dev/null
+++ b/changelog.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contributors¶
+-
+
Florian Klien <florian.klien@smaxtec.com>
+Philipp Kulich <philipp.kulich@smaxtec.com>
+Marco Julian Moser <hyper_chrome@gmx.at>
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/genindex.html b/genindex.html
new file mode 100644
index 0000000..b6a6d5d
--- /dev/null
+++ b/genindex.html
@@ -0,0 +1,574 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contributing¶
+Welcome to sxapi contributor’s guide.
This document focuses on getting any potential contributor familiarized +with the development processes, but other kinds of contributions are also +appreciated.
+If you are new to using git or have never collaborated in a project previously, +please have a look at contribution-guide.org. Other resources are also +listed in the excellent guide created by FreeCodeCamp [1].
+Please notice, all users and contributors are expected to be open, +considerate, reasonable, and respectful. When in doubt, Python Software +Foundation’s Code of Conduct is a good reference in terms of behavior +guidelines.
+Issue Reports¶
+If you experience bugs or general issues with sxapi, please have a look
+on the issue tracker. If you don’t see anything useful there, please feel
+free to fire an issue report.
+
+Tip
+Please don’t forget to include the closed issues in your search. +Sometimes a solution was already reported, and the problem is considered +solved.
+New issue reports should include information about your programming environment +(e.g., operating system, Python version) and steps to reproduce the problem. +Please try also to simplify the reproduction steps to a very minimal example +that still illustrates the problem you are facing. By removing other factors, +you help us to identify the root cause of the issue.
+Documentation Improvements¶
+You can help improve sxapi docs by making them more readable and coherent, or
+by adding missing information and correcting mistakes.
sxapi documentation uses Sphinx as its main documentation compiler, with reStructuredText as markup language.
+This means that the docs are kept in the same repository as the project code, and
+that any documentation update is done in the same way was a code contribution.
+
+Tip
+Please notice that the GitHub web interface provides a quick way of
+propose changes in sxapi’s files. While this mechanism can
+be tricky for normal code contributions, it works perfectly fine for
+contributing to the docs, and can be quite handy.
If you are interested in trying this method out, please navigate to
+the docs folder in the source repository, find which file you
+would like to propose changes and click in the little pencil icon at the
+top, to open GitHub’s code editor. Once you finish editing the file,
+please write a message in the form at the bottom of the page describing
+which changes have you made and what are the motivations behind them and
+submit your proposal.
When working on documentation changes in your local machine, you can
+compile them using tox:
tox -e docs
+and use Python’s built-in web server for a preview in your web browser
+(http://localhost:8000):
python3 -m http.server --directory 'docs/_build/html'
+Code Contributions¶
+You can find the API documentation for the smaxtec system on the API documentation page and the integration API documentation page.
+This API is only available with a smaxtec user account after logging in. All calls must use an access token. +.. todo:: fix contact info. +If you need an account for the API you can contact smaXtec.
+Submit an issue¶
+Before you work on any non-trivial code contribution it’s best to first create +a report in the issue tracker to start a discussion on the subject. +This often provides additional considerations and avoids unnecessary work.
+Create an environment¶
+Before you start coding, we recommend creating an isolated virtual
+environment to avoid any problems with your installed Python packages.
+This can easily be done via either virtualenv:
virtualenv <PATH TO VENV>
+source <PATH TO VENV>/bin/activate
+Clone the repository¶
+-
+
Create an user account on GitHub if you do not already have one.
+Fork the project repository: click on the Fork button near the top of the +page. This creates a copy of the code under your account on GitHub.
+Clone this copy to your local disk:
+++git clone git@github.com:YourLogin/sxapi.git +cd sxapi +
+You should run:
+++pip install -U pip setuptools -e . +
to be able run
+putup --help.
+Install
+pre-commit:++pip install pre-commit +pre-commit install +
+sxapicomes with a lot of hooks configured to automatically help the +developer to check the code being written.
+
Implement your changes¶
+-
+
Create a branch to hold your changes:
+++git checkout -b my-feature +
and start making changes. Never work on the master branch!
+
+Start your work on this branch. Don’t forget to add docstrings to new +functions, modules and classes, especially if they are part of public APIs.
+Add yourself to the list of contributors in
AUTHORS.rst.
+When you’re done editing, do:
+++git add <MODIFIED FILES> +git commit +
to record your changes in git.
+Please make sure to see the validation messages from
+pre-commitand fix +any eventual issues. +This should automatically use flake8/black to check/fix the code style +in a way that is compatible with the project.++Important
+Don’t forget to add unit tests and documentation in case your +contribution adds an additional feature and is not just a bugfix.
+Moreover, writing a descriptive commit message is highly recommended. +In case of doubt, you can check the commit history with:
+++git log --graph --decorate --pretty=oneline --abbrev-commit --all +
to look for recurring communication patterns.
+
+Please check that your changes don’t break any unit tests with:
+++tox +(after having installed
+toxwithpip install toxorpipx).You can also use
+toxto run several other pre-configured tasks in the +repository. Trytox -avto see a list of the available checks.
+
Submit your contribution¶
+-
+
If everything works fine, push your local branch to GitHub with:
+++git push -u origin my-feature +
+Go to the web page of your fork and click “Create pull request” +to send your changes for review.
+Find more detailed information creating a PR. You might also want to open +the PR as a draft first and mark it as ready for review after the feedbacks +from the continuous integration (CI) system or any required fixes.
+
+
Troubleshooting¶
+The following tips can be used when facing problems to build or test the +package:
+-
+
Make sure to fetch all the tags from the upstream repository. +The command
git describe --abbrev=0 --tagsshould return the version you +are expecting. If you are trying to run CI scripts in a fork repository, +make sure to push all the tags. +You can also try to remove all the egg files or the complete egg folder, i.e., +.eggs, as well as the*.egg-infofolders in thesrcfolder or +potentially in the root of your project.
+Sometimes
+toxmisses out when new dependencies are added, especially to +setup.cfganddocs/requirements.txt. If you find any problems with +missing dependencies when running a command withtox, try to recreate the +toxenvironment using the-rflag. For example, instead of:++tox -e docs +
Try running:
+++tox -r -e docs +
+Make sure to have a reliable
+toxinstallation that uses the correct +Python version (e.g., 3.7+). When in doubt you can run:++tox --version +# OR +which tox +
If you have trouble and are seeing weird errors upon running
+tox, you can +also try to create a dedicated virtual environment with atoxbinary +freshly installed. For example:++virtualenv .venv +source .venv/bin/activate +.venv/bin/pip install tox +.venv/bin/tox -e all +
+Pytest can drop you in an interactive session in the case an error occurs. +In order to do that you need to pass a
--pdboption (for example by +runningtox -- -k <NAME OF THE FALLING TEST> --pdb). +You can also setup breakpoints manually instead of using the--pdboption.
+
Maintainer tasks¶
+Releases¶
+If you are part of the group of maintainers and have correct user permissions
+on PyPI, the following steps can be used to release a new version for
+sxapi:
-
+
Make sure all unit tests are successful.
+Tag the current commit on the main branch with a release tag, e.g.,
v1.2.3.
+Push the new tag to the upstream repository, e.g.,
git push upstream v1.2.3
+Clean up the
distandbuildfolders withtox -e clean+(orrm -rf dist build) +to avoid confusion with old builds and Sphinx docs.
+Run
tox -e buildand check that the files indisthave +the correct version (no.dirtyor git hash) according to the git tag. +Also check the sizes of the distributions, if they are too big (e.g., > +500KB), unwanted clutter may have been accidentally included.
+Run
tox -e publish -- --repository pypiand check that everything was +uploaded to PyPI correctly.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..c047751
--- /dev/null
+++ b/index.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+ + +A
+| + | + |
B
+| + |
C
+| + | + |
D
+| + | + |
F
+| + |
G
+H
+| + | + |
I
+| + | + |
M
+
|
+
P
+R
+| + | + |
S
+
|
+
|
+
T
+| + | + |
U
+| + | + |
V
+| + |
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/license.html b/license.html
new file mode 100644
index 0000000..433a974
--- /dev/null
+++ b/license.html
@@ -0,0 +1,298 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sxapi¶
+This is the documentation of sxapi.
+
+
+Note
+This is the main page of your project’s Sphinx documentation.
+It is formatted in reStructuredText. Add additional pages
+by creating rst-files in docs and adding them to the toctree below.
+Use then references in order to link them from this page, e.g.
+Contributors and Changelog.
It is also possible to refer to the documentation of other Python packages
+with the Python domain syntax. By default you can reference the
+documentation of Sphinx, Python, NumPy, SciPy, matplotlib,
+Pandas, Scikit-Learn. You can add more by extending the
+intersphinx_mapping in your Sphinx’s conf.py.
The pretty useful extension autodoc is activated by default and lets +you include documentation from docstrings. Docstrings can be written in +Google style (recommended!), NumPy style and classical style.
+Contents¶
+
+
+-
+
- Overview
-
+
- Note +
+ - Contributions & Help + +
- License +
- Authors +
- Changelog + +
- Module Reference + +
Indices and tables¶
+-
+
- +
- +
- +
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
new file mode 100644
index 0000000000000000000000000000000000000000..112f720c1d2d1b395f59ee1cee9261d85d50d774
GIT binary patch
literal 1314
zcmV+-1>O21AX9K?X>NERX>N99Zgg*Qc_4OWa&u{KZXhxWBOp+6Z)#;@bUGk&cwum9
z3L_v^WpZ
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ License¶
+++++++ +++Apache License
+Version 2.0, January 2004
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
++
+- +
Definitions.
+“License” shall mean the terms and conditions for use, reproduction, +and distribution as defined by Sections 1 through 9 of this document.
+“Licensor” shall mean the copyright owner or entity authorized by +the copyright owner that is granting the License.
+“Legal Entity” shall mean the union of the acting entity and all +other entities that control, are controlled by, or are under common +control with that entity. For the purposes of this definition, +“control” means (i) the power, direct or indirect, to cause the +direction or management of such entity, whether by contract or +otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity.
+“You” (or “Your”) shall mean an individual or Legal Entity +exercising permissions granted by this License.
+“Source” form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation +source, and configuration files.
+“Object” form shall mean any form resulting from mechanical +transformation or translation of a Source form, including but +not limited to compiled object code, generated documentation, +and conversions to other media types.
+“Work” shall mean the work of authorship, whether in Source or +Object form, made available under the License, as indicated by a +copyright notice that is included in or attached to the work +(an example is provided in the Appendix below).
+“Derivative Works” shall mean any work, whether in Source or Object +form, that is based on (or derived from) the Work and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. For the purposes +of this License, Derivative Works shall not include works that remain +separable from, or merely link (or bind by name) to the interfaces of, +the Work and Derivative Works thereof.
+“Contribution” shall mean any work of authorship, including +the original version of the Work and any modifications or additions +to that Work or Derivative Works thereof, that is intentionally +submitted to Licensor for inclusion in the Work by the copyright owner +or by an individual or Legal Entity authorized to submit on behalf of +the copyright owner. For the purposes of this definition, “submitted” +means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, +and issue tracking systems that are managed by, or on behalf of, the +Licensor for the purpose of discussing and improving the Work, but +excluding communication that is conspicuously marked or otherwise +designated in writing by the copyright owner as “Not a Contribution.”
+“Contributor” shall mean Licensor and any individual or Legal Entity +on behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work.
+- +
Grant of Copyright License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the +Work and such Derivative Works in Source or Object form.
- +
Grant of Patent License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +(except as stated in this section) patent license to make, have made, +use, offer to sell, sell, import, and otherwise transfer the Work, +where such license applies only to those patent claims licensable +by such Contributor that are necessarily infringed by their +Contribution(s) alone or by combination of their Contribution(s) +with the Work to which such Contribution(s) was submitted. If You +institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work +or a Contribution incorporated within the Work constitutes direct +or contributory patent infringement, then any patent licenses +granted to You under this License for that Work shall terminate +as of the date such litigation is filed.
- +
Redistribution. You may reproduce and distribute copies of the +Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You +meet the following conditions:
++
+- +
You must give any other recipients of the Work or +Derivative Works a copy of this License; and
- +
You must cause any modified files to carry prominent notices +stating that You changed the files; and
- +
You must retain, in the Source form of any Derivative Works +that You distribute, all copyright, patent, trademark, and +attribution notices from the Source form of the Work, +excluding those notices that do not pertain to any part of +the Derivative Works; and
- +
If the Work includes a “NOTICE” text file as part of its +distribution, then any Derivative Works that You distribute must +include a readable copy of the attribution notices contained +within such NOTICE file, excluding those notices that do not +pertain to any part of the Derivative Works, in at least one +of the following places: within a NOTICE text file distributed +as part of the Derivative Works; within the Source form or +documentation, if provided along with the Derivative Works; or, +within a display generated by the Derivative Works, if and +wherever such third-party notices normally appear. The contents +of the NOTICE file are for informational purposes only and +do not modify the License. You may add Your own attribution +notices within Derivative Works that You distribute, alongside +or as an addendum to the NOTICE text from the Work, provided +that such additional attribution notices cannot be construed +as modifying the License.
You may add Your own copyright statement to Your modifications and +may provide additional or different license terms and conditions +for use, reproduction, or distribution of Your modifications, or +for any such Derivative Works as a whole, provided Your use, +reproduction, and distribution of the Work otherwise complies with +the conditions stated in this License.
+- +
Submission of Contributions. Unless You explicitly state otherwise, +any Contribution intentionally submitted for inclusion in the Work +by You to the Licensor shall be under the terms and conditions of +this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify +the terms of any separate license agreement you may have executed +with Licensor regarding such Contributions.
- +
Trademarks. This License does not grant permission to use the trade +names, trademarks, service marks, or product names of the Licensor, +except as required for reasonable and customary use in describing the +origin of the Work and reproducing the content of the NOTICE file.
- +
Disclaimer of Warranty. Unless required by applicable law or +agreed to in writing, Licensor provides the Work (and each +Contributor provides its Contributions) on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied, including, without limitation, any warranties or conditions +of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. You are solely responsible for determining the +appropriateness of using or redistributing the Work and assume any +risks associated with Your exercise of permissions under this License.
- +
Limitation of Liability. In no event and under no legal theory, +whether in tort (including negligence), contract, or otherwise, +unless required by applicable law (such as deliberate and grossly +negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, +incidental, or consequential damages of any character arising as a +result of this License or out of the use or inability to use the +Work (including but not limited to damages for loss of goodwill, +work stoppage, computer failure or malfunction, or any and all +other commercial damages or losses), even if such Contributor +has been advised of the possibility of such damages.
- +
Accepting Warranty or Additional Liability. While redistributing +the Work or Derivative Works thereof, You may choose to offer, +and charge a fee for, acceptance of support, warranty, indemnity, +or other liability obligations and/or rights consistent with this +License. However, in accepting such obligations, You may act only +on Your own behalf and on Your sole responsibility, not on behalf +of any other Contributor, and only if You agree to indemnify, +defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason +of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
+APPENDIX: How to apply the Apache License to your work.
+++To apply the Apache License to your work, attach the following +boilerplate notice, with the fields enclosed by brackets “[]” +replaced with your own identifying information. (Don’t include +the brackets!) The text should be enclosed in the appropriate +comment syntax for the file format. We also recommend that a +file or class name and description of purpose be included on the +same “printed page” as the copyright notice for easier +identification within third-party archives.
+Copyright [yyyy] [name of copyright owner]
+Licensed under the Apache License, Version 2.0 (the “License”); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at
+++Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/readme.html b/readme.html
new file mode 100644
index 0000000..0170f96
--- /dev/null
+++ b/readme.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Python Module Index
+ +
+ s
+
+
+ | + s | ||
| + |
+ sxapi | + |
| + |
+ sxapi.base | + |
| + |
+ sxapi.cli | + |
| + |
+ sxapi.cli.cli | + |
| + |
+ sxapi.cli.cli_user | + |
| + |
+ sxapi.cli.subparser | + |
| + |
+ sxapi.cli.subparser.get_sensor_data | + |
| + |
+ sxapi.cli.subparser.token | + |
| + |
+ sxapi.publicV2 | + |
| + |
+ sxapi.publicV2.alarms | + |
| + |
+ sxapi.publicV2.data | + |
| + |
+ sxapi.publicV2.feedrations | + |
| + |
+ sxapi.publicV2.groups | + |
| + |
+ sxapi.publicV2.sensordata | + |
| + |
+ sxapi.publicV2.todos | + |
| + |
+ sxapi.publicV2.users | + |
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search.html b/search.html
new file mode 100644
index 0000000..e645474
--- /dev/null
+++ b/search.html
@@ -0,0 +1,125 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+sxapi¶
+++a new API to interact with the smaXtec system.
+
sxapi lets you import and export data through an easy to understand python API and a command line interface.
+Note¶
+This project has been set up using PyScaffold 4.1. For details and usage +information on PyScaffold see https://pyscaffold.org/.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
new file mode 100644
index 0000000..4c222f9
--- /dev/null
+++ b/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"docnames": ["api/modules", "api/sxapi", "api/sxapi.cli", "api/sxapi.cli.subparser", "api/sxapi.publicV2", "authors", "changelog", "contributing", "index", "license", "readme"], "filenames": ["api/modules.rst", "api/sxapi.rst", "api/sxapi.cli.rst", "api/sxapi.cli.subparser.rst", "api/sxapi.publicV2.rst", "authors.rst", "changelog.rst", "contributing.rst", "index.rst", "license.rst", "readme.rst"], "titles": ["sxapi", "sxapi package", "sxapi.cli package", "sxapi.cli.subparser namespace", "sxapi.publicV2 package", "Contributors", "Changelog", "Contributing", "sxapi", "License", "sxapi"], "terms": {"packag": [0, 7, 8], "subpackag": 0, "cli": [0, 1], "submodul": 0, "modul": [0, 7, 8], "cli_us": [0, 1], "content": [0, 9], "publicv2": [0, 1, 2], "alarm": [0, 1], "data": [0, 1, 3, 10], "feedrat": [0, 1], "group": [0, 1, 7], "sensordata": [0, 1], "todo": [0, 1], "user": [0, 1, 7], "base": [0, 2, 4, 7, 9], "apityp": [0, 1], "integr": [0, 1, 2, 7], "public": [0, 1, 7], "baseapi": [0, 1, 4], "delet": [0, 1, 2, 3, 4], "get": [0, 1, 2, 3, 4, 7], "get_token": [0, 1], "post": [0, 1, 4], "put": [0, 1, 4], "session": [0, 1, 7], "to_url": [0, 1], "integrationapiv2": [0, 1], "subpars": [1, 2], "namespac": [1, 2], "get_sensor_data": [1, 2], "token": [1, 2, 4, 7], "api_statu": [1, 2], "parse_arg": [1, 2], "read_config_from_fil": [1, 2], "run": [1, 2, 7], "update_config_with_env": [1, 2], "version_info": [1, 2], "cli_run": [1, 2], "cliuser": [1, 2], "check_credentials_set": [1, 2], "clear_token_keyr": [1, 2], "get_token_environ": [1, 2], "get_token_keyr": [1, 2], "init_us": [1, 2], "set_token_keyr": [1, 2], "get_categori": [1, 4], "get_data_anim": [1, 4], "get_data_devic": [1, 4], "get_data_feedr": [1, 4], "get_data_group": [1, 4], "get_download_animal_data": [1, 4], "get_download_device_data": [1, 4], "get_download_group_data": [1, 4], "get_download": [1, 4], "get_metrics_anim": [1, 4], "get_metrics_devic": [1, 4], "get_metrics_group": [1, 4], "post_downloads_excel_report": [1, 4], "post_downloads_messages_excel_report": [1, 4], "post_downloads_organisation_messages_excel_report": [1, 4], "delete_act": [1, 4], "get_act": [1, 4], "put_act": [1, 4], "get_sensor_data_from_anim": [1, 4], "delete_com": [1, 4], "post_com": [1, 4], "put_com": [1, 4], "delete_token": [1, 4], "get_account": [1, 4], "get_alarm": [1, 4], "get_credenti": [1, 4], "get_reset_password_request": [1, 4], "get_shar": [1, 4], "post_activ": [1, 4], "post_credenti": [1, 4], "post_password_strength": [1, 4], "post_reset_password": [1, 4], "post_test_email": [1, 4], "post_test_push": [1, 4], "post_token": [1, 4], "post_update_metadata": [1, 4], "put_change_password": [1, 4], "put_token": [1, 4], "publicapiv2": [1, 3, 4], "class": [1, 2, 4, 7, 9], "valu": [1, 4], "sourc": [1, 2, 3, 4, 7, 9], "enum": 1, "an": [1, 3, 4, 9, 10], "enumer": 1, "2": [1, 7, 9], "1": [1, 7, 8, 9, 10], "base_url": [1, 4], "email": [1, 4], "none": [1, 4], "password": [1, 2, 3, 4], "api_token": [1, 4], "api_typ": 1, "object": [1, 2, 4, 9], "path": [1, 7], "arg": [1, 2, 3, 4], "kwarg": [1, 4], "properti": 1, "geneat": 1, "new": [1, 3, 4, 7, 10], "http": [1, 4, 7, 9, 10], "fly": 1, "log": [1, 7], "exist": [1, 4], "create_gsd_pars": [2, 3], "gsd_sub_funct": [2, 3], "create_token_pars": [2, 3], "handle_clear_token": [2, 3], "handle_new_token": [2, 3], "handle_print_token": [2, 3], "handle_set_token": [2, 3], "token_sub_funct": [2, 3], "handl": 2, "argument": [2, 3], "call": [2, 3, 4, 7], "api": [2, 3, 4, 7, 10], "static": 2, "print": [2, 3, 9], "onlin": 2, "statu": 2, "v2": [2, 4], "pars": [2, 3], "from": [2, 3, 4, 7, 8, 9], "initi": 2, "config_file_path": 2, "function": [2, 3, 4, 7], "pass": [2, 7], "config_dict": 2, "version": [2, 7, 8, 9], "info": [2, 7], "start": [2, 3, 7], "us": [2, 3, 7, 8, 9, 10], "store": [2, 3], "retriev": [2, 4], "credenti": [2, 3], "creat": [2, 3, 4, 8], "hold": [2, 7, 9], "instanc": [2, 3], "support": [2, 4, 9], "client": 2, "thi": [2, 3, 4, 7, 8, 9, 10], "should": [2, 4, 7, 9], "onli": [2, 3, 7, 9], "check": [2, 3, 4, 7], "i": [2, 3, 4, 7, 8, 9], "alreadi": [2, 7], "set": [2, 10], "keyr": [2, 3], "name": [2, 4, 7, 9], "smaxtec_api_access_token": 2, "system": [2, 7, 9, 10], "environ": [2, 3], "args_token": 2, "args_keyr": 2, "specifi": 2, "resourc": [2, 7], "integrationv2": 2, "If": [2, 4, 7, 9], "can": [2, 7, 8], "found": 2, "via": [2, 7], "usernam": [2, 3, 4], "ar": [2, 3, 7, 9], "also": [2, 7, 8, 9], "miss": [2, 7], "given": [2, 3, 4], "cli_test": 3, "respons": [3, 4, 9], "perform": [3, 4, 9], "sensor": 3, "anim": [3, 4], "The": [3, 7, 8, 9], "animals_id": 3, "mandatori": 3, "animal_id": [3, 4], "It": [3, 8], "repres": [3, 4, 9], "you": [3, 7, 8, 9, 10], "want": [3, 7], "follow": [3, 7, 9], "flag": [3, 7], "option": [3, 4, 7], "metric": [3, 4], "m": [3, 7], "defin": [3, 9], "expect": [3, 7], "most": 3, "two": 3, "temp": 3, "act": [3, 9], "both": 3, "togeth": 3, "where": [3, 9], "mean": [3, 7, 9], "temperatur": 3, "activ": [3, 4, 7, 8], "from_dat": [3, 4], "date": [3, 4, 9], "window": 3, "exactli": 3, "one": [3, 4, 7, 9], "datetim": 3, "format": [3, 8, 9], "yyyi": [3, 9], "mm": 3, "dd": 3, "e": [3, 7, 8], "g": [3, 7, 8], "2022": 3, "01": 3, "12": 3, "to_dat": [3, 4], "end": [3, 4, 9], "default": [3, 8], "pare": 3, "which": [3, 4, 7, 9], "desir": [3, 4], "manag": [3, 9], "print_token": 3, "p": 3, "stdout": 3, "k": [3, 7], "ek": 3, "same": [3, 7, 9], "time": 3, "set_keyr": 3, "": [3, 7, 8, 9], "clear_keyr": 3, "c": 3, "doesn": 3, "t": [3, 7, 9], "ani": [3, 7, 9], "new_token": 3, "n": 3, "smaxtec": [3, 4, 5, 7, 10], "possibl": [3, 8, 9], "more": [3, 7, 8, 9], "than": 3, "those": [3, 9], "logic": 3, "behind": [3, 7], "specif": [3, 9], "helper": 3, "see": [3, 7, 9, 10], "below": [3, 8, 9], "accord": [3, 7], "present": 3, "endpoint": 4, "com": [4, 5, 7], "alarm_id": 4, "paramet": 4, "str": 4, "id": 4, "find": [4, 7], "under": [4, 7, 9], "return": [4, 7], "success": [4, 7], "error": [4, 7], "messag": [4, 7], "els": 4, "type": [4, 9], "dict": 4, "queri": 4, "all": [4, 7, 9], "categori": 4, "organis": 4, "badrequesterror": 4, "list": [4, 7, 9], "organisation_id": 4, "titl": [4, 9], "updat": [4, 7], "fo": 4, "request": [4, 7], "device_id": 4, "devic": 4, "feedration_id": 4, "group_id": 4, "download": 4, "download_id": 4, "gener": [4, 7, 9], "excel": [4, 7], "report": [4, 8], "avail": [4, 7, 9], "send": [4, 7], "contain": [4, 9], "link": [4, 8, 9], "empti": 4, "result": [4, 9], "action_id": 4, "action": 4, "add": [4, 7, 8, 9], "public_api_v2": 4, "todo_id": 4, "comment_id": 4, "comment": [4, 9], "todo_typ": 4, "user_id": 4, "account": [4, 7], "access": [4, 7], "jwt": 4, "current": [4, 7], "addit": [4, 7, 8, 9], "inform": [4, 7, 9, 10], "reset": 4, "share": [4, 9], "user_secret": 4, "secret": 4, "receiv": [4, 9], "registr": 4, "firestor": 4, "strength": 4, "new_password": 4, "test": [4, 7], "push": [4, 7], "notif": 4, "platform": 4, "token_typ": 4, "some": 4, "kind": [4, 7, 9], "push_": 4, "metadata": 4, "old_password": 4, "chang": [4, 9], "old": [4, 7], "doe": [4, 9], "florian": 5, "klien": 5, "philipp": 5, "kulich": 5, "marco": 5, "julian": 5, "moser": 5, "hyper_chrom": 5, "gmx": 5, "init": 6, "welcom": 7, "sxapi": 7, "contributor": [7, 8, 9], "guid": 7, "focus": 7, "potenti": 7, "familiar": 7, "develop": 7, "process": 7, "other": [7, 8, 9], "appreci": 7, "git": 7, "have": [7, 9], "never": 7, "collabor": 7, "project": [7, 8, 10], "previous": 7, "pleas": 7, "look": 7, "org": [7, 9, 10], "freecodecamp": 7, "notic": [7, 9], "open": 7, "consider": 7, "reason": [7, 9], "respect": 7, "when": 7, "doubt": 7, "python": [7, 8, 10], "softwar": [7, 9], "foundat": 7, "conduct": 7, "good": 7, "refer": [7, 8], "term": [7, 9], "behavior": 7, "guidelin": 7, "experi": 7, "bug": 7, "tracker": 7, "don": [7, 9], "anyth": 7, "feel": 7, "free": [7, 9], "fire": 7, "forget": 7, "includ": [7, 8, 9], "close": 7, "search": [7, 8], "sometim": 7, "solut": 7, "wa": [7, 9], "problem": 7, "consid": 7, "solv": 7, "about": 7, "program": 7, "oper": 7, "step": 7, "reproduc": [7, 9], "try": 7, "simplifi": 7, "reproduct": [7, 9], "veri": 7, "minim": 7, "exampl": [7, 9], "still": 7, "illustr": 7, "face": 7, "By": [7, 8], "remov": 7, "factor": 7, "help": [7, 8], "u": 7, "identifi": [7, 9], "root": 7, "caus": [7, 9], "doc": [7, 8], "make": [7, 9], "them": [7, 8], "readabl": [7, 9], "coher": 7, "ad": [7, 8], "correct": 7, "mistak": 7, "sphinx": [7, 8], "its": [7, 9], "main": [7, 8], "compil": [7, 9], "restructuredtext": [7, 8], "markup": 7, "languag": [7, 9], "kept": 7, "done": 7, "wai": 7, "github": 7, "web": 7, "interfac": [7, 9, 10], "provid": [7, 9], "quick": 7, "propos": 7, "file": [7, 8, 9], "while": [7, 9], "mechan": [7, 9], "tricki": 7, "normal": [7, 9], "work": [7, 9], "perfectli": 7, "fine": 7, "quit": 7, "handi": 7, "interest": 7, "method": 7, "out": [7, 9], "navig": 7, "folder": 7, "would": 7, "like": 7, "click": 7, "littl": 7, "pencil": 7, "icon": 7, "top": 7, "editor": 7, "onc": 7, "finish": 7, "edit": 7, "write": [7, 9], "form": [7, 9], "bottom": 7, "page": [7, 8, 9], "describ": [7, 9], "made": [7, 9], "what": 7, "motiv": 7, "local": 7, "machin": 7, "tox": 7, "built": 7, "server": 7, "preview": 7, "browser": 7, "localhost": 7, "8000": 7, "python3": 7, "directori": 7, "_build": 7, "html": 7, "after": 7, "must": [7, 9], "fix": 7, "contact": 7, "need": 7, "befor": 7, "non": [7, 9], "trivial": 7, "best": 7, "first": 7, "discuss": [7, 9], "subject": [7, 9], "often": 7, "avoid": 7, "unnecessari": 7, "we": [7, 9], "recommend": [7, 8, 9], "isol": 7, "virtual": 7, "instal": 7, "easili": 7, "either": [7, 9], "virtualenv": 7, "TO": 7, "venv": 7, "bin": 7, "do": [7, 9], "fork": 7, "button": 7, "copi": [7, 9], "disk": 7, "yourlogin": 7, "cd": 7, "pip": 7, "setuptool": 7, "abl": 7, "putup": 7, "pre": 7, "commit": 7, "come": 7, "lot": 7, "hook": 7, "configur": [7, 9], "automat": 7, "being": 7, "written": [7, 8, 9], "branch": 7, "checkout": 7, "b": 7, "my": 7, "featur": 7, "master": 7, "docstr": [7, 8], "especi": 7, "thei": 7, "part": [7, 9], "yourself": 7, "author": [7, 8, 9], "rst": [7, 8], "re": 7, "modifi": [7, 9], "record": 7, "sure": 7, "valid": 7, "eventu": 7, "flake8": 7, "black": 7, "style": [7, 8], "compat": 7, "unit": 7, "case": 7, "just": 7, "bugfix": 7, "moreov": 7, "descript": [7, 9], "highli": 7, "In": [7, 9], "histori": 7, "graph": 7, "decor": 7, "pretti": [7, 8], "onelin": 7, "abbrev": 7, "recur": 7, "commun": [7, 9], "pattern": 7, "break": 7, "pipx": 7, "sever": 7, "av": 7, "everyth": 7, "origin": [7, 9], "go": 7, "pull": 7, "review": 7, "detail": [7, 10], "pr": 7, "might": 7, "draft": 7, "mark": [7, 9], "readi": 7, "feedback": 7, "continu": 7, "ci": 7, "requir": [7, 9], "tip": 7, "build": 7, "fetch": 7, "tag": 7, "upstream": 7, "command": [7, 10], "0": [7, 9], "script": 7, "egg": 7, "complet": 7, "well": 7, "src": 7, "depend": 7, "setup": 7, "cfg": 7, "txt": 7, "recreat": 7, "r": 7, "For": [7, 9, 10], "instead": 7, "reliabl": 7, "3": 7, "7": 7, "OR": [7, 9], "troubl": 7, "weird": 7, "upon": 7, "dedic": 7, "binari": 7, "freshli": 7, "pytest": 7, "drop": 7, "interact": [7, 10], "occur": 7, "order": [7, 8], "pdb": 7, "OF": [7, 9], "THE": 7, "fall": 7, "breakpoint": 7, "manual": 7, "permiss": [7, 9], "pypi": 7, "v1": 7, "clean": 7, "up": [7, 10], "dist": 7, "rm": 7, "rf": 7, "confus": 7, "dirti": 7, "hash": 7, "size": 7, "distribut": [7, 9], "too": 7, "big": 7, "500kb": 7, "unwant": 7, "clutter": 7, "mai": [7, 9], "been": [7, 9, 10], "accident": 7, "publish": 7, "upload": 7, "correctli": 7, "even": [7, 9], "though": 7, "focu": 7, "idea": 7, "collect": 7, "appli": [7, 9], "sort": 7, "privat": 7, "compani": 7, "proprietari": 7, "definit": [7, 9], "document": [8, 9], "your": [8, 9], "toctre": 8, "changelog": 8, "domain": 8, "syntax": [8, 9], "numpi": 8, "scipi": 8, "matplotlib": 8, "panda": 8, "scikit": 8, "learn": 8, "extend": 8, "intersphinx_map": 8, "conf": 8, "py": 8, "extens": 8, "autodoc": 8, "let": [8, 10], "googl": 8, "classic": 8, "overview": 8, "note": 8, "contribut": [8, 9], "issu": [8, 9], "improv": [8, 9], "code": [8, 9], "maintain": 8, "task": 8, "licens": 8, "0b1": 8, "index": 8, "apach": 9, "januari": 9, "2004": 9, "www": 9, "AND": 9, "condit": 9, "FOR": 9, "shall": 9, "section": 9, "through": [9, 10], "9": 9, "licensor": 9, "copyright": 9, "owner": 9, "entiti": 9, "grant": 9, "legal": 9, "union": 9, "control": 9, "common": 9, "purpos": 9, "power": 9, "direct": 9, "indirect": 9, "whether": 9, "contract": 9, "otherwis": 9, "ii": 9, "ownership": 9, "fifti": 9, "percent": 9, "50": 9, "outstand": 9, "iii": 9, "benefici": 9, "individu": 9, "exercis": 9, "prefer": 9, "modif": 9, "limit": 9, "transform": 9, "translat": 9, "convers": 9, "media": 9, "authorship": 9, "indic": 9, "attach": 9, "appendix": 9, "deriv": 9, "editori": 9, "revis": 9, "annot": 9, "elabor": 9, "whole": 9, "remain": 9, "separ": 9, "mere": 9, "bind": 9, "thereof": 9, "intention": 9, "submit": 9, "inclus": 9, "behalf": 9, "electron": 9, "verbal": 9, "sent": 9, "mail": 9, "track": 9, "exclud": 9, "conspicu": 9, "design": 9, "Not": 9, "whom": 9, "ha": [9, 10], "subsequ": 9, "incorpor": 9, "within": 9, "each": 9, "herebi": 9, "perpetu": 9, "worldwid": 9, "exclus": 9, "charg": 9, "royalti": 9, "irrevoc": 9, "prepar": 9, "publicli": 9, "displai": 9, "sublicens": 9, "patent": 9, "except": 9, "state": 9, "offer": 9, "sell": 9, "import": [9, 10], "transfer": 9, "claim": 9, "necessarili": 9, "infring": 9, "alon": 9, "combin": 9, "institut": 9, "litig": 9, "against": 9, "cross": 9, "counterclaim": 9, "lawsuit": 9, "alleg": 9, "constitut": 9, "contributori": 9, "termin": 9, "redistribut": 9, "medium": 9, "without": 9, "meet": 9, "give": 9, "recipi": 9, "carri": 9, "promin": 9, "retain": 9, "trademark": 9, "attribut": 9, "pertain": 9, "text": 9, "least": 9, "place": 9, "along": 9, "wherev": 9, "third": 9, "parti": 9, "appear": 9, "own": 9, "alongsid": 9, "addendum": 9, "cannot": 9, "constru": 9, "statement": 9, "differ": 9, "compli": 9, "submiss": 9, "unless": 9, "explicitli": 9, "notwithstand": 9, "abov": 9, "noth": 9, "herein": 9, "supersed": 9, "agreement": 9, "execut": 9, "regard": 9, "trade": 9, "servic": 9, "product": 9, "customari": 9, "disclaim": 9, "warranti": 9, "applic": 9, "law": 9, "agre": 9, "AS": 9, "basi": 9, "express": 9, "impli": 9, "merchant": 9, "fit": 9, "A": 9, "particular": 9, "sole": 9, "determin": 9, "appropri": 9, "assum": 9, "risk": 9, "associ": 9, "liabil": 9, "event": 9, "theori": 9, "tort": 9, "neglig": 9, "deliber": 9, "grossli": 9, "liabl": 9, "damag": 9, "special": 9, "incident": 9, "consequenti": 9, "charact": 9, "aris": 9, "inabl": 9, "loss": 9, "goodwil": 9, "stoppag": 9, "comput": 9, "failur": 9, "malfunct": 9, "commerci": 9, "advis": 9, "accept": 9, "choos": 9, "fee": 9, "indemn": 9, "oblig": 9, "right": 9, "consist": 9, "howev": 9, "indemnifi": 9, "defend": 9, "harmless": 9, "incur": 9, "assert": 9, "how": 9, "To": 9, "boilerpl": 9, "field": 9, "enclos": 9, "bracket": 9, "replac": 9, "easier": 9, "identif": 9, "archiv": 9, "complianc": 9, "obtain": 9, "govern": 9, "export": 10, "easi": 10, "understand": 10, "line": 10, "pyscaffold": 10, "4": 10, "usag": 10}, "objects": {"": [[1, 0, 0, "-", "sxapi"]], "sxapi": [[1, 0, 0, "-", "base"], [2, 0, 0, "-", "cli"], [4, 0, 0, "-", "publicV2"]], "sxapi.base": [[1, 1, 1, "", "ApiTypes"], [1, 1, 1, "", "BaseAPI"], [1, 1, 1, "", "IntegrationAPIV2"]], "sxapi.base.ApiTypes": [[1, 2, 1, "", "INTEGRATION"], [1, 2, 1, "", "PUBLIC"]], "sxapi.base.BaseAPI": [[1, 3, 1, "", "delete"], [1, 3, 1, "", "get"], [1, 3, 1, "", "get_token"], [1, 3, 1, "", "post"], [1, 3, 1, "", "put"], [1, 4, 1, "", "session"], [1, 3, 1, "", "to_url"]], "sxapi.cli": [[2, 0, 0, "-", "cli"], [2, 0, 0, "-", "cli_user"], [3, 0, 0, "-", "subparser"]], "sxapi.cli.cli": [[2, 1, 1, "", "Cli"], [2, 5, 1, "", "cli_run"]], "sxapi.cli.cli.Cli": [[2, 3, 1, "", "api_status"], [2, 3, 1, "", "parse_args"], [2, 3, 1, "", "read_config_from_file"], [2, 3, 1, "", "run"], [2, 3, 1, "", "update_config_with_env"], [2, 3, 1, "", "version_info"]], "sxapi.cli.cli_user": [[2, 1, 1, "", "CliUser"]], "sxapi.cli.cli_user.CliUser": [[2, 3, 1, "", "check_credentials_set"], [2, 3, 1, "", "clear_token_keyring"], [2, 3, 1, "", "get_token_environment"], [2, 3, 1, "", "get_token_keyring"], [2, 3, 1, "", "init_user"], [2, 3, 1, "", "set_token_keyring"]], "sxapi.cli.subparser": [[3, 0, 0, "-", "get_sensor_data"], [3, 0, 0, "-", "token"]], "sxapi.cli.subparser.get_sensor_data": [[3, 5, 1, "", "create_gsd_parser"], [3, 5, 1, "", "gsd_sub_function"]], "sxapi.cli.subparser.token": [[3, 5, 1, "", "create_token_parser"], [3, 5, 1, "", "handle_clear_token"], [3, 5, 1, "", "handle_new_token"], [3, 5, 1, "", "handle_print_token"], [3, 5, 1, "", "handle_set_token"], [3, 5, 1, "", "token_sub_function"]], "sxapi.publicV2": [[4, 1, 1, "", "PublicAPIV2"], [4, 0, 0, "-", "alarms"], [4, 0, 0, "-", "data"], [4, 0, 0, "-", "feedrations"], [4, 0, 0, "-", "groups"], [4, 0, 0, "-", "sensordata"], [4, 0, 0, "-", "todos"], [4, 0, 0, "-", "users"]], "sxapi.publicV2.alarms": [[4, 1, 1, "", "Alarms"]], "sxapi.publicV2.alarms.Alarms": [[4, 3, 1, "", "delete"], [4, 3, 1, "", "get"], [4, 3, 1, "", "get_categories"], [4, 3, 1, "", "post"], [4, 3, 1, "", "put"]], "sxapi.publicV2.data": [[4, 1, 1, "", "Data"]], "sxapi.publicV2.data.Data": [[4, 3, 1, "", "get_data_animals"], [4, 3, 1, "", "get_data_devices"], [4, 3, 1, "", "get_data_feedrations"], [4, 3, 1, "", "get_data_groups"], [4, 3, 1, "", "get_download_animal_data"], [4, 3, 1, "", "get_download_device_data"], [4, 3, 1, "", "get_download_group_data"], [4, 3, 1, "", "get_downloads"], [4, 3, 1, "", "get_metrics_animals"], [4, 3, 1, "", "get_metrics_devices"], [4, 3, 1, "", "get_metrics_groups"], [4, 3, 1, "", "post_downloads_excel_report"], [4, 3, 1, "", "post_downloads_messages_excel_report"], [4, 3, 1, "", "post_downloads_organisation_messages_excel_report"]], "sxapi.publicV2.feedrations": [[4, 1, 1, "", "Feedrations"]], "sxapi.publicV2.feedrations.Feedrations": [[4, 3, 1, "", "delete"], [4, 3, 1, "", "get"], [4, 3, 1, "", "post"], [4, 3, 1, "", "put"]], "sxapi.publicV2.groups": [[4, 1, 1, "", "Groups"]], "sxapi.publicV2.groups.Groups": [[4, 3, 1, "", "delete_actions"], [4, 3, 1, "", "get_actions"], [4, 3, 1, "", "put_actions"]], "sxapi.publicV2.sensordata": [[4, 5, 1, "", "get_sensor_data_from_animal"]], "sxapi.publicV2.todos": [[4, 1, 1, "", "Todos"]], "sxapi.publicV2.todos.Todos": [[4, 3, 1, "", "delete_comment"], [4, 3, 1, "", "get"], [4, 3, 1, "", "post"], [4, 3, 1, "", "post_comment"], [4, 3, 1, "", "put"], [4, 3, 1, "", "put_comment"]], "sxapi.publicV2.users": [[4, 1, 1, "", "Users"]], "sxapi.publicV2.users.Users": [[4, 3, 1, "", "delete_tokens"], [4, 3, 1, "", "get"], [4, 3, 1, "", "get_account"], [4, 3, 1, "", "get_alarms"], [4, 3, 1, "", "get_credentials"], [4, 3, 1, "", "get_reset_password_request"], [4, 3, 1, "", "get_shares"], [4, 3, 1, "", "post_activate"], [4, 3, 1, "", "post_credentials"], [4, 3, 1, "", "post_password_strength"], [4, 3, 1, "", "post_reset_password"], [4, 3, 1, "", "post_test_email"], [4, 3, 1, "", "post_test_push"], [4, 3, 1, "", "post_tokens"], [4, 3, 1, "", "post_update_metadata"], [4, 3, 1, "", "put_change_password"], [4, 3, 1, "", "put_tokens"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"]}, "titleterms": {"sxapi": [0, 1, 2, 3, 4, 8, 10], "packag": [1, 2, 4], "subpackag": [1, 2], "submodul": [1, 2, 3, 4], "base": 1, "modul": [1, 2, 3, 4], "content": [1, 2, 4, 8], "cli": [2, 3], "cli_us": 2, "subpars": 3, "namespac": 3, "get_sensor_data": 3, "token": 3, "publicv2": 4, "alarm": 4, "data": 4, "feedrat": 4, "group": 4, "sensordata": 4, "todo": [4, 7], "user": 4, "contributor": 5, "changelog": 6, "version": 6, "1": 6, "0b1": 6, "contribut": 7, "issu": 7, "report": 7, "document": 7, "improv": 7, "code": 7, "submit": 7, "an": 7, "creat": 7, "environ": 7, "clone": 7, "repositori": 7, "implement": 7, "your": 7, "chang": 7, "troubleshoot": 7, "maintain": 7, "task": 7, "releas": 7, "indic": 8, "tabl": 8, "licens": 9, "note": 10}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"sxapi": [[0, "sxapi"], [8, "sxapi"], [10, "sxapi"]], "sxapi package": [[1, "sxapi-package"]], "Subpackages": [[1, "subpackages"], [2, "subpackages"]], "Submodules": [[1, "submodules"], [2, "submodules"], [3, "submodules"], [4, "submodules"]], "sxapi.base module": [[1, "module-sxapi.base"]], "Module contents": [[1, "module-sxapi"], [2, "module-sxapi.cli"], [4, "module-sxapi.publicV2"]], "sxapi.cli package": [[2, "sxapi-cli-package"]], "sxapi.cli.cli module": [[2, "module-sxapi.cli.cli"]], "sxapi.cli.cli_user module": [[2, "module-sxapi.cli.cli_user"]], "sxapi.cli.subparser namespace": [[3, "module-sxapi.cli.subparser"]], "sxapi.cli.subparser.get_sensor_data module": [[3, "module-sxapi.cli.subparser.get_sensor_data"]], "sxapi.cli.subparser.token module": [[3, "module-sxapi.cli.subparser.token"]], "sxapi.publicV2 package": [[4, "sxapi-publicv2-package"]], "sxapi.publicV2.alarms module": [[4, "module-sxapi.publicV2.alarms"]], "sxapi.publicV2.data module": [[4, "module-sxapi.publicV2.data"]], "sxapi.publicV2.feedrations module": [[4, "module-sxapi.publicV2.feedrations"]], "sxapi.publicV2.groups module": [[4, "module-sxapi.publicV2.groups"]], "sxapi.publicV2.sensordata module": [[4, "module-sxapi.publicV2.sensordata"]], "sxapi.publicV2.todos module": [[4, "module-sxapi.publicV2.todos"]], "sxapi.publicV2.users module": [[4, "module-sxapi.publicV2.users"]], "Contributors": [[5, "contributors"]], "Changelog": [[6, "changelog"]], "Version 1.0b1": [[6, "version-1-0b1"]], "Contributing": [[7, "contributing"]], "Issue Reports": [[7, "issue-reports"]], "Documentation Improvements": [[7, "documentation-improvements"]], "Code Contributions": [[7, "code-contributions"]], "Submit an issue": [[7, "submit-an-issue"]], "Create an environment": [[7, "create-an-environment"]], "Clone the repository": [[7, "clone-the-repository"]], "Implement your changes": [[7, "implement-your-changes"]], "Submit your contribution": [[7, "submit-your-contribution"]], "Troubleshooting": [[7, "troubleshooting"]], "Maintainer tasks": [[7, "maintainer-tasks"]], "Releases": [[7, "releases"]], "Todo": [[7, "id2"]], "Contents": [[8, "contents"]], "Indices and tables": [[8, "indices-and-tables"]], "License": [[9, "license"]], "Note": [[10, "note"]]}, "indexentries": {"apitypes (class in sxapi.base)": [[1, "sxapi.base.ApiTypes"]], "baseapi (class in sxapi.base)": [[1, "sxapi.base.BaseAPI"]], "integration (sxapi.base.apitypes attribute)": [[1, "sxapi.base.ApiTypes.INTEGRATION"]], "integrationapiv2 (class in sxapi.base)": [[1, "sxapi.base.IntegrationAPIV2"]], "public (sxapi.base.apitypes attribute)": [[1, "sxapi.base.ApiTypes.PUBLIC"]], "delete() (sxapi.base.baseapi method)": [[1, "sxapi.base.BaseAPI.delete"]], "get() (sxapi.base.baseapi method)": [[1, "sxapi.base.BaseAPI.get"]], "get_token() (sxapi.base.baseapi method)": [[1, "sxapi.base.BaseAPI.get_token"]], "module": [[1, "module-sxapi"], [1, "module-sxapi.base"], [2, "module-sxapi.cli"], [2, "module-sxapi.cli.cli"], [2, "module-sxapi.cli.cli_user"], [3, "module-sxapi.cli.subparser"], [3, "module-sxapi.cli.subparser.get_sensor_data"], [3, "module-sxapi.cli.subparser.token"], [4, "module-sxapi.publicV2"], [4, "module-sxapi.publicV2.alarms"], [4, "module-sxapi.publicV2.data"], [4, "module-sxapi.publicV2.feedrations"], [4, "module-sxapi.publicV2.groups"], [4, "module-sxapi.publicV2.sensordata"], [4, "module-sxapi.publicV2.todos"], [4, "module-sxapi.publicV2.users"]], "post() (sxapi.base.baseapi method)": [[1, "sxapi.base.BaseAPI.post"]], "put() (sxapi.base.baseapi method)": [[1, "sxapi.base.BaseAPI.put"]], "session (sxapi.base.baseapi property)": [[1, "sxapi.base.BaseAPI.session"]], "sxapi": [[1, "module-sxapi"]], "sxapi.base": [[1, "module-sxapi.base"]], "to_url() (sxapi.base.baseapi method)": [[1, "sxapi.base.BaseAPI.to_url"]], "cli (class in sxapi.cli.cli)": [[2, "sxapi.cli.cli.Cli"]], "cliuser (class in sxapi.cli.cli_user)": [[2, "sxapi.cli.cli_user.CliUser"]], "api_status() (sxapi.cli.cli.cli static method)": [[2, "sxapi.cli.cli.Cli.api_status"]], "check_credentials_set() (sxapi.cli.cli_user.cliuser method)": [[2, "sxapi.cli.cli_user.CliUser.check_credentials_set"]], "clear_token_keyring() (sxapi.cli.cli_user.cliuser static method)": [[2, "sxapi.cli.cli_user.CliUser.clear_token_keyring"]], "cli_run() (in module sxapi.cli.cli)": [[2, "sxapi.cli.cli.cli_run"]], "get_token_environment() (sxapi.cli.cli_user.cliuser static method)": [[2, "sxapi.cli.cli_user.CliUser.get_token_environment"]], "get_token_keyring() (sxapi.cli.cli_user.cliuser static method)": [[2, "sxapi.cli.cli_user.CliUser.get_token_keyring"]], "init_user() (sxapi.cli.cli_user.cliuser method)": [[2, "sxapi.cli.cli_user.CliUser.init_user"]], "parse_args() (sxapi.cli.cli.cli static method)": [[2, "sxapi.cli.cli.Cli.parse_args"]], "read_config_from_file() (sxapi.cli.cli.cli method)": [[2, "sxapi.cli.cli.Cli.read_config_from_file"]], "run() (sxapi.cli.cli.cli method)": [[2, "sxapi.cli.cli.Cli.run"]], "set_token_keyring() (sxapi.cli.cli_user.cliuser method)": [[2, "sxapi.cli.cli_user.CliUser.set_token_keyring"]], "sxapi.cli": [[2, "module-sxapi.cli"]], "sxapi.cli.cli": [[2, "module-sxapi.cli.cli"]], "sxapi.cli.cli_user": [[2, "module-sxapi.cli.cli_user"]], "update_config_with_env() (sxapi.cli.cli.cli static method)": [[2, "sxapi.cli.cli.Cli.update_config_with_env"]], "version_info() (sxapi.cli.cli.cli static method)": [[2, "sxapi.cli.cli.Cli.version_info"]], "create_gsd_parser() (in module sxapi.cli.subparser.get_sensor_data)": [[3, "sxapi.cli.subparser.get_sensor_data.create_gsd_parser"]], "create_token_parser() (in module sxapi.cli.subparser.token)": [[3, "sxapi.cli.subparser.token.create_token_parser"]], "gsd_sub_function() (in module sxapi.cli.subparser.get_sensor_data)": [[3, "sxapi.cli.subparser.get_sensor_data.gsd_sub_function"]], "handle_clear_token() (in module sxapi.cli.subparser.token)": [[3, "sxapi.cli.subparser.token.handle_clear_token"]], "handle_new_token() (in module sxapi.cli.subparser.token)": [[3, "sxapi.cli.subparser.token.handle_new_token"]], "handle_print_token() (in module sxapi.cli.subparser.token)": [[3, "sxapi.cli.subparser.token.handle_print_token"]], "handle_set_token() (in module sxapi.cli.subparser.token)": [[3, "sxapi.cli.subparser.token.handle_set_token"]], "sxapi.cli.subparser": [[3, "module-sxapi.cli.subparser"]], "sxapi.cli.subparser.get_sensor_data": [[3, "module-sxapi.cli.subparser.get_sensor_data"]], "sxapi.cli.subparser.token": [[3, "module-sxapi.cli.subparser.token"]], "token_sub_function() (in module sxapi.cli.subparser.token)": [[3, "sxapi.cli.subparser.token.token_sub_function"]], "alarms (class in sxapi.publicv2.alarms)": [[4, "sxapi.publicV2.alarms.Alarms"]], "data (class in sxapi.publicv2.data)": [[4, "sxapi.publicV2.data.Data"]], "feedrations (class in sxapi.publicv2.feedrations)": [[4, "sxapi.publicV2.feedrations.Feedrations"]], "groups (class in sxapi.publicv2.groups)": [[4, "sxapi.publicV2.groups.Groups"]], "publicapiv2 (class in sxapi.publicv2)": [[4, "sxapi.publicV2.PublicAPIV2"]], "todos (class in sxapi.publicv2.todos)": [[4, "sxapi.publicV2.todos.Todos"]], "users (class in sxapi.publicv2.users)": [[4, "sxapi.publicV2.users.Users"]], "delete() (sxapi.publicv2.alarms.alarms method)": [[4, "sxapi.publicV2.alarms.Alarms.delete"]], "delete() (sxapi.publicv2.feedrations.feedrations method)": [[4, "sxapi.publicV2.feedrations.Feedrations.delete"]], "delete_actions() (sxapi.publicv2.groups.groups method)": [[4, "sxapi.publicV2.groups.Groups.delete_actions"]], "delete_comment() (sxapi.publicv2.todos.todos method)": [[4, "sxapi.publicV2.todos.Todos.delete_comment"]], "delete_tokens() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.delete_tokens"]], "get() (sxapi.publicv2.alarms.alarms method)": [[4, "sxapi.publicV2.alarms.Alarms.get"]], "get() (sxapi.publicv2.feedrations.feedrations method)": [[4, "sxapi.publicV2.feedrations.Feedrations.get"]], "get() (sxapi.publicv2.todos.todos method)": [[4, "sxapi.publicV2.todos.Todos.get"]], "get() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.get"]], "get_account() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.get_account"]], "get_actions() (sxapi.publicv2.groups.groups method)": [[4, "sxapi.publicV2.groups.Groups.get_actions"]], "get_alarms() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.get_alarms"]], "get_categories() (sxapi.publicv2.alarms.alarms method)": [[4, "sxapi.publicV2.alarms.Alarms.get_categories"]], "get_credentials() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.get_credentials"]], "get_data_animals() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_data_animals"]], "get_data_devices() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_data_devices"]], "get_data_feedrations() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_data_feedrations"]], "get_data_groups() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_data_groups"]], "get_download_animal_data() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_download_animal_data"]], "get_download_device_data() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_download_device_data"]], "get_download_group_data() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_download_group_data"]], "get_downloads() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_downloads"]], "get_metrics_animals() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_metrics_animals"]], "get_metrics_devices() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_metrics_devices"]], "get_metrics_groups() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.get_metrics_groups"]], "get_reset_password_request() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.get_reset_password_request"]], "get_sensor_data_from_animal() (in module sxapi.publicv2.sensordata)": [[4, "sxapi.publicV2.sensordata.get_sensor_data_from_animal"]], "get_shares() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.get_shares"]], "post() (sxapi.publicv2.alarms.alarms method)": [[4, "sxapi.publicV2.alarms.Alarms.post"]], "post() (sxapi.publicv2.feedrations.feedrations method)": [[4, "sxapi.publicV2.feedrations.Feedrations.post"]], "post() (sxapi.publicv2.todos.todos method)": [[4, "sxapi.publicV2.todos.Todos.post"]], "post_activate() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_activate"]], "post_comment() (sxapi.publicv2.todos.todos method)": [[4, "sxapi.publicV2.todos.Todos.post_comment"]], "post_credentials() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_credentials"]], "post_downloads_excel_report() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.post_downloads_excel_report"]], "post_downloads_messages_excel_report() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.post_downloads_messages_excel_report"]], "post_downloads_organisation_messages_excel_report() (sxapi.publicv2.data.data method)": [[4, "sxapi.publicV2.data.Data.post_downloads_organisation_messages_excel_report"]], "post_password_strength() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_password_strength"]], "post_reset_password() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_reset_password"]], "post_test_email() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_test_email"]], "post_test_push() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_test_push"]], "post_tokens() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_tokens"]], "post_update_metadata() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.post_update_metadata"]], "put() (sxapi.publicv2.alarms.alarms method)": [[4, "sxapi.publicV2.alarms.Alarms.put"]], "put() (sxapi.publicv2.feedrations.feedrations method)": [[4, "sxapi.publicV2.feedrations.Feedrations.put"]], "put() (sxapi.publicv2.todos.todos method)": [[4, "sxapi.publicV2.todos.Todos.put"]], "put_actions() (sxapi.publicv2.groups.groups method)": [[4, "sxapi.publicV2.groups.Groups.put_actions"]], "put_change_password() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.put_change_password"]], "put_comment() (sxapi.publicv2.todos.todos method)": [[4, "sxapi.publicV2.todos.Todos.put_comment"]], "put_tokens() (sxapi.publicv2.users.users method)": [[4, "sxapi.publicV2.users.Users.put_tokens"]], "sxapi.publicv2": [[4, "module-sxapi.publicV2"]], "sxapi.publicv2.alarms": [[4, "module-sxapi.publicV2.alarms"]], "sxapi.publicv2.data": [[4, "module-sxapi.publicV2.data"]], "sxapi.publicv2.feedrations": [[4, "module-sxapi.publicV2.feedrations"]], "sxapi.publicv2.groups": [[4, "module-sxapi.publicV2.groups"]], "sxapi.publicv2.sensordata": [[4, "module-sxapi.publicV2.sensordata"]], "sxapi.publicv2.todos": [[4, "module-sxapi.publicV2.todos"]], "sxapi.publicv2.users": [[4, "module-sxapi.publicV2.users"]]}})
\ No newline at end of file
+
+
+
+
+
+
+
+
+
+
+
+ Search
+ + + + ++ Searching for multiple words only shows matches that contain + all words. +
+ + + + + + +
+
+
+
+
+