@ikatec/digisac-api-sdk 1.2.0

package/src/apis/messages/MessagesApi.ts

@@ -0,0 +1,136 @@
+import qs from 'qs'
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type {
+  Message,
+  CreateMessagePayload,
+  UpdateMessagePayload,
+  ForwardMessagesPayload,
+  ForwardMessagesResult,
+  SendVcardsPayload,
+  SendReactionPayload,
+  MagicTextPayload,
+  MagicTextResult,
+  CheckSummaryPayload,
+  CheckSummaryResult,
+  BulkDestroyPayload,
+  OutOfRangeResult,
+  LoadAroundQuery,
+} from './types'
+
+export class MessagesApi extends BaseCrudApi<Message, CreateMessagePayload, UpdateMessagePayload> {
+  constructor(client: ApiClient) {
+    super(client, '/messages')
+  }
+
+  /** Forwards one or more messages to one or more contacts (max 20 messages to 5 contacts). */
+  forward(
+    body: ForwardMessagesPayload,
+    headers?: Record<string, string>,
+  ): Promise<ForwardMessagesResult> {
+    return this.client.post<ForwardMessagesResult, ForwardMessagesPayload>(
+      `${this.basePath}/forward`,
+      body,
+      headers,
+    )
+  }
+
+  /** Revokes (soft-deletes) a sent message so it is no longer visible to the recipient. */
+  revoke(id: string, headers?: Record<string, string>): Promise<Message> {
+    return this.client.post<Message>(`${this.basePath}/${id}/revoke`, undefined, headers)
+  }
+
+  /** Removes a previously sent reaction from a message. */
+  revokeReaction(id: string, headers?: Record<string, string>): Promise<boolean> {
+    return this.client.put<boolean>(`${this.basePath}/${id}/revoke-reaction`, undefined, headers)
+  }
+
+  /** Sends one or more contacts as vCard messages to a given contact. */
+  sendVcards(body: SendVcardsPayload, headers?: Record<string, string>): Promise<Message> {
+    return this.client.post<Message, SendVcardsPayload>(
+      `${this.basePath}/send-vcards`,
+      body,
+      headers,
+    )
+  }
+
+  /** Sends an emoji reaction to a message. */
+  sendReaction(
+    id: string,
+    body: SendReactionPayload,
+    headers?: Record<string, string>,
+  ): Promise<boolean> {
+    return this.client.post<boolean, SendReactionPayload>(
+      `${this.basePath}/${id}/send-reaction`,
+      body,
+      headers,
+    )
+  }
+
+  /** Uses AI to rewrite or correct a message text with a given tone (e.g. "correct", "professional", "casual"). */
+  magicText(body: MagicTextPayload, headers?: Record<string, string>): Promise<MagicTextResult> {
+    return this.client.post<MagicTextResult, MagicTextPayload>(
+      `${this.basePath}/magic-text`,
+      body,
+      headers,
+    )
+  }
+
+  /** Checks whether an AI-generated summary already exists for a given ticket. */
+  checkSummary(
+    body: CheckSummaryPayload,
+    headers?: Record<string, string>,
+  ): Promise<CheckSummaryResult> {
+    return this.client.post<CheckSummaryResult, CheckSummaryPayload>(
+      `${this.basePath}/check-summary`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Deletes multiple messages matching the given where clause.
+   * @permissions messages.destroy
+   */
+  bulkDestroy(body: BulkDestroyPayload, headers?: Record<string, string>): Promise<boolean> {
+    return this.client.request<boolean, BulkDestroyPayload>(
+      'DELETE',
+      `${this.basePath}/many`,
+      body,
+      headers,
+    )
+  }
+
+  /** Triggers an AI-generated summary for the conversation associated with the given message. */
+  summarize(id: string, headers?: Record<string, string>): Promise<void> {
+    return this.client.post<void>(`${this.basePath}/${id}/summarize`, undefined, headers)
+  }
+
+  /** Checks whether a message is out of the visible range (i.e. there are more than `limit` messages after it). */
+  outOfRange(
+    id: string,
+    limit?: number,
+    headers?: Record<string, string>,
+  ): Promise<OutOfRangeResult> {
+    const queryString = limit ? `?${qs.stringify({ limit })}` : ''
+    return this.client.get<OutOfRangeResult>(
+      `${this.basePath}/${id}/out-of-range${queryString}`,
+      headers,
+    )
+  }
+
+  /** Re-downloads and syncs the file attachment for a message from the messaging service. */
+  syncFile(id: string, headers?: Record<string, string>): Promise<unknown> {
+    return this.client.post<unknown>(`${this.basePath}/${id}/sync-file`, undefined, headers)
+  }
+
+  /** Loads messages surrounding a target message (N before and N after), useful for jumping to a specific point in a conversation. */
+  around(
+    id: string,
+    query?: LoadAroundQuery,
+    headers?: Record<string, string>,
+  ): Promise<Message[]> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<Message[]>(`${this.basePath}/${id}/around${queryString}`, headers)
+  }
+}

package/src/apis/messages/index.ts

@@ -0,0 +1,2 @@
+export { MessagesApi } from './MessagesApi'
+export type * from './types'

package/src/apis/messages/types.ts

@@ -0,0 +1,248 @@
+import type { Contact } from '../contacts/types'
+import type { Department } from '../departments/types'
+import type { File } from '../files/types'
+import type { Ticket } from '../tickets/types'
+import type { User } from '../users/types'
+
+export type MessageType =
+  | 'chat'
+  | 'audio'
+  | 'ptt'
+  | 'video'
+  | 'image'
+  | 'document'
+  | 'vcard'
+  | 'location'
+  | 'email'
+  | 'sticker'
+  | 'comment'
+  | 'ticket'
+  | 'summary'
+  | 'reaction'
+  | 'hsm'
+  | 'bot_action'
+  | string
+
+export type MessageData = {
+  textFromMail?: boolean
+  mentionedList?: { id: string }[]
+  hsmParameters?: unknown
+  fileDownload?: {
+    startedAt: string
+    endedAt?: string
+    isDownloading: boolean
+    error?: boolean
+  }
+  ack?: number | 'error'
+  location?: {
+    lat: number
+    lng: number
+    previewUrl: string
+  }
+  contact?: Contact
+  hsmDecremented?: boolean
+  vcard?: string
+  isFirst?: boolean
+  isNew?: boolean
+  isFromSync?: boolean
+  isSurveyResponse?: boolean
+  surveyExpired?: boolean
+  isFromFirstSync?: boolean
+  dontOpenTicket?: boolean
+  dontTransferTicket?: boolean
+  dontCallBot?: boolean
+  softRevoked?: boolean
+  mediaId?: string
+  mediaFilehash?: string
+  error?: unknown
+  errorDescription?: string
+  mail?: string
+  RAInteractionTypeId?: number
+  subject?: unknown
+  resourceId?: string
+  hasReaction?: boolean
+  whatsappMessageId?: string
+  startBlockedAt?: string
+  endBlockedAt?: string
+  unblockUntilAt?: string
+  hasAudioMetadata?: boolean
+  ctwaReferral?: {
+    sourceUrl?: string
+    sourceId?: string
+    body?: string
+    sourceType?: string
+    headline?: string
+    imageUrl?: string
+    videoUrl?: string
+    thumbnailUrl?: string
+    ctwaClid?: string
+  }
+  showMessage?: boolean
+  transcriptionOrigin?: string
+  scheduleId?: string
+  blockedFile?: {
+    fileName: string
+    extension: string
+    mimetype: string
+    reason: string
+    blockedAt: string
+  }
+}
+
+export type MessageMention = {
+  id: string
+  name: string
+  numberToRender: string
+  idFromService: string
+}
+
+export type Message = {
+  id: string
+  isFromMe: boolean
+  sent: boolean
+  type: MessageType
+  timestamp: string
+  data: MessageData
+  text: string
+  visible: boolean
+  origin: string | null
+  obfuscated: boolean
+  isComment?: boolean
+  isTranscribing?: boolean
+  transcribeError?: boolean
+  reactionParentMessageId: string | null
+  hsmId: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  user?: User | null
+  from?: Contact
+  contact?: Contact
+  ticket?: Ticket | null
+  file?: File | null
+  files?: File[]
+  thumbnail?: File | null
+  preview?: File | null
+  quotedMessage?: Message | null
+  ticketUser?: User | null
+  ticketDepartment?: Department | null
+  hsm?: unknown
+  hsmFile?: File | null
+  reactions?: Message[]
+  reactionParentMessage?: Message | null
+  mentionedList?: MessageMention[]
+  interpolatedHsmMessage?: {
+    header: unknown
+    body: string
+    footer: string
+    buttons: unknown[]
+  }
+}
+
+export type MessageRelationships =
+  | 'user'
+  | 'from'
+  | 'contact'
+  | 'ticket'
+  | 'file'
+  | 'files'
+  | 'thumbnail'
+  | 'preview'
+  | 'quotedMessage'
+  | 'ticketUser'
+  | 'ticketDepartment'
+  | 'hsm'
+  | 'hsmFile'
+  | 'reactions'
+  | 'reactionParentMessage'
+  | 'mentionedList'
+  | 'interpolatedHsmMessage'
+
+export type CreateMessagePayload = {
+  text?: string
+  contactId?: string
+  number?: string
+  serviceId?: string
+  userId?: string
+  file?: unknown
+  fileId?: string
+  filesIds?: string[]
+  quotedMessageId?: string
+  hsmId?: string
+  hsm?: unknown
+  hsmFileId?: string
+  type?: string
+  origin?: 'user' | 'bot'
+  isComment?: boolean
+  dontOpenTicket?: boolean
+  dontSendUserName?: boolean
+  mentionedList?: string[]
+  interactiveMessage?: unknown
+  stickerId?: string
+  isPtt?: boolean
+  subject?: string
+  ccs?: unknown[]
+}
+
+export type UpdateMessagePayload = {
+  text?: string
+  file?: unknown
+  fileId?: string
+  contactId?: string
+  number?: string
+  origin?: 'user' | 'bot'
+  hsm?: unknown
+  hsmFileId?: string
+}
+
+export type ForwardMessagesPayload = {
+  contactsIds: string[]
+  messagesIds: string[]
+}
+
+export type ForwardMessagesResult = {
+  id: string
+  messagesIds: string[]
+}[]
+
+export type SendVcardsPayload = {
+  serviceId: string
+  contactId: string
+  contactsIds: string[]
+}
+
+export type SendReactionPayload = {
+  reactionEmojiRendered: string
+  reactionCode?: string
+}
+
+export type MagicTextPayload = {
+  message: string
+  tone: string
+  serviceId?: string
+}
+
+export type MagicTextResult = {
+  answer: string | null
+}
+
+export type CheckSummaryPayload = {
+  ticketId: string
+}
+
+export type CheckSummaryResult = {
+  hasSummary: boolean
+}
+
+export type BulkDestroyPayload = {
+  where: Record<string, unknown>
+}
+
+export type OutOfRangeResult = {
+  outOfRange: boolean
+}
+
+export type LoadAroundQuery = {
+  limit?: number
+}

package/src/apis/notifications/NotificationsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Notification, CreateNotificationPayload, UpdateNotificationPayload } from './types'
+
+export class NotificationsApi extends BaseCrudApi<
+  Notification,
+  CreateNotificationPayload,
+  UpdateNotificationPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/notifications')
+  }
+}

