superb-ai-onprem 0.9.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

spb_onprem/reports/__init__.py

@@ -0,0 +1,25 @@
+from .service import ReportService
+from .entities import (
+    AnalyticsReport,
+    AnalyticsReportItem,
+    AnalyticsReportItemType,
+    AnalyticsReportPageInfo,
+)
+from .params import (
+    AnalyticsReportsFilter,
+    AnalyticsReportsFilterOptions,
+    AnalyticsReportsOrderBy,
+    AnalyticsReportListOrderFields,
+)
+
+__all__ = (
+    "ReportService",
+    "AnalyticsReport",
+    "AnalyticsReportItem",
+    "AnalyticsReportItemType",
+    "AnalyticsReportPageInfo",
+    "AnalyticsReportsFilter",
+    "AnalyticsReportsFilterOptions",
+    "AnalyticsReportsOrderBy",
+    "AnalyticsReportListOrderFields",
+)

spb_onprem/reports/entities/__init__.py

@@ -0,0 +1,10 @@
+from .analytics_report import AnalyticsReport
+from .analytics_report_item import AnalyticsReportItem, AnalyticsReportItemType
+from .analytics_report_page_info import AnalyticsReportPageInfo
+
+__all__ = (
+    "AnalyticsReport",
+    "AnalyticsReportItem",
+    "AnalyticsReportItemType",
+    "AnalyticsReportPageInfo",
+)

spb_onprem/reports/entities/analytics_report.py

@@ -0,0 +1,22 @@
+from typing import Optional, List, Any
+from spb_onprem.base_model import CustomBaseModel, Field
+from .analytics_report_item import AnalyticsReportItem
+
+
+class AnalyticsReport(CustomBaseModel):
+    """
+    분석 리포트 엔터티
+    
+    데이터셋의 분석 리포트를 나타냅니다.
+    여러 개의 리포트 아이템(차트, 그래프 등)으로 구성됩니다.
+    """
+    id: Optional[str] = Field(None, description="리포트 고유 식별자")
+    dataset_id: Optional[str] = Field(None, alias="datasetId", description="이 리포트가 속한 데이터셋 ID")
+    title: Optional[str] = Field(None, description="리포트 제목")
+    description: Optional[str] = Field(None, description="리포트 설명")
+    meta: Optional[dict] = Field(None, description="추가 메타데이터 (JSONObject)")
+    created_at: Optional[str] = Field(None, alias="createdAt", description="생성일시 (ISO 8601)")
+    created_by: Optional[str] = Field(None, alias="createdBy", description="생성자")
+    updated_at: Optional[str] = Field(None, alias="updatedAt", description="수정일시 (ISO 8601)")
+    updated_by: Optional[str] = Field(None, alias="updatedBy", description="수정자")
+    items: Optional[List[AnalyticsReportItem]] = Field(None, description="리포트 아이템 목록")

spb_onprem/reports/entities/analytics_report_item.py

@@ -0,0 +1,30 @@
+from typing import Optional, Any
+from enum import Enum
+from spb_onprem.base_model import CustomBaseModel, Field
+from spb_onprem.contents.entities.base_content import BaseContent
+
+
+class AnalyticsReportItemType(str, Enum):
+    """분석 리포트 아이템 타입"""
+    PIE = "PIE"
+    HORIZONTAL_BAR = "HORIZONTAL_BAR"
+    VERTICAL_BAR = "VERTICAL_BAR"
+    HEATMAP = "HEATMAP"
+
+
+class AnalyticsReportItem(CustomBaseModel):
+    """
+    분석 리포트 아이템 엔터티
+    
+    리포트 내의 개별 차트나 시각화 아이템을 나타냅니다.
+    """
+    id: Optional[str] = Field(None, description="리포트 아이템 고유 식별자")
+    type: Optional[AnalyticsReportItemType] = Field(None, description="리포트 아이템 타입 (PIE, BAR, HEATMAP 등)")
+    title: Optional[str] = Field(None, description="리포트 아이템 제목")
+    description: Optional[str] = Field(None, description="리포트 아이템 설명")
+    content: Optional[BaseContent] = Field(None, description="리포트 아이템 컨텐츠")
+    meta: Optional[Any] = Field(None, description="추가 메타데이터 (JSONObject)")
+    created_at: Optional[str] = Field(None, alias="createdAt", description="생성일시 (ISO 8601)")
+    created_by: Optional[str] = Field(None, alias="createdBy", description="생성자")
+    updated_at: Optional[str] = Field(None, alias="updatedAt", description="수정일시 (ISO 8601)")
+    updated_by: Optional[str] = Field(None, alias="updatedBy", description="수정자")

