@squidcloud/teams-client 1.0.418

package/dist/connectors/teams/common/src/teams-types.d.ts

@@ -0,0 +1,54 @@
+import { IntegrationId } from '../../../../internal-common/src/public-types/communication.public-types';
+/** Teams conversation/channel ID */
+export type ConversationId = string;
+/** Teams team ID */
+export type TeamId = string;
+/** Page size for pagination and batching operations */
+export declare const PAGE_SIZE = 50;
+/** List of conversation types. */
+export declare const RECIPIENT_TYPES: readonly ["team", "channel", "chat", "user"];
+/** Types of conversations in Teams. */
+export type RecipientType = (typeof RECIPIENT_TYPES)[number];
+/**
+ * Teams user profile object.
+ */
+export interface TeamsUser {
+    id: string;
+    displayName?: string;
+    userPrincipalName?: string;
+    mail?: string;
+}
+/**
+ * Request to search for messages related to a given prompt.
+ */
+export interface SearchTeamsMessagesRequest {
+    /** The search query */
+    prompt: string;
+    /** Which Teams integration instance to search. */
+    integrationId: IntegrationId;
+    /** Restrict the search to the given team names, comma-separated. */
+    teamNames?: string;
+    /** Restrict the search to the given channel names, comma-separated. */
+    channelNames?: string;
+}
+/**
+ * Message search result chunk.
+ */
+export interface SearchTeamsMessagesResultChunk {
+    /**
+     * Conversation messages.
+     * Contains an arbitrary subset of messages in sequential & chronological order, where the
+     * matching messages are contained within the subset.
+     */
+    messages: string;
+    /** Team name the messages came from. */
+    teamName?: string;
+    /** Channel/conversation name the messages came from. */
+    channelName?: string;
+    /** Conversation Type. */
+    conversationType?: RecipientType;
+    /** Thread ID if these messages are part of a thread. */
+    threadId?: string;
+    /** The day date (in UTC) that the conversation took place. */
+    timestamp?: Date;
+}

package/dist/connectors/teams/teams-client/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from '../../common/src/teams-types';
+export * from './teams-client';

package/dist/connectors/teams/teams-client/src/teams-client.d.ts

@@ -0,0 +1,25 @@
+import { Squid } from '@squidcloud/client';
+import { SearchTeamsMessagesRequest, SearchTeamsMessagesResultChunk } from '../../common/src/teams-types';
+/**
+ * Client for interacting with the Microsoft Teams connector.
+ */
+export declare class SquidTeamsClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * Creates a new Teams client instance.
+     *
+     * @param squid - Squid client instance. Provide an instance that includes the Squid API key.
+     * @param integrationId - The ID of the Teams integration in the Squid console
+     */
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * Search for messages related to the given prompt query string.
+     *
+     * The provided `squid` instance requires your Squid API key to use this function.
+     *
+     * @param request Request parameters for searching within a Teams integration instance.
+     * @returns Array of chunks of messages that contain messages related to the query.
+     */
+    searchMessages(request: Omit<SearchTeamsMessagesRequest, 'integrationId'>): Promise<SearchTeamsMessagesResultChunk[]>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,r)=>{for(var o in r)e.o(r,o)&&!e.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:r[o]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{PAGE_SIZE:()=>r,RECIPIENT_TYPES:()=>o,SquidTeamsClient:()=>s});const r=50,o=["team","channel","chat","user"];class s{constructor(e,t){this.squid=e,this.integrationId=t}async searchMessages(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("searchMessagesInTeams",t)}}var n=exports;for(var a in t)n[a]=t[a];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/internal-common/src/public-types/communication.public-types.d.ts

@@ -0,0 +1,30 @@
+/** A type alias for an application id. */
+export type AppId = string;
+/** A tuple of environment identifiers like 'dev' or 'prod'. */
+export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
+/** A type representing valid environment identifiers derived from ENVIRONMENT_IDS. */
+export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
+/** A type alias for a squid developer identifier. */
+export type SquidDeveloperId = string;
+/** A type alias for an integration id. */
+export type IntegrationId = string;
+/** A type alias for a client identifier. */
+export type ClientId = string;
+/** A type alias for a squid document identifier. */
+export type SquidDocId = string;
+/** A type alias for a client request identifier. */
+export type ClientRequestId = string;
+/** ID of AI agent. Also known as AI profile id. */
+export type AiAgentId = string;
+/** App-level ID of AI Knowledge Base */
+export type AiKnowledgeBaseId = string;
+/**
+ * The built-in agent id. Cannot be customized.
+ * @category AI
+ */
+export declare const BUILT_IN_AGENT_ID = "built_in_agent";
+/**
+ * A type alias for an AI context identifier.
+ * @category AI
+ */
+export type AiContextId = string;