omx-sdk 0.2.0

Official Python SDK for Oxinion Marketing Exchange - Multi-channel marketing automation with push notifications, email, geotriggers, beacons, and webhooks

OMX SDK for Python

Python SDK for Oxinion Marketing Exchange (OMX) - A comprehensive toolkit for multi-channel marketing automation, geotrigger management, push notifications, email campaigns, webhook integration, workflow automation, analytics insights, audience segmentation, and event tracking.

Installation

pip install omx-sdk

Quick Start

import asyncio
import os
from omx_sdk import OMXClient

async def main():
    # Recommended: Use async context manager (auto-cleanup)
    async with OMXClient(
        client_id=os.getenv("OMX_CLIENT_ID"),
        secret_key=os.getenv("OMX_SECRET_KEY")
    ) as omx:
        # Send push notification (Pythonic style with keyword arguments)
        result = await omx.notification.send(
            title="Special Offer",
            message="Get 20% off your next purchase!",
            recipients=["user123", "user456"],
            data={"coupon_code": "SAVE20"}
        )
        print(f"Notification sent: {result.message_id}")

        # Create geofence
        geofence = await omx.geo_trigger.create(
            name="Downtown Store",
            location={"lat": 40.7128, "lng": -74.006},
            radius=100,
            events=["enter", "exit"]
        )
        print(f"Geofence created: {geofence.id}")

        # Send email
        email = await omx.email.send(
            to="[e-mail]",
            subject="Welcome!",
            template="welcome_template",
            variables={"first_name": "John"}
        )
        print(f"Email sent: {email.message_id}")

        # Create webhook
        webhook = await omx.webhook.create(
            url="https://your-app.com/webhooks/omx",
            events=["geofence.enter", "notification.sent"],
            secret="your_webhook_secret"
        )
        print(f"Webhook created: {webhook.id}")

if __name__ == "__main__":
    asyncio.run(main())

Features

• 📱 Push Notifications - Send targeted push notifications with deep linking
• 🌍 GeoTrigger Management - Create and manage location-based automation
• 📧 Email Marketing - Send transactional emails and email campaigns
• 📡 Beacon Management - Bluetooth beacon proximity marketing
• 🔗 Webhook Integration - Real-time event notifications and webhooks
• 🎯 Campaign Automation - Multi-channel marketing campaigns
• 🔄 Workflow Automation - Visual workflow automation with complex logic
• 📊 Analytics & Insights - Performance analytics and reporting
• 👥 Audience Segmentation - Advanced user segmentation and targeting
• 📝 Event Tracking - Comprehensive user behavior tracking
• 🔐 Secure Authentication - Automatic token management
• ⚡ Async Support - Built with httpx for high-performance async/await

All Available Modules

Notification Module

# Send push notifications
await omx.notification.send(
    title="Hello",
    message="Welcome!",
    recipients=["user123"]
)

# Send to audience segment
await omx.notification.send_to_segment(
    title="Sale Alert",
    message="50% off today!",
    segment="vip_customers"
)

# Get notification history
history = await omx.notification.get_history(limit=50, status="delivered")

Email Module

# Send transactional email
await omx.email.send(
    to="[e-mail]",
    subject="Welcome!",
    template="welcome_template",
    variables={"name": "John"}
)

# Create email campaign
campaign = await omx.email.create_campaign(
    name="Monthly Newsletter",
    subject="Special Offers",
    template="newsletter",
    recipients=["segment:all_users"]
)

GeoTrigger Module

# Create circular geofence
geofence = await omx.geo_trigger.create(
    name="Store Location",
    location={"lat": 40.7128, "lng": -74.006},
    radius=100,
    events=["enter", "exit"]
)

# Check if location is inside geofence
is_inside = await omx.geo_trigger.check_location(
    geofence_id="fence_123",
    latitude=40.7128,
    longitude=-74.006
)

Beacon Module

# Register beacon
beacon = await omx.beacon.register(
    uuid="550e8400-e29b-41d4-a716-446655440000",
    major=1,
    minor=1,
    name="Store Entrance"
)

# Get nearby beacons
beacons = await omx.beacon.get_nearby(
    latitude=40.7128,
    longitude=-74.006,
    radius=50
)

Webhook Module

# Create webhook
webhook = await omx.webhook.create(
    url="https://yourapp.com/webhook",
    events=["geofence.enter", "notification.sent"],
    secret="your_secret"
)

# Get delivery logs
deliveries = await omx.webhook.get_deliveries(
    webhook_id="webhook_123",
    status="failed"
)

Campaign Module

# Create multi-channel campaign
campaign = await omx.campaign.create(
    name="Summer Sale",
    description="Seasonal promotion",
    channels=["email", "push_notification"],
    schedule={"start_date": "2024-06-01T00:00:00Z"},
    targeting={"segments": ["active_users"]}
)

# Execute campaign
await omx.campaign.execute(
    campaign.id,
    trigger_data={"user_id": "user_123"}
)

Workflow Module

# Create visual workflow
workflow = await omx.workflow.create_workflow(
    name="Customer Onboarding",
    description="Automated welcome sequence",
    config={
        "triggers": ["user_signup"],
        "actions": [
            {"type": "send_email", "template": "welcome"},
            {"type": "wait", "duration": 3600},
            {"type": "send_notification", "title": "Complete Profile"}
        ]
    }
)

# Execute workflow
result = await omx.workflow.run_workflow(workflow.id)

Analytics Module

# Get geotrigger analytics
analytics = await omx.analytics.get_geotrigger_stats(
    geotrigger_id="store_001",
    time_range="30d"
)

print(f"Total entries: {analytics.metrics['total_entries']}")
print(f"Conversion rate: {analytics.metrics['conversion_rate']}%")

Segment Module

# Create audience segment
segment = await omx.segment.create_segment(
    name="High Value Customers",
    description="Customers with high lifetime value",
    criteria={
        "total_spent": {"$gte": 1000},
        "last_purchase": {"$gte": "2024-01-01"}
    }
)

# Get users in segment
users = await omx.segment.get_segment_users(segment.id)

Events Module

# Track user event
await omx.events.track_event(
    user_id="user_123",
    event_type="purchase",
    data={
        "product_id": "prod_456",
        "amount": 99.99,
        "currency": "USD"
    }
)

# Get user event timeline
timeline = await omx.events.get_event_timeline(
    user_id="user_123",
    limit=50
)

Configuration

Set your credentials as environment variables:

export OMX_CLIENT_ID="your_client_id"
export OMX_SECRET_KEY="your_secret_key"

Documentation

For detailed documentation and API reference, visit: https://github.com/oxinion/omx-sdk

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• 📧 Email: [e-mail]
• 🐛 Issues: https://github.com/oxinion/omx-sdk/issues
• 📖 Documentation: https://github.com/oxinion/omx-sdk#readme