spb_onprem/reports/entities/analytics_report_page_info.py

@@ -0,0 +1,14 @@
+from typing import Optional, List
+from spb_onprem.base_model import CustomBaseModel, Field
+from .analytics_report import AnalyticsReport
+
+
+class AnalyticsReportPageInfo(CustomBaseModel):
+    """
+    분석 리포트 페이지 정보 엔터티
+    
+    분석 리포트 목록 조회 시 페이지네이션 정보를 포함합니다.
+    """
+    analytics_reports: Optional[List[AnalyticsReport]] = Field(None, alias="analyticsReports", description="쿼리와 일치하는 리포트 목록")
+    next: Optional[str] = Field(None, description="페이지네이션에 사용할 커서")
+    total_count: Optional[int] = Field(None, alias="totalCount", description="쿼리와 일치하는 리포트의 총 개수")

spb_onprem/reports/params/__init__.py

@@ -0,0 +1,29 @@
+from .analytics_report import analytics_report_params
+from .analytics_reports import (
+    analytics_reports_params,
+    AnalyticsReportsFilter,
+    AnalyticsReportsFilterOptions,
+    AnalyticsReportsOrderBy,
+    AnalyticsReportListOrderFields,
+)
+from .create_analytics_report import create_analytics_report_params
+from .update_analytics_report import update_analytics_report_params
+from .delete_analytics_report import delete_analytics_report_params
+from .create_analytics_report_item import create_analytics_report_item_params
+from .update_analytics_report_item import update_analytics_report_item_params
+from .delete_analytics_report_item import delete_analytics_report_item_params
+
+__all__ = (
+    "analytics_report_params",
+    "analytics_reports_params",
+    "create_analytics_report_params",
+    "update_analytics_report_params",
+    "delete_analytics_report_params",
+    "create_analytics_report_item_params",
+    "update_analytics_report_item_params",
+    "delete_analytics_report_item_params",
+    "AnalyticsReportsFilter",
+    "AnalyticsReportsFilterOptions",
+    "AnalyticsReportsOrderBy",
+    "AnalyticsReportListOrderFields",
+)

spb_onprem/reports/params/analytics_report.py

@@ -0,0 +1,17 @@
+def analytics_report_params(
+    report_id: str,
+    dataset_id: str,
+):
+    """Get parameters for retrieving a single analytics report.
+    
+    Args:
+        report_id: The report ID
+        dataset_id: The dataset ID
+        
+    Returns:
+        dict: Parameters for retrieving an analytics report
+    """
+    return {
+        "reportId": report_id,
+        "datasetId": dataset_id,
+    }

spb_onprem/reports/params/analytics_reports.py

@@ -0,0 +1,87 @@
+from typing import Optional, Union
+from enum import Enum
+
+from spb_onprem.base_model import CustomBaseModel, Field
+from spb_onprem.base_types import Undefined, UndefinedType
+
+
+class AnalyticsReportListOrderFields(str, Enum):
+    """분석 리포트 정렬 필드"""
+    UPDATED_AT = "updatedAt"
+    CREATED_AT = "createdAt"
+    TITLE = "title"
+
+
+class AnalyticsReportsFilterOptions(CustomBaseModel):
+    """Options for filtering analytics reports.
+    
+    Attributes:
+        title_contains: Filter reports by title containing this string
+    """
+    title_contains: Optional[str] = Field(None, alias="titleContains")
+
+
+class AnalyticsReportsFilter(CustomBaseModel):
+    """Filter criteria for analytics report queries.
+    
+    Attributes:
+        must_filter: Conditions that must be met
+        not_filter: Conditions that must not be met
+    """
+    must_filter: Optional[AnalyticsReportsFilterOptions] = Field(None, alias="must")
+    not_filter: Optional[AnalyticsReportsFilterOptions] = Field(None, alias="not")
+
+
+class AnalyticsReportsOrderBy(CustomBaseModel):
+    """Order by options for analytics reports.
+    
+    Attributes:
+        field: The field to order by
+        direction: The direction to order (ASC or DESC)
+    """
+    field: Optional[AnalyticsReportListOrderFields] = Field(None, description="정렬 필드")
+    direction: Optional[str] = Field(None, description="정렬 방향 (ASC or DESC)")
+
+
+def analytics_reports_params(
+    dataset_id: str,
+    analytics_reports_filter: Union[
+        AnalyticsReportsFilter,
+        UndefinedType
+    ] = Undefined,
+    cursor: Optional[str] = None,
+    length: Optional[int] = 10,
+    order_by: Union[
+        AnalyticsReportsOrderBy,
+        UndefinedType
+    ] = Undefined,
+):
+    """Get parameters for listing analytics reports.
+    
+    Args:
+        dataset_id: Required dataset ID
+        analytics_reports_filter: Optional filter criteria for reports
+        cursor: Optional cursor for pagination
+        length: Optional number of items per page (default: 10)
+        order_by: Optional order by options
+        
+    Returns:
+        dict: Parameters for listing analytics reports
+    """
+    params = {
+        "datasetId": dataset_id,
+        "cursor": cursor,
+        "length": length,
+    }
+    
+    if analytics_reports_filter and not isinstance(analytics_reports_filter, UndefinedType):
+        params["filter"] = analytics_reports_filter.model_dump(
+            by_alias=True, exclude_unset=True
+        )
+    
+    if order_by and not isinstance(order_by, UndefinedType):
+        params["orderBy"] = order_by.model_dump(
+            by_alias=True, exclude_unset=True
+        )
+    
+    return params

