simpleapps-com-augur-api 0.8.10__py3-none-any.whl

augur_api/services/basecamp2/schemas.py

@@ -0,0 +1,227 @@
+"""Schemas for the Basecamp2 service."""
+
+from pydantic import BaseModel
+
+from augur_api.core.schemas import CamelCaseModel, EdgeCacheParams
+
+
+# Health Check
+class HealthCheckData(CamelCaseModel):
+    """Health check response data."""
+
+    site_hash: str | None = None
+    site_id: str | None = None
+
+
+# Projects
+class ProjectListParams(EdgeCacheParams):
+    """Parameters for listing projects."""
+
+    limit: int | None = None
+    offset: int | None = None
+    archived_flag: str | None = None
+
+
+class Project(CamelCaseModel):
+    """Basecamp project entity."""
+
+    projects_uid: int | None = None
+    bc_project_id: int | None = None
+    name: str | None = None
+    description: str | None = None
+    status: str | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+# Todos
+class TodoListParams(EdgeCacheParams):
+    """Parameters for listing todos."""
+
+    limit: int | None = None
+    offset: int | None = None
+    order_by: str | None = None
+    completed_flag: str | None = None
+    projects_id: int | None = None
+
+
+class Todo(CamelCaseModel):
+    """Basecamp todo entity."""
+
+    todos_uid: int | None = None
+    bc_todo_id: int | None = None
+    content: str | None = None
+    completed: bool | None = None
+    due_at: str | None = None
+    assignee_id: int | None = None
+    project_id: int | None = None
+    todolist_id: int | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+class TodoCreateParams(BaseModel):
+    """Parameters for creating a todo."""
+
+    content: str
+    todolist_id: int
+    due_at: str | None = None
+    assignee_id: int | None = None
+
+
+class TodoUpdateParams(BaseModel):
+    """Parameters for updating a todo."""
+
+    content: str | None = None
+    completed: bool | None = None
+    due_at: str | None = None
+    assignee_id: int | None = None
+
+
+# People
+class PersonListParams(EdgeCacheParams):
+    """Parameters for listing people."""
+
+    limit: int | None = None
+    offset: int | None = None
+    order_by: str | None = None
+    q: str | None = None
+    admin_flag: str | None = None
+    trashed_flag: str | None = None
+
+
+class Person(CamelCaseModel):
+    """Basecamp person entity."""
+
+    people_uid: int | None = None
+    bc_person_id: int | None = None
+    name: str | None = None
+    email_address: str | None = None
+    avatar_url: str | None = None
+    admin: bool | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+# Comments
+class CommentListParams(EdgeCacheParams):
+    """Parameters for listing comments."""
+
+    limit: int | None = None
+    offset: int | None = None
+    order_by: str | None = None
+    creator_id: int | None = None
+    todos_id: int | None = None
+
+
+class Comment(CamelCaseModel):
+    """Basecamp comment entity."""
+
+    comments_uid: int | None = None
+    bc_comment_id: int | None = None
+    content: str | None = None
+    creator_id: int | None = None
+    todo_id: int | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+class CommentCreateParams(BaseModel):
+    """Parameters for creating a comment."""
+
+    content: str
+    todo_id: int
+
+
+# Events
+class EventListParams(EdgeCacheParams):
+    """Parameters for listing events."""
+
+    limit: int | None = None
+    offset: int | None = None
+    order_by: str | None = None
+    event_type_cd: str | None = None
+    id: int | None = None
+    people_id: int | None = None
+
+
+class Event(CamelCaseModel, extra="allow"):
+    """Basecamp event entity (passthrough for API flexibility)."""
+
+    events_uid: int | None = None
+
+
+# Metrics
+class MetricsListParams(EdgeCacheParams):
+    """Parameters for listing metrics."""
+
+    limit: int | None = None
+    offset: int | None = None
+    order_by: str | None = None
+    assignee_id: int | None = None
+    creator_id: int | None = None
+    has_comments: str | None = None
+    is_stale: str | None = None
+    needs_response: str | None = None
+    projects_id: int | None = None
+    todos_status_cd: str | None = None
+
+
+class Metric(CamelCaseModel, extra="allow"):
+    """Basecamp metric entity (passthrough for API flexibility)."""
+
+
+# Todolists
+class TodolistListParams(EdgeCacheParams):
+    """Parameters for listing todolists."""
+
+    limit: int | None = None
+    offset: int | None = None
+    order_by: str | None = None
+
+
+class Todolist(CamelCaseModel, extra="allow"):
+    """Basecamp todolist entity (passthrough for API flexibility)."""
+
+    todolists_uid: int | None = None
+    name: str | None = None
+
+
+# Todos Summary
+class TodosSummaryListParams(EdgeCacheParams):
+    """Parameters for listing todos summary."""
+
+    limit: int | None = None
+    offset: int | None = None
+    order_by: str | None = None
+    akasha_cd: int | None = None
+    process_cd: int | None = None
+
+
+class TodosSummary(CamelCaseModel, extra="allow"):
+    """Basecamp todos summary entity (passthrough for API flexibility)."""
+
+    todos_summary_uid: int | None = None
+
+
+# Sessions
+class SessionListParams(EdgeCacheParams):
+    """Parameters for listing sessions."""
+
+    limit: int | None = None
+    offset: int | None = None
+    session_status_cd: int | None = None
+
+
+class Session(CamelCaseModel, extra="allow"):
+    """Basecamp session entity (passthrough for API flexibility)."""
+
+    session_id: int | None = None
+
+
+class SessionCreateParams(BaseModel, extra="allow"):
+    """Parameters for creating a session (passthrough)."""
+
+
+class SessionUpdateParams(BaseModel, extra="allow"):
+    """Parameters for updating a session (passthrough)."""

