@ikatec/digisac-api-sdk 1.2.0

package/src/apis/contacts/ContactsApi.ts

@@ -0,0 +1,105 @@
+import qs from 'qs'
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { ListQuery, Paginated } from '../../core/types'
+import type {
+  Contact,
+  CountContactsQuery,
+  CountMediaResult,
+  CreateContactPayload,
+  ExistsContactsParams,
+  ExportTemplatePayload,
+  UpdateContactPayload,
+} from './types'
+
+export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, UpdateContactPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/contacts')
+  }
+
+  /**
+   * Downloads a CSV template for importing contacts, with columns based on the service type.
+   * @permissions contacts.view AND contacts.export
+   */
+  exportTemplate(body: ExportTemplatePayload, headers?: Record<string, string>): Promise<unknown> {
+    return this.client.post<unknown, ExportTemplatePayload>(
+      `${this.basePath}/export-template`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Returns the total number of contacts matching the given query filters.
+   * @permissions contacts.view
+   */
+  count(query?: CountContactsQuery, headers?: Record<string, string>): Promise<{ count: number }> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<{ count: number }>(`${this.basePath}/count${queryString}`, headers)
+  }
+
+  /**
+   * Returns the total number of contacts matching the given filters (POST variant for complex queries).
+   * @permissions contacts.view
+   */
+  countPost(
+    body: CountContactsQuery,
+    headers?: Record<string, string>,
+  ): Promise<{ count: number }> {
+    return this.client.post<{ count: number }, CountContactsQuery>(
+      `${this.basePath}/count`,
+      body,
+      headers,
+    )
+  }
+
+  /**
+   * Returns a paginated list of contacts available for message forwarding.
+   * @permissions contacts.view
+   */
+  forward(
+    query?: ListQuery<Contact>,
+    headers?: Record<string, string>,
+  ): Promise<Paginated<Contact>> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<Paginated<Contact>>(`${this.basePath}/forward${queryString}`, headers)
+  }
+
+  /**
+   * Checks whether contacts exist for the given phone numbers on a specific service. Returns a map of number to boolean.
+   * @permissions contacts.view
+   */
+  exists(
+    params: ExistsContactsParams,
+    headers?: Record<string, string>,
+  ): Promise<Record<string, boolean>> {
+    const queryString = `?${qs.stringify(params)}`
+    return this.client.get<Record<string, boolean>>(
+      `${this.basePath}/exists${queryString}`,
+      headers,
+    )
+  }
+
+  /**
+   * Returns media counts grouped by type (e.g. image, video, document, link) for a contact.
+   * @permissions contacts.view
+   */
+  countMedia(contactId: string, headers?: Record<string, string>): Promise<CountMediaResult> {
+    return this.client.get<CountMediaResult>(`${this.basePath}/${contactId}/media/count`, headers)
+  }
+
+  /**
+   * Returns a paginated list of contacts using POST body for advanced filtering.
+   * @permissions contacts.view
+   */
+  list(
+    body: Record<string, unknown>,
+    headers?: Record<string, string>,
+  ): Promise<Paginated<Contact>> {
+    return this.client.post<Paginated<Contact>, Record<string, unknown>>(
+      `${this.basePath}/list`,
+      body,
+      headers,
+    )
+  }
+}

package/src/apis/contacts/index.ts

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

package/src/apis/contacts/types.ts