spb_onprem/reports/params/create_analytics_report.py

@@ -0,0 +1,35 @@
+from typing import Union, Any
+from spb_onprem.base_types import Undefined, UndefinedType
+
+
+def create_analytics_report_params(
+    dataset_id: str,
+    title: Union[str, UndefinedType] = Undefined,
+    description: Union[str, UndefinedType] = Undefined,
+    meta: Union[Any, UndefinedType] = Undefined,
+):
+    """Get parameters for creating an analytics report.
+    
+    Args:
+        dataset_id: The dataset ID
+        title: Optional report title
+        description: Optional report description
+        meta: Optional metadata
+        
+    Returns:
+        dict: Parameters for creating an analytics report
+    """
+    params = {
+        "datasetId": dataset_id,
+    }
+    
+    if not isinstance(title, UndefinedType):
+        params["title"] = title
+    
+    if not isinstance(description, UndefinedType):
+        params["description"] = description
+    
+    if not isinstance(meta, UndefinedType):
+        params["meta"] = meta
+    
+    return params

spb_onprem/reports/params/create_analytics_report_item.py

@@ -0,0 +1,47 @@
+from typing import Union, Any
+from spb_onprem.base_types import Undefined, UndefinedType
+from spb_onprem.reports.entities.analytics_report_item import AnalyticsReportItemType
+
+
+def create_analytics_report_item_params(
+    dataset_id: str,
+    report_id: str,
+    type: AnalyticsReportItemType,
+    title: Union[str, UndefinedType] = Undefined,
+    description: Union[str, UndefinedType] = Undefined,
+    content_id: Union[str, UndefinedType] = Undefined,
+    meta: Union[Any, UndefinedType] = Undefined,
+):
+    """Get parameters for creating an analytics report item.
+    
+    Args:
+        dataset_id: The dataset ID
+        report_id: The report ID
+        type: The type of report item (PIE, HORIZONTAL_BAR, etc.)
+        title: Optional item title
+        description: Optional item description
+        content_id: Optional content ID
+        meta: Optional metadata
+        
+    Returns:
+        dict: Parameters for creating an analytics report item
+    """
+    params = {
+        "datasetId": dataset_id,
+        "reportId": report_id,
+        "type": type.value if isinstance(type, AnalyticsReportItemType) else type,
+    }
+    
+    if not isinstance(title, UndefinedType):
+        params["title"] = title
+    
+    if not isinstance(description, UndefinedType):
+        params["description"] = description
+    
+    if not isinstance(content_id, UndefinedType):
+        params["contentId"] = content_id
+    
+    if not isinstance(meta, UndefinedType):
+        params["meta"] = meta
+    
+    return params

spb_onprem/reports/params/delete_analytics_report.py

@@ -0,0 +1,17 @@
+def delete_analytics_report_params(
+    report_id: str,
+    dataset_id: str,
+):
+    """Get parameters for deleting an analytics report.
+    
+    Args:
+        report_id: The report ID
+        dataset_id: The dataset ID
+        
+    Returns:
+        dict: Parameters for deleting an analytics report
+    """
+    return {
+        "reportId": report_id,
+        "datasetId": dataset_id,
+    }

spb_onprem/reports/params/delete_analytics_report_item.py

@@ -0,0 +1,20 @@
+def delete_analytics_report_item_params(
+    item_id: str,
+    report_id: str,
+    dataset_id: str,
+):
+    """Get parameters for deleting an analytics report item.
+    
+    Args:
+        item_id: The item ID
+        report_id: The report ID
+        dataset_id: The dataset ID
+        
+    Returns:
+        dict: Parameters for deleting an analytics report item
+    """
+    return {
+        "itemId": item_id,
+        "reportId": report_id,
+        "datasetId": dataset_id,
+    }

spb_onprem/reports/params/update_analytics_report.py

@@ -0,0 +1,38 @@
+from typing import Union, Any
+from spb_onprem.base_types import Undefined, UndefinedType
+
+
+def update_analytics_report_params(
+    dataset_id: str,
+    report_id: str,
+    title: Union[str, UndefinedType] = Undefined,
+    description: Union[str, UndefinedType] = Undefined,
+    meta: Union[Any, UndefinedType] = Undefined,
+):
+    """Get parameters for updating an analytics report.
+    
+    Args:
+        dataset_id: The dataset ID
+        report_id: The report ID
+        title: Optional new title
+        description: Optional new description
+        meta: Optional new metadata
+        
+    Returns:
+        dict: Parameters for updating an analytics report
+    """
+    params = {
+        "datasetId": dataset_id,
+        "reportId": report_id,
+    }
+    
+    if not isinstance(title, UndefinedType):
+        params["title"] = title
+    
+    if not isinstance(description, UndefinedType):
+        params["description"] = description
+    
+    if not isinstance(meta, UndefinedType):
+        params["meta"] = meta
+    
+    return params

spb_onprem/reports/params/update_analytics_report_item.py

@@ -0,0 +1,46 @@
+from typing import Union, Any
+from spb_onprem.base_types import Undefined, UndefinedType
+
+
+def update_analytics_report_item_params(
+    dataset_id: str,
+    report_id: str,
+    item_id: str,
+    title: Union[str, UndefinedType] = Undefined,
+    description: Union[str, UndefinedType] = Undefined,
+    content_id: Union[str, UndefinedType] = Undefined,
+    meta: Union[Any, UndefinedType] = Undefined,
+):
+    """Get parameters for updating an analytics report item.
+    
+    Args:
+        dataset_id: The dataset ID
+        report_id: The report ID
+        item_id: The item ID
+        title: Optional new title
+        description: Optional new description
+        content_id: Optional new content ID
+        meta: Optional new metadata
+        
+    Returns:
+        dict: Parameters for updating an analytics report item
+    """
+    params = {
+        "datasetId": dataset_id,
+        "reportId": report_id,
+        "itemId": item_id,
+    }
+    
+    if not isinstance(title, UndefinedType):
+        params["title"] = title
+    
+    if not isinstance(description, UndefinedType):
+        params["description"] = description
+    
+    if not isinstance(content_id, UndefinedType):
+        params["contentId"] = content_id
+    
+    if not isinstance(meta, UndefinedType):
+        params["meta"] = meta
+    
+    return params

spb_onprem/reports/queries.py