augur_api/services/brand_folder/__init__.py

@@ -0,0 +1,31 @@
+"""Brand Folder service exports."""
+
+from augur_api.services.brand_folder.client import (
+    AssetsResource,
+    BrandFolderClient,
+    CategoriesResource,
+    CollectionsResource,
+)
+from augur_api.services.brand_folder.schemas import (
+    Asset,
+    AssetCreateParams,
+    AssetListParams,
+    Category,
+    CategoryListParams,
+    Collection,
+    CollectionListParams,
+)
+
+__all__ = [
+    "Asset",
+    "AssetCreateParams",
+    "AssetListParams",
+    "AssetsResource",
+    "BrandFolderClient",
+    "CategoriesResource",
+    "Category",
+    "CategoryListParams",
+    "Collection",
+    "CollectionListParams",
+    "CollectionsResource",
+]

augur_api/services/brand_folder/client.py

@@ -0,0 +1,206 @@
+"""Brand Folder service client for digital asset management."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from augur_api.core.http_client import HTTPClient
+from augur_api.core.schemas import BaseResponse
+from augur_api.services.base import BaseServiceClient
+from augur_api.services.brand_folder.schemas import (
+    Asset,
+    AssetListParams,
+    Category,
+    CategoryFocusResult,
+    CategoryListParams,
+    Collection,
+    CollectionListParams,
+)
+from augur_api.services.resource import BaseResource
+
+
+class AssetsResource(BaseResource):
+    """Resource for /assets endpoints."""
+
+    def __init__(self, http: HTTPClient) -> None:
+        """Initialize the resource."""
+        super().__init__(http, "/assets")
+
+    def list(self, params: AssetListParams | None = None) -> BaseResponse[list[Asset]]:
+        """List assets.
+
+        Args:
+            params: Optional query parameters for filtering and pagination.
+
+        Returns:
+            BaseResponse containing a list of Asset items.
+        """
+        response = self._get(params=params)
+        return BaseResponse[list[Asset]].model_validate(response)
+
+    def get(self, assets_uid: int) -> BaseResponse[Asset]:
+        """Get asset by UID.
+
+        Args:
+            assets_uid: The asset UID.
+
+        Returns:
+            BaseResponse containing the Asset.
+        """
+        response = self._get(f"/{assets_uid}")
+        return BaseResponse[Asset].model_validate(response)
+
+    def create(self, data: Any) -> BaseResponse[Asset]:
+        """Create a new asset.
+
+        Args:
+            data: The asset data to create.
+
+        Returns:
+            BaseResponse containing the created Asset.
+        """
+        response = self._post(data=data)
+        return BaseResponse[Asset].model_validate(response)
+
+
+class CategoriesFocusResource(BaseResource):
+    """Resource for /categories/focus endpoints."""
+
+    def __init__(self, http: HTTPClient) -> None:
+        """Initialize the resource."""
+        super().__init__(http, "/categories/focus")
+
+    def create(self, data: Any) -> BaseResponse[CategoryFocusResult]:
+        """Set category focus configuration.
+
+        Args:
+            data: Category focus configuration parameters.
+
+        Returns:
+            BaseResponse containing the CategoryFocusResult.
+        """
+        response = self._post(data=data)
+        return BaseResponse[CategoryFocusResult].model_validate(response)
+
+
+class CategoriesResource(BaseResource):
+    """Resource for /categories endpoints."""
+
+    def __init__(self, http: HTTPClient) -> None:
+        """Initialize the resource."""
+        super().__init__(http, "/categories")
+        self._focus: CategoriesFocusResource | None = None
+
+    @property
+    def focus(self) -> CategoriesFocusResource:
+        """Access category focus endpoints."""
+        if self._focus is None:
+            self._focus = CategoriesFocusResource(self._http)
+        return self._focus
+
+    def list(self, params: CategoryListParams | None = None) -> BaseResponse[list[Category]]:
+        """List categories.
+
+        Args:
+            params: Optional query parameters for filtering and pagination.
+
+        Returns:
+            BaseResponse containing a list of Category items.
+        """
+        response = self._get(params=params)
+        return BaseResponse[list[Category]].model_validate(response)
+
+    def get(self, categories_uid: int) -> BaseResponse[Category]:
+        """Get category by UID.
+
+        Args:
+            categories_uid: The category UID.
+
+        Returns:
+            BaseResponse containing the Category.
+        """
+        response = self._get(f"/{categories_uid}")
+        return BaseResponse[Category].model_validate(response)
+
+
+class CollectionsResource(BaseResource):
+    """Resource for /collections endpoints."""
+
+    def __init__(self, http: HTTPClient) -> None:
+        """Initialize the resource."""
+        super().__init__(http, "/collections")
+
+    def list(self, params: CollectionListParams | None = None) -> BaseResponse[list[Collection]]:
+        """List collections.
+
+        Args:
+            params: Optional query parameters for filtering and pagination.
+
+        Returns:
+            BaseResponse containing a list of Collection items.
+        """
+        response = self._get(params=params)
+        return BaseResponse[list[Collection]].model_validate(response)
+
+    def get(self, collections_uid: int) -> BaseResponse[Collection]:
+        """Get collection by UID.
+
+        Args:
+            collections_uid: The collection UID.
+
+        Returns:
+            BaseResponse containing the Collection.
+        """
+        response = self._get(f"/{collections_uid}")
+        return BaseResponse[Collection].model_validate(response)
+
+
+class BrandFolderClient(BaseServiceClient):
+    """Client for the Brand Folder service.
+
+    Provides access to digital asset management endpoints including:
+    - Health check (health_check)
+    - Assets (assets)
+    - Categories (categories)
+    - Collections (collections)
+
+    Example:
+        >>> from augur_api import AugurAPI
+        >>> api = AugurAPI(token="...", site_id="...")
+        >>> assets = api.brand_folder.assets.list()
+        >>> for asset in assets.data:
+        ...     print(asset.name)
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        """Initialize the Brand Folder client.
+
+        Args:
+            http_client: HTTP client for making requests.
+        """
+        super().__init__(http_client)
+        self._assets: AssetsResource | None = None
+        self._categories: CategoriesResource | None = None
+        self._collections: CollectionsResource | None = None
+
+    @property
+    def assets(self) -> AssetsResource:
+        """Access assets endpoints."""
+        if self._assets is None:
+            self._assets = AssetsResource(self._http)
+        return self._assets
+
+    @property
+    def categories(self) -> CategoriesResource:
+        """Access categories endpoints."""
+        if self._categories is None:
+            self._categories = CategoriesResource(self._http)
+        return self._categories
+
+    @property
+    def collections(self) -> CollectionsResource:
+        """Access collections endpoints."""
+        if self._collections is None:
+            self._collections = CollectionsResource(self._http)
+        return self._collections

