@ikatec/digisac-api-sdk 1.2.0

package/src/apis/serviceEvents/ServiceEventsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { ServiceEvent, CreateServiceEventPayload, UpdateServiceEventPayload } from './types'
+
+export class ServiceEventsApi extends BaseCrudApi<
+  ServiceEvent,
+  CreateServiceEventPayload,
+  UpdateServiceEventPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/service-events')
+  }
+}

package/src/apis/serviceEvents/index.ts

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

package/src/apis/serviceEvents/types.ts

@@ -0,0 +1,52 @@
+import type { Service } from '../services/types'
+import type { User } from '../users/types'
+
+export type ServiceEventReasonCategory = 'service_connection' | 'service_block_message'
+
+export type ServiceConnectionReason =
+  | 'waiting_qr_code'
+  | 'connected_elsewhere'
+  | 'device_offline'
+  | 'archived'
+  | 'shutdown'
+  | 'connected'
+  | 'unknown'
+
+export type ServiceBlockMessageReason =
+  | 'enabled_block_message_rules_active'
+  | 'disabled_block_message_rules_active'
+  | 'enabled_unblock_by_receive_message'
+  | 'disabled_unblock_by_receive_message'
+
+export type ServiceEvent = {
+  id: string
+  online: boolean | null
+  reason: ServiceConnectionReason | ServiceBlockMessageReason | null
+  reasonCategory: ServiceEventReasonCategory | null
+  startedAt: string | null
+  endedAt: string | null
+  accountId: string
+  serviceId: string
+  userId: string | null
+  createdAt: string
+  updatedAt: string
+  // relationships
+  service?: Service
+  user?: User | null
+}
+
+export type ServiceEventRelationships = 'service' | 'user'
+
+export type CreateServiceEventPayload = {
+  online: boolean
+  reason: ServiceConnectionReason | ServiceBlockMessageReason
+  reasonCategory: ServiceEventReasonCategory
+  serviceId: string
+  startedAt?: string
+  endedAt?: string
+}
+
+export type UpdateServiceEventPayload = {
+  online?: boolean
+  endedAt?: string | null
+}

package/src/apis/services/ServicesApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Service, CreateServicePayload, UpdateServicePayload } from './types'
+
+export class ServicesApi extends BaseCrudApi<Service, CreateServicePayload, UpdateServicePayload> {
+  constructor(client: ApiClient) {
+    super(client, '/services')
+  }
+}

package/src/apis/services/index.ts

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

package/src/apis/services/types.ts

