@scryme/chat 2.13.4 → 2.15.2

package/dist/sdk.d.ts

@@ -1,6 +1,29 @@
 import { AxiosRequestConfig } from 'axios';
 import { getSkyrmeChatAPI } from './generated/v3-server';
-import type { V3ProvisionWorkspaceDto, V3UpdateWorkspaceDto, V3AddMemberDto, V3UpdateMemberRoleDto, CreateWorkspaceChannelDto, UpdateWorkspaceChannelDto, ChannelsControllerGetMessagesParams, ChannelsControllerUpdateMessageBody, ChannelsControllerAddReactionBody, CreateDmDto, UsersControllerSearchUsersParams, DmsControllerGetMessagesParams } from './generated/v3-server';
+import type { V3ProvisionWorkspaceDto, V3UpdateWorkspaceDto, V3AddMemberDto, V3UpdateMemberRoleDto, CreateWorkspaceChannelDto, UpdateWorkspaceChannelDto, ChannelsControllerGetMessagesParams, ChannelsControllerUpdateMessageBody, ChannelsControllerAddReactionBody, CreateDmDto, UpdateDmMessageDto, UsersControllerSearchUsersParams, DmsControllerGetMessagesParams, CreateMessageDto, V3CreateWebhookDto, V3UpdateWebhookDto, CreateChannelIncomingWebhookDto, UpdateChannelIncomingWebhookDto, ExecuteChannelIncomingWebhookDto, V3ChannelIncomingWebhooksControllerExecuteWebhookByChannelIdParams, ChannelsControllerAddReactionResult, ChannelsControllerRemoveReactionResult, DmsControllerAddReactionBody, DmsControllerAddReactionResult, DmsControllerRemoveReactionResult, V3WebhooksControllerGetWebhooksResult, V3WebhooksControllerCreateWebhookResult, V3WebhooksControllerGetWebhookResult, V3WebhooksControllerUpdateWebhookResult, V3WebhooksControllerDeleteWebhookResult, V3ChannelIncomingWebhooksControllerGetChannelWebhooksResult, V3ChannelIncomingWebhooksControllerCreateChannelWebhookResult, V3ChannelIncomingWebhooksControllerGetChannelWebhookResult, V3ChannelIncomingWebhooksControllerUpdateChannelWebhookResult, V3ChannelIncomingWebhooksControllerDeleteChannelWebhookResult, V3ChannelIncomingWebhooksControllerExecuteWebhookByUrlTokenResult, V3ChannelIncomingWebhooksControllerExecuteWebhookByChannelIdResult, V3OAuthControllerGetTokenResult } from './generated/v3-server';
+/**
+ * Represents a message attachment.
+ */
+export interface MessageAttachment {
+    id: string;
+    messageId?: string | null;
+    name: string;
+    type: string;
+    url: string;
+    size?: string | null;
+    createdAt: string;
+}
+/**
+ * Represents a user reaction to a message.
+ */
+export interface MessageReaction {
+    id: string;
+    messageId: string;
+    userId: string;
+    emoji: string;
+    customEmojiId?: string | null;
+    createdAt: string;
+}
 /**
  * Represents a workspace in the Scryme platform (Enterprise M2M API V3).
  */
