ccai-python 1.0.0__tar.gz → 1.0.1__tar.gz

ccai_python-1.0.1/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: ccai-python
+Version: 1.0.1
+Summary: Python client for CloudContactAI API
+Author: CloudContactAI LLC
+License: MIT
+Project-URL: Homepage, https://github.com/cloudcontactai/ccai-python
+Project-URL: Bug Tracker, https://github.com/cloudcontactai/ccai-python/issues
+Keywords: sms,api,client,cloud,contact,ai,cloudcontactai
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pydantic>=2.5.0
+Dynamic: requires-python
+
+# CCAI Python Client
+
+Version: 1.0.1
+
+A Python client for interacting with the CloudContactAI API.
+
+## Installation
+
+```bash
+pip install ccai-python
+```
+
+## Usage
+
+### SMS
+
+```python
+from ccai_python import CCAI
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Send a single SMS
+response = ccai.sms.send_single(
+    first_name="John",
+    last_name="Doe",
+    phone="+15551234567",
+    message="Hello ${first_name}, this is a test message!",
+    title="Test Campaign"
+)
+
+print(f"Message sent with ID: {response.id}")
+
+# Send to multiple recipients
+accounts = [
+    {"first_name": "John", "last_name": "Doe", "phone": "+15551234567"},
+    {"first_name": "Jane", "last_name": "Smith", "phone": "+15559876543"}
+]
+
+campaign_response = ccai.sms.send(
+    accounts=accounts,
+    message="Hello ${first_name} ${last_name}, this is a test message!",
+    title="Bulk Test Campaign"
+)
+
+print(f"Campaign sent with ID: {campaign_response.campaign_id}")
+```
+
+### MMS
+
+```python
+from ccai_python import CCAI, Account, SMSOptions
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Define a progress callback
+def track_progress(status):
+    print(f"Progress: {status}")
+
+# Create options with progress tracking
+options = SMSOptions(
+    timeout=60,
+    retries=3,
+    on_progress=track_progress
+)
+
+# Complete MMS workflow (get URL, upload image, send MMS)
+image_path = "path/to/your/image.jpg"
+content_type = "image/jpeg"
+
+# Define recipient
+account = Account(
+    first_name="John",
+    last_name="Doe",
+    phone="+15551234567"  # Use E.164 format
+)
+
+# Send MMS with image in one step
+response = ccai.mms.send_with_image(
+    image_path=image_path,
+    content_type=content_type,
+    accounts=[account],
+    message="Hello ${first_name}, check out this image!",
+    title="MMS Campaign Example",
+    options=options
+)
+
+print(f"MMS sent! Campaign ID: {response.campaign_id}")
+```
+
+### Email
+
+```python
+from ccai_python import CCAI, EmailAccount, EmailCampaign
+from datetime import datetime, timedelta
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Send a single email
+response = ccai.email.send_single(
+    first_name="John",
+    last_name="Doe",
+    email="john@example.com",
+    subject="Welcome to Our Service",
+    message="<p>Hello John,</p><p>Thank you for signing up!</p>",
+    sender_email="noreply@yourcompany.com",
+    reply_email="support@yourcompany.com",
+    sender_name="Your Company",
+    title="Welcome Email"
+)
+
+print(f"Email sent with ID: {response.id}")
+
+# Send email campaign to multiple recipients
+accounts = [
+    EmailAccount(
+        first_name="John",
+        last_name="Doe",
+        email="john@example.com",
+        phone=""
+    ),
+    EmailAccount(
+        first_name="Jane",
+        last_name="Smith",
+        email="jane@example.com",
+        phone=""
+    )
+]
+
+campaign = EmailCampaign(
+    subject="Monthly Newsletter",
+    title="July 2025 Newsletter",
+    message="<h1>Hello ${firstName}!</h1><p>Here's our monthly update...</p>",
+    sender_email="newsletter@yourcompany.com",
+    reply_email="support@yourcompany.com",
+    sender_name="Your Company Newsletter",
+    accounts=accounts
+)
+
+response = ccai.email.send_campaign(campaign)
+print(f"Email campaign sent: {response}")
+
+# Schedule an email for future delivery
+tomorrow = datetime.now() + timedelta(days=1)
+tomorrow = tomorrow.replace(hour=10, minute=0, second=0, microsecond=0)
+
+scheduled_campaign = EmailCampaign(
+    subject="Scheduled Email",
+    title="Future Email",
+    message="<p>This email was scheduled in advance!</p>",
+    sender_email="scheduled@yourcompany.com",
+    reply_email="support@yourcompany.com",
+    sender_name="Your Company",
+    accounts=[accounts[0]],
+    scheduled_timestamp=tomorrow.isoformat(),
+    scheduled_timezone="America/New_York"
+)
+
+response = ccai.email.send_campaign(scheduled_campaign)
+print(f"Email scheduled: {response}")
+```
+
+### Contacts
+
+```python
+from ccai_python import CCAI
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Set do not text status using contact ID
+response = ccai.contact.set_do_not_text(
+    do_not_text=True,
+    contact_id="your-contact-id"
+)
+print(f"Contact {response.contact_id} do not text set to {response.do_not_text}")
+
+# Set do not text status using phone number
+response = ccai.contact.set_do_not_text(
+    do_not_text=True,
+    phone="+15551234567"
+)
+print(f"Contact {response.contact_id} ({response.phone}) do not text set to {response.do_not_text}")
+
+# Remove do not text status from a contact
+response = ccai.contact.set_do_not_text(
+    do_not_text=False,
+    contact_id="your-contact-id"
+)
+print(f"Contact {response.contact_id} do not text removed: {response.do_not_text}")
+```
+
+### Webhooks
+
+```python
+from ccai_python import CCAI, WebhookConfig, WebhookEventType
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Register a webhook
+config = WebhookConfig(
+    url="https://your-domain.com/api/ccai-webhook",
+    events=[WebhookEventType.MESSAGE_SENT, WebhookEventType.MESSAGE_RECEIVED],
+    secret="your-webhook-secret"
+)
+
+webhook = ccai.webhook.register(config)
+print(f"Webhook registered with ID: {webhook.id}")
+
+# List all webhooks
+webhooks = ccai.webhook.list()
+print(f"Found {len(webhooks)} webhooks")
+
+# Update a webhook
+update_data = {
+    "events": [WebhookEventType.MESSAGE_RECEIVED]
+}
+updated_webhook = ccai.webhook.update(webhook.id, update_data)
+print(f"Webhook updated: {updated_webhook}")
+
+# Delete a webhook
+result = ccai.webhook.delete(webhook.id)
+print(f"Webhook deleted: {result}")
+
+# Create a webhook handler for web frameworks
+def handle_message_sent(event):
+    print(f"Message sent: {event.message} to {event.to}")
+
+def handle_message_received(event):
+    print(f"Message received: {event.message} from {event.from_}")
+
+handlers = {
+    'on_message_sent': handle_message_sent,
+    'on_message_received': handle_message_received
+}
+
+webhook_handler = ccai.webhook.create_handler(handlers)
+
+# Use with Flask
+from flask import Flask, request, jsonify
+
+app = Flask(__name__)
+
+@app.route('/api/ccai-webhook', methods=['POST'])
+def handle_webhook():
+    payload = request.get_json()
+    result = webhook_handler(payload)
+    return jsonify(result)
+```
+
+## Features
+
+- Send SMS messages to single or multiple recipients
+- Send MMS messages with images
+- Send Email campaigns with HTML content
+- Schedule emails for future delivery
+- Webhook management (register, update, list, delete)
+- Webhook event handling for web frameworks
+- Upload images to S3 with signed URLs
+- Variable substitution in messages
+- Progress tracking callbacks
+- Type hints for better IDE integration
+- Comprehensive error handling
+
+## Requirements
+
+- Python 3.10 or higher
+- `requests` library
+- `pydantic` library
+
+## License
+
+MIT

