@ikatec/digisac-api-sdk 1.2.0

package/src/apis/integrations/IntegrationsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Integration, CreateIntegrationPayload, UpdateIntegrationPayload } from './types'
+
+export class IntegrationsApi extends BaseCrudApi<
+  Integration,
+  CreateIntegrationPayload,
+  UpdateIntegrationPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/integrations')
+  }
+}

package/src/apis/integrations/index.ts

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

package/src/apis/integrations/types.ts

@@ -0,0 +1,27 @@
+export type Integration = {
+  id: string
+  type: string
+  url: string | null
+  icon: string | null
+  text: string | null
+  size: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+}
+
+export type CreateIntegrationPayload = {
+  type: string
+  url?: string
+  icon?: string
+  text?: string
+  size?: string
+}
+
+export type UpdateIntegrationPayload = {
+  type?: string
+  url?: string | null
+  icon?: string | null
+  text?: string | null
+  size?: string | null
+}

package/src/apis/interactiveMessages/InteractiveMessagesApi.ts

@@ -0,0 +1,17 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type {
+  InteractiveMessage,
+  CreateInteractiveMessagePayload,
+  UpdateInteractiveMessagePayload,
+} from './types'
+
+export class InteractiveMessagesApi extends BaseCrudApi<
+  InteractiveMessage,
+  CreateInteractiveMessagePayload,
+  UpdateInteractiveMessagePayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/interactive-messages')
+  }
+}

package/src/apis/interactiveMessages/index.ts

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

package/src/apis/interactiveMessages/types.ts

@@ -0,0 +1,134 @@
+import type { Department } from '../departments'
+import type { File } from '../files'
+
+// --- Shared types ---
+
+type InteractiveMessageButton = {
+  type: 'reply'
+  reply: { id: string; title: string }
+}
+
+type InteractiveMessageBodyFooter = string | { text: string }
+
+// --- Response types ---
+
+type InteractiveMedia = {
+  id?: string
+  link?: string
+  filename?: string
+}
+
+type InteractiveMessageRow = {
+  id: string
+  title: string
+  description?: string
+}
+
+type InteractiveMessageSection = {
+  title: string
+  rows: InteractiveMessageRow[]
+}
+
+type ListInteractiveMessageContent = {
+  type: 'list'
+  header?: {
+    type: 'text'
+    text?: string | { body: string }
+  }
+  body: InteractiveMessageBodyFooter
+  footer?: InteractiveMessageBodyFooter
+  action: {
+    /** Label for the list trigger button. */
+    button: string
+    sections: InteractiveMessageSection[]
+  }
+}
+
+type ButtonInteractiveMessageContent = {
+  type: 'button'
+  header?: {
+    type: 'text' | 'document' | 'image' | 'video'
+    text?: string | { body: string }
+    document?: InteractiveMedia
+    image?: InteractiveMedia
+    video?: InteractiveMedia
+  }
+  body: InteractiveMessageBodyFooter
+  footer?: InteractiveMessageBodyFooter
+  action: {
+    buttons: InteractiveMessageButton[]
+  }
+}
+
+export type InteractiveMessageContent =
+  | ListInteractiveMessageContent
+  | ButtonInteractiveMessageContent
+
+// --- Input types (create/update) ---
+
+type ListInteractiveMessageContentInput = {
+  type: 'list'
+  header?: {
+    type: 'text'
+    text?: string
+  }
+  body: InteractiveMessageBodyFooter
+  footer?: InteractiveMessageBodyFooter
+  action: {
+    button: string
+    sections: InteractiveMessageSection[]
+  }
+}
+
+type ButtonInteractiveMessageContentInput = {
+  type: 'button'
+  header?: { type: 'text'; text?: string } | { type: 'image' | 'document' | 'video' }
+  body: InteractiveMessageBodyFooter
+  footer?: InteractiveMessageBodyFooter
+  action: {
+    buttons: InteractiveMessageButton[]
+  }
+}
+
+type InteractiveMessageContentInput =
+  | ListInteractiveMessageContentInput
+  | ButtonInteractiveMessageContentInput
+
+type InteractiveMessageFilePayload =
+  | { id: string }
+  | { fileName: string; base64Url: string; mimetype: string }
+
+// --- Resource types ---
+
+export type InteractiveMessage = {
+  id: string
+  name: string
+  type: 'list' | 'button'
+  interactive: InteractiveMessageContent
+  archivedAt: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  file?: File | null
+  departments?: Department[]
+}
+
+export type InteractiveMessageRelationships = 'file' | 'departments'
+
+export type CreateInteractiveMessagePayload = {
+  name: string
+  interactive: InteractiveMessageContentInput
+  departmentIds?: string[]
+  departments?: { id: string }[]
+  file?: InteractiveMessageFilePayload
+}
+
+export type UpdateInteractiveMessagePayload = {
+  name?: string
+  interactive?: InteractiveMessageContentInput
+  departmentIds?: string[]
+  departments?: { id: string }[]
+  file?: InteractiveMessageFilePayload
+}

