@signalwire/js/src/fabric/interfaces/index.ts

SignalWire JS SDK

import {
  ConversationChatMessagesSubscribeParams,
  ConversationChatMessagesSubscribeResult,
  ConversationSubscribeCallback,
  ConversationSubscribeResult,
  GetConversationChatMessageParams,
  GetConversationChatMessageResult,
  GetConversationMessagesParams,
  GetConversationMessagesResult,
  GetConversationsParams,
  GetConversationsResult,
  GetMessagesParams,
  GetMessagesResult,
  JoinConversationParams,
  JoinConversationResult,
  SendConversationMessageParams,
  SendConversationMessageResult,
} from './conversation'
import { Address } from './address'
import { HTTPClientContract } from './httpClient'
import { WSClientContract, WSClientOptions } from './wsClient'

export interface SignalWireClientParams extends WSClientOptions {}

export interface SignalWireContract
  extends WSClientContract,
    Omit<HTTPClientContract, 'getAddresses' | 'getAddress'> {
  address: Pick<HTTPClientContract, 'getAddresses' | 'getAddress'>
  /** @deprecated */
  conversation: {
    getConversations: (
      _params?: GetConversationsParams
    ) => Promise<GetConversationsResult>
    getMessages: (_params?: GetMessagesParams) => Promise<GetMessagesResult>
    getConversationMessages: (
      _params: GetConversationMessagesParams
    ) => Promise<GetConversationMessagesResult>
    subscribe: (
      _callback: ConversationSubscribeCallback
    ) => Promise<ConversationSubscribeResult>
    sendMessage: (
      params: SendConversationMessageParams
    ) => Promise<SendConversationMessageResult>
    join: (_params: JoinConversationParams) => Promise<JoinConversationResult>
  }
  /** @deprecated */
  chat: {
    getMessages: (
      _params: GetConversationChatMessageParams
    ) => Promise<GetConversationChatMessageResult>
    subscribe: (
      _params: ConversationChatMessagesSubscribeParams
    ) => Promise<ConversationChatMessagesSubscribeResult>
    sendMessage: (
      params: SendConversationMessageParams
    ) => Promise<SendConversationMessageResult>
    join: (_params: JoinConversationParams) => Promise<JoinConversationResult>
  }
}

export type SignalWireClient = SignalWireContract

// #region Paginated response and result

export interface PaginatedResponse<T> {
  data: Array<T>
  links: {
    first?: string
    self?: string
    next?: string
    prev?: string
  }
}

export interface PaginatedResult<T> {
  data: Array<T>
  self(): Promise<PaginatedResult<T> | undefined>
  nextPage(): Promise<PaginatedResult<T> | undefined>
  prevPage(): Promise<PaginatedResult<T> | undefined>
  firstPage(): Promise<PaginatedResult<T> | undefined>
  hasNext: boolean
  hasPrev: boolean
}

// #endregion Paginated response and result

// #region Subscriber info

export interface GetSubscriberInfoResponse {
  id: string
  email: string
  first_name?: string
  last_name?: string
  display_name?: string
  job_title?: string
  time_zone?: number
  country?: string
  region?: string
  company_name?: string
  push_notification_key: string
  app_settings?: {
    display_name: string
    scopes: string[]
  }
  fabric_addresses: Address[]
}

export type GetSubscriberInfoResult = GetSubscriberInfoResponse

// #endregion Subscriber info

export * from './capabilities'
export * from './address'
export * from './conversation'
export * from './device'
export * from './httpClient'
export * from './incomingCallManager'
export * from './wsClient'