@ikatec/digisac-api-sdk 1.2.0

package/src/apis/bots/types.ts

@@ -0,0 +1,287 @@
+import type { BotVersion } from '../botVersions/types'
+import type { Service } from '../services/types'
+
+// ─── Settings ─────────────────────────────────────────────────────────────────
+
+export type BotCreatedVersion = 'v1' | 'v2' | 'v3'
+
+export type BotLimitations = {
+  hasInteractiveMessage?: boolean
+  hasWebchatTrigger?: boolean
+}
+
+export type BotSettings = {
+  /** If true, only the first matching rule per trigger fires; otherwise all matching rules fire. */
+  sequentialRuleExecution?: boolean
+  /** Version of the bot builder used to create this bot. v3 uses the visual flow builder. */
+  botCreatedVersion?: BotCreatedVersion
+  limitations?: BotLimitations
+}
+
+// ─── FlowJson ─────────────────────────────────────────────────────────────────
+
+export type BotEvent =
+  | 'MESSAGE_RECEIVED'
+  | 'WIDGET_MESSAGE_RECEIVED'
+  | 'USER_MESSAGE_SENT'
+  | 'MANUAL_TICKET_OPENED'
+  | 'TICKET_OPENED'
+  | 'TICKET_CLOSED'
+  | 'TICKET_BEFORE_CLOSE'
+  | 'TICKET_INACTIVE'
+  | 'ENTER_CONTEXT'
+  | 'LEAVE_CONTEXT'
+  | 'CONTACT_CREATED'
+  | 'CONTACT_RECONNECTED'
+  | 'API_SIGNAL'
+  | 'ANONYMOUS_USER_CREATED_WEBCHAT'
+
+export type BotFlowTriggerNode = {
+  id: string
+  type: 'triggerNode'
+  position: { x: number; y: number }
+  data: { trigger: BotEvent }
+}
+
+export type BotFlowMenuNodeAnswer = {
+  id: string
+  text: string
+  fallback?: boolean
+}
+
+export type BotFlowMenuNode = {
+  id: string
+  type: 'menuNode'
+  position: { x: number; y: number }
+  data: {
+    text: string
+    answers?: BotFlowMenuNodeAnswer[]
+  }
+}
+
+export type BotFlowNode = BotFlowTriggerNode | BotFlowMenuNode
+
+export type BotFlowEdge = {
+  id: string
+  source: string
+  target: string
+  /** The answer handle ID on the source node this edge originates from, if any. */
+  sourceHandle: string
+}
+
+/** Visual flow graph used by the flow builder UI. Gets compiled into `contexts` on save. */
+export type BotFlowJson = {
+  nodes: BotFlowNode[]
+  edges: BotFlowEdge[]
+}
+
+// ─── Contexts ─────────────────────────────────────────────────────────────────
+
+export type BotActionType =
+  | 'SEND_MESSAGE'
+  | 'SEND_TERM'
+  | 'CONFIRM_TERM'
+  | 'SEND_QUESTION'
+  | 'WRITE_CUSTOM_FIELD'
+  | 'TRANSFER_TICKET'
+  | 'CLOSE_TICKET'
+  | 'ADD_TAG'
+  | 'REMOVE_TAG'
+  | 'SET_CONTEXT'
+  | 'RESET_CONTEXT'
+  | 'UNSUBSCRIBE_FROM_CAMPAIGN'
+  | 'SEND_WEBHOOK_COMMAND'
+  | 'AI'
+  | 'HTTP_REQUEST'
+  | 'SET_VAR'
+
+export type BotActionDataMap = {
+  SEND_MESSAGE: {
+    text?: string
+    /** File UUID. */
+    file?: string
+    /** Message mask/template string. */
+    mask?: string
+    /** WhatsApp Business interactive message payload. */
+    interactive?: unknown
+    /** Quick reply buttons. */
+    actions?: { title: string; value: string }[]
+  }
+  SEND_TERM: {
+    /** Acceptance term UUID. */
+    acceptanceTerms?: string
+  }
+  CONFIRM_TERM: {
+    /** Acceptance term UUID to confirm. */
+    confirmAcceptanceTerms?: string
+  }
+  SEND_QUESTION: {
+    /** Question UUID. */
+    question?: string
+  }
+  WRITE_CUSTOM_FIELD: {
+    /** Custom field UUID. */
+    customField?: string
+    /** Custom field UUID (alias used in some versions). */
+    customFieldId?: string
+    /** Prompt text sent to the contact asking for input. */
+    text?: string
+    /** Number of retries before giving up. */
+    tries?: number
+    /** Message sent when the contact provides an invalid value. */
+    invalidMessage?: string
+    /** Context ID to navigate to on success. */
+    successContext?: string
+    /** Context ID to navigate to on failure. */
+    fallbackContext?: string
+  }
+  TRANSFER_TICKET: {
+    /** Department UUID. */
+    department?: string
+    /** User UUID. */
+    user?: string
+  }
+  CLOSE_TICKET: {
+    /** Ticket topic UUIDs. */
+    ticketTopics?: string[]
+    comments?: string
+  }
+  ADD_TAG: {
+    /** Tag UUIDs to add to the contact. */
+    tags: string[]
+  }
+  REMOVE_TAG: {
+    /** Tag UUIDs to remove from the contact. */
+    tags: string[]
+  }
+  SET_CONTEXT: {
+    /** Context ID to navigate to. */
+    context?: string
+  }
+  RESET_CONTEXT: Record<string, never>
+  UNSUBSCRIBE_FROM_CAMPAIGN: Record<string, never>
+  SEND_WEBHOOK_COMMAND: {
+    command?: string
+  }
+  AI: {
+    /** AI agent UUID. */
+    agentId?: string
+    prompt?: string
+    maxAttempts?: number
+    /** Actions to take based on AI agent outcomes. */
+    actions?: { context?: string; action: { id: string; type: string } }[]
+  }
+  HTTP_REQUEST: {
+    requestName?: string
+    endpointUrl?: string
+    httpMethod?: 'get' | 'post' | 'put' | 'patch' | 'delete'
+    isAsyncRequest?: boolean
+    bodyType?: 'json' | 'xml' | 'formData' | 'empty'
+    headers?: { key: string; value: string }[]
+    requestBodyFormData?: { key: string; value: string }[]
+    requestBodyJson?: string
+    requestBodyXml?: string
+    retries?: number
+    /** Timeout in milliseconds. */
+    timeout?: number
+    /** Response properties to extract into bot session variables. */
+    variables?: { key: string; value: string }[]
+  }
+  SET_VAR: {
+    /** Session variable name. */
+    key: string
+    /** Value to assign (supports interpolation via `{{variable}}`). */
+    value: string
+  }
+}
+
+export type BotAction = {
+  [K in BotActionType]: {
+    value: K
+    name?: string
+    data: BotActionDataMap[K]
+  }
+}[BotActionType]
+
+/**
+ * A simple condition matching a single variable against a value.
+ * Key is a variable placeholder like `{{message_text}}` or `{{@customVar}}`.
+ * Value is an object with one operator key (e.g. `$eq`, `$in`, `$between`).
+ */
+export type BotSimpleCondition = {
+  [variable: string]: {
+    [operator: string]: string | string[] | number | boolean
+  }
+}
+
+/** Groups multiple simple conditions with a logical AND or OR. */
+export type BotGroupCondition = {
+  $and?: BotSimpleCondition[]
+  $or?: BotSimpleCondition[]
+}
+
+export type BotCondition = BotSimpleCondition | BotGroupCondition
+
+export type BotRule = {
+  title: string
+  actions: BotAction[]
+  conditions: BotCondition[]
+  fallbackActions: BotAction[]
+  data?: Record<string, unknown>
+}
+
+export type BotContext = {
+  name: string
+  /** Map of event type to ordered list of rules evaluated when that event fires. */
+  triggers: Partial<Record<BotEvent, BotRule[]>>
+}
+
+/**
+ * Map of context IDs to their configuration.
+ * `@INIT`, `@EVERY`, and `@FALLBACK` are always present built-in contexts.
+ * Additional string keys are user-defined context IDs.
+ */
+export type BotContexts = {
+  '@INIT': BotContext
+  '@EVERY': BotContext
+  '@FALLBACK': BotContext
+  [contextId: string]: BotContext
+}
+
+// ─── Bot ──────────────────────────────────────────────────────────────────────
+
+export type Bot = {
+  id: string
+  name: string
+  data: Record<string, unknown>
+  contexts: BotContexts
+  flowJson: BotFlowJson | null
+  settings: BotSettings
+  currentBotVersionId: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  currentBotVersion?: BotVersion | null
+  services?: Service[]
+}
+
+export type CreateBotPayload = {
+  name: string
+  data?: Record<string, unknown>
+  contexts?: BotContexts
+  flowJson?: BotFlowJson
+  settings?: BotSettings
+}
+
+export type BotRelationships = 'currentBotVersion' | 'services'
+
+export type UpdateBotPayload = {
+  name?: string
+  data?: Record<string, unknown>
+  contexts?: BotContexts
+  flowJson?: BotFlowJson
+  settings?: BotSettings
+  currentBotVersionId?: string | null
+}

