@knocklabs/node 0.6.19 → 1.0.0

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

@@ -0,0 +1,260 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { MsTeamsPagination, type MsTeamsPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export 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> {
+    return this._client.get(path`/v1/providers/ms-teams/${channelID}/auth_check`, { query, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.get(path`/v1/providers/ms-teams/${channelID}/channels`, { query, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.getAPIList(
+      path`/v1/providers/ms-teams/${channelID}/teams`,
+      MsTeamsPagination<MsTeamListTeamsResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
+   */
+  revokeAccess(
+    channelID: string,
+    params: MsTeamRevokeAccessParams,
+    options?: RequestOptions,
+  ): APIPromise<MsTeamRevokeAccessResponse> {
+    const { ms_teams_tenant_object } = params;
+    return this._client.put(path`/v1/providers/ms-teams/${channelID}/revoke_access`, {
+      query: { ms_teams_tenant_object },
+      ...options,
+    });
+  }
+}
+
+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 namespace MsTeamCheckAuthResponse {
+  /**
+   * A Microsoft Teams connection object.
+   */
+  export 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 namespace MsTeamListChannelsResponse {
+  export 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 namespace MsTeamListChannelsParams {
+  export 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 namespace MsTeamListTeamsParams {
+  export 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,
+  };
+}

package/src/resources/providers/providers.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MsTeamsAPI from './ms-teams';
+import {
+  MsTeamCheckAuthParams,
+  MsTeamCheckAuthResponse,
+  MsTeamListChannelsParams,
+  MsTeamListChannelsResponse,
+  MsTeamListTeamsParams,
+  MsTeamListTeamsResponse,
+  MsTeamListTeamsResponsesMsTeamsPagination,
+  MsTeamRevokeAccessParams,
+  MsTeamRevokeAccessResponse,
+  MsTeams,
+} from './ms-teams';
+import * as SlackAPI from './slack';
+import {
+  Slack,
+  SlackCheckAuthParams,
+  SlackCheckAuthResponse,
+  SlackListChannelsParams,
+  SlackListChannelsResponse,
+  SlackListChannelsResponsesSlackChannelsCursor,
+  SlackRevokeAccessParams,
+  SlackRevokeAccessResponse,
+} from './slack';
+
+export class Providers extends APIResource {
+  slack: SlackAPI.Slack = new SlackAPI.Slack(this._client);
+  msTeams: MsTeamsAPI.MsTeams = new MsTeamsAPI.MsTeams(this._client);
+}
+
+Providers.Slack = Slack;
+Providers.MsTeams = MsTeams;
+
+export declare namespace Providers {
+  export {
+    Slack as Slack,
+    type SlackCheckAuthResponse as SlackCheckAuthResponse,
+    type SlackListChannelsResponse as SlackListChannelsResponse,
+    type SlackRevokeAccessResponse as SlackRevokeAccessResponse,
+    type SlackListChannelsResponsesSlackChannelsCursor as SlackListChannelsResponsesSlackChannelsCursor,
+    type SlackCheckAuthParams as SlackCheckAuthParams,
+    type SlackListChannelsParams as SlackListChannelsParams,
+    type SlackRevokeAccessParams as SlackRevokeAccessParams,
+  };
+
+  export {
+    MsTeams as MsTeams,
+    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,
+  };
+}

package/src/resources/providers/slack.ts

@@ -0,0 +1,186 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { PagePromise, SlackChannelsCursor, type SlackChannelsCursorParams } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Slack extends APIResource {
+  /**
+   * Check if a Slack channel is authenticated.
+   */
+  checkAuth(
+    channelID: string,
+    query: SlackCheckAuthParams,
+    options?: RequestOptions,
+  ): APIPromise<SlackCheckAuthResponse> {
+    return this._client.get(path`/v1/providers/slack/${channelID}/auth_check`, { query, ...options });
+  }
+
+  /**
+   * List Slack channels for a Slack workspace.
+   */
+  listChannels(
+    channelID: string,
+    query: SlackListChannelsParams,
+    options?: RequestOptions,
+  ): PagePromise<SlackListChannelsResponsesSlackChannelsCursor, SlackListChannelsResponse> {
+    return this._client.getAPIList(
+      path`/v1/providers/slack/${channelID}/channels`,
+      SlackChannelsCursor<SlackListChannelsResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Revoke access for a Slack channel.
+   */
+  revokeAccess(
+    channelID: string,
+    params: SlackRevokeAccessParams,
+    options?: RequestOptions,
+  ): APIPromise<SlackRevokeAccessResponse> {
+    const { access_token_object } = params;
+    return this._client.put(path`/v1/providers/slack/${channelID}/revoke_access`, {
+      query: { access_token_object },
+      ...options,
+    });
+  }
+}
+
+export type SlackListChannelsResponsesSlackChannelsCursor = SlackChannelsCursor<SlackListChannelsResponse>;
+
+/**
+ * The response from a Slack auth check request.
+ */
+export interface SlackCheckAuthResponse {
+  /**
+   * A Slack connection object.
+   */
+  connection: SlackCheckAuthResponse.Connection;
+}
+
+export namespace SlackCheckAuthResponse {
+  /**
+   * A Slack connection object.
+   */
+  export interface Connection {
+    /**
+     * Whether the Slack connection is valid.
+     */
+    ok: boolean;
+
+    /**
+     * The reason for the Slack connection if it is not valid.
+     */
+    reason?: string | null;
+  }
+}
+
+/**
+ * A Slack channel.
+ */
+export interface SlackListChannelsResponse {
+  /**
+   * A Slack channel ID from the Slack provider.
+   */
+  id: string;
+
+  /**
+   * The team ID that the Slack channel belongs to.
+   */
+  context_team_id: string;
+
+  /**
+   * Whether the Slack channel is an IM channel.
+   */
+  is_im: boolean;
+
+  /**
+   * Whether the Slack channel is private.
+   */
+  is_private: boolean;
+
+  /**
+   * Slack channel name.
+   */
+  name: string;
+}
+
+/**
+ * A response indicating the operation was successful.
+ */
+export interface SlackRevokeAccessResponse {
+  /**
+   * OK response.
+   */
+  ok?: string;
+}
+
+export interface SlackCheckAuthParams {
+  /**
+   * A JSON encoded string containing the access token object reference.
+   */
+  access_token_object: string;
+}
+
+export interface SlackListChannelsParams extends SlackChannelsCursorParams {
+  /**
+   * A JSON encoded string containing the access token object reference.
+   */
+  access_token_object: string;
+
+  query_options?: SlackListChannelsParams.QueryOptions;
+}
+
+export namespace SlackListChannelsParams {
+  export interface QueryOptions {
+    /**
+     * Paginate through collections of data by setting the cursor parameter to a
+     * next_cursor attribute returned by a previous request's response_metadata.
+     * Default value fetches the first "page" of the collection.
+     */
+    cursor?: string;
+
+    /**
+     * Set to true to exclude archived channels from the list.
+     */
+    exclude_archived?: boolean;
+
+    /**
+     * The maximum number of channels to return.
+     */
+    limit?: number;
+
+    /**
+     * Encoded team ID (T1234) to list channels in, required if org token is used.
+     */
+    team_id?: string;
+
+    /**
+     * Mix and match channel types by providing a comma-separated list of any
+     * combination of public_channel, private_channel, mpim, im.
+     */
+    types?: string;
+  }
+}
+
+export interface SlackRevokeAccessParams {
+  /**
+   * A JSON encoded string containing the access token object reference.
+   */
+  access_token_object: string;
+}
+
+export declare namespace Slack {
+  export {
+    type SlackCheckAuthResponse as SlackCheckAuthResponse,
+    type SlackListChannelsResponse as SlackListChannelsResponse,
+    type SlackRevokeAccessResponse as SlackRevokeAccessResponse,
+    type SlackListChannelsResponsesSlackChannelsCursor as SlackListChannelsResponsesSlackChannelsCursor,
+    type SlackCheckAuthParams as SlackCheckAuthParams,
+    type SlackListChannelsParams as SlackListChannelsParams,
+    type SlackRevokeAccessParams as SlackRevokeAccessParams,
+  };
+}

package/src/resources/providers.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './providers/index';