labs-alert-manager-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

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 labs_alert_manager_client

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 labs_alert_manager_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import labs_alert_manager_client
from labs_alert_manager_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = labs_alert_manager_client.Configuration(
    host = "http://localhost"
)

# 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: auth_token
configuration.api_key['auth_token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['auth_token'] = 'Bearer'


# Enter a context with an instance of the API client
with labs_alert_manager_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = labs_alert_manager_client.ChannelsApi(api_client)
    id = 'id_example' # str | 

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ChannelsApi	delete_policy_channels_delete	DELETE /channels/{id}
ChannelsApi	get_policy_channels_get	GET /channels/{id}
ChannelsApi	get_policy_channels_get_all	GET /channels
ChannelsApi	post_policy_channels_post	POST /channels
ChannelsApi	post_policy_channels_test	POST /channels/test
ChannelsApi	put_policy_channels_put	PUT /channels/{id}
DocsApi	get_swagger_json	GET /docs/swagger.json
DocsApi	get_swagger_yml	GET /docs/swagger.yml
EventsApi	delete_events_parameters_delete	DELETE /events/parameters/{app_key}
EventsApi	get_events_get	GET /events/{id}
EventsApi	get_events_get_all	GET /events
EventsApi	get_events_parameters_get	GET /events/parameters
EventsApi	post_events_post	POST /events
HealthCheckApi	get_health_check	GET /health_check
NotificationsApi	get_notification_log_get	GET /notifications/{id}
NotificationsApi	get_notification_log_get_all	GET /notifications
NotificationsApi	post_notification_log_resend	POST /notifications/{id}/resend
PoliciesApi	delete_policies_delete	DELETE /policies/{id}
PoliciesApi	get_policies_get	GET /policies/{id}
PoliciesApi	get_policies_get_all	GET /policies
PoliciesApi	post_policies_post	POST /policies
PoliciesApi	put_policies_put	PUT /policies/{id}
WelcomeApi	get_welcome	GET /

Documentation For Models

• EventSchema
• NotificationSchema
• PaginationSchema
• PolicyChannelSchema
• PolicySchema

Documentation For Authorization

Authentication schemes defined for the API:

auth_token

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

Author