@wildix/stream-client 0.0.1

package/dist-types/models/models_0.d.ts

@@ -0,0 +1,1113 @@
+import { StreamServiceServiceException as __BaseException } from "./StreamServiceServiceException";
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+/**
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class InternalServerError extends __BaseException {
+    readonly name: "InternalServerError";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class RateLimitExceededException extends __BaseException {
+    readonly name: "RateLimitExceededException";
+    readonly $fault: "client";
+    /**
+     * Displays the applicable rate limits for the current request.
+     * @public
+     */
+    rateLimit?: string | undefined;
+    /**
+     * Indicates how many requests a user can still make within the current time window.
+     * @public
+     */
+    rateLimitRemaining?: number | undefined;
+    /**
+     * Shows the time in seconds until the rate limit resets.
+     * @public
+     */
+    rateLimitReset?: number | undefined;
+    /**
+     * Displays how many seconds the user agent should wait before making a follow-up request.
+     * @public
+     */
+    retryAfter?: number | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<RateLimitExceededException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class UnauthorizedException extends __BaseException {
+    readonly name: "UnauthorizedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface AddReactionInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    messageId: string;
+    /**
+     * Reaction key. Free-form lowercase identifier (e.g. `thumbsup`, `heart`).
+     * @public
+     */
+    type: string;
+}
+/**
+ * File attached to a message as returned by listing and lookup endpoints.
+ * @public
+ */
+export interface MessageAttachment {
+    /**
+     * Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
+     * @public
+     */
+    fsId: string;
+    /**
+     * MIME type.
+     * @public
+     */
+    mime?: string | undefined;
+    /**
+     * Original file name.
+     * @public
+     */
+    name: string;
+    /**
+     * File size in bytes.
+     * @public
+     */
+    size: number;
+    /**
+     * Image or video width in pixels.
+     * @public
+     */
+    width?: number | undefined;
+    /**
+     * Image or video height in pixels.
+     * @public
+     */
+    height?: number | undefined;
+    /**
+     * Thumbnail URL when available.
+     * @public
+     */
+    thumbnail?: string | undefined;
+    /**
+     * Attachment identifier within the message.
+     * @public
+     */
+    id: string;
+}
+/**
+ * Reference to the original forwarded message.
+ * @public
+ */
+export interface MessageForward {
+    channelId: string;
+    messageId: string;
+    /**
+     * Author of the original message.
+     * @public
+     */
+    userId: string;
+    /**
+     * Creation timestamp of the original message.
+     * @public
+     */
+    forwardedAt: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageType: {
+    readonly REGULAR: "regular";
+    readonly SYSTEM: "system";
+};
+/**
+ * @public
+ */
+export type MessageType = typeof MessageType[keyof typeof MessageType];
+/**
+ * Reference to a quoted message.
+ * @public
+ */
+export interface MessageQuote {
+    channelId: string;
+    messageId: string;
+    /**
+     * Author of the quoted message.
+     * @public
+     */
+    userId: string;
+    /**
+     * Text body captured at quote time.
+     * @public
+     */
+    text?: string | undefined;
+    /**
+     * ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
+     * @public
+     */
+    createdAt: string;
+}
+/**
+ * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+ * @public
+ */
+export interface Message {
+    messageId: string;
+    /**
+     * Author of the message.
+     * @public
+     */
+    userId: string;
+    /**
+     * Type of message row.
+     * @public
+     */
+    messageType: MessageType;
+    /**
+     * Text body. Empty for attachment-only or deleted messages.
+     * @public
+     */
+    text?: string | undefined;
+    /**
+     * Attached files.
+     * @public
+     */
+    attachments: (MessageAttachment)[];
+    /**
+     * Users directly mentioned in the message.
+     * @public
+     */
+    mentions: (string)[];
+    /**
+     * Quoted message reference.
+     * @public
+     */
+    quote?: MessageQuote | undefined;
+    /**
+     * Forwarded message reference.
+     * @public
+     */
+    forward?: MessageForward | undefined;
+    /**
+     * Per-emoji reaction counters. Keys are reaction type ids (e.g. `thumbsup`).
+     * @public
+     */
+    reactionCounts: Record<string, number>;
+    /**
+     * True when the message is currently pinned at channel scope.
+     * @public
+     */
+    pinned: boolean;
+    /**
+     * Timestamp at which the message was pinned. Absent when not pinned.
+     * @public
+     */
+    pinnedAt?: string | undefined;
+    /**
+     * User that pinned the message. Absent when not pinned.
+     * @public
+     */
+    pinnedBy?: string | undefined;
+    /**
+     * True when the message is system-generated.
+     * @public
+     */
+    system: boolean;
+    /**
+     * Monotonic per-channel sequence covering every channel mutation. Used to page the channel timeline.
+     * @public
+     */
+    timelineSeq: number;
+    /**
+     * Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
+     * @public
+     */
+    visibleSeq: number;
+    /**
+     * Channel version. Increments on every channel mutation.
+     * @public
+     */
+    channelVersion: number;
+    /**
+     * Message version. Increments on every message mutation.
+     * @public
+     */
+    messageVersion: number;
+    /**
+     * ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
+     * @public
+     */
+    createdAt: string;
+    /**
+     * Timestamp of the most recent edit.
+     * @public
+     */
+    editedAt?: string | undefined;
+    /**
+     * Tombstone timestamp.
+     * @public
+     */
+    deletedAt?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface AddReactionOutput {
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+}
+/**
+ * @public
+ */
+export declare class ChannelNotFoundException extends __BaseException {
+    readonly name: "ChannelNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChannelNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class MessageNotFoundException extends __BaseException {
+    readonly name: "MessageNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MessageNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelsFilter: {
+    /**
+     * Archived (hidden) channels.
+     */
+    readonly ARCHIVED: "archived";
+    /**
+     * Non-archived channels with at least one unread message.
+     */
+    readonly UNREAD: "unread";
+};
+/**
+ * @public
+ */
+export type ChannelsFilter = typeof ChannelsFilter[keyof typeof ChannelsFilter];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelType: {
+    readonly DIRECT: "direct";
+    readonly EXTERNAL: "external";
+    readonly GROUP: "group";
+};
+/**
+ * @public
+ */
+export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
+/**
+ * @public
+ */
+export interface DeleteMessageInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    messageId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteMessageOutput {
+}
+/**
+ * Attachment record supplied by the client when sending or editing a message. The server assigns the attachment `id` after persistence.
+ * @public
+ */
+export interface MessageAttachmentRequest {
+    /**
+     * Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
+     * @public
+     */
+    fsId: string;
+    /**
+     * MIME type.
+     * @public
+     */
+    mime?: string | undefined;
+    /**
+     * Original file name.
+     * @public
+     */
+    name: string;
+    /**
+     * File size in bytes.
+     * @public
+     */
+    size: number;
+    /**
+     * Image or video width in pixels.
+     * @public
+     */
+    width?: number | undefined;
+    /**
+     * Image or video height in pixels.
+     * @public
+     */
+    height?: number | undefined;
+    /**
+     * Thumbnail URL when available.
+     * @public
+     */
+    thumbnail?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface EditMessageInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    messageId: string;
+    /**
+     * New text body. Server rejects payloads that would empty both `text` and `attachments`.
+     * @public
+     */
+    text?: string | undefined;
+    /**
+     * New attachment list. Replaces the previous list when provided.
+     * @public
+     */
+    attachments?: (MessageAttachmentRequest)[] | undefined;
+    /**
+     * New mention list. Replaces the previous list when provided. Edits never advance unread counters.
+     * @public
+     */
+    mentions?: (string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface EditMessageOutput {
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+}
+/**
+ * @public
+ */
+export interface GetInboxInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+}
+/**
+ * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
+ * @public
+ */
+export interface InboxState {
+    /**
+     * Sections that include this channel.
+     * @public
+     */
+    sectionIds: (string)[];
+    /**
+     * Number of unread visible messages.
+     * @public
+     */
+    unreadCount: number;
+    /**
+     * Number of unread mentions of the current user.
+     * @public
+     */
+    mentionUnreadCount: number;
+    /**
+     * Highest `visibleSeq` the user has read in this channel.
+     * @public
+     */
+    lastReadVisibleSeq?: number | undefined;
+    /**
+     * Timestamp of the most recent read event.
+     * @public
+     */
+    lastReadAt?: string | undefined;
+    /**
+     * True when the channel is hidden (archived).
+     * @public
+     */
+    hidden: boolean;
+    /**
+     * True when the channel is muted.
+     * @public
+     */
+    muted: boolean;
+    /**
+     * Expiry timestamp for a temporary mute.
+     * @public
+     */
+    mutedUntil?: string | undefined;
+    /**
+     * `visibleSeq` from which the user manually marked the channel as unread.
+     * @public
+     */
+    unreadMarkAt?: number | undefined;
+}
+/**
+ * Preview of the most recent visible message in a channel.
+ * @public
+ */
+export interface LastMessagePreview {
+    messageId: string;
+    /**
+     * Author of the message.
+     * @public
+     */
+    userId: string;
+    /**
+     * Text body of the message. Absent for attachment-only or deleted messages.
+     * @public
+     */
+    text?: string | undefined;
+    /**
+     * Creation timestamp of the message.
+     * @public
+     */
+    createdAt: string;
+}
+/**
+ * Channel item returned by inbox and channel listings. Includes per-user inbox state and last-message preview.
+ * @public
+ */
+export interface InboxChannel {
+    channelId: string;
+    /**
+     * Type of channel.
+     * @public
+     */
+    channelType: ChannelType;
+    /**
+     * Channel subject.
+     * @public
+     */
+    subject?: string | undefined;
+    /**
+     * Channel picture URL.
+     * @public
+     */
+    picture?: string | undefined;
+    /**
+     * Current number of members.
+     * @public
+     */
+    memberCount: number;
+    /**
+     * Channel creation timestamp.
+     * @public
+     */
+    createdAt: string;
+    /**
+     * User that created the channel.
+     * @public
+     */
+    createdBy: string;
+    /**
+     * Timestamp of the last channel mutation.
+     * @public
+     */
+    updatedAt: string;
+    /**
+     * Channel version. Increments on every channel mutation.
+     * @public
+     */
+    channelVersion: number;
+    /**
+     * Timestamp of the last activity. Drives inbox ordering.
+     * @public
+     */
+    lastActivityAt: string;
+    /**
+     * Last visible message preview. Absent for empty channels.
+     * @public
+     */
+    lastMessage?: LastMessagePreview | undefined;
+    /**
+     * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
+     * @public
+     */
+    inbox: InboxState;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SectionType: {
+    /**
+     * Custom section created by the user.
+     */
+    readonly CUSTOM: "custom";
+    /**
+     * System section maintained by the backend.
+     */
+    readonly SYSTEM: "system";
+};
+/**
+ * @public
+ */
+export type SectionType = typeof SectionType[keyof typeof SectionType];
+/**
+ * Aggregated unread counters for an inbox section.
+ * @public
+ */
+export interface SectionUnreadCounters {
+    /**
+     * Unmuted channels with at least one unread message.
+     * @public
+     */
+    unmutedUnreadChannelCount: number;
+    /**
+     * Total unread messages across unmuted channels.
+     * @public
+     */
+    unmutedUnreadMessageCount: number;
+    /**
+     * Total unread messages across muted channels.
+     * @public
+     */
+    mutedUnreadMessageCount: number;
+    /**
+     * Unread direct mentions of the current user.
+     * @public
+     */
+    unreadMentionCount: number;
+}
+/**
+ * Inbox section with metadata, channel count, and unread counters.
+ * @public
+ */
+export interface Section {
+    /**
+     * Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
+     * @public
+     */
+    sectionId: string;
+    /**
+     * Display name of the section.
+     * @public
+     */
+    name: string;
+    /**
+     * Whether the section is system-managed or user-defined.
+     * @public
+     */
+    type: SectionType;
+    /**
+     * Total channels assigned to this section.
+     * @public
+     */
+    channelCount: number;
+    /**
+     * Aggregated unread counters for an inbox section.
+     * @public
+     */
+    unread: SectionUnreadCounters;
+}
+/**
+ * @public
+ */
+export interface GetInboxOutput {
+    /**
+     * Recent channels with per-user state and last-message preview.
+     * @public
+     */
+    channels: (InboxChannel)[];
+    /**
+     * Inbox sections with channel counts and unread counters.
+     * @public
+     */
+    sections: (Section)[];
+}
+/**
+ * @public
+ */
+export interface GetMessageInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    messageId: string;
+}
+/**
+ * @public
+ */
+export interface GetMessageOutput {
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+}
+/**
+ * @public
+ */
+export interface ListChannelsInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    /**
+     * Section to list. Defaults to `all`.
+     * @public
+     */
+    section?: string | undefined;
+    /**
+     * Optional refinement applied on top of the section.
+     * @public
+     */
+    filter?: ChannelsFilter | undefined;
+    /**
+     * Opaque continuation token from the previous response.
+     * @public
+     */
+    cursor?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListChannelsOutput {
+    /**
+     * Ordered page of channels for the requested section.
+     * @public
+     */
+    channels: (InboxChannel)[];
+    /**
+     * Cursor for the next page. Absent when there are no more pages.
+     * @public
+     */
+    nextCursor?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const MentionsFilter: {
+    /**
+     * Unread mentions only.
+     */
+    readonly UNREAD: "unread";
+};
+/**
+ * @public
+ */
+export type MentionsFilter = typeof MentionsFilter[keyof typeof MentionsFilter];
+/**
+ * @public
+ */
+export interface ListMentionsInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    /**
+     * Optional refinement.
+     * @public
+     */
+    filter?: MentionsFilter | undefined;
+    /**
+     * Opaque continuation token from the previous response.
+     * @public
+     */
+    cursor?: string | undefined;
+}
+/**
+ * Compact channel preview returned alongside a mention entry.
+ * @public
+ */
+export interface MentionChannelPreview {
+    channelId: string;
+    /**
+     * Type of channel.
+     * @public
+     */
+    channelType: ChannelType;
+    /**
+     * Channel subject.
+     * @public
+     */
+    subject?: string | undefined;
+    /**
+     * Channel picture URL.
+     * @public
+     */
+    picture?: string | undefined;
+    /**
+     * Current number of members.
+     * @public
+     */
+    memberCount: number;
+    /**
+     * Channel version. Increments on every channel mutation.
+     * @public
+     */
+    channelVersion: number;
+    /**
+     * ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
+     * @public
+     */
+    lastActivityAt: string;
+}
+/**
+ * Mention entry. Identifies a message that mentioned the current user, with the user's read state and an embedded copy of the message and its channel.
+ * @public
+ */
+export interface MentionEntry {
+    channelId: string;
+    messageId: string;
+    /**
+     * Monotonic per-channel sequence covering every channel mutation. Used to page the channel timeline.
+     * @public
+     */
+    timelineSeq: number;
+    /**
+     * Monotonic per-channel sequence covering only visible messages. Used for unread counts and read pointers.
+     * @public
+     */
+    visibleSeq?: number | undefined;
+    /**
+     * Timestamp at which the mention was recorded.
+     * @public
+     */
+    mentionAddedAt: string;
+    /**
+     * True when the user has read this mention.
+     * @public
+     */
+    read: boolean;
+    /**
+     * Timestamp at which the mention was read.
+     * @public
+     */
+    readAt?: string | undefined;
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+    /**
+     * Compact channel preview returned alongside a mention entry.
+     * @public
+     */
+    channel: MentionChannelPreview;
+}
+/**
+ * @public
+ */
+export interface ListMentionsOutput {
+    /**
+     * Mentions ordered by most recent `mentionAddedAt` first.
+     * @public
+     */
+    mentions: (MentionEntry)[];
+    /**
+     * Cursor for the next page. Absent when there are no more pages.
+     * @public
+     */
+    nextCursor?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListMessagesInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    /**
+     * Optional inclusive lower bound on `timelineSeq`. Combine with `to` for a bounded window, or use alone to scroll forward from a known anchor.
+     * @public
+     */
+    from?: number | undefined;
+    /**
+     * Optional inclusive upper bound on `timelineSeq`. Combine with `from` for a bounded window, or use alone to scroll back from a known anchor.
+     * @public
+     */
+    to?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface ListMessagesOutput {
+    /**
+     * Messages ordered newest-first by `timelineSeq`.
+     * @public
+     */
+    messages: (Message)[];
+}
+/**
+ * Forward reference supplied by the client. The server resolves the original author and snapshot fields at write time.
+ * @public
+ */
+export interface MessageForwardRef {
+    channelId: string;
+    messageId: string;
+}
+/**
+ * Quote reference supplied by the client. The server resolves the author and snapshot fields at write time.
+ * @public
+ */
+export interface MessageQuoteRef {
+    channelId: string;
+    messageId: string;
+}
+/**
+ * @public
+ */
+export interface PinMessageInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    messageId: string;
+}
+/**
+ * @public
+ */
+export interface PinMessageOutput {
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+}
+/**
+ * @public
+ */
+export interface RemoveReactionInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    messageId: string;
+    /**
+     * Reaction key. Free-form lowercase identifier (e.g. `thumbsup`, `heart`).
+     * @public
+     */
+    type: string;
+}
+/**
+ * @public
+ */
+export interface RemoveReactionOutput {
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+}
+/**
+ * @public
+ */
+export interface SendMessageInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    /**
+     * Rendering hint for the message.
+     * @public
+     */
+    messageType?: MessageType | undefined;
+    /**
+     * Text body. Required unless `attachments` is non-empty.
+     * @public
+     */
+    text?: string | undefined;
+    /**
+     * Pre-uploaded file references. Required unless `text` is provided.
+     * @public
+     */
+    attachments?: (MessageAttachmentRequest)[] | undefined;
+    /**
+     * Direct `@user` ids. `@all`, `@here`, and `@channel` are not supported.
+     * @public
+     */
+    mentions?: (string)[] | undefined;
+    /**
+     * Reply context referencing a quoted message.
+     * @public
+     */
+    quote?: MessageQuoteRef | undefined;
+    /**
+     * Source reference for a forwarded message.
+     * @public
+     */
+    forward?: MessageForwardRef | undefined;
+    /**
+     * Backend / S2S only flag. User requests carrying `system: true` are rejected.
+     * @public
+     */
+    system?: boolean | undefined;
+}
+/**
+ * @public
+ */
+export interface SendMessageOutput {
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+}
+/**
+ * @public
+ */
+export interface UnpinMessageInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    channelId: string;
+    messageId: string;
+}
+/**
+ * @public
+ */
+export interface UnpinMessageOutput {
+    /**
+     * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
+     * @public
+     */
+    message: Message;
+}