Metadata-Version: 2.4
Name: credoxa-notification-sdk
Version: 1.0.0
Summary: Credoxa Notification API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
License: NoLicense
Keywords: OpenAPI,OpenAPI-Generator,Credoxa Notification API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# credoxa-notification-sdk
Canonical N17 HTTP contract for Credoxa Notification.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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:

```sh
```

Then import the package:
```python
import credoxa_notification
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import credoxa_notification
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CampaignsApi* | [**cancel_campaign**](docs/CampaignsApi.md#cancel_campaign) | **POST** /api/v1/campaigns/{campaign_id}/cancel |
*CampaignsApi* | [**create_campaign**](docs/CampaignsApi.md#create_campaign) | **POST** /api/v1/campaigns |
*CampaignsApi* | [**get_campaign**](docs/CampaignsApi.md#get_campaign) | **GET** /api/v1/campaigns/{campaign_id} |
*CampaignsApi* | [**pause_campaign**](docs/CampaignsApi.md#pause_campaign) | **POST** /api/v1/campaigns/{campaign_id}/pause |
*CampaignsApi* | [**resume_campaign**](docs/CampaignsApi.md#resume_campaign) | **POST** /api/v1/campaigns/{campaign_id}/resume |
*DeliveriesApi* | [**get_delivery**](docs/DeliveriesApi.md#get_delivery) | **GET** /api/v1/deliveries/{delivery_id} |
*InternalCallbacksApi* | [**process_provider_callback**](docs/InternalCallbacksApi.md#process_provider_callback) | **POST** /internal/v1/provider-callbacks/{provider} |
*NotificationsApi* | [**cancel_notification**](docs/NotificationsApi.md#cancel_notification) | **POST** /api/v1/notifications/{notification_id}/cancel |
*NotificationsApi* | [**create_notification**](docs/NotificationsApi.md#create_notification) | **POST** /api/v1/notifications |
*NotificationsApi* | [**get_notification**](docs/NotificationsApi.md#get_notification) | **GET** /api/v1/notifications/{notification_id} |
*PreferencesApi* | [**list_preferences**](docs/PreferencesApi.md#list_preferences) | **GET** /api/v1/preferences |
*PreferencesApi* | [**put_preference**](docs/PreferencesApi.md#put_preference) | **PUT** /api/v1/preferences |
*TemplatesApi* | [**create_template**](docs/TemplatesApi.md#create_template) | **POST** /api/v1/templates |
*TemplatesApi* | [**get_template**](docs/TemplatesApi.md#get_template) | **GET** /api/v1/templates/{template_id} |
*TemplatesApi* | [**update_template**](docs/TemplatesApi.md#update_template) | **PUT** /api/v1/templates/{template_id} |


## Documentation For Models

 - [Campaign](docs/Campaign.md)
 - [Delivery](docs/Delivery.md)
 - [Error](docs/Error.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [Notification](docs/Notification.md)
 - [NotificationCreateRequest](docs/NotificationCreateRequest.md)
 - [Preference](docs/Preference.md)
 - [PreferenceList](docs/PreferenceList.md)
 - [PreferencePutRequest](docs/PreferencePutRequest.md)
 - [RecipientReference](docs/RecipientReference.md)
 - [Template](docs/Template.md)
 - [TemplateCreateRequest](docs/TemplateCreateRequest.md)
 - [TemplateUpdateRequest](docs/TemplateUpdateRequest.md)
 - [TemplateVariable](docs/TemplateVariable.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)


## Author
