Metadata-Version: 2.4
Name: parlo_sdk
Version: 1.0.0
Summary: Official Parlo email API client for Python — send transactional email and manage sending domains.
Home-page: 
Author: Parlo
Author-email: Claris <hello@claris.agency>
License: MIT
Project-URL: Homepage, https://getparlo.io
Project-URL: Documentation, https://getparlo.io/docs
Keywords: parlo,email,transactional-email,api-client,sdk
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.6.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# parlo-sdk
The Parlo API sends transactional email and manages the sending domains it
authenticates from. Marketing campaigns (audiences, templates, broadcasts)
are designed and sent from the Parlo dashboard, not this API — the API is
transactional-only at launch.

All requests authenticate with a company API key as an HTTP bearer token:
`Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the
shape `{ \"message\": string, \"code\": string }`.


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.24.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://getparlo.io](https://getparlo.io)

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
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:
```python
import parlo_sdk
```

### 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 parlo_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import parlo_sdk
from parlo_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.getparlo.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = parlo_sdk.Configuration(
    host = "https://api.getparlo.io/v1"
)

# 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: bearerAuth
configuration = parlo_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with parlo_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = parlo_sdk.DomainsApi(api_client)
    create_domain_request = {"name":"yourdomain.com"} # CreateDomainRequest | 

    try:
        # Add a sending domain
        api_response = api_instance.create_domain(create_domain_request)
        print("The response of DomainsApi->create_domain:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DomainsApi->create_domain: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.getparlo.io/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DomainsApi* | [**create_domain**](docs/DomainsApi.md#create_domain) | **POST** /domains | Add a sending domain
*DomainsApi* | [**delete_domain**](docs/DomainsApi.md#delete_domain) | **DELETE** /domains/{id} | Remove a domain
*DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /domains/{id} | Retrieve a domain
*DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /domains | List sending domains
*DomainsApi* | [**verify_domain**](docs/DomainsApi.md#verify_domain) | **POST** /domains/{id}/verify | Re-check a domain&#39;s DNS
*EmailsApi* | [**get_email**](docs/EmailsApi.md#get_email) | **GET** /emails/{id} | Retrieve an email
*EmailsApi* | [**send_email**](docs/EmailsApi.md#send_email) | **POST** /emails | Send a transactional email


## Documentation For Models

 - [AuthHealth](docs/AuthHealth.md)
 - [AuthHealthDkim](docs/AuthHealthDkim.md)
 - [AuthHealthDmarc](docs/AuthHealthDmarc.md)
 - [AuthHealthSpf](docs/AuthHealthSpf.md)
 - [CreateDomainRequest](docs/CreateDomainRequest.md)
 - [DeleteDomain200Response](docs/DeleteDomain200Response.md)
 - [DnsRecord](docs/DnsRecord.md)
 - [Domain](docs/Domain.md)
 - [DomainSummary](docs/DomainSummary.md)
 - [Email](docs/Email.md)
 - [EmailCreated](docs/EmailCreated.md)
 - [Error](docs/Error.md)
 - [ListDomains200Response](docs/ListDomains200Response.md)
 - [SendEmailRequest](docs/SendEmailRequest.md)
 - [SendEmailRequestCc](docs/SendEmailRequestCc.md)
 - [SendEmailRequestTo](docs/SendEmailRequestTo.md)


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


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

- **Type**: Bearer authentication


## Author




