Class MessengerService

Messenger service

Hierarchy

MessengerService

Constructors

constructor

new MessengerService(httpClient): MessengerService
Parameters
- httpClient: HttpClient
Returns MessengerService

Properties

`Private` `Readonly` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/messenger/v1'

Methods

createChatNote

createChatNote(chatId, text): Promise<{
data: IChatNote;
}>
create note for chat
Parameters
- chatId: string
  
  chat id
- text: string
  
  note text
Returns Promise<{
data: IChatNote;
}>
created note

createChatRelation

createChatRelation(props): Promise<{
data: IRelatedChatItem;
}>
create chat relation
Parameters
- props: {
  chatId: string;
  entityId: string;
  }
  - chatId: string
  - entityId: string
Returns Promise<{
data: IRelatedChatItem;
}>
created relation

createQuickAnswer

createQuickAnswer(data): Promise<AxiosResponse<any, any, {}>>
create quick answer
Parameters
- data: ICreateQuickAnswerDTO
Returns Promise<AxiosResponse<any, any, {}>>
created quick answer

createWidget

createWidget(data): Promise<AxiosResponse<any, any, {}>>
create widget
Parameters
- data: ICreateWidgetData
  
  create widget payload
Returns Promise<AxiosResponse<any, any, {}>>
created widget data

deleteChatNote

deleteChatNote(noteId): Promise<{
data: IChatNote;
}>
delete note for chat
Parameters
- noteId: string
  
  note id
Returns Promise<{
data: IChatNote;
}>
deleted note

deleteChatRelation

deleteChatRelation(props): Promise<{
data: IRelatedChatItem;
}>
delete chat relation
Parameters
- props: {
  chatId: string;
  entityId: string;
  }
  - chatId: string
  - entityId: string
Returns Promise<{
data: IRelatedChatItem;
}>

deleteQuickAnswer

deleteQuickAnswer(id): Promise<AxiosResponse<any, any, {}>>
delete quick answer
Parameters
- id: string
Returns Promise<AxiosResponse<any, any, {}>>

deleteWidgets

deleteWidgets(id): Promise<AxiosResponse<any, any, {}>>
delete widget
Parameters
- id: string
  
  widget id
Returns Promise<AxiosResponse<any, any, {}>>

getChatNotes

getChatNotes(chatId): Promise<{
data: IChatNote[];
}>
get notes for chat
Parameters
- chatId: string
  
  chat id
Returns Promise<{
data: IChatNote[];
}>
list of notes for chat

getChatRelations

getChatRelations(props): Promise<{
data: IRelatedChatItem[];
}>
get chat relations
Parameters
- props: {
  chatId: string;
  }
  - chatId: string
Returns Promise<{
data: IRelatedChatItem[];
}>
list of related entities

getChats

getChats(props): Promise<AxiosResponse<IChat[], any, {}>>
Get chats
Parameters
- props: IFetchChatsParams
Returns Promise<AxiosResponse<IChat[], any, {}>>
list of chats

getExternalChatsPage

getExternalChatsPage(props): Promise<AxiosResponse<ICursorPaginatedChats, any, {}>>
Get a cursor (keyset) paginated page of external chats for one status bucket. Hits the same /chats endpoint but engages cursor mode (cursor/limit present) and returns ICursorPaginatedChats: { pinned?, data, nextCursor, hasNext }. Pass externalStatuses as a single status ('active' | 'undistributed' | 'inactive'). Omit cursor for the first page (which also returns the pinned block).
Parameters
- props: IFetchChatsParams
Returns Promise<AxiosResponse<ICursorPaginatedChats, any, {}>>

getMessages

getMessages(props): Promise<AxiosResponse<any, any, {}>>
Get messages
Parameters
- props: FetchMessagesRequest
Returns Promise<AxiosResponse<any, any, {}>>
list of messages for chat

getPinnedMessages

getPinnedMessages(chatId): Promise<AxiosResponse<any, any, {}>>
Get pinned messages
Parameters
- chatId: string
  
  chat id
Returns Promise<AxiosResponse<any, any, {}>>
pinned messages for chat

getQuickAnswerById

getQuickAnswerById(id): Promise<{
data: IQuickAnswer;
}>
get quick answer by id
Parameters
- id: string
Returns Promise<{
data: IQuickAnswer;
}>
quick answer

getQuickAnswers

getQuickAnswers(reqParams): Promise<AxiosResponse<any, any, {}>>
get quick answers
Parameters
- reqParams: IGetQuickAnswerParams
Returns Promise<AxiosResponse<any, any, {}>>
list of quick answers

getSettings

getSettings(): Promise<{
data: IUserSettings;
}>
get users settings

Returns Promise<{
data: IUserSettings;
}>
users settings

getTaskRelations

getTaskRelations(props): Promise<{
data: IChat[];
}>
get task relations
Parameters
- props: {
  entityId: string;
  }
  - entityId: string
Returns Promise<{
data: IChat[];
}>
list of related chats

