@microsoft/teams.api 0.2.7

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

@@ -0,0 +1,78 @@
+import { MeetingInfo } from '../meeting/meeting-info.js';
+import { ChannelInfo } from './channel-info.js';
+import { NotificationInfo } from './notification-info.js';
+import { ChannelDataSettings } from './settings.js';
+import { TeamInfo } from './team-info.js';
+import { TenantInfo } from './tenant-info.js';
+import '../account.js';
+import '../role.js';
+import '../meeting/meeting-details.js';
+
+/**
+ *
+ * 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 };

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

@@ -0,0 +1,42 @@
+'use strict';
+
+var channelInfo = require('./channel-info');
+var notificationInfo = require('./notification-info');
+var settings = require('./settings');
+var teamInfo = require('./team-info');
+var tenantInfo = require('./tenant-info');
+
+
+
+Object.keys(channelInfo).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return channelInfo[k]; }
+	});
+});
+Object.keys(notificationInfo).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return notificationInfo[k]; }
+	});
+});
+Object.keys(settings).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return settings[k]; }
+	});
+});
+Object.keys(teamInfo).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return teamInfo[k]; }
+	});
+});
+Object.keys(tenantInfo).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return tenantInfo[k]; }
+	});
+});
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,7 @@
+export * from './channel-info';
+export * from './notification-info';
+export * from './settings';
+export * from './team-info';
+export * from './tenant-info';
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

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

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

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

@@ -0,0 +1,24 @@
+/**
+ *
+ * An interface representing NotificationInfo.
+ * Specifies if a notification is to be sent for the mentions.
+ *
+ */
+type NotificationInfo = {
+    /**
+     * @member {boolean} [alert] true if notification is to be sent to the user,
+     * false otherwise.
+     */
+    alert?: boolean;
+    /**
+     * @member {boolean} [alertInMeeting] true if a notification is to be shown to the user while in a meeting,
+     * false otherwise.
+     */
+    alertInMeeting?: boolean;
+    /**
+     * @member {string} [externalResourceUrl] the value of the notification's external resource url
+     */
+    externalResourceUrl?: string;
+};
+
+export type { NotificationInfo };

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

@@ -0,0 +1,24 @@
+/**
+ *
+ * An interface representing NotificationInfo.
+ * Specifies if a notification is to be sent for the mentions.
+ *
+ */
+type NotificationInfo = {
+    /**
+     * @member {boolean} [alert] true if notification is to be sent to the user,
+     * false otherwise.
+     */
+    alert?: boolean;
+    /**
+     * @member {boolean} [alertInMeeting] true if a notification is to be shown to the user while in a meeting,
+     * false otherwise.
+     */
+    alertInMeeting?: boolean;
+    /**
+     * @member {string} [externalResourceUrl] the value of the notification's external resource url
+     */
+    externalResourceUrl?: string;
+};
+
+export type { NotificationInfo };

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,22 @@
+import { ChannelInfo } from './channel-info.mjs';
+
+/**
+ *
+ * Settings within teams channel data specific to messages received in Microsoft Teams.
+ */
+type ChannelDataSettings = {
+    /**
+     * @member {ChannelInfo} [selectedChannel] Information about the selected Teams channel.
+     */
+    selectedChannel: ChannelInfo;
+    /**
+     * @member {any} [any] Additional properties that are not otherwise defined by the TeamsChannelDataSettings
+     * type but that might appear in the REST JSON object.
+     * @remarks With this, properties not represented in the defined type are not dropped when
+     * the JSON object is deserialized, but are instead stored in this property. Such properties
+     * will be written to a JSON object when the instance is serialized.
+     */
+    [properties: string]: unknown;
+};
+
+export type { ChannelDataSettings };

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

