@opens/gateways 1.14.0 → 1.14.2

package/dist/chat-webservice/contracts/index.d.mts

@@ -127,4 +127,166 @@ interface LiveUserRoomResponse {
     room: RoomResponse;
 }
 
-export type { CancelInvitationRequest, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse };
+/** Attachment metadata associated with a chat message. */
+interface MessageAttachment {
+    id: string;
+    key: string;
+    bucket: string;
+    filename: string;
+    type: string;
+    contentType: string;
+    link?: string;
+}
+/** Status entry tracking delivery/read state of a chat message. */
+interface MessageStatusResponse {
+    id: number;
+    status: string;
+    message: unknown;
+    createdAt: string;
+    updatedAt: string;
+    chatRoomMessageId: number;
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    attachmentIndex: number | null;
+}
+/** Reaction applied to a chat message. */
+interface MessageReactionResponse {
+    id: number;
+    emoji: string;
+    chatRoomId: number;
+    chatRoomMessageId: number;
+    chatRoomMemberId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Compact representation of the message being replied to. */
+interface MessageReplyContext {
+    id: number;
+    messageType: string;
+    messageBody: string;
+    filename?: string;
+    createdAt: string;
+}
+/** Optional metadata associated with a chat message. */
+interface MessageMetadata {
+    isExternalInit?: boolean;
+    privateReason?: string;
+    hiddenByOperatorId?: string;
+    hiddenByOperatorName?: string;
+    hiddenAt?: string;
+    [key: string]: unknown;
+}
+/** Chat message entity returned by the Chat Webservice API. */
+interface MessageResponse {
+    id: number;
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    companyId: string;
+    secretId: unknown;
+    messageHeader: string;
+    messageBody: string;
+    messageFooter: unknown;
+    caption: unknown;
+    messageHeaderType: string;
+    messageType: string;
+    messageFooterType: unknown;
+    subject: unknown;
+    origin: unknown;
+    recipientId: string;
+    provider: string;
+    providerId: string;
+    canBeInteractedWith: boolean;
+    buttons: unknown;
+    replyingToId?: number;
+    attachments: unknown;
+    createdAt: string;
+    updatedAt: string;
+    topic: unknown;
+    isPrivate: boolean;
+    metadata?: MessageMetadata | null;
+    carousel?: {
+        data?: unknown[];
+    };
+    status: MessageStatusResponse[];
+    reactions: MessageReactionResponse[];
+    replyingTo?: MessageReplyContext;
+    echo?: string;
+}
+/** Query parameters for fetching the initial message context of a room. */
+interface GetInitialContextRequest {
+    companyId: string;
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    limit?: number;
+    associations?: string[];
+}
+/** Paginated initial context response centered around unread messages. */
+interface GetInitialContextResponse {
+    data: MessageResponse[];
+    meta: {
+        count: number;
+        oldestCursor: number;
+        newestCursor: number;
+        lastUnreadMessageId: number | null;
+        hasMoreBefore: boolean;
+        hasMoreAfter: boolean;
+    };
+}
+/** Query parameters for cursor-based message pagination. */
+interface GetMessagesByCursorRequest {
+    companyId: string;
+    chatRoomId: number;
+    beforeId?: number;
+    afterId?: number;
+    limit?: number;
+    associations?: string[];
+}
+/** Paginated response for cursor-based message listing. */
+interface GetMessagesByCursorResponse {
+    data: MessageResponse[];
+    meta: {
+        hasMore: boolean;
+        count: number;
+        oldestCursor: number;
+        newestCursor: number;
+        hasMoreBefore?: boolean;
+        hasMoreAfter?: boolean;
+    };
+}
+/** Request payload for sending a chat message. */
+interface SendMessageRequest {
+    recipientId: string;
+    origin: string;
+    channel: string;
+    provider: string;
+    chatRoomId: number;
+    companyId: string;
+    messageBody?: string;
+    messageType: string;
+    chatRoomMemberId: number;
+    attachments?: {
+        data: MessageAttachment[];
+    };
+    replyingToId?: number;
+}
+/** Response returned when sending an attachment message. */
+interface SendAttachmentMessageResponse {
+    message: MessageResponse;
+}
+/** Request payload for marking specific messages as read. */
+interface MarkMessagesAsReadRequest {
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    chatRoomMessageId: number[];
+    status: string;
+}
+/** Response returned after marking messages as read. */
+interface MarkMessagesAsReadResponse {
+    updatedMessageStatus: MessageStatusResponse[];
+}
+/** Request payload for updating a room member. */
+interface UpdateMemberInRoomRequest {
+    new?: boolean;
+}
+
+export type { CancelInvitationRequest, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageResponse, MessageStatusResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse, SendAttachmentMessageResponse, SendMessageRequest, UpdateMemberInRoomRequest };

package/dist/chat-webservice/contracts/index.d.ts

@@ -127,4 +127,166 @@ interface LiveUserRoomResponse {
     room: RoomResponse;
 }
 
-export type { CancelInvitationRequest, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse };
+/** Attachment metadata associated with a chat message. */
+interface MessageAttachment {
+    id: string;
+    key: string;
+    bucket: string;
+    filename: string;
+    type: string;
+    contentType: string;
+    link?: string;
+}
+/** Status entry tracking delivery/read state of a chat message. */
+interface MessageStatusResponse {
+    id: number;
+    status: string;
+    message: unknown;
+    createdAt: string;
+    updatedAt: string;
+    chatRoomMessageId: number;
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    attachmentIndex: number | null;
+}
+/** Reaction applied to a chat message. */
+interface MessageReactionResponse {
+    id: number;
+    emoji: string;
+    chatRoomId: number;
+    chatRoomMessageId: number;
+    chatRoomMemberId: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Compact representation of the message being replied to. */
+interface MessageReplyContext {
+    id: number;
+    messageType: string;
+    messageBody: string;
+    filename?: string;
+    createdAt: string;
+}
+/** Optional metadata associated with a chat message. */
+interface MessageMetadata {
+    isExternalInit?: boolean;
+    privateReason?: string;
+    hiddenByOperatorId?: string;
+    hiddenByOperatorName?: string;
+    hiddenAt?: string;
+    [key: string]: unknown;
+}
+/** Chat message entity returned by the Chat Webservice API. */
+interface MessageResponse {
+    id: number;
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    companyId: string;
+    secretId: unknown;
+    messageHeader: string;
+    messageBody: string;
+    messageFooter: unknown;
+    caption: unknown;
+    messageHeaderType: string;
+    messageType: string;
+    messageFooterType: unknown;
+    subject: unknown;
+    origin: unknown;
+    recipientId: string;
+    provider: string;
+    providerId: string;
+    canBeInteractedWith: boolean;
+    buttons: unknown;
+    replyingToId?: number;
+    attachments: unknown;
+    createdAt: string;
+    updatedAt: string;
+    topic: unknown;
+    isPrivate: boolean;
+    metadata?: MessageMetadata | null;
+    carousel?: {
+        data?: unknown[];
+    };
+    status: MessageStatusResponse[];
+    reactions: MessageReactionResponse[];
+    replyingTo?: MessageReplyContext;
+    echo?: string;
+}
+/** Query parameters for fetching the initial message context of a room. */
+interface GetInitialContextRequest {
+    companyId: string;
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    limit?: number;
+    associations?: string[];
+}
+/** Paginated initial context response centered around unread messages. */
+interface GetInitialContextResponse {
+    data: MessageResponse[];
+    meta: {
+        count: number;
+        oldestCursor: number;
+        newestCursor: number;
+        lastUnreadMessageId: number | null;
+        hasMoreBefore: boolean;
+        hasMoreAfter: boolean;
+    };
+}
+/** Query parameters for cursor-based message pagination. */
+interface GetMessagesByCursorRequest {
+    companyId: string;
+    chatRoomId: number;
+    beforeId?: number;
+    afterId?: number;
+    limit?: number;
+    associations?: string[];
+}
+/** Paginated response for cursor-based message listing. */
+interface GetMessagesByCursorResponse {
+    data: MessageResponse[];
+    meta: {
+        hasMore: boolean;
+        count: number;
+        oldestCursor: number;
+        newestCursor: number;
+        hasMoreBefore?: boolean;
+        hasMoreAfter?: boolean;
+    };
+}
+/** Request payload for sending a chat message. */
+interface SendMessageRequest {
+    recipientId: string;
+    origin: string;
+    channel: string;
+    provider: string;
+    chatRoomId: number;
+    companyId: string;
+    messageBody?: string;
+    messageType: string;
+    chatRoomMemberId: number;
+    attachments?: {
+        data: MessageAttachment[];
+    };
+    replyingToId?: number;
+}
+/** Response returned when sending an attachment message. */
+interface SendAttachmentMessageResponse {
+    message: MessageResponse;
+}
+/** Request payload for marking specific messages as read. */
+interface MarkMessagesAsReadRequest {
+    chatRoomId: number;
+    chatRoomMemberId: number;
+    chatRoomMessageId: number[];
+    status: string;
+}
+/** Response returned after marking messages as read. */
+interface MarkMessagesAsReadResponse {
+    updatedMessageStatus: MessageStatusResponse[];
+}
+/** Request payload for updating a room member. */
+interface UpdateMemberInRoomRequest {
+    new?: boolean;
+}
+
+export type { CancelInvitationRequest, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageResponse, MessageStatusResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse, SendAttachmentMessageResponse, SendMessageRequest, UpdateMemberInRoomRequest };

package/dist/chat-webservice/contracts/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/chat-webservice/contracts/index.ts"],"sourcesContent":["export * from './invitation';\nexport * from './room';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../../src/chat-webservice/contracts/index.ts"],"sourcesContent":["export * from './invitation';\nexport * from './room';\nexport * from './message';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.d.mts

@@ -13,12 +13,13 @@ import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResp
 export { ContactPhoneResponse } from './contact-list/contracts/index.mjs';
 import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.mjs';
 export { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.mjs';
-import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse } from './chat-webservice/contracts/index.mjs';
-export { RoomActiveDates, RoomMemberResponse, RoomTagResponse } from './chat-webservice/contracts/index.mjs';
+import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse } from './chat-webservice/contracts/index.mjs';
+export { MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.mjs';
 import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.mjs';
 export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.mjs';
 import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem } from './cases/contracts/index.mjs';
 export { CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry } from './cases/contracts/index.mjs';
+export { Event } from './rh/contracts/index.mjs';
 
 /**
  * Gateway for interacting with the Customer Service API.
@@ -427,6 +428,50 @@ declare class ChatWebserviceGateway {
      * @returns The chat room data.
      */
     getRoomById(id: number, params?: GetRoomByIdRequest): Promise<RoomResponse>;
+    /**
+     * Fetches the initial message context for a room member, centered around unread messages.
+     * @param params - The room, member, and pagination filters.
+     * @returns The initial page of messages with unread metadata.
+     */
+    getInitialContext(params: GetInitialContextRequest): Promise<GetInitialContextResponse>;
+    /**
+     * Lists messages in a room using cursor-based pagination.
+     * @param params - The room, cursor, and association filters.
+     * @returns A page of messages with cursor metadata.
+     */
+    getMessagesByCursor(params: GetMessagesByCursorRequest): Promise<GetMessagesByCursorResponse>;
+    /**
+     * Sends a chat message to a room.
+     * @param payload - The message content and routing metadata.
+     * @returns The created message.
+     */
+    sendMessage(payload: SendMessageRequest): Promise<MessageResponse>;
+    /**
+     * Sends a chat message that includes attachments.
+     * @param payload - The message content, attachments, and routing metadata.
+     * @returns The created message wrapped in a response object.
+     */
+    sendAttachmentMessage(payload: SendMessageRequest): Promise<SendAttachmentMessageResponse>;
+    /**
+     * Marks specific messages as read for a room member.
+     * @param payload - The room, member, and message identifiers to update.
+     * @returns The updated message status entries.
+     */
+    markMessagesAsRead(payload: MarkMessagesAsReadRequest): Promise<MarkMessagesAsReadResponse>;
+    /**
+     * Marks all messages in a room as read for a given member.
+     * @param memberId - The chat room member identifier.
+     * @param roomId - The chat room identifier.
+     * @returns The API response payload.
+     */
+    markAllRoomMessagesAsRead(memberId: number, roomId: number): Promise<unknown>;
+    /**
+     * Updates a room member's attributes.
+     * @param memberId - The chat room member identifier.
+     * @param payload - The member fields to update.
+     * @returns The updated room member.
+     */
+    updateMemberInRoom(memberId: number, payload: UpdateMemberInRoomRequest): Promise<RoomMemberResponse>;
 }
 
 /**
@@ -478,6 +523,15 @@ declare class CasesGateway {
     getCaseFeedByActions(payload: GetCaseFeedByActionsRequest): Promise<CaseFeedByActionItem[]>;
 }
 
+/**
+ * Gateway for interacting with the RH API.
+ */
+declare class RhGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+}
+
 /**
  * Maps service identifiers to their corresponding gateway types.
  * Used by the `gateway()` function to infer the correct return type
@@ -497,6 +551,7 @@ type GatewayMap = {
     'chat-webservice': ChatWebserviceGateway;
     'call-report': CallReportGateway;
     cases: CasesGateway;
+    rh: RhGateway;
 };
 /**
  * Parameters required to configure the SDK client.
@@ -539,6 +594,9 @@ interface GatewayClientParams {
         cases?: {
             baseUrl: string;
         };
+        rh?: {
+            baseUrl: string;
+        };
     };
 }
 
@@ -553,6 +611,7 @@ declare const SERVICE_GATEWAYS: {
     readonly CHAT_WEBSERVICE: "chat-webservice";
     readonly CALL_REPORT: "call-report";
     readonly CASES: "cases";
+    readonly RH: "rh";
 };
 type SERVICE_GATEWAYS = (typeof SERVICE_GATEWAYS)[keyof typeof SERVICE_GATEWAYS];
 
@@ -579,4 +638,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CommentHistoryPage, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, ServiceGroupsResponse, UpdateCasePermissionsRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CommentHistoryPage, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateCasePermissionsRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };

package/dist/index.d.ts

@@ -13,12 +13,13 @@ import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResp
 export { ContactPhoneResponse } from './contact-list/contracts/index.js';
 import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.js';
 export { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.js';
-import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse } from './chat-webservice/contracts/index.js';
-export { RoomActiveDates, RoomMemberResponse, RoomTagResponse } from './chat-webservice/contracts/index.js';
+import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse } from './chat-webservice/contracts/index.js';
+export { MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.js';
 import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.js';
 export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.js';
 import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem } from './cases/contracts/index.js';
 export { CasePermissionsValue, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry } from './cases/contracts/index.js';
+export { Event } from './rh/contracts/index.js';
 
 /**
  * Gateway for interacting with the Customer Service API.
@@ -427,6 +428,50 @@ declare class ChatWebserviceGateway {
      * @returns The chat room data.
      */
     getRoomById(id: number, params?: GetRoomByIdRequest): Promise<RoomResponse>;
