@ikatec/digisac-api-sdk 4.5.0 → 4.6.0

package/src/apis/tickets/types.ts

@@ -1,5 +1,6 @@
 import type { Contact } from '../contacts/types'
 import type { Department } from '../departments/types'
+import type { Message } from '../messages/types'
 import type { Service } from '../services/types'
 import type { User } from '../users/types'
 
@@ -23,6 +24,43 @@ export type TicketMetrics = {
   isActiveTicket?: boolean
 }
 
+export type TicketTransferAction = 'opened' | 'transferred' | 'closed'
+
+/**
+ * A step of the history of a ticket (opening, transfer, closing), as the `ticketTransfers` include of
+ * `GET /tickets/{id}` answers it. `byUserId` is who performed the step (null when there is no user, e.g. a bot).
+ *
+ * Inside `ticketTransfers`, the route whitelist only accepts `byUser`, `fromUser`, `toUser`, `fromDepartment` and
+ * `toDepartment`: `transferredMessage`, `firstMessage` and `lastMessage` are dropped in silence and come as `null`.
+ */
+export type TicketTransfer = {
+  id: string
+  action: TicketTransferAction | null
+  comments: string | null
+  fromDistribution: boolean
+  accountId: string
+  ticketId: string
+  byUserId: string | null
+  fromUserId: string | null
+  toUserId: string | null
+  fromDepartmentId: string | null
+  toDepartmentId: string | null
+  transferredMessageId: string | null
+  firstMessageId: string | null
+  lastMessageId: string | null
+  createdAt: string
+  updatedAt: string
+  // relationships
+  byUser?: User | null
+  fromUser?: User | null
+  toUser?: User | null
+  fromDepartment?: Department | null
+  toDepartment?: Department | null
+  transferredMessage?: Message | null
+  firstMessage?: Message | null
+  lastMessage?: Message | null
+}
+
 export type Ticket = {
   id: string
   isOpen: boolean
@@ -49,9 +87,10 @@ export type Ticket = {
   department?: Department
   user?: User | null
   service?: Service | null
+  ticketTransfers?: TicketTransfer[]
 }
 
-export type TicketRelationships = 'contact' | 'department' | 'user' | 'service'
+export type TicketRelationships = 'contact' | 'department' | 'user' | 'service' | 'ticketTransfers'
 
 export type CreateTicketPayload = {
   contactId: string

package/src/core/BaseCrudApi.ts

@@ -14,15 +14,19 @@ export type {
   CrudApi,
 } from './types'
 
-/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */
+/**
+ * Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`.
+ * `TDeleteResponse` is what `deleteById` resolves to (most routes answer the text `'OK'`).
+ */
 export class BaseCrudApi<
   TResponse,
   TCreate,
   TUpdate = TCreate,
   TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,
+  TDeleteResponse = TResponse,
 >
   extends BaseReadApi<TResponse, TQuery>
-  implements CrudApi<TResponse, TCreate, TUpdate, TQuery>
+  implements CrudApi<TResponse, TCreate, TUpdate, TQuery, TDeleteResponse>
 {
   /**
    * Creates a new resource.
@@ -42,9 +46,9 @@ export class BaseCrudApi<
 
   /**
    * Deletes a resource by ID.
-   * @permissions $resourceName.delete
+   * @permissions $resourceName.destroy
    */
-  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {
-    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)
+  deleteById(id: string, headers?: Record<string, string>): Promise<TDeleteResponse> {
+    return this.client.delete<TDeleteResponse>(`${this.basePath}/${id}`, headers)
   }
 }

package/src/core/types.ts

@@ -159,8 +159,9 @@ export type CrudApi<
   TCreate,
   TUpdate = TCreate,
   TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,
+  TDeleteResponse = TResponse,
 > = HasGetMany<TResponse, TQuery> &
   HasGetById<TResponse> &
   HasCreate<TResponse, TCreate> &
   HasUpdateById<TResponse, TUpdate> &
-  HasDeleteById<TResponse>
+  HasDeleteById<TDeleteResponse>

package/src/incommingWebhooks/index.test-d.ts

@@ -2,6 +2,7 @@ import { expectAssignable, expectNotAssignable, expectType } from 'tsd'
 import type { WebhookPayload, WebhookEvent, WebhookEventPayloadMap, BotCommandData } from './index'
 import type { Message, MessageRelationships } from '../apis/messages'
 import type { Ticket, TicketRelationships } from '../apis/tickets'
+import type { BotApiSignalData, BotContexts } from '../apis/bots'
 
 // ── WebhookPayload (generic) ─────────────────────────────────────────────────
 
@@ -37,6 +38,14 @@ declare const botPayload: WebhookPayload<'bot.command'>
 expectType<BotCommandData>(botPayload.data)
 expectAssignable<{ id: string; command: string }>(botPayload.data)
 
+// ── bot.* deliver the stored bot, with the contexts in the map form ──────────
+
+declare const botCreated: WebhookPayload<'bot.created'>
+expectType<BotContexts>(botCreated.data.contexts)
+
+declare const apiSignal: WebhookPayload<'bot.api-signal'>
+expectType<BotApiSignalData>(apiSignal.data)
+
 // ── invalid events are rejected ──────────────────────────────────────────────
 
 expectNotAssignable<WebhookEvent>('message.deleted')

package/src/incommingWebhooks/index.ts

@@ -1,4 +1,4 @@
-import type { Bot, BotRelationships } from '../apis/bots'
+import type { BotApiSignalData, BotRecord } from '../apis/bots'
 import type { Campaign, CampaignRelationships } from '../apis/campaigns'
 import type { Contact, ContactRelationships } from '../apis/contacts'
 import type { Department, DepartmentRelationships } from '../apis/departments'
@@ -103,13 +103,13 @@ export interface WebhookEventPayloadMap {
   'role.created': Omit<Role, RoleRelationships>
   'role.updated': Omit<Role, RoleRelationships>
   'role.destroyed': Omit<Role, RoleRelationships>
-  'bot.created': Omit<Bot, BotRelationships>
-  'bot.updated': Omit<Bot, BotRelationships>
-  'bot.destroyed': Omit<Bot, BotRelationships>
+  'bot.created': BotRecord
+  'bot.updated': BotRecord
+  'bot.destroyed': BotRecord
   'bot.command': BotCommandData
-  'bot.enter-context': Omit<Bot, BotRelationships>
-  'bot.leave-context': Omit<Bot, BotRelationships>
-  'bot.api-signal': Omit<Bot, BotRelationships>
+  'bot.enter-context': BotRecord
+  'bot.leave-context': BotRecord
+  'bot.api-signal': BotApiSignalData
   'quickReplies.created': Omit<QuickReply, QuickReplyRelationships>
   'quickReplies.updated': Omit<QuickReply, QuickReplyRelationships>
   'quickReplies.destroyed': Omit<QuickReply, QuickReplyRelationships>