@@ -0,0 +1,222 @@
+import type { Bot } from '../bots/types'
+import type { Department } from '../departments/types'
+
+export type ServiceType =
+  | 'whatsapp'
+  | 'email'
+  | 'webchat'
+  | 'sms-wavy'
+  | 'telegram'
+  | 'instagram'
+  | 'reclame-aqui'
+  | 'whatsapp-remote'
+  | 'whatsapp-business'
+  | 'facebook-messenger'
+  | 'google-business-message'
+
+export type ServiceConnectionStatus = {
+  isSyncing?: boolean
+  isConnected?: boolean
+  isStarting?: boolean
+  isStarted?: boolean
+  batteryLevel?: number
+  isCharging?: boolean
+  isConflicted?: boolean
+  isLoading?: boolean
+  isOnChatPage?: boolean
+  enteredQrCodePageAt?: string
+  disconnectedAt?: string
+  isOnQrPage?: boolean
+  isPhoneAuthed?: boolean
+  isPhoneConnected?: boolean
+  isQrCodeExpired?: boolean
+  isHosted?: boolean
+  isWaitingForPhoneInternet?: boolean
+  isWebConnected?: boolean
+  isWebSyncing?: boolean
+  isLidMigrated?: boolean
+  mode?: string
+  myId?: string
+  myLidId?: string
+  myName?: string
+  myNumber?: string
+  needsCharging?: boolean
+  qrCodeExpiresAt?: number
+  qrCodeUrl?: string | null
+  state?: string
+  timestamp?: string
+}
+
+export type ServiceData = {
+  // ─── Common ───────────────────────────────────────────────────────────────
+  token?: string
+  myId?: string
+  syncCount?: number
+  readReceipts?: boolean
+  markComposingBeforeSend?: boolean
+  lastSyncAt?: string
+  lastDisconnectedAt?: string
+  lastMessageTimestamp?: string
+  isManuallyDisconnected?: boolean
+  notifiedServiceDisconnectionAt?: string
+  status?: ServiceConnectionStatus
+
+  // ─── WhatsApp / WhatsApp Remote ───────────────────────────────────────────
+  phone?: string
+  phoneWhatsapp?: string
+  provider?: string
+  appName?: string
+  syncFlowDone?: boolean
+
+  // ─── WhatsApp Business ────────────────────────────────────────────────────
+  pageId?: string
+  businessId?: string
+  numberId?: string
+  /** WhatsApp Business API provider: positus, 360Dialog, meta, or gupshup. */
+  providerType?: 'positus' | '360Dialog' | 'meta' | 'gupshup' | null
+  hub360PartnerId?: string
+
+  // ─── Telegram ─────────────────────────────────────────────────────────────
+  nameTelegram?: string
+
+  // ─── Email ────────────────────────────────────────────────────────────────
+  /** Email service provider. */
+  service?: 'Gmail' | 'Outlook365' | 'Godaddy' | 'GSuite' | 'Hotmail' | 'other' | null
+  auth?: { user: string; pass?: string }
+  imap?: { host: string; port: number; syncFrom: number }
+  smtp?: { host: string; port: number; ignoreTLS?: boolean; requireTLS?: boolean }
+  includeSpamTrash?: boolean
+  microsoft?: {
+    token_type: string
+    scope: string
+    expires_in: number
+    ext_expires_in: number
+    access_token: string
+    refresh_token: string
+    refreshedAt: string
+  }
+
+  // ─── SMS Wavy ─────────────────────────────────────────────────────────────
+  smsWavy?: { sync: boolean }
+
+  // ─── Webchat ──────────────────────────────────────────────────────────────
+  nameWebchat?: string
+  filePerfilWebchat?: {
+    base64Url: string
+    mimetype: string
+    fileName: string
+  }
+  webchat?: Record<string, unknown>
+
+  // ─── Other ────────────────────────────────────────────────────────────────
+  driverId?: string
+  apiURL?: string
+  error?: unknown
+  googleBusiness?: unknown
+}
+
+export type ServiceInternalData = {
+  id?: string
+  appToken?: string
+  partnerToken?: string
+  apiKey?: string
+  webchat?: {
+    id: string
+    token: string
+    password: string
+    username: string
+  }
+  user?: string
+  pass?: string
+  clientId?: string
+  clientSecret?: string
+  securityToken?: string
+  token?: {
+    accessToken: string
+    tokenType: string
+    expiresAt: number
+    scope: string
+    rateLimit: number
+    licenseStartAt: string
+    licenseId: number
+    organizationId: string
+  }
+  localStorage?: Record<string, string>
+  envInfo?: Record<string, unknown>
+  mmlite?: string
+} | null
+
+export type ServiceSettings = {
+  readReceipts?: boolean
+  markComposingBeforeSend?: boolean
+  blockMessageRulesActive?: boolean
+  unblockByReceiveMessage?: boolean
+  shouldOpenTicketForGroups?: boolean
+  reactionsEnabled?: boolean
+  tokenSandBox360?: string
+  lowLevel?: boolean
+  cloudApi?: boolean
+  keepOnline?: boolean
+  allowScanAnotherNumber?: boolean
+  contactsSyncDisabled?: boolean
+  legacyMessageIds?: boolean
+  ackChangeTimeout?: number
+  fallbackMessagesCheckerInterval?: number
+  disableMessagesChecker?: boolean
+  disableFallbackMessagesChecker?: boolean
+  syncDelay?: number
+  lowLevelContactCheckerDelay?: number
+  lowLevelStatusConnectedDelay?: number
+  widget?: Record<string, unknown>
+}
+
+/** WhatsApp Business API health status (WABA only). */
+export type ServiceHealth = {
+  /** e.g. `'AVAILABLE'` | `'LIMITED'` | `'BLOCKED'` */
+  status: string
+  /** e.g. `'ALLOWED'` | `'BLOCKED'` | `'LIMITED'` */
+  canSendMessage: string
+  /** e.g. `'HIGH'` | `'MEDIUM'` | `'LOW'` */
+  qualityRating: string
+  info: string
+  errors: { description: string; solution: string }[]
+}
+
+export type Service = {
+  id: string
+  name: string
+  type: ServiceType
+  data: ServiceData
+  internalData: ServiceInternalData
+  settings: ServiceSettings
+  health: ServiceHealth | null
+  accountId: string
+  defaultDepartmentId: string | null
+  botId: string | null
+  archivedAt: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  bot?: Bot | null
+  defaultDepartment?: Department | null
+}
+
+export type ServiceRelationships = 'bot' | 'defaultDepartment'
+
+export type CreateServicePayload = {
+  name: string
+  type: ServiceType
+  data?: ServiceData
+  settings?: ServiceSettings
+  defaultDepartmentId?: string
+  botId?: string
+}
+
+export type UpdateServicePayload = {
+  name?: string
+  data?: ServiceData
+  settings?: ServiceSettings
+  defaultDepartmentId?: string | null
+  botId?: string | null
+}