package/src/apis/kanbanBoards/KanbanBoardsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { KanbanBoard, CreateKanbanBoardPayload, UpdateKanbanBoardPayload } from './types'
+
+export class KanbanBoardsApi extends BaseCrudApi<
+  KanbanBoard,
+  CreateKanbanBoardPayload,
+  UpdateKanbanBoardPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/kanban-boards')
+  }
+}

package/src/apis/kanbanBoards/index.ts

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

package/src/apis/kanbanBoards/types.ts

@@ -0,0 +1,27 @@
+import type { Department } from '../departments/types'
+import type { KanbanColumn } from '../kanbanColumns/types'
+
+export type KanbanBoard = {
+  id: string
+  name: string
+  timeoutAlertEnabled: boolean
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  departments?: Department[]
+  columns?: KanbanColumn[]
+}
+
+export type KanbanBoardRelationships = 'departments' | 'columns'
+
+export type CreateKanbanBoardPayload = {
+  name: string
+  timeoutAlertEnabled?: boolean
+}
+
+export type UpdateKanbanBoardPayload = {
+  name?: string
+  timeoutAlertEnabled?: boolean
+}

package/src/apis/kanbanCards/KanbanCardsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { KanbanCard, CreateKanbanCardPayload, UpdateKanbanCardPayload } from './types'
+
+export class KanbanCardsApi extends BaseCrudApi<
+  KanbanCard,
+  CreateKanbanCardPayload,
+  UpdateKanbanCardPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/kanban-cards')
+  }
+}

package/src/apis/kanbanCards/index.ts

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

package/src/apis/kanbanCards/types.ts

@@ -0,0 +1,33 @@
+import type { KanbanColumn } from '../kanbanColumns/types'
+import type { Ticket } from '../tickets/types'
+
+export type KanbanCard = {
+  id: string
+  ticketSubject: string | null
+  position: string
+  columnId: string
+  ticketId: string
+  accountId: string
+  lastModifiedById: string | null
+  lastColumnChangeAt: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  column?: KanbanColumn
+  ticket?: Ticket
+}
+
+export type KanbanCardRelationships = 'column' | 'ticket'
+
+export type CreateKanbanCardPayload = {
+  columnId: string
+  ticketId: string
+  position?: string
+}
+
+export type UpdateKanbanCardPayload = {
+  columnId?: string
+  position?: string
+  ticketSubject?: string | null
+}

package/src/apis/kanbanColumns/KanbanColumnsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { KanbanColumn, CreateKanbanColumnPayload, UpdateKanbanColumnPayload } from './types'
+
+export class KanbanColumnsApi extends BaseCrudApi<
+  KanbanColumn,
+  CreateKanbanColumnPayload,
+  UpdateKanbanColumnPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/kanban-columns')
+  }
+}

package/src/apis/kanbanColumns/index.ts

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

package/src/apis/kanbanColumns/types.ts

@@ -0,0 +1,40 @@
+import type { KanbanBoard } from '../kanbanBoards/types'
+import type { KanbanCard } from '../kanbanCards/types'
+
+export type KanbanColumnRole = 'initial' | 'regular' | 'final'
+
+export type KanbanColumn = {
+  id: string
+  name: string
+  role: KanbanColumnRole
+  position: string
+  ticketWaitTimeMinutes: number | null
+  isDraggable: boolean
+  kanbanBoardId: string
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  kanbanBoard?: KanbanBoard
+  cards?: KanbanCard[]
+}
+
+export type KanbanColumnRelationships = 'kanbanBoard' | 'cards'
+
+export type CreateKanbanColumnPayload = {
+  name: string
+  kanbanBoardId: string
+  role?: KanbanColumnRole
+  position?: string
+  ticketWaitTimeMinutes?: number
+  isDraggable?: boolean
+}
+
+export type UpdateKanbanColumnPayload = {
+  name?: string
+  role?: KanbanColumnRole
+  position?: string
+  ticketWaitTimeMinutes?: number | null
+  isDraggable?: boolean
+}

