skyledge-sdk 1.0.3

Skyledge API

Skyledge SDK

Sky Ledge is an operational insights platform that gives you the visibility and control you need to minimise inefficiencies, oversight, theft, and ultimately, unnecessary costs associated with your operations.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.3
• 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:

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:

import skyledge_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import skyledge_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import skyledge_sdk
from skyledge_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_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_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with skyledge_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = skyledge_sdk.ControlRoomAppsApi(api_client)
    control_room_id = 'control_room_id_example' # str | 
    app_instance_id = 'app_instance_id_example' # str | 

    try:
        api_response = api_instance.list_installed_apps_for_control_room(control_room_id, app_instance_id)
        print("The response of ControlRoomAppsApi->list_installed_apps_for_control_room:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ControlRoomAppsApi->list_installed_apps_for_control_room: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://host.docker.internal:8080

Class	Method	HTTP request	Description
ControlRoomAppsApi	list_installed_apps_for_control_room	GET /controlrooms/{controlRoomId}/apps/{appInstanceId}
ControlRoomAppsApi	update_control_room_app	PUT /controlrooms/{controlRoomId}/apps/{appInstanceId}
ControlRoomAppsApi	update_control_room_app1	PATCH /controlrooms/{controlRoomId}/apps/{appInstanceId}
ApiKeyRetrievalControllerApi	list_api_keys	GET /api-key
AssignAssetTypeToControlRoomControllerApi	assign_asset_type_to_control_room	PUT /controlrooms/{controlRoomId}/asset-types/{assetTypeId}
AssignControlRoomCollaboratorsControllerApi	invite_collaborators	POST /controlrooms/{controlRoomId}/invite
AssignPlaceTypeToControlRoomControllerApi	assign_place_type_to_controlroom	PUT /controlrooms/{controlRoomId}/place-types/{placeTypeId}
AuthorizePaymentMethodControllerApi	authorize_payment_method	POST /billing/payment-methods
ClearControlRoomEventsControllerApi	clear_events	POST /controlrooms/{controlRoomId}/events/clear
CreateAssetAttachmentsControllerApi	add_asset_attachments	POST /assets/{assetId}/attachments
CreateAssetForAssetTypeControllerApi	create_asset	POST /asset-types/{assetTypeId}/assets
CreateAssetForAssetTypeControllerApi	create_asset_by_identifier	POST /asset-types/identifier={assetTypeIdentifier}/assets
CreateAssetTypeControllerApi	create_asset_type	POST /asset-types
CreateControlRoomControllerApi	create_control_rooms	POST /controlrooms
CreateCycleForCycleTypeControllerApi	create_cycle	POST /cycle-types/{cycleTypeId}/cycles
CreateCycleForCycleTypeControllerApi	create_cycle_by_identifier	POST /cycle-types/identifier={cycleTypeIdentifier}/cycles
CreateCycleTypeControllerApi	create_cycle_type	POST /cycle-types
CreateEventForEventTypeControllerApi	create_event	POST /event-types/{eventTypeId}/events
CreateEventForEventTypeControllerApi	create_event_by_identifier	POST /event-types/identifier={eventTypeIdentifier}/events
CreateEventTypeControllerApi	create_event_type	POST /event-types
CreateFormControllerApi	create_form	POST /forms
CreateFormResponseControllerApi	create_form_response	POST /forms/{formId}/responses
CreateFormResponseControllerApi	create_form_response_by_identifier	POST /forms/identifier={formIdentifier}/responses
CreatePlaceForPlaceTypeControllerApi	create_place	POST /place-types/{placeTypeId}/places
CreatePlaceForPlaceTypeControllerApi	create_place_by_identifier	POST /place-types/identifier={placeTypeIdentifier}/places
CreatePlaceTypeControllerApi	create_place_type	POST /place-types
CreateRuleForControlRoomControllerApi	create_rule	POST /controlrooms/{controlRoomId}/rule-types/{ruleTypeId}/rules
CreateRuleForControlRoomControllerApi	create_rule_by_identifier	POST /controlrooms/{controlRoomId}/rule-types/identifier={ruleTypeIdentifier}/rules
CreateRuleTypeControllerApi	create_rule_type	POST /rule-types
CreateTaskControllerApi	create_task	POST /task-types/{taskTypeId}/tasks
CreateTaskTypeControllerApi	create_task_type	POST /task-types
CreateUploadSignatureControllerApi	create_upload_signature	POST /assets/{assetId}/attachments/upload-signature
CreateUserControllerApi	create_users	POST /users
CycleSummaryControllerApi	cycle_summary	POST /cycles/summary
DeleteAssetAttachmentControllerApi	delete_attachment	DELETE /assets/{assetId}/attachments/{attachmentId}
DeleteControlRoomControllerApi	delete_control_room	DELETE /controlrooms/{controlRoomId}
DeleteCycleControllerApi	delete_cycle_by_id	DELETE /cycles/{cycleId}
DeletePlaceControllerApi	delete_place_by_id	DELETE /places/{placeId}
DeletePlaceControllerApi	delete_place_by_identifier	DELETE /places/identifier={placeIdentifier}
DeleteRuleControllerApi	delete_rule	DELETE /rules/{ruleId}
DeleteTaskControllerApi	delete_task	DELETE /tasks/{taskId}
ErrorControllerApi	error	GET /error
ErrorControllerApi	error1	POST /error
ErrorControllerApi	error2	PUT /error
ErrorControllerApi	error3	DELETE /error
ErrorControllerApi	error4	PATCH /error
ErrorControllerApi	error5	HEAD /error
ErrorControllerApi	error6	OPTIONS /error
ExecuteAssetsAggregationControllerApi	execute_aggregation	POST /asset-types/{assetTypeIdentifier}/assets/aggregation
ExecutePeriodAggregationControllerApi	execute_aggregation_by_id	POST /assets/{assetId}/aggregation
ExecutePeriodAggregationControllerApi	execute_aggregation_by_identifier	POST /assets/identifier={assetIdentifier}/aggregation
GetAssetActiveEventsControllerApi	retrieve_latest100_active_events	GET /assets/{assetId}/events/active
GetAssetAttachmentControllerApi	get_asset_attachment	GET /assets/{assetId}/attachments/{attachmentId}
GetAssetControllerApi	get_asset_using_asset_id	GET /assets/{assetId}
GetAssetControllerApi	get_asset_using_asset_identifier	GET /assets/identifier={assetIdentifier}
GetAssetTypeControllerApi	get_asset_type	GET /asset-types/{assetTypeId}
GetAssetTypeMapViewControllerApi	get_asset_map_view	GET /asset-types/{assetTypeId}/views/map
GetAssetTypeSettingsControllerApi	get_asset_settings	GET /controlrooms/{controlRoomId}/asset-types/{assetTypeId}
GetAssetTypeTableViewControllerApi	get_asset_table_view	GET /asset-types/{assetTypeId}/views/table
GetBillingPlanControllerApi	get_billing_plan	GET /billing/plan
GetControlRoomControllerApi	get_control_room	GET /controlrooms/{controlRoomId}
GetControlRoomEventsSummaryControllerApi	get_control_room_event_summary	GET /controlrooms/{controlRoomId}/events/summary
GetCycleControllerApi	get_cycle_by_cycle_id	GET /cycles/{cycleId}
GetCycleTypeControllerApi	get_cycle_type	GET /cycle-types/{cycleTypeId}
GetEventControllerApi	get_event	GET /events/{eventId}
GetEventTypeControllerApi	get_event_type	GET /event-types/{eventTypeId}
GetFormControllerApi	get_form_using_form_id	GET /forms/{formId}
GetFormControllerApi	get_form_using_form_identifier	GET /forms/identifier={formIdentifier}
GetFormResponseControllerApi	get_form_using_form_id1	GET /forms/{formId}/responses/{formResponseId}
GetFormResponseControllerApi	get_form_using_form_identifier1	GET /forms/identifier={formIdentifier}/responses/{formResponseId}
GetPaymentMethodControllerApi	get_payment_method	GET /billing/payment-methods
GetPlaceControllerApi	get_place_using_place_id	GET /places/{placeId}
GetPlaceControllerApi	get_place_using_place_identifier	GET /places/identifier={placeIdentifier}
GetPlaceTypeControllerApi	get_place_type	GET /place-types/{placeTypeId}
GetReportUrlForControlRoomControllerApi	get_report_url	GET /controlrooms/{controlRoomId}/report-url
GetRuleControllerApi	get_rule	GET /rules/{ruleId}
GetRuleTypeControllerApi	get_rule_type	GET /rule-types/{ruleTypeId}
GetTaskControllerApi	get_task	GET /tasks/{taskId}
GetTaskTypeControllerApi	get_task_type	GET /task-types/{taskTypeId}
InstallControlRoomAppControllerApi	install_app_to_control_room	POST /controlrooms/{controlRoomId}/apps
InviteUsersControllerApi	invite_users	POST /users/invite
ListAssetAttachmentsControllerApi	get_asset_attachments	GET /assets/{assetId}/attachments
ListAssetTypesControllerApi	list_asset_types	GET /asset-types
ListAssetTypesForControlRoomControllerApi	list_asset_types_for_control_room	GET /controlrooms/{controlRoomId}/asset-types
ListAssetsControllerApi	list_assets	GET /assets
ListAssetsForControlRoomControllerApi	list_asset_for_control_room	GET /controlrooms/{controlRoomId}/assets
ListCollaboratorsControllerApi	list_collaborators	GET /controlrooms/{controlRoomId}/collaborators
ListControlRoomEventChangesControllerApi	list_control_room_event_changes	GET /controlrooms/{controlRoomId}/events/changes
ListControlRoomEventsControllerApi	list_control_room_events	GET /controlrooms/{controlRoomId}/events
ListControlRoomsControllerApi	list_control_rooms	GET /controlrooms
ListCycleTypesControllerApi	list_cycle_types	GET /cycle-types
ListCyclesControllerApi	list_cycles	GET /cycles
ListEventTypesControllerApi	list_event_types	GET /event-types
ListEventTypesForControlRoomControllerApi	list_event_types_for_control_room	GET /controlrooms/{id}/event-types
ListFormResponsesControllerApi	get_responses_using_form_id	GET /forms/{formId}/responses
ListFormResponsesControllerApi	get_responses_using_form_identifier	GET /forms/identifier={formIdentifier}/responses
ListFormsControllerApi	list_forms	GET /forms
ListInstalledControlRoomAppsControllerApi	list_installed_apps_for_control_room1	GET /controlrooms/{controlRoomId}/apps
ListInvoicesControllerApi	get_invoices	GET /billing/invoices
ListPlaceTypesControllerApi	list_place_types	GET /place-types
ListPlaceTypesForControlRoomControllerApi	list_place_types_for_control_room	GET /controlrooms/{controlRoomId}/place-types
ListPlacesControllerApi	list_places_for_control_room	GET /places
ListPlacesForControlRoomControllerApi	list_places_for_control_room1	GET /controlrooms/{controlRoomId}/places
ListRuleTypesControllerApi	list_rule_types	GET /rule-types
ListRulesControllerApi	list_rules	GET /rule-types/{ruleTypeId}/rules
ListTaskTypesControllerApi	list_task_types	GET /task-types
ListTasksControllerApi	list_tasks	GET /task-types/{taskTypeId}/tasks
ListUserDevicesControllerApi	retrieve_user_devices	GET /me/devices
ListUserPreferencesControllerApi	retrieve_user_preferences	GET /me/preferences
ListUsersControllerApi	list_users	GET /users
MailingListSubscriptionControllerApi	subscribe_to_mailing_list	POST /me/mailing-list
MailingListUnsubscribeControllerApi	unsubscribe_from_mailing_list	DELETE /me/mailing-list/{listName}
RegisterUserDeviceControllerApi	update_user_device	PUT /me/devices
RetrieveAssetHistoricMetricsControllerApi	retrieve_metrics_for_asset	GET /assets/{assetId}/metrics/{metricName}
RetrieveAssetHistoricMetricsControllerApi	retrieve_metrics_for_asset1	GET /assets/identifier={assetIdentifier}/metrics/{metricName}
RetrieveAssetLocationHistoryControllerApi	retrieve_location_history_for_asset	GET /assets/{assetId}/location
RetrieveAssetLocationHistoryControllerApi	retrieve_location_history_for_asset1	GET /assets/identifier={assetIdentifier}/location
RetrieveAssetSnapshotControllerApi	retrieve_asset_snapshot	GET /assets/{assetId}/snapshot/{queryDateTime}
RetrieveControlRoomConfigControllerApi	retrieve_configuration	GET /controlrooms/{controlRoomId}/config
SearchAssetAttributesControllerApi	list_asset_attribute_values_by_attribute_name	POST /assets/attributes/{attribute}
SearchAssetsControllerApi	search_assets	POST /assets/search
SearchControlRoomEventsControllerApi	search_events_within_control_room	POST /controlrooms/{controlRoomId}/events/search
SearchCyclesControllerApi	search_cycles	POST /cycles/search
SearchEventsControllerApi	search_events	POST /events/search
SearchRulesForControlRoomControllerApi	search_rules_within_control_room	POST /controlrooms/{controlRoomId}/rules/search
SearchTasksControllerApi	search_tasks	POST /tasks/search
SearchTasksForControlRoomControllerApi	search_tasks_within_control_room	POST /tasks/{controlRoomId}/search
UninstallControlRoomAppControllerApi	uninstall_control_room_app	DELETE /controlrooms/{controlRoomId}/apps/{appInstanceId}
UpdateAssetAttachmentControllerApi	update_asset_attachments	PATCH /assets/{assetId}/attachments/{attachmentId}
UpdateAssetControllerApi	update_asset_by_id	PATCH /assets/{assetId}
UpdateAssetControllerApi	update_asset_by_identifier	PATCH /assets/identifier={assetIdentifier}
UpdateAssetTypeControllerApi	update_asset_type	PUT /asset-types/{assetTypeId}
UpdateAssetTypeMapViewControllerApi	update_asset_map_view	PUT /asset-types/{assetTypeId}/views/map
UpdateAssetTypeTableViewControllerApi	update_asset_table_view	PUT /asset-types/{assetTypeId}/views/table
UpdateControlRoomCollaboratorControllerApi	update_control_room_collaborator	PUT /controlrooms/{controlRoomId}/collaborators/{userId}
UpdateControlRoomConfigControllerApi	update_configuration	PATCH /controlrooms/{controlRoomId}/config
UpdateControlRoomControllerApi	update_control_room	PUT /controlrooms/{controlRoomId}
UpdateCycleControllerApi	update_cycle_by_id	PATCH /cycles/{cycleId}
UpdateCycleTypeControllerApi	update_cycle_type	PATCH /cycle-types/{cycleTypeId}
UpdateEventControllerApi	update_event	PATCH /events/{eventId}
UpdateEventTypeControllerApi	update_event_type	PUT /event-types/{eventTypeId}
UpdateFormControllerApi	update_form_using_id	PUT /forms/{formId}
UpdateFormControllerApi	update_form_using_identifier	PUT /forms/identifier={formIdentifier}
UpdateOrganizationControllerApi	update_organization	PUT /organization
UpdatePlaceControllerApi	update_place_by_id	PATCH /places/{placeId}
UpdatePlaceControllerApi	update_place_by_identifier	PATCH /places/identifier={placeIdentifier}
UpdatePlaceTypeControllerApi	update_place_type	PATCH /place-types/{placeTypeId}
UpdateRuleForControlRoomControllerApi	update_rule	PUT /controlrooms/{controlRoomId}/rules/{ruleId}
UpdateRuleTypeControllerApi	update_rule_type	PUT /rule-types/{ruleTypeId}
UpdateTaskControllerApi	update_task	PUT /tasks/{taskId}
UpdateTaskTypeControllerApi	update_task_type	PUT /task-types/{taskTypeId}
UpdateUserControllerApi	update_user	PUT /me
UpdateUserPreferenceControllerApi	update_user_preferences	POST /me/preferences
UserDetailsControllerApi	verify_user	GET /me

Documentation For Models

• Action
• AggregatedResponse
• AggregationParameterRequest
• ApiKeyResponse
• ApiKeysResponse
• AssetAttachments
• AssetAttachmentsResponse
• AssetCount
• AssetLocationResponse
• AssetMapViewResponse
• AssetMetricResponse
• AssetRequest
• AssetResponse
• AssetSearchRequest
• AssetSnapshotResponse
• AssetTableViewResponse
• AssetTypeRequest
• AssetTypeResponse
• AssetTypes
• Assets
• AssetsAggregationResponse
• AttachmentDto
• AttachmentResource
• AttachmentUpdate
• AttachmentsRequest
• AttachmentsRequestAttachmentsInner
• AuthorizePaymentMethodRequest
• BillingPlanResponse
• ChangeLog
• ClearControlRoomEventsRequest
• CollaboratorResponse
• CollaboratorsResponse
• ControlRoom
• ControlRoomAssetSettingsResponse
• ControlRoomCollaboratorRequest
• ControlRoomCollaboratorResponse
• ControlRoomCollaboratorsRequest
• ControlRoomConfigResponse
• ControlRoomEventChangesResponse
• ControlRoomEventResponse
• ControlRoomEventSearchRequest
• ControlRoomEventsResponse
• ControlRoomEventsSummaryResponse
• ControlRoomResponse
• ControlRoomRulesResponse
• ControlRoomTaskSearchRequest
• ControlRoomTasksResponse
• ControlRoomsResponse
• CopyAttachmentAction
• CreateAttachmentAction
• CreateControlRoomRequest
• CreateEventResponse
• CreateUserRequest
• Crs
• CycleAggregationParameterRequest
• CycleRequest
• CycleResponse
• CycleSearchRequest
• CycleSummaries
• CycleSummaryRequest
• CycleSummaryResponse
• CycleTypeRequest
• CycleTypeResponse
• CycleTypes
• Cycles
• CyclesCycles
• DateGrouping
• DateRange
• DeleteTaskRequest
• EmailChannel
• EntityResponse
• EventCreatedOptions
• EventDisplay
• EventPlace
• EventRequest
• EventResponse
• EventSearchRequest
• EventTypeCount
• EventTypeRequest
• EventTypeResponse
• EventTypes
• EventWarning
• Events
• ExcessChargePolicy
• ExecuteAssetsAggregationRequest
• ExecutePeriodAggregationRequest
• Execution
• Feature
• FeatureAllOfGeometry
• FeatureAllOfGeometry1
• FeatureCollection
• Filter
• FormAction
• FormRequest
• FormResponse
• FormResponseRequest
• FormResponseResponse
• FormResponsesResponse
• FormsResponse
• GeoJsonObject
• GeometryCollection
• GeometryCollectionAllOfGeometries
• Importance
• ImportanceCount
• InstallAppRequest
• InstalledAppResponse
• InstalledAppsResponse
• InviteUserRequest
• InviteUsersRequest
• InvoiceResponse
• InvoicesResponse
• LineString
• Link
• LinkedAssetResponse
• LinkedEntity
• LinkedPlaceResponse
• LngLatAlt
• LocationHistory
• MailingListSubscriptionRequest
• MailingListSubscriptionResponse
• MapRuleResponse
• MapTooltipResponse
• MapUpdateResponse
• MetricHistory
• ModelField
• ModelProperty
• MultiLineString
• MultiPoint
• MultiPolygon
• NotificationActionConfig
• NotificationActionConfigChannelsInner
• NotificationChannel
• NotificationRuleAction
• OrganizationResponse
• Pageable
• PaymentMethodResponse
• PaymentMethodsResponse
• PeriodAggregatedResponse
• PeriodAggregationResponse
• PlaceEnteredExitedOptions
• PlaceRequest
• PlaceResponse
• PlaceTypeRequest
• PlaceTypeResponse
• PlaceTypes
• Places
• PlanConstraint
• Point
• Polygon
• PushChannel
• QuickFilter
• QuickFilterEntry
• Range
• ReportUrlResponse
• RuleActionObjectObject
• RuleRequest
• RuleResponse
• RuleTypeRequest
• RuleTypeResponse
• RuleTypes
• RulesResponse
• RulesSearchRequest
• SearchAssetAttributeRequest
• SearchAssetAttributeResponse
• SmsChannel
• TaskAssetResponse
• TaskCreatedOptions
• TaskEventResponse
• TaskRequest
• TaskResponse
• TaskSearchRequest
• TaskTypeRequest
• TaskTypeResponse
• TaskTypes
• Tasks
• Tooltip
• UpdateAssetMapViewRequest
• UpdateAssetRequest
• UpdateAssetTableViewRequest
• UpdateAssetTypeRequest
• UpdateControlRoomAssetSettingsRequest
• UpdateControlRoomCollaboratorRequest
• UpdateControlRoomConfigRequest
• UpdateControlRoomRequest
• UpdateCycleRequest
• UpdateCycleTypeRequest
• UpdateEventRequest
• UpdateEventTypeRequest
• UpdateFormRequest
• UpdateInstalledAppRequest
• UpdateOrganizationRequest
• UpdatePlaceRequest
• UpdatePlaceTypeRequest
• UpdateRuleRequest
• UpdateRuleTypeRequest
• UpdateRuleTypeRequestOptions
• UpdateTaskRequest
• UpdateTaskTypeRequest
• UpdateUserDeviceRequest
• UpdateUserPreferencesRequest
• UpdateUserRequest
• UploadSignatureResponse
• UserDetailsResponse
• UserDeviceResponse
• UserDevicesResponse
• UserPreferenceResponse
• UserPreferencesResponse
• UserResponse
• UsersResponse
• Widget

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

apiKeyAuth

• Type: API key
• API key parameter name: X-Authorization
• Location: HTTP header

Author