package/src/apis/campaigns/CampaignsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Campaign, CreateCampaignPayload, UpdateCampaignPayload } from './types'
+
+export class CampaignsApi extends BaseCrudApi<
+  Campaign,
+  CreateCampaignPayload,
+  UpdateCampaignPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/campaigns')
+  }
+}

package/src/apis/campaigns/index.ts

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

package/src/apis/campaigns/types.ts

@@ -0,0 +1,97 @@
+import type { Department } from '../departments/types'
+import type { Service } from '../services/types'
+import type { Tag } from '../tags/types'
+import type { User } from '../users/types'
+
+export type CampaignStatus =
+  | 'ready'
+  | 'queued'
+  | 'processing'
+  | 'paused'
+  | 'waiting_connection'
+  | 'canceled'
+  | 'done'
+  | 'insufficient_credits'
+  | 'hsm_limit_exceeded'
+  | 'import_error'
+  | 'error'
+  | 'importing_contacts'
+  | 'preventive_break'
+
+export type CampaignConfig = {
+  /** Minimum interval in ms between sends. */
+  minInterval: number
+  /** Maximum interval in ms between sends. */
+  maxInterval: number
+  /** Column name in the import file used as the contact name. */
+  nameField?: string
+  /** Column name in the import file used as the phone number. */
+  numberField?: string
+  delimiter?: ',' | ';' | ':' | string
+  error?: {
+    message: string
+  }
+}
+
+export type Campaign = {
+  id: string
+  title: string
+  status: CampaignStatus | null
+  config: CampaignConfig
+  sendsAt: string | null
+  isScheduled: boolean
+  startedAt: string | null
+  finishedAt: string | null
+  totalMessagesCount: number | null
+  sentMessagesCount: number | null
+  totalContacts: number | null
+  totalContactsImported: number | null
+  totalValidContacts: number | null
+  mustOpenTicket: boolean
+  marketingIntegration: boolean
+  accountId: string
+  serviceId: string
+  defaultDepartmentId: string | null
+  defaultUserId: string | null
+  createdById: string | null
+  sentById: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  service?: Service
+  defaultDepartment?: Department | null
+  defaultUser?: User | null
+  createdBy?: User | null
+  sentBy?: User | null
+  tags?: Tag[]
+}
+
+export type CampaignRelationships =
+  | 'service'
+  | 'defaultDepartment'
+  | 'defaultUser'
+  | 'createdBy'
+  | 'sentBy'
+  | 'tags'
+
+export type CreateCampaignPayload = {
+  title: string
+  serviceId: string
+  config: CampaignConfig
+  defaultDepartmentId?: string
+  defaultUserId?: string
+  sendsAt?: string
+  isScheduled?: boolean
+  mustOpenTicket?: boolean
+}
+
+export type UpdateCampaignPayload = {
+  title?: string
+  config?: CampaignConfig
+  defaultDepartmentId?: string | null
+  defaultUserId?: string | null
+  sendsAt?: string | null
+  isScheduled?: boolean
+  mustOpenTicket?: boolean
+}

