channel3-sdk 0.2.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

channel3_sdk/models.py

@@ -1,135 +0,0 @@
-"""Pydantic models for the Channel3 API."""
-
-from enum import Enum
-from typing import List, Optional, Literal
-from pydantic import BaseModel, Field
-
-
-class AvailabilityStatus(str, Enum):
-    """Availability status of a product."""
-
-    IN_STOCK = "InStock"
-    OUT_OF_STOCK = "OutOfStock"
-    PRE_ORDER = "PreOrder"
-    LIMITED_AVAILABILITY = "LimitedAvailability"
-    BACK_ORDER = "BackOrder"
-    DISCONTINUED = "Discontinued"
-    SOLD_OUT = "SoldOut"
-    UNKNOWN = "Unknown"
-
-
-class Price(BaseModel):
-    """Price information for a product."""
-
-    price: float = Field(
-        ..., description="The current price of the product, including any discounts."
-    )
-    compare_at_price: Optional[float] = Field(
-        None, description="The original price of the product before any discounts."
-    )
-    currency: str = Field(..., description="The currency code of the product.")
-
-
-class Brand(BaseModel):
-    """A brand."""
-
-    id: str = Field(..., description="Unique identifier for the brand")
-    name: str = Field(..., description="Name of the brand")
-    logo_url: Optional[str] = Field(None, description="Logo URL for the brand")
-    description: Optional[str] = Field(None, description="Description of the brand")
-
-
-class Variant(BaseModel):
-    """A product variant."""
-
-    product_id: str = Field(..., description="Unique identifier for the product")
-    title: str = Field(..., description="Title of the variant")
-    image_url: str = Field(..., description="Image URL for the variant")
-
-
-class Product(BaseModel):
-    """A product returned from search."""
-
-    id: str = Field(..., description="Unique identifier for the product")
-    url: str = Field(..., description="URL for the product")
-    score: float = Field(..., description="Relevance score for the search query")
-    title: str = Field(..., description="Product title")
-    description: Optional[str] = Field(None, description="Product description")
-    brand_name: str = Field(..., description="Brand name for the product")
-    image_url: str = Field(..., description="Main product image URL")
-    price: Price = Field(..., description="Price information")
-    availability: AvailabilityStatus = Field(
-        ..., description="Product availability status"
-    )
-    variants: List[Variant] = Field(
-        default_factory=list, description="Product variants"
-    )
-
-
-class ProductDetail(BaseModel):
-    """Detailed information about a product."""
-
-    id: str = Field(..., description="Unique identifier for the product")
-    url: str = Field(..., description="URL for the product")
-    score: float = Field(..., description="Relevance score for the search query")
-    title: str = Field(..., description="Product title")
-    description: Optional[str] = Field(None, description="Product description")
-    brand_id: Optional[str] = Field(None, description="Unique identifier for the brand")
-    brand_name: Optional[str] = Field(None, description="Brand name of the product")
-    image_urls: Optional[List[str]] = Field(
-        None, description="List of product image URLs"
-    )
-    price: Price = Field(..., description="Price information")
-    availability: AvailabilityStatus = Field(
-        ..., description="Product availability status"
-    )
-    gender: Optional[Literal["unisex", "men", "women"]] = Field(
-        None, description="Gender of the product, if applicable"
-    )
-    materials: Optional[List[str]] = Field(
-        None, description="List of materials, if applicable"
-    )
-    key_features: Optional[List[str]] = Field(
-        None, description="List of key product features"
-    )
-    variants: List[Variant] = Field(
-        default_factory=list, description="Product variants"
-    )
-
-
-class SearchFilterPrice(BaseModel):
-    """Price filter for product search."""
-
-    min_price: Optional[float] = Field(None, description="Minimum price filter")
-    max_price: Optional[float] = Field(None, description="Maximum price filter")
-
-
-class SearchFilters(BaseModel):
-    """Search filters for product search."""
-
-    brand_ids: Optional[List[str]] = Field(
-        None, description="List of brand IDs to filter by"
-    )
-    gender: Optional[Literal["male", "female", "unisex"]] = Field(
-        None, description="Gender to filter by"
-    )
-    price: Optional[SearchFilterPrice] = Field(
-        None, description="Price range to filter by"
-    )
-    availability: Optional[List[AvailabilityStatus]] = Field(
-        None, description="Availability statuses to filter by"
-    )
-
-
-class SearchRequest(BaseModel):
-    """Request model for product search."""
-
-    query: Optional[str] = Field(None, description="Text search query")
-    image_url: Optional[str] = Field(None, description="URL of image for visual search")
-    base64_image: Optional[str] = Field(
-        None, description="Base64-encoded image for visual search"
-    )
-    limit: Optional[int] = Field(
-        default=20, description="Maximum number of results to return"
-    )
-    filters: Optional[SearchFilters] = Field(default=None, description="Search filters")