@@ -0,0 +1,22 @@
+import { ChannelInfo } from './channel-info.js';
+
+/**
+ *
+ * Settings within teams channel data specific to messages received in Microsoft Teams.
+ */
+type ChannelDataSettings = {
+    /**
+     * @member {ChannelInfo} [selectedChannel] Information about the selected Teams channel.
+     */
+    selectedChannel: ChannelInfo;
+    /**
+     * @member {any} [any] Additional properties that are not otherwise defined by the TeamsChannelDataSettings
+     * type but that might appear in the REST JSON object.
+     * @remarks With this, properties not represented in the defined type are not dropped when
+     * the JSON object is deserialized, but are instead stored in this property. Such properties
+     * will be written to a JSON object when the instance is serialized.
+     */
+    [properties: string]: unknown;
+};
+
+export type { ChannelDataSettings };

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,22 @@
+/**
+ *
+ * An interface representing TeamInfo.
+ * Describes a team
+ *
+ */
+type TeamInfo = {
+    /**
+     * @member {string} [id] Unique identifier representing a team
+     */
+    id: string;
+    /**
+     * @member {string} [name] Name of team.
+     */
+    name?: string;
+    /**
+     * @member {string} [aadGroupId] The Azure AD Teams group ID.
+     */
+    aadGroupId?: string;
+};
+
+export type { TeamInfo };

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

@@ -0,0 +1,22 @@
+/**
+ *
+ * An interface representing TeamInfo.
+ * Describes a team
+ *
+ */
+type TeamInfo = {
+    /**
+     * @member {string} [id] Unique identifier representing a team
+     */
+    id: string;
+    /**
+     * @member {string} [name] Name of team.
+     */
+    name?: string;
+    /**
+     * @member {string} [aadGroupId] The Azure AD Teams group ID.
+     */
+    aadGroupId?: string;
+};
+
+export type { TeamInfo };

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+/**
+ *
+ * An interface representing TenantInfo.
+ * Describes a tenant
+ *
+ */
+type TenantInfo = {
+    /**
+     * @member {string} [id] Unique identifier representing a tenant
+     */
+    id: string;
+};
+
+export type { TenantInfo };

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

@@ -0,0 +1,14 @@
+/**
+ *
+ * An interface representing TenantInfo.
+ * Describes a tenant
+ *
+ */
+type TenantInfo = {
+    /**
+     * @member {string} [id] Unique identifier representing a tenant
+     */
+    id: string;
+};
+
+export type { TenantInfo };

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

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

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

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

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

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

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

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

package/dist/models/channel-id.d.mts

@@ -0,0 +1,3 @@
+type ChannelID = 'webchat' | 'msteams' | Omit<string, 'webchat' | 'msteams'>;
+
+export type { ChannelID };

package/dist/models/channel-id.d.ts

@@ -0,0 +1,3 @@
+type ChannelID = 'webchat' | 'msteams' | Omit<string, 'webchat' | 'msteams'>;
+
+export type { ChannelID };

package/dist/models/channel-id.js

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

package/dist/models/channel-id.js.map

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

package/dist/models/channel-id.mjs

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

package/dist/models/channel-id.mjs.map

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

package/dist/models/config/config-auth.d.mts

@@ -0,0 +1,19 @@
+import { SuggestedActions } from '../suggested-actions.mjs';
+import '../card/card-action.mjs';
+
+/**
+ *
+ * An interface the bot's authentication config for SuggestedActions
+ */
+type ConfigAuth = {
+    /**
+     * @member {SuggestedActions} [suggestedActions] SuggestedActions for the Bot Config Auth
+     */
+    suggestedActions?: SuggestedActions;
+    /**
+     * @member {BotConfigAuthType} [type] Type of the Bot Config Auth
+     */
+    type: 'auth';
+};
+
+export type { ConfigAuth };

package/dist/models/config/config-auth.d.ts

@@ -0,0 +1,19 @@
+import { SuggestedActions } from '../suggested-actions.js';
+import '../card/card-action.js';
+
+/**
+ *
+ * An interface the bot's authentication config for SuggestedActions
+ */
+type ConfigAuth = {
+    /**
+     * @member {SuggestedActions} [suggestedActions] SuggestedActions for the Bot Config Auth
+     */
+    suggestedActions?: SuggestedActions;
+    /**
+     * @member {BotConfigAuthType} [type] Type of the Bot Config Auth
+     */
+    type: 'auth';
+};
+
+export type { ConfigAuth };

package/dist/models/config/config-auth.js

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

package/dist/models/config/config-auth.js.map

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

package/dist/models/config/config-auth.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=config-auth.mjs.map
+//# sourceMappingURL=config-auth.mjs.map

package/dist/models/config/config-auth.mjs.map

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

package/dist/models/config/config-response.d.mts

