@knocklabs/node 0.6.19 → 1.0.0

package/resources/objects/objects.mjs

@@ -0,0 +1,136 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as BulkAPI from "./bulk.mjs";
+import { Bulk } from "./bulk.mjs";
+import { EntriesCursor } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Objects extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.bulk = new BulkAPI.Bulk(this._client);
+    }
+    /**
+     * Returns a paginated list of objects from the specified collection. Optionally
+     * includes preference data for the objects.
+     */
+    list(collection, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}`, (EntriesCursor), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Permanently removes an object from the specified collection. This operation
+     * cannot be undone.
+     */
+    delete(collection, id, options) {
+        return this._client.delete(path `/v1/objects/${collection}/${id}`, options);
+    }
+    /**
+     * Add subscriptions for an object. If a subscription already exists, it will be
+     * updated. This endpoint also handles
+     * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+     * for the `recipient`.
+     */
+    addSubscriptions(collection, objectID, body, options) {
+        return this._client.post(path `/v1/objects/${collection}/${objectID}/subscriptions`, { body, ...options });
+    }
+    /**
+     * Delete subscriptions for the specified recipients from an object. Returns the
+     * list of deleted subscriptions.
+     */
+    deleteSubscriptions(collection, objectID, body, options) {
+        return this._client.delete(path `/v1/objects/${collection}/${objectID}/subscriptions`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Retrieves a specific object by its ID from the specified collection. Returns the
+     * object with all its properties.
+     */
+    get(collection, id, options) {
+        return this._client.get(path `/v1/objects/${collection}/${id}`, options);
+    }
+    /**
+     * Returns the channel data for the specified object and channel.
+     */
+    getChannelData(collection, objectID, channelID, options) {
+        return this._client.get(path `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, options);
+    }
+    /**
+     * Returns the preference set for the specified object and preference set `id`.
+     */
+    getPreferences(collection, objectID, id, options) {
+        return this._client.get(path `/v1/objects/${collection}/${objectID}/preferences/${id}`, options);
+    }
+    /**
+     * Returns a paginated list of messages for a specific object in the given
+     * collection. Allows filtering by message status and provides various sorting
+     * options.
+     */
+    listMessages(collection, id, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}/${id}/messages`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * Returns a paginated list of preference sets for the specified object.
+     */
+    listPreferences(collection, objectID, options) {
+        return this._client.get(path `/v1/objects/${collection}/${objectID}/preferences`, options);
+    }
+    /**
+     * Returns a paginated list of schedules for an object.
+     */
+    listSchedules(collection, id, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}/${id}/schedules`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * List subscriptions for an object. Either list the recipients that subscribe to
+     * the provided object, or list the objects that the provided object is subscribed
+     * to. Determined by the `mode` query parameter.
+     */
+    listSubscriptions(collection, objectID, query = {}, options) {
+        return this._client.getAPIList(path `/v1/objects/${collection}/${objectID}/subscriptions`, (EntriesCursor), { query, ...options });
+    }
+    /**
+     * Creates a new object or updates an existing one in the specified collection.
+     * This operation is used to identify objects with their properties, as well as
+     * optional preferences and channel data.
+     */
+    set(collection, id, body, options) {
+        return this._client.put(path `/v1/objects/${collection}/${id}`, { body, ...options });
+    }
+    /**
+     * Sets the channel data for the specified object and channel. If no object exists
+     * in the current environment for the given `collection` and `object_id`, Knock
+     * will create the object as part of this request.
+     */
+    setChannelData(collection, objectID, channelID, body, options) {
+        return this._client.put(path `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Sets preferences within the given preference set. This is a destructive
+     * operation and will replace any existing preferences with the preferences given.
+     * If no object exists in the current environment for the given `:collection` and
+     * `:object_id`, Knock will create the object as part of this request. The
+     * preference set `:id` can be either `default` or a `tenant.id`. Learn more about
+     * [per-tenant preferences](/preferences/tenant-preferences).
+     */
+    setPreferences(collection, objectID, id, body, options) {
+        return this._client.put(path `/v1/objects/${collection}/${objectID}/preferences/${id}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Unsets the channel data for the specified object and channel.
+     */
+    unsetChannelData(collection, objectID, channelID, options) {
+        return this._client.delete(path `/v1/objects/${collection}/${objectID}/channel_data/${channelID}`, options);
+    }
+}
+Objects.Bulk = Bulk;
+//# sourceMappingURL=objects.mjs.map

package/resources/objects/objects.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.mjs","sourceRoot":"","sources":["../../src/resources/objects/objects.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,KAAK,OAAO;OACZ,EAAE,IAAI,EAA+D;OASrE,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAqNtD,CAAC;IAnNC;;;OAGG;IACH,IAAI,CACF,UAAkB,EAClB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,eAAe,UAAU,EAAE,EAAE,CAAA,aAAqB,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAkB,EAAE,EAAU,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CACd,UAAkB,EAClB,QAAgB,EAChB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;OAGG;IACH,mBAAmB,CACjB,UAAkB,EAClB,QAAgB,EAChB,IAAqC,EACrC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE;YACpF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,UAAkB,EAAE,EAAU,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,EAAU,EACV,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,UAAkB,EAClB,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,WAAW,EAC9C,CAAA,aAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,eAAe,CACb,UAAkB,EAClB,QAAgB,EAChB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,cAAc,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,aAAa,CACX,UAAkB,EAClB,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,YAAY,EAC/C,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,UAAkB,EAClB,QAAgB,EAChB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EACzD,CAAA,aAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,UAAkB,EAAE,EAAU,EAAE,IAAqB,EAAE,OAAwB;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EAAE;YAC7F,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CACZ,UAAkB,EAClB,QAAgB,EAChB,EAAU,EACV,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,gBAAgB,EAAE,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,UAAkB,EAClB,QAAgB,EAChB,SAAiB,EACjB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,IAAI,CAAA,eAAe,UAAU,IAAI,QAAQ,iBAAiB,SAAS,EAAE,EACrE,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAqWD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC"}

package/resources/objects.d.mts

@@ -0,0 +1,2 @@
+export * from "./objects/index.mjs";
+//# sourceMappingURL=objects.d.mts.map

package/resources/objects.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.mts","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":""}

package/resources/objects.d.ts

@@ -0,0 +1,2 @@
+export * from "./objects/index.js";
+//# sourceMappingURL=objects.d.ts.map

package/resources/objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":""}

package/resources/objects.js

@@ -0,0 +1,19 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./objects/index.js"), exports);
+//# sourceMappingURL=objects.js.map

package/resources/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,qDAAgC"}

package/resources/objects.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./objects/index.mjs";
+//# sourceMappingURL=objects.mjs.map

package/resources/objects.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.mjs","sourceRoot":"","sources":["../src/resources/objects.ts"],"names":[],"mappings":"AAAA,sFAAsF"}

package/resources/providers/index.d.mts

@@ -0,0 +1,4 @@
+export { MsTeams, type MsTeamCheckAuthResponse, type MsTeamListChannelsResponse, type MsTeamListTeamsResponse, type MsTeamRevokeAccessResponse, type MsTeamCheckAuthParams, type MsTeamListChannelsParams, type MsTeamListTeamsParams, type MsTeamRevokeAccessParams, type MsTeamListTeamsResponsesMsTeamsPagination, } from "./ms-teams.mjs";
+export { Providers } from "./providers.mjs";
+export { Slack, type SlackCheckAuthResponse, type SlackListChannelsResponse, type SlackRevokeAccessResponse, type SlackCheckAuthParams, type SlackListChannelsParams, type SlackRevokeAccessParams, type SlackListChannelsResponsesSlackChannelsCursor, } from "./slack.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/providers/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,yCAAyC,GAC/C;OACM,EAAE,SAAS,EAAE;OACb,EACL,KAAK,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,6CAA6C,GACnD"}

