Skip to content

NotifierV1alpha1ConsoleApi.md

Latest commit

 

History

History
253 lines (174 loc) · 7.71 KB

NotifierV1alpha1ConsoleApi.md

File metadata and controls

253 lines (174 loc) · 7.71 KB

halo_client.NotifierV1alpha1ConsoleApi

All URIs are relative to http://localhost:8091

Method HTTP request Description
fetch_sender_config GET /apis/api.console.halo.run/v1alpha1/notifiers/{name}/sender-config
save_sender_config POST /apis/api.console.halo.run/v1alpha1/notifiers/{name}/sender-config
verify_email_sender_config POST /apis/console.api.notification.halo.run/v1alpha1/notifiers/default-email-notifier/verify-connection

fetch_sender_config

object fetch_sender_config(name)

Fetch sender config of notifier

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.NotifierV1alpha1ConsoleApi(api_client)
    name = 'name_example' # str | Notifier name

    try:
        api_response = api_instance.fetch_sender_config(name)
        print("The response of NotifierV1alpha1ConsoleApi->fetch_sender_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotifierV1alpha1ConsoleApi->fetch_sender_config: %s\n" % e)

Parameters

Name Type Description Notes
name str Notifier name

Return type

object

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
0 default response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

save_sender_config

save_sender_config(name, body)

Save sender config of notifier

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.NotifierV1alpha1ConsoleApi(api_client)
    name = 'name_example' # str | Notifier name
    body = None # object | 

    try:
        api_instance.save_sender_config(name, body)
    except Exception as e:
        print("Exception when calling NotifierV1alpha1ConsoleApi->save_sender_config: %s\n" % e)

Parameters

Name Type Description Notes
name str Notifier name
body object

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
0 default response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verify_email_sender_config

verify_email_sender_config(email_config_validation_request)

Verify email sender config.

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.email_config_validation_request import EmailConfigValidationRequest
from halo_client.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.NotifierV1alpha1ConsoleApi(api_client)
    email_config_validation_request = halo_client.EmailConfigValidationRequest() # EmailConfigValidationRequest | 

    try:
        api_instance.verify_email_sender_config(email_config_validation_request)
    except Exception as e:
        print("Exception when calling NotifierV1alpha1ConsoleApi->verify_email_sender_config: %s\n" % e)

Parameters

Name Type Description Notes
email_config_validation_request EmailConfigValidationRequest

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
0 default response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]