@ikatec/digisac-api-sdk 1.2.0

package/src/apis/permissions/types.ts

@@ -0,0 +1,232 @@
+export type PermissionType =
+  | 'chat'
+  | 'miscellaneous'
+  | 'users'
+  | 'roles'
+  | 'services'
+  | 'campaigns'
+  | 'tags'
+  | 'tickets'
+  | 'departments'
+  | 'bots'
+  | 'contacts'
+  | 'quickReplies'
+  | 'pipelines'
+  | 'automation'
+  | 'evaluation'
+  | 'holidays'
+  | 'myAccount'
+  | 'settingsApi'
+  | 'authHistory'
+  | 'overview'
+  | 'messages'
+  | 'ticketTopics'
+  | 'distribution'
+  | 'people'
+  | 'acceptanceTerms'
+  | 'organizations'
+  | 'hsm'
+  | 'interactive-messages'
+  | 'integrations'
+  | 'customFields'
+  | 'schedule'
+  | 'notification'
+  | 'timetables'
+  | 'stickers'
+  | 'groups'
+  | 'download'
+  | 'aIConsumption'
+  | 'knowledgeBase'
+  | 'kanban'
+
+export type PermissionName =
+  | 'chat'
+  | 'chat.view.contacts'
+  | 'ignore-ip-restriction'
+  | 'users.view'
+  | 'users.create'
+  | 'users.update'
+  | 'users.archive'
+  | 'roles.view'
+  | 'roles.create'
+  | 'roles.update'
+  | 'roles.destroy'
+  | 'services.view'
+  | 'services.create'
+  | 'services.update'
+  | 'services.destroy'
+  | 'services.operate'
+  | 'services.disabled'
+  | 'campaigns.view'
+  | 'campaigns.create'
+  | 'campaigns.update'
+  | 'campaigns.destroy'
+  | 'campaigns.autoPause'
+  | 'tags.view'
+  | 'tags.create'
+  | 'tags.update'
+  | 'tags.destroy'
+  | 'tickets.transfer.all'
+  | 'tickets.transfer.me'
+  | 'tickets.transfer.departments'
+  | 'tickets.close.all'
+  | 'tickets.close.me'
+  | 'tickets.update'
+  | 'tickets.open'
+  | 'tickets.view.all.departments'
+  | 'tickets.view.all'
+  | 'tickets.transfer.all.bulk'
+  | 'tickets.comment'
+  | 'departments.view'
+  | 'departments.create'
+  | 'departments.update'
+  | 'departments.archive'
+  | 'bots.view'
+  | 'bots.create'
+  | 'bots.update'
+  | 'bots.destroy'
+  | 'contacts.view.number'
+  | 'contacts.view'
+  | 'contacts.create'
+  | 'contacts.update'
+  | 'contacts.destroy'
+  | 'contacts.export'
+  | 'contacts.pin'
+  | 'contacts.block'
+  | 'quickReplies.view'
+  | 'quickReplies.create'
+  | 'quickReplies.update'
+  | 'quickReplies.destroy'
+  | 'pipelines.view'
+  | 'pipelines.create'
+  | 'pipelines.update'
+  | 'pipelines.destroy'
+  | 'pipelines.opportunity.view'
+  | 'pipelines.opportunity.create'
+  | 'pipelines.opportunity.update'
+  | 'pipelines.opportunity.destroy'
+  | 'automation.view'
+  | 'automation.management'
+  | 'evaluation.view'
+  | 'evaluation.create'
+  | 'evaluation.update'
+  | 'evaluation.destroy'
+  | 'holidays.view'
+  | 'holidays.create'
+  | 'holidays.update'
+  | 'holidays.destroy'
+  | 'myAccount.view'
+  | 'myAccount.update'
+  | 'myAccount.myPlan'
+  | 'myAccount.absence'
+  | 'settingsApi.update'
+  | 'authHistory.view'
+  | 'overview.now.view'
+  | 'overview.history.view'
+  | 'overview.hsm.statistic.view'
+  | 'overview.evaluation.view'
+  | 'overview.absence.view'
+  | 'messages.destroy'
+  | 'messages.view.out.queue'
+  | 'messages.view.all'
+  | 'messages.view.ticket.mine'
+  | 'messages.view.ticket.department'
+  | 'messages.view.transfer.mine'
+  | 'messages.view.transfer.department'
+  | 'messages.view.ticket.mine.current'
+  | 'messages.view.ticket.department.current'
+  | 'ticketTopics.view'
+  | 'ticketTopics.create'
+  | 'ticketTopics.update'
+  | 'ticketTopics.destroy'
+  | 'ticketTopics.archive'
+  | 'distribution.view'
+  | 'distribution.create'
+  | 'distribution.update'
+  | 'distribution.destroy'
+  | 'people.view'
+  | 'people.create'
+  | 'people.update'
+  | 'people.destroy'
+  | 'acceptanceTerms.view'
+  | 'acceptanceTerms.create'
+  | 'acceptanceTerms.update'
+  | 'acceptanceTerms.destroy'
+  | 'organizations.view'
+  | 'organizations.create'
+  | 'organizations.update'
+  | 'organizations.destroy'
+  | 'hsm.view'
+  | 'hsm.create'
+  | 'hsm.update'
+  | 'hsm.destroy'
+  | 'hsm.send.before.expire'
+  | 'hsm.send'
+  | 'interactive-messages.view'
+  | 'interactive-messages.create'
+  | 'interactive-messages.management.all.departments'
+  | 'interactive-messages.update'
+  | 'interactive-messages.destroy'
+  | 'interactive-messages.send'
+  | 'integrations.view'
+  | 'integrations.create'
+  | 'integrations.update'
+  | 'integrations.destroy'
+  | 'customFields.view'
+  | 'customFields.create'
+  | 'customFields.update'
+  | 'customFields.destroy'
+  | 'schedule.view'
+  | 'schedule.create'
+  | 'schedule.update'
+  | 'schedule.destroy'
+  | 'schedule.create.all'
+  | 'notification.view.all'
+  | 'timetables.view'
+  | 'timetables.create'
+  | 'timetables.update'
+  | 'timetables.destroy'
+  | 'stickers.management'
+  | 'stickers.send'
+  | 'groups.create'
+  | 'groups.view'
+  | 'groups.update'
+  | 'groups.add.members'
+  | 'groups.remove.members'
+  | 'groups.promote.admin'
+  | 'groups.demote.admin'
+  | 'groups.leave'
+  | 'download.image'
+  | 'download.audio'
+  | 'download.video'
+  | 'aIConsumption.view'
+  | 'knowledgeBase.view'
+  | 'knowledgeBase.create'
+  | 'knowledgeBase.update'
+  | 'knowledgeBase.destroy'
+  | 'kanban.view'
+  | 'kanban.create'
+  | 'kanban.update'
+  | 'kanban.destroy'
+
+export type Permission = {
+  id: string
+  name: PermissionName
+  type: PermissionType | null
+  description: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+}
+
+export type CreatePermissionPayload = {
+  name: PermissionName
+  type?: PermissionType
+  description?: string
+}
+
+export type UpdatePermissionPayload = {
+  name?: PermissionName
+  type?: PermissionType | null
+  description?: string | null
+}