getWidgets

getWidgets(limit?, page?): Promise<AxiosResponse<any, any, {}>>
create widget
Parameters
- Optional limit: number
- Optional page: number
Returns Promise<AxiosResponse<any, any, {}>>
created widget data

goToMessage

goToMessage(id): Promise<AxiosResponse<any, any, {}>>
Go to message
Parameters
- id: GoToMessageRequest
  
  message id
Returns Promise<AxiosResponse<any, any, {}>>
out message ( and 10 next and 10 previous messages if we don't have our message in store )

readAllMessages

readAllMessages(chatId): Promise<AxiosResponse<any, any, {}>>
readAllMessages
Parameters
- chatId: string
  
  chat id
Returns Promise<AxiosResponse<any, any, {}>>

updateChatNote

updateChatNote(noteId, text): Promise<{
data: IChatNote;
}>
update note for chat
Parameters
- noteId: string
  
  note id
- text: string
  
  new note text
Returns Promise<{
data: IChatNote;
}>
updated note

updateQuickAnswer

updateQuickAnswer(id, data): Promise<{
data: IQuickAnswer;
}>
update quick answer
Parameters
- id: string
- data: Partial<IQuickAnswer>
Returns Promise<{
data: IQuickAnswer;
}>
updated quick answer

updateQuickAnswerStatus

updateQuickAnswerStatus(id, status): Promise<{
data: IQuickAnswer;
}>
update status
Parameters
- id: string
- status: string
Returns Promise<{
data: IQuickAnswer;
}>
updated quick answer

updateSettings

updateSettings(settings): Promise<{
data: IUserSettings;
}>
update users settings
Parameters
- settings: Partial<Omit<IUserSettings, "authUserId">>
  
  new settings
Returns Promise<{
data: IUserSettings;
}>
updated users settings

updateWidget

updateWidget(data): Promise<AxiosResponse<any, any, {}>>
update widget
Parameters
- data: ICreateWidgetData
  
  update widget payload
Returns Promise<AxiosResponse<any, any, {}>>
updated widget data

Class MessengerService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

httpClient: HttpClient

Returns MessengerService

Properties

Private Readonly httpClient

Private namespace

Methods

createChatNote

Parameters

chatId: string

text: string

Returns Promise<{ data: IChatNote; }>

createChatRelation

Parameters

props: { chatId: string; entityId: string; }

chatId: string

entityId: string

Returns Promise<{ data: IRelatedChatItem; }>

createQuickAnswer

Parameters

data: ICreateQuickAnswerDTO

Returns Promise<AxiosResponse<any, any, {}>>

createWidget

Parameters

data: ICreateWidgetData

Returns Promise<AxiosResponse<any, any, {}>>

deleteChatNote

Parameters

noteId: string

Returns Promise<{ data: IChatNote; }>

deleteChatRelation

Parameters

props: { chatId: string; entityId: string; }

chatId: string

entityId: string

Returns Promise<{ data: IRelatedChatItem; }>

deleteQuickAnswer

Parameters

id: string

Returns Promise<AxiosResponse<any, any, {}>>

deleteWidgets

Parameters

id: string

Returns Promise<AxiosResponse<any, any, {}>>

getChatNotes

Parameters

chatId: string

Returns Promise<{ data: IChatNote[]; }>

getChatRelations

Parameters

props: { chatId: string; }

chatId: string

Returns Promise<{ data: IRelatedChatItem[]; }>

getChats

Parameters

props: IFetchChatsParams

Returns Promise<AxiosResponse<IChat[], any, {}>>

getExternalChatsPage

Parameters

props: IFetchChatsParams

Returns Promise<AxiosResponse<ICursorPaginatedChats, any, {}>>

getMessages

Parameters

props: FetchMessagesRequest

Returns Promise<AxiosResponse<any, any, {}>>

getPinnedMessages

Parameters

chatId: string

Returns Promise<AxiosResponse<any, any, {}>>

getQuickAnswerById

Parameters

id: string

`Private` `Readonly` httpClient

`Private` namespace

Returns Promise<{
data: IChatNote;
}>

props: {
chatId: string;
entityId: string;
}

Returns Promise<{
data: IRelatedChatItem;
}>

Returns Promise<{
data: IChatNote;
}>

props: {
chatId: string;
entityId: string;
}

Returns Promise<{
data: IRelatedChatItem;
}>

Returns Promise<{
data: IChatNote[];
}>

props: {
chatId: string;
}

Returns Promise<{
data: IRelatedChatItem[];
}>

Returns Promise<{
data: IQuickAnswer;
}>

Returns Promise<{
data: IUserSettings;
}>

props: {
entityId: string;
}

Returns Promise<{
data: IChat[];
}>

`Optional` limit: number

`Optional` page: number

Returns Promise<{
data: IChatNote;
}>

Returns Promise<{
data: IQuickAnswer;
}>

Returns Promise<{
data: IQuickAnswer;
}>

Returns Promise<{
data: IUserSettings;
}>