+    /**
+     * Fetches the initial message context for a room member, centered around unread messages.
+     * @param params - The room, member, and pagination filters.
+     * @returns The initial page of messages with unread metadata.
+     */
+    getInitialContext(params: GetInitialContextRequest): Promise<GetInitialContextResponse>;
+    /**
+     * Lists messages in a room using cursor-based pagination.
+     * @param params - The room, cursor, and association filters.
+     * @returns A page of messages with cursor metadata.
+     */
+    getMessagesByCursor(params: GetMessagesByCursorRequest): Promise<GetMessagesByCursorResponse>;
+    /**
+     * Sends a chat message to a room.
+     * @param payload - The message content and routing metadata.
+     * @returns The created message.
+     */
+    sendMessage(payload: SendMessageRequest): Promise<MessageResponse>;
+    /**
+     * Sends a chat message that includes attachments.
+     * @param payload - The message content, attachments, and routing metadata.
+     * @returns The created message wrapped in a response object.
+     */
+    sendAttachmentMessage(payload: SendMessageRequest): Promise<SendAttachmentMessageResponse>;
+    /**
+     * Marks specific messages as read for a room member.
+     * @param payload - The room, member, and message identifiers to update.
+     * @returns The updated message status entries.
+     */
+    markMessagesAsRead(payload: MarkMessagesAsReadRequest): Promise<MarkMessagesAsReadResponse>;
+    /**
+     * Marks all messages in a room as read for a given member.
+     * @param memberId - The chat room member identifier.
+     * @param roomId - The chat room identifier.
+     * @returns The API response payload.
+     */
+    markAllRoomMessagesAsRead(memberId: number, roomId: number): Promise<unknown>;
+    /**
+     * Updates a room member's attributes.
+     * @param memberId - The chat room member identifier.
+     * @param payload - The member fields to update.
+     * @returns The updated room member.
+     */
+    updateMemberInRoom(memberId: number, payload: UpdateMemberInRoomRequest): Promise<RoomMemberResponse>;
 }
 
 /**
@@ -478,6 +523,15 @@ declare class CasesGateway {
     getCaseFeedByActions(payload: GetCaseFeedByActionsRequest): Promise<CaseFeedByActionItem[]>;
 }
 
+/**
+ * Gateway for interacting with the RH API.
+ */
+declare class RhGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+}
+
 /**
  * Maps service identifiers to their corresponding gateway types.
  * Used by the `gateway()` function to infer the correct return type
@@ -497,6 +551,7 @@ type GatewayMap = {
     'chat-webservice': ChatWebserviceGateway;
     'call-report': CallReportGateway;
     cases: CasesGateway;
+    rh: RhGateway;
 };
 /**
  * Parameters required to configure the SDK client.
@@ -539,6 +594,9 @@ interface GatewayClientParams {
         cases?: {
             baseUrl: string;
         };
+        rh?: {
+            baseUrl: string;
+        };
     };
 }
 
@@ -553,6 +611,7 @@ declare const SERVICE_GATEWAYS: {
     readonly CHAT_WEBSERVICE: "chat-webservice";
     readonly CALL_REPORT: "call-report";
     readonly CASES: "cases";
+    readonly RH: "rh";
 };
 type SERVICE_GATEWAYS = (typeof SERVICE_GATEWAYS)[keyof typeof SERVICE_GATEWAYS];
 
@@ -579,4 +638,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CommentHistoryPage, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, ServiceGroupsResponse, UpdateCasePermissionsRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CommentHistoryPage, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateCasePermissionsRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };