@microsoft/teams.api 0.2.7

package/dist/models/card/index.mjs

@@ -0,0 +1,13 @@
+export * from './animation-card';
+export * from './audio-card';
+export * from './basic-card';
+export * from './card-image';
+export * from './hero-card';
+export * from './media-card';
+export * from './media-url';
+export * from './thumbnail-card';
+export * from './thumbnail-url';
+export * from './video-card';
+export * from './card-action';
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/models/card/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs","sourcesContent":[]}

package/dist/models/card/media-card.d.mts

@@ -0,0 +1,61 @@
+import { CardAction } from './card-action.mjs';
+import { MediaUrl } from './media-url.mjs';
+import { ThumbnailUrl } from './thumbnail-url.mjs';
+
+/**
+ * Media card
+ */
+type MediaCard = {
+    /**
+     * Title of this card
+     */
+    title?: string;
+    /**
+     * Subtitle of this card
+     */
+    subtitle?: string;
+    /**
+     * Text of this card
+     */
+    text?: string;
+    /**
+     * Thumbnail placeholder
+     */
+    image?: ThumbnailUrl;
+    /**
+     * Media URLs for this card. When this field contains more than one URL, each URL is an
+     * alternative format of the same content.
+     */
+    media?: MediaUrl[];
+    /**
+     * Actions on this card
+     */
+    buttons?: CardAction[];
+    /**
+     * This content may be shared with others (default?:true)
+     */
+    shareable?: boolean;
+    /**
+     * Should the client loop playback at end of content (default?:true)
+     */
+    autoloop?: boolean;
+    /**
+     * Should the client automatically start playback of media in this card (default?:true)
+     */
+    autostart?: boolean;
+    /**
+     * Aspect ratio of thumbnail/media placeholder. Allowed values are "16?:9" and "4?:3"
+     */
+    aspect?: string;
+    /**
+     * Describes the length of the media content without requiring a receiver to open the content.
+     * Formatted as an ISO 8601 Duration field.
+     */
+    duration?: string;
+    /**
+     * Supplementary parameter for this card
+     */
+    value?: any;
+};
+
+export type { MediaCard };

package/dist/models/card/media-card.d.ts

@@ -0,0 +1,61 @@
+import { CardAction } from './card-action.js';
+import { MediaUrl } from './media-url.js';
+import { ThumbnailUrl } from './thumbnail-url.js';
+
+/**
+ * Media card
+ */
+type MediaCard = {
+    /**
+     * Title of this card
+     */
+    title?: string;
+    /**
+     * Subtitle of this card
+     */
+    subtitle?: string;
+    /**
+     * Text of this card
+     */
+    text?: string;
+    /**
+     * Thumbnail placeholder
+     */
+    image?: ThumbnailUrl;
+    /**
+     * Media URLs for this card. When this field contains more than one URL, each URL is an
+     * alternative format of the same content.
+     */
+    media?: MediaUrl[];
+    /**
+     * Actions on this card
+     */
+    buttons?: CardAction[];
+    /**
+     * This content may be shared with others (default?:true)
+     */
+    shareable?: boolean;
+    /**
+     * Should the client loop playback at end of content (default?:true)
+     */
+    autoloop?: boolean;
+    /**
+     * Should the client automatically start playback of media in this card (default?:true)
+     */
+    autostart?: boolean;
+    /**
+     * Aspect ratio of thumbnail/media placeholder. Allowed values are "16?:9" and "4?:3"
+     */
+    aspect?: string;
+    /**
+     * Describes the length of the media content without requiring a receiver to open the content.
+     * Formatted as an ISO 8601 Duration field.
+     */
+    duration?: string;
+    /**
+     * Supplementary parameter for this card
+     */
+    value?: any;
+};
+
+export type { MediaCard };

package/dist/models/card/media-card.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=media-card.js.map
+//# sourceMappingURL=media-card.js.map

package/dist/models/card/media-card.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"media-card.js"}

package/dist/models/card/media-card.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=media-card.mjs.map
+//# sourceMappingURL=media-card.mjs.map

