skyledge-sdk 1.0.20

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.3
• Package version: 1.0.20
• 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://api-server:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = skyledge_sdk.Configuration(
    host = "http://api-server: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.ApiKeysApi(api_client)
    secret = 'secret_example' # str |  (optional)

    try:
        api_response = api_instance.list_api_keys(secret=secret)
        print("The response of ApiKeysApi->list_api_keys:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiKeysApi->list_api_keys: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://api-server:8080

Class	Method	HTTP request	Description
ApiKeysApi	list_api_keys	GET /api-key
AppsApi	install_app_to_control_room	POST /controlrooms/{controlRoomId}/apps
AppsApi	list_installed_apps_for_control_room	GET /controlrooms/{controlRoomId}/apps/{appInstanceId}
AppsApi	list_installed_apps_for_control_room1	GET /controlrooms/{controlRoomId}/apps
AppsApi	uninstall_control_room_app	DELETE /controlrooms/{controlRoomId}/apps/{appInstanceId}
AppsApi	update_control_room_app	PUT /controlrooms/{controlRoomId}/apps/{appInstanceId}
AppsApi	update_control_room_app1	PATCH /controlrooms/{controlRoomId}/apps/{appInstanceId}
AssetTypesApi	assign_asset_type_to_control_room	PUT /controlrooms/{controlRoomId}/asset-types/{assetTypeId}
AssetTypesApi	create_asset_type	POST /asset-types
AssetTypesApi	get_asset_map_view	GET /asset-types/{assetTypeId}/views/map
AssetTypesApi	get_asset_settings	GET /controlrooms/{controlRoomId}/asset-types/{assetTypeId}
AssetTypesApi	get_asset_table_view	GET /asset-types/{assetTypeId}/views/table
AssetTypesApi	get_asset_type	GET /asset-types/{assetTypeId}
AssetTypesApi	list_asset_types	GET /asset-types
AssetTypesApi	list_asset_types_for_control_room	GET /controlrooms/{controlRoomId}/asset-types
AssetTypesApi	update_asset_map_view	PUT /asset-types/{assetTypeId}/views/map
AssetTypesApi	update_asset_table_view	PUT /asset-types/{assetTypeId}/views/table
AssetTypesApi	update_asset_type	PUT /asset-types/{assetTypeId}
AssetsApi	create_asset	POST /asset-types/{assetTypeId}/assets
AssetsApi	create_asset_by_identifier	POST /asset-types/identifier={assetTypeIdentifier}/assets
AssetsApi	execute_aggregation	POST /asset-types/{assetTypeIdentifier}/assets/aggregation
AssetsApi	execute_aggregation_by_id	POST /assets/{assetId}/aggregation
AssetsApi	execute_aggregation_by_identifier	POST /assets/identifier={assetIdentifier}/aggregation
AssetsApi	get_asset_using_asset_id	GET /assets/{assetId}
AssetsApi	get_asset_using_asset_identifier	GET /assets/identifier={assetIdentifier}
AssetsApi	list_asset_attribute_values_by_attribute_name	POST /assets/attributes/{attribute}
AssetsApi	list_asset_for_control_room	GET /controlrooms/{controlRoomId}/assets
AssetsApi	list_assets	GET /assets
AssetsApi	retrieve_asset_snapshot	GET /assets/{assetId}/snapshot/{queryDateTime}
AssetsApi	retrieve_location_history_for_asset	GET /assets/{assetId}/location
AssetsApi	retrieve_location_history_for_asset1	GET /assets/identifier={assetIdentifier}/location
AssetsApi	retrieve_metrics_for_asset	GET /assets/{assetId}/metrics/{metricName}
AssetsApi	retrieve_metrics_for_asset1	GET /assets/identifier={assetIdentifier}/metrics/{metricName}
AssetsApi	search_assets	POST /assets/search
AssetsApi	update_asset_by_id	PATCH /assets/{assetId}
AssetsApi	update_asset_by_identifier	PATCH /assets/identifier={assetIdentifier}
AssetsApi	update_location_history	PUT /assets/{assetId}/location
AssetsApi	upsert_metric_history	PUT /assets/{assetId}/metrics/{metricName}
AttachmentsApi	add_asset_attachments	POST /assets/{assetId}/attachments
AttachmentsApi	add_form_response_attachments	POST /forms/{formId}/responses/{formResponseId}/attachments
AttachmentsApi	add_form_response_attachments_with_identifier	POST /forms/identifier={formIdentifier}/responses/{formResponseId}/attachments
AttachmentsApi	create_form_response_upload_signature	POST /forms/{formId}/responses/{formResponseId}/attachments/upload-signature
AttachmentsApi	create_form_response_upload_signature_with_identifier	POST /forms/identifier={formIdentifier}/responses/{formResponseId}/attachments/upload-signature
AttachmentsApi	create_upload_signature	POST /assets/{assetId}/attachments/upload-signature
AttachmentsApi	delete_asset_attachment	DELETE /assets/{assetId}/attachments/{attachmentId}
AttachmentsApi	delete_form_response_attachment	DELETE /forms/{formId}/responses/{formResponseId}/attachments/{attachmentId}
AttachmentsApi	get_asset_attachment	GET /assets/{assetId}/attachments/{attachmentId}
AttachmentsApi	get_asset_attachments	GET /assets/{assetId}/attachments
AttachmentsApi	get_form_response_attachment	GET /forms/{formId}/responses/{formResponseId}/attachments/{attachmentId}
AttachmentsApi	get_form_response_attachment_with_identifier	GET /forms/identifier={formIdentifier}/responses/{formResponseId}/attachments/{attachmentId}
AttachmentsApi	get_form_response_attachments	GET /forms/{formId}/responses/{formResponseId}/attachments
AttachmentsApi	get_form_response_attachments_with_identifier	GET /forms/identifier={formIdentifier}/responses/{formResponseId}/attachments
AttachmentsApi	update_asset_attachments	PATCH /assets/{assetId}/attachments/{attachmentId}
BillingApi	authorize_payment_method	POST /billing/payment-methods
BillingApi	get_billing_plan	GET /billing/plan
BillingApi	get_invoices	GET /billing/invoices
BillingApi	get_payment_method	GET /billing/payment-methods
CollaboratorsApi	invite_collaborators	POST /controlrooms/{controlRoomId}/invite
CollaboratorsApi	list_collaborators	GET /controlrooms/{controlRoomId}/collaborators
CollaboratorsApi	update_control_room_collaborator	PUT /controlrooms/{controlRoomId}/collaborators/{userId}
ControlRoomsApi	create_control_rooms	POST /controlrooms
ControlRoomsApi	delete_control_room	DELETE /controlrooms/{controlRoomId}
ControlRoomsApi	get_control_room	GET /controlrooms/{controlRoomId}
ControlRoomsApi	get_report_url	GET /controlrooms/{controlRoomId}/report-url
ControlRoomsApi	list_control_rooms	GET /controlrooms
ControlRoomsApi	retrieve_configuration	GET /controlrooms/{controlRoomId}/config
ControlRoomsApi	update_configuration	PATCH /controlrooms/{controlRoomId}/config
ControlRoomsApi	update_control_room	PUT /controlrooms/{controlRoomId}
CycleTypesApi	create_cycle_type	POST /cycle-types
CycleTypesApi	get_cycle_type	GET /cycle-types/{cycleTypeId}
CycleTypesApi	list_cycle_types	GET /cycle-types
CycleTypesApi	update_cycle_type	PATCH /cycle-types/{cycleTypeId}
CyclesApi	create_cycle	POST /cycle-types/{cycleTypeId}/cycles
CyclesApi	create_cycle_by_identifier	POST /cycle-types/identifier={cycleTypeIdentifier}/cycles
CyclesApi	cycle_summary	POST /cycles/summary
CyclesApi	delete_cycle_by_id	DELETE /cycles/{cycleId}
CyclesApi	get_cycle_by_cycle_id	GET /cycles/{cycleId}
CyclesApi	list_cycles	GET /cycles
CyclesApi	search_cycles	POST /cycles/search
CyclesApi	update_cycle_by_id	PATCH /cycles/{cycleId}
ErrorsApi	error	GET /error
ErrorsApi	error1	POST /error
ErrorsApi	error2	PUT /error
ErrorsApi	error3	DELETE /error
ErrorsApi	error4	PATCH /error
ErrorsApi	error5	HEAD /error
ErrorsApi	error6	OPTIONS /error
EventTypesApi	create_event_type	POST /event-types
EventTypesApi	get_event_type	GET /event-types/{eventTypeId}
EventTypesApi	list_event_types	GET /event-types
EventTypesApi	list_event_types_for_control_room	GET /controlrooms/{id}/event-types
EventTypesApi	update_event_type	PUT /event-types/{eventTypeId}
EventsApi	clear_events	POST /controlrooms/{controlRoomId}/events/clear
EventsApi	create_event	POST /event-types/{eventTypeId}/events
EventsApi	create_event_by_identifier	POST /event-types/identifier={eventTypeIdentifier}/events
EventsApi	get_control_room_event_summary	GET /controlrooms/{controlRoomId}/events/summary
EventsApi	get_event	GET /events/{eventId}
EventsApi	list_control_room_event_changes	GET /controlrooms/{controlRoomId}/events/changes
EventsApi	list_control_room_events	GET /controlrooms/{controlRoomId}/events
EventsApi	retrieve_latest100_active_events	GET /assets/{assetId}/events/active
EventsApi	search_events	POST /events/search
EventsApi	search_events_within_control_room	POST /controlrooms/{controlRoomId}/events/search
EventsApi	update_event	PATCH /events/{eventId}
FormApi	create_form_response	POST /forms/{formId}/responses
FormApi	create_form_response_by_identifier	POST /forms/identifier={formIdentifier}/responses
FormsApi	create_form	POST /forms
FormsApi	get_form_using_form_id	GET /forms/{formId}
FormsApi	get_form_using_form_id1	GET /forms/{formId}/responses/{formResponseId}
FormsApi	get_form_using_form_identifier	GET /forms/identifier={formIdentifier}
FormsApi	get_form_using_form_identifier1	GET /forms/identifier={formIdentifier}/responses/{formResponseId}
FormsApi	get_responses_using_form_id	GET /forms/{formId}/responses
FormsApi	get_responses_using_form_identifier	GET /forms/identifier={formIdentifier}/responses
FormsApi	list_forms	GET /forms
FormsApi	update_form_response	PUT /forms/{formId}/responses/{formResponseId}
FormsApi	update_form_response_with_identifier	PUT /forms/identifier={formIdentifier}/responses/{formResponseId}
FormsApi	update_form_using_id	PUT /forms/{formId}
FormsApi	update_form_using_identifier	PUT /forms/identifier={formIdentifier}
OrganizationApi	update_organization	PUT /organization
PlaceTypesApi	assign_place_type_to_controlroom	PUT /controlrooms/{controlRoomId}/place-types/{placeTypeId}
PlaceTypesApi	create_place_type	POST /place-types
PlaceTypesApi	get_place_type	GET /place-types/{placeTypeId}
PlaceTypesApi	list_place_types	GET /place-types
PlaceTypesApi	list_place_types_for_control_room	GET /controlrooms/{controlRoomId}/place-types
PlaceTypesApi	update_place_type	PATCH /place-types/{placeTypeId}
PlacesApi	create_place	POST /place-types/{placeTypeId}/places
PlacesApi	create_place_by_identifier	POST /place-types/identifier={placeTypeIdentifier}/places
PlacesApi	delete_place_by_id	DELETE /places/{placeId}
PlacesApi	delete_place_by_identifier	DELETE /places/identifier={placeIdentifier}
PlacesApi	get_place_using_place_id	GET /places/{placeId}
PlacesApi	get_place_using_place_identifier	GET /places/identifier={placeIdentifier}
PlacesApi	list_places	GET /places
PlacesApi	list_places_for_control_room	GET /controlrooms/{controlRoomId}/places
PlacesApi	update_place_by_id	PATCH /places/{placeId}
PlacesApi	update_place_by_identifier	PATCH /places/identifier={placeIdentifier}
RuleTypesApi	create_rule_type	POST /rule-types
RuleTypesApi	get_rule_type	GET /rule-types/{ruleTypeId}
RuleTypesApi	list_rule_types	GET /rule-types
RuleTypesApi	update_rule_type	PUT /rule-types/{ruleTypeId}
RulesApi	create_rule	POST /controlrooms/{controlRoomId}/rule-types/{ruleTypeId}/rules
RulesApi	create_rule_by_identifier	POST /controlrooms/{controlRoomId}/rule-types/identifier={ruleTypeIdentifier}/rules
RulesApi	delete_rule	DELETE /rules/{ruleId}
RulesApi	get_rule	GET /rules/{ruleId}
RulesApi	list_rules	GET /rule-types/{ruleTypeId}/rules
RulesApi	search_rules_within_control_room	POST /controlrooms/{controlRoomId}/rules/search
RulesApi	update_rule	PUT /controlrooms/{controlRoomId}/rules/{ruleId}
TaskTypesApi	create_task_type	POST /task-types
TaskTypesApi	get_task_type	GET /task-types/{taskTypeId}
TaskTypesApi	list_task_types	GET /task-types
TaskTypesApi	update_task_type	PUT /task-types/{taskTypeId}
TasksApi	create_task	POST /task-types/{taskTypeId}/tasks
TasksApi	delete_task	DELETE /tasks/{taskId}
TasksApi	get_task	GET /tasks/{taskId}
TasksApi	list_tasks	GET /task-types/{taskTypeId}/tasks
TasksApi	search_tasks	POST /tasks/search
TasksApi	search_tasks_within_control_room	POST /tasks/{controlRoomId}/search
TasksApi	update_task	PUT /tasks/{taskId}
UsersApi	create_users	POST /users
UsersApi	invite_users	POST /users/invite
UsersApi	list_users	GET /users
UsersApi	retrieve_user_devices	GET /me/devices
UsersApi	retrieve_user_preferences	GET /me/preferences
UsersApi	subscribe_to_mailing_list	POST /me/mailing-list
UsersApi	unsubscribe_from_mailing_list	DELETE /me/mailing-list/{listName}
UsersApi	update_user	PUT /users/{userId}
UsersApi	update_user1	PUT /me
UsersApi	update_user_device	PUT /me/devices
UsersApi	update_user_preferences	POST /me/preferences
UsersApi	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
• AttachmentResource
• AttachmentResponse
• AttachmentUpdate
• AttachmentsRequest
• AttachmentsRequestAttachmentsInner
• AuthorizePaymentMethodRequest
• BillingPlanResponse
• ChangeLog
• ClearControlRoomEventsRequest
• CollaboratorResponse
• CollaboratorsResponse
• ControlRoom
• ControlRoomAssetSettingsResponse
• ControlRoomCollaboratorRequest
• ControlRoomCollaboratorResponse
• ControlRoomCollaboratorsRequest
• ControlRoomConfigResponse
• ControlRoomEventChangeResponse
• ControlRoomEventChangesResponse
• ControlRoomEventResponse
• ControlRoomEventSearchRequest
• ControlRoomEventsResponse
• ControlRoomEventsSummaryResponse
• ControlRoomResponse
• ControlRoomRulesResponse
• ControlRoomTaskSearchRequest
• ControlRoomTasksResponse
• ControlRoomsResponse
• CopyAttachmentAction
• CreateAttachmentAction
• CreateControlRoomRequest
• CreateEventResponse
• CreateUserRequest
• CycleAggregationParameterRequest
• CycleRequest
• CycleResponse
• CycleSearchRequest
• CycleSummaries
• CycleSummaryRequest
• CycleSummaryResponse
• CycleTypeDisplaySettingsDto
• CycleTypeEndpointsDto
• CycleTypeMetricTooltipDto
• CycleTypeMetricTooltipItemDto
• CycleTypeMetricsDto
• CycleTypeRequest
• CycleTypeResponse
• CycleTypes
• Cycles
• DateGrouping
• DateRange
• DeleteTaskRequest
• EmailChannel
• EntityResponse
• EventCreatedOptions
• EventDisplay
• EventPlace
• EventRequest
• EventResponse
• EventSearchRequest
• EventTypeCount
• EventTypeRequest
• EventTypeResponse
• EventTypes
• EventWarning
• Events
• ExcessChargePolicy
• ExecuteAssetsAggregationRequest
• ExecutePeriodAggregationRequest
• Execution
• Filter
• FormAction
• FormRequest
• FormResourceHeaderRequest
• FormResourceHeaderResponse
• FormResourceRequest
• FormResourceResponse
• FormResponse
• FormResponseRequest
• FormResponseResponse
• FormResponsesResponse
• FormShortResponse
• FormsResponse
• Importance
• ImportanceCount
• InstallAppRequest
• InstalledAppResponse
• InstalledAppsResponse
• InviteUserRequest
• InviteUsersRequest
• InvoiceResponse
• InvoicesResponse
• JsonNode
• Link
• LinkedAssetResponse
• LinkedPlaceResponse
• LocationHistory
• MailingListSubscriptionRequest
• MailingListSubscriptionResponse
• MapRuleResponse
• MapTooltipResponse
• MapUpdateResponse
• MetricHistory
• MetricHistoryEntry
• MetricLocationEntry
• ModelField
• ModelProperty
• NotificationActionConfig
• NotificationActionConfigChannelsInner
• NotificationChannel
• NotificationRuleAction
• OrganizationResponse
• Pageable
• PaymentMethodResponse
• PaymentMethodsResponse
• PeriodAggregatedResponse
• PeriodAggregationResponse
• PlaceEnteredExitedOptions
• PlaceRequest
• PlaceResponse
• PlaceTypeRequest
• PlaceTypeResponse
• PlaceTypes
• Places
• PlanConstraint
• 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
• TriggeredBy
• UpdateAssetLocationRequest
• UpdateAssetLocationSummaryResponse
• UpdateAssetMapViewRequest
• UpdateAssetMetricsRequest
• UpdateAssetMetricsSummaryResponse
• UpdateAssetRequest
• UpdateAssetTableViewRequest
• UpdateAssetTypeRequest
• UpdateControlRoomAssetSettingsRequest
• UpdateControlRoomCollaboratorRequest
• UpdateControlRoomConfigRequest
• UpdateControlRoomRequest
• UpdateCycleRequest
• UpdateCycleTypeRequest
• UpdateEventRequest
• UpdateEventTypeRequest
• UpdateFormRequest
• UpdateFormResponseRequest
• UpdateInstalledAppRequest
• UpdateOrganizationRequest
• UpdatePlaceRequest
• UpdatePlaceTypeRequest
• UpdatePlatformUserRequest
• 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