Metadata-Version: 2.4
Name: rebelsender
Version: 0.2.0
Summary: RebelSender API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,RebelSender 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

# rebelsender
High-velocity email infrastructure for builders.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.1.0
- Generator version: 7.20.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
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 rebelsender
```

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

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import rebelsender
from rebelsender.rest import ApiException
from pprint import pprint

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

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


# Enter a context with an instance of the API client
with rebelsender.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rebelsender.APIKeysApi(api_client)
    create_api_key_request = rebelsender.CreateApiKeyRequest() # CreateApiKeyRequest | 

    try:
        # Create API key
        api_response = api_instance.create_api_key(create_api_key_request)
        print("The response of APIKeysApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->create_api_key: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.rebelsender.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**create_api_key**](docs/APIKeysApi.md#create_api_key) | **POST** /api/v1/api-keys | Create API key
*APIKeysApi* | [**list_api_keys**](docs/APIKeysApi.md#list_api_keys) | **GET** /api/v1/api-keys | List API keys
*APIKeysApi* | [**revoke_api_key**](docs/APIKeysApi.md#revoke_api_key) | **DELETE** /api/v1/api-keys/{id} | Revoke API key
*AdminApi* | [**admin_get_dashboard**](docs/AdminApi.md#admin_get_dashboard) | **GET** /api/v1/admin/dashboard | System dashboard stats
*AdminApi* | [**admin_get_provider_health**](docs/AdminApi.md#admin_get_provider_health) | **GET** /api/v1/admin/providers | Provider health stats
*AdminApi* | [**admin_list_audit_logs**](docs/AdminApi.md#admin_list_audit_logs) | **GET** /api/v1/admin/logs | Audit logs
*AdminApi* | [**admin_list_domains**](docs/AdminApi.md#admin_list_domains) | **GET** /api/v1/admin/domains | List all domains
*AdminApi* | [**admin_list_organizations**](docs/AdminApi.md#admin_list_organizations) | **GET** /api/v1/admin/organizations | List all organizations
*AdminApi* | [**admin_list_users**](docs/AdminApi.md#admin_list_users) | **GET** /api/v1/admin/users | List all users
*AdminApi* | [**admin_update_org_subscription**](docs/AdminApi.md#admin_update_org_subscription) | **PUT** /api/v1/admin/organizations/{id}/subscription | Update org subscription (admin override)
*AdminApi* | [**admin_update_plan_limits**](docs/AdminApi.md#admin_update_plan_limits) | **PUT** /api/v1/admin/plans | Update plan limits
*AdminApi* | [**admin_update_user**](docs/AdminApi.md#admin_update_user) | **PUT** /api/v1/admin/users/{id} | Update user (admin)
*AnalyticsApi* | [**get_analytics_by_domain**](docs/AnalyticsApi.md#get_analytics_by_domain) | **GET** /api/v1/analytics/domains | Stats by domain
*AnalyticsApi* | [**get_analytics_by_tag**](docs/AnalyticsApi.md#get_analytics_by_tag) | **GET** /api/v1/analytics/tags | Stats by tag
*AnalyticsApi* | [**get_analytics_overview**](docs/AnalyticsApi.md#get_analytics_overview) | **GET** /api/v1/analytics/overview | Get overview stats
*AnalyticsApi* | [**get_analytics_timeseries**](docs/AnalyticsApi.md#get_analytics_timeseries) | **GET** /api/v1/analytics/timeseries | Get daily stats
*AuthApi* | [**forgot_password**](docs/AuthApi.md#forgot_password) | **POST** /api/v1/auth/forgot-password | Request a password reset email
*AuthApi* | [**get_current_user**](docs/AuthApi.md#get_current_user) | **GET** /api/v1/auth/me | Get current user profile
*AuthApi* | [**login_user**](docs/AuthApi.md#login_user) | **POST** /api/v1/auth/login | Login with email and password
*AuthApi* | [**refresh_token**](docs/AuthApi.md#refresh_token) | **POST** /api/v1/auth/refresh | Refresh access token
*AuthApi* | [**register_user**](docs/AuthApi.md#register_user) | **POST** /api/v1/auth/register | Register a new user and organization
*AuthApi* | [**reset_password**](docs/AuthApi.md#reset_password) | **POST** /api/v1/auth/reset-password | Reset password with token
*BillingApi* | [**create_checkout_session**](docs/BillingApi.md#create_checkout_session) | **POST** /api/v1/billing/subscribe | Subscribe to a plan (creates Stripe checkout)
*BillingApi* | [**get_billing_portal**](docs/BillingApi.md#get_billing_portal) | **POST** /api/v1/billing/portal | Create Stripe billing portal session
*BillingApi* | [**get_billing_usage**](docs/BillingApi.md#get_billing_usage) | **GET** /api/v1/billing/usage | Get current email usage
*BillingApi* | [**get_current_plan**](docs/BillingApi.md#get_current_plan) | **GET** /api/v1/billing/plan | Get current subscription plan
*BillingApi* | [**handle_stripe_webhook**](docs/BillingApi.md#handle_stripe_webhook) | **POST** /api/v1/billing/stripe-webhook | Stripe webhook handler
*DomainsApi* | [**create_domain**](docs/DomainsApi.md#create_domain) | **POST** /api/v1/domains | Create a domain
*DomainsApi* | [**create_sender**](docs/DomainsApi.md#create_sender) | **POST** /api/v1/domains/{id}/senders | Create sender
*DomainsApi* | [**delete_domain**](docs/DomainsApi.md#delete_domain) | **DELETE** /api/v1/domains/{id} | Delete a domain
*DomainsApi* | [**delete_sender**](docs/DomainsApi.md#delete_sender) | **DELETE** /api/v1/domains/{id}/senders/{senderId} | Delete sender
*DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /api/v1/domains/{id} | Get domain details
*DomainsApi* | [**get_domain_connect_url**](docs/DomainsApi.md#get_domain_connect_url) | **GET** /api/v1/domains/{id}/connect | Get Domain Connect URL
*DomainsApi* | [**get_domain_warmup**](docs/DomainsApi.md#get_domain_warmup) | **GET** /api/v1/domains/{id}/warmup | Get warmup status
*DomainsApi* | [**list_domain_senders**](docs/DomainsApi.md#list_domain_senders) | **GET** /api/v1/domains/{id}/senders | List domain senders
*DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /api/v1/domains | List domains
*DomainsApi* | [**list_senders**](docs/DomainsApi.md#list_senders) | **GET** /api/v1/senders | List all senders
*DomainsApi* | [**relink_domain**](docs/DomainsApi.md#relink_domain) | **POST** /api/v1/domains/{id}/relink | Relink domain to provider
*DomainsApi* | [**start_domain_warmup**](docs/DomainsApi.md#start_domain_warmup) | **POST** /api/v1/domains/{id}/warmup | Start warmup
*DomainsApi* | [**stop_domain_warmup**](docs/DomainsApi.md#stop_domain_warmup) | **DELETE** /api/v1/domains/{id}/warmup | Stop warmup
*DomainsApi* | [**update_domain_warmup**](docs/DomainsApi.md#update_domain_warmup) | **PUT** /api/v1/domains/{id}/warmup | Update warmup
*DomainsApi* | [**verify_domain**](docs/DomainsApi.md#verify_domain) | **POST** /api/v1/domains/{id}/verify | Verify domain DNS
*EmailsApi* | [**cancel_email**](docs/EmailsApi.md#cancel_email) | **DELETE** /api/v1/emails/{id} | Cancel a scheduled email
*EmailsApi* | [**get_email**](docs/EmailsApi.md#get_email) | **GET** /api/v1/emails/{id} | Get email details
*EmailsApi* | [**list_emails**](docs/EmailsApi.md#list_emails) | **GET** /api/v1/emails | List emails
*EmailsApi* | [**send_batch_emails**](docs/EmailsApi.md#send_batch_emails) | **POST** /api/v1/emails/batch | Send a batch of emails
*EmailsApi* | [**send_email**](docs/EmailsApi.md#send_email) | **POST** /api/v1/emails | Send an email
*InboundWebhooksApi* | [**handle_azure_callback**](docs/InboundWebhooksApi.md#handle_azure_callback) | **POST** /api/v1/inbound/azure | Azure Communication Services callback
*InboundWebhooksApi* | [**handle_ses_notification**](docs/InboundWebhooksApi.md#handle_ses_notification) | **POST** /api/v1/inbound/ses | AWS SES notification handler (SNS)
*OrganizationsApi* | [**create_org**](docs/OrganizationsApi.md#create_org) | **POST** /api/v1/orgs | Create organization
*OrganizationsApi* | [**get_org**](docs/OrganizationsApi.md#get_org) | **GET** /api/v1/orgs/{id} | Get organization details
*OrganizationsApi* | [**invite_org_member**](docs/OrganizationsApi.md#invite_org_member) | **POST** /api/v1/orgs/{id}/members | Invite or add member
*OrganizationsApi* | [**remove_org_member**](docs/OrganizationsApi.md#remove_org_member) | **DELETE** /api/v1/orgs/{id}/members/{userId} | Remove member
*OrganizationsApi* | [**update_org**](docs/OrganizationsApi.md#update_org) | **PUT** /api/v1/orgs/{id} | Update organization
*SuppressionsApi* | [**add_bulk_suppressions**](docs/SuppressionsApi.md#add_bulk_suppressions) | **POST** /api/v1/suppressions/bulk | Bulk add suppressions
*SuppressionsApi* | [**add_suppression**](docs/SuppressionsApi.md#add_suppression) | **POST** /api/v1/suppressions | Add suppression
*SuppressionsApi* | [**check_suppression**](docs/SuppressionsApi.md#check_suppression) | **GET** /api/v1/suppressions/check | Check if email is suppressed
*SuppressionsApi* | [**list_suppressions**](docs/SuppressionsApi.md#list_suppressions) | **GET** /api/v1/suppressions | List suppressions
*SuppressionsApi* | [**remove_suppression**](docs/SuppressionsApi.md#remove_suppression) | **DELETE** /api/v1/suppressions/{email} | Remove suppression
*TemplatesApi* | [**create_template**](docs/TemplatesApi.md#create_template) | **POST** /api/v1/templates | Create a template
*TemplatesApi* | [**delete_template**](docs/TemplatesApi.md#delete_template) | **DELETE** /api/v1/templates/{id} | Delete a template
*TemplatesApi* | [**get_template**](docs/TemplatesApi.md#get_template) | **GET** /api/v1/templates/{id} | Get a template
*TemplatesApi* | [**list_templates**](docs/TemplatesApi.md#list_templates) | **GET** /api/v1/templates | List templates
*TemplatesApi* | [**update_template**](docs/TemplatesApi.md#update_template) | **PUT** /api/v1/templates/{id} | Update a template
*TrackingApi* | [**get_unsubscribe_page**](docs/TrackingApi.md#get_unsubscribe_page) | **GET** /t/u/{emailId} | Unsubscribe confirmation page
*TrackingApi* | [**handle_one_click_unsubscribe**](docs/TrackingApi.md#handle_one_click_unsubscribe) | **POST** /t/u/{emailId} | One-click unsubscribe (RFC 8058)
*TrackingApi* | [**track_click**](docs/TrackingApi.md#track_click) | **GET** /t/c/{emailId} | Click tracking redirect
*TrackingApi* | [**track_open_pixel**](docs/TrackingApi.md#track_open_pixel) | **GET** /t/o/{emailId} | Open tracking pixel
*WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /api/v1/webhooks | Create a webhook endpoint
*WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /api/v1/webhooks/{id} | Delete a webhook endpoint
*WebhooksApi* | [**get_webhook_logs**](docs/WebhooksApi.md#get_webhook_logs) | **GET** /api/v1/webhooks/{id}/logs | Get webhook delivery logs
*WebhooksApi* | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /api/v1/webhooks | List webhook endpoints
*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /api/v1/webhooks/{id} | Update a webhook endpoint
*DefaultApi* | [**health_get**](docs/DefaultApi.md#health_get) | **GET** /health | 


## Documentation For Models

 - [AddBulkSuppressions201Response](docs/AddBulkSuppressions201Response.md)
 - [AddBulkSuppressionsRequest](docs/AddBulkSuppressionsRequest.md)
 - [AddSuppressionRequest](docs/AddSuppressionRequest.md)
 - [AdminUpdateOrgSubscriptionRequest](docs/AdminUpdateOrgSubscriptionRequest.md)
 - [AdminUpdatePlanLimitsRequest](docs/AdminUpdatePlanLimitsRequest.md)
 - [AdminUpdateUserRequest](docs/AdminUpdateUserRequest.md)
 - [CancelEmail200Response](docs/CancelEmail200Response.md)
 - [CheckSuppression200Response](docs/CheckSuppression200Response.md)
 - [CreateApiKey201Response](docs/CreateApiKey201Response.md)
 - [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
 - [CreateCheckoutSession200Response](docs/CreateCheckoutSession200Response.md)
 - [CreateCheckoutSession200ResponseData](docs/CreateCheckoutSession200ResponseData.md)
 - [CreateCheckoutSessionRequest](docs/CreateCheckoutSessionRequest.md)
 - [CreateDomain201Response](docs/CreateDomain201Response.md)
 - [CreateDomainRequest](docs/CreateDomainRequest.md)
 - [CreateOrg201Response](docs/CreateOrg201Response.md)
 - [CreateOrg201ResponseData](docs/CreateOrg201ResponseData.md)
 - [CreateOrgRequest](docs/CreateOrgRequest.md)
 - [CreateSender201Response](docs/CreateSender201Response.md)
 - [CreateSenderRequest](docs/CreateSenderRequest.md)
 - [CreateTemplate201Response](docs/CreateTemplate201Response.md)
 - [CreateTemplateRequest](docs/CreateTemplateRequest.md)
 - [CreateWebhook201Response](docs/CreateWebhook201Response.md)
 - [CreateWebhook201ResponseData](docs/CreateWebhook201ResponseData.md)
 - [CreateWebhookRequest](docs/CreateWebhookRequest.md)
 - [ForgotPassword200Response](docs/ForgotPassword200Response.md)
 - [ForgotPasswordRequest](docs/ForgotPasswordRequest.md)
 - [GetAnalyticsByDomain200Response](docs/GetAnalyticsByDomain200Response.md)
 - [GetAnalyticsByDomain200ResponseDataInner](docs/GetAnalyticsByDomain200ResponseDataInner.md)
 - [GetAnalyticsByTag200Response](docs/GetAnalyticsByTag200Response.md)
 - [GetAnalyticsByTag200ResponseDataInner](docs/GetAnalyticsByTag200ResponseDataInner.md)
 - [GetAnalyticsOverview200Response](docs/GetAnalyticsOverview200Response.md)
 - [GetAnalyticsOverview200ResponseData](docs/GetAnalyticsOverview200ResponseData.md)
 - [GetAnalyticsOverview200ResponseDataPeriod](docs/GetAnalyticsOverview200ResponseDataPeriod.md)
 - [GetAnalyticsTimeseries200Response](docs/GetAnalyticsTimeseries200Response.md)
 - [GetAnalyticsTimeseries200ResponseDataInner](docs/GetAnalyticsTimeseries200ResponseDataInner.md)
 - [GetBillingUsage200Response](docs/GetBillingUsage200Response.md)
 - [GetBillingUsage200ResponseData](docs/GetBillingUsage200ResponseData.md)
 - [GetCurrentPlan200Response](docs/GetCurrentPlan200Response.md)
 - [GetCurrentUser200Response](docs/GetCurrentUser200Response.md)
 - [GetCurrentUser200ResponseUser](docs/GetCurrentUser200ResponseUser.md)
 - [GetDomain200Response](docs/GetDomain200Response.md)
 - [GetDomain200ResponseDnsRecordsInner](docs/GetDomain200ResponseDnsRecordsInner.md)
 - [GetDomainConnectUrl200Response](docs/GetDomainConnectUrl200Response.md)
 - [GetDomainConnectUrl200ResponseData](docs/GetDomainConnectUrl200ResponseData.md)
 - [GetDomainWarmup200Response](docs/GetDomainWarmup200Response.md)
 - [GetDomainWarmup200ResponseData](docs/GetDomainWarmup200ResponseData.md)
 - [GetDomainWarmup200ResponseDataStagesInner](docs/GetDomainWarmup200ResponseDataStagesInner.md)
 - [GetEmail200Response](docs/GetEmail200Response.md)
 - [GetEmail200ResponseDomain](docs/GetEmail200ResponseDomain.md)
 - [GetEmail200ResponseEventsInner](docs/GetEmail200ResponseEventsInner.md)
 - [GetWebhookLogs200Response](docs/GetWebhookLogs200Response.md)
 - [GetWebhookLogs200ResponseDataInner](docs/GetWebhookLogs200ResponseDataInner.md)
 - [GetWebhookLogs200ResponsePagination](docs/GetWebhookLogs200ResponsePagination.md)
 - [HandleStripeWebhook200Response](docs/HandleStripeWebhook200Response.md)
 - [InviteOrgMember201Response](docs/InviteOrgMember201Response.md)
 - [InviteOrgMemberRequest](docs/InviteOrgMemberRequest.md)
 - [ListApiKeys200Response](docs/ListApiKeys200Response.md)
 - [ListApiKeys200ResponseDataInner](docs/ListApiKeys200ResponseDataInner.md)
 - [ListDomainSenders200ResponseInner](docs/ListDomainSenders200ResponseInner.md)
 - [ListDomains200ResponseInner](docs/ListDomains200ResponseInner.md)
 - [ListEmails200Response](docs/ListEmails200Response.md)
 - [ListEmails200ResponseDataInner](docs/ListEmails200ResponseDataInner.md)
 - [ListEmails200ResponsePagination](docs/ListEmails200ResponsePagination.md)
 - [ListSenders200ResponseInner](docs/ListSenders200ResponseInner.md)
 - [ListSenders200ResponseInnerDomain](docs/ListSenders200ResponseInnerDomain.md)
 - [ListSuppressions200Response](docs/ListSuppressions200Response.md)
 - [ListSuppressions200ResponsePagination](docs/ListSuppressions200ResponsePagination.md)
 - [ListTemplates200Response](docs/ListTemplates200Response.md)
 - [ListTemplates200ResponseDataInner](docs/ListTemplates200ResponseDataInner.md)
 - [ListWebhooks200Response](docs/ListWebhooks200Response.md)
 - [ListWebhooks200ResponseDataInner](docs/ListWebhooks200ResponseDataInner.md)
 - [LoginUserRequest](docs/LoginUserRequest.md)
 - [RefreshToken200Response](docs/RefreshToken200Response.md)
 - [RefreshTokenRequest](docs/RefreshTokenRequest.md)
 - [RegisterUser201Response](docs/RegisterUser201Response.md)
 - [RegisterUser201ResponseOrgsInner](docs/RegisterUser201ResponseOrgsInner.md)
 - [RegisterUser201ResponseUser](docs/RegisterUser201ResponseUser.md)
 - [RegisterUserRequest](docs/RegisterUserRequest.md)
 - [RelinkDomain200Response](docs/RelinkDomain200Response.md)
 - [ResetPassword200Response](docs/ResetPassword200Response.md)
 - [ResetPassword400Response](docs/ResetPassword400Response.md)
 - [ResetPassword400ResponseError](docs/ResetPassword400ResponseError.md)
 - [ResetPasswordRequest](docs/ResetPasswordRequest.md)
 - [SendBatchEmails201Response](docs/SendBatchEmails201Response.md)
 - [SendBatchEmails201ResponseDataInner](docs/SendBatchEmails201ResponseDataInner.md)
 - [SendBatchEmails201ResponseErrorsInner](docs/SendBatchEmails201ResponseErrorsInner.md)
 - [SendBatchEmailsRequest](docs/SendBatchEmailsRequest.md)
 - [SendEmail201Response](docs/SendEmail201Response.md)
 - [SendEmailRequest](docs/SendEmailRequest.md)
 - [StartDomainWarmup201Response](docs/StartDomainWarmup201Response.md)
 - [StopDomainWarmup200Response](docs/StopDomainWarmup200Response.md)
 - [UpdateDomainWarmup200Response](docs/UpdateDomainWarmup200Response.md)
 - [UpdateDomainWarmup200ResponseData](docs/UpdateDomainWarmup200ResponseData.md)
 - [UpdateDomainWarmupRequest](docs/UpdateDomainWarmupRequest.md)
 - [UpdateOrgRequest](docs/UpdateOrgRequest.md)
 - [UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
 - [UpdateWebhook200Response](docs/UpdateWebhook200Response.md)
 - [UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
 - [VerifyDomain200Response](docs/VerifyDomain200Response.md)
 - [VerifyDomain200ResponseDnsRecordsInner](docs/VerifyDomain200ResponseDnsRecordsInner.md)
 - [VerifyDomain200ResponseVerification](docs/VerifyDomain200ResponseVerification.md)
 - [VerifyDomain200ResponseVerificationRecordsInner](docs/VerifyDomain200ResponseVerificationRecordsInner.md)


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


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

- **Type**: Bearer authentication

<a id="jwt"></a>
### jwt

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


## Author




