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

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

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, {}>>

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: {
      all?: boolean;
      include?: string;
      list?: number;
      page?: number;
      type?: "EXTERNAL";
  }
  - Optional all?: boolean
  - Optional include?: string
  - Optional list?: number
  - Optional page?: number
  - Optional type?: "EXTERNAL"
Returns Promise<AxiosResponse<IChat[], any, {}>>
list of chats

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

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, {}>>

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

updateWidget

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

Generated using TypeDoc