microsoft-teams-api 0.0.1a1__tar.gz

microsoft_teams_api-0.0.1a1/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+.copilot-instructions.md
+
+# other
+.DS_STORE
+*.bak
+*~
+*.tmp
+
+ref/
+py.typed
+CLAUDE.md
+
+.env.claude/
+.claude/

microsoft_teams_api-0.0.1a1/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: microsoft-teams-api
+Version: 0.0.1a1
+Summary: API package for Microsoft Teams
+Project-URL: Homepage, https://github.com/microsoft/teams.py/tree/main/packages/api/src/microsoft/teams/api
+Author-email: Microsoft <TeamsAISDKFeedback@microsoft.com>
+License-Expression: MIT
+Keywords: agents,ai,bot,microsoft,teams
+Requires-Python: >=3.12
+Requires-Dist: microsoft-teams-cards
+Requires-Dist: microsoft-teams-common
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyjwt[crypto]>=2.10.0
+Description-Content-Type: text/markdown
+
+> [!CAUTION]
+> This project is in active development and not ready for production use. It has not been publicly announced yet.
+
+# Microsoft Teams API Client
+
+Core API client functionality with models and clients for Microsoft Teams integration.
+Provides HTTP abstraction, authentication, and typed models for Teams Bot Framework APIs.

microsoft_teams_api-0.0.1a1/README.md

@@ -0,0 +1,7 @@
+> [!CAUTION]
+> This project is in active development and not ready for production use. It has not been publicly announced yet.
+
+# Microsoft Teams API Client
+
+Core API client functionality with models and clients for Microsoft Teams integration.
+Provides HTTP abstraction, authentication, and typed models for Teams Bot Framework APIs.