package/src/apis/knowledgeBase/KnowledgeBaseApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { KnowledgeBase, CreateKnowledgeBasePayload, UpdateKnowledgeBasePayload } from './types'
+
+export class KnowledgeBaseApi extends BaseCrudApi<
+  KnowledgeBase,
+  CreateKnowledgeBasePayload,
+  UpdateKnowledgeBasePayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/knowledge-base')
+  }
+}

package/src/apis/knowledgeBase/index.ts

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

package/src/apis/knowledgeBase/types.ts

@@ -0,0 +1,25 @@
+import type { KnowledgeBaseItem } from '../knowledgeBaseItem/types'
+
+export type KnowledgeBase = {
+  id: string
+  name: string
+  description: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  items?: KnowledgeBaseItem[]
+}
+
+export type KnowledgeBaseRelationships = 'items'
+
+export type CreateKnowledgeBasePayload = {
+  name: string
+  description?: string
+}
+
+export type UpdateKnowledgeBasePayload = {
+  name?: string
+  description?: string | null
+}

package/src/apis/knowledgeBaseItem/KnowledgeBaseItemApi.ts

@@ -0,0 +1,17 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type {
+  KnowledgeBaseItem,
+  CreateKnowledgeBaseItemPayload,
+  UpdateKnowledgeBaseItemPayload,
+} from './types'
+
+export class KnowledgeBaseItemApi extends BaseCrudApi<
+  KnowledgeBaseItem,
+  CreateKnowledgeBaseItemPayload,
+  UpdateKnowledgeBaseItemPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/knowledge-base-item')
+  }
+}

package/src/apis/knowledgeBaseItem/index.ts

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

package/src/apis/knowledgeBaseItem/types.ts

@@ -0,0 +1,38 @@
+import type { File } from '../files/types'
+import type { KnowledgeBase } from '../knowledgeBase/types'
+
+export type KnowledgeBaseItem = {
+  id: string
+  name: string
+  type: string
+  sourceId: string | null
+  url: string | null
+  accountId: string
+  knowledgeBaseId: string
+  fileId: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  knowledgeBase?: KnowledgeBase
+  file?: File | null
+}
+
+export type KnowledgeBaseItemRelationships = 'knowledgeBase' | 'file'
+
+export type CreateKnowledgeBaseItemPayload = {
+  name: string
+  type: string
+  knowledgeBaseId: string
+  sourceId?: string
+  url?: string
+  fileId?: string
+}
+
+export type UpdateKnowledgeBaseItemPayload = {
+  name?: string
+  type?: string
+  sourceId?: string | null
+  url?: string | null
+  fileId?: string | null
+}

package/src/apis/me/MeApi.ts

