@scryme/chat 2.91.43 → 2.91.76

package/dist/sdk.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 import { getSkyrmeChatAPI } from './generated/v3-server';
-import type { V3ProvisionWorkspaceDto, V3UpdateWorkspaceDto, V3AddMemberDto, V3UpdateMemberRoleDto, CreateWorkspaceChannelDto, UpdateWorkspaceChannelDto, UpdateChannelMemberDto, V3CreateChannelDto, V3UpdateChannelDto, V3AddChannelMemberDto, V3UpdateChannelMemberDto, 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';
+import type { V3ProvisionWorkspaceDto, V3UpdateWorkspaceDto, V3AddMemberDto, V3UpdateMemberRoleDto, CreateWorkspaceChannelDto, UpdateWorkspaceChannelDto, UpdateChannelMemberDto, V3CreateChannelDto, V3UpdateChannelDto, V3AddChannelMemberDto, V3UpdateChannelMemberDto, 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.
  */
@@ -460,7 +460,7 @@ export interface AssignSupportTicketDto {
 /**
  * Options for starting a new live chat session.
  */
-export interface StartLiveChatDto {
+export interface SupportStartLiveChatDto {
     /** Unique workspace identifier where live chat is initialized. */
     workspaceId: string;
     /** Optional metadata associated with the live chat session. */
@@ -469,7 +469,7 @@ export interface StartLiveChatDto {
 /**
  * Options for creating or updating a customer profile.
  */
-export interface CreateCustomerProfileDto {
+export interface SupportCreateCustomerProfileDto {
     /** Associated workspace identifier. */
     workspaceId: string;
     /** User ID of the customer. */
@@ -732,61 +732,66 @@ export declare class ScrymeSDK {
          */
         message: {
             /**
-             * Lists messages in a channel with cursor pagination support.
+             * Lists messages in a channel with cursor pagination support via V3 API.
+             * @param slug The unique workspace slug.
              * @param channelId Unique identifier of the channel.
              * @param params Query parameters for limiting, sorting, or pagination cursors.
              * @param options Optional request config override.
-             * @returns Object containing the messages array and next pagination cursor exactly from the endpoint.
              */
-            list: (channelId: string, params?: ChannelsControllerGetMessagesParams, options?: AxiosRequestConfig) => Promise<{
+            list: (slug: string, channelId: string, params?: {
+                cursor?: string;
+                limit?: string;
+            }, options?: AxiosRequestConfig) => Promise<{
                 messages: ChannelMessage[];
                 nextCursor?: string;
             }>;
             /**
-             * Sends a new message to a channel.
+             * Sends a new message to a channel via V3 API.
+             * @param slug The unique workspace slug.
              * @param channelId Unique identifier of the target channel.
-             * @param data The message content string or structured CreateMessageDto object.
+             * @param data The message content string or structured payload object.
              * @param options Optional request config override.
-             * @returns The created message exactly from the endpoint.
              */
-            create: (channelId: string, data: CreateMessageDto | string, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
+            create: (slug: string, channelId: string, data: CreateMessageDto | string, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
             /**
-             * Updates the content of a previously sent message in a channel.
+             * Updates the content of a previously sent message in a channel via V3 API.
+             * @param slug The unique workspace slug.
              * @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>;
+            update: (slug: string, channelId: string, messageId: string, data: ChannelsControllerUpdateMessageBody, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
             /**
-             * Permanently deletes a message in a channel.
+             * Permanently deletes a message in a channel via V3 API.
+             * @param slug The unique workspace slug.
              * @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<{
+            delete: (slug: string, channelId: string, messageId: string, options?: AxiosRequestConfig) => Promise<{
                 success: boolean;
             }>;
             /**
-             * Adds a reaction (emoji) to a message in a channel.
+             * Adds a reaction (emoji) to a message in a channel via V3 API.
+             * @param slug The unique workspace slug.
              * @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>;
+            addReaction: (slug: string, channelId: string, messageId: string, data: ChannelsControllerAddReactionBody, options?: AxiosRequestConfig) => Promise<any>;
             /**
-             * Removes a reaction (emoji) from a message in a channel.
+             * Removes a reaction (emoji) from a message in a channel via V3 API.
+             * @param slug The unique workspace slug.
              * @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>;
+            removeReaction: (slug: string, channelId: string, messageId: string, emoji: string, options?: AxiosRequestConfig) => Promise<{
+                success: boolean;
+            }>;
         };
     };
     /**
@@ -833,100 +838,95 @@ export declare class ScrymeSDK {
         removeReaction: (channelId: string, messageId: string, emoji: string, options?: AxiosRequestConfig) => Promise<ChannelsControllerRemoveReactionResult | DmsControllerRemoveReactionResult>;
     };
     /**
-     * Operations for managing direct messages (DMs) and direct message conversations.
+     * Operations for managing direct messages (DMs) and direct message conversations via V3 API.
      */
     get dm(): {
         /**
-         * Lists all active direct message conversations for the authenticated user.
+         * Lists all active direct message conversations for the authenticated user/bot via V3 API.
          * @param options Optional request config override.
-         * @returns List of active DM conversations returned exactly from the endpoint.
          */
         list: (options?: AxiosRequestConfig) => Promise<DmConversation[]>;
         /**
-         * Creates/initiates a direct message conversation with specified users.
+         * Creates/initiates a direct message conversation via V3 API.
          * @param data Create direct message details containing target participant IDs.
          * @param options Optional request config override.
-         * @returns Details of the created DM conversation exactly from the endpoint.
          */
-        create: (data: CreateDmDto, options?: AxiosRequestConfig) => Promise<DmConversation>;
+        create: (data: CreateDmDto | {
+            targetUserId?: string;
+            userId?: string;
+        }, options?: AxiosRequestConfig) => Promise<DmConversation>;
         /**
-         * Retrieves details of a specific direct message conversation.
+         * Retrieves details of a specific direct message conversation via V3 API.
          * @param dmId Unique identifier of the direct message conversation.
          * @param options Optional request config override.
-         * @returns Detailed direct message conversation object exactly from the endpoint.
          */
         get: (dmId: string, options?: AxiosRequestConfig) => Promise<DmConversation>;
         /**
-         * Deletes/closes an active direct message conversation.
+         * Deletes/closes an active direct message conversation via V3 API.
          * @param dmId Unique identifier of the direct message conversation to close.
          * @param options Optional request config override.
-         * @returns Success status indicating that the DM conversation was deleted exactly from the endpoint.
          */
         delete: (dmId: string, options?: AxiosRequestConfig) => Promise<{
             success: boolean;
         }>;
         /**
-         * Sub-namespace for managing direct messages in a specific DM conversation.
+         * Sub-namespace for managing direct messages in a specific DM conversation via V3 API.
          */
         message: {
             /**
-             * Lists messages in a direct message conversation with cursor pagination.
+             * Lists messages in a direct message conversation with cursor pagination via V3 API.
              * @param dmId Unique identifier of the direct message conversation.
              * @param params Query parameters for pagination limits, cursors or search filters.
              * @param options Optional request config override.
-             * @returns List of direct messages and next pagination cursor exactly from the endpoint.
              */
             list: (dmId: string, params?: DmsControllerGetMessagesParams, options?: AxiosRequestConfig) => Promise<{
                 messages: ChannelMessage[];
                 nextCursor?: string;
             }>;
             /**
-             * Sends a new message in a direct message conversation.
+             * Sends a new message in a direct message conversation via V3 API.
              * @param dmId Unique identifier of the direct message conversation.
              * @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, data: CreateMessageDto | {
                 content: string;
             } | string, options?: AxiosRequestConfig) => Promise<ChannelMessage>;
             /**
-             * Updates the content of a previously sent direct message.
+             * Updates the content of a previously sent direct message via V3 API.
              * @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.
+             * Permanently deletes a direct message via V3 API.
              * @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.
+             * Adds a reaction (emoji) to a direct message via V3 API.
              * @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>;
+            addReaction: (dmId: string, messageId: string, data: DmsControllerAddReactionBody, options?: AxiosRequestConfig) => Promise<any>;
             /**
-             * Removes a reaction (emoji) from a direct message.
+             * Removes a reaction (emoji) from a direct message via V3 API.
              * @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>;
+            removeReaction: (dmId: string, messageId: string, emoji: string, options?: AxiosRequestConfig) => Promise<{
+                success: boolean;
+            }>;
         };
     };
     /**
@@ -1125,7 +1125,7 @@ export declare class ScrymeSDK {
              * @param data Details for starting live chat session.
              * @param options Optional request config override.
              */
-            start: (data: StartLiveChatDto, options?: AxiosRequestConfig) => Promise<LiveChatSession>;
+            start: (data: SupportStartLiveChatDto, options?: AxiosRequestConfig) => Promise<LiveChatSession>;
             /**
              * Ends an active live chat session.
              * @param sessionId Unique session identifier.
@@ -1142,7 +1142,7 @@ export declare class ScrymeSDK {
              * @param data Profile details including workspaceId and userId.
              * @param options Optional request config override.
              */
-            createProfile: (data: CreateCustomerProfileDto, options?: AxiosRequestConfig) => Promise<CustomerProfile>;
+            createProfile: (data: SupportCreateCustomerProfileDto, options?: AxiosRequestConfig) => Promise<CustomerProfile>;
             /**
              * Retrieves customer profiles in a workspace.
              * @param workspaceId Unique workspace identifier.