package/resources/providers/index.d.ts

@@ -0,0 +1,4 @@
+export { MsTeams, type MsTeamCheckAuthResponse, type MsTeamListChannelsResponse, type MsTeamListTeamsResponse, type MsTeamRevokeAccessResponse, type MsTeamCheckAuthParams, type MsTeamListChannelsParams, type MsTeamListTeamsParams, type MsTeamRevokeAccessParams, type MsTeamListTeamsResponsesMsTeamsPagination, } from "./ms-teams.js";
+export { Providers } from "./providers.js";
+export { Slack, type SlackCheckAuthResponse, type SlackListChannelsResponse, type SlackRevokeAccessResponse, type SlackCheckAuthParams, type SlackListChannelsParams, type SlackRevokeAccessParams, type SlackListChannelsResponsesSlackChannelsCursor, } from "./slack.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,yCAAyC,GAC/C;OACM,EAAE,SAAS,EAAE;OACb,EACL,KAAK,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,6CAA6C,GACnD"}

package/resources/providers/index.js

@@ -0,0 +1,11 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Slack = exports.Providers = exports.MsTeams = void 0;
+var ms_teams_1 = require("./ms-teams.js");
+Object.defineProperty(exports, "MsTeams", { enumerable: true, get: function () { return ms_teams_1.MsTeams; } });
+var providers_1 = require("./providers.js");
+Object.defineProperty(exports, "Providers", { enumerable: true, get: function () { return providers_1.Providers; } });
+var slack_1 = require("./slack.js");
+Object.defineProperty(exports, "Slack", { enumerable: true, get: function () { return slack_1.Slack; } });
+//# sourceMappingURL=index.js.map

package/resources/providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,0CAWoB;AAVlB,mGAAA,OAAO,OAAA;AAWT,4CAAwC;AAA/B,sGAAA,SAAS,OAAA;AAClB,oCASiB;AARf,8FAAA,KAAK,OAAA"}

package/resources/providers/index.mjs

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { MsTeams, } from "./ms-teams.mjs";
+export { Providers } from "./providers.mjs";
+export { Slack, } from "./slack.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/providers/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/providers/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,GAUR;OACM,EAAE,SAAS,EAAE;OACb,EACL,KAAK,GAQN"}

package/resources/providers/ms-teams.d.mts

@@ -0,0 +1,183 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { MsTeamsPagination, type MsTeamsPaginationParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class MsTeams extends APIResource {
+    /**
+     * Check if a connection to Microsoft Teams has been authorized for a given
+     * Microsoft Teams tenant object.
+     */
+    checkAuth(channelID: string, query: MsTeamCheckAuthParams, options?: RequestOptions): APIPromise<MsTeamCheckAuthResponse>;
+    /**
+     * List the Microsoft Teams channels within a team. By default, archived and
+     * private channels are excluded from the results.
+     */
+    listChannels(channelID: string, query: MsTeamListChannelsParams, options?: RequestOptions): APIPromise<MsTeamListChannelsResponse>;
+    /**
+     * Get a list of teams belonging to the Microsoft Entra tenant. By default,
+     * archived and private channels are excluded from the results.
+     */
+    listTeams(channelID: string, query: MsTeamListTeamsParams, options?: RequestOptions): PagePromise<MsTeamListTeamsResponsesMsTeamsPagination, MsTeamListTeamsResponse>;
+    /**
+     * Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
+     */
+    revokeAccess(channelID: string, params: MsTeamRevokeAccessParams, options?: RequestOptions): APIPromise<MsTeamRevokeAccessResponse>;
+}
+export type MsTeamListTeamsResponsesMsTeamsPagination = MsTeamsPagination<MsTeamListTeamsResponse>;
+/**
+ * The response from a Microsoft Teams auth check request.
+ */
+export interface MsTeamCheckAuthResponse {
+    /**
+     * A Microsoft Teams connection object.
+     */
+    connection: MsTeamCheckAuthResponse.Connection;
+}
+export declare namespace MsTeamCheckAuthResponse {
+    /**
+     * A Microsoft Teams connection object.
+     */
+    interface Connection {
+        /**
+         * Whether the Microsoft Teams connection is valid.
+         */
+        ok: boolean;
+        /**
+         * The reason for the Microsoft Teams connection if it is not valid.
+         */
+        reason?: string | null;
+    }
+}
+/**
+ * The response from a Microsoft Teams provider request, containing a list of
+ * channels.
+ */
+export interface MsTeamListChannelsResponse {
+    /**
+     * List of Microsoft Teams channels.
+     */
+    ms_teams_channels: Array<MsTeamListChannelsResponse.MsTeamsChannel>;
+}
+export declare namespace MsTeamListChannelsResponse {
+    interface MsTeamsChannel {
+        /**
+         * Microsoft Teams channel ID.
+         */
+        id: string;
+        /**
+         * Microsoft Teams channel name.
+         */
+        displayName: string;
+        /**
+         * Microsoft Teams channel created date and time.
+         */
+        createdDateTime?: string;
+        /**
+         * Microsoft Teams channel description.
+         */
+        description?: string | null;
+        /**
+         * Whether the Microsoft Teams channel is archived.
+         */
+        isArchived?: boolean;
+        /**
+         * Microsoft Teams channel membership type.
+         */
+        membershipType?: string;
+    }
+}
+export interface MsTeamListTeamsResponse {
+    /**
+     * Microsoft Teams team ID.
+     */
+    id: string;
+    /**
+     * Microsoft Teams team display name.
+     */
+    displayName: string;
+    /**
+     * Microsoft Teams team description.
+     */
+    description?: string | null;
+}
+/**
+ * A response indicating the operation was successful.
+ */
+export interface MsTeamRevokeAccessResponse {
+    /**
+     * OK response.
+     */
+    ok?: string;
+}
+export interface MsTeamCheckAuthParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+}
+export interface MsTeamListChannelsParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+    /**
+     * Microsoft Teams team ID.
+     */
+    team_id: string;
+    query_options?: MsTeamListChannelsParams.QueryOptions;
+}
+export declare namespace MsTeamListChannelsParams {
+    interface QueryOptions {
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to filter channels.
+         */
+        $filter?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to select specific properties.
+         */
+        $select?: string;
+    }
+}
+export interface MsTeamListTeamsParams extends MsTeamsPaginationParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+    query_options?: MsTeamListTeamsParams.QueryOptions;
+}
+export declare namespace MsTeamListTeamsParams {
+    interface QueryOptions {
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to filter teams.
+         */
+        $filter?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to select fields on a team.
+         */
+        $select?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to retrieve the next page of results.
+         */
+        $skiptoken?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to limit the number of teams returned.
+         */
+        $top?: number;
+    }
+}
+export interface MsTeamRevokeAccessParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+}
+export declare namespace MsTeams {
+    export { type MsTeamCheckAuthResponse as MsTeamCheckAuthResponse, type MsTeamListChannelsResponse as MsTeamListChannelsResponse, type MsTeamListTeamsResponse as MsTeamListTeamsResponse, type MsTeamRevokeAccessResponse as MsTeamRevokeAccessResponse, type MsTeamListTeamsResponsesMsTeamsPagination as MsTeamListTeamsResponsesMsTeamsPagination, type MsTeamCheckAuthParams as MsTeamCheckAuthParams, type MsTeamListChannelsParams as MsTeamListChannelsParams, type MsTeamListTeamsParams as MsTeamListTeamsParams, type MsTeamRevokeAccessParams as MsTeamRevokeAccessParams, };
+}
+//# sourceMappingURL=ms-teams.d.mts.map