package/src/apis/personalAccessTokens/PersonalAccessTokensApi.ts

@@ -0,0 +1,17 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type {
+  PersonalAccessToken,
+  CreatePersonalAccessTokenPayload,
+  UpdatePersonalAccessTokenPayload,
+} from './types'
+
+export class PersonalAccessTokensApi extends BaseCrudApi<
+  PersonalAccessToken,
+  CreatePersonalAccessTokenPayload,
+  UpdatePersonalAccessTokenPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/me/tokens')
+  }
+}

package/src/apis/personalAccessTokens/index.ts

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

package/src/apis/personalAccessTokens/types.ts

@@ -0,0 +1,28 @@
+import type { User } from '../users/types'
+
+export type PersonalAccessToken = {
+  id: string
+  name: string
+  scope: string | null
+  accessToken: string
+  accessTokenExpiresAt: string | null
+  userId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  user?: User
+}
+
+export type PersonalAccessTokenRelationships = 'user'
+
+export type CreatePersonalAccessTokenPayload = {
+  name: string
+  scope?: string
+  accessTokenExpiresAt?: string
+}
+
+export type UpdatePersonalAccessTokenPayload = {
+  name?: string
+  scope?: string | null
+}

package/src/apis/pipeline/PipelineApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Pipeline, CreatePipelinePayload, UpdatePipelinePayload } from './types'
+
+export class PipelineApi extends BaseCrudApi<
+  Pipeline,
+  CreatePipelinePayload,
+  UpdatePipelinePayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/pipelines')
+  }
+}

package/src/apis/pipeline/index.ts

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

package/src/apis/pipeline/types.ts