augur_api/services/brand_folder/schemas.py

@@ -0,0 +1,133 @@
+"""Schemas for the Brand Folder service."""
+
+from pydantic import BaseModel
+
+from augur_api.core.schemas import CamelCaseModel, EdgeCacheParams
+
+
+# Health Check
+class HealthCheckData(CamelCaseModel):
+    """Health check response data."""
+
+    site_hash: str | None = None
+    site_id: str | None = None
+
+
+# Assets
+class AssetListParams(EdgeCacheParams):
+    """Parameters for listing assets."""
+
+    limit: int | None = None
+    offset: int | None = None
+    section_id: str | None = None
+    collection_id: str | None = None
+
+
+class Asset(CamelCaseModel):
+    """Brand folder asset entity."""
+
+    assets_uid: int | None = None
+    bf_asset_id: str | None = None
+    name: str | None = None
+    description: str | None = None
+    file_type: str | None = None
+    file_size: int | None = None
+    cdn_url: str | None = None
+    thumbnail_url: str | None = None
+    section_id: str | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+class AssetCreateParams(BaseModel):
+    """Parameters for creating an asset."""
+
+    name: str
+    section_id: str
+    description: str | None = None
+
+
+# Categories
+class CategoryListParams(EdgeCacheParams):
+    """Parameters for listing categories."""
+
+    limit: int | None = None
+    offset: int | None = None
+
+
+class Category(CamelCaseModel):
+    """Brand folder category entity."""
+
+    categories_uid: int | None = None
+    bf_category_id: str | None = None
+    name: str | None = None
+    slug: str | None = None
+    parent_id: str | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+class CategoryFocusParams(BaseModel):
+    """Parameters for setting category focus configuration."""
+
+    # Category identification
+    category_id: str | None = None
+    category_name: str | None = None
+    category_slug: str | None = None
+    # Focus configuration
+    focus_level: str | None = None  # 'primary', 'secondary', 'tertiary'
+    priority: int | None = None  # 1-100
+    is_active: bool | None = None
+    # Brand association
+    brand_id: str | None = None
+    brand_name: str | None = None
+    # Metadata
+    description: str | None = None
+    tags: list[str] | None = None
+    start_date: str | None = None
+    end_date: str | None = None
+    # Configuration options
+    display_order: int | None = None
+    visibility: str | None = None  # 'public', 'private', 'draft'
+    featured: bool | None = None
+
+
+class CategoryFocusResult(CamelCaseModel):
+    """Result of category focus configuration."""
+
+    category_id: str | None = None
+    category_name: str | None = None
+    category_slug: str | None = None
+    focus_level: str | None = None
+    priority: int | None = None
+    is_active: bool | None = None
+    brand_id: str | None = None
+    brand_name: str | None = None
+    display_order: int | None = None
+    visibility: str | None = None
+    featured: bool | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+    effective_date: str | None = None
+    expiration_date: str | None = None
+
+
+# Collections
+class CollectionListParams(EdgeCacheParams):
+    """Parameters for listing collections."""
+
+    limit: int | None = None
+    offset: int | None = None
+
+
+class Collection(CamelCaseModel):
+    """Brand folder collection entity."""
+
+    collections_uid: int | None = None
+    bf_collection_id: str | None = None
+    name: str | None = None
+    description: str | None = None
+    slug: str | None = None
+    public: bool | None = None
+    created_at: str | None = None
+    updated_at: str | None = None