package/src/apis/cards/CardsApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Card, CreateCardPayload, UpdateCardPayload } from './types'
+
+export class CardsApi extends BaseCrudApi<Card, CreateCardPayload, UpdateCardPayload> {
+  constructor(client: ApiClient) {
+    super(client, '/cards')
+  }
+}

package/src/apis/cards/index.ts

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

package/src/apis/cards/types.ts

@@ -0,0 +1,63 @@
+import type { Contact } from '../contacts/types'
+import type { Pipeline } from '../pipeline/types'
+import type { User } from '../users/types'
+
+export type Card = {
+  id: string
+  title: string
+  description: string | null
+  order: number | null
+  isArchived: boolean
+  archivedAt: string | null
+  success: boolean | null
+  finishedAt: string | null
+  organization: string | null
+  organizationSegment: string | null
+  originChannel: string | null
+  originCampaign: string | null
+  accountId: string
+  contactId: string | null
+  pipelineId: string
+  pipelineStageId: string | null
+  statusId: string | null
+  reasonId: string | null
+  ownerId: string | null
+  createdAt: string
+  updatedAt: string
+  // relationships
+  contact?: Contact | null
+  owner?: User | null
+  pipeline?: Pipeline
+}
+
+export type CardRelationships = 'contact' | 'owner' | 'pipeline'
+
+export type CreateCardPayload = {
+  title: string
+  pipelineId: string
+  contactId?: string
+  pipelineStageId?: string
+  description?: string
+  organization?: string
+  organizationSegment?: string
+  originChannel?: string
+  originCampaign?: string
+  ownerId?: string
+}
+
+export type UpdateCardPayload = {
+  title?: string
+  description?: string | null
+  contactId?: string | null
+  pipelineStageId?: string | null
+  statusId?: string | null
+  reasonId?: string | null
+  ownerId?: string | null
+  organization?: string | null
+  organizationSegment?: string | null
+  originChannel?: string | null
+  originCampaign?: string | null
+  isArchived?: boolean
+  success?: boolean | null
+  finishedAt?: string | null
+}