package/dist/models/card/media-card.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"media-card.mjs"}

package/dist/models/card/media-url.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Media URL
+ */
+type MediaUrl = {
+    /**
+     * Url for the media
+     */
+    url: string;
+    /**
+     * Optional profile hint to the client to differentiate multiple MediaUrl objects from each other
+     */
+    profile?: string;
+};
+
+export type { MediaUrl };

package/dist/models/card/media-url.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Media URL
+ */
+type MediaUrl = {
+    /**
+     * Url for the media
+     */
+    url: string;
+    /**
+     * Optional profile hint to the client to differentiate multiple MediaUrl objects from each other
+     */
+    profile?: string;
+};
+
+export type { MediaUrl };

package/dist/models/card/media-url.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=media-url.js.map
+//# sourceMappingURL=media-url.js.map

package/dist/models/card/media-url.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"media-url.js"}

package/dist/models/card/media-url.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=media-url.mjs.map
+//# sourceMappingURL=media-url.mjs.map

package/dist/models/card/media-url.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"media-url.mjs"}

package/dist/models/card/thumbnail-card.d.mts

@@ -0,0 +1,34 @@
+import { CardAction } from './card-action.mjs';
+import { CardImage } from './card-image.mjs';
+
+/**
+ * A thumbnail card (card with a single, small thumbnail image)
+ */
+type ThumbnailCard = {
+    /**
+     * Title of the card
+     */
+    title?: string;
+    /**
+     * Subtitle of the card
+     */
+    subtitle?: string;
+    /**
+     * Text for the card
+     */
+    text?: string;
+    /**
+     * Array of images for the card
+     */
+    images?: CardImage[];
+    /**
+     * Set of actions applicable to the current card
+     */
+    buttons?: CardAction[];
+    /**
+     * This action will be activated when user taps on the card itself
+     */
+    tap?: CardAction;
+};
+
+export type { ThumbnailCard };

package/dist/models/card/thumbnail-card.d.ts

@@ -0,0 +1,34 @@
+import { CardAction } from './card-action.js';
+import { CardImage } from './card-image.js';
+
+/**
+ * A thumbnail card (card with a single, small thumbnail image)
+ */
+type ThumbnailCard = {
+    /**
+     * Title of the card
+     */
+    title?: string;
+    /**
+     * Subtitle of the card
+     */
+    subtitle?: string;
+    /**
+     * Text for the card
+     */
+    text?: string;
+    /**
+     * Array of images for the card
+     */
+    images?: CardImage[];
+    /**
+     * Set of actions applicable to the current card
+     */
+    buttons?: CardAction[];
+    /**
+     * This action will be activated when user taps on the card itself
+     */
+    tap?: CardAction;
+};
+
+export type { ThumbnailCard };

package/dist/models/card/thumbnail-card.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=thumbnail-card.js.map
+//# sourceMappingURL=thumbnail-card.js.map

package/dist/models/card/thumbnail-card.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"thumbnail-card.js"}

package/dist/models/card/thumbnail-card.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=thumbnail-card.mjs.map
+//# sourceMappingURL=thumbnail-card.mjs.map

package/dist/models/card/thumbnail-card.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"thumbnail-card.mjs"}

package/dist/models/card/thumbnail-url.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Thumbnail URL
+ */
+type ThumbnailUrl = {
+    /**
+     * URL pointing to the thumbnail to use for media content
+     */
+    url: string;
+    /**
+     * HTML alt text to include on this thumbnail image
+     */
+    alt: string;
+};
+
+export type { ThumbnailUrl };

package/dist/models/card/thumbnail-url.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Thumbnail URL
+ */
+type ThumbnailUrl = {
+    /**
+     * URL pointing to the thumbnail to use for media content
+     */
+    url: string;
+    /**
+     * HTML alt text to include on this thumbnail image
+     */
+    alt: string;
+};
+
+export type { ThumbnailUrl };

package/dist/models/card/thumbnail-url.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=thumbnail-url.js.map
+//# sourceMappingURL=thumbnail-url.js.map

package/dist/models/card/thumbnail-url.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"thumbnail-url.js"}

