channel3-sdk 2.11.0__py3-none-any.whl

channel3_sdk/types/paginated_subscriptions.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .subscription import Subscription
+
+__all__ = ["PaginatedSubscriptions"]
+
+
+class PaginatedSubscriptions(BaseModel):
+    subscriptions: List[Subscription]
+
+    next_page_token: Optional[str] = None

channel3_sdk/types/price.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["Price"]
+
+
+class Price(BaseModel):
+    currency: str
+    """The currency code of the product, like USD, EUR, GBP, etc."""
+
+    price: float
+    """The current price of the product, including any discounts."""
+
+    compare_at_price: Optional[float] = None
+    """The original price of the product before any discounts."""

channel3_sdk/types/price_history.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["PriceHistory", "History", "Statistics"]
+
+
+class History(BaseModel):
+    currency: str
+
+    price: float
+
+    timestamp: datetime
+
+
+class Statistics(BaseModel):
+    currency: str
+
+    current_price: float
+
+    current_status: Literal["low", "typical", "high"]
+
+    max_price: float
+
+    mean: float
+
+    min_price: float
+
+    std_dev: float
+
+
+class PriceHistory(BaseModel):
+    canonical_product_id: str
+
+    history: Optional[List[History]] = None
+
+    product_title: Optional[str] = None
+
+    statistics: Optional[Statistics] = None

channel3_sdk/types/price_tracking_get_history_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["PriceTrackingGetHistoryParams"]
+
+
+class PriceTrackingGetHistoryParams(TypedDict, total=False):
+    days: int
+    """Number of days of history to fetch (max 30)"""

channel3_sdk/types/price_tracking_list_subscriptions_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["PriceTrackingListSubscriptionsParams"]
+
+
+class PriceTrackingListSubscriptionsParams(TypedDict, total=False):
+    limit: int
+
+    page_token: Optional[str]

channel3_sdk/types/price_tracking_start_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["PriceTrackingStartParams"]
+
+
+class PriceTrackingStartParams(TypedDict, total=False):
+    canonical_product_id: Required[str]

channel3_sdk/types/price_tracking_stop_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["PriceTrackingStopParams"]
+
+
+class PriceTrackingStopParams(TypedDict, total=False):
+    canonical_product_id: Required[str]

channel3_sdk/types/product.py

@@ -0,0 +1,89 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .price import Price
+from .variant import Variant
+from .._models import BaseModel
+from .availability_status import AvailabilityStatus
+
+__all__ = ["Product", "Image"]
+
+
+class Image(BaseModel):
+    """Product image with metadata"""
+
+    url: str
+
+    alt_text: Optional[str] = None
+
+    is_main_image: Optional[bool] = None
+
+    photo_quality: Optional[Literal["professional", "ugc", "poor"]] = None
+    """
+    Photo quality classification for API responses. Note: This enum is decoupled
+    from internal ImageIntelligence types as they may diverge.
+    """
+
+    shot_type: Optional[
+        Literal[
+            "hero",
+            "lifestyle",
+            "on_model",
+            "detail",
+            "scale_reference",
+            "angle_view",
+            "flat_lay",
+            "in_use",
+            "packaging",
+            "size_chart",
+            "color_swatch",
+            "product_information",
+            "merchant_information",
+        ]
+    ] = None
+    """
+    Product image type classification for API responses. Note: This enum is
+    decoupled from internal ImageIntelligence types as they may diverge.
+    """
+
+
+class Product(BaseModel):
+    """A search result that includes product details and a relevance score."""
+
+    id: str
+
+    availability: AvailabilityStatus
+
+    image_url: str
+    """Main product image (deprecated, use images field)"""
+
+    price: Price
+
+    score: int
+
+    title: str
+
+    url: str
+
+    brand_id: Optional[str] = None
+
+    brand_name: Optional[str] = None
+
+    categories: Optional[List[str]] = None
+
+    description: Optional[str] = None
+
+    gender: Optional[Literal["male", "female", "unisex"]] = None
+
+    image_urls: Optional[List[str]] = None
+    """List of image URLs (deprecated, use images field)"""
+
+    images: Optional[List[Image]] = None
+
+    key_features: Optional[List[str]] = None
+
+    materials: Optional[List[str]] = None
+
+    variants: Optional[List[Variant]] = None

channel3_sdk/types/product_detail.py

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .price import Price
+from .variant import Variant
+from .._models import BaseModel
+from .availability_status import AvailabilityStatus
+
+__all__ = ["ProductDetail", "Image"]
+
+
+class Image(BaseModel):
+    """Product image with metadata"""
+
+    url: str
+
+    alt_text: Optional[str] = None
+
+    is_main_image: Optional[bool] = None
+
+    photo_quality: Optional[Literal["professional", "ugc", "poor"]] = None
+    """
+    Photo quality classification for API responses. Note: This enum is decoupled
+    from internal ImageIntelligence types as they may diverge.
+    """
+
+    shot_type: Optional[
+        Literal[
+            "hero",
+            "lifestyle",
+            "on_model",
+            "detail",
+            "scale_reference",
+            "angle_view",
+            "flat_lay",
+            "in_use",
+            "packaging",
+            "size_chart",
+            "color_swatch",
+            "product_information",
+            "merchant_information",
+        ]
+    ] = None
+    """
+    Product image type classification for API responses. Note: This enum is
+    decoupled from internal ImageIntelligence types as they may diverge.
+    """
+
+
+class ProductDetail(BaseModel):
+    """A product with detailed information"""
+
+    id: str
+
+    availability: AvailabilityStatus
+
+    price: Price
+
+    title: str
+
+    url: str
+
+    brand_id: Optional[str] = None
+
+    brand_name: Optional[str] = None
+
+    categories: Optional[List[str]] = None
+
+    description: Optional[str] = None
+
+    gender: Optional[Literal["male", "female", "unisex"]] = None
+
+    image_urls: Optional[List[str]] = None
+    """List of image URLs (deprecated, use images field)"""
+
+    images: Optional[List[Image]] = None
+
+    key_features: Optional[List[str]] = None
+
+    materials: Optional[List[str]] = None
+
+    variants: Optional[List[Variant]] = None