@@ -0,0 +1,121 @@
+import type { ApiClient } from '../../core/ApiClient'
+import type { Account } from '../accounts/types'
+import type { User } from '../users/types'
+import type {
+  RegisterTokenPayload,
+  SetOtpSecretKeyPayload,
+  TakeoverPayload,
+  UpdateMeAccountPayload,
+  UpdateMePayload,
+  UpdateMeStatusPayload,
+} from './types'
+
+export class MeApi {
+  protected readonly client: ApiClient
+
+  constructor(client: ApiClient) {
+    this.client = client
+  }
+
+  /**
+   * Returns the currently authenticated user, including their roles, departments, and timetable.
+   * @permissions users.view
+   */
+  getMe(headers?: Record<string, string>): Promise<User> {
+    return this.client.get<User>('/me', headers)
+  }
+
+  /** Returns the account associated with the currently authenticated user. */
+  getAccount(headers?: Record<string, string>): Promise<Account> {
+    return this.client.get<Account>('/me/account', headers)
+  }
+
+  /**
+   * Returns credit and usage amounts for the current account.
+   * Excludes Digisac's own internal credit amounts.
+   */
+  getAccountAmounts(headers?: Record<string, string>): Promise<Record<string, unknown>> {
+    return this.client.get<Record<string, unknown>>('/me/get-account-amounts', headers)
+  }
+
+  /**
+   * Returns a URL to the Agnus billing/plan management page for the current account.
+   * @permissions myAccount.myPlan
+   */
+  getAgnusMyPlanUrl(headers?: Record<string, string>): Promise<{ url: string }> {
+    return this.client.get<{ url: string }>('/me/account/agnus-my-plan-url', headers)
+  }
+
+  /**
+   * Updates the current user's profile fields such as name, language, and preferences.
+   * If a new password is provided, it is validated against the last 6 password history entries
+   * and all existing access tokens for the user are revoked.
+   */
+  updateMe(body: UpdateMePayload, headers?: Record<string, string>): Promise<User> {
+    return this.client.put<User, UpdateMePayload>('/me', body, headers)
+  }
+
+  /** Updates account-level settings such as name, settings object, wizard progress, and default department. */
+  updateAccount(body: UpdateMeAccountPayload, headers?: Record<string, string>): Promise<Account> {
+    return this.client.put<Account, UpdateMeAccountPayload>('/me/account', body, headers)
+  }
+
+  /**
+   * Updates the presence status of the current user (`online`, `offline`, or `away`).
+   * If setting to `online`, validates the user's timetable first — if outside working hours,
+   * the status is set to `offline` instead.
+   */
+  updateStatus(body: UpdateMeStatusPayload, headers?: Record<string, string>): Promise<User> {
+    return this.client.put<User, UpdateMeStatusPayload>('/me/status', body, headers)
+  }
+
+  /**
+   * Extends the grace period for the current account when it has expired or is about to expire.
+   * Returns the updated account.
+   */
+  extendAccountGracePeriod(headers?: Record<string, string>): Promise<Account> {
+    return this.client.post<Account>('/me/account/extend-grace-period', undefined, headers)
+  }
+
+  /**
+   * Registers a OneSignal push notification token for the current user.
+   * Used to enable push notifications on mobile/web clients.
+   */
+  registerToken(body: RegisterTokenPayload, headers?: Record<string, string>): Promise<void> {
+    return this.client.post<void, RegisterTokenPayload>(
+      '/me/one-signal/register-token',
+      body,
+      headers,
+    )
+  }
+
+  /** Marks the current user's first login as complete by setting `isFirstLogin` to `false`. */
+  reportFirstLogin(headers?: Record<string, string>): Promise<User> {
+    return this.client.post<User>('/me/report-login', undefined, headers)
+  }
+
+  /**
+   * Sets the current user's status to `online` for the given client and emits a takeover event,
+   * which signals other connected sessions to yield control to this one.
+   */
+  takeover(body?: TakeoverPayload, headers?: Record<string, string>): Promise<void> {
+    return this.client.post<void, TakeoverPayload>('/me/takeover', body, headers)
+  }
+
+  /**
+   * Stores a 16-character OTP secret key on the current user.
+   * This must be called before activating OTP authentication via `activateOtpAuth`.
+   */
+  setOtpSecretKey(body: SetOtpSecretKeyPayload, headers?: Record<string, string>): Promise<void> {
+    return this.client.patch<void, SetOtpSecretKeyPayload>('/me/set-otp-secret-key', body, headers)
+  }
+
+  /**
+   * Activates OTP (two-factor) authentication for the current user.
+   * Requires the `x-digisac-otp` header with a valid TOTP token generated from the secret key
+   * previously set via `setOtpSecretKey`.
+   */
+  activateOtpAuth(headers?: Record<string, string>): Promise<boolean> {
+    return this.client.post<boolean>('/me/activate-otp-auth', undefined, headers)
+  }
+}

package/src/apis/me/index.ts

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

package/src/apis/me/types.ts

@@ -0,0 +1,35 @@
+import type { AccountSettings } from '../accounts/types'
+import type { UserPreferences } from '../users/types'
+import type { UserStatus } from '../users/types'
+
+export type UpdateMePayload = {
+  name?: string
+  password?: string
+  language?: string
+  preferences?: UserPreferences
+  otpAuthActive?: boolean
+  logoutFromApp?: boolean
+  data?: Record<string, unknown>
+}
+
+export type UpdateMeStatusPayload = {
+  status: UserStatus
+  client?: string
+}
+
+export type UpdateMeAccountPayload = {
+  name?: string
+  settings?: Partial<AccountSettings>
+  wizardProgress?: string
+  defaultDepartmentId?: string
+}
+
+export type TakeoverPayload = {
+  client?: string
+}
+
+export type SetOtpSecretKeyPayload = {
+  secretKey: string
+}
+
+export type RegisterTokenPayload = Record<string, unknown>