feedrequest.py

"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""

from __future__ import annotations
from .feedrequestoptions import FeedRequestOptions, FeedRequestOptionsTypedDict
from .sessioninfo import SessionInfo, SessionInfoTypedDict
from enum import Enum
from glean.api_client.types import BaseModel, UNSET_SENTINEL
import pydantic
from pydantic import model_serializer
from typing import List, Optional
from typing_extensions import Annotated, NotRequired, TypedDict


class FeedRequestCategory(str, Enum):
    DOCUMENT_SUGGESTION = "DOCUMENT_SUGGESTION"
    DOCUMENT_SUGGESTION_SCENARIO = "DOCUMENT_SUGGESTION_SCENARIO"
    TRENDING_DOCUMENT = "TRENDING_DOCUMENT"
    VERIFICATION_REMINDER = "VERIFICATION_REMINDER"
    EVENT = "EVENT"
    ANNOUNCEMENT = "ANNOUNCEMENT"
    MENTION = "MENTION"
    DATASOURCE_AFFINITY = "DATASOURCE_AFFINITY"
    RECENT = "RECENT"
    COMPANY_RESOURCE = "COMPANY_RESOURCE"
    EXPERIMENTAL = "EXPERIMENTAL"
    PEOPLE_CELEBRATIONS = "PEOPLE_CELEBRATIONS"
    DISPLAYABLE_LIST = "DISPLAYABLE_LIST"
    SOCIAL_LINK = "SOCIAL_LINK"
    EXTERNAL_TASKS = "EXTERNAL_TASKS"
    WORKFLOW_COLLECTIONS = "WORKFLOW_COLLECTIONS"
    ZERO_STATE_CHAT_SUGGESTION = "ZERO_STATE_CHAT_SUGGESTION"
    ZERO_STATE_CHAT_TOOL_SUGGESTION = "ZERO_STATE_CHAT_TOOL_SUGGESTION"
    ZERO_STATE_WORKFLOW_CREATED_BY_ME = "ZERO_STATE_WORKFLOW_CREATED_BY_ME"
    ZERO_STATE_WORKFLOW_FAVORITES = "ZERO_STATE_WORKFLOW_FAVORITES"
    ZERO_STATE_WORKFLOW_POPULAR = "ZERO_STATE_WORKFLOW_POPULAR"
    ZERO_STATE_WORKFLOW_RECENT = "ZERO_STATE_WORKFLOW_RECENT"
    ZERO_STATE_WORKFLOW_SUGGESTION = "ZERO_STATE_WORKFLOW_SUGGESTION"
    PERSONALIZED_CHAT_SUGGESTION = "PERSONALIZED_CHAT_SUGGESTION"
    DAILY_DIGEST = "DAILY_DIGEST"
    TASK = "TASK"
    PLAN_MY_DAY = "PLAN_MY_DAY"
    END_MY_DAY = "END_MY_DAY"
    STARTER_KIT = "STARTER_KIT"
    MID_DAY_CATCH_UP = "MID_DAY_CATCH_UP"
    QUERY_SUGGESTION = "QUERY_SUGGESTION"
    WEEKLY_MEETINGS = "WEEKLY_MEETINGS"
    FOLLOW_UP = "FOLLOW_UP"
    MILESTONE_TIMELINE_CHECK = "MILESTONE_TIMELINE_CHECK"
    PROJECT_DISCUSSION_DIGEST = "PROJECT_DISCUSSION_DIGEST"
    PROJECT_NEXT_STEP = "PROJECT_NEXT_STEP"


class FeedRequestTypedDict(TypedDict):
    categories: NotRequired[List[FeedRequestCategory]]
    r"""Categories of content requested. An allowlist gives flexibility to request content separately or together."""
    request_options: NotRequired[FeedRequestOptionsTypedDict]
    timeout_millis: NotRequired[int]
    r"""Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer."""
    session_info: NotRequired[SessionInfoTypedDict]


class FeedRequest(BaseModel):
    categories: Optional[List[FeedRequestCategory]] = None
    r"""Categories of content requested. An allowlist gives flexibility to request content separately or together."""

    request_options: Annotated[
        Optional[FeedRequestOptions], pydantic.Field(alias="requestOptions")
    ] = None

    timeout_millis: Annotated[Optional[int], pydantic.Field(alias="timeoutMillis")] = (
        None
    )
    r"""Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer."""

    session_info: Annotated[
        Optional[SessionInfo], pydantic.Field(alias="sessionInfo")
    ] = None

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = set(
            ["categories", "requestOptions", "timeoutMillis", "sessionInfo"]
        )
        serialized = handler(self)
        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k, serialized.get(n))

            if val != UNSET_SENTINEL:
                if val is not None or k not in optional_fields:
                    m[k] = val

        return m


try:
    FeedRequest.model_rebuild()
except NameError:
    pass