@@ -0,0 +1,239 @@
+from spb_onprem.reports.params import (
+    analytics_report_params,
+    analytics_reports_params,
+    create_analytics_report_params,
+    update_analytics_report_params,
+    delete_analytics_report_params,
+    create_analytics_report_item_params,
+    update_analytics_report_item_params,
+    delete_analytics_report_item_params,
+)
+
+
+class Schemas:
+    ANALYTICS_REPORT_ITEM = '''
+        id
+        type
+        title
+        description
+        content {
+            id
+            downloadURL
+        }
+        meta
+        createdAt
+        createdBy
+        updatedAt
+        updatedBy
+    '''
+    
+    ANALYTICS_REPORT = '''
+        datasetId
+        id
+        title
+        description
+        meta
+        createdAt
+        updatedAt
+        createdBy
+        updatedBy
+        items {
+            id
+            type
+            title
+            description
+            content {
+                id
+                downloadURL
+            }
+            meta
+            createdAt
+            createdBy
+            updatedAt
+            updatedBy
+        }
+    '''
+
+
+class Queries():
+    ANALYTICS_REPORT = {
+        "name": "analyticsReport",
+        "query": f'''
+            query AnalyticsReport(
+                $reportId: ID!,
+                $datasetId: String!
+            ) {{
+                analyticsReport(
+                    reportId: $reportId,
+                    datasetId: $datasetId
+                ) {{
+                    {Schemas.ANALYTICS_REPORT}
+                }}
+            }}
+        ''',
+        "variables": analytics_report_params,
+    }
+    
+    ANALYTICS_REPORTS = {
+        "name": "analyticsReports",
+        "query": f'''
+            query AnalyticsReports(
+                $datasetId: ID!,
+                $filter: AnalyticsReportFilter,
+                $cursor: String,
+                $length: Int,
+                $orderBy: AnalyticsReportOrderBy
+            ) {{
+                analyticsReports(
+                    datasetId: $datasetId,
+                    filter: $filter,
+                    cursor: $cursor,
+                    length: $length,
+                    orderBy: $orderBy
+                ) {{
+                    analyticsReports {{
+                        {Schemas.ANALYTICS_REPORT}
+                    }}
+                    next
+                    totalCount
+                }}
+            }}
+        ''',
+        "variables": analytics_reports_params,
+    }
+    
+    CREATE_ANALYTICS_REPORT = {
+        "name": "createAnalyticsReport",
+        "query": f'''
+            mutation CreateAnalyticsReport(
+                $datasetId: ID!,
+                $title: String,
+                $description: String,
+                $meta: JSONObject
+            ) {{
+                createAnalyticsReport(
+                    datasetId: $datasetId,
+                    title: $title,
+                    description: $description,
+                    meta: $meta
+                ) {{
+                    {Schemas.ANALYTICS_REPORT}
+                }}
+            }}
+        ''',
+        "variables": create_analytics_report_params,
+    }
+    
+    UPDATE_ANALYTICS_REPORT = {
+        "name": "updateAnalyticsReport",
+        "query": f'''
+            mutation UpdateAnalyticsReport(
+                $datasetId: ID!,
+                $reportId: ID!,
+                $title: String,
+                $description: String,
+                $meta: JSONObject
+            ) {{
+                updateAnalyticsReport(
+                    datasetId: $datasetId,
+                    reportId: $reportId,
+                    title: $title,
+                    description: $description,
+                    meta: $meta
+                ) {{
+                    {Schemas.ANALYTICS_REPORT}
+                }}
+            }}
+        ''',
+        "variables": update_analytics_report_params,
+    }
+    
+    DELETE_ANALYTICS_REPORT = {
+        "name": "deleteAnalyticsReport",
+        "query": '''
+            mutation DeleteAnalyticsReport(
+                $reportId: String!,
+                $datasetId: String!
+            ) {
+                deleteAnalyticsReport(
+                    reportId: $reportId,
+                    datasetId: $datasetId
+                )
+            }
+        ''',
+        "variables": delete_analytics_report_params,
+    }
+    
+    CREATE_ANALYTICS_REPORT_ITEM = {
+        "name": "createAnalyticsReportItem",
+        "query": f'''
+            mutation CreateAnalyticsReportItem(
+                $datasetId: ID!,
+                $reportId: ID!,
+                $type: AnalyticsReportItemType!,
+                $title: String,
+                $description: String,
+                $contentId: String,
+                $meta: JSONObject
+            ) {{
+                createAnalyticsReportItem(
+                    datasetId: $datasetId,
+                    reportId: $reportId,
+                    type: $type,
+                    title: $title,
+                    description: $description,
+                    contentId: $contentId,
+                    meta: $meta
+                ) {{
+                    {Schemas.ANALYTICS_REPORT_ITEM}
+                }}
+            }}
+        ''',
+        "variables": create_analytics_report_item_params,
+    }
+    
+    UPDATE_ANALYTICS_REPORT_ITEM = {
+        "name": "updateAnalyticsReportItem",
+        "query": f'''
+            mutation UpdateAnalyticsReportItem(
+                $datasetId: ID!,
+                $reportId: ID!,
+                $itemId: ID!,
+                $title: String,
+                $description: String,
+                $contentId: String,
+                $meta: JSONObject
+            ) {{
+                updateAnalyticsReportItem(
+                    datasetId: $datasetId,
+                    reportId: $reportId,
+                    itemId: $itemId,
+                    title: $title,
+                    description: $description,
+                    contentId: $contentId,
+                    meta: $meta
+                ) {{
+                    {Schemas.ANALYTICS_REPORT_ITEM}
+                }}
+            }}
+        ''',
+        "variables": update_analytics_report_item_params,
+    }
+    
+    DELETE_ANALYTICS_REPORT_ITEM = {
+        "name": "deleteAnalyticsReportItem",
+        "query": '''
+            mutation DeleteAnalyticsReportItem(
+                $itemId: String!,
+                $reportId: String!,
+                $datasetId: String!
+            ) {
+                deleteAnalyticsReportItem(
+                    itemId: $itemId,
+                    reportId: $reportId,
+                    datasetId: $datasetId
+                )
+            }
+        ''',
+        "variables": delete_analytics_report_item_params,
+    }