@ikatec/digisac-api-sdk 4.5.0 → 4.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  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';
2
- 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.all' | 'overview.now.view.departments' | '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';
2
+ export type PermissionName = 'chat' | 'chat.view.contacts' | 'ignore-ip-restriction' | 'users.view' | 'users.create' | 'users.update' | 'users.archive' | 'users.export' | '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.all' | 'overview.now.view.departments' | '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.boards.view' | 'kanban.boards.create' | 'kanban.boards.update' | 'kanban.boards.destroy' | 'kanban.columns.create' | 'kanban.columns.update' | 'kanban.columns.destroy' | 'kanban.cards.move';
3
3
  /**
4
4
  * A permission, as `GET /permissions` answers it (the transformer only picks these fields).
5
5
  * Permissions are a fixed catalog: the API is read-only.
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,eAAe,GACf,OAAO,GACP,OAAO,GACP,UAAU,GACV,WAAW,GACX,MAAM,GACN,SAAS,GACT,aAAa,GACb,MAAM,GACN,UAAU,GACV,cAAc,GACd,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,WAAW,GACX,aAAa,GACb,aAAa,GACb,UAAU,GACV,UAAU,GACV,cAAc,GACd,cAAc,GACd,QAAQ,GACR,iBAAiB,GACjB,eAAe,GACf,KAAK,GACL,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,UAAU,GACV,cAAc,GACd,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,UAAU,GACV,eAAe,GACf,eAAe,GACf,QAAQ,CAAA;AAEZ,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,oBAAoB,GACpB,uBAAuB,GACvB,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,qBAAqB,GACrB,8BAA8B,GAC9B,mBAAmB,GACnB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,8BAA8B,GAC9B,kBAAkB,GAClB,2BAA2B,GAC3B,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,4BAA4B,GAC5B,8BAA8B,GAC9B,8BAA8B,GAC9B,+BAA+B,GAC/B,iBAAiB,GACjB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,+BAA+B,GAC/B,uBAAuB,GACvB,6BAA6B,GAC7B,0BAA0B,GAC1B,uBAAuB,GACvB,kBAAkB,GAClB,yBAAyB,GACzB,mBAAmB,GACnB,2BAA2B,GAC3B,iCAAiC,GACjC,6BAA6B,GAC7B,mCAAmC,GACnC,mCAAmC,GACnC,yCAAyC,GACzC,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,aAAa,GACb,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,wBAAwB,GACxB,UAAU,GACV,2BAA2B,GAC3B,6BAA6B,GAC7B,iDAAiD,GACjD,6BAA6B,GAC7B,8BAA8B,GAC9B,2BAA2B,GAC3B,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,qBAAqB,GACrB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,aAAa,GACb,eAAe,GACf,oBAAoB,GACpB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,aAAa,GACb,eAAe,GACf,eAAe,GACf,gBAAgB,CAAA;AAEpB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,cAAc,GAAG,IAAI,CAAA;CAC5B,CAAA"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,eAAe,GACf,OAAO,GACP,OAAO,GACP,UAAU,GACV,WAAW,GACX,MAAM,GACN,SAAS,GACT,aAAa,GACb,MAAM,GACN,UAAU,GACV,cAAc,GACd,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,WAAW,GACX,aAAa,GACb,aAAa,GACb,UAAU,GACV,UAAU,GACV,cAAc,GACd,cAAc,GACd,QAAQ,GACR,iBAAiB,GACjB,eAAe,GACf,KAAK,GACL,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,UAAU,GACV,cAAc,GACd,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,UAAU,GACV,eAAe,GACf,eAAe,GACf,QAAQ,CAAA;AAEZ,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,oBAAoB,GACpB,uBAAuB,GACvB,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,cAAc,GACd,YAAY,GACZ,cAAc,GACd,cAAc,GACd,eAAe,GACf,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,qBAAqB,GACrB,8BAA8B,GAC9B,mBAAmB,GACnB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,8BAA8B,GAC9B,kBAAkB,GAClB,2BAA2B,GAC3B,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,4BAA4B,GAC5B,8BAA8B,GAC9B,8BAA8B,GAC9B,+BAA+B,GAC/B,iBAAiB,GACjB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,+BAA+B,GAC/B,uBAAuB,GACvB,6BAA6B,GAC7B,0BAA0B,GAC1B,uBAAuB,GACvB,kBAAkB,GAClB,yBAAyB,GACzB,mBAAmB,GACnB,2BAA2B,GAC3B,iCAAiC,GACjC,6BAA6B,GAC7B,mCAAmC,GACnC,mCAAmC,GACnC,yCAAyC,GACzC,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,aAAa,GACb,eAAe,GACf,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,wBAAwB,GACxB,wBAAwB,GACxB,yBAAyB,GACzB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,wBAAwB,GACxB,UAAU,GACV,2BAA2B,GAC3B,6BAA6B,GAC7B,iDAAiD,GACjD,6BAA6B,GAC7B,8BAA8B,GAC9B,2BAA2B,GAC3B,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,qBAAqB,GACrB,uBAAuB,GACvB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,oBAAoB,GACpB,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,aAAa,GACb,eAAe,GACf,oBAAoB,GACpB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GAEvB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,mBAAmB,CAAA;AAEvB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,cAAc,GAAG,IAAI,CAAA;CAC5B,CAAA"}
@@ -1,5 +1,6 @@
1
1
  import type { Contact } from '../contacts/types';
2
2
  import type { Department } from '../departments/types';
3
+ import type { Message } from '../messages/types';
3
4
  import type { Service } from '../services/types';
4
5
  import type { User } from '../users/types';
5
6
  export type TicketOrigin = 'automatic' | 'manual' | 'widget';
@@ -20,6 +21,40 @@ export type TicketMetrics = {
20
21
  waitingTimeTransfersAvg?: number;
21
22
  isActiveTicket?: boolean;
22
23
  };
24
+ export type TicketTransferAction = 'opened' | 'transferred' | 'closed';
25
+ /**
26
+ * A step of the history of a ticket (opening, transfer, closing), as the `ticketTransfers` include of
27
+ * `GET /tickets/{id}` answers it. `byUserId` is who performed the step (null when there is no user, e.g. a bot).
28
+ *
29
+ * Inside `ticketTransfers`, the route whitelist only accepts `byUser`, `fromUser`, `toUser`, `fromDepartment` and
30
+ * `toDepartment`: `transferredMessage`, `firstMessage` and `lastMessage` are dropped in silence and come as `null`.
31
+ */
32
+ export type TicketTransfer = {
33
+ id: string;
34
+ action: TicketTransferAction | null;
35
+ comments: string | null;
36
+ fromDistribution: boolean;
37
+ accountId: string;
38
+ ticketId: string;
39
+ byUserId: string | null;
40
+ fromUserId: string | null;
41
+ toUserId: string | null;
42
+ fromDepartmentId: string | null;
43
+ toDepartmentId: string | null;
44
+ transferredMessageId: string | null;
45
+ firstMessageId: string | null;
46
+ lastMessageId: string | null;
47
+ createdAt: string;
48
+ updatedAt: string;
49
+ byUser?: User | null;
50
+ fromUser?: User | null;
51
+ toUser?: User | null;
52
+ fromDepartment?: Department | null;
53
+ toDepartment?: Department | null;
54
+ transferredMessage?: Message | null;
55
+ firstMessage?: Message | null;
56
+ lastMessage?: Message | null;
57
+ };
23
58
  export type Ticket = {
24
59
  id: string;
25
60
  isOpen: boolean;
@@ -45,8 +80,9 @@ export type Ticket = {
45
80
  department?: Department;
46
81
  user?: User | null;
47
82
  service?: Service | null;
83
+ ticketTransfers?: TicketTransfer[];
48
84
  };
49
- export type TicketRelationships = 'contact' | 'department' | 'user' | 'service';
85
+ export type TicketRelationships = 'contact' | 'department' | 'user' | 'service' | 'ticketTransfers';
50
86
  export type CreateTicketPayload = {
51
87
  contactId: string;
52
88
  departmentId: string;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAA;AAE/E,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,mBAAmB,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAA"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iDAAiD;IACjD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,CAAA;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACnC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,OAAO,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,cAAc,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAClC,YAAY,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAChC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACnC,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,aAAa,CAAA;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,OAAO,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,iBAAiB,CAAA;AAEnG,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACxE;IAAE,mBAAmB,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ikatec/digisac-api-sdk",
3
- "version": "4.5.0",
3
+ "version": "4.5.1",
4
4
  "type": "module",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",
@@ -1,12 +1,15 @@
1
- import { expectError } from 'tsd'
1
+ import { expectAssignable, expectError, expectNotAssignable, expectType } from 'tsd'
2
2
  import type { ApiClient } from '../core/ApiClient'
3
3
  import { CardsApi } from './cards/CardsApi'
4
4
  import { ContactsApi } from './contacts/ContactsApi'
5
5
  import { KanbanColumnsApi } from './kanbanColumns/KanbanColumnsApi'
6
6
  import { PipelineApi } from './pipeline/PipelineApi'
7
+ import type { PermissionName } from './permissions/types'
7
8
  import { PersonalAccessTokensApi } from './personalAccessTokens/PersonalAccessTokensApi'
8
9
  import { RolesApi } from './roles/RolesApi'
9
10
  import { TagsApi } from './tags/TagsApi'
11
+ import { TicketsApi } from './tickets/TicketsApi'
12
+ import type { Ticket, TicketTransfer } from './tickets/types'
10
13
  import { TimetableApi } from './timetable/TimetableApi'
11
14
  import { UsersApi } from './users/UsersApi'
12
15
 
@@ -93,3 +96,22 @@ expectError(cards.saveComment({ comment: 'no card nor id' }))
93
96
  const columns = new KanbanColumnsApi(client)
94
97
  columns.reorder('col-1', { beforeColumnId: 'col-0', afterColumnId: 'col-2' })
95
98
  expectError(columns.reorder('col-1', { position: 'M' }))
99
+
100
+ // ── permissions: the kanban permissions were split by the migration 20260209144630 ──
101
+
102
+ expectAssignable<PermissionName>('kanban.boards.view')
103
+ expectAssignable<PermissionName>('kanban.cards.move')
104
+ expectAssignable<PermissionName>('users.export')
105
+ expectNotAssignable<PermissionName>('kanban.view')
106
+ expectNotAssignable<PermissionName>('kanban.update')
107
+
108
+ // ── tickets: the history of the ticket comes in the ticketTransfers include ──
109
+
110
+ const tickets = new TicketsApi(client)
111
+ tickets.getById('t-1', { include: ['ticketTransfers'] })
112
+ tickets.getById('t-1', { include: [{ model: 'ticketTransfers', include: ['byUser'] }] })
113
+ declare const ticket: Ticket
114
+ expectType<TicketTransfer[] | undefined>(ticket.ticketTransfers)
115
+ declare const transfer: TicketTransfer
116
+ expectType<string | null>(transfer.byUserId)
117
+ expectType<'opened' | 'transferred' | 'closed' | null>(transfer.action)
@@ -47,6 +47,7 @@ export type PermissionName =
47
47
  | 'users.create'
48
48
  | 'users.update'
49
49
  | 'users.archive'
50
+ | 'users.export'
50
51
  | 'roles.view'
51
52
  | 'roles.create'
52
53
  | 'roles.update'
@@ -205,10 +206,15 @@ export type PermissionName =
205
206
  | 'knowledgeBase.create'
206
207
  | 'knowledgeBase.update'
207
208
  | 'knowledgeBase.destroy'
208
- | 'kanban.view'
209
- | 'kanban.create'
210
- | 'kanban.update'
211
- | 'kanban.destroy'
209
+ // The migration 20260209144630 replaced kanban.view/create/update/destroy with the permissions below.
210
+ | 'kanban.boards.view'
211
+ | 'kanban.boards.create'
212
+ | 'kanban.boards.update'
213
+ | 'kanban.boards.destroy'
214
+ | 'kanban.columns.create'
215
+ | 'kanban.columns.update'
216
+ | 'kanban.columns.destroy'
217
+ | 'kanban.cards.move'
212
218
 
213
219
  /**
214
220
  * A permission, as `GET /permissions` answers it (the transformer only picks these fields).
@@ -1,5 +1,6 @@
1
1
  import type { Contact } from '../contacts/types'
2
2
  import type { Department } from '../departments/types'
3
+ import type { Message } from '../messages/types'
3
4
  import type { Service } from '../services/types'
4
5
  import type { User } from '../users/types'
5
6
 
@@ -23,6 +24,43 @@ export type TicketMetrics = {
23
24
  isActiveTicket?: boolean
24
25
  }
25
26
 
27
+ export type TicketTransferAction = 'opened' | 'transferred' | 'closed'
28
+
29
+ /**
30
+ * A step of the history of a ticket (opening, transfer, closing), as the `ticketTransfers` include of
31
+ * `GET /tickets/{id}` answers it. `byUserId` is who performed the step (null when there is no user, e.g. a bot).
32
+ *
33
+ * Inside `ticketTransfers`, the route whitelist only accepts `byUser`, `fromUser`, `toUser`, `fromDepartment` and
34
+ * `toDepartment`: `transferredMessage`, `firstMessage` and `lastMessage` are dropped in silence and come as `null`.
35
+ */
36
+ export type TicketTransfer = {
37
+ id: string
38
+ action: TicketTransferAction | null
39
+ comments: string | null
40
+ fromDistribution: boolean
41
+ accountId: string
42
+ ticketId: string
43
+ byUserId: string | null
44
+ fromUserId: string | null
45
+ toUserId: string | null
46
+ fromDepartmentId: string | null
47
+ toDepartmentId: string | null
48
+ transferredMessageId: string | null
49
+ firstMessageId: string | null
50
+ lastMessageId: string | null
51
+ createdAt: string
52
+ updatedAt: string
53
+ // relationships
54
+ byUser?: User | null
55
+ fromUser?: User | null
56
+ toUser?: User | null
57
+ fromDepartment?: Department | null
58
+ toDepartment?: Department | null
59
+ transferredMessage?: Message | null
60
+ firstMessage?: Message | null
61
+ lastMessage?: Message | null
62
+ }
63
+
26
64
  export type Ticket = {
27
65
  id: string
28
66
  isOpen: boolean
@@ -49,9 +87,10 @@ export type Ticket = {
49
87
  department?: Department
50
88
  user?: User | null
51
89
  service?: Service | null
90
+ ticketTransfers?: TicketTransfer[]
52
91
  }
53
92
 
54
- export type TicketRelationships = 'contact' | 'department' | 'user' | 'service'
93
+ export type TicketRelationships = 'contact' | 'department' | 'user' | 'service' | 'ticketTransfers'
55
94
 
56
95
  export type CreateTicketPayload = {
57
96
  contactId: string