package/src/apis/categories/CategoriesApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Category, CreateCategoryPayload, UpdateCategoryPayload } from './types'
+
+export class CategoriesApi extends BaseCrudApi<
+  Category,
+  CreateCategoryPayload,
+  UpdateCategoryPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/categories')
+  }
+}

package/src/apis/categories/index.ts

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

package/src/apis/categories/types.ts

@@ -0,0 +1,16 @@
+export type Category = {
+  id: string
+  title: string
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+}
+
+export type CreateCategoryPayload = {
+  title: string
+}
+
+export type UpdateCategoryPayload = {
+  title?: string
+}

package/src/apis/clientFeedback/ClientFeedbackApi.ts

@@ -0,0 +1,24 @@
+import type { ApiClient } from '../../core/ApiClient'
+import type { HasCreate } from '../../core/types'
+import type { ClientFeedback, CreateClientFeedbackPayload } from './types'
+
+export class ClientFeedbackApi implements HasCreate<ClientFeedback, CreateClientFeedbackPayload> {
+  private readonly client: ApiClient
+  private readonly basePath = '/client-feedback'
+
+  constructor(client: ApiClient) {
+    this.client = client
+  }
+
+  /** Creates a client feedback record for a ticket (accountId, ticketId, and feedback text are required). */
+  create(
+    body: CreateClientFeedbackPayload,
+    headers?: Record<string, string>,
+  ): Promise<ClientFeedback> {
+    return this.client.post<ClientFeedback, CreateClientFeedbackPayload>(
+      this.basePath,
+      body,
+      headers,
+    )
+  }
+}