@@ -0,0 +1,189 @@
+import type { Department } from '../departments/types'
+import type { Person } from '../people/types'
+import type { Service } from '../services/types'
+import type { Tag } from '../tags/types'
+import type { Ticket } from '../tickets/types'
+import type { User } from '../users/types'
+import type { ListQuery } from '../../core/types'
+
+export type ContactStatus = 'online' | 'offline' | 'absent'
+export type ContactOrigin = 'api' | 'app' | 'campaign' | 'driver' | 'import' | 'web'
+
+export type ContactData = {
+  hasUnreadMentionForMe?: boolean
+  lastSyncAt?: string
+  unread?: boolean
+  /** Hugme (ReclameAqui) status code. */
+  hugmeStatus?: 1 | 2 | 3 | 4 | 15 | 16 | 17 | 21 | 22
+  /** ReclameAqui status code. */
+  raStatus?: 5 | 6 | 7 | 8 | 9 | 10 | 12 | 13 | 18 | 19 | 20
+  answered?: boolean
+  info?: {
+    birthday?: string
+    cpf?: string
+    rg?: string
+    gender?: string
+    email?: string
+    phoneNumbers?: string
+    city?: string
+    state?: string
+    company?: string
+  }
+  number?: string
+  valid?: boolean
+  isOriginal?: boolean
+  validNumber?: string
+  email?: string
+  survey?: {
+    expiresAt?: string
+    ticketId?: string
+    questionId?: string
+    tries?: number
+  }
+  webchat?: {
+    userId: string
+    roomId?: string
+    idleStages?: {
+      1?: string
+      2?: string
+      3?: string
+    }
+    sentFollowUpMail?: { sentAt: string; origin: 'auto' | 'manual' }
+    sentTicketCloseMail?: { sentAt: string; origin: 'auto' | 'manual' }
+    originAccessURL?: string
+    followUpToken?: string
+    followUpRedirectLink?: string
+    contactUnread?: number
+    continueService?: boolean
+  }
+  lastChargedMessage?: string
+  botIsRunning?: boolean
+  botFinishedAt?: string
+  blockMessageRules?: {
+    unblockUntilAt?: string
+    alertToBlockUntilAt?: string
+    nextUnblockAt?: string
+    unreadAlertToBlock?: boolean
+  }
+  canSend?: boolean
+  lastMessageIdOnInactiveTicket?: string
+  lidId?: string
+  jidId?: string
+  /** ISO date string of when group data was last synced. */
+  groupSyncedAt?: string
+  groupSettings?: {
+    inviteUrl?: string
+    onlyAdminCanSend?: boolean
+    onlyAdminCanEditProperties?: boolean
+    onlyAdminCanAddMembers?: boolean
+    onlyAdminCanApproveMembers?: boolean
+    description?: string
+  }
+}
+
+export type ContactDataBlock = {
+  /**
+   * Block level:
+   * - `0` = unblocked via block list
+   * - `1` = blocked via block list
+   * - `2` = manually unblocked
+   * - `3` = manually blocked
+   */
+  level: 0 | 1 | 2 | 3
+  byUserId: string
+  date: string
+  description: string
+}
+
+export type Contact = {
+  id: string
+  idFromService: string | null
+  name: string | null
+  internalName: string | null
+  alternativeName: string | null
+  isGroup: boolean
+  isBroadcast: boolean
+  isMe: boolean
+  isMyContact: boolean
+  hadChat: boolean
+  visible: boolean
+  status: ContactStatus
+  isSilenced: boolean
+  data: ContactData
+  note: string | null
+  unread: number
+  lastMessageAt: string | null
+  unsubscribed: boolean
+  lastContactMessageAt: string | null
+  acceptedTermAt: string | null
+  hsmExpirationTime: string | null
+  block: boolean | null
+  dataBlock: ContactDataBlock | null
+  origin: ContactOrigin | null
+  archivedAt: string | null
+  accountId: string
+  serviceId: string
+  defaultDepartmentId: string | null
+  defaultUserId: string | null
+  currentTicketId: string | null
+  lastMessageId: string | null
+  personId: string | null
+  contactBlockListControlId: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  service?: Service
+  defaultDepartment?: Department | null
+  defaultUser?: User | null
+  person?: Person | null
+  tags?: Tag[]
+  currentTicket?: Ticket | null
+}
+
+export type ContactRelationships =
+  | 'service'
+  | 'defaultDepartment'
+  | 'defaultUser'
+  | 'person'
+  | 'tags'
+  | 'currentTicket'
+
+export type CreateContactPayload = {
+  name?: string
+  serviceId: string
+  idFromService?: string
+  defaultDepartmentId?: string
+  defaultUserId?: string
+  data?: ContactData
+  note?: string
+  origin?: ContactOrigin
+}
+
+export type UpdateContactPayload = {
+  name?: string
+  internalName?: string
+  alternativeName?: string
+  defaultDepartmentId?: string | null
+  defaultUserId?: string | null
+  data?: ContactData
+  note?: string | null
+  isSilenced?: boolean
+  block?: boolean
+}
+
+export type ExportTemplatePayload = {
+  serviceType: string
+  type: string
+}
+
+export type CountContactsQuery = ListQuery<Contact> & {
+  queries?: ListQuery<Contact>[]
+}
+
+export type ExistsContactsParams = {
+  serviceId: string
+  numbers: string[]
+}
+
+export type CountMediaResult = Record<string, number>

package/src/apis/creditMovements/CreditMovementsApi.ts

@@ -0,0 +1,17 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type {
+  CreditMovement,
+  CreateCreditMovementPayload,
+  UpdateCreditMovementPayload,
+} from './types'
+
+export class CreditMovementsApi extends BaseCrudApi<
+  CreditMovement,
+  CreateCreditMovementPayload,
+  UpdateCreditMovementPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/credit-movements')
+  }
+}