package/dist/models/card/thumbnail-url.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=thumbnail-url.mjs.map
+//# sourceMappingURL=thumbnail-url.mjs.map

package/dist/models/card/thumbnail-url.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"thumbnail-url.mjs"}

package/dist/models/card/video-card.d.mts

@@ -0,0 +1,61 @@
+import { CardAction } from './card-action.mjs';
+import { MediaUrl } from './media-url.mjs';
+import { ThumbnailUrl } from './thumbnail-url.mjs';
+
+/**
+ * Video card
+ */
+type VideoCard = {
+    /**
+     * Title of this card
+     */
+    title?: string;
+    /**
+     * Subtitle of this card
+     */
+    subtitle?: string;
+    /**
+     * Text of this card
+     */
+    text?: string;
+    /**
+     * Thumbnail placeholder
+     */
+    image?: ThumbnailUrl;
+    /**
+     * Media URLs for this card. When this field contains more than one URL, each URL is an
+     * alternative format of the same content.
+     */
+    media?: MediaUrl[];
+    /**
+     * Actions on this card
+     */
+    buttons?: CardAction[];
+    /**
+     * This content may be shared with others (default?:true)
+     */
+    shareable?: boolean;
+    /**
+     * Should the client loop playback at end of content (default?:true)
+     */
+    autoloop?: boolean;
+    /**
+     * Should the client automatically start playback of media in this card (default?:true)
+     */
+    autostart?: boolean;
+    /**
+     * Aspect ratio of thumbnail/media placeholder. Allowed values are "16?:9" and "4?:3"
+     */
+    aspect?: string;
+    /**
+     * Describes the length of the media content without requiring a receiver to open the content.
+     * Formatted as an ISO 8601 Duration field.
+     */
+    duration?: string;
+    /**
+     * Supplementary parameter for this card
+     */
+    value?: any;
+};
+
+export type { VideoCard };

package/dist/models/card/video-card.d.ts

@@ -0,0 +1,61 @@
+import { CardAction } from './card-action.js';
+import { MediaUrl } from './media-url.js';
+import { ThumbnailUrl } from './thumbnail-url.js';
+
+/**
+ * Video card
+ */
+type VideoCard = {
+    /**
+     * Title of this card
+     */
+    title?: string;
+    /**
+     * Subtitle of this card
+     */
+    subtitle?: string;
+    /**
+     * Text of this card
+     */
+    text?: string;
+    /**
+     * Thumbnail placeholder
+     */
+    image?: ThumbnailUrl;
+    /**
+     * Media URLs for this card. When this field contains more than one URL, each URL is an
+     * alternative format of the same content.
+     */
+    media?: MediaUrl[];
+    /**
+     * Actions on this card
+     */
+    buttons?: CardAction[];
+    /**
+     * This content may be shared with others (default?:true)
+     */
+    shareable?: boolean;
+    /**
+     * Should the client loop playback at end of content (default?:true)
+     */
+    autoloop?: boolean;
+    /**
+     * Should the client automatically start playback of media in this card (default?:true)
+     */
+    autostart?: boolean;
+    /**
+     * Aspect ratio of thumbnail/media placeholder. Allowed values are "16?:9" and "4?:3"
+     */
+    aspect?: string;
+    /**
+     * Describes the length of the media content without requiring a receiver to open the content.
+     * Formatted as an ISO 8601 Duration field.
+     */
+    duration?: string;
+    /**
+     * Supplementary parameter for this card
+     */
+    value?: any;
+};
+
+export type { VideoCard };

package/dist/models/card/video-card.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=video-card.js.map
+//# sourceMappingURL=video-card.js.map

package/dist/models/card/video-card.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"video-card.js"}

package/dist/models/card/video-card.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=video-card.mjs.map
+//# sourceMappingURL=video-card.mjs.map

package/dist/models/card/video-card.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"video-card.mjs"}

package/dist/models/channel-data/channel-info.d.mts