package/src/apis/clientFeedback/index.ts

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

package/src/apis/clientFeedback/types.ts

@@ -0,0 +1,14 @@
+export type ClientFeedback = {
+  id: string
+  accountId: string
+  ticketId: string
+  feedback: string
+  createdAt: string
+  updatedAt: string
+}
+
+export type CreateClientFeedbackPayload = {
+  accountId: string
+  ticketId: string
+  feedback: string
+}

package/src/apis/contactBlockLists/ContactBlockListsApi.ts

@@ -0,0 +1,17 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type {
+  ContactBlockList,
+  CreateContactBlockListPayload,
+  UpdateContactBlockListPayload,
+} from './types'
+
+export class ContactBlockListsApi extends BaseCrudApi<
+  ContactBlockList,
+  CreateContactBlockListPayload,
+  UpdateContactBlockListPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/contact-block-lists')
+  }
+}

package/src/apis/contactBlockLists/index.ts

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

package/src/apis/contactBlockLists/types.ts

@@ -0,0 +1,34 @@
+import type { User } from '../users/types'
+
+export type ContactBlockListStatus = 'ready' | 'processing' | 'done' | 'error'
+
+export type ContactBlockList = {
+  id: string
+  name: string
+  status: ContactBlockListStatus
+  defaultDDI: string | null
+  saveCount: number | null
+  validCount: number | null
+  totalCount: number | null
+  userId: string
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  user?: User
+}
+
+export type ContactBlockListRelationships = 'user'
+
+export type CreateContactBlockListPayload = {
+  name: string
+  contacts: string[]
+  defaultDDI?: string
+}
+
+export type UpdateContactBlockListPayload = {
+  name?: string
+  contacts?: string[]
+  defaultDDI?: string | null
+}

package/src/apis/contactBlockListsControls/ContactBlockListsControlsApi.ts

@@ -0,0 +1,17 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type {
+  ContactBlockListsControl,
+  CreateContactBlockListsControlPayload,
+  UpdateContactBlockListsControlPayload,
+} from './types'
+
+export class ContactBlockListsControlsApi extends BaseCrudApi<
+  ContactBlockListsControl,
+  CreateContactBlockListsControlPayload,
+  UpdateContactBlockListsControlPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/contact-block-lists-controls')
+  }
+}

package/src/apis/contactBlockListsControls/index.ts

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

package/src/apis/contactBlockListsControls/types.ts

@@ -0,0 +1,45 @@
+import type { ContactBlockList } from '../contactBlockLists/types'
+import type { Service } from '../services/types'
+import type { User } from '../users/types'
+
+export type ContactBlockListsControlStatus = 'ready' | 'processing' | 'done' | 'error'
+
+export type ContactBlockListsControlAction = 'block' | 'unblock'
+
+export type ContactBlockListsControl = {
+  id: string
+  reason: string
+  status: ContactBlockListsControlStatus
+  action: ContactBlockListsControlAction
+  revertExceptions: boolean
+  updatedCount: number | null
+  processCount: number | null
+  totalCount: number | null
+  contactBlockListId: string
+  serviceId: string
+  userId: string
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  contactBlockList?: ContactBlockList
+  user?: User
+  service?: Service
+}
+
+export type ContactBlockListsControlRelationships = 'contactBlockList' | 'user' | 'service'
+
+export type CreateContactBlockListsControlPayload = {
+  reason: string
+  servicesIds: string[]
+  contactBlockListsIds: string[]
+  action: ContactBlockListsControlAction
+}
+
+export type UpdateContactBlockListsControlPayload = {
+  reason?: string
+  servicesIds?: string[]
+  contactBlockListsIds?: string[]
+  action?: ContactBlockListsControlAction
+}