Skip to content

rebelsender/rebelsender-python

BranchesTags

Repository files navigation

rebelsender

High-velocity email infrastructure for builders.

This Python package is automatically generated by the OpenAPI Generator 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:

pip install git+https://github.com/rebelsender/rebelsender-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/rebelsender/rebelsender-python.git)

Then import the package:

import rebelsender

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 rebelsender

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

  • Type: Bearer authentication

jwt

  • Type: Bearer authentication (JWT)

Author

About

Official Python SDK for RebelSender

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

 
 
 

Contributors

Languages