package/src/apis/notifications/index.ts

@@ -0,0 +1,2 @@
+export { NotificationsApi } from './NotificationsApi'
+export type * from './types'

package/src/apis/notifications/types.ts

@@ -0,0 +1,62 @@
+import type { Contact } from '../contacts/types'
+import type { Schedule } from '../schedule/types'
+import type { User } from '../users/types'
+
+export type NotificationType =
+  | 'schedule'
+  | 'distribution'
+  | 'info'
+  | 'warn'
+  | 'error'
+  | 'announcement'
+  | 'copilot'
+  | 'undefined'
+  | 'waba-health-warning'
+  | 'waba-health-block'
+
+/** Present on pipeline-related notifications. */
+export type NotificationConfig = {
+  pipelineId: string
+  pipelineAutomationId: string
+}
+
+export type Notification = {
+  id: string
+  text: string
+  type: NotificationType | null
+  read: boolean
+  image: string | null
+  label: string | null
+  config: NotificationConfig | null
+  attachedType: string | null
+  contactId: string | null
+  userId: string
+  accountId: string
+  scheduleId: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  user?: User
+  schedule?: Schedule | null
+  contact?: Contact | null
+}
+
+export type NotificationRelationships = 'user' | 'schedule' | 'contact'
+
+export type CreateNotificationPayload = {
+  text: string
+  userId: string
+  type?: NotificationType
+  label?: string
+  config?: NotificationConfig
+  attachedType?: string
+  contactId?: string
+  scheduleId?: string
+}
+
+export type UpdateNotificationPayload = {
+  text?: string
+  read?: boolean
+  label?: string | null
+}