@@ -0,0 +1,29 @@
+import type { Department } from '../departments/types'
+
+export type Pipeline = {
+  id: string
+  name: string
+  goBack: boolean
+  accountId: string
+  permissionToViewCard: boolean | null
+  archivedAt: string | null
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  departments?: Department[]
+}
+
+export type PipelineRelationships = 'departments'
+
+export type CreatePipelinePayload = {
+  name: string
+  goBack?: boolean
+  permissionToViewCard?: boolean
+}
+
+export type UpdatePipelinePayload = {
+  name?: string
+  goBack?: boolean
+  permissionToViewCard?: boolean | null
+}

package/src/apis/planAiHistory/PlanAiHistoryApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { PlanAiHistory, CreatePlanAiHistoryPayload, UpdatePlanAiHistoryPayload } from './types'
+
+export class PlanAiHistoryApi extends BaseCrudApi<
+  PlanAiHistory,
+  CreatePlanAiHistoryPayload,
+  UpdatePlanAiHistoryPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/plan-ai-history')
+  }
+}

package/src/apis/planAiHistory/index.ts

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

package/src/apis/planAiHistory/types.ts

@@ -0,0 +1,38 @@
+export type PlanAiActivityType = 'change' | 'renewal' | 'addition'
+
+export type PlanAiHistory = {
+  id: string
+  accountId: string
+  activity: PlanAiActivityType
+  name: string
+  magicText: boolean
+  summary: boolean
+  transcription: boolean
+  copilot: boolean
+  csat: boolean
+  agent: boolean
+  createdAt: string
+  updatedAt: string
+}
+
+export type CreatePlanAiHistoryPayload = {
+  activity: PlanAiActivityType
+  name: string
+  magicText?: boolean
+  summary?: boolean
+  transcription?: boolean
+  copilot?: boolean
+  csat?: boolean
+  agent?: boolean
+}
+
+export type UpdatePlanAiHistoryPayload = {
+  activity?: PlanAiActivityType
+  name?: string
+  magicText?: boolean
+  summary?: boolean
+  transcription?: boolean
+  copilot?: boolean
+  csat?: boolean
+  agent?: boolean
+}

package/src/apis/questions/QuestionsApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Question, CreateQuestionPayload, UpdateQuestionPayload } from './types'
+
+export class QuestionsApi extends BaseCrudApi<
+  Question,
+  CreateQuestionPayload,
+  UpdateQuestionPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/questions')
+  }
+}

package/src/apis/questions/index.ts

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

package/src/apis/questions/types.ts

@@ -0,0 +1,45 @@
+import type { Answer } from '../answers/types'
+
+export type QuestionType = 'nps' | 'csat' | 'custom'
+
+export type Question = {
+  id: string
+  name: string
+  type: QuestionType
+  questionMessage: string
+  duration: number
+  tries: number
+  successMessage: string
+  invalidMessage: string
+  reasonMessage: string | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  answers?: Answer[]
+}
+
+export type QuestionRelationships = 'answers'
+
+export type CreateQuestionPayload = {
+  name: string
+  type: QuestionType
+  questionMessage: string
+  duration: number
+  tries: number
+  successMessage: string
+  invalidMessage: string
+  reasonMessage?: string
+}
+
+export type UpdateQuestionPayload = {
+  name?: string
+  type?: QuestionType
+  questionMessage?: string
+  duration?: number
+  tries?: number
+  successMessage?: string
+  invalidMessage?: string
+  reasonMessage?: string | null
+}

package/src/apis/quickReplies/QuickRepliesApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { QuickReply, CreateQuickReplyPayload, UpdateQuickReplyPayload } from './types'
+
+export class QuickRepliesApi extends BaseCrudApi<
+  QuickReply,
+  CreateQuickReplyPayload,
+  UpdateQuickReplyPayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/quick-replies')
+  }
+}

package/src/apis/quickReplies/index.ts

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

package/src/apis/quickReplies/types.ts

@@ -0,0 +1,29 @@
+import type { Category } from '../categories/types'
+import type { Department } from '../departments/types'
+import type { File } from '../files/types'
+
+export type QuickReply = {
+  id: string
+  title: string
+  text: string
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  departments?: Department[]
+  categories?: Category[]
+  files?: File[]
+}
+
+export type QuickReplyRelationships = 'departments' | 'categories' | 'files'
+
+export type CreateQuickReplyPayload = {
+  title: string
+  text: string
+}
+
+export type UpdateQuickReplyPayload = {
+  title?: string
+  text?: string
+}

package/src/apis/roles/RolesApi.ts

@@ -0,0 +1,9 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Role, CreateRolePayload, UpdateRolePayload } from './types'
+
+export class RolesApi extends BaseCrudApi<Role, CreateRolePayload, UpdateRolePayload> {
+  constructor(client: ApiClient) {
+    super(client, '/roles')
+  }
+}