package/src/apis/stickerUsers/StickerUsersApi.ts

@@ -0,0 +1,35 @@
+import qs from 'qs'
+import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery, Paginated, HasGetMany } from '../../core/types'
+import type { StickerUser } from './types'
+
+export class StickerUsersApi implements HasGetMany<StickerUser> {
+  private readonly client: ApiClient
+
+  constructor(client: ApiClient) {
+    this.client = client
+  }
+
+  /**
+   * Returns a paginated list of sticker-user associations with their related file.
+   * @permissions stickers.send
+   */
+  getMany(
+    query: ListQuery<StickerUser> & { paginate: false },
+    headers?: Record<string, string>,
+  ): Promise<StickerUser[]>
+  getMany(
+    query?: ListQuery<StickerUser> & { paginate?: true },
+    headers?: Record<string, string>,
+  ): Promise<Paginated<StickerUser>>
+  getMany(
+    query?: ListQuery<StickerUser>,
+    headers?: Record<string, string>,
+  ): Promise<Paginated<StickerUser> | StickerUser[]> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<Paginated<StickerUser> | StickerUser[]>(
+      `/sticker-users${queryString}`,
+      headers,
+    )
+  }
+}

package/src/apis/stickerUsers/index.ts

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

package/src/apis/stickerUsers/types.ts

@@ -0,0 +1,18 @@
+import type { File } from '../files/types'
+import type { Sticker } from '../stickers/types'
+import type { User } from '../users/types'
+
+export type StickerUser = {
+  stickerId: string
+  userId: string
+  accountId: string
+  lastSendAt: string
+  createdAt: string
+  updatedAt: string
+  // relationships
+  sticker?: Sticker
+  user?: User
+  file?: File
+}
+
+export type StickerUserRelationships = 'sticker' | 'user' | 'file'

package/src/apis/stickers/StickersApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Sticker, CreateStickerPayload, UpdateStickerPayload } from './types'
+
+export class StickersApi extends BaseCrudApi<Sticker, CreateStickerPayload, UpdateStickerPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/stickers')
+  }
+}

package/src/apis/stickers/index.ts

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

package/src/apis/stickers/types.ts

@@ -0,0 +1,29 @@
+import type { User } from '../users/types'
+
+export type Sticker = {
+  id: string
+  type: string
+  originFileChecksum: string | null
+  originFilehash: string | null
+  originMessageId: string | null
+  userId: string
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  user?: User
+}
+
+export type StickerRelationships = 'user'
+
+export type CreateStickerPayload = {
+  type: string
+  originMessageId?: string
+  originFileChecksum?: string
+  originFilehash?: string
+}
+
+export type UpdateStickerPayload = {
+  type?: string
+}

package/src/apis/tags/TagsApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Tag, CreateTagPayload, UpdateTagPayload } from './types'
+
+export class TagsApi extends BaseCrudApi<Tag, CreateTagPayload, UpdateTagPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/tags')
+  }
+}

package/src/apis/tags/index.ts

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

package/src/apis/tags/types.ts

@@ -0,0 +1,27 @@
+import type { Contact } from '../contacts/types'
+import type { Department } from '../departments/types'
+
+export type Tag = {
+  id: string
+  label: string
+  backgroundColor: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  contacts?: Contact[]
+  departments?: Department[]
+}
+
+export type TagRelationships = 'contacts' | 'departments'
+
+export type CreateTagPayload = {
+  label: string
+  backgroundColor?: string
+}
+
+export type UpdateTagPayload = {
+  label?: string
+  backgroundColor?: string | null
+}

package/src/apis/terms/TermsApi.ts

@@ -0,0 +1,23 @@
+import qs from 'qs'
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { ListQuery, Paginated } from '../../core/types'
+import type { Term, CreateTermPayload, UpdateTermPayload } from './types'
+
+export class TermsApi extends BaseCrudApi<Term, CreateTermPayload, UpdateTermPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/terms')
+  }
+
+  /** Returns all terms where agreementDate is null for the current user's account (i.e. terms not yet agreed to). */
+  getNotAgreed(
+    query?: ListQuery<Term>,
+    headers?: Record<string, string>,
+  ): Promise<Paginated<Term>> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<Paginated<Term>>(
+      `${this.basePath}/terms-not-agreed${queryString}`,
+      headers,
+    )
+  }
+}

package/src/apis/terms/index.ts

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

package/src/apis/terms/types.ts

