[CHA-1578] refactor: code generated from openapi specs

.github/workflows/release.yml

@@ -36,7 +36,8 @@ jobs:
       - name: Extract package version
         id: get_version
         run: |
-          VERSION=$(uvx -q hatch version)
+          FILE=$(ls dist/getstream-*.tar.gz | head -1)
+          VERSION=$(basename "$FILE" .tar.gz | sed 's/^getstream-//')
           echo "version=$VERSION" >> "$GITHUB_OUTPUT"
 
       - name: Publish to PyPI (Trusted Publishing)

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.0.0b1] - 2026-02-27
+
+### Breaking Changes
+
+- Type names across all products now follow the OpenAPI spec naming convention: response types are suffixed with `Response`, input types with `Request`. See [MIGRATION_v2_to_v3.md](./MIGRATION_v2_to_v3.md) for the complete rename mapping.
+- `Event` (WebSocket envelope type) renamed to `WSEvent`. Base event type renamed from `BaseEvent` to `Event` (with field `type` instead of `T`).
+- Event composition changed from monolithic `*Preset` embeds to modular `Has*` types.
+- `Pager` renamed to `PagerResponse` and migrated from offset-based to cursor-based pagination (`next`/`prev` tokens).
+- Types that were previously `dict` or `TypedDict` (e.g., `User`, `Channel`, `Message`) are now full dataclasses with typed fields.
+
+### Added
+
+- Full product coverage: Chat, Video, Moderation, and Feeds APIs are all supported in a single SDK.
+- **Feeds**: activities, feeds, feed groups, follows, comments, reactions, collections, bookmarks, membership levels, feed views, and more.
+- **Video**: calls, recordings, transcription, closed captions, SFU, call statistics, user feedback analytics, and more.
+- **Moderation**: flags, review queue, moderation rules, config, appeals, moderation logs, and more.
+- Push notification types, preferences, and templates.
+- Webhook support: `WHEvent` envelope class for receiving webhook payloads, utility functions for decoding and verifying webhook signatures, and a full set of individual typed event dataclasses for every event across all products (Chat, Video, Moderation, Feeds) usable as discriminated event types.
+- Cursor-based pagination across all list endpoints.
+
+## [2.7.1] - 2026-02-18
+
+## [2.7.0] - 2026-02-03
+
+## [2.6.0] - 2025-12-11
+
+## [2.5.22] - 2025-10-15

MIGRATION_v2_to_v3.md