@@ -0,0 +1,22 @@
+/**
+ *
+ * An interface representing ChannelInfo.
+ * A channel info object which decribes the channel.
+ *
+ */
+type ChannelInfo = {
+    /**
+     * @member {string} [id] Unique identifier representing a channel
+     */
+    id: string;
+    /**
+     * @member {string} [name] Name of the channel
+     */
+    name?: string;
+    /**
+     * @member {string} [type] The type of the channel. Valid values are standard, shared and private.
+     */
+    type?: 'standard' | 'shared' | 'private';
+};
+
+export type { ChannelInfo };

package/dist/models/channel-data/channel-info.d.ts

@@ -0,0 +1,22 @@
+/**
+ *
+ * An interface representing ChannelInfo.
+ * A channel info object which decribes the channel.
+ *
+ */
+type ChannelInfo = {
+    /**
+     * @member {string} [id] Unique identifier representing a channel
+     */
+    id: string;
+    /**
+     * @member {string} [name] Name of the channel
+     */
+    name?: string;
+    /**
+     * @member {string} [type] The type of the channel. Valid values are standard, shared and private.
+     */
+    type?: 'standard' | 'shared' | 'private';
+};
+
+export type { ChannelInfo };

package/dist/models/channel-data/channel-info.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=channel-info.js.map
+//# sourceMappingURL=channel-info.js.map

package/dist/models/channel-data/channel-info.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"channel-info.js"}

package/dist/models/channel-data/channel-info.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=channel-info.mjs.map
+//# sourceMappingURL=channel-info.mjs.map

package/dist/models/channel-data/channel-info.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"channel-info.mjs"}

package/dist/models/channel-data/index.d.mts

@@ -0,0 +1,78 @@
+import { MeetingInfo } from '../meeting/meeting-info.mjs';
+import { ChannelInfo } from './channel-info.mjs';
+import { NotificationInfo } from './notification-info.mjs';
+import { ChannelDataSettings } from './settings.mjs';
+import { TeamInfo } from './team-info.mjs';
+import { TenantInfo } from './tenant-info.mjs';
+import '../account.mjs';
+import '../role.mjs';
+import '../meeting/meeting-details.mjs';
+
+/**
+ *
+ * An interface representing ChannelData.
+ * Channel data specific to messages received in Microsoft Teams
+ *
+ */
+type ChannelData = {
+    /**
+     * @member {ChannelInfo} [channel] Information about the channel in which the
+     * message was sent.
+     */
+    channel?: ChannelInfo;
+    /**
+     * @member {string} [eventType] Type of event.
+     */
+    eventType?: unknown;
+    /**
+     * @member {TeamInfo} [team] Information about the team in which the message
+     * was sent.
+     */
+    team?: TeamInfo;
+    /**
+     * @member {NotificationInfo} [notification] Notification settings for the
+     * message.
+     */
+    notification?: NotificationInfo;
+    /**
+     * @member {TenantInfo} [tenant] Information about the tenant in which the
+     * message was sent.
+     */
+    tenant?: TenantInfo;
+    /**
+     * @member {MeetingInfo} [meeting] Information about the tenant in which the
+     * message was sent.
+     */
+    meeting?: MeetingInfo;
+    /**
+     * @member {ChannelDataSettings} [settings] Information about the settings in which the
+     * message was sent.
+     */
+    settings?: ChannelDataSettings;
+    /**
+     * Whether or not the feedback loop feature is enabled.
+     */
+    feedbackLoopEnabled?: boolean;
+    /**
+     * ID of the stream.
+     * @remarks
+     * Assigned after the initial update is sent.
+     */
+    streamId?: string;
+    /**
+     * The type of message being sent.
+     * @remarks
+     * `informative` - An informative update.
+     * `streaming` - A chunk of partial message text.
+     * `final` - The final message.
+     */
+    streamType?: 'informative' | 'streaming' | 'final';
+    /**
+     * Sequence number of the message in the stream.
+     * @remarks
+     * Starts at 1 for the first message and increments from there.
+     */
+    streamSequence?: number;
+};
+
+export { type ChannelData, ChannelDataSettings, ChannelInfo, NotificationInfo, TeamInfo, TenantInfo };