@@ -18,7 +41,7 @@ export interface V3Workspace {
     /** Industry categorization of the workspace. */
     industry?: string | null;
     /** Custom branding configuration object. */
-    brandingConfig?: any;
+    brandingConfig?: Record<string, unknown> | null;
     /** ISO timestamp when the workspace was created. */
     createdAt: string;
     /** ISO timestamp when the workspace was last updated. */
@@ -263,9 +286,9 @@ export interface ChannelMessage {
     /** Optional identifier of the root thread message. */
     threadId?: string | null;
     /** Optional attachments uploaded with the message. */
-    attachments?: any[];
+    attachments?: MessageAttachment[];
     /** Reactions associated with this message. */
-    reactions?: any[];
+    reactions?: MessageReaction[];
 }
 /**
  * Represents a direct message conversation between users.
@@ -298,7 +321,7 @@ export interface DmConversation {
         };
     }[];
     /** Messages belonging to this DM conversation. */
-    messages?: any[];
+    messages?: ChannelMessage[];
     /** Metadata count summaries for the conversation. */
     _count?: {
         /** Total number of messages in the conversation. */
@@ -538,28 +561,67 @@ export declare class ScrymeSDK {
             /**
              * Sends a new message to a channel.
              * @param channelId Unique identifier of the target channel.
-             * @param options Optional request config override. Note that standard message data (like text content) can be passed inside options.data.
+             * @param data The message content string or structured CreateMessageDto object.
+             * @param options Optional request config override.
              * @returns The created message exactly from the endpoint.
              */
-            create: (channelId: string, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+            create: (channelId: string, data: CreateMessageDto | string, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+            /**
+             * Updates the content of a previously sent message in a channel.
+             * @param channelId Unique identifier of the channel containing the message.
+             * @param messageId Unique identifier of the message to update.
+             * @param data The new content payload.
+             * @param options Optional request config override.
+             * @returns The updated message details exactly from the endpoint.
+             */
+            update: (channelId: string, messageId: string, data: ChannelsControllerUpdateMessageBody, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+            /**
+             * Permanently deletes a message in a channel.
+             * @param channelId Unique identifier of the channel containing the message.
+             * @param messageId Unique identifier of the message to delete.
+             * @param options Optional request config override.
+             * @returns Success status indicating that the message was deleted exactly from the endpoint.
+             */
+            delete: (channelId: string, messageId: string, options?: AxiosRequestConfig) => Promise<{
+                success: boolean;
+            }>;
+            /**
+             * Adds a reaction (emoji) to a message in a channel.
+             * @param channelId Unique identifier of the channel containing the message.
+             * @param messageId Unique identifier of the message.
+             * @param data Object containing the target emoji character.
+             * @param options Optional request config override.
+             * @returns The reaction response returned exactly from the endpoint.
+             */
+            addReaction: (channelId: string, messageId: string, data: ChannelsControllerAddReactionBody, options?: AxiosRequestConfig) => Promise<ChannelsControllerAddReactionResult>;
+            /**
+             * Removes a reaction (emoji) from a message in a channel.
+             * @param channelId Unique identifier of the channel containing the message.
+             * @param messageId Unique identifier of the message.
+             * @param emoji The emoji character to remove.
+             * @param options Optional request config override.
+             * @returns The reaction removal response returned exactly from the endpoint.
+             */
+            removeReaction: (channelId: string, messageId: string, emoji: string, options?: AxiosRequestConfig) => Promise<ChannelsControllerRemoveReactionResult>;
         };
     };
     /**
-     * Operations for modifying, reacting to, or deleting existing channel messages.
+     * Operations for modifying, reacting to, or deleting existing messages (both channel & direct messages).
+     * Automatically intercepts direct messages starting with 'dm-' and routes them correctly.
      */
     get message(): {
         /**
          * Updates the content of a previously sent message.
-         * @param channelId Unique identifier of the channel containing the message.
+         * @param channelId Unique identifier of the channel or DM conversation containing the message.
          * @param messageId Unique identifier of the message to update.
          * @param data The new content payload.
          * @param options Optional request config override.
          * @returns The updated message details exactly from the endpoint.
          */
-        update: (channelId: string, messageId: string, data: ChannelsControllerUpdateMessageBody, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+        update: (channelId: string, messageId: string, data: ChannelsControllerUpdateMessageBody | UpdateDmMessageDto, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
         /**
          * Permanently deletes a message.
-         * @param channelId Unique identifier of the channel containing the message.
+         * @param channelId Unique identifier of the channel or DM conversation containing the message.
          * @param messageId Unique identifier of the message to delete.
          * @param options Optional request config override.
          * @returns Success status indicating that the message was deleted exactly from the endpoint.
@@ -569,22 +631,22 @@ export declare class ScrymeSDK {
         }>;
         /**
          * Adds a reaction (emoji) to a message.
-         * @param channelId Unique identifier of the channel containing the message.
+         * @param channelId Unique identifier of the channel or DM conversation containing the message.
          * @param messageId Unique identifier of the message.
          * @param data Object containing the target emoji character.
          * @param options Optional request config override.
          * @returns The reaction response returned exactly from the endpoint.
          */
-        addReaction: (channelId: string, messageId: string, data: ChannelsControllerAddReactionBody, options?: AxiosRequestConfig) => Promise<any>;
+        addReaction: (channelId: string, messageId: string, data: ChannelsControllerAddReactionBody | DmsControllerAddReactionBody, options?: AxiosRequestConfig) => Promise<ChannelsControllerAddReactionResult | DmsControllerAddReactionResult>;
         /**
          * Removes a reaction (emoji) from a message.
-         * @param channelId Unique identifier of the channel containing the message.
+         * @param channelId Unique identifier of the channel or DM conversation containing the message.
          * @param messageId Unique identifier of the message.
          * @param emoji The emoji character to remove.
          * @param options Optional request config override.
          * @returns The reaction removal response returned exactly from the endpoint.
          */
-        removeReaction: (channelId: string, messageId: string, emoji: string, options?: AxiosRequestConfig) => Promise<any>;
+        removeReaction: (channelId: string, messageId: string, emoji: string, options?: AxiosRequestConfig) => Promise<ChannelsControllerRemoveReactionResult | DmsControllerRemoveReactionResult>;
     };
     /**
      * Operations for managing direct messages (DMs) and direct message conversations.
@@ -637,10 +699,50 @@ export declare class ScrymeSDK {
             /**
              * Sends a new message in a direct message conversation.
              * @param dmId Unique identifier of the direct message conversation.
-             * @param options Optional request config override. Note that content/attachments can be passed inside options.data.
+             * @param data The message content string or structured CreateMessageDto object.
+             * @param options Optional request config override.
              * @returns The sent message exactly from the endpoint.
              */
-            create: (dmId: string, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+            create: (dmId: string, data: CreateMessageDto | {
+                content: string;
+            } | string, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+            /**
+             * Updates the content of a previously sent direct message.
+             * @param dmId Unique identifier of the direct message conversation.
+             * @param messageId Unique identifier of the message to update.
+             * @param data The new content payload.
+             * @param options Optional request config override.
+             * @returns The updated message details exactly from the endpoint.
+             */
+            update: (dmId: string, messageId: string, data: UpdateDmMessageDto, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+            /**
+             * Permanently deletes a direct message.
+             * @param dmId Unique identifier of the direct message conversation.
+             * @param messageId Unique identifier of the message to delete.
+             * @param options Optional request config override.
+             * @returns Success status indicating that the message was deleted exactly from the endpoint.
+             */
+            delete: (dmId: string, messageId: string, options?: AxiosRequestConfig) => Promise<{
+                success: boolean;
+            }>;
+            /**
+             * Adds a reaction (emoji) to a direct message.
+             * @param dmId Unique identifier of the direct message conversation.
+             * @param messageId Unique identifier of the message.
+             * @param data Object containing the target emoji character.
+             * @param options Optional request config override.
+             * @returns The reaction response returned exactly from the endpoint.
+             */
+            addReaction: (dmId: string, messageId: string, data: DmsControllerAddReactionBody, options?: AxiosRequestConfig) => Promise<DmsControllerAddReactionResult>;
+            /**
+             * Removes a reaction (emoji) from a direct message.
+             * @param dmId Unique identifier of the direct message conversation.
+             * @param messageId Unique identifier of the message.
+             * @param emoji The emoji character to remove.
+             * @param options Optional request config override.
+             * @returns The reaction removal response returned exactly from the endpoint.
+             */
+            removeReaction: (dmId: string, messageId: string, emoji: string, options?: AxiosRequestConfig) => Promise<DmsControllerRemoveReactionResult>;
         };
     };
     /**
@@ -669,4 +771,201 @@ export declare class ScrymeSDK {
          */
         search: (params: UsersControllerSearchUsersParams, options?: AxiosRequestConfig) => Promise<UserProfile[]>;
     };
+    /**
+     * Operations for managing webhooks (both standard workspace webhooks and channel incoming webhooks).
+     */
+    get webhooks(): {
+        /**
+         * Lists all configured webhooks for a workspace. Requires webhooks:read scope.
+         * @param slug The unique workspace slug.
+         * @param options Optional request config override.
+         */
+        list: (slug: string, options?: AxiosRequestConfig) => Promise<V3WebhooksControllerGetWebhooksResult>;
+        /**
+         * Creates a new standard webhook for a workspace. Requires webhooks:write scope.
+         * @param slug The unique workspace slug.
+         * @param data Configuration options for the standard webhook.
+         * @param options Optional request config override.
+         */
+        create: (slug: string, data: V3CreateWebhookDto, options?: AxiosRequestConfig) => Promise<V3WebhooksControllerCreateWebhookResult>;
+        /**
+         * Retrieves details of a specific webhook. Requires webhooks:read scope.
+         * @param slug The unique workspace slug.
+         * @param webhookId The unique webhook identifier.
+         * @param options Optional request config override.
+         */
+        get: (slug: string, webhookId: string, options?: AxiosRequestConfig) => Promise<V3WebhooksControllerGetWebhookResult>;
+        /**
+         * Updates a standard webhook for a workspace. Requires webhooks:write scope.
+         * @param slug The unique workspace slug.
+         * @param webhookId The unique webhook identifier.
+         * @param data Fields to update on the webhook.
+         * @param options Optional request config override.
+         */
+        update: (slug: string, webhookId: string, data: V3UpdateWebhookDto, options?: AxiosRequestConfig) => Promise<V3WebhooksControllerUpdateWebhookResult>;
+        /**
+         * Permanently deletes a standard webhook. Requires webhooks:write scope.
+         * @param slug The unique workspace slug.
+         * @param webhookId The unique webhook identifier.
+         * @param options Optional request config override.
+         */
+        delete: (slug: string, webhookId: string, options?: AxiosRequestConfig) => Promise<V3WebhooksControllerDeleteWebhookResult>;
+        /**
+         * Sub-namespace for managing channel incoming webhooks.
+         */
+        incoming: {
+            /**
+             * Lists incoming webhooks configured for a specific channel. Requires webhooks:read scope.
+             * @param slug The unique workspace slug.
+             * @param channelId The unique channel identifier.
+             * @param options Optional request config override.
+             */
+            list: (slug: string, channelId: string, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerGetChannelWebhooksResult>;
+            /**
+             * Creates an incoming webhook for a specific channel. Requires webhooks:write scope.
+             * @param slug The unique workspace slug.
+             * @param channelId The unique channel identifier.
+             * @param data Configuration options for the incoming webhook.
+             * @param options Optional request config override.
+             */
+            create: (slug: string, channelId: string, data: CreateChannelIncomingWebhookDto, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerCreateChannelWebhookResult>;
+            /**
+             * Retrieves details of a specific channel incoming webhook. Requires webhooks:read scope.
+             * @param slug The unique workspace slug.
+             * @param channelId The unique channel identifier.
+             * @param webhookId The unique webhook identifier.
+             * @param options Optional request config override.
+             */
+            get: (slug: string, channelId: string, webhookId: string, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerGetChannelWebhookResult>;
+            /**
+             * Updates a channel incoming webhook. Requires webhooks:write scope.
+             * @param slug The unique workspace slug.
+             * @param channelId The unique channel identifier.
+             * @param webhookId The unique webhook identifier.
+             * @param data Fields to update on the incoming webhook.
+             * @param options Optional request config override.
+             */
+            update: (slug: string, channelId: string, webhookId: string, data: UpdateChannelIncomingWebhookDto, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerUpdateChannelWebhookResult>;
+            /**
+             * Deletes a channel incoming webhook. Requires webhooks:write scope.
+             * @param slug The unique workspace slug.
+             * @param channelId The unique channel identifier.
+             * @param webhookId The unique webhook identifier.
+             * @param options Optional request config override.
+             */
+            delete: (slug: string, channelId: string, webhookId: string, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerDeleteChannelWebhookResult>;
+            /**
+             * Executes an incoming webhook using its unique url token directly. No auth headers required.
+             * @param token The unique webhook token from the webhook URL.
+             * @param data The payload payload consisting of content/attachments/metadata.
+             * @param options Optional request config override.
+             */
+            executeByUrlToken: (token: string, data: ExecuteChannelIncomingWebhookDto, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerExecuteWebhookByUrlTokenResult>;
+            /**
+             * Executes an incoming webhook by channel ID.
+             * @param channelId The target channel identifier.
+             * @param data The payload payload consisting of content/attachments/metadata.
+             * @param params Optional query parameters like token or signature.
+             * @param options Optional request config override.
+             */
+            executeByChannelId: (channelId: string, data: ExecuteChannelIncomingWebhookDto, params?: V3ChannelIncomingWebhooksControllerExecuteWebhookByChannelIdParams, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerExecuteWebhookByChannelIdResult>;
+        };
+    };
+    /**
+     * First-class namespace for Machine-to-Machine (M2M) operations,
+     * grouping V3 Enterprise M2M APIs into logical, highly cohesive spaces.
+     */
+    get m2m(): {
+        /**
+         * M2M Workspace Operations (Provisioning, Retrieval, and Lifecycle management).
+         */
+        workspace: {
+            /**
+             * Provisions a brand new tenant workspace in the organization.
+             * @param data Configuration payload for workspace name, slug, owner, and initial setups.
+             * @param options Optional request config override.
+             */
+            provision: (data: V3ProvisionWorkspaceDto, options?: AxiosRequestConfig) => Promise<V3ProvisionWorkspaceResponse>;
+            /**
+             * Retrieves detailed information of a specific workspace by its slug.
+             * @param slug The unique workspace slug.
+             * @param options Optional request config override.
+             */
+            get: (slug: string, options?: AxiosRequestConfig) => Promise<V3WorkspaceResponse>;
+            /**
+             * Lists all workspaces under the organization context.
+             * @param options Optional request config override.
+             */
+            list: (options?: AxiosRequestConfig) => Promise<V3WorkspacesResponse>;
+            /**
+             * Updates configuration and branding metadata of a specific workspace.
+             * @param slug The unique workspace slug.
+             * @param data Workspace update DTO.
+             * @param options Optional request config override.
+             */
+            update: (slug: string, data: V3UpdateWorkspaceDto, options?: AxiosRequestConfig) => Promise<V3WorkspaceResponse>;
+            /**
+             * Permanently deletes a specific workspace by its slug.
+             * @param slug The unique workspace slug.
+             * @param options Optional request config override.
+             */
+            delete: (slug: string, options?: AxiosRequestConfig) => Promise<V3DeleteWorkspaceResponse>;
+        };
+        /**
+         * M2M Workspace Membership Operations (Adding, modifying roles, and removing workspace members).
+         */
+        member: {
+            /**
+             * Lists all members currently in a workspace.
+             * @param slug The unique workspace slug.
+             * @param options Optional request config override.
+             */
+            list: (slug: string, options?: AxiosRequestConfig) => Promise<V3WorkspaceMembersResponse>;
+            /**
+             * Adds a new member to a workspace.
+             * @param slug The unique workspace slug.
+             * @param data Configuration containing user email and target role.
+             * @param options Optional request config override.
+             */
+            add: (slug: string, data: V3AddMemberDto, options?: AxiosRequestConfig) => Promise<V3AddWorkspaceMemberResponse>;
+            /**
+             * Retrieves membership details of a specific workspace member.
+             * @param slug The unique workspace slug.
+             * @param memberId Unique ID of the workspace member (user ID).
+             * @param options Optional request config override.
+             */
+            get: (slug: string, memberId: string, options?: AxiosRequestConfig) => Promise<V3GetWorkspaceMemberResponse>;
+            /**
+             * Updates the role or settings of an existing member in a workspace.
+             * @param slug The unique workspace slug.
+             * @param memberId Unique ID of the workspace member (user ID).
+             * @param data Updated role.
+             * @param options Optional request config override.
+             */
+            update: (slug: string, memberId: string, data: V3UpdateMemberRoleDto, options?: AxiosRequestConfig) => Promise<V3UpdateWorkspaceMemberResponse>;
+            /**
+             * Removes a member from a workspace.
+             * @param slug The unique workspace slug.
+             * @param memberId Unique ID of the workspace member (user ID).
+             * @param options Optional request config override.
+             */
+            delete: (slug: string, memberId: string, options?: AxiosRequestConfig) => Promise<V3DeleteWorkspaceMemberResponse>;
+        };
+        /**
+         * M2M Authentication and Token Management Utilities.
+         */
+        auth: {
+            /**
+             * Explicitly exchanges Client Credentials for a V3 access token.
+             * @param clientId The unique M2M Client ID.
+             * @param clientSecret The secure M2M Client Secret.
+             * @param options Optional request config override.
+             */
+            token: (clientId: string, clientSecret: string, options?: AxiosRequestConfig) => Promise<V3OAuthControllerGetTokenResult>;
+            /**
+             * Dynamically retrieves the current cached M2M token, or proactively fetches a new one.
+             */
+            getOrFetchToken: () => Promise<string | null>;
+        };
+    };
 }