augur_api/services/commerce/__init__.py

@@ -0,0 +1,56 @@
+"""Commerce service exports."""
+
+from augur_api.services.commerce.client import (
+    CartHdrResource,
+    CartLineResource,
+    CheckoutResource,
+    CommerceClient,
+)
+from augur_api.services.commerce.schemas import (
+    AlsoBoughtItem,
+    AlsoBoughtParams,
+    CartHdr,
+    CartHdrListParams,
+    CartHdrLookupParams,
+    CartLine,
+    CartLineAddItem,
+    CartLineDeleteResponse,
+    CartLineUpdateItem,
+    Checkout,
+    CheckoutCreateParams,
+    CheckoutDoc,
+    CheckoutDocParams,
+    HealthCheckData,
+    Prophet21Hdr,
+    Prophet21Line,
+)
+
+__all__ = [
+    # Client
+    "CommerceClient",
+    # Resources
+    "CartHdrResource",
+    "CartLineResource",
+    "CheckoutResource",
+    # Health check
+    "HealthCheckData",
+    # Cart header schemas
+    "CartHdr",
+    "CartHdrListParams",
+    "CartHdrLookupParams",
+    "AlsoBoughtParams",
+    "AlsoBoughtItem",
+    # Cart line schemas
+    "CartLine",
+    "CartLineAddItem",
+    "CartLineUpdateItem",
+    "CartLineDeleteResponse",
+    # Checkout schemas
+    "Checkout",
+    "CheckoutCreateParams",
+    "CheckoutDoc",
+    "CheckoutDocParams",
+    # Prophet21 schemas
+    "Prophet21Hdr",
+    "Prophet21Line",
+]