package/src/apis/creditMovements/index.ts

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

package/src/apis/creditMovements/types.ts

@@ -0,0 +1,61 @@
+import type { Campaign } from '../campaigns/types'
+import type { Service } from '../services/types'
+import type { User } from '../users/types'
+
+export type CreditMovementType = 'in' | 'out'
+
+export type CreditMovementServiceType =
+  | 'sms-wavy'
+  | 'transcription'
+  | 'summary'
+  | 'magic-text'
+  | 'copilot'
+  | 'csat'
+  | 'agent'
+
+export type CreditMovementOrigin =
+  | 'trial'
+  | 'single'
+  | 'bulk'
+  | 'chargeback'
+  | 'renewal'
+  | 'reset'
+  | 'agnus'
+  | 'marketplace'
+  | 'copilot'
+  | 'additional'
+  | 'agent'
+
+export type CreditMovement = {
+  id: string
+  type: CreditMovementType
+  amount: number | null
+  serviceType: CreditMovementServiceType
+  origin: CreditMovementOrigin | null
+  accountId: string
+  serviceId: string
+  userId: string | null
+  campaignId: string | null
+  createdAt: string
+  updatedAt: string
+  // relationships
+  service?: Service
+  user?: User | null
+  campaign?: Campaign | null
+}
+
+export type CreditMovementRelationships = 'service' | 'user' | 'campaign'
+
+export type CreateCreditMovementPayload = {
+  type: CreditMovementType
+  serviceType: CreditMovementServiceType
+  serviceId: string
+  amount?: number
+  origin?: CreditMovementOrigin
+  userId?: string
+  campaignId?: string
+}
+
+export type UpdateCreditMovementPayload = {
+  amount?: number
+}

package/src/apis/customFields/CustomFieldsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { CustomField, CreateCustomFieldPayload, UpdateCustomFieldPayload } from './types'
+
+export class CustomFieldsApi extends BaseCrudApi<
+  CustomField,
+  CreateCustomFieldPayload,
+  UpdateCustomFieldPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/custom-fields')
+  }
+}

package/src/apis/customFields/index.ts

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

package/src/apis/customFields/types.ts

@@ -0,0 +1,76 @@
+export type CustomFieldType =
+  | 'cpf'
+  | 'cnpj'
+  | 'email'
+  | 'date'
+  | 'date-range'
+  | 'hour'
+  | 'hour-range'
+  | 'type'
+  | 'text'
+  | 'long-text'
+  | 'numeric'
+  | 'monetary'
+  | 'phone'
+  | 'postal-code'
+  | 'checkbox'
+  | 'list'
+
+export type CustomFieldOption = {
+  id?: string
+  label?: string
+}
+
+/** Settings for `list` and `checkbox` types: a list of selectable options. */
+export type CustomFieldListSettings = {
+  options: CustomFieldOption[]
+}
+
+/** Settings for `monetary` type: optional min/max value constraints. */
+export type CustomFieldMonetarySettings = {
+  options: CustomFieldOption[]
+  min?: string
+  max?: string
+}
+
+/** Settings for `text` and `long-text` types: optional max length constraint. */
+export type CustomFieldTextSettings = {
+  options: CustomFieldOption[]
+  maxLength?: number
+}
+
+export type CustomFieldSettings =
+  | CustomFieldListSettings
+  | CustomFieldMonetarySettings
+  | CustomFieldTextSettings
+
+export type CustomField = {
+  id: string
+  name: string
+  type: CustomFieldType
+  allowed: 'contacts'
+  showOnRegister: boolean
+  required: boolean
+  settings: CustomFieldSettings | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+}
+
+export type CreateCustomFieldPayload = {
+  name: string
+  type: CustomFieldType
+  allowed: 'contacts'
+  showOnRegister?: boolean
+  required?: boolean
+  settings?: CustomFieldSettings
+}
+
+export type UpdateCustomFieldPayload = {
+  name?: string
+  type?: CustomFieldType
+  showOnRegister?: boolean
+  required?: boolean
+  settings?: CustomFieldSettings | null
+}

package/src/apis/departments/DepartmentsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Department, CreateDepartmentPayload, UpdateDepartmentPayload } from './types'
+
+export class DepartmentsApi extends BaseCrudApi<
+  Department,
+  CreateDepartmentPayload,
+  UpdateDepartmentPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/departments')
+  }
+}

package/src/apis/departments/index.ts

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

package/src/apis/departments/types.ts