package/src/apis/organizations/OrganizationsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Organization, CreateOrganizationPayload, UpdateOrganizationPayload } from './types'
+
+export class OrganizationsApi extends BaseCrudApi<
+  Organization,
+  CreateOrganizationPayload,
+  UpdateOrganizationPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/organizations')
+  }
+}

package/src/apis/organizations/index.ts

@@ -0,0 +1,2 @@
+export { OrganizationsApi } from './OrganizationsApi'
+export type * from './types'

package/src/apis/organizations/types.ts

@@ -0,0 +1,24 @@
+import type { Person } from '../people/types'
+
+export type Organization = {
+  id: string
+  name: string | null
+  document: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  // relationships
+  people?: Person[]
+}
+
+export type OrganizationRelationships = 'people'
+
+export type CreateOrganizationPayload = {
+  name: string
+  document?: string
+}
+
+export type UpdateOrganizationPayload = {
+  name?: string
+  document?: string | null
+}

package/src/apis/people/PeopleApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Person, CreatePersonPayload, UpdatePersonPayload } from './types'
+
+export class PeopleApi extends BaseCrudApi<Person, CreatePersonPayload, UpdatePersonPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/people')
+  }
+}

package/src/apis/people/index.ts

@@ -0,0 +1,2 @@
+export { PeopleApi } from './PeopleApi'
+export type * from './types'

package/src/apis/people/types.ts

@@ -0,0 +1,26 @@
+import type { Contact } from '../contacts/types'
+import type { Organization } from '../organizations/types'
+
+export type Person = {
+  id: string
+  name: string | null
+  document: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  // relationships
+  organizations?: Organization[]
+  contacts?: Contact[]
+}
+
+export type PersonRelationships = 'organizations' | 'contacts'
+
+export type CreatePersonPayload = {
+  name: string
+  document?: string
+}
+
+export type UpdatePersonPayload = {
+  name?: string
+  document?: string | null
+}

package/src/apis/permissions/PermissionsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Permission, CreatePermissionPayload, UpdatePermissionPayload } from './types'
+
+export class PermissionsApi extends BaseCrudApi<
+  Permission,
+  CreatePermissionPayload,
+  UpdatePermissionPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/permissions')
+  }
+}

package/src/apis/permissions/index.ts

@@ -0,0 +1,2 @@
+export { PermissionsApi } from './PermissionsApi'
+export type * from './types'