# skyledge_api_sdk_python
Skyledge InControl is a platform for managing and controlling IoT devices.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.1
- Package version: 1.3.4
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.9+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import skyledge_api_sdk
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import skyledge_api_sdk
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import skyledge_api_sdk
from skyledge_api_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://host.docker.internal:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = skyledge_api_sdk.Configuration(
host = "http://host.docker.internal:8080"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure Bearer authorization (JWT): bearerAuth
configuration = skyledge_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with skyledge_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = skyledge_api_sdk.ApiKeyRetrievalControllerApi(api_client)
secret = 'secret_example' # str | (optional)
try:
api_response = api_instance.list_api_keys(secret=secret)
print("The response of ApiKeyRetrievalControllerApi->list_api_keys:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiKeyRetrievalControllerApi->list_api_keys: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://host.docker.internal:8080*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApiKeyRetrievalControllerApi* | [**list_api_keys**](docs/ApiKeyRetrievalControllerApi.md#list_api_keys) | **GET** /api-key |
*AssignAssetTypeToControlRoomControllerApi* | [**assign_asset_type_to_control_room**](docs/AssignAssetTypeToControlRoomControllerApi.md#assign_asset_type_to_control_room) | **PUT** /controlrooms/{controlRoomId}/asset-types/{assetTypeId} |
*AssignControlRoomCollaboratorsControllerApi* | [**invite_collaborators**](docs/AssignControlRoomCollaboratorsControllerApi.md#invite_collaborators) | **POST** /controlrooms/{controlRoomId}/invite |
*AssignPlaceTypeToControlRoomControllerApi* | [**assign_place_type_to_controlroom**](docs/AssignPlaceTypeToControlRoomControllerApi.md#assign_place_type_to_controlroom) | **PUT** /controlrooms/{controlRoomId}/place-types/{placeTypeId} |
*AuthorizePaymentMethodControllerApi* | [**authorize_payment_method**](docs/AuthorizePaymentMethodControllerApi.md#authorize_payment_method) | **POST** /billing/payment-methods |
*ClearControlRoomEventsControllerApi* | [**clear_events**](docs/ClearControlRoomEventsControllerApi.md#clear_events) | **POST** /controlrooms/{controlRoomId}/events/clear |
*CreateAssetAttachmentsControllerApi* | [**add_asset_attachments**](docs/CreateAssetAttachmentsControllerApi.md#add_asset_attachments) | **POST** /assets/{assetId}/attachments |
*CreateAssetForAssetTypeControllerApi* | [**create_asset**](docs/CreateAssetForAssetTypeControllerApi.md#create_asset) | **POST** /asset-types/{assetTypeId}/assets |
*CreateAssetForAssetTypeControllerApi* | [**create_asset_by_identifier**](docs/CreateAssetForAssetTypeControllerApi.md#create_asset_by_identifier) | **POST** /asset-types/identifier={assetTypeIdentifier}/assets |
*CreateAssetTypeControllerApi* | [**create_asset_type**](docs/CreateAssetTypeControllerApi.md#create_asset_type) | **POST** /asset-types |
*CreateControlRoomControllerApi* | [**create_control_rooms**](docs/CreateControlRoomControllerApi.md#create_control_rooms) | **POST** /controlrooms |
*CreateCycleForCycleTypeControllerApi* | [**create_cycle**](docs/CreateCycleForCycleTypeControllerApi.md#create_cycle) | **POST** /cycle-types/{cycleTypeId}/cycles |
*CreateCycleForCycleTypeControllerApi* | [**create_cycle_by_identifier**](docs/CreateCycleForCycleTypeControllerApi.md#create_cycle_by_identifier) | **POST** /cycle-types/identifier={cycleTypeIdentifier}/cycles |
*CreateCycleTypeControllerApi* | [**create_cycle_type**](docs/CreateCycleTypeControllerApi.md#create_cycle_type) | **POST** /cycle-types |
*CreateEventForEventTypeControllerApi* | [**create_event**](docs/CreateEventForEventTypeControllerApi.md#create_event) | **POST** /event-types/{eventTypeId}/events |
*CreateEventForEventTypeControllerApi* | [**create_event_by_identifier**](docs/CreateEventForEventTypeControllerApi.md#create_event_by_identifier) | **POST** /event-types/identifier={eventTypeIdentifier}/events |
*CreateEventTypeControllerApi* | [**create_event_type**](docs/CreateEventTypeControllerApi.md#create_event_type) | **POST** /event-types |
*CreateFormControllerApi* | [**create_form**](docs/CreateFormControllerApi.md#create_form) | **POST** /forms |
*CreateFormResponseControllerApi* | [**create_form_response**](docs/CreateFormResponseControllerApi.md#create_form_response) | **POST** /forms/{formId}/responses |
*CreateFormResponseControllerApi* | [**create_form_response_by_identifier**](docs/CreateFormResponseControllerApi.md#create_form_response_by_identifier) | **POST** /forms/identifier={formIdentifier}/responses |
*CreatePlaceForPlaceTypeControllerApi* | [**create_place**](docs/CreatePlaceForPlaceTypeControllerApi.md#create_place) | **POST** /place-types/{placeTypeId}/places |
*CreatePlaceForPlaceTypeControllerApi* | [**create_place_by_identifier**](docs/CreatePlaceForPlaceTypeControllerApi.md#create_place_by_identifier) | **POST** /place-types/identifier={placeTypeIdentifier}/places |
*CreatePlaceTypeControllerApi* | [**create_place_type**](docs/CreatePlaceTypeControllerApi.md#create_place_type) | **POST** /place-types |
*CreateRuleForControlRoomControllerApi* | [**create_rule**](docs/CreateRuleForControlRoomControllerApi.md#create_rule) | **POST** /controlrooms/{controlRoomId}/rule-types/{ruleTypeId}/rules |
*CreateRuleForControlRoomControllerApi* | [**create_rule_by_identifier**](docs/CreateRuleForControlRoomControllerApi.md#create_rule_by_identifier) | **POST** /controlrooms/{controlRoomId}/rule-types/identifier={ruleTypeIdentifier}/rules |
*CreateRuleTypeControllerApi* | [**create_rule_type**](docs/CreateRuleTypeControllerApi.md#create_rule_type) | **POST** /rule-types |
*CreateTaskControllerApi* | [**create_task**](docs/CreateTaskControllerApi.md#create_task) | **POST** /task-types/{taskTypeId}/tasks |
*CreateTaskTypeControllerApi* | [**create_task_type**](docs/CreateTaskTypeControllerApi.md#create_task_type) | **POST** /task-types |
*CreateUploadSignatureControllerApi* | [**create_upload_signature**](docs/CreateUploadSignatureControllerApi.md#create_upload_signature) | **POST** /assets/{assetId}/attachments/upload-signature |
*CreateUserControllerApi* | [**create_users**](docs/CreateUserControllerApi.md#create_users) | **POST** /users |
*CycleSummaryControllerApi* | [**cycle_summary**](docs/CycleSummaryControllerApi.md#cycle_summary) | **POST** /cycles/summary |
*DeleteAssetAttachmentControllerApi* | [**delete_attachment**](docs/DeleteAssetAttachmentControllerApi.md#delete_attachment) | **DELETE** /assets/{assetId}/attachments/{attachmentId} |
*DeleteControlRoomControllerApi* | [**delete_control_room**](docs/DeleteControlRoomControllerApi.md#delete_control_room) | **DELETE** /controlrooms/{controlRoomId} |
*DeleteCycleControllerApi* | [**delete_cycle_by_id**](docs/DeleteCycleControllerApi.md#delete_cycle_by_id) | **DELETE** /cycles/{cycleId} |
*DeletePlaceControllerApi* | [**delete_place_by_id**](docs/DeletePlaceControllerApi.md#delete_place_by_id) | **DELETE** /places/{placeId} |
*DeletePlaceControllerApi* | [**delete_place_by_identifier**](docs/DeletePlaceControllerApi.md#delete_place_by_identifier) | **DELETE** /places/identifier={placeIdentifier} |
*DeleteRuleControllerApi* | [**delete_rule**](docs/DeleteRuleControllerApi.md#delete_rule) | **DELETE** /rules/{ruleId} |
*DeleteTaskControllerApi* | [**delete_task**](docs/DeleteTaskControllerApi.md#delete_task) | **DELETE** /tasks/{taskId} |
*ErrorControllerApi* | [**error**](docs/ErrorControllerApi.md#error) | **GET** /error |
*ErrorControllerApi* | [**error1**](docs/ErrorControllerApi.md#error1) | **POST** /error |
*ErrorControllerApi* | [**error2**](docs/ErrorControllerApi.md#error2) | **PUT** /error |
*ErrorControllerApi* | [**error3**](docs/ErrorControllerApi.md#error3) | **DELETE** /error |
*ErrorControllerApi* | [**error4**](docs/ErrorControllerApi.md#error4) | **PATCH** /error |
*ErrorControllerApi* | [**error5**](docs/ErrorControllerApi.md#error5) | **HEAD** /error |
*ErrorControllerApi* | [**error6**](docs/ErrorControllerApi.md#error6) | **OPTIONS** /error |
*ExecuteAssetsAggregationControllerApi* | [**execute_aggregation**](docs/ExecuteAssetsAggregationControllerApi.md#execute_aggregation) | **POST** /asset-types/{assetTypeIdentifier}/assets/aggregation |
*ExecutePeriodAggregationControllerApi* | [**execute_aggregation_by_id**](docs/ExecutePeriodAggregationControllerApi.md#execute_aggregation_by_id) | **POST** /assets/{assetId}/aggregation |
*ExecutePeriodAggregationControllerApi* | [**execute_aggregation_by_identifier**](docs/ExecutePeriodAggregationControllerApi.md#execute_aggregation_by_identifier) | **POST** /assets/identifier={assetIdentifier}/aggregation |
*GetAssetActiveEventsControllerApi* | [**retrieve_latest100_active_events**](docs/GetAssetActiveEventsControllerApi.md#retrieve_latest100_active_events) | **GET** /assets/{assetId}/events/active |
*GetAssetAttachmentControllerApi* | [**get_asset_attachment**](docs/GetAssetAttachmentControllerApi.md#get_asset_attachment) | **GET** /assets/{assetId}/attachments/{attachmentId} |
*GetAssetControllerApi* | [**get_asset_using_asset_id**](docs/GetAssetControllerApi.md#get_asset_using_asset_id) | **GET** /assets/{assetId} |
*GetAssetControllerApi* | [**get_asset_using_asset_identifier**](docs/GetAssetControllerApi.md#get_asset_using_asset_identifier) | **GET** /assets/identifier={assetIdentifier} |
*GetAssetTypeControllerApi* | [**get_asset_type**](docs/GetAssetTypeControllerApi.md#get_asset_type) | **GET** /asset-types/{assetTypeId} |
*GetAssetTypeMapViewControllerApi* | [**get_asset_map_view**](docs/GetAssetTypeMapViewControllerApi.md#get_asset_map_view) | **GET** /asset-types/{assetTypeId}/views/map |
*GetAssetTypeSettingsControllerApi* | [**get_asset_settings**](docs/GetAssetTypeSettingsControllerApi.md#get_asset_settings) | **GET** /controlrooms/{controlRoomId}/asset-types/{assetTypeId} |
*GetAssetTypeTableViewControllerApi* | [**get_asset_table_view**](docs/GetAssetTypeTableViewControllerApi.md#get_asset_table_view) | **GET** /asset-types/{assetTypeId}/views/table |
*GetBillingPlanControllerApi* | [**get_billing_plan**](docs/GetBillingPlanControllerApi.md#get_billing_plan) | **GET** /billing/plan |
*GetControlRoomControllerApi* | [**get_control_room**](docs/GetControlRoomControllerApi.md#get_control_room) | **GET** /controlrooms/{controlRoomId} |
*GetControlRoomEventsSummaryControllerApi* | [**get_control_room_event_summary**](docs/GetControlRoomEventsSummaryControllerApi.md#get_control_room_event_summary) | **GET** /controlrooms/{controlRoomId}/events/summary |
*GetCycleControllerApi* | [**get_cycle_by_cycle_id**](docs/GetCycleControllerApi.md#get_cycle_by_cycle_id) | **GET** /cycles/{cycleId} |
*GetCycleTypeControllerApi* | [**get_cycle_type**](docs/GetCycleTypeControllerApi.md#get_cycle_type) | **GET** /cycle-types/{cycleTypeId} |
*GetEventControllerApi* | [**get_event**](docs/GetEventControllerApi.md#get_event) | **GET** /events/{eventId} |
*GetEventTypeControllerApi* | [**get_event_type**](docs/GetEventTypeControllerApi.md#get_event_type) | **GET** /event-types/{eventTypeId} |
*GetFormControllerApi* | [**get_form_using_form_id**](docs/GetFormControllerApi.md#get_form_using_form_id) | **GET** /forms/{formId} |
*GetFormControllerApi* | [**get_form_using_form_identifier**](docs/GetFormControllerApi.md#get_form_using_form_identifier) | **GET** /forms/identifier={formIdentifier} |
*GetFormResponseControllerApi* | [**get_form_using_form_id1**](docs/GetFormResponseControllerApi.md#get_form_using_form_id1) | **GET** /forms/{formId}/responses/{formResponseId} |
*GetFormResponseControllerApi* | [**get_form_using_form_identifier1**](docs/GetFormResponseControllerApi.md#get_form_using_form_identifier1) | **GET** /forms/identifier={formIdentifier}/responses/{formResponseId} |
*GetPaymentMethodControllerApi* | [**get_payment_method**](docs/GetPaymentMethodControllerApi.md#get_payment_method) | **GET** /billing/payment-methods |
*GetPlaceControllerApi* | [**get_place_using_place_id**](docs/GetPlaceControllerApi.md#get_place_using_place_id) | **GET** /places/{placeId} |
*GetPlaceControllerApi* | [**get_place_using_place_identifier**](docs/GetPlaceControllerApi.md#get_place_using_place_identifier) | **GET** /places/identifier={placeIdentifier} |
*GetPlaceTypeControllerApi* | [**get_place_type**](docs/GetPlaceTypeControllerApi.md#get_place_type) | **GET** /place-types/{placeTypeId} |
*GetReportUrlForControlRoomControllerApi* | [**get_report_url**](docs/GetReportUrlForControlRoomControllerApi.md#get_report_url) | **GET** /controlrooms/{controlRoomId}/report-url |
*GetRuleControllerApi* | [**get_rule**](docs/GetRuleControllerApi.md#get_rule) | **GET** /rules/{ruleId} |
*GetRuleTypeControllerApi* | [**get_rule_type**](docs/GetRuleTypeControllerApi.md#get_rule_type) | **GET** /rule-types/{ruleTypeId} |
*GetTaskControllerApi* | [**get_task**](docs/GetTaskControllerApi.md#get_task) | **GET** /tasks/{taskId} |
*GetTaskTypeControllerApi* | [**get_task_type**](docs/GetTaskTypeControllerApi.md#get_task_type) | **GET** /task-types/{taskTypeId} |
*InstallControlRoomAppControllerApi* | [**install_app_to_control_room**](docs/InstallControlRoomAppControllerApi.md#install_app_to_control_room) | **POST** /controlrooms/{controlRoomId}/apps |
*InviteUsersControllerApi* | [**invite_users**](docs/InviteUsersControllerApi.md#invite_users) | **POST** /users/invite |
*ListAssetAttachmentsControllerApi* | [**get_asset_attachments**](docs/ListAssetAttachmentsControllerApi.md#get_asset_attachments) | **GET** /assets/{assetId}/attachments |
*ListAssetTypesControllerApi* | [**list_asset_types**](docs/ListAssetTypesControllerApi.md#list_asset_types) | **GET** /asset-types |
*ListAssetTypesForControlRoomControllerApi* | [**list_asset_types_for_control_room**](docs/ListAssetTypesForControlRoomControllerApi.md#list_asset_types_for_control_room) | **GET** /controlrooms/{controlRoomId}/asset-types |
*ListAssetsControllerApi* | [**list_assets**](docs/ListAssetsControllerApi.md#list_assets) | **GET** /assets |
*ListAssetsForControlRoomControllerApi* | [**list_asset_for_control_room**](docs/ListAssetsForControlRoomControllerApi.md#list_asset_for_control_room) | **GET** /controlrooms/{controlRoomId}/assets |
*ListCollaboratorsControllerApi* | [**list_collaborators**](docs/ListCollaboratorsControllerApi.md#list_collaborators) | **GET** /controlrooms/{controlRoomId}/collaborators |
*ListControlRoomEventChangesControllerApi* | [**list_control_room_event_changes**](docs/ListControlRoomEventChangesControllerApi.md#list_control_room_event_changes) | **GET** /controlrooms/{controlRoomId}/events/changes |
*ListControlRoomEventsControllerApi* | [**list_control_room_events**](docs/ListControlRoomEventsControllerApi.md#list_control_room_events) | **GET** /controlrooms/{controlRoomId}/events |
*ListControlRoomsControllerApi* | [**list_control_rooms**](docs/ListControlRoomsControllerApi.md#list_control_rooms) | **GET** /controlrooms |
*ListCycleTypesControllerApi* | [**list_cycle_types**](docs/ListCycleTypesControllerApi.md#list_cycle_types) | **GET** /cycle-types |
*ListCyclesControllerApi* | [**list_cycles**](docs/ListCyclesControllerApi.md#list_cycles) | **GET** /cycles |
*ListEventTypesControllerApi* | [**list_event_types**](docs/ListEventTypesControllerApi.md#list_event_types) | **GET** /event-types |
*ListEventTypesForControlRoomControllerApi* | [**list_event_types_for_control_room**](docs/ListEventTypesForControlRoomControllerApi.md#list_event_types_for_control_room) | **GET** /controlrooms/{id}/event-types |
*ListFormResponsesControllerApi* | [**get_responses_using_form_id**](docs/ListFormResponsesControllerApi.md#get_responses_using_form_id) | **GET** /forms/{formId}/responses |
*ListFormResponsesControllerApi* | [**get_responses_using_form_identifier**](docs/ListFormResponsesControllerApi.md#get_responses_using_form_identifier) | **GET** /forms/identifier={formIdentifier}/responses |
*ListFormsControllerApi* | [**list_forms**](docs/ListFormsControllerApi.md#list_forms) | **GET** /forms |
*ListInstalledControlRoomAppsControllerApi* | [**list_installed_apps_for_control_room1**](docs/ListInstalledControlRoomAppsControllerApi.md#list_installed_apps_for_control_room1) | **GET** /controlrooms/{controlRoomId}/apps |
*ListInvoicesControllerApi* | [**get_invoices**](docs/ListInvoicesControllerApi.md#get_invoices) | **GET** /billing/invoices |
*ListPlaceTypesControllerApi* | [**list_place_types**](docs/ListPlaceTypesControllerApi.md#list_place_types) | **GET** /place-types |
*ListPlaceTypesForControlRoomControllerApi* | [**list_place_types_for_control_room**](docs/ListPlaceTypesForControlRoomControllerApi.md#list_place_types_for_control_room) | **GET** /controlrooms/{controlRoomId}/place-types |
*ListPlacesControllerApi* | [**list_places_for_control_room**](docs/ListPlacesControllerApi.md#list_places_for_control_room) | **GET** /places |
*ListPlacesForControlRoomControllerApi* | [**list_places_for_control_room1**](docs/ListPlacesForControlRoomControllerApi.md#list_places_for_control_room1) | **GET** /controlrooms/{controlRoomId}/places |
*ListRuleTypesControllerApi* | [**list_rule_types**](docs/ListRuleTypesControllerApi.md#list_rule_types) | **GET** /rule-types |
*ListRulesControllerApi* | [**list_rules**](docs/ListRulesControllerApi.md#list_rules) | **GET** /rule-types/{ruleTypeId}/rules |
*ListTaskTypesControllerApi* | [**list_task_types**](docs/ListTaskTypesControllerApi.md#list_task_types) | **GET** /task-types |
*ListTasksControllerApi* | [**list_tasks**](docs/ListTasksControllerApi.md#list_tasks) | **GET** /task-types/{taskTypeId}/tasks |
*ListUserDevicesControllerApi* | [**retrieve_user_devices**](docs/ListUserDevicesControllerApi.md#retrieve_user_devices) | **GET** /me/devices |
*ListUserPreferencesControllerApi* | [**retrieve_user_preferences**](docs/ListUserPreferencesControllerApi.md#retrieve_user_preferences) | **GET** /me/preferences |
*ListUsersControllerApi* | [**list_users**](docs/ListUsersControllerApi.md#list_users) | **GET** /users |
*MailingListSubscriptionControllerApi* | [**subscribe_to_mailing_list**](docs/MailingListSubscriptionControllerApi.md#subscribe_to_mailing_list) | **POST** /me/mailing-list |
*MailingListUnsubscribeControllerApi* | [**unsubscribe_from_mailing_list**](docs/MailingListUnsubscribeControllerApi.md#unsubscribe_from_mailing_list) | **DELETE** /me/mailing-list/{listName} |
*RegisterUserDeviceControllerApi* | [**update_user_device**](docs/RegisterUserDeviceControllerApi.md#update_user_device) | **PUT** /me/devices |
*RetrieveAssetHistoricMetricsControllerApi* | [**retrieve_metrics_for_asset**](docs/RetrieveAssetHistoricMetricsControllerApi.md#retrieve_metrics_for_asset) | **GET** /assets/{assetId}/metrics/{metricName} |
*RetrieveAssetHistoricMetricsControllerApi* | [**retrieve_metrics_for_asset1**](docs/RetrieveAssetHistoricMetricsControllerApi.md#retrieve_metrics_for_asset1) | **GET** /assets/identifier={assetIdentifier}/metrics/{metricName} |
*RetrieveAssetLocationHistoryControllerApi* | [**retrieve_location_history_for_asset**](docs/RetrieveAssetLocationHistoryControllerApi.md#retrieve_location_history_for_asset) | **GET** /assets/{assetId}/location |
*RetrieveAssetLocationHistoryControllerApi* | [**retrieve_location_history_for_asset1**](docs/RetrieveAssetLocationHistoryControllerApi.md#retrieve_location_history_for_asset1) | **GET** /assets/identifier={assetIdentifier}/location |
*RetrieveAssetSnapshotControllerApi* | [**retrieve_asset_snapshot**](docs/RetrieveAssetSnapshotControllerApi.md#retrieve_asset_snapshot) | **GET** /assets/{assetId}/snapshot/{queryDateTime} |
*RetrieveControlRoomAppControllerApi* | [**list_installed_apps_for_control_room**](docs/RetrieveControlRoomAppControllerApi.md#list_installed_apps_for_control_room) | **GET** /controlrooms/{controlRoomId}/apps/{appInstanceId} |
*RetrieveControlRoomConfigControllerApi* | [**retrieve_configuration**](docs/RetrieveControlRoomConfigControllerApi.md#retrieve_configuration) | **GET** /controlrooms/{controlRoomId}/config |
*SearchAssetAttributesControllerApi* | [**list_asset_attribute_values_by_attribute_name**](docs/SearchAssetAttributesControllerApi.md#list_asset_attribute_values_by_attribute_name) | **POST** /assets/attributes/{attribute} |
*SearchAssetsControllerApi* | [**search_assets**](docs/SearchAssetsControllerApi.md#search_assets) | **POST** /assets/search |
*SearchControlRoomEventsControllerApi* | [**search_events_within_control_room**](docs/SearchControlRoomEventsControllerApi.md#search_events_within_control_room) | **POST** /controlrooms/{controlRoomId}/events/search |
*SearchCyclesControllerApi* | [**search_cycles**](docs/SearchCyclesControllerApi.md#search_cycles) | **POST** /cycles/search |
*SearchEventsControllerApi* | [**search_events**](docs/SearchEventsControllerApi.md#search_events) | **POST** /events/search |
*SearchRulesForControlRoomControllerApi* | [**search_rules_within_control_room**](docs/SearchRulesForControlRoomControllerApi.md#search_rules_within_control_room) | **POST** /controlrooms/{controlRoomId}/rules/search |
*SearchTasksControllerApi* | [**search_tasks**](docs/SearchTasksControllerApi.md#search_tasks) | **POST** /tasks/search |
*SearchTasksForControlRoomControllerApi* | [**search_tasks_within_control_room**](docs/SearchTasksForControlRoomControllerApi.md#search_tasks_within_control_room) | **POST** /tasks/{controlRoomId}/search |
*UninstallControlRoomAppControllerApi* | [**uninstall_control_room_app**](docs/UninstallControlRoomAppControllerApi.md#uninstall_control_room_app) | **DELETE** /controlrooms/{controlRoomId}/apps/{appInstanceId} |
*UpdateAssetAttachmentControllerApi* | [**update_asset_attachments**](docs/UpdateAssetAttachmentControllerApi.md#update_asset_attachments) | **PATCH** /assets/{assetId}/attachments/{attachmentId} |
*UpdateAssetControllerApi* | [**update_asset_by_id**](docs/UpdateAssetControllerApi.md#update_asset_by_id) | **PATCH** /assets/{assetId} |
*UpdateAssetControllerApi* | [**update_asset_by_identifier**](docs/UpdateAssetControllerApi.md#update_asset_by_identifier) | **PATCH** /assets/identifier={assetIdentifier} |
*UpdateAssetTypeControllerApi* | [**update_asset_type**](docs/UpdateAssetTypeControllerApi.md#update_asset_type) | **PUT** /asset-types/{assetTypeId} |
*UpdateAssetTypeMapViewControllerApi* | [**update_asset_map_view**](docs/UpdateAssetTypeMapViewControllerApi.md#update_asset_map_view) | **PUT** /asset-types/{assetTypeId}/views/map |
*UpdateAssetTypeTableViewControllerApi* | [**update_asset_table_view**](docs/UpdateAssetTypeTableViewControllerApi.md#update_asset_table_view) | **PUT** /asset-types/{assetTypeId}/views/table |
*UpdateControlRoomAppControllerApi* | [**update_control_room_app**](docs/UpdateControlRoomAppControllerApi.md#update_control_room_app) | **PUT** /controlrooms/{controlRoomId}/apps/{appInstanceId} |
*UpdateControlRoomAppControllerApi* | [**update_control_room_app1**](docs/UpdateControlRoomAppControllerApi.md#update_control_room_app1) | **PATCH** /controlrooms/{controlRoomId}/apps/{appInstanceId} |
*UpdateControlRoomCollaboratorControllerApi* | [**update_control_room_collaborator**](docs/UpdateControlRoomCollaboratorControllerApi.md#update_control_room_collaborator) | **PUT** /controlrooms/{controlRoomId}/collaborators/{userId} |
*UpdateControlRoomConfigControllerApi* | [**update_configuration**](docs/UpdateControlRoomConfigControllerApi.md#update_configuration) | **PATCH** /controlrooms/{controlRoomId}/config |
*UpdateControlRoomControllerApi* | [**update_control_room**](docs/UpdateControlRoomControllerApi.md#update_control_room) | **PUT** /controlrooms/{controlRoomId} |
*UpdateCycleControllerApi* | [**update_cycle_by_id**](docs/UpdateCycleControllerApi.md#update_cycle_by_id) | **PATCH** /cycles/{cycleId} |
*UpdateCycleTypeControllerApi* | [**update_cycle_type**](docs/UpdateCycleTypeControllerApi.md#update_cycle_type) | **PATCH** /cycle-types/{cycleTypeId} |
*UpdateEventControllerApi* | [**update_event**](docs/UpdateEventControllerApi.md#update_event) | **PATCH** /events/{eventId} |
*UpdateEventTypeControllerApi* | [**update_event_type**](docs/UpdateEventTypeControllerApi.md#update_event_type) | **PUT** /event-types/{eventTypeId} |
*UpdateFormControllerApi* | [**update_form_using_id**](docs/UpdateFormControllerApi.md#update_form_using_id) | **PUT** /forms/{formId} |
*UpdateFormControllerApi* | [**update_form_using_identifier**](docs/UpdateFormControllerApi.md#update_form_using_identifier) | **PUT** /forms/identifier={formIdentifier} |
*UpdateOrganizationControllerApi* | [**update_organization**](docs/UpdateOrganizationControllerApi.md#update_organization) | **PUT** /organization |
*UpdatePlaceControllerApi* | [**update_place_by_id**](docs/UpdatePlaceControllerApi.md#update_place_by_id) | **PATCH** /places/{placeId} |
*UpdatePlaceControllerApi* | [**update_place_by_identifier**](docs/UpdatePlaceControllerApi.md#update_place_by_identifier) | **PATCH** /places/identifier={placeIdentifier} |
*UpdatePlaceTypeControllerApi* | [**update_place_type**](docs/UpdatePlaceTypeControllerApi.md#update_place_type) | **PATCH** /place-types/{placeTypeId} |
*UpdateRuleForControlRoomControllerApi* | [**update_rule**](docs/UpdateRuleForControlRoomControllerApi.md#update_rule) | **PUT** /controlrooms/{controlRoomId}/rules/{ruleId} |
*UpdateRuleTypeControllerApi* | [**update_rule_type**](docs/UpdateRuleTypeControllerApi.md#update_rule_type) | **PUT** /rule-types/{ruleTypeId} |
*UpdateTaskControllerApi* | [**update_task**](docs/UpdateTaskControllerApi.md#update_task) | **PUT** /tasks/{taskId} |
*UpdateTaskTypeControllerApi* | [**update_task_type**](docs/UpdateTaskTypeControllerApi.md#update_task_type) | **PUT** /task-types/{taskTypeId} |
*UpdateUserControllerApi* | [**update_user**](docs/UpdateUserControllerApi.md#update_user) | **PUT** /me |
*UpdateUserPreferenceControllerApi* | [**update_user_preferences**](docs/UpdateUserPreferenceControllerApi.md#update_user_preferences) | **POST** /me/preferences |
*UserDetailsControllerApi* | [**verify_user**](docs/UserDetailsControllerApi.md#verify_user) | **GET** /me |
## Documentation For Models
- [Action](docs/Action.md)
- [AggregatedResponse](docs/AggregatedResponse.md)
- [AggregationParameterRequest](docs/AggregationParameterRequest.md)
- [ApiKeyResponse](docs/ApiKeyResponse.md)
- [ApiKeysResponse](docs/ApiKeysResponse.md)
- [AssetAttachments](docs/AssetAttachments.md)
- [AssetAttachmentsResponse](docs/AssetAttachmentsResponse.md)
- [AssetCount](docs/AssetCount.md)
- [AssetLocationResponse](docs/AssetLocationResponse.md)
- [AssetMapViewResponse](docs/AssetMapViewResponse.md)
- [AssetMetricResponse](docs/AssetMetricResponse.md)
- [AssetRequest](docs/AssetRequest.md)
- [AssetResponse](docs/AssetResponse.md)
- [AssetSearchRequest](docs/AssetSearchRequest.md)
- [AssetSnapshotResponse](docs/AssetSnapshotResponse.md)
- [AssetTableViewResponse](docs/AssetTableViewResponse.md)
- [AssetTypeRequest](docs/AssetTypeRequest.md)
- [AssetTypeResponse](docs/AssetTypeResponse.md)
- [AssetTypes](docs/AssetTypes.md)
- [Assets](docs/Assets.md)
- [AssetsAggregationResponse](docs/AssetsAggregationResponse.md)
- [AttachmentDto](docs/AttachmentDto.md)
- [AttachmentResource](docs/AttachmentResource.md)
- [AttachmentUpdate](docs/AttachmentUpdate.md)
- [AttachmentsRequest](docs/AttachmentsRequest.md)
- [AttachmentsRequestAttachmentsInner](docs/AttachmentsRequestAttachmentsInner.md)
- [AuthorizePaymentMethodRequest](docs/AuthorizePaymentMethodRequest.md)
- [BillingPlanResponse](docs/BillingPlanResponse.md)
- [ChangeLog](docs/ChangeLog.md)
- [ClearControlRoomEventsRequest](docs/ClearControlRoomEventsRequest.md)
- [CollaboratorResponse](docs/CollaboratorResponse.md)
- [CollaboratorsResponse](docs/CollaboratorsResponse.md)
- [ControlRoom](docs/ControlRoom.md)
- [ControlRoomAssetSettingsResponse](docs/ControlRoomAssetSettingsResponse.md)
- [ControlRoomCollaboratorRequest](docs/ControlRoomCollaboratorRequest.md)
- [ControlRoomCollaboratorResponse](docs/ControlRoomCollaboratorResponse.md)
- [ControlRoomCollaboratorsRequest](docs/ControlRoomCollaboratorsRequest.md)
- [ControlRoomConfigResponse](docs/ControlRoomConfigResponse.md)
- [ControlRoomEventChangesResponse](docs/ControlRoomEventChangesResponse.md)
- [ControlRoomEventResponse](docs/ControlRoomEventResponse.md)
- [ControlRoomEventSearchRequest](docs/ControlRoomEventSearchRequest.md)
- [ControlRoomEventsResponse](docs/ControlRoomEventsResponse.md)
- [ControlRoomEventsSummaryResponse](docs/ControlRoomEventsSummaryResponse.md)
- [ControlRoomResponse](docs/ControlRoomResponse.md)
- [ControlRoomRulesResponse](docs/ControlRoomRulesResponse.md)
- [ControlRoomTaskSearchRequest](docs/ControlRoomTaskSearchRequest.md)
- [ControlRoomTasksResponse](docs/ControlRoomTasksResponse.md)
- [ControlRoomsResponse](docs/ControlRoomsResponse.md)
- [CopyAttachmentAction](docs/CopyAttachmentAction.md)
- [CreateAttachmentAction](docs/CreateAttachmentAction.md)
- [CreateControlRoomRequest](docs/CreateControlRoomRequest.md)
- [CreateEventResponse](docs/CreateEventResponse.md)
- [CreateUserRequest](docs/CreateUserRequest.md)
- [Crs](docs/Crs.md)
- [CycleAggregationParameterRequest](docs/CycleAggregationParameterRequest.md)
- [CycleRequest](docs/CycleRequest.md)
- [CycleResponse](docs/CycleResponse.md)
- [CycleSearchRequest](docs/CycleSearchRequest.md)
- [CycleSummaries](docs/CycleSummaries.md)
- [CycleSummaryRequest](docs/CycleSummaryRequest.md)
- [CycleSummaryResponse](docs/CycleSummaryResponse.md)
- [CycleTypeRequest](docs/CycleTypeRequest.md)
- [CycleTypeResponse](docs/CycleTypeResponse.md)
- [CycleTypes](docs/CycleTypes.md)
- [Cycles](docs/Cycles.md)
- [CyclesCycles](docs/CyclesCycles.md)
- [DateGrouping](docs/DateGrouping.md)
- [DateRange](docs/DateRange.md)
- [DeleteTaskRequest](docs/DeleteTaskRequest.md)
- [EmailChannel](docs/EmailChannel.md)
- [EntityResponse](docs/EntityResponse.md)
- [EventCreatedOptions](docs/EventCreatedOptions.md)
- [EventDisplay](docs/EventDisplay.md)
- [EventPlace](docs/EventPlace.md)
- [EventRequest](docs/EventRequest.md)
- [EventResponse](docs/EventResponse.md)
- [EventSearchRequest](docs/EventSearchRequest.md)
- [EventTypeCount](docs/EventTypeCount.md)
- [EventTypeRequest](docs/EventTypeRequest.md)
- [EventTypeResponse](docs/EventTypeResponse.md)
- [EventTypes](docs/EventTypes.md)
- [EventWarning](docs/EventWarning.md)
- [Events](docs/Events.md)
- [ExcessChargePolicy](docs/ExcessChargePolicy.md)
- [ExecuteAssetsAggregationRequest](docs/ExecuteAssetsAggregationRequest.md)
- [ExecutePeriodAggregationRequest](docs/ExecutePeriodAggregationRequest.md)
- [Execution](docs/Execution.md)
- [Feature](docs/Feature.md)
- [FeatureAllOfGeometry](docs/FeatureAllOfGeometry.md)
- [FeatureAllOfGeometry1](docs/FeatureAllOfGeometry1.md)
- [FeatureCollection](docs/FeatureCollection.md)
- [Filter](docs/Filter.md)
- [FormAction](docs/FormAction.md)
- [FormRequest](docs/FormRequest.md)
- [FormResponse](docs/FormResponse.md)
- [FormResponseRequest](docs/FormResponseRequest.md)
- [FormResponseResponse](docs/FormResponseResponse.md)
- [FormResponsesResponse](docs/FormResponsesResponse.md)
- [FormsResponse](docs/FormsResponse.md)
- [GeoJsonObject](docs/GeoJsonObject.md)
- [GeometryCollection](docs/GeometryCollection.md)
- [GeometryCollectionAllOfGeometries](docs/GeometryCollectionAllOfGeometries.md)
- [Importance](docs/Importance.md)
- [ImportanceCount](docs/ImportanceCount.md)
- [InstallAppRequest](docs/InstallAppRequest.md)
- [InstalledAppResponse](docs/InstalledAppResponse.md)
- [InstalledAppsResponse](docs/InstalledAppsResponse.md)
- [InviteUserRequest](docs/InviteUserRequest.md)
- [InviteUsersRequest](docs/InviteUsersRequest.md)
- [InvoiceResponse](docs/InvoiceResponse.md)
- [InvoicesResponse](docs/InvoicesResponse.md)
- [LineString](docs/LineString.md)
- [Link](docs/Link.md)
- [LinkedAssetResponse](docs/LinkedAssetResponse.md)
- [LinkedEntity](docs/LinkedEntity.md)
- [LinkedPlaceResponse](docs/LinkedPlaceResponse.md)
- [LngLatAlt](docs/LngLatAlt.md)
- [LocationHistory](docs/LocationHistory.md)
- [MailingListSubscriptionRequest](docs/MailingListSubscriptionRequest.md)
- [MailingListSubscriptionResponse](docs/MailingListSubscriptionResponse.md)
- [MapRuleResponse](docs/MapRuleResponse.md)
- [MapTooltipResponse](docs/MapTooltipResponse.md)
- [MapUpdateResponse](docs/MapUpdateResponse.md)
- [MetricHistory](docs/MetricHistory.md)
- [ModelField](docs/ModelField.md)
- [ModelProperty](docs/ModelProperty.md)
- [MultiLineString](docs/MultiLineString.md)
- [MultiPoint](docs/MultiPoint.md)
- [MultiPolygon](docs/MultiPolygon.md)
- [NotificationActionConfig](docs/NotificationActionConfig.md)
- [NotificationActionConfigChannelsInner](docs/NotificationActionConfigChannelsInner.md)
- [NotificationChannel](docs/NotificationChannel.md)
- [NotificationRuleAction](docs/NotificationRuleAction.md)
- [OrganizationResponse](docs/OrganizationResponse.md)
- [Pageable](docs/Pageable.md)
- [PaymentMethodResponse](docs/PaymentMethodResponse.md)
- [PaymentMethodsResponse](docs/PaymentMethodsResponse.md)
- [PeriodAggregatedResponse](docs/PeriodAggregatedResponse.md)
- [PeriodAggregationResponse](docs/PeriodAggregationResponse.md)
- [PlaceEnteredExitedOptions](docs/PlaceEnteredExitedOptions.md)
- [PlaceRequest](docs/PlaceRequest.md)
- [PlaceResponse](docs/PlaceResponse.md)
- [PlaceTypeRequest](docs/PlaceTypeRequest.md)
- [PlaceTypeResponse](docs/PlaceTypeResponse.md)
- [PlaceTypes](docs/PlaceTypes.md)
- [Places](docs/Places.md)
- [PlanConstraint](docs/PlanConstraint.md)
- [Point](docs/Point.md)
- [Polygon](docs/Polygon.md)
- [PushChannel](docs/PushChannel.md)
- [QuickFilter](docs/QuickFilter.md)
- [QuickFilterEntry](docs/QuickFilterEntry.md)
- [Range](docs/Range.md)
- [ReportUrlResponse](docs/ReportUrlResponse.md)
- [RuleActionObjectObject](docs/RuleActionObjectObject.md)
- [RuleRequest](docs/RuleRequest.md)
- [RuleResponse](docs/RuleResponse.md)
- [RuleTypeRequest](docs/RuleTypeRequest.md)
- [RuleTypeResponse](docs/RuleTypeResponse.md)
- [RuleTypes](docs/RuleTypes.md)
- [RulesResponse](docs/RulesResponse.md)
- [RulesSearchRequest](docs/RulesSearchRequest.md)
- [SearchAssetAttributeRequest](docs/SearchAssetAttributeRequest.md)
- [SearchAssetAttributeResponse](docs/SearchAssetAttributeResponse.md)
- [SmsChannel](docs/SmsChannel.md)
- [TaskAssetResponse](docs/TaskAssetResponse.md)
- [TaskCreatedOptions](docs/TaskCreatedOptions.md)
- [TaskEventResponse](docs/TaskEventResponse.md)
- [TaskRequest](docs/TaskRequest.md)
- [TaskResponse](docs/TaskResponse.md)
- [TaskSearchRequest](docs/TaskSearchRequest.md)
- [TaskTypeRequest](docs/TaskTypeRequest.md)
- [TaskTypeResponse](docs/TaskTypeResponse.md)
- [TaskTypes](docs/TaskTypes.md)
- [Tasks](docs/Tasks.md)
- [Tooltip](docs/Tooltip.md)
- [UpdateAssetMapViewRequest](docs/UpdateAssetMapViewRequest.md)
- [UpdateAssetRequest](docs/UpdateAssetRequest.md)
- [UpdateAssetTableViewRequest](docs/UpdateAssetTableViewRequest.md)
- [UpdateAssetTypeRequest](docs/UpdateAssetTypeRequest.md)
- [UpdateControlRoomAssetSettingsRequest](docs/UpdateControlRoomAssetSettingsRequest.md)
- [UpdateControlRoomCollaboratorRequest](docs/UpdateControlRoomCollaboratorRequest.md)
- [UpdateControlRoomConfigRequest](docs/UpdateControlRoomConfigRequest.md)
- [UpdateControlRoomRequest](docs/UpdateControlRoomRequest.md)
- [UpdateCycleRequest](docs/UpdateCycleRequest.md)
- [UpdateCycleTypeRequest](docs/UpdateCycleTypeRequest.md)
- [UpdateEventRequest](docs/UpdateEventRequest.md)
- [UpdateEventTypeRequest](docs/UpdateEventTypeRequest.md)
- [UpdateFormRequest](docs/UpdateFormRequest.md)
- [UpdateInstalledAppRequest](docs/UpdateInstalledAppRequest.md)
- [UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
- [UpdatePlaceRequest](docs/UpdatePlaceRequest.md)
- [UpdatePlaceTypeRequest](docs/UpdatePlaceTypeRequest.md)
- [UpdateRuleRequest](docs/UpdateRuleRequest.md)
- [UpdateRuleTypeRequest](docs/UpdateRuleTypeRequest.md)
- [UpdateRuleTypeRequestOptions](docs/UpdateRuleTypeRequestOptions.md)
- [UpdateTaskRequest](docs/UpdateTaskRequest.md)
- [UpdateTaskTypeRequest](docs/UpdateTaskTypeRequest.md)
- [UpdateUserDeviceRequest](docs/UpdateUserDeviceRequest.md)
- [UpdateUserPreferencesRequest](docs/UpdateUserPreferencesRequest.md)
- [UpdateUserRequest](docs/UpdateUserRequest.md)
- [UploadSignatureResponse](docs/UploadSignatureResponse.md)
- [UserDetailsResponse](docs/UserDetailsResponse.md)
- [UserDeviceResponse](docs/UserDeviceResponse.md)
- [UserDevicesResponse](docs/UserDevicesResponse.md)
- [UserPreferenceResponse](docs/UserPreferenceResponse.md)
- [UserPreferencesResponse](docs/UserPreferencesResponse.md)
- [UserResponse](docs/UserResponse.md)
- [UsersResponse](docs/UsersResponse.md)
- [Widget](docs/Widget.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth
- **Type**: Bearer authentication (JWT)
<a id="apiKeyAuth"></a>
### apiKeyAuth
- **Type**: API key
- **API key parameter name**: X-Authorization
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "skyledge-api-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Skyledge InControl API",
"author": "OpenAPI Generator community",
"author_email": "OpenAPI Generator Community <team@openapitools.org>",
"download_url": "https://files.pythonhosted.org/packages/6c/a6/d477431581f44a5481af1e49a40a8c646ca7e00f41afe25c55d914200aa9/skyledge_api_sdk-1.3.4.tar.gz",
"platform": null,
"description": "# skyledge_api_sdk_python\nSkyledge InControl is a platform for managing and controlling IoT devices.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.1\n- Package version: 1.3.4\n- Generator version: 7.14.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport skyledge_api_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport skyledge_api_sdk\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport skyledge_api_sdk\nfrom skyledge_api_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://host.docker.internal:8080\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = skyledge_api_sdk.Configuration(\n host = \"http://host.docker.internal:8080\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: apiKeyAuth\nconfiguration.api_key['apiKeyAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'\n\n# Configure Bearer authorization (JWT): bearerAuth\nconfiguration = skyledge_api_sdk.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith skyledge_api_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = skyledge_api_sdk.ApiKeyRetrievalControllerApi(api_client)\n secret = 'secret_example' # str | (optional)\n\n try:\n api_response = api_instance.list_api_keys(secret=secret)\n print(\"The response of ApiKeyRetrievalControllerApi->list_api_keys:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ApiKeyRetrievalControllerApi->list_api_keys: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://host.docker.internal:8080*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ApiKeyRetrievalControllerApi* | [**list_api_keys**](docs/ApiKeyRetrievalControllerApi.md#list_api_keys) | **GET** /api-key | \n*AssignAssetTypeToControlRoomControllerApi* | [**assign_asset_type_to_control_room**](docs/AssignAssetTypeToControlRoomControllerApi.md#assign_asset_type_to_control_room) | **PUT** /controlrooms/{controlRoomId}/asset-types/{assetTypeId} | \n*AssignControlRoomCollaboratorsControllerApi* | [**invite_collaborators**](docs/AssignControlRoomCollaboratorsControllerApi.md#invite_collaborators) | **POST** /controlrooms/{controlRoomId}/invite | \n*AssignPlaceTypeToControlRoomControllerApi* | [**assign_place_type_to_controlroom**](docs/AssignPlaceTypeToControlRoomControllerApi.md#assign_place_type_to_controlroom) | **PUT** /controlrooms/{controlRoomId}/place-types/{placeTypeId} | \n*AuthorizePaymentMethodControllerApi* | [**authorize_payment_method**](docs/AuthorizePaymentMethodControllerApi.md#authorize_payment_method) | **POST** /billing/payment-methods | \n*ClearControlRoomEventsControllerApi* | [**clear_events**](docs/ClearControlRoomEventsControllerApi.md#clear_events) | **POST** /controlrooms/{controlRoomId}/events/clear | \n*CreateAssetAttachmentsControllerApi* | [**add_asset_attachments**](docs/CreateAssetAttachmentsControllerApi.md#add_asset_attachments) | **POST** /assets/{assetId}/attachments | \n*CreateAssetForAssetTypeControllerApi* | [**create_asset**](docs/CreateAssetForAssetTypeControllerApi.md#create_asset) | **POST** /asset-types/{assetTypeId}/assets | \n*CreateAssetForAssetTypeControllerApi* | [**create_asset_by_identifier**](docs/CreateAssetForAssetTypeControllerApi.md#create_asset_by_identifier) | **POST** /asset-types/identifier={assetTypeIdentifier}/assets | \n*CreateAssetTypeControllerApi* | [**create_asset_type**](docs/CreateAssetTypeControllerApi.md#create_asset_type) | **POST** /asset-types | \n*CreateControlRoomControllerApi* | [**create_control_rooms**](docs/CreateControlRoomControllerApi.md#create_control_rooms) | **POST** /controlrooms | \n*CreateCycleForCycleTypeControllerApi* | [**create_cycle**](docs/CreateCycleForCycleTypeControllerApi.md#create_cycle) | **POST** /cycle-types/{cycleTypeId}/cycles | \n*CreateCycleForCycleTypeControllerApi* | [**create_cycle_by_identifier**](docs/CreateCycleForCycleTypeControllerApi.md#create_cycle_by_identifier) | **POST** /cycle-types/identifier={cycleTypeIdentifier}/cycles | \n*CreateCycleTypeControllerApi* | [**create_cycle_type**](docs/CreateCycleTypeControllerApi.md#create_cycle_type) | **POST** /cycle-types | \n*CreateEventForEventTypeControllerApi* | [**create_event**](docs/CreateEventForEventTypeControllerApi.md#create_event) | **POST** /event-types/{eventTypeId}/events | \n*CreateEventForEventTypeControllerApi* | [**create_event_by_identifier**](docs/CreateEventForEventTypeControllerApi.md#create_event_by_identifier) | **POST** /event-types/identifier={eventTypeIdentifier}/events | \n*CreateEventTypeControllerApi* | [**create_event_type**](docs/CreateEventTypeControllerApi.md#create_event_type) | **POST** /event-types | \n*CreateFormControllerApi* | [**create_form**](docs/CreateFormControllerApi.md#create_form) | **POST** /forms | \n*CreateFormResponseControllerApi* | [**create_form_response**](docs/CreateFormResponseControllerApi.md#create_form_response) | **POST** /forms/{formId}/responses | \n*CreateFormResponseControllerApi* | [**create_form_response_by_identifier**](docs/CreateFormResponseControllerApi.md#create_form_response_by_identifier) | **POST** /forms/identifier={formIdentifier}/responses | \n*CreatePlaceForPlaceTypeControllerApi* | [**create_place**](docs/CreatePlaceForPlaceTypeControllerApi.md#create_place) | **POST** /place-types/{placeTypeId}/places | \n*CreatePlaceForPlaceTypeControllerApi* | [**create_place_by_identifier**](docs/CreatePlaceForPlaceTypeControllerApi.md#create_place_by_identifier) | **POST** /place-types/identifier={placeTypeIdentifier}/places | \n*CreatePlaceTypeControllerApi* | [**create_place_type**](docs/CreatePlaceTypeControllerApi.md#create_place_type) | **POST** /place-types | \n*CreateRuleForControlRoomControllerApi* | [**create_rule**](docs/CreateRuleForControlRoomControllerApi.md#create_rule) | **POST** /controlrooms/{controlRoomId}/rule-types/{ruleTypeId}/rules | \n*CreateRuleForControlRoomControllerApi* | [**create_rule_by_identifier**](docs/CreateRuleForControlRoomControllerApi.md#create_rule_by_identifier) | **POST** /controlrooms/{controlRoomId}/rule-types/identifier={ruleTypeIdentifier}/rules | \n*CreateRuleTypeControllerApi* | [**create_rule_type**](docs/CreateRuleTypeControllerApi.md#create_rule_type) | **POST** /rule-types | \n*CreateTaskControllerApi* | [**create_task**](docs/CreateTaskControllerApi.md#create_task) | **POST** /task-types/{taskTypeId}/tasks | \n*CreateTaskTypeControllerApi* | [**create_task_type**](docs/CreateTaskTypeControllerApi.md#create_task_type) | **POST** /task-types | \n*CreateUploadSignatureControllerApi* | [**create_upload_signature**](docs/CreateUploadSignatureControllerApi.md#create_upload_signature) | **POST** /assets/{assetId}/attachments/upload-signature | \n*CreateUserControllerApi* | [**create_users**](docs/CreateUserControllerApi.md#create_users) | **POST** /users | \n*CycleSummaryControllerApi* | [**cycle_summary**](docs/CycleSummaryControllerApi.md#cycle_summary) | **POST** /cycles/summary | \n*DeleteAssetAttachmentControllerApi* | [**delete_attachment**](docs/DeleteAssetAttachmentControllerApi.md#delete_attachment) | **DELETE** /assets/{assetId}/attachments/{attachmentId} | \n*DeleteControlRoomControllerApi* | [**delete_control_room**](docs/DeleteControlRoomControllerApi.md#delete_control_room) | **DELETE** /controlrooms/{controlRoomId} | \n*DeleteCycleControllerApi* | [**delete_cycle_by_id**](docs/DeleteCycleControllerApi.md#delete_cycle_by_id) | **DELETE** /cycles/{cycleId} | \n*DeletePlaceControllerApi* | [**delete_place_by_id**](docs/DeletePlaceControllerApi.md#delete_place_by_id) | **DELETE** /places/{placeId} | \n*DeletePlaceControllerApi* | [**delete_place_by_identifier**](docs/DeletePlaceControllerApi.md#delete_place_by_identifier) | **DELETE** /places/identifier={placeIdentifier} | \n*DeleteRuleControllerApi* | [**delete_rule**](docs/DeleteRuleControllerApi.md#delete_rule) | **DELETE** /rules/{ruleId} | \n*DeleteTaskControllerApi* | [**delete_task**](docs/DeleteTaskControllerApi.md#delete_task) | **DELETE** /tasks/{taskId} | \n*ErrorControllerApi* | [**error**](docs/ErrorControllerApi.md#error) | **GET** /error | \n*ErrorControllerApi* | [**error1**](docs/ErrorControllerApi.md#error1) | **POST** /error | \n*ErrorControllerApi* | [**error2**](docs/ErrorControllerApi.md#error2) | **PUT** /error | \n*ErrorControllerApi* | [**error3**](docs/ErrorControllerApi.md#error3) | **DELETE** /error | \n*ErrorControllerApi* | [**error4**](docs/ErrorControllerApi.md#error4) | **PATCH** /error | \n*ErrorControllerApi* | [**error5**](docs/ErrorControllerApi.md#error5) | **HEAD** /error | \n*ErrorControllerApi* | [**error6**](docs/ErrorControllerApi.md#error6) | **OPTIONS** /error | \n*ExecuteAssetsAggregationControllerApi* | [**execute_aggregation**](docs/ExecuteAssetsAggregationControllerApi.md#execute_aggregation) | **POST** /asset-types/{assetTypeIdentifier}/assets/aggregation | \n*ExecutePeriodAggregationControllerApi* | [**execute_aggregation_by_id**](docs/ExecutePeriodAggregationControllerApi.md#execute_aggregation_by_id) | **POST** /assets/{assetId}/aggregation | \n*ExecutePeriodAggregationControllerApi* | [**execute_aggregation_by_identifier**](docs/ExecutePeriodAggregationControllerApi.md#execute_aggregation_by_identifier) | **POST** /assets/identifier={assetIdentifier}/aggregation | \n*GetAssetActiveEventsControllerApi* | [**retrieve_latest100_active_events**](docs/GetAssetActiveEventsControllerApi.md#retrieve_latest100_active_events) | **GET** /assets/{assetId}/events/active | \n*GetAssetAttachmentControllerApi* | [**get_asset_attachment**](docs/GetAssetAttachmentControllerApi.md#get_asset_attachment) | **GET** /assets/{assetId}/attachments/{attachmentId} | \n*GetAssetControllerApi* | [**get_asset_using_asset_id**](docs/GetAssetControllerApi.md#get_asset_using_asset_id) | **GET** /assets/{assetId} | \n*GetAssetControllerApi* | [**get_asset_using_asset_identifier**](docs/GetAssetControllerApi.md#get_asset_using_asset_identifier) | **GET** /assets/identifier={assetIdentifier} | \n*GetAssetTypeControllerApi* | [**get_asset_type**](docs/GetAssetTypeControllerApi.md#get_asset_type) | **GET** /asset-types/{assetTypeId} | \n*GetAssetTypeMapViewControllerApi* | [**get_asset_map_view**](docs/GetAssetTypeMapViewControllerApi.md#get_asset_map_view) | **GET** /asset-types/{assetTypeId}/views/map | \n*GetAssetTypeSettingsControllerApi* | [**get_asset_settings**](docs/GetAssetTypeSettingsControllerApi.md#get_asset_settings) | **GET** /controlrooms/{controlRoomId}/asset-types/{assetTypeId} | \n*GetAssetTypeTableViewControllerApi* | [**get_asset_table_view**](docs/GetAssetTypeTableViewControllerApi.md#get_asset_table_view) | **GET** /asset-types/{assetTypeId}/views/table | \n*GetBillingPlanControllerApi* | [**get_billing_plan**](docs/GetBillingPlanControllerApi.md#get_billing_plan) | **GET** /billing/plan | \n*GetControlRoomControllerApi* | [**get_control_room**](docs/GetControlRoomControllerApi.md#get_control_room) | **GET** /controlrooms/{controlRoomId} | \n*GetControlRoomEventsSummaryControllerApi* | [**get_control_room_event_summary**](docs/GetControlRoomEventsSummaryControllerApi.md#get_control_room_event_summary) | **GET** /controlrooms/{controlRoomId}/events/summary | \n*GetCycleControllerApi* | [**get_cycle_by_cycle_id**](docs/GetCycleControllerApi.md#get_cycle_by_cycle_id) | **GET** /cycles/{cycleId} | \n*GetCycleTypeControllerApi* | [**get_cycle_type**](docs/GetCycleTypeControllerApi.md#get_cycle_type) | **GET** /cycle-types/{cycleTypeId} | \n*GetEventControllerApi* | [**get_event**](docs/GetEventControllerApi.md#get_event) | **GET** /events/{eventId} | \n*GetEventTypeControllerApi* | [**get_event_type**](docs/GetEventTypeControllerApi.md#get_event_type) | **GET** /event-types/{eventTypeId} | \n*GetFormControllerApi* | [**get_form_using_form_id**](docs/GetFormControllerApi.md#get_form_using_form_id) | **GET** /forms/{formId} | \n*GetFormControllerApi* | [**get_form_using_form_identifier**](docs/GetFormControllerApi.md#get_form_using_form_identifier) | **GET** /forms/identifier={formIdentifier} | \n*GetFormResponseControllerApi* | [**get_form_using_form_id1**](docs/GetFormResponseControllerApi.md#get_form_using_form_id1) | **GET** /forms/{formId}/responses/{formResponseId} | \n*GetFormResponseControllerApi* | [**get_form_using_form_identifier1**](docs/GetFormResponseControllerApi.md#get_form_using_form_identifier1) | **GET** /forms/identifier={formIdentifier}/responses/{formResponseId} | \n*GetPaymentMethodControllerApi* | [**get_payment_method**](docs/GetPaymentMethodControllerApi.md#get_payment_method) | **GET** /billing/payment-methods | \n*GetPlaceControllerApi* | [**get_place_using_place_id**](docs/GetPlaceControllerApi.md#get_place_using_place_id) | **GET** /places/{placeId} | \n*GetPlaceControllerApi* | [**get_place_using_place_identifier**](docs/GetPlaceControllerApi.md#get_place_using_place_identifier) | **GET** /places/identifier={placeIdentifier} | \n*GetPlaceTypeControllerApi* | [**get_place_type**](docs/GetPlaceTypeControllerApi.md#get_place_type) | **GET** /place-types/{placeTypeId} | \n*GetReportUrlForControlRoomControllerApi* | [**get_report_url**](docs/GetReportUrlForControlRoomControllerApi.md#get_report_url) | **GET** /controlrooms/{controlRoomId}/report-url | \n*GetRuleControllerApi* | [**get_rule**](docs/GetRuleControllerApi.md#get_rule) | **GET** /rules/{ruleId} | \n*GetRuleTypeControllerApi* | [**get_rule_type**](docs/GetRuleTypeControllerApi.md#get_rule_type) | **GET** /rule-types/{ruleTypeId} | \n*GetTaskControllerApi* | [**get_task**](docs/GetTaskControllerApi.md#get_task) | **GET** /tasks/{taskId} | \n*GetTaskTypeControllerApi* | [**get_task_type**](docs/GetTaskTypeControllerApi.md#get_task_type) | **GET** /task-types/{taskTypeId} | \n*InstallControlRoomAppControllerApi* | [**install_app_to_control_room**](docs/InstallControlRoomAppControllerApi.md#install_app_to_control_room) | **POST** /controlrooms/{controlRoomId}/apps | \n*InviteUsersControllerApi* | [**invite_users**](docs/InviteUsersControllerApi.md#invite_users) | **POST** /users/invite | \n*ListAssetAttachmentsControllerApi* | [**get_asset_attachments**](docs/ListAssetAttachmentsControllerApi.md#get_asset_attachments) | **GET** /assets/{assetId}/attachments | \n*ListAssetTypesControllerApi* | [**list_asset_types**](docs/ListAssetTypesControllerApi.md#list_asset_types) | **GET** /asset-types | \n*ListAssetTypesForControlRoomControllerApi* | [**list_asset_types_for_control_room**](docs/ListAssetTypesForControlRoomControllerApi.md#list_asset_types_for_control_room) | **GET** /controlrooms/{controlRoomId}/asset-types | \n*ListAssetsControllerApi* | [**list_assets**](docs/ListAssetsControllerApi.md#list_assets) | **GET** /assets | \n*ListAssetsForControlRoomControllerApi* | [**list_asset_for_control_room**](docs/ListAssetsForControlRoomControllerApi.md#list_asset_for_control_room) | **GET** /controlrooms/{controlRoomId}/assets | \n*ListCollaboratorsControllerApi* | [**list_collaborators**](docs/ListCollaboratorsControllerApi.md#list_collaborators) | **GET** /controlrooms/{controlRoomId}/collaborators | \n*ListControlRoomEventChangesControllerApi* | [**list_control_room_event_changes**](docs/ListControlRoomEventChangesControllerApi.md#list_control_room_event_changes) | **GET** /controlrooms/{controlRoomId}/events/changes | \n*ListControlRoomEventsControllerApi* | [**list_control_room_events**](docs/ListControlRoomEventsControllerApi.md#list_control_room_events) | **GET** /controlrooms/{controlRoomId}/events | \n*ListControlRoomsControllerApi* | [**list_control_rooms**](docs/ListControlRoomsControllerApi.md#list_control_rooms) | **GET** /controlrooms | \n*ListCycleTypesControllerApi* | [**list_cycle_types**](docs/ListCycleTypesControllerApi.md#list_cycle_types) | **GET** /cycle-types | \n*ListCyclesControllerApi* | [**list_cycles**](docs/ListCyclesControllerApi.md#list_cycles) | **GET** /cycles | \n*ListEventTypesControllerApi* | [**list_event_types**](docs/ListEventTypesControllerApi.md#list_event_types) | **GET** /event-types | \n*ListEventTypesForControlRoomControllerApi* | [**list_event_types_for_control_room**](docs/ListEventTypesForControlRoomControllerApi.md#list_event_types_for_control_room) | **GET** /controlrooms/{id}/event-types | \n*ListFormResponsesControllerApi* | [**get_responses_using_form_id**](docs/ListFormResponsesControllerApi.md#get_responses_using_form_id) | **GET** /forms/{formId}/responses | \n*ListFormResponsesControllerApi* | [**get_responses_using_form_identifier**](docs/ListFormResponsesControllerApi.md#get_responses_using_form_identifier) | **GET** /forms/identifier={formIdentifier}/responses | \n*ListFormsControllerApi* | [**list_forms**](docs/ListFormsControllerApi.md#list_forms) | **GET** /forms | \n*ListInstalledControlRoomAppsControllerApi* | [**list_installed_apps_for_control_room1**](docs/ListInstalledControlRoomAppsControllerApi.md#list_installed_apps_for_control_room1) | **GET** /controlrooms/{controlRoomId}/apps | \n*ListInvoicesControllerApi* | [**get_invoices**](docs/ListInvoicesControllerApi.md#get_invoices) | **GET** /billing/invoices | \n*ListPlaceTypesControllerApi* | [**list_place_types**](docs/ListPlaceTypesControllerApi.md#list_place_types) | **GET** /place-types | \n*ListPlaceTypesForControlRoomControllerApi* | [**list_place_types_for_control_room**](docs/ListPlaceTypesForControlRoomControllerApi.md#list_place_types_for_control_room) | **GET** /controlrooms/{controlRoomId}/place-types | \n*ListPlacesControllerApi* | [**list_places_for_control_room**](docs/ListPlacesControllerApi.md#list_places_for_control_room) | **GET** /places | \n*ListPlacesForControlRoomControllerApi* | [**list_places_for_control_room1**](docs/ListPlacesForControlRoomControllerApi.md#list_places_for_control_room1) | **GET** /controlrooms/{controlRoomId}/places | \n*ListRuleTypesControllerApi* | [**list_rule_types**](docs/ListRuleTypesControllerApi.md#list_rule_types) | **GET** /rule-types | \n*ListRulesControllerApi* | [**list_rules**](docs/ListRulesControllerApi.md#list_rules) | **GET** /rule-types/{ruleTypeId}/rules | \n*ListTaskTypesControllerApi* | [**list_task_types**](docs/ListTaskTypesControllerApi.md#list_task_types) | **GET** /task-types | \n*ListTasksControllerApi* | [**list_tasks**](docs/ListTasksControllerApi.md#list_tasks) | **GET** /task-types/{taskTypeId}/tasks | \n*ListUserDevicesControllerApi* | [**retrieve_user_devices**](docs/ListUserDevicesControllerApi.md#retrieve_user_devices) | **GET** /me/devices | \n*ListUserPreferencesControllerApi* | [**retrieve_user_preferences**](docs/ListUserPreferencesControllerApi.md#retrieve_user_preferences) | **GET** /me/preferences | \n*ListUsersControllerApi* | [**list_users**](docs/ListUsersControllerApi.md#list_users) | **GET** /users | \n*MailingListSubscriptionControllerApi* | [**subscribe_to_mailing_list**](docs/MailingListSubscriptionControllerApi.md#subscribe_to_mailing_list) | **POST** /me/mailing-list | \n*MailingListUnsubscribeControllerApi* | [**unsubscribe_from_mailing_list**](docs/MailingListUnsubscribeControllerApi.md#unsubscribe_from_mailing_list) | **DELETE** /me/mailing-list/{listName} | \n*RegisterUserDeviceControllerApi* | [**update_user_device**](docs/RegisterUserDeviceControllerApi.md#update_user_device) | **PUT** /me/devices | \n*RetrieveAssetHistoricMetricsControllerApi* | [**retrieve_metrics_for_asset**](docs/RetrieveAssetHistoricMetricsControllerApi.md#retrieve_metrics_for_asset) | **GET** /assets/{assetId}/metrics/{metricName} | \n*RetrieveAssetHistoricMetricsControllerApi* | [**retrieve_metrics_for_asset1**](docs/RetrieveAssetHistoricMetricsControllerApi.md#retrieve_metrics_for_asset1) | **GET** /assets/identifier={assetIdentifier}/metrics/{metricName} | \n*RetrieveAssetLocationHistoryControllerApi* | [**retrieve_location_history_for_asset**](docs/RetrieveAssetLocationHistoryControllerApi.md#retrieve_location_history_for_asset) | **GET** /assets/{assetId}/location | \n*RetrieveAssetLocationHistoryControllerApi* | [**retrieve_location_history_for_asset1**](docs/RetrieveAssetLocationHistoryControllerApi.md#retrieve_location_history_for_asset1) | **GET** /assets/identifier={assetIdentifier}/location | \n*RetrieveAssetSnapshotControllerApi* | [**retrieve_asset_snapshot**](docs/RetrieveAssetSnapshotControllerApi.md#retrieve_asset_snapshot) | **GET** /assets/{assetId}/snapshot/{queryDateTime} | \n*RetrieveControlRoomAppControllerApi* | [**list_installed_apps_for_control_room**](docs/RetrieveControlRoomAppControllerApi.md#list_installed_apps_for_control_room) | **GET** /controlrooms/{controlRoomId}/apps/{appInstanceId} | \n*RetrieveControlRoomConfigControllerApi* | [**retrieve_configuration**](docs/RetrieveControlRoomConfigControllerApi.md#retrieve_configuration) | **GET** /controlrooms/{controlRoomId}/config | \n*SearchAssetAttributesControllerApi* | [**list_asset_attribute_values_by_attribute_name**](docs/SearchAssetAttributesControllerApi.md#list_asset_attribute_values_by_attribute_name) | **POST** /assets/attributes/{attribute} | \n*SearchAssetsControllerApi* | [**search_assets**](docs/SearchAssetsControllerApi.md#search_assets) | **POST** /assets/search | \n*SearchControlRoomEventsControllerApi* | [**search_events_within_control_room**](docs/SearchControlRoomEventsControllerApi.md#search_events_within_control_room) | **POST** /controlrooms/{controlRoomId}/events/search | \n*SearchCyclesControllerApi* | [**search_cycles**](docs/SearchCyclesControllerApi.md#search_cycles) | **POST** /cycles/search | \n*SearchEventsControllerApi* | [**search_events**](docs/SearchEventsControllerApi.md#search_events) | **POST** /events/search | \n*SearchRulesForControlRoomControllerApi* | [**search_rules_within_control_room**](docs/SearchRulesForControlRoomControllerApi.md#search_rules_within_control_room) | **POST** /controlrooms/{controlRoomId}/rules/search | \n*SearchTasksControllerApi* | [**search_tasks**](docs/SearchTasksControllerApi.md#search_tasks) | **POST** /tasks/search | \n*SearchTasksForControlRoomControllerApi* | [**search_tasks_within_control_room**](docs/SearchTasksForControlRoomControllerApi.md#search_tasks_within_control_room) | **POST** /tasks/{controlRoomId}/search | \n*UninstallControlRoomAppControllerApi* | [**uninstall_control_room_app**](docs/UninstallControlRoomAppControllerApi.md#uninstall_control_room_app) | **DELETE** /controlrooms/{controlRoomId}/apps/{appInstanceId} | \n*UpdateAssetAttachmentControllerApi* | [**update_asset_attachments**](docs/UpdateAssetAttachmentControllerApi.md#update_asset_attachments) | **PATCH** /assets/{assetId}/attachments/{attachmentId} | \n*UpdateAssetControllerApi* | [**update_asset_by_id**](docs/UpdateAssetControllerApi.md#update_asset_by_id) | **PATCH** /assets/{assetId} | \n*UpdateAssetControllerApi* | [**update_asset_by_identifier**](docs/UpdateAssetControllerApi.md#update_asset_by_identifier) | **PATCH** /assets/identifier={assetIdentifier} | \n*UpdateAssetTypeControllerApi* | [**update_asset_type**](docs/UpdateAssetTypeControllerApi.md#update_asset_type) | **PUT** /asset-types/{assetTypeId} | \n*UpdateAssetTypeMapViewControllerApi* | [**update_asset_map_view**](docs/UpdateAssetTypeMapViewControllerApi.md#update_asset_map_view) | **PUT** /asset-types/{assetTypeId}/views/map | \n*UpdateAssetTypeTableViewControllerApi* | [**update_asset_table_view**](docs/UpdateAssetTypeTableViewControllerApi.md#update_asset_table_view) | **PUT** /asset-types/{assetTypeId}/views/table | \n*UpdateControlRoomAppControllerApi* | [**update_control_room_app**](docs/UpdateControlRoomAppControllerApi.md#update_control_room_app) | **PUT** /controlrooms/{controlRoomId}/apps/{appInstanceId} | \n*UpdateControlRoomAppControllerApi* | [**update_control_room_app1**](docs/UpdateControlRoomAppControllerApi.md#update_control_room_app1) | **PATCH** /controlrooms/{controlRoomId}/apps/{appInstanceId} | \n*UpdateControlRoomCollaboratorControllerApi* | [**update_control_room_collaborator**](docs/UpdateControlRoomCollaboratorControllerApi.md#update_control_room_collaborator) | **PUT** /controlrooms/{controlRoomId}/collaborators/{userId} | \n*UpdateControlRoomConfigControllerApi* | [**update_configuration**](docs/UpdateControlRoomConfigControllerApi.md#update_configuration) | **PATCH** /controlrooms/{controlRoomId}/config | \n*UpdateControlRoomControllerApi* | [**update_control_room**](docs/UpdateControlRoomControllerApi.md#update_control_room) | **PUT** /controlrooms/{controlRoomId} | \n*UpdateCycleControllerApi* | [**update_cycle_by_id**](docs/UpdateCycleControllerApi.md#update_cycle_by_id) | **PATCH** /cycles/{cycleId} | \n*UpdateCycleTypeControllerApi* | [**update_cycle_type**](docs/UpdateCycleTypeControllerApi.md#update_cycle_type) | **PATCH** /cycle-types/{cycleTypeId} | \n*UpdateEventControllerApi* | [**update_event**](docs/UpdateEventControllerApi.md#update_event) | **PATCH** /events/{eventId} | \n*UpdateEventTypeControllerApi* | [**update_event_type**](docs/UpdateEventTypeControllerApi.md#update_event_type) | **PUT** /event-types/{eventTypeId} | \n*UpdateFormControllerApi* | [**update_form_using_id**](docs/UpdateFormControllerApi.md#update_form_using_id) | **PUT** /forms/{formId} | \n*UpdateFormControllerApi* | [**update_form_using_identifier**](docs/UpdateFormControllerApi.md#update_form_using_identifier) | **PUT** /forms/identifier={formIdentifier} | \n*UpdateOrganizationControllerApi* | [**update_organization**](docs/UpdateOrganizationControllerApi.md#update_organization) | **PUT** /organization | \n*UpdatePlaceControllerApi* | [**update_place_by_id**](docs/UpdatePlaceControllerApi.md#update_place_by_id) | **PATCH** /places/{placeId} | \n*UpdatePlaceControllerApi* | [**update_place_by_identifier**](docs/UpdatePlaceControllerApi.md#update_place_by_identifier) | **PATCH** /places/identifier={placeIdentifier} | \n*UpdatePlaceTypeControllerApi* | [**update_place_type**](docs/UpdatePlaceTypeControllerApi.md#update_place_type) | **PATCH** /place-types/{placeTypeId} | \n*UpdateRuleForControlRoomControllerApi* | [**update_rule**](docs/UpdateRuleForControlRoomControllerApi.md#update_rule) | **PUT** /controlrooms/{controlRoomId}/rules/{ruleId} | \n*UpdateRuleTypeControllerApi* | [**update_rule_type**](docs/UpdateRuleTypeControllerApi.md#update_rule_type) | **PUT** /rule-types/{ruleTypeId} | \n*UpdateTaskControllerApi* | [**update_task**](docs/UpdateTaskControllerApi.md#update_task) | **PUT** /tasks/{taskId} | \n*UpdateTaskTypeControllerApi* | [**update_task_type**](docs/UpdateTaskTypeControllerApi.md#update_task_type) | **PUT** /task-types/{taskTypeId} | \n*UpdateUserControllerApi* | [**update_user**](docs/UpdateUserControllerApi.md#update_user) | **PUT** /me | \n*UpdateUserPreferenceControllerApi* | [**update_user_preferences**](docs/UpdateUserPreferenceControllerApi.md#update_user_preferences) | **POST** /me/preferences | \n*UserDetailsControllerApi* | [**verify_user**](docs/UserDetailsControllerApi.md#verify_user) | **GET** /me | \n\n\n## Documentation For Models\n\n - [Action](docs/Action.md)\n - [AggregatedResponse](docs/AggregatedResponse.md)\n - [AggregationParameterRequest](docs/AggregationParameterRequest.md)\n - [ApiKeyResponse](docs/ApiKeyResponse.md)\n - [ApiKeysResponse](docs/ApiKeysResponse.md)\n - [AssetAttachments](docs/AssetAttachments.md)\n - [AssetAttachmentsResponse](docs/AssetAttachmentsResponse.md)\n - [AssetCount](docs/AssetCount.md)\n - [AssetLocationResponse](docs/AssetLocationResponse.md)\n - [AssetMapViewResponse](docs/AssetMapViewResponse.md)\n - [AssetMetricResponse](docs/AssetMetricResponse.md)\n - [AssetRequest](docs/AssetRequest.md)\n - [AssetResponse](docs/AssetResponse.md)\n - [AssetSearchRequest](docs/AssetSearchRequest.md)\n - [AssetSnapshotResponse](docs/AssetSnapshotResponse.md)\n - [AssetTableViewResponse](docs/AssetTableViewResponse.md)\n - [AssetTypeRequest](docs/AssetTypeRequest.md)\n - [AssetTypeResponse](docs/AssetTypeResponse.md)\n - [AssetTypes](docs/AssetTypes.md)\n - [Assets](docs/Assets.md)\n - [AssetsAggregationResponse](docs/AssetsAggregationResponse.md)\n - [AttachmentDto](docs/AttachmentDto.md)\n - [AttachmentResource](docs/AttachmentResource.md)\n - [AttachmentUpdate](docs/AttachmentUpdate.md)\n - [AttachmentsRequest](docs/AttachmentsRequest.md)\n - [AttachmentsRequestAttachmentsInner](docs/AttachmentsRequestAttachmentsInner.md)\n - [AuthorizePaymentMethodRequest](docs/AuthorizePaymentMethodRequest.md)\n - [BillingPlanResponse](docs/BillingPlanResponse.md)\n - [ChangeLog](docs/ChangeLog.md)\n - [ClearControlRoomEventsRequest](docs/ClearControlRoomEventsRequest.md)\n - [CollaboratorResponse](docs/CollaboratorResponse.md)\n - [CollaboratorsResponse](docs/CollaboratorsResponse.md)\n - [ControlRoom](docs/ControlRoom.md)\n - [ControlRoomAssetSettingsResponse](docs/ControlRoomAssetSettingsResponse.md)\n - [ControlRoomCollaboratorRequest](docs/ControlRoomCollaboratorRequest.md)\n - [ControlRoomCollaboratorResponse](docs/ControlRoomCollaboratorResponse.md)\n - [ControlRoomCollaboratorsRequest](docs/ControlRoomCollaboratorsRequest.md)\n - [ControlRoomConfigResponse](docs/ControlRoomConfigResponse.md)\n - [ControlRoomEventChangesResponse](docs/ControlRoomEventChangesResponse.md)\n - [ControlRoomEventResponse](docs/ControlRoomEventResponse.md)\n - [ControlRoomEventSearchRequest](docs/ControlRoomEventSearchRequest.md)\n - [ControlRoomEventsResponse](docs/ControlRoomEventsResponse.md)\n - [ControlRoomEventsSummaryResponse](docs/ControlRoomEventsSummaryResponse.md)\n - [ControlRoomResponse](docs/ControlRoomResponse.md)\n - [ControlRoomRulesResponse](docs/ControlRoomRulesResponse.md)\n - [ControlRoomTaskSearchRequest](docs/ControlRoomTaskSearchRequest.md)\n - [ControlRoomTasksResponse](docs/ControlRoomTasksResponse.md)\n - [ControlRoomsResponse](docs/ControlRoomsResponse.md)\n - [CopyAttachmentAction](docs/CopyAttachmentAction.md)\n - [CreateAttachmentAction](docs/CreateAttachmentAction.md)\n - [CreateControlRoomRequest](docs/CreateControlRoomRequest.md)\n - [CreateEventResponse](docs/CreateEventResponse.md)\n - [CreateUserRequest](docs/CreateUserRequest.md)\n - [Crs](docs/Crs.md)\n - [CycleAggregationParameterRequest](docs/CycleAggregationParameterRequest.md)\n - [CycleRequest](docs/CycleRequest.md)\n - [CycleResponse](docs/CycleResponse.md)\n - [CycleSearchRequest](docs/CycleSearchRequest.md)\n - [CycleSummaries](docs/CycleSummaries.md)\n - [CycleSummaryRequest](docs/CycleSummaryRequest.md)\n - [CycleSummaryResponse](docs/CycleSummaryResponse.md)\n - [CycleTypeRequest](docs/CycleTypeRequest.md)\n - [CycleTypeResponse](docs/CycleTypeResponse.md)\n - [CycleTypes](docs/CycleTypes.md)\n - [Cycles](docs/Cycles.md)\n - [CyclesCycles](docs/CyclesCycles.md)\n - [DateGrouping](docs/DateGrouping.md)\n - [DateRange](docs/DateRange.md)\n - [DeleteTaskRequest](docs/DeleteTaskRequest.md)\n - [EmailChannel](docs/EmailChannel.md)\n - [EntityResponse](docs/EntityResponse.md)\n - [EventCreatedOptions](docs/EventCreatedOptions.md)\n - [EventDisplay](docs/EventDisplay.md)\n - [EventPlace](docs/EventPlace.md)\n - [EventRequest](docs/EventRequest.md)\n - [EventResponse](docs/EventResponse.md)\n - [EventSearchRequest](docs/EventSearchRequest.md)\n - [EventTypeCount](docs/EventTypeCount.md)\n - [EventTypeRequest](docs/EventTypeRequest.md)\n - [EventTypeResponse](docs/EventTypeResponse.md)\n - [EventTypes](docs/EventTypes.md)\n - [EventWarning](docs/EventWarning.md)\n - [Events](docs/Events.md)\n - [ExcessChargePolicy](docs/ExcessChargePolicy.md)\n - [ExecuteAssetsAggregationRequest](docs/ExecuteAssetsAggregationRequest.md)\n - [ExecutePeriodAggregationRequest](docs/ExecutePeriodAggregationRequest.md)\n - [Execution](docs/Execution.md)\n - [Feature](docs/Feature.md)\n - [FeatureAllOfGeometry](docs/FeatureAllOfGeometry.md)\n - [FeatureAllOfGeometry1](docs/FeatureAllOfGeometry1.md)\n - [FeatureCollection](docs/FeatureCollection.md)\n - [Filter](docs/Filter.md)\n - [FormAction](docs/FormAction.md)\n - [FormRequest](docs/FormRequest.md)\n - [FormResponse](docs/FormResponse.md)\n - [FormResponseRequest](docs/FormResponseRequest.md)\n - [FormResponseResponse](docs/FormResponseResponse.md)\n - [FormResponsesResponse](docs/FormResponsesResponse.md)\n - [FormsResponse](docs/FormsResponse.md)\n - [GeoJsonObject](docs/GeoJsonObject.md)\n - [GeometryCollection](docs/GeometryCollection.md)\n - [GeometryCollectionAllOfGeometries](docs/GeometryCollectionAllOfGeometries.md)\n - [Importance](docs/Importance.md)\n - [ImportanceCount](docs/ImportanceCount.md)\n - [InstallAppRequest](docs/InstallAppRequest.md)\n - [InstalledAppResponse](docs/InstalledAppResponse.md)\n - [InstalledAppsResponse](docs/InstalledAppsResponse.md)\n - [InviteUserRequest](docs/InviteUserRequest.md)\n - [InviteUsersRequest](docs/InviteUsersRequest.md)\n - [InvoiceResponse](docs/InvoiceResponse.md)\n - [InvoicesResponse](docs/InvoicesResponse.md)\n - [LineString](docs/LineString.md)\n - [Link](docs/Link.md)\n - [LinkedAssetResponse](docs/LinkedAssetResponse.md)\n - [LinkedEntity](docs/LinkedEntity.md)\n - [LinkedPlaceResponse](docs/LinkedPlaceResponse.md)\n - [LngLatAlt](docs/LngLatAlt.md)\n - [LocationHistory](docs/LocationHistory.md)\n - [MailingListSubscriptionRequest](docs/MailingListSubscriptionRequest.md)\n - [MailingListSubscriptionResponse](docs/MailingListSubscriptionResponse.md)\n - [MapRuleResponse](docs/MapRuleResponse.md)\n - [MapTooltipResponse](docs/MapTooltipResponse.md)\n - [MapUpdateResponse](docs/MapUpdateResponse.md)\n - [MetricHistory](docs/MetricHistory.md)\n - [ModelField](docs/ModelField.md)\n - [ModelProperty](docs/ModelProperty.md)\n - [MultiLineString](docs/MultiLineString.md)\n - [MultiPoint](docs/MultiPoint.md)\n - [MultiPolygon](docs/MultiPolygon.md)\n - [NotificationActionConfig](docs/NotificationActionConfig.md)\n - [NotificationActionConfigChannelsInner](docs/NotificationActionConfigChannelsInner.md)\n - [NotificationChannel](docs/NotificationChannel.md)\n - [NotificationRuleAction](docs/NotificationRuleAction.md)\n - [OrganizationResponse](docs/OrganizationResponse.md)\n - [Pageable](docs/Pageable.md)\n - [PaymentMethodResponse](docs/PaymentMethodResponse.md)\n - [PaymentMethodsResponse](docs/PaymentMethodsResponse.md)\n - [PeriodAggregatedResponse](docs/PeriodAggregatedResponse.md)\n - [PeriodAggregationResponse](docs/PeriodAggregationResponse.md)\n - [PlaceEnteredExitedOptions](docs/PlaceEnteredExitedOptions.md)\n - [PlaceRequest](docs/PlaceRequest.md)\n - [PlaceResponse](docs/PlaceResponse.md)\n - [PlaceTypeRequest](docs/PlaceTypeRequest.md)\n - [PlaceTypeResponse](docs/PlaceTypeResponse.md)\n - [PlaceTypes](docs/PlaceTypes.md)\n - [Places](docs/Places.md)\n - [PlanConstraint](docs/PlanConstraint.md)\n - [Point](docs/Point.md)\n - [Polygon](docs/Polygon.md)\n - [PushChannel](docs/PushChannel.md)\n - [QuickFilter](docs/QuickFilter.md)\n - [QuickFilterEntry](docs/QuickFilterEntry.md)\n - [Range](docs/Range.md)\n - [ReportUrlResponse](docs/ReportUrlResponse.md)\n - [RuleActionObjectObject](docs/RuleActionObjectObject.md)\n - [RuleRequest](docs/RuleRequest.md)\n - [RuleResponse](docs/RuleResponse.md)\n - [RuleTypeRequest](docs/RuleTypeRequest.md)\n - [RuleTypeResponse](docs/RuleTypeResponse.md)\n - [RuleTypes](docs/RuleTypes.md)\n - [RulesResponse](docs/RulesResponse.md)\n - [RulesSearchRequest](docs/RulesSearchRequest.md)\n - [SearchAssetAttributeRequest](docs/SearchAssetAttributeRequest.md)\n - [SearchAssetAttributeResponse](docs/SearchAssetAttributeResponse.md)\n - [SmsChannel](docs/SmsChannel.md)\n - [TaskAssetResponse](docs/TaskAssetResponse.md)\n - [TaskCreatedOptions](docs/TaskCreatedOptions.md)\n - [TaskEventResponse](docs/TaskEventResponse.md)\n - [TaskRequest](docs/TaskRequest.md)\n - [TaskResponse](docs/TaskResponse.md)\n - [TaskSearchRequest](docs/TaskSearchRequest.md)\n - [TaskTypeRequest](docs/TaskTypeRequest.md)\n - [TaskTypeResponse](docs/TaskTypeResponse.md)\n - [TaskTypes](docs/TaskTypes.md)\n - [Tasks](docs/Tasks.md)\n - [Tooltip](docs/Tooltip.md)\n - [UpdateAssetMapViewRequest](docs/UpdateAssetMapViewRequest.md)\n - [UpdateAssetRequest](docs/UpdateAssetRequest.md)\n - [UpdateAssetTableViewRequest](docs/UpdateAssetTableViewRequest.md)\n - [UpdateAssetTypeRequest](docs/UpdateAssetTypeRequest.md)\n - [UpdateControlRoomAssetSettingsRequest](docs/UpdateControlRoomAssetSettingsRequest.md)\n - [UpdateControlRoomCollaboratorRequest](docs/UpdateControlRoomCollaboratorRequest.md)\n - [UpdateControlRoomConfigRequest](docs/UpdateControlRoomConfigRequest.md)\n - [UpdateControlRoomRequest](docs/UpdateControlRoomRequest.md)\n - [UpdateCycleRequest](docs/UpdateCycleRequest.md)\n - [UpdateCycleTypeRequest](docs/UpdateCycleTypeRequest.md)\n - [UpdateEventRequest](docs/UpdateEventRequest.md)\n - [UpdateEventTypeRequest](docs/UpdateEventTypeRequest.md)\n - [UpdateFormRequest](docs/UpdateFormRequest.md)\n - [UpdateInstalledAppRequest](docs/UpdateInstalledAppRequest.md)\n - [UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)\n - [UpdatePlaceRequest](docs/UpdatePlaceRequest.md)\n - [UpdatePlaceTypeRequest](docs/UpdatePlaceTypeRequest.md)\n - [UpdateRuleRequest](docs/UpdateRuleRequest.md)\n - [UpdateRuleTypeRequest](docs/UpdateRuleTypeRequest.md)\n - [UpdateRuleTypeRequestOptions](docs/UpdateRuleTypeRequestOptions.md)\n - [UpdateTaskRequest](docs/UpdateTaskRequest.md)\n - [UpdateTaskTypeRequest](docs/UpdateTaskTypeRequest.md)\n - [UpdateUserDeviceRequest](docs/UpdateUserDeviceRequest.md)\n - [UpdateUserPreferencesRequest](docs/UpdateUserPreferencesRequest.md)\n - [UpdateUserRequest](docs/UpdateUserRequest.md)\n - [UploadSignatureResponse](docs/UploadSignatureResponse.md)\n - [UserDetailsResponse](docs/UserDetailsResponse.md)\n - [UserDeviceResponse](docs/UserDeviceResponse.md)\n - [UserDevicesResponse](docs/UserDevicesResponse.md)\n - [UserPreferenceResponse](docs/UserPreferenceResponse.md)\n - [UserPreferencesResponse](docs/UserPreferencesResponse.md)\n - [UserResponse](docs/UserResponse.md)\n - [UsersResponse](docs/UsersResponse.md)\n - [Widget](docs/Widget.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"bearerAuth\"></a>\n### bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n<a id=\"apiKeyAuth\"></a>\n### apiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: X-Authorization\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Skyledge InControl API",
"version": "1.3.4",
"project_urls": {
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" skyledge incontrol api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e80192bef9841745c4e2a88f808338b6a4dc0fcd350291af0754fdd42846c346",
"md5": "0c9a50f993bb66746bd0df5948963be1",
"sha256": "5f593ae8054ca8a6beb8fc6c415fc46046d8dedaef7ab8f6334d3f5571d4bd61"
},
"downloads": -1,
"filename": "skyledge_api_sdk-1.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c9a50f993bb66746bd0df5948963be1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 603546,
"upload_time": "2025-07-22T05:29:14",
"upload_time_iso_8601": "2025-07-22T05:29:14.448104Z",
"url": "https://files.pythonhosted.org/packages/e8/01/92bef9841745c4e2a88f808338b6a4dc0fcd350291af0754fdd42846c346/skyledge_api_sdk-1.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6ca6d477431581f44a5481af1e49a40a8c646ca7e00f41afe25c55d914200aa9",
"md5": "9988f2fded4a045e6c0f5c5aa7adbe0b",
"sha256": "b8c8f2446a11f4d72eaba2e105627932bd1bc29a20df6ac828d027d465308b6d"
},
"downloads": -1,
"filename": "skyledge_api_sdk-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "9988f2fded4a045e6c0f5c5aa7adbe0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 182339,
"upload_time": "2025-07-22T05:29:16",
"upload_time_iso_8601": "2025-07-22T05:29:16.888726Z",
"url": "https://files.pythonhosted.org/packages/6c/a6/d477431581f44a5481af1e49a40a8c646ca7e00f41afe25c55d914200aa9/skyledge_api_sdk-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-22 05:29:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "skyledge-api-sdk"
}
JSON