@@ -0,0 +1,29 @@
+export type Term = {
+  id: string
+  title: Record<string, string>
+  text: Record<string, string>
+  expirationDate: string
+  version: string
+  agnusId: string
+  accountId: string | null
+  userId: string | null
+  agreementDate: string | null
+  createdAt: string
+  updatedAt: string
+}
+
+export type CreateTermPayload = {
+  title: Record<string, string>
+  text: Record<string, string>
+  expirationDate: string
+  version: string
+  agnusId: string
+  accountId?: string
+}
+
+export type UpdateTermPayload = {
+  title?: Record<string, string>
+  text?: Record<string, string>
+  expirationDate?: string
+  version?: string
+}

package/src/apis/ticketTopics/TicketTopicsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { TicketTopic, CreateTicketTopicPayload, UpdateTicketTopicPayload } from './types'
+
+export class TicketTopicsApi extends BaseCrudApi<
+  TicketTopic,
+  CreateTicketTopicPayload,
+  UpdateTicketTopicPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/ticket-topics')
+  }
+}

package/src/apis/ticketTopics/index.ts

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

package/src/apis/ticketTopics/types.ts

@@ -0,0 +1,17 @@
+export type TicketTopic = {
+  id: string
+  name: string
+  accountId: string
+  archivedAt: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+}
+
+export type CreateTicketTopicPayload = {
+  name: string
+}
+
+export type UpdateTicketTopicPayload = {
+  name?: string
+}

package/src/apis/tickets/TicketsApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Ticket, CreateTicketPayload, UpdateTicketPayload } from './types'
+
+export class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/tickets')
+  }
+}

package/src/apis/tickets/index.ts

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

package/src/apis/tickets/types.ts

@@ -0,0 +1,69 @@
+import type { Contact } from '../contacts/types'
+import type { Department } from '../departments/types'
+import type { Service } from '../services/types'
+import type { User } from '../users/types'
+
+export type TicketOrigin = 'automatic' | 'manual' | 'widget'
+
+export type TicketMetrics = {
+  /** Time in seconds the contact waited before a user picked up the ticket. */
+  waitingTime?: number
+  /** Time in seconds the contact waited after the bot handed off to a human. */
+  waitingTimeAfterBot?: number
+  /** Total time in seconds with active messaging (first to last message). */
+  messagingTime?: number
+  /** Total open time in seconds from ticket open to close. */
+  ticketTime?: number
+  /** Sum of waiting times across all transfers. */
+  waitingTimeTransfersSum?: number
+  /** Number of times the ticket was transferred. */
+  ticketTransferCount?: number
+  /** Average waiting time per transfer. */
+  waitingTimeTransfersAvg?: number
+  isActiveTicket?: boolean
+}
+
+export type Ticket = {
+  id: string
+  isOpen: boolean
+  comments: string | null
+  protocol: string | null
+  origin: TicketOrigin | null
+  metrics: TicketMetrics
+  startedAt: string | null
+  endedAt: string | null
+  isDistributing: boolean
+  count: number | null
+  accountId: string
+  departmentId: string
+  contactId: string
+  userId: string | null
+  serviceId: string | null
+  firstMessageId: string | null
+  lastMessageId: string | null
+  currentTicketTransferId: string | null
+  createdAt: string
+  updatedAt: string
+  // relationships
+  contact?: Contact
+  department?: Department
+  user?: User | null
+  service?: Service | null
+}
+
+export type TicketRelationships = 'contact' | 'department' | 'user' | 'service'
+
+export type CreateTicketPayload = {
+  contactId: string
+  departmentId: string
+  userId?: string
+  comments?: string
+  origin?: TicketOrigin
+}
+
+export type UpdateTicketPayload = {
+  departmentId?: string
+  userId?: string | null
+  comments?: string | null
+  isOpen?: boolean
+}

package/src/apis/timetable/TimetableApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Timetable, CreateTimetablePayload, UpdateTimetablePayload } from './types'
+
+export class TimetableApi extends BaseCrudApi<
+  Timetable,
+  CreateTimetablePayload,
+  UpdateTimetablePayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/timetable')
+  }
+}

package/src/apis/timetable/index.ts

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

package/src/apis/timetable/types.ts

@@ -0,0 +1,28 @@
+export type TimetableWorkSlot = {
+  day: number
+  start: string
+  end: string
+  active: boolean
+}
+
+export type Timetable = {
+  id: string
+  name: string
+  previousTimeToNotification: number
+  workPlan: TimetableWorkSlot[]
+  accountId: string
+  createdAt: string
+  updatedAt: string
+}
+
+export type CreateTimetablePayload = {
+  name: string
+  previousTimeToNotification: number
+  workPlan: TimetableWorkSlot[]
+}
+
+export type UpdateTimetablePayload = {
+  name?: string
+  previousTimeToNotification?: number
+  workPlan?: TimetableWorkSlot[]
+}