@@ -0,0 +1,27 @@
+import type { Distribution } from '../distribution/types'
+import type { Tag } from '../tags/types'
+
+export type Department = {
+  id: string
+  name: string | null
+  accountId: string
+  distributionId: string | null
+  archivedAt: string | null
+  createdAt: string
+  updatedAt: string
+  // relationships
+  distribution?: Distribution | null
+  tags?: Tag[]
+}
+
+export type DepartmentRelationships = 'distribution' | 'tags'
+
+export type CreateDepartmentPayload = {
+  name: string
+  distributionId?: string
+}
+
+export type UpdateDepartmentPayload = {
+  name?: string
+  distributionId?: string | null
+}

package/src/apis/distribution/DistributionApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Distribution, CreateDistributionPayload, UpdateDistributionPayload } from './types'
+
+export class DistributionApi extends BaseCrudApi<
+  Distribution,
+  CreateDistributionPayload,
+  UpdateDistributionPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/distribution')
+  }
+}

package/src/apis/distribution/index.ts

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

package/src/apis/distribution/types.ts

@@ -0,0 +1,40 @@
+import type { Department } from '../departments/types'
+import type { Role } from '../roles/types'
+
+export type Distribution = {
+  id: string
+  name: string
+  maxNum: number
+  timeToRedistribute: number
+  redistributeAll: boolean
+  redistributeAssignedTickets: boolean
+  distributeQueue: boolean
+  accountId: string
+  archivedAt: string | null
+  deletedAt: string | null
+  createdAt: string
+  updatedAt: string
+  // relationships
+  departments?: Department[]
+  roles?: Role[]
+}
+
+export type DistributionRelationships = 'departments' | 'roles'
+
+export type CreateDistributionPayload = {
+  name: string
+  maxNum: number
+  redistributeAll: boolean
+  timeToRedistribute?: number
+  redistributeAssignedTickets?: boolean
+  distributeQueue?: boolean
+}
+
+export type UpdateDistributionPayload = {
+  name?: string
+  maxNum?: number
+  redistributeAll?: boolean
+  timeToRedistribute?: number
+  redistributeAssignedTickets?: boolean
+  distributeQueue?: boolean
+}

package/src/apis/files/FilesApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { File, CreateFilePayload, UpdateFilePayload } from './types'
+
+export class FilesApi extends BaseCrudApi<File, CreateFilePayload, UpdateFilePayload> {
+  constructor(client: ApiClient) {
+    super(client, '/files')
+  }
+}

package/src/apis/files/index.ts

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

package/src/apis/files/types.ts

@@ -0,0 +1,57 @@
+export type FileAudioMetadata = {
+  duration?: number
+  bitRate?: number
+  sampleRate?: number
+  channels?: number
+  /** Waveform peak amplitudes for rendering audio visualizations. */
+  peaks?: number[]
+}
+
+export type FileData = {
+  audioMetadata?: FileAudioMetadata
+}
+
+export type FileStorage =
+  | 's3'
+  | 'oracle'
+  | 'fs'
+  | 'oracleFallback'
+  | 'wpLvS3'
+  | 'wpBrowserDataS3'
+  | 'exportsS3'
+  | string
+
+export type File = {
+  id: string
+  name: string | null
+  checksum: string | null
+  mimetype: string
+  extension: string
+  isEncrypted: boolean
+  iv: string | null
+  attachedId: string | null
+  attachedType: string | null
+  storage: FileStorage
+  data: FileData
+  accountId: string
+  serviceId: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+}
+
+export type CreateFilePayload = {
+  name?: string
+  mimetype: string
+  extension: string
+  attachedId?: string
+  attachedType?: string
+  serviceId?: string
+  data?: FileData
+}
+
+export type UpdateFilePayload = {
+  name?: string
+  attachedId?: string | null
+  attachedType?: string | null
+}

package/src/apis/holiday/HolidayApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Holiday, CreateHolidayPayload, UpdateHolidayPayload } from './types'
+
+export class HolidayApi extends BaseCrudApi<Holiday, CreateHolidayPayload, UpdateHolidayPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/holiday')
+  }
+}

package/src/apis/holiday/index.ts

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

package/src/apis/holiday/types.ts

@@ -0,0 +1,25 @@
+export type Holiday = {
+  id: string
+  name: string
+  from: string
+  to: string
+  message: string
+  accountId: string
+  createdAt: string
+  updatedAt: string | null
+  deletedAt: string | null
+}
+
+export type CreateHolidayPayload = {
+  name: string
+  from: string
+  to: string
+  message: string
+}
+
+export type UpdateHolidayPayload = {
+  name?: string
+  from?: string
+  to?: string
+  message?: string
+}