@@ -0,0 +1,31 @@
+import { ConfigAuth } from './config-auth.mjs';
+import { CacheInfo } from '../cache-info.mjs';
+import { TaskModuleResponse } from '../task-module/task-module-response.mjs';
+import '../suggested-actions.mjs';
+import '../card/card-action.mjs';
+import '../task-module/task-module-continue-response.mjs';
+import '../task-module/task-module-response-base.mjs';
+import '../task-module/task-module-task-info.mjs';
+import '../attachment/attachment.mjs';
+import '../task-module/task-module-message-response.mjs';
+
+/**
+ *
+ * An interface container for the Config response payload
+ */
+type ConfigResponse = {
+    /**
+     * @member {CacheInfo} [cacheInfo] The data of the ConfigResponse cache, including cache type and cache duration.
+     */
+    cacheInfo?: CacheInfo;
+    /**
+     * @member {ConfigResponseConfig} [config] The ConfigResponse config of BotConfigAuth or TaskModuleResponse
+     */
+    config: ConfigAuth | TaskModuleResponse;
+    /**
+     * @member {string} [responseType] The type of response 'config'.
+     */
+    responseType: 'config';
+};
+
+export type { ConfigResponse };

package/dist/models/config/config-response.d.ts

@@ -0,0 +1,31 @@
+import { ConfigAuth } from './config-auth.js';
+import { CacheInfo } from '../cache-info.js';
+import { TaskModuleResponse } from '../task-module/task-module-response.js';
+import '../suggested-actions.js';
+import '../card/card-action.js';
+import '../task-module/task-module-continue-response.js';
+import '../task-module/task-module-response-base.js';
+import '../task-module/task-module-task-info.js';
+import '../attachment/attachment.js';
+import '../task-module/task-module-message-response.js';
+
+/**
+ *
+ * An interface container for the Config response payload
+ */
+type ConfigResponse = {
+    /**
+     * @member {CacheInfo} [cacheInfo] The data of the ConfigResponse cache, including cache type and cache duration.
+     */
+    cacheInfo?: CacheInfo;
+    /**
+     * @member {ConfigResponseConfig} [config] The ConfigResponse config of BotConfigAuth or TaskModuleResponse
+     */
+    config: ConfigAuth | TaskModuleResponse;
+    /**
+     * @member {string} [responseType] The type of response 'config'.
+     */
+    responseType: 'config';
+};
+
+export type { ConfigResponse };

package/dist/models/config/config-response.js

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

package/dist/models/config/config-response.js.map

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

package/dist/models/config/config-response.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=config-response.mjs.map
+//# sourceMappingURL=config-response.mjs.map

package/dist/models/config/config-response.mjs.map

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

package/dist/models/config/index.d.mts

@@ -0,0 +1,11 @@
+export { ConfigAuth } from './config-auth.mjs';
+export { ConfigResponse } from './config-response.mjs';
+import '../suggested-actions.mjs';
+import '../card/card-action.mjs';
+import '../cache-info.mjs';
+import '../task-module/task-module-response.mjs';
+import '../task-module/task-module-continue-response.mjs';
+import '../task-module/task-module-response-base.mjs';
+import '../task-module/task-module-task-info.mjs';
+import '../attachment/attachment.mjs';
+import '../task-module/task-module-message-response.mjs';

package/dist/models/config/index.d.ts

@@ -0,0 +1,11 @@
+export { ConfigAuth } from './config-auth.js';
+export { ConfigResponse } from './config-response.js';
+import '../suggested-actions.js';
+import '../card/card-action.js';
+import '../cache-info.js';
+import '../task-module/task-module-response.js';
+import '../task-module/task-module-continue-response.js';
+import '../task-module/task-module-response-base.js';
+import '../task-module/task-module-task-info.js';
+import '../attachment/attachment.js';
+import '../task-module/task-module-message-response.js';

package/dist/models/config/index.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var configAuth = require('./config-auth');
+var configResponse = require('./config-response');
+
+
+
+Object.keys(configAuth).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return configAuth[k]; }
+	});
+});
+Object.keys(configResponse).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return configResponse[k]; }
+	});
+});
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/models/config/index.js.map

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

package/dist/models/config/index.mjs

@@ -0,0 +1,4 @@
+export * from './config-auth';
+export * from './config-response';
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

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

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