package/src/apis/roles/index.ts

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

package/src/apis/roles/types.ts

@@ -0,0 +1,27 @@
+import type { Permission } from '../permissions/types'
+
+export type Role = {
+  id: string
+  displayName: string
+  isAdmin: boolean | null
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  permissions?: Permission[]
+}
+
+export type RoleRelationships = 'permissions'
+
+export type CreateRolePayload = {
+  displayName: string
+  isAdmin?: boolean
+  permissionIds?: string[]
+}
+
+export type UpdateRolePayload = {
+  displayName?: string
+  isAdmin?: boolean | null
+  permissionIds?: string[]
+}

package/src/apis/schedule/ScheduleApi.ts

@@ -0,0 +1,13 @@
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { Schedule, CreateSchedulePayload, UpdateSchedulePayload } from './types'
+
+export class ScheduleApi extends BaseCrudApi<
+  Schedule,
+  CreateSchedulePayload,
+  UpdateSchedulePayload
+> {
+  constructor(client: ApiClient) {
+    super(client, '/schedule')
+  }
+}

package/src/apis/schedule/index.ts

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

package/src/apis/schedule/types.ts

@@ -0,0 +1,58 @@
+import type { Contact } from '../contacts/types'
+import type { Department } from '../departments/types'
+import type { User } from '../users/types'
+
+export type Schedule = {
+  id: string
+  status: string
+  reason: string | null
+  message: string
+  notes: string
+  openTicket: boolean
+  notificateUser: boolean
+  extraOptions: Record<string, unknown> | null
+  hsmId: string | null
+  hsmFileId: string | null
+  scheduledAt: string
+  contactId: string
+  userId: string | null
+  departmentId: string
+  accountId: string
+  createdAt: string
+  updatedAt: string
+  deletedAt: string | null
+  // relationships
+  contact?: Contact
+  department?: Department
+  user?: User | null
+}
+
+export type ScheduleRelationships = 'contact' | 'department' | 'user'
+
+export type CreateSchedulePayload = {
+  scheduledAt: string
+  contactId: string
+  departmentId: string
+  message: string
+  notes: string
+  openTicket: boolean
+  notificateUser?: boolean
+  userId?: string
+  hsmId?: string
+  hsmFileId?: string
+  extraOptions?: Record<string, unknown>
+}
+
+export type UpdateSchedulePayload = {
+  scheduledAt?: string
+  contactId?: string
+  departmentId?: string
+  userId?: string | null
+  message?: string
+  notes?: string
+  openTicket?: boolean
+  notificateUser?: boolean
+  hsmId?: string | null
+  hsmFileId?: string | null
+  extraOptions?: Record<string, unknown> | null
+}

package/src/apis/serviceAccessManagement/ServiceAccessManagementApi.ts

@@ -0,0 +1,32 @@
+import qs from 'qs'
+import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery, Paginated, HasGetMany } from '../../core/types'
+import type { ServiceAccessManagement } from './types'
+
+export class ServiceAccessManagementApi implements HasGetMany<ServiceAccessManagement> {
+  private readonly client: ApiClient
+
+  constructor(client: ApiClient) {
+    this.client = client
+  }
+
+  /** Returns a paginated list of which users have access to which services. */
+  getMany(
+    query: ListQuery<ServiceAccessManagement> & { paginate: false },
+    headers?: Record<string, string>,
+  ): Promise<ServiceAccessManagement[]>
+  getMany(
+    query?: ListQuery<ServiceAccessManagement> & { paginate?: true },
+    headers?: Record<string, string>,
+  ): Promise<Paginated<ServiceAccessManagement>>
+  getMany(
+    query?: ListQuery<ServiceAccessManagement>,
+    headers?: Record<string, string>,
+  ): Promise<Paginated<ServiceAccessManagement> | ServiceAccessManagement[]> {
+    const queryString = query ? `?${qs.stringify(query)}` : ''
+    return this.client.get<Paginated<ServiceAccessManagement> | ServiceAccessManagement[]>(
+      `/service-access-management${queryString}`,
+      headers,
+    )
+  }
+}

package/src/apis/serviceAccessManagement/index.ts

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

package/src/apis/serviceAccessManagement/types.ts

@@ -0,0 +1,13 @@
+import type { Service } from '../services/types'
+import type { User } from '../users/types'
+
+export type ServiceAccessManagement = {
+  userId: string
+  serviceId: string
+  createdAt: string
+  // relationships
+  user?: User
+  service?: Service
+}
+
+export type ServiceAccessManagementRelationships = 'user' | 'service'