microsoft_teams_api-0.0.1a1/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "microsoft-teams-api"
+version = "0.0.1-alpha.1"
+description = "API package for Microsoft Teams"
+readme = "README.md"
+repository = "https://github.com/microsoft/teams.py"
+keywords = ["microsoft", "teams", "ai", "bot", "agents"] 
+license = "MIT"
+authors = [
+    { name = "Microsoft", email = "TeamsAISDKFeedback@microsoft.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.0.0",
+    "microsoft-teams-common",
+    "microsoft-teams-cards",
+    "pyjwt[crypto]>=2.10.0",
+]
+
+[tool.uv.sources]
+"microsoft-teams-common" = { workspace = true }
+"microsoft-teams-cards" = { workspace = true }
+
+[project.urls]
+Homepage = "https://github.com/microsoft/teams.py/tree/main/packages/api/src/microsoft/teams/api"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "python-dotenv>=1.0.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/microsoft"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src"]

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/__init__.py

@@ -0,0 +1,17 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from . import activities, auth, clients, models
+from .activities import *  # noqa: F403
+from .auth import *  # noqa: F403
+from .clients import *  # noqa: F403
+from .models import *  # noqa: F403
+
+# Combine all exports from submodules
+__all__: list[str] = []
+__all__.extend(activities.__all__)
+__all__.extend(auth.__all__)
+__all__.extend(clients.__all__)
+__all__.extend(models.__all__)

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/__init__.py

@@ -0,0 +1,80 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Annotated, Union
+
+from pydantic import Field, TypeAdapter
+
+from . import event, install_update, invoke, message
+from .activity_params import ActivityParams
+from .command import CommandActivity, CommandResultActivity, CommandResultValue, CommandSendActivity, CommandSendValue
+from .conversation import (
+    ConversationActivity,
+    ConversationChannelData,
+    ConversationEventType,
+    ConversationUpdateActivity,
+    EndOfConversationActivity,
+    EndOfConversationCode,
+)
+from .event import *  # noqa: F403
+from .event import EventActivity
+from .handoff import HandoffActivity
+from .install_update import *  # noqa: F403
+from .install_update import InstallUpdateActivity
+from .invoke import *  # noqa: F403
+from .invoke import InvokeActivity
+from .message import *  # noqa: F403
+from .message import MessageActivities
+from .sent_activity import SentActivity
+from .trace import TraceActivity
+from .typing import TypingActivity
+
+Activity = Annotated[
+    Union[
+        HandoffActivity,
+        TraceActivity,
+        TypingActivity,
+        CommandActivity,
+        ConversationActivity,
+        MessageActivities,
+        EventActivity,
+        InvokeActivity,
+        InstallUpdateActivity,
+    ],
+    Field(discriminator="type"),
+]
+
+# Use this if you want to validate an incoming activity.
+ActivityTypeAdapter = TypeAdapter[Activity](Activity)
+ActivityTypeAdapter.rebuild()
+
+
+# Combine all exports from submodules
+__all__: list[str] = [
+    "Activity",
+    "ActivityTypeAdapter",
+    "CommandSendActivity",
+    "CommandResultActivity",
+    "CommandSendValue",
+    "CommandResultValue",
+    "ConversationActivity",
+    "ConversationUpdateActivity",
+    "ConversationChannelData",
+    "EndOfConversationActivity",
+    "EndOfConversationCode",
+    "EventActivity",
+    "HandoffActivity",
+    "InstallUpdateActivity",
+    "TypingActivity",
+    "ConversationEventType",
+    "InvokeActivity",
+    "TraceActivity",
+    "ActivityParams",
+    "SentActivity",
+]
+__all__.extend(event.__all__)
+__all__.extend(install_update.__all__)
+__all__.extend(message.__all__)
+__all__.extend(invoke.__all__)

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/activity_params.py

@@ -0,0 +1,41 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+# Union of all activity input types (each defined next to their respective activities)
+from typing import Annotated, Union
+
+from pydantic import Field
+
+from .command import CommandResultActivityInput, CommandSendActivityInput
+from .conversation import ConversationUpdateActivityInput, EndOfConversationActivityInput
+from .handoff import HandoffActivityInput
+from .message import (
+    MessageActivityInput,
+    MessageDeleteActivityInput,
+    MessageReactionActivityInput,
+    MessageUpdateActivityInput,
+)
+from .trace import TraceActivityInput
+from .typing import TypingActivityInput
+
+ActivityParams = Annotated[
+    Union[
+        # Simple activities
+        ConversationUpdateActivityInput,
+        EndOfConversationActivityInput,
+        HandoffActivityInput,
+        TraceActivityInput,
+        TypingActivityInput,
+        # Message activities
+        MessageActivityInput,
+        MessageDeleteActivityInput,
+        MessageReactionActivityInput,
+        MessageUpdateActivityInput,
+        # Command activities
+        CommandSendActivityInput,
+        CommandResultActivityInput,
+    ],
+    Field(discriminator="type"),
+]

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/command/__init__.py

@@ -0,0 +1,23 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Annotated, Union
+
+from pydantic import Field
+
+from .command_result import CommandResultActivity, CommandResultActivityInput, CommandResultValue
+from .command_send import CommandSendActivity, CommandSendActivityInput, CommandSendValue
+
+CommandActivity = Annotated[Union[CommandSendActivity, CommandResultActivity], Field(discriminator="type")]
+
+__all__ = [
+    "CommandResultValue",
+    "CommandResultActivity",
+    "CommandResultActivityInput",
+    "CommandSendValue",
+    "CommandSendActivity",
+    "CommandSendActivityInput",
+    "CommandActivity",
+]

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/command/command_result.py

@@ -0,0 +1,53 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Any, Literal, Optional
+
+from ...models import ActivityBase, ActivityInputBase, CustomBaseModel
+
+
+class CommandResultValue(CustomBaseModel):
+    """
+    The value field of a CommandResultActivity contains metadata related to a command result.
+    An optional extensible data payload may be included if defined by the command activity name.
+    The presence of an error field indicates that the original command failed to complete.
+    """
+
+    command_id: str
+    """ID of the command."""
+
+    data: Optional[Any] = None
+    """
+    The data field containing optional parameters specific to this command activity,
+    as defined by the name. The value of the data field is a complex type.
+    """
+
+    error: Optional[Exception] = None
+    """The optional error, if the command result indicates a failure."""
+
+
+class _CommandResultBase(CustomBaseModel):
+    """Base class containing shared command result activity fields (all Optional except type)."""
+
+    type: Literal["commandResult"] = "commandResult"
+
+    name: Optional[str] = None
+    """The name of the event."""
+
+    value: Optional[CommandResultValue] = None
+    """The value for this command."""
+
+
+class CommandResultActivity(_CommandResultBase, ActivityBase):
+    """Output model for received command result activities with required fields and read-only properties."""
+
+    name: str  # pyright: ignore [reportGeneralTypeIssues, reportIncompatibleVariableOverride]
+    """The name of the event."""
+
+
+class CommandResultActivityInput(_CommandResultBase, ActivityInputBase):
+    """Input model for creating command result activities with builder methods."""
+
+    pass

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/command/command_send.py

@@ -0,0 +1,49 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Any, Literal, Optional
+
+from ...models import ActivityBase, ActivityInputBase, CustomBaseModel
+
+
+class CommandSendValue(CustomBaseModel):
+    """
+    The value field of a CommandActivity contains metadata related to a command.
+    An optional extensible data payload may be included if defined by the command activity name.
+    """
+
+    command_id: str
+    """ID of the command."""
+
+    data: Optional[Any] = None
+    """
+    The data field containing optional parameters specific to this command activity,
+    as defined by the name. The value of the data field is a complex type.
+    """
+
+
+class _CommandSendBase(CustomBaseModel):
+    """Base class containing shared command send activity fields (all Optional except type)."""
+
+    type: Literal["command"] = "command"
+
+    name: Optional[str] = None
+    """The name of the event."""
+
+    value: Optional[CommandSendValue] = None
+    """The value for this command."""
+
+
+class CommandSendActivity(_CommandSendBase, ActivityBase):
+    """Output model for received command send activities with required fields and read-only properties."""
+
+    name: str  # pyright: ignore [reportGeneralTypeIssues, reportIncompatibleVariableOverride]
+    """The name of the event."""
+
+
+class CommandSendActivityInput(_CommandSendBase, ActivityInputBase):
+    """Input model for creating command send activities with builder methods."""
+
+    pass

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/conversation/__init__.py

@@ -0,0 +1,31 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Annotated, Union
+
+from pydantic import Field
+
+from .conversation_update import (
+    ConversationChannelData,
+    ConversationEventType,
+    ConversationUpdateActivity,
+    ConversationUpdateActivityInput,
+)
+from .end_of_conversation import EndOfConversationActivity, EndOfConversationActivityInput, EndOfConversationCode
+
+ConversationActivity = Annotated[
+    Union[ConversationUpdateActivity, EndOfConversationActivity], Field(discriminator="type")
+]
+
+__all__ = [
+    "ConversationEventType",
+    "ConversationChannelData",
+    "ConversationUpdateActivity",
+    "ConversationUpdateActivityInput",
+    "EndOfConversationCode",
+    "EndOfConversationActivity",
+    "EndOfConversationActivityInput",
+    "ConversationActivity",
+]

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/conversation/conversation_update.py

@@ -0,0 +1,62 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import List, Literal, Optional
+
+from ...models import Account, ActivityBase, ActivityInputBase, ChannelData, CustomBaseModel
+
+ConversationEventType = Literal[
+    "channelCreated",
+    "channelDeleted",
+    "channelRenamed",
+    "channelRestored",
+    "teamArchived",
+    "teamDeleted",
+    "teamHardDeleted",
+    "teamRenamed",
+    "teamRestored",
+    "teamUnarchived",
+]
+
+
+class ConversationChannelData(ChannelData, CustomBaseModel):
+    """Extended ChannelData with event type."""
+
+    event_type: Optional[ConversationEventType] = None
+    """The type of event that occurred."""
+
+
+class _ConversationUpdateBase(CustomBaseModel):
+    """Base class containing shared conversation update activity fields (all Optional except type)."""
+
+    type: Literal["conversationUpdate"] = "conversationUpdate"
+
+    members_added: Optional[List[Account]] = None
+    """The collection of members added to the conversation."""
+
+    members_removed: Optional[List[Account]] = None
+    """The collection of members removed from the conversation."""
+
+    topic_name: Optional[str] = None
+    """The updated topic name of the conversation."""
+
+    history_disclosed: Optional[bool] = None
+    """Indicates whether the prior history of the channel is disclosed."""
+
+    channel_data: Optional[ConversationChannelData] = None
+    """Channel data with event type information."""
+
+
+class ConversationUpdateActivity(_ConversationUpdateBase, ActivityBase):
+    """Output model for received conversation update activities with required fields and read-only properties."""
+
+    channel_data: ConversationChannelData  # pyright: ignore [reportGeneralTypeIssues, reportIncompatibleVariableOverride]
+    """Channel data with event type information."""
+
+
+class ConversationUpdateActivityInput(_ConversationUpdateBase, ActivityInputBase):
+    """Input model for creating conversation update activities with builder methods."""
+
+    pass

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/conversation/end_of_conversation.py

@@ -0,0 +1,39 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Literal, Optional
+
+from ...models import ActivityBase, ActivityInputBase, CustomBaseModel
+
+EndOfConversationCode = Literal[
+    "unknown", "completedSuccessfully", "userCancelled", "botTimedOut", "botIssuedInvalidMessage", "channelFailed"
+]
+
+
+class _EndOfConversationBase(CustomBaseModel):
+    """Base class containing shared end of conversation activity fields (all Optional except type)."""
+
+    type: Literal["endOfConversation"] = "endOfConversation"
+
+    code: Optional[EndOfConversationCode] = None
+    """
+    The code for endOfConversation activities that indicates why the conversation ended.
+    Possible values include: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut',
+    'botIssuedInvalidMessage', 'channelFailed'
+    """
+
+    text: Optional[str] = None
+    """The text content of the message."""
+
+
+class EndOfConversationActivity(_EndOfConversationBase, ActivityBase):
+    """Output model for received end of conversation activities with required fields and read-only properties."""
+
+    text: str  # pyright: ignore [reportGeneralTypeIssues]
+    """The text content of the message."""
+
+
+class EndOfConversationActivityInput(_EndOfConversationBase, ActivityInputBase):
+    """Input model for creating end of conversation activities with builder methods."""

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/event/__init__.py

@@ -0,0 +1,36 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Annotated, Union
+
+from pydantic import Field
+
+from .meeting_end import MeetingEndEventActivity
+from .meeting_participant import MeetingParticipantEventActivity
+from .meeting_participant_join import MeetingParticipantJoinEventActivity
+from .meeting_participant_leave import MeetingParticipantLeaveEventActivity
+from .meeting_start import MeetingStartEventActivity
+from .read_reciept import ReadReceiptEventActivity
+
+EventActivity = Annotated[
+    Union[
+        ReadReceiptEventActivity,
+        MeetingStartEventActivity,
+        MeetingEndEventActivity,
+        MeetingParticipantJoinEventActivity,
+        MeetingParticipantLeaveEventActivity,
+    ],
+    Field(discriminator="name"),
+]
+
+__all__ = [
+    "MeetingEndEventActivity",
+    "MeetingStartEventActivity",
+    "MeetingParticipantEventActivity",
+    "MeetingParticipantJoinEventActivity",
+    "MeetingParticipantLeaveEventActivity",
+    "ReadReceiptEventActivity",
+    "EventActivity",
+]

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/event/meeting_end.py

@@ -0,0 +1,38 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from datetime import datetime
+from typing import Literal
+
+from ...models import ActivityBase, CustomBaseModel
+
+
+class MeetingEndEventValue(CustomBaseModel):
+    id: str
+    """The meeting's Id, encoded as a BASE64 string."""
+
+    meeting_type: str
+    """Type of the meeting"""
+
+    join_url: str
+    """URL to join the meeting"""
+
+    title: str
+    """Title of the meeting."""
+
+    end_time: datetime
+    """Timestamp for meeting end, in UTC."""
+
+
+class MeetingEndEventActivity(ActivityBase, CustomBaseModel):
+    """
+    Represents a meeting end event activity in Microsoft Teams.
+    """
+
+    type: Literal["event"] = "event"  #
+
+    name: Literal["application/vnd.microsoft.meetingEnd"] = "application/vnd.microsoft.meetingEnd"
+
+    value: MeetingEndEventValue

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/event/meeting_participant.py

@@ -0,0 +1,50 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import List, Literal
+
+from ...models import Account, ActivityBase, CustomBaseModel
+
+
+class MeetingParticipantInfo(CustomBaseModel):
+    """
+    Represents information about a participant in a Microsoft Teams meeting.
+    """
+
+    in_meeting: bool
+    """Indicates whether the participant is currently in the meeting."""
+
+    role: str
+    """The role of the participant in the meeting"""
+
+
+class MeetingParticipant(CustomBaseModel):
+    """
+    Represents a participant in a Microsoft Teams meeting.
+    """
+
+    user: Account
+    """The participant account."""
+
+    meeting: MeetingParticipantInfo
+    """The participant's info"""
+
+
+class MeetingParticipantEventValue(CustomBaseModel):
+    members: List[MeetingParticipant]
+    """The list of participants in the meeting."""
+
+
+class MeetingParticipantEventActivity(ActivityBase, CustomBaseModel):
+    """
+    Represents a meeting participant event activity in Microsoft Teams.
+    """
+
+    type: Literal["event"] = "event"  #
+
+    value: MeetingParticipantEventValue
+    """
+    The value of the event.
+    """

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/event/meeting_participant_join.py

@@ -0,0 +1,15 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Literal
+
+from ...models import CustomBaseModel
+from .meeting_participant import MeetingParticipantEventActivity
+
+
+class MeetingParticipantJoinEventActivity(MeetingParticipantEventActivity, CustomBaseModel):
+    name: Literal["application/vnd.microsoft.meetingParticipantJoin"] = (
+        "application/vnd.microsoft.meetingParticipantJoin"
+    )

microsoft_teams_api-0.0.1a1/src/microsoft/teams/api/activities/event/meeting_participant_leave.py

@@ -0,0 +1,15 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+from typing import Literal
+
+from ...models import CustomBaseModel
+from .meeting_participant import MeetingParticipantEventActivity
+
+
+class MeetingParticipantLeaveEventActivity(MeetingParticipantEventActivity, CustomBaseModel):
+    name: Literal["application/vnd.microsoft.meetingParticipantLeave"] = (
+        "application/vnd.microsoft.meetingParticipantLeave"
+    )