credoxa-notification-sdk

Canonical N17 HTTP contract for Credoxa Notification.

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

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

</code></pre>
<p>Then import the package:</p>
<pre><code class="language-python">import credoxa_notification

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 credoxa_notification

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import credoxa_notification
from credoxa_notification.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 = credoxa_notification.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 Bearer authorization (JWT): bearerAuth
configuration = credoxa_notification.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with credoxa_notification.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = credoxa_notification.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str |
    idempotency_key = 'idempotency_key_example' # str |
    request_body = None # Dict[str, object] |
    x_request_id = 'x_request_id_example' # str |  (optional)
    x_correlation_id = 'x_correlation_id_example' # str |  (optional)

    try:
        api_response = api_instance.cancel_campaign(campaign_id, idempotency_key, request_body, x_request_id=x_request_id, x_correlation_id=x_correlation_id)
        print("The response of CampaignsApi->cancel_campaign:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CampaignsApi->cancel_campaign: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• Campaign
• Delivery
• Error
• ErrorResponse
• Notification
• NotificationCreateRequest
• Preference
• PreferenceList
• PreferencePutRequest
• RecipientReference
• Template
• TemplateCreateRequest
• TemplateUpdateRequest
• TemplateVariable

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author