ccai_python-1.0.1/README.md

@@ -0,0 +1,291 @@
+# CCAI Python Client
+
+Version: 1.0.1
+
+A Python client for interacting with the CloudContactAI API.
+
+## Installation
+
+```bash
+pip install ccai-python
+```
+
+## Usage
+
+### SMS
+
+```python
+from ccai_python import CCAI
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Send a single SMS
+response = ccai.sms.send_single(
+    first_name="John",
+    last_name="Doe",
+    phone="+15551234567",
+    message="Hello ${first_name}, this is a test message!",
+    title="Test Campaign"
+)
+
+print(f"Message sent with ID: {response.id}")
+
+# Send to multiple recipients
+accounts = [
+    {"first_name": "John", "last_name": "Doe", "phone": "+15551234567"},
+    {"first_name": "Jane", "last_name": "Smith", "phone": "+15559876543"}
+]
+
+campaign_response = ccai.sms.send(
+    accounts=accounts,
+    message="Hello ${first_name} ${last_name}, this is a test message!",
+    title="Bulk Test Campaign"
+)
+
+print(f"Campaign sent with ID: {campaign_response.campaign_id}")
+```
+
+### MMS
+
+```python
+from ccai_python import CCAI, Account, SMSOptions
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Define a progress callback
+def track_progress(status):
+    print(f"Progress: {status}")
+
+# Create options with progress tracking
+options = SMSOptions(
+    timeout=60,
+    retries=3,
+    on_progress=track_progress
+)
+
+# Complete MMS workflow (get URL, upload image, send MMS)
+image_path = "path/to/your/image.jpg"
+content_type = "image/jpeg"
+
+# Define recipient
+account = Account(
+    first_name="John",
+    last_name="Doe",
+    phone="+15551234567"  # Use E.164 format
+)
+
+# Send MMS with image in one step
+response = ccai.mms.send_with_image(
+    image_path=image_path,
+    content_type=content_type,
+    accounts=[account],
+    message="Hello ${first_name}, check out this image!",
+    title="MMS Campaign Example",
+    options=options
+)
+
+print(f"MMS sent! Campaign ID: {response.campaign_id}")
+```
+
+### Email
+
+```python
+from ccai_python import CCAI, EmailAccount, EmailCampaign
+from datetime import datetime, timedelta
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Send a single email
+response = ccai.email.send_single(
+    first_name="John",
+    last_name="Doe",
+    email="john@example.com",
+    subject="Welcome to Our Service",
+    message="<p>Hello John,</p><p>Thank you for signing up!</p>",
+    sender_email="noreply@yourcompany.com",
+    reply_email="support@yourcompany.com",
+    sender_name="Your Company",
+    title="Welcome Email"
+)
+
+print(f"Email sent with ID: {response.id}")
+
+# Send email campaign to multiple recipients
+accounts = [
+    EmailAccount(
+        first_name="John",
+        last_name="Doe",
+        email="john@example.com",
+        phone=""
+    ),
+    EmailAccount(
+        first_name="Jane",
+        last_name="Smith",
+        email="jane@example.com",
+        phone=""
+    )
+]
+
+campaign = EmailCampaign(
+    subject="Monthly Newsletter",
+    title="July 2025 Newsletter",
+    message="<h1>Hello ${firstName}!</h1><p>Here's our monthly update...</p>",
+    sender_email="newsletter@yourcompany.com",
+    reply_email="support@yourcompany.com",
+    sender_name="Your Company Newsletter",
+    accounts=accounts
+)
+
+response = ccai.email.send_campaign(campaign)
+print(f"Email campaign sent: {response}")
+
+# Schedule an email for future delivery
+tomorrow = datetime.now() + timedelta(days=1)
+tomorrow = tomorrow.replace(hour=10, minute=0, second=0, microsecond=0)
+
+scheduled_campaign = EmailCampaign(
+    subject="Scheduled Email",
+    title="Future Email",
+    message="<p>This email was scheduled in advance!</p>",
+    sender_email="scheduled@yourcompany.com",
+    reply_email="support@yourcompany.com",
+    sender_name="Your Company",
+    accounts=[accounts[0]],
+    scheduled_timestamp=tomorrow.isoformat(),
+    scheduled_timezone="America/New_York"
+)
+
+response = ccai.email.send_campaign(scheduled_campaign)
+print(f"Email scheduled: {response}")
+```
+
+### Contacts
+
+```python
+from ccai_python import CCAI
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Set do not text status using contact ID
+response = ccai.contact.set_do_not_text(
+    do_not_text=True,
+    contact_id="your-contact-id"
+)
+print(f"Contact {response.contact_id} do not text set to {response.do_not_text}")
+
+# Set do not text status using phone number
+response = ccai.contact.set_do_not_text(
+    do_not_text=True,
+    phone="+15551234567"
+)
+print(f"Contact {response.contact_id} ({response.phone}) do not text set to {response.do_not_text}")
+
+# Remove do not text status from a contact
+response = ccai.contact.set_do_not_text(
+    do_not_text=False,
+    contact_id="your-contact-id"
+)
+print(f"Contact {response.contact_id} do not text removed: {response.do_not_text}")
+```
+
+### Webhooks
+
+```python
+from ccai_python import CCAI, WebhookConfig, WebhookEventType
+
+# Initialize the client
+ccai = CCAI(
+    client_id="YOUR-CLIENT-ID",
+    api_key="YOUR-API-KEY"
+)
+
+# Register a webhook
+config = WebhookConfig(
+    url="https://your-domain.com/api/ccai-webhook",
+    events=[WebhookEventType.MESSAGE_SENT, WebhookEventType.MESSAGE_RECEIVED],
+    secret="your-webhook-secret"
+)
+
+webhook = ccai.webhook.register(config)
+print(f"Webhook registered with ID: {webhook.id}")
+
+# List all webhooks
+webhooks = ccai.webhook.list()
+print(f"Found {len(webhooks)} webhooks")
+
+# Update a webhook
+update_data = {
+    "events": [WebhookEventType.MESSAGE_RECEIVED]
+}
+updated_webhook = ccai.webhook.update(webhook.id, update_data)
+print(f"Webhook updated: {updated_webhook}")
+
+# Delete a webhook
+result = ccai.webhook.delete(webhook.id)
+print(f"Webhook deleted: {result}")
+
+# Create a webhook handler for web frameworks
+def handle_message_sent(event):
+    print(f"Message sent: {event.message} to {event.to}")
+
+def handle_message_received(event):
+    print(f"Message received: {event.message} from {event.from_}")
+
+handlers = {
+    'on_message_sent': handle_message_sent,
+    'on_message_received': handle_message_received
+}
+
+webhook_handler = ccai.webhook.create_handler(handlers)
+
+# Use with Flask
+from flask import Flask, request, jsonify
+
+app = Flask(__name__)
+
+@app.route('/api/ccai-webhook', methods=['POST'])
+def handle_webhook():
+    payload = request.get_json()
+    result = webhook_handler(payload)
+    return jsonify(result)
+```
+
+## Features
+
+- Send SMS messages to single or multiple recipients
+- Send MMS messages with images
+- Send Email campaigns with HTML content
+- Schedule emails for future delivery
+- Webhook management (register, update, list, delete)
+- Webhook event handling for web frameworks
+- Upload images to S3 with signed URLs
+- Variable substitution in messages
+- Progress tracking callbacks
+- Type hints for better IDE integration
+- Comprehensive error handling
+
+## Requirements
+
+- Python 3.10 or higher
+- `requests` library
+- `pydantic` library
+
+## License
+
+MIT