package/resources/providers/ms-teams.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ms-teams.d.mts","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE,WAAW,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;OAGG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,uBAAuB,CAAC;IAQlF;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAO1C;AAED,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;CAChD;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACrE;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,wBAAwB,CAAC,YAAY,CAAC;CACvD;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B,aAAa,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC;CACpD;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/providers/ms-teams.d.ts

@@ -0,0 +1,183 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { MsTeamsPagination, type MsTeamsPaginationParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class MsTeams extends APIResource {
+    /**
+     * Check if a connection to Microsoft Teams has been authorized for a given
+     * Microsoft Teams tenant object.
+     */
+    checkAuth(channelID: string, query: MsTeamCheckAuthParams, options?: RequestOptions): APIPromise<MsTeamCheckAuthResponse>;
+    /**
+     * List the Microsoft Teams channels within a team. By default, archived and
+     * private channels are excluded from the results.
+     */
+    listChannels(channelID: string, query: MsTeamListChannelsParams, options?: RequestOptions): APIPromise<MsTeamListChannelsResponse>;
+    /**
+     * Get a list of teams belonging to the Microsoft Entra tenant. By default,
+     * archived and private channels are excluded from the results.
+     */
+    listTeams(channelID: string, query: MsTeamListTeamsParams, options?: RequestOptions): PagePromise<MsTeamListTeamsResponsesMsTeamsPagination, MsTeamListTeamsResponse>;
+    /**
+     * Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
+     */
+    revokeAccess(channelID: string, params: MsTeamRevokeAccessParams, options?: RequestOptions): APIPromise<MsTeamRevokeAccessResponse>;
+}
+export type MsTeamListTeamsResponsesMsTeamsPagination = MsTeamsPagination<MsTeamListTeamsResponse>;
+/**
+ * The response from a Microsoft Teams auth check request.
+ */
+export interface MsTeamCheckAuthResponse {
+    /**
+     * A Microsoft Teams connection object.
+     */
+    connection: MsTeamCheckAuthResponse.Connection;
+}
+export declare namespace MsTeamCheckAuthResponse {
+    /**
+     * A Microsoft Teams connection object.
+     */
+    interface Connection {
+        /**
+         * Whether the Microsoft Teams connection is valid.
+         */
+        ok: boolean;
+        /**
+         * The reason for the Microsoft Teams connection if it is not valid.
+         */
+        reason?: string | null;
+    }
+}
+/**
+ * The response from a Microsoft Teams provider request, containing a list of
+ * channels.
+ */
+export interface MsTeamListChannelsResponse {
+    /**
+     * List of Microsoft Teams channels.
+     */
+    ms_teams_channels: Array<MsTeamListChannelsResponse.MsTeamsChannel>;
+}
+export declare namespace MsTeamListChannelsResponse {
+    interface MsTeamsChannel {
+        /**
+         * Microsoft Teams channel ID.
+         */
+        id: string;
+        /**
+         * Microsoft Teams channel name.
+         */
+        displayName: string;
+        /**
+         * Microsoft Teams channel created date and time.
+         */
+        createdDateTime?: string;
+        /**
+         * Microsoft Teams channel description.
+         */
+        description?: string | null;
+        /**
+         * Whether the Microsoft Teams channel is archived.
+         */
+        isArchived?: boolean;
+        /**
+         * Microsoft Teams channel membership type.
+         */
+        membershipType?: string;
+    }
+}
+export interface MsTeamListTeamsResponse {
+    /**
+     * Microsoft Teams team ID.
+     */
+    id: string;
+    /**
+     * Microsoft Teams team display name.
+     */
+    displayName: string;
+    /**
+     * Microsoft Teams team description.
+     */
+    description?: string | null;
+}
+/**
+ * A response indicating the operation was successful.
+ */
+export interface MsTeamRevokeAccessResponse {
+    /**
+     * OK response.
+     */
+    ok?: string;
+}
+export interface MsTeamCheckAuthParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+}
+export interface MsTeamListChannelsParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+    /**
+     * Microsoft Teams team ID.
+     */
+    team_id: string;
+    query_options?: MsTeamListChannelsParams.QueryOptions;
+}
+export declare namespace MsTeamListChannelsParams {
+    interface QueryOptions {
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to filter channels.
+         */
+        $filter?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to select specific properties.
+         */
+        $select?: string;
+    }
+}
+export interface MsTeamListTeamsParams extends MsTeamsPaginationParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+    query_options?: MsTeamListTeamsParams.QueryOptions;
+}
+export declare namespace MsTeamListTeamsParams {
+    interface QueryOptions {
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to filter teams.
+         */
+        $filter?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to select fields on a team.
+         */
+        $select?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to retrieve the next page of results.
+         */
+        $skiptoken?: string;
+        /**
+         * [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
+         * to the Microsoft Graph API to limit the number of teams returned.
+         */
+        $top?: number;
+    }
+}
+export interface MsTeamRevokeAccessParams {
+    /**
+     * A JSON encoded string containing the Microsoft Teams tenant object reference.
+     */
+    ms_teams_tenant_object: string;
+}
+export declare namespace MsTeams {
+    export { type MsTeamCheckAuthResponse as MsTeamCheckAuthResponse, type MsTeamListChannelsResponse as MsTeamListChannelsResponse, type MsTeamListTeamsResponse as MsTeamListTeamsResponse, type MsTeamRevokeAccessResponse as MsTeamRevokeAccessResponse, type MsTeamListTeamsResponsesMsTeamsPagination as MsTeamListTeamsResponsesMsTeamsPagination, type MsTeamCheckAuthParams as MsTeamCheckAuthParams, type MsTeamListChannelsParams as MsTeamListChannelsParams, type MsTeamListTeamsParams as MsTeamListTeamsParams, type MsTeamRevokeAccessParams as MsTeamRevokeAccessParams, };
+}
+//# sourceMappingURL=ms-teams.d.ts.map

package/resources/providers/ms-teams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ms-teams.d.ts","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE,WAAW,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;OAGG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,uBAAuB,CAAC;IAQlF;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAO1C;AAED,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;CAChD;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACrE;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,wBAAwB,CAAC,YAAY,CAAC;CACvD;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B,aAAa,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC;CACpD;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}