channel3_sdk-0.2.2.dist-info/METADATA

@@ -1,284 +0,0 @@
-Metadata-Version: 2.1
-Name: channel3-sdk
-Version: 0.2.2
-Summary: The official Python SDK for Channel3 AI Shopping API
-Home-page: https://github.com/channel3/sdk-python
-License: MIT
-Keywords: ai,shopping,ecommerce,search,api
-Author: Channel3
-Author-email: alex@trychannel3.com
-Requires-Python: >=3.8,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: aiohttp (>=3.9.0,<4.0.0)
-Requires-Dist: pydantic (>=2.5.0,<3.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
-Project-URL: Repository, https://github.com/channel3/sdk-python
-Description-Content-Type: text/markdown
-
-# Channel3 Python SDK
-
-The official Python SDK for the [Channel3](https://trychannel3.com) AI Shopping API.
-
-## Installation
-
-```bash
-pip install channel3-sdk
-```
-
-## Quick Start
-
-### Synchronous Client
-
-```python
-import os
-from channel3_sdk import Channel3Client
-
-# Initialize the client
-client = Channel3Client(api_key="your_api_key_here")
-# Or use environment variable: CHANNEL3_API_KEY
-
-# Search for products
-products = client.search(query="blue denim jacket")
-
-for product in products:
-    print(f"Product: {product.title}")
-    print(f"Brand: {product.brand_name}")
-    print(f"Price: {product.price.currency} {product.price.price}")
-    print(f"Availability: {product.availability}")
-    print("---")
-
-# Get detailed product information
-product_detail = client.get_product("prod_123456")
-print(f"Detailed info for: {product_detail.title}")
-print(f"Brand: {product_detail.brand_name}")
-if product_detail.key_features:
-    print(f"Key features: {product_detail.key_features}")
-
-# Get all brands
-brands = client.get_brands()
-for brand in brands:
-    print(f"Brand: {brand.name}")
-    if brand.description:
-        print(f"Description: {brand.description}")
-
-# Get specific brand details
-brand = client.get_brand("brand_123")
-print(f"Brand: {brand.name}")
-```
-
-### Asynchronous Client
-
-```python
-import asyncio
-from channel3_sdk import AsyncChannel3Client
-
-async def main():
-    # Initialize the async client
-    client = AsyncChannel3Client(api_key="your_api_key_here")
-    
-    # Search for products
-    products = await client.search(query="running shoes")
-    
-    for product in products:
-        print(f"Product: {product.title}")
-        print(f"Score: {product.score}")
-        print(f"Price: {product.price.currency} {product.price.price}")
-    
-    # Get detailed product information
-    if products:
-        product_detail = await client.get_product(products[0].id)
-        print(f"Availability: {product_detail.availability}")
-    
-    # Get brands
-    brands = await client.get_brands()
-    print(f"Found {len(brands)} brands")
-
-# Run the async function
-asyncio.run(main())
-```
-
-## Advanced Usage
-
-### Visual Search
-
-```python
-# Search by image URL
-products = client.search(image_url="https://example.com/image.jpg")
-
-# Search by base64 image
-with open("image.jpg", "rb") as f:
-    import base64
-    base64_image = base64.b64encode(f.read()).decode()
-    products = client.search(base64_image=base64_image)
-```
-
-### Multimodal Search
-
-```python
-# Combine text and image search
-products = client.search(
-    query="blue denim jacket",
-    image_url="https://example.com/jacket.jpg"
-)
-```
-
-### Search with Filters
-
-```python
-from channel3_sdk import SearchFilters, AvailabilityStatus
-
-# Create search filters
-filters = SearchFilters(
-    brand_ids=["brand_123", "brand_456"],
-    gender="male",
-    availability=[AvailabilityStatus.IN_STOCK],
-    price={"min_price": 50.0, "max_price": 200.0}
-)
-
-# Search with filters
-products = client.search(
-    query="jacket",
-    filters=filters,
-    limit=10
-)
-```
-
-### Brand Management
-
-```python
-# Get all brands with pagination
-brands = client.get_brands(page=1, size=50)
-
-# Search for specific brands
-nike_brands = client.get_brands(query="nike")
-
-# Get detailed brand information
-brand_detail = client.get_brand("brand_123")
-print(f"Brand: {brand_detail.name}")
-print(f"Logo: {brand_detail.logo_url}")
-```
-
-## API Reference
-
-### Client Classes
-
-#### `Channel3Client`
-Synchronous client for the Channel3 API.
-
-**Methods:**
-- `search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
-- `get_product(product_id)` → `ProductDetail`
-- `get_brands(query=None, page=1, size=100)` → `List[Brand]`
-- `get_brand(brand_id)` → `Brand`
-
-#### `AsyncChannel3Client` 
-Asynchronous client for the Channel3 API.
-
-**Methods:**
-- `async search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
-- `async get_product(product_id)` → `ProductDetail`
-- `async get_brands(query=None, page=1, size=100)` → `List[Brand]`
-- `async get_brand(brand_id)` → `Brand`
-
-### Models
-
-#### `Product`
-- `id: str` - Unique product identifier
-- `score: float` - Search relevance score
-- `title: str` - Product title
-- `description: Optional[str]` - Product description
-- `brand_name: str` - Brand name
-- `image_url: str` - Main product image URL
-- `price: Price` - Price information
-- `availability: AvailabilityStatus` - Availability status
-- `variants: List[Variant]` - Product variants
-
-#### `ProductDetail`
-- `title: str` - Product title
-- `description: Optional[str]` - Product description
-- `brand_id: Optional[str]` - Brand identifier
-- `brand_name: Optional[str]` - Brand name
-- `image_urls: Optional[List[str]]` - Product image URLs
-- `price: Price` - Price information
-- `availability: AvailabilityStatus` - Availability status
-- `key_features: Optional[List[str]]` - Key product features
-- `variants: List[Variant]` - Product variants
-
-#### `Brand`
-- `id: str` - Unique brand identifier
-- `name: str` - Brand name
-- `logo_url: Optional[str]` - Brand logo URL
-- `description: Optional[str]` - Brand description
-
-#### `Variant`
-- `product_id: str` - Associated product identifier
-- `title: str` - Variant title
-- `image_url: str` - Variant image URL
-
-#### `SearchFilters`
-- `brand_ids: Optional[List[str]]` - Brand ID filters
-- `gender: Optional[Literal["male", "female", "unisex"]]` - Gender filter
-- `price: Optional[SearchFilterPrice]` - Price range filter
-- `availability: Optional[List[AvailabilityStatus]]` - Availability filters
-
-#### `SearchFilterPrice`
-- `min_price: Optional[float]` - Minimum price
-- `max_price: Optional[float]` - Maximum price
-
-#### `Price`
-- `price: float` - Current price
-- `compare_at_price: Optional[float]` - Original price (if discounted)
-- `currency: str` - Currency code
-
-#### `AvailabilityStatus`
-Enum with values: `IN_STOCK`, `OUT_OF_STOCK`, `PRE_ORDER`, `LIMITED_AVAILABILITY`, `BACK_ORDER`, `DISCONTINUED`, `SOLD_OUT`, `UNKNOWN`
-
-## Error Handling
-
-The SDK provides specific exception types for different error conditions:
-
-```python
-from channel3_sdk import (
-    Channel3AuthenticationError,
-    Channel3ValidationError,
-    Channel3NotFoundError,
-    Channel3ServerError,
-    Channel3ConnectionError
-)
-
-try:
-    products = client.search(query="shoes")
-except Channel3AuthenticationError:
-    print("Invalid API key")
-except Channel3ValidationError as e:
-    print(f"Invalid request: {e.message}")
-except Channel3NotFoundError:
-    print("Resource not found")
-except Channel3ServerError:
-    print("Server error - please try again later")
-except Channel3ConnectionError:
-    print("Connection error - check your internet connection")
-```
-
-## Environment Variables
-
-- `CHANNEL3_API_KEY` - Your Channel3 API key
-
-## Requirements
-
-- Python 3.8+
-- requests
-- aiohttp
-- pydantic
-
-## License
-
-MIT License
-

channel3_sdk-0.2.2.dist-info/RECORD

@@ -1,7 +0,0 @@
-channel3_sdk/__init__.py,sha256=vMrsZwY59OoYmoPwEnZ0kuAuWFkOIERUaoy0lWpGIlc,976
-channel3_sdk/client.py,sha256=wNqM9d7M2eiWOZ0Xp9rJGjINUrsaHYXiBJktBfPD-18,20776
-channel3_sdk/exceptions.py,sha256=5HJgrhir4-_b4XKyWAB9qp-CjVZeigXSkyM9fbcB1IA,1044
-channel3_sdk/models.py,sha256=Qzq4evy1LAyekw9KU8VfV_yn9qeTf6rPj9x_R2ANeH4,5039
-channel3_sdk-0.2.2.dist-info/METADATA,sha256=IM9BZe8al3570-PczGj8PhQHJHlFU0uyCZnMl60a8f0,7799
-channel3_sdk-0.2.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-channel3_sdk-0.2.2.dist-info/RECORD,,