channel3_sdk/types/product_retrieve_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+from .._types import SequenceNotStr
+from .redirect_mode import RedirectMode
+
+__all__ = ["ProductRetrieveParams"]
+
+
+class ProductRetrieveParams(TypedDict, total=False):
+    redirect_mode: Optional[RedirectMode]
+    """
+    "price" redirects to the product page with the lowest price "commission"
+    redirects to the product page with the highest commission rate "brand" redirects
+    to the brand's product page
+    """
+
+    website_ids: Optional[SequenceNotStr[str]]
+    """
+    Optional list of website IDs to constrain the buy URL to, relevant if multiple
+    merchants exist
+    """

channel3_sdk/types/redirect_mode.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["RedirectMode"]
+
+RedirectMode: TypeAlias = Literal["brand", "price", "commission"]

channel3_sdk/types/search_config_param.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+from .redirect_mode import RedirectMode
+
+__all__ = ["SearchConfigParam"]
+
+
+class SearchConfigParam(TypedDict, total=False):
+    """Configuration for a search request"""
+
+    keyword_search_only: bool
+    """If True, search will only use keyword search and not vector search.
+
+    Keyword-only search is not supported with image input.
+    """
+
+    redirect_mode: Optional[RedirectMode]
+    """
+    "price" redirects to the product page with the lowest price "commission"
+    redirects to the product page with the highest commission rate "brand" redirects
+    to the brand's product page
+    """

channel3_sdk/types/search_filter_price_param.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["SearchFilterPriceParam"]
+
+
+class SearchFilterPriceParam(TypedDict, total=False):
+    """Price filter. Values are inclusive."""
+
+    max_price: Optional[float]
+    """Maximum price, in dollars and cents"""
+
+    min_price: Optional[float]
+    """Minimum price, in dollars and cents"""

channel3_sdk/types/search_filters_param.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal, TypedDict
+
+from .._types import SequenceNotStr
+from .availability_status import AvailabilityStatus
+from .search_filter_price_param import SearchFilterPriceParam
+
+__all__ = ["SearchFiltersParam"]
+
+
+class SearchFiltersParam(TypedDict, total=False):
+    age: Optional[List[Literal["newborn", "infant", "toddler", "kids", "adult"]]]
+    """Filter by age group. Age-agnostic products are treated as adult products."""
+
+    availability: Optional[List[AvailabilityStatus]]
+    """If provided, only products with these availability statuses will be returned"""
+
+    brand_ids: Optional[SequenceNotStr[str]]
+    """If provided, only products from these brands will be returned"""
+
+    category_ids: Optional[SequenceNotStr[str]]
+    """If provided, only products from these categories will be returned"""
+
+    condition: Optional[Literal["new", "refurbished", "used"]]
+    """Filter by product condition.
+
+    Incubating: condition data is currently incomplete; products without condition
+    data will be included in all condition filter results.
+    """
+
+    exclude_product_ids: Optional[SequenceNotStr[str]]
+    """If provided, products with these IDs will be excluded from the results"""
+
+    gender: Optional[Literal["male", "female", "unisex"]]
+
+    price: Optional[SearchFilterPriceParam]
+    """Price filter. Values are inclusive."""
+
+    website_ids: Optional[SequenceNotStr[str]]
+    """If provided, only products from these websites will be returned"""

channel3_sdk/types/search_perform_params.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+from .search_config_param import SearchConfigParam
+from .search_filters_param import SearchFiltersParam
+
+__all__ = ["SearchPerformParams"]
+
+
+class SearchPerformParams(TypedDict, total=False):
+    base64_image: Optional[str]
+    """Base64 encoded image"""
+
+    config: SearchConfigParam
+    """Optional configuration"""
+
+    context: Optional[str]
+    """Optional customer information to personalize search results"""
+
+    filters: SearchFiltersParam
+    """Optional filters.
+
+    Search will only consider products that match all of the filters.
+    """
+
+    image_url: Optional[str]
+    """Image URL"""
+
+    limit: Optional[int]
+    """Optional limit on the number of results. Default is 20, max is 30."""
+
+    query: Optional[str]
+    """Search query"""

channel3_sdk/types/search_perform_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .product import Product
+
+__all__ = ["SearchPerformResponse"]
+
+SearchPerformResponse: TypeAlias = List[Product]

channel3_sdk/types/subscription.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["Subscription"]
+
+
+class Subscription(BaseModel):
+    canonical_product_id: str
+
+    created_at: datetime
+
+    subscription_status: Literal["active", "cancelled"]

channel3_sdk/types/variant.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["Variant"]
+
+
+class Variant(BaseModel):
+    image_url: str
+
+    product_id: str
+
+    title: str

channel3_sdk/types/website.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["Website"]
+
+
+class Website(BaseModel):
+    id: str
+
+    url: str
+
+    best_commission_rate: Optional[float] = None
+    """The maximum commission rate for the website, as a percentage"""

channel3_sdk/types/website_find_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["WebsiteFindParams"]
+
+
+class WebsiteFindParams(TypedDict, total=False):
+    query: Required[str]