@@ -0,0 +1,210 @@
+# Migration Guide: v2 → v3
+
+This guide covers all breaking changes when upgrading from `getstream` (stream-py) v2 to v3.
+
+## Overview
+
+v3 is a full OpenAPI-aligned release. The primary change is a **systematic type renaming**: types that appear in API responses now have a `Response` suffix, and input types have a `Request` suffix. There are no removed features — all functionality from v2 is available in v3. Additionally, v3 adds complete coverage of the **Feeds**, **Video**, and **Moderation** product APIs.
+
+Types that were previously plain `dict` or `TypedDict` (e.g., `User`, `Channel`, `Message`) are now full dataclasses with typed fields and IDE autocompletion support.
+
+## Installation
+
+```bash
+pip install getstream==3.*
+```
+
+Or to install the pre-release:
+
+```bash
+pip install --pre getstream
+```
+
+## Naming Conventions
+
+- **Classes**: `PascalCase` (e.g., `UserResponse`, `MessageRequest`)
+- **Fields/attributes**: `snake_case` (e.g., `user.created_at`, `message.reply_count`)
+
+The general renaming rules:
+
+- Classes returned in API responses: `Foo` → `FooResponse`
+- Classes used as API inputs: `Foo` → `FooRequest`
+- Some moderation action payloads: `FooRequest` → `FooRequestPayload`
+
+## Breaking Changes
+
+### Common / Shared Types
+
+| v2 | v3 | Notes |
+| --- | --- | --- |
+| `ApplicationConfig` | `AppResponseFields` | App configuration in responses |
+| `ChannelPushPreferences` | `ChannelPushPreferencesResponse` | Per-channel push settings |
+| `Device` | `DeviceResponse` | Device data (push, voip) |
+| `Event` | `WSEvent` | WebSocket event envelope |
+| `FeedsPreferences` | `FeedsPreferencesResponse` | Feeds push preferences |
+| `ImportV2Task` | `ImportV2TaskItem` | V2 import task |
+| `OwnUser` | `OwnUserResponse` | Authenticated user data (was `dict`) |
+| `Pager` | `PagerResponse` | Now cursor-based (`next`/`prev`) |
+| `PushPreferences` | `PushPreferencesResponse` | Push preferences |
+| `PushTemplate` | `PushTemplateResponse` | Push template |
+| `PrivacySettings` | `PrivacySettingsResponse` | Typing indicators, read receipts |
+| `RateLimitInfo` | `LimitInfoResponse` | Rate limit info |
+| `SortParam` | `SortParamRequest` | Sort parameter for queries |
+| `User` | `UserResponse` | Full user in responses (was `dict`) |
+| `UserBlock` | `BlockedUserResponse` | Blocked user details |
+| `UserCustomEvent` | `CustomEvent` | Custom user event |
+| `UserMute` | `UserMuteResponse` | User mute details |
+
+### Event System
+
+| Before (v2) | After (v3) | Notes |
+| --- | --- | --- |
+| `BaseEvent` (field `T`) | `Event` (field `type`) | Base event type |
+| `Event` (WS envelope) | `WSEvent` | WebSocket event wrapper |
+| `*Preset` embeds | `Has*` composition types | e.g., `HasChannel`, `HasMessage` |
+| — | `WHEvent` | New webhook envelope type |
+
+### Chat Types
+
+| v2 | v3 | Notes |
+| --- | --- | --- |
+| `Campaign` | `CampaignResponse` | |
+| `CampaignStats` | `CampaignStatsResponse` | |
+| `Channel` | `ChannelResponse` | Was `dict`, now dataclass |
+| `ChannelConfigFields` | `ChannelConfigWithInfo` | Channel config + commands/grants |
+| `ChannelMember` | `ChannelMemberResponse` | |
+| `ChannelTypeConfigWithInfo` | `ChannelTypeConfig` | |
+| `ConfigOverrides` | `ConfigOverridesRequest` | |
+| `DraftMessage` / `DraftMessagePayload` | `DraftResponse` | Two types merged into one |
+| `Message` | `MessageResponse` | Was `dict`, now dataclass |
+| `MessageReminder` | `ReminderResponseData` | |
+| `PendingMessage` | `PendingMessageResponse` | |
+| `Poll` | `PollResponse` | |
+| `PollOption` | `PollOptionResponse` | |
+| `PollVote` | `PollVoteResponse` | |
+| `Reaction` | `ReactionResponse` | |
+| `ReadState` | `ReadStateResponse` | |
+| `Thread` | `ThreadResponse` | |
+
+### Video Types
+
+| v2 | v3 | Notes |
+| --- | --- | --- |
+| `AudioSettings` | `AudioSettingsResponse` | |
+| `BackstageSettings` | `BackstageSettingsResponse` | |
+| `BroadcastSettings` | `BroadcastSettingsResponse` | |
+| `Call` | `CallResponse` | Was `dict`, now dataclass |
+| `CallEgress` | `EgressResponse` | |
+| `CallMember` | `MemberResponse` | Note: not `CallMemberResponse` |
+| `CallParticipant` | `CallParticipantResponse` | |
+| `CallParticipantFeedback` | *(removed)* | Use `CollectUserFeedbackRequest` |
+| `CallSession` | `CallSessionResponse` | |
+| `CallSettings` | `CallSettingsResponse` | |
+| `CallType` | `CallTypeResponse` | |
+| `EventNotificationSettings` | `EventNotificationSettingsResponse` | |
+| `FrameRecordSettings` | `FrameRecordingSettingsResponse` | `Recording` inserted in name |
+| `GeofenceSettings` | `GeofenceSettingsResponse` | |
+| `HLSSettings` | `HLSSettingsResponse` | |
+| `IndividualRecordSettings` | `IndividualRecordingSettingsResponse` | `Recording` inserted in name |
+| `IngressSettings` | `IngressSettingsResponse` | |
+| `IngressSource` | `IngressSourceResponse` | |
+| `IngressAudioEncodingOptions` | `IngressAudioEncodingResponse` | Shortened name |
+| `IngressVideoEncodingOptions` | `IngressVideoEncodingResponse` | Shortened name |
+| `IngressVideoLayer` | `IngressVideoLayerResponse` | |
+| `LimitsSettings` | `LimitsSettingsResponse` | |
+| `NotificationSettings` | `NotificationSettingsResponse` | |
+| `RawRecordSettings` | `RawRecordingSettingsResponse` | `Recording` inserted in name |
+| `RecordSettings` | `RecordSettingsResponse` | |
+| `RingSettings` | `RingSettingsResponse` | |
+| `RTMPSettings` | `RTMPSettingsResponse` | |
+| `ScreensharingSettings` | `ScreensharingSettingsResponse` | |
+| `SessionSettings` | `SessionSettingsResponse` | |
+| `SIPCallConfigs` | `SIPCallConfigsResponse` | |
+| `SIPCallerConfigs` | `SIPCallerConfigsResponse` | |
+| `SIPDirectRoutingRuleCallConfigs` | `SIPDirectRoutingRuleCallConfigsResponse` | |
+| `SIPInboundRoutingRules` | `SIPInboundRoutingRuleResponse` | Plural → singular |
+| `SIPPinProtectionConfigs` | `SIPPinProtectionConfigsResponse` | |
+| `SIPTrunk` | `SIPTrunkResponse` | |
+| `ThumbnailsSettings` | `ThumbnailsSettingsResponse` | |
+| `TranscriptionSettings` | `TranscriptionSettingsResponse` | |
+| `VideoSettings` | `VideoSettingsResponse` | |
+
+### Moderation Types
+
+| v2 | v3 | Notes |
+| --- | --- | --- |
+| `ActionLog` | `ActionLogResponse` | |
+| `Appeal` | `AppealItemResponse` | |
+| `AutomodDetails` | `AutomodDetailsResponse` | |
+| `Ban` | `BanInfoResponse` | |
+| `BanOptions` | *(removed)* | Merged into `BanActionRequestPayload` |
+| `BanActionRequest` | `BanActionRequestPayload` | |
+| `BlockActionRequest` | `BlockActionRequestPayload` | |
+| `BlockedMessage` | *(removed)* | Internal only |
+| `CustomActionRequest` | `CustomActionRequestPayload` | |
+| `DeleteMessageRequest` | `DeleteMessageRequestPayload` | |
+| `DeleteUserRequest` | `DeleteUserRequestPayload` | |
+| `EntityCreator` | `EntityCreatorResponse` | |
+| `Evaluation` | `EvaluationResponse` | |
+| `FeedsModerationTemplate` | `QueryFeedModerationTemplate` | No `Response` suffix |
+| `FeedsModerationTemplateConfig` | `FeedsModerationTemplateConfigPayload` | |
+| `Flag` | *(removed)* | Use `ModerationFlagResponse` |
+| `Flag2` | `ModerationFlagResponse` | Was minimal type defs, now full dataclass |
+| `FlagDetails` | `FlagDetailsResponse` | |
+| `FlagFeedback` | `FlagFeedbackResponse` | |
+| `FlagMessageDetails` | `FlagMessageDetailsResponse` | |
+| `FlagReport` | *(removed)* | Internal only |
+| `FutureChannelBan` | `FutureChannelBanResponse` | |
+| `MarkReviewedRequest` | `MarkReviewedRequestPayload` | |
+| `Match` | `MatchResponse` | |
+| `ModerationActionConfig` | `ModerationActionConfigResponse` | |
+| `ModerationBulkSubmitActionRequest` | `BulkSubmitActionRequest` | `Moderation` prefix dropped |
+| `ModerationConfig` | `ConfigResponse` | |
+| `ModerationFlags` | *(removed)* | Use `List[ModerationFlagResponse]` |
+| `ModerationLog` | *(removed)* | Use `ActionLogResponse` |
+| `ModerationLogResponse` | *(removed)* | Use `QueryModerationLogsResponse` |
+| `ModerationUsageStats` | `ModerationUsageStatsResponse` | |
+| `RestoreActionRequest` | `RestoreActionRequestPayload` | |
+| `ReviewQueueItem` | `ReviewQueueItemResponse` | |
+| `Rule` | `RuleResponse` | |
+| `ShadowBlockActionRequest` | `ShadowBlockActionRequestPayload` | |
+| `Task` | `TaskResponse` | |
+| `Trigger` | `TriggerResponse` | |
+| `UnbanActionRequest` | `UnbanActionRequestPayload` | |
+| `UnblockActionRequest` | `UnblockActionRequestPayload` | |
+| `VideoEndCallRequest` | `VideoEndCallRequestPayload` | |
+| `VideoKickUserRequest` | `VideoKickUserRequestPayload` | |
+
+### Feeds Types
+
+| v2 | v3 | Notes |
+| --- | --- | --- |
+| `Activity` | `ActivityResponse` | Was `dict`, now dataclass |
+| `ActivityFeedback` | `ActivityFeedbackRequest` | Request-only (no `Response` suffix) |
+| `ActivityMark` | `MarkActivityRequest` | |
+| `ActivityPin` | `ActivityPinResponse` | |
+| `AggregatedActivity` | `AggregatedActivityResponse` | |
+| `Bookmark` | `BookmarkResponse` | |
+| `BookmarkFolder` | `BookmarkFolderResponse` | |
+| `Collection` | `CollectionResponse` | |
+| `Comment` | `CommentResponse` | |
+| `CommentMedia` | *(removed)* | Embedded inline in `CommentResponse` |
+| `CommentMention` | *(removed)* | Embedded inline in `CommentResponse` |
+| `DenormalizedFeedsReaction` | *(removed)* | Internal only |
+| `Feed` | `FeedResponse` | |
+| `FeedGroup` | `FeedGroupResponse` | |
+| `FeedMember` | `FeedMemberResponse` | |
+| `FeedsReaction` | `FeedsReactionResponse` | |
+| `FeedsReactionGroup` | `FeedsReactionGroupResponse` | |
+| `FeedSuggestion` | `FeedSuggestionResponse` | |
+| `FeedView` | `FeedViewResponse` | |
+| `FeedVisibilityInfo` | `FeedVisibilityResponse` | |
+| `Follow` | `FollowResponse` | |
+| `MembershipLevel` | `MembershipLevelResponse` | |
+| `ThreadedComment` | `ThreadedCommentResponse` | |
+
+## Getting Help
+
+- [Stream documentation](https://getstream.io/docs/)
+- [GitHub Issues](https://github.com/GetStream/stream-py/issues)
+- [Stream support](https://getstream.io/contact/support/)