{ccai_python-1.0.0 → ccai_python-1.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ccai-python"
-version = "1.0.0"
+version = "1.0.1"
 description = "Python client for CloudContactAI API"
 readme = "README.md"
 requires-python = ">=3.10"

ccai_python-1.0.1/setup.py

@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='ccai',  # 🟢 CLI command will be `ccai`
+    version='1.0.1',
+    description='A CLI and Python client for sending SMS via CloudContactAI',
+    author='CloudContactAI LLC',
+    license='MIT',
+    packages=find_packages(where='src'),
+    package_dir={'': 'src'},
+    install_requires=[
+        'requests>=2.31.0',
+        'pydantic>=2.5.0'
+    ],
+    entry_points={
+        'console_scripts': [
+            'ccai = ccai_python.ccai:main',
+        ],
+    },
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.8',
+)

ccai_python-1.0.1/src/ccai_python/__init__.py

@@ -0,0 +1,39 @@
+"""
+Main export file for the CCAI Python module
+
+:license: MIT
+:copyright: 2025 CloudContactAI LLC
+"""
+
+from .ccai import CCAI, Account, CCAIConfig
+from .sms.sms import SMS, SMSCampaign, SMSResponse, SMSOptions
+from .sms.mms import MMS
+from .email_service import Email, EmailAccount, EmailCampaign, EmailResponse, EmailOptions
+from .webhook import Webhook, WebhookConfig, WebhookEventType, MessageSentEvent, MessageReceivedEvent
+from .contact_service import Contact, ContactDoNotTextRequest, ContactDoNotTextResponse
+
+__all__ = [
+    'CCAI',
+    'SMS',
+    'MMS',
+    'Email',
+    'Webhook',
+    'Account',
+    'EmailAccount',
+    'CCAIConfig',
+    'SMSCampaign',
+    'SMSResponse',
+    'SMSOptions',
+    'EmailCampaign',
+    'EmailResponse',
+    'EmailOptions',
+    'WebhookConfig',
+    'WebhookEventType',
+    'MessageSentEvent',
+    'MessageReceivedEvent',
+    'Contact',
+    'ContactDoNotTextRequest',
+    'ContactDoNotTextResponse'
+]
+
+__version__ = '1.0.1'