@ikatec/digisac-api-sdk 4.1.0 → 4.3.0
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.
- package/README.md +7 -4
- package/dist/apis/authHistory/AuthHistoryApi.cjs +12 -12
- package/dist/apis/authHistory/AuthHistoryApi.cjs.map +1 -1
- package/dist/apis/authHistory/AuthHistoryApi.d.ts +12 -19
- package/dist/apis/authHistory/AuthHistoryApi.d.ts.map +1 -1
- package/dist/apis/authHistory/AuthHistoryApi.mjs +12 -12
- package/dist/apis/authHistory/AuthHistoryApi.mjs.map +1 -1
- package/dist/apis/authHistory/types.d.ts +4 -3
- package/dist/apis/authHistory/types.d.ts.map +1 -1
- package/dist/apis/customFields/types.d.ts +21 -19
- package/dist/apis/customFields/types.d.ts.map +1 -1
- package/dist/apis/dashboard/DashboardApi.cjs +54 -0
- package/dist/apis/dashboard/DashboardApi.cjs.map +1 -0
- package/dist/apis/dashboard/DashboardApi.d.ts +65 -0
- package/dist/apis/dashboard/DashboardApi.d.ts.map +1 -0
- package/dist/apis/dashboard/DashboardApi.mjs +53 -0
- package/dist/apis/dashboard/DashboardApi.mjs.map +1 -0
- package/dist/apis/dashboard/index.cjs +4 -0
- package/dist/apis/dashboard/index.d.ts +3 -0
- package/dist/apis/dashboard/index.d.ts.map +1 -0
- package/dist/apis/dashboard/index.mjs +3 -0
- package/dist/apis/dashboard/types.cjs +0 -0
- package/dist/apis/dashboard/types.d.ts +124 -0
- package/dist/apis/dashboard/types.d.ts.map +1 -0
- package/dist/apis/dashboard/types.mjs +0 -0
- package/dist/apis/holiday/types.d.ts +34 -8
- package/dist/apis/holiday/types.d.ts.map +1 -1
- package/dist/apis/index.cjs +6 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.d.ts.map +1 -1
- package/dist/apis/index.mjs +5 -1
- package/dist/apis/now/NowApi.cjs +37 -0
- package/dist/apis/now/NowApi.cjs.map +1 -0
- package/dist/apis/now/NowApi.d.ts +26 -0
- package/dist/apis/now/NowApi.d.ts.map +1 -0
- package/dist/apis/now/NowApi.mjs +36 -0
- package/dist/apis/now/NowApi.mjs.map +1 -0
- package/dist/apis/now/index.cjs +4 -0
- package/dist/apis/now/index.d.ts +3 -0
- package/dist/apis/now/index.d.ts.map +1 -0
- package/dist/apis/now/index.mjs +3 -0
- package/dist/apis/now/types.cjs +0 -0
- package/dist/apis/now/types.d.ts +45 -0
- package/dist/apis/now/types.d.ts.map +1 -0
- package/dist/apis/now/types.mjs +0 -0
- package/dist/apis/people/types.d.ts +7 -2
- package/dist/apis/people/types.d.ts.map +1 -1
- package/dist/apis/permissions/PermissionsApi.cjs +6 -2
- package/dist/apis/permissions/PermissionsApi.cjs.map +1 -1
- package/dist/apis/permissions/PermissionsApi.d.ts +7 -3
- package/dist/apis/permissions/PermissionsApi.d.ts.map +1 -1
- package/dist/apis/permissions/PermissionsApi.mjs +6 -2
- package/dist/apis/permissions/PermissionsApi.mjs.map +1 -1
- package/dist/apis/permissions/types.d.ts +4 -14
- package/dist/apis/permissions/types.d.ts.map +1 -1
- package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.cjs +5 -0
- package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.cjs.map +1 -1
- package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.d.ts +5 -0
- package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.d.ts.map +1 -1
- package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.mjs +5 -0
- package/dist/apis/personalAccessTokens/PersonalAccessTokensApi.mjs.map +1 -1
- package/dist/apis/personalAccessTokens/types.d.ts +23 -4
- package/dist/apis/personalAccessTokens/types.d.ts.map +1 -1
- package/dist/apis/roles/RolesApi.cjs.map +1 -1
- package/dist/apis/roles/RolesApi.d.ts +2 -2
- package/dist/apis/roles/RolesApi.d.ts.map +1 -1
- package/dist/apis/roles/RolesApi.mjs.map +1 -1
- package/dist/apis/roles/types.d.ts +27 -4
- package/dist/apis/roles/types.d.ts.map +1 -1
- package/dist/apis/terms/TermsApi.cjs +4 -1
- package/dist/apis/terms/TermsApi.cjs.map +1 -1
- package/dist/apis/terms/TermsApi.d.ts +4 -1
- package/dist/apis/terms/TermsApi.d.ts.map +1 -1
- package/dist/apis/terms/TermsApi.mjs +4 -1
- package/dist/apis/terms/TermsApi.mjs.map +1 -1
- package/dist/apis/timetable/types.d.ts +12 -7
- package/dist/apis/timetable/types.d.ts.map +1 -1
- package/dist/core/BaseCrudApi.cjs +3 -30
- package/dist/core/BaseCrudApi.cjs.map +1 -1
- package/dist/core/BaseCrudApi.d.ts +4 -24
- package/dist/core/BaseCrudApi.d.ts.map +1 -1
- package/dist/core/BaseCrudApi.mjs +3 -30
- package/dist/core/BaseCrudApi.mjs.map +1 -1
- package/dist/core/BaseReadApi.cjs +44 -0
- package/dist/core/BaseReadApi.cjs.map +1 -0
- package/dist/core/BaseReadApi.d.ts +32 -0
- package/dist/core/BaseReadApi.d.ts.map +1 -0
- package/dist/core/BaseReadApi.mjs +43 -0
- package/dist/core/BaseReadApi.mjs.map +1 -0
- package/dist/core/index.cjs +2 -0
- package/dist/core/index.d.ts +1 -0
- package/dist/core/index.d.ts.map +1 -1
- package/dist/core/index.mjs +2 -1
- package/dist/index.cjs +2 -0
- package/dist/index.mjs +2 -1
- package/package.json +1 -1
- package/src/apis/authHistory/AuthHistoryApi.test.ts +10 -2
- package/src/apis/authHistory/AuthHistoryApi.ts +13 -39
- package/src/apis/authHistory/types.ts +4 -3
- package/src/apis/customFields/types.ts +21 -25
- package/src/apis/dashboard/DashboardApi.test-d.ts +49 -0
- package/src/apis/dashboard/DashboardApi.test.ts +270 -0
- package/src/apis/dashboard/DashboardApi.ts +146 -0
- package/src/apis/dashboard/index.ts +2 -0
- package/src/apis/dashboard/types.ts +131 -0
- package/src/apis/holiday/types.ts +36 -8
- package/src/apis/index.ts +2 -0
- package/src/apis/now/NowApi.test.ts +125 -0
- package/src/apis/now/NowApi.ts +59 -0
- package/src/apis/now/index.ts +2 -0
- package/src/apis/now/types.ts +47 -0
- package/src/apis/payloads.test-d.ts +39 -0
- package/src/apis/payloads.test.ts +81 -0
- package/src/apis/people/types.ts +7 -2
- package/src/apis/permissions/PermissionsApi.test.ts +93 -0
- package/src/apis/permissions/PermissionsApi.ts +7 -7
- package/src/apis/permissions/types.ts +4 -16
- package/src/apis/personalAccessTokens/PersonalAccessTokensApi.ts +5 -0
- package/src/apis/personalAccessTokens/types.ts +25 -4
- package/src/apis/queryFormat.test.ts +139 -0
- package/src/apis/roles/RolesApi.ts +7 -2
- package/src/apis/roles/types.ts +27 -4
- package/src/apis/terms/TermsApi.ts +4 -1
- package/src/apis/timetable/types.ts +13 -7
- package/src/core/BaseCrudApi.ts +4 -60
- package/src/core/BaseReadApi.ts +70 -0
- package/src/core/index.ts +1 -0
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Granularity of the by-period items (`grouping`). Default: `daily`. Whatever the granularity, the
|
|
3
|
+
* `name` of each item is its day (`dd/MM/yyyy`), so with `hourly` the items of one day share the same
|
|
4
|
+
* `name` (they come in chronological order).
|
|
5
|
+
*/
|
|
6
|
+
export type DashboardGrouping = 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly';
|
|
7
|
+
/**
|
|
8
|
+
* Filters of the service statistics (`/dashboard`). Every field is optional; the period defaults to
|
|
9
|
+
* the last 7 days.
|
|
10
|
+
*/
|
|
11
|
+
export type DashboardQuery = {
|
|
12
|
+
/** ISO date-time. Default: 7 days ago, 00:00. */
|
|
13
|
+
startPeriod?: string;
|
|
14
|
+
/** ISO date-time. Default: the end of the `startPeriod` day (or of today). */
|
|
15
|
+
endPeriod?: string;
|
|
16
|
+
/** Which ticket date the period filters: opening (default) or closing. */
|
|
17
|
+
periodType?: 'openDate' | 'closeDate';
|
|
18
|
+
/** Ticket status (`closed`, not `close`). */
|
|
19
|
+
status?: 'all' | 'open' | 'closed';
|
|
20
|
+
/**
|
|
21
|
+
* A department id, a list of ids, or `all`. Only applied together with `departmentParticipation`:
|
|
22
|
+
* without it the backend ignores `departmentId` and answers the totals of every department.
|
|
23
|
+
*/
|
|
24
|
+
departmentId?: string | string[];
|
|
25
|
+
/**
|
|
26
|
+
* Whether the department must be the ticket's last one or any one it went through. Required for
|
|
27
|
+
* `departmentId` to filter; sent WITHOUT `departmentId`, it filters the tickets with no department.
|
|
28
|
+
*/
|
|
29
|
+
departmentParticipation?: 'last' | 'middle';
|
|
30
|
+
/**
|
|
31
|
+
* A user id, a list of ids, or `all`. Only applied together with `userParticipation`: without it
|
|
32
|
+
* the backend ignores `userId` and answers the totals of every user.
|
|
33
|
+
*/
|
|
34
|
+
userId?: string | string[];
|
|
35
|
+
/**
|
|
36
|
+
* Whether the user must be the ticket's last one or any one it went through. Required for `userId`
|
|
37
|
+
* to filter; sent WITHOUT `userId`, it filters the tickets with no user.
|
|
38
|
+
*/
|
|
39
|
+
userParticipation?: 'last' | 'middle';
|
|
40
|
+
userStatus?: 'active' | 'archived' | 'all';
|
|
41
|
+
serviceId?: string | string[];
|
|
42
|
+
tagId?: string | string[];
|
|
43
|
+
ticketTopicId?: string | string[];
|
|
44
|
+
/**
|
|
45
|
+
* Granularity of the `getByPeriod` items (the other routes ignore it). Default: `daily`. See
|
|
46
|
+
* {@link DashboardGrouping} for the `name` of the items.
|
|
47
|
+
*/
|
|
48
|
+
grouping?: DashboardGrouping;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* `withTotals: true` makes `getByPeriod`, `getByUser` and `getByDepartment` answer `{ totals, items }`,
|
|
52
|
+
* where `totals` are the `getGeneral` counts of the same filters (`getByTopic` and `getByService` do
|
|
53
|
+
* not take it). Kept out of `DashboardQuery` so a query without it keeps the plain array overload.
|
|
54
|
+
* Only sent to the backend when `true`.
|
|
55
|
+
*/
|
|
56
|
+
export type DashboardWithTotals = {
|
|
57
|
+
withTotals?: boolean;
|
|
58
|
+
};
|
|
59
|
+
/** `GET /dashboard/general` — counts of the period. Times are in seconds. */
|
|
60
|
+
export type DashboardGeneral = {
|
|
61
|
+
sentMessagesCount: number;
|
|
62
|
+
receivedMessagesCount: number;
|
|
63
|
+
totalMessagesCount: number;
|
|
64
|
+
openedTicketsCount: number;
|
|
65
|
+
closedTicketsCount: number;
|
|
66
|
+
totalTicketsCount: number;
|
|
67
|
+
waitingTime: number;
|
|
68
|
+
waitingTimeAfterBot: number;
|
|
69
|
+
waitingTimeAvg: number;
|
|
70
|
+
ticketTime: number;
|
|
71
|
+
contactsCount: number;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* Counts shared by the grouped routes (`by-period`, `by-user`, `by-department`, `by-topic`,
|
|
75
|
+
* `by-service`). The backend builds each item from the rows it found, so a count is ABSENT (not 0)
|
|
76
|
+
* when the group has no row for it: read them with a default. Times are in seconds.
|
|
77
|
+
*/
|
|
78
|
+
export type DashboardGroupCounts = {
|
|
79
|
+
sentMessagesCount?: number;
|
|
80
|
+
receivedMessagesCount?: number;
|
|
81
|
+
openedTicketsCount?: number;
|
|
82
|
+
closedTicketsCount?: number;
|
|
83
|
+
waitingTime?: number;
|
|
84
|
+
ticketTime?: number;
|
|
85
|
+
contactsCount?: number;
|
|
86
|
+
};
|
|
87
|
+
/** `GET /dashboard/by-period` — the counts of one day of the period (`name` as `dd/MM/yyyy`). */
|
|
88
|
+
export type DashboardPeriodItem = DashboardGroupCounts & {
|
|
89
|
+
name: string;
|
|
90
|
+
totalMessagesCount?: number;
|
|
91
|
+
totalTicketsCount?: number;
|
|
92
|
+
waitingTimeAfterBot?: number;
|
|
93
|
+
waitingTimeAvg?: number;
|
|
94
|
+
};
|
|
95
|
+
/** `GET /dashboard/by-user` — the counts of one user (`name` is the user's name). */
|
|
96
|
+
export type DashboardUserItem = DashboardGroupCounts & {
|
|
97
|
+
name: string;
|
|
98
|
+
ticketTopicsCount?: number;
|
|
99
|
+
};
|
|
100
|
+
/** `GET /dashboard/by-department` — the counts of one department (`name` is its name). */
|
|
101
|
+
export type DashboardDepartmentItem = DashboardGroupCounts & {
|
|
102
|
+
name: string;
|
|
103
|
+
ticketTopicsCount?: number;
|
|
104
|
+
};
|
|
105
|
+
/** `GET /dashboard/by-topic` — the counts of one ticket topic (`name` is the topic's name). */
|
|
106
|
+
export type DashboardTopicItem = DashboardGroupCounts & {
|
|
107
|
+
name: string;
|
|
108
|
+
waitingTimeAfterBot?: number;
|
|
109
|
+
waitingTimeAvg?: number;
|
|
110
|
+
};
|
|
111
|
+
/** `GET /dashboard/by-service` — the counts of one connection (`name` is the connection's name). */
|
|
112
|
+
export type DashboardServiceItem = DashboardGroupCounts & {
|
|
113
|
+
name: string;
|
|
114
|
+
waitingTimeAfterBot?: number;
|
|
115
|
+
waitingTimeAvg?: number;
|
|
116
|
+
ticketTopicsCount?: number;
|
|
117
|
+
};
|
|
118
|
+
/** Answer of `getByPeriod`, `getByUser` and `getByDepartment` with `withTotals: true`. */
|
|
119
|
+
export type DashboardGrouped<TItem> = {
|
|
120
|
+
/** The `getGeneral` counts of the same filters. */
|
|
121
|
+
totals: DashboardGeneral;
|
|
122
|
+
items: TItem[];
|
|
123
|
+
};
|
|
124
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/dashboard/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAA;AAEpF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,UAAU,GAAG,WAAW,CAAA;IACrC,6CAA6C;IAC7C,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAA;IAClC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IAC3C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IACrC,UAAU,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAA;IAC1C,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAE1D,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,iGAAiG;AACjG,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG;IACvD,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,qFAAqF;AACrF,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED,0FAA0F;AAC1F,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,GAAG;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,IAAI,EAAE,MAAM,CAAA;IACZ,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,oGAAoG;AACpG,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD,IAAI,EAAE,MAAM,CAAA;IACZ,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED,0FAA0F;AAC1F,MAAM,MAAM,gBAAgB,CAAC,KAAK,IAAI;IACpC,mDAAmD;IACnD,MAAM,EAAE,gBAAgB,CAAA;IACxB,KAAK,EAAE,KAAK,EAAE,CAAA;CACf,CAAA"}
|
|
File without changes
|
|
@@ -1,24 +1,50 @@
|
|
|
1
|
+
import type { Account } from '../accounts/types';
|
|
2
|
+
import type { File } from '../files/types';
|
|
3
|
+
/**
|
|
4
|
+
* A holiday: the account's services answer `message` during the period `from`–`to`.
|
|
5
|
+
* Holidays are soft-deleted, but `deletedAt` is never returned.
|
|
6
|
+
*/
|
|
1
7
|
export type Holiday = {
|
|
2
8
|
id: string;
|
|
3
9
|
name: string;
|
|
4
10
|
from: string;
|
|
5
11
|
to: string;
|
|
6
12
|
message: string;
|
|
13
|
+
/** Whether the period is over. */
|
|
14
|
+
expired: boolean;
|
|
15
|
+
/** Number of attached files (computed on the listing, derived from `files` on the detail). */
|
|
16
|
+
filesCount: number;
|
|
17
|
+
/**
|
|
18
|
+
* Attached files — always an array. Only loaded on `getById` (or when listed with
|
|
19
|
+
* `include: ['files']`): `getMany` answers `[]` even when the holiday has files, so use
|
|
20
|
+
* `filesCount` there.
|
|
21
|
+
*/
|
|
22
|
+
files: File[];
|
|
7
23
|
accountId: string;
|
|
8
24
|
createdAt: string;
|
|
9
|
-
|
|
10
|
-
|
|
25
|
+
/** Virtual attribute of the model — may be absent. */
|
|
26
|
+
updatedAt?: string | null;
|
|
27
|
+
account?: Account;
|
|
28
|
+
};
|
|
29
|
+
export type HolidayRelationships = 'account' | 'files';
|
|
30
|
+
/** A file attached by id (up to 10 per holiday). */
|
|
31
|
+
export type HolidayFileRef = {
|
|
32
|
+
id: string;
|
|
11
33
|
};
|
|
12
34
|
export type CreateHolidayPayload = {
|
|
35
|
+
/** Up to 255 characters. */
|
|
13
36
|
name: string;
|
|
37
|
+
/** Date string. A period overlapping another holiday answers 402 "Holiday time already exists.". */
|
|
14
38
|
from: string;
|
|
39
|
+
/** Date string. */
|
|
15
40
|
to: string;
|
|
41
|
+
/** Up to 1024 characters. */
|
|
16
42
|
message: string;
|
|
43
|
+
files?: HolidayFileRef[];
|
|
17
44
|
};
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
};
|
|
45
|
+
/**
|
|
46
|
+
* The backend requires name, from, to and message on every update (same validator as the create).
|
|
47
|
+
* Omitting `files` keeps the current attachments.
|
|
48
|
+
*/
|
|
49
|
+
export type UpdateHolidayPayload = CreateHolidayPayload;
|
|
24
50
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/holiday/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/holiday/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,kCAAkC;IAClC,OAAO,EAAE,OAAO,CAAA;IAChB,8FAA8F;IAC9F,UAAU,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,OAAO,CAAA;AAEtD,oDAAoD;AACpD,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3C,MAAM,MAAM,oBAAoB,GAAG;IACjC,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAA;IACZ,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,cAAc,EAAE,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAA"}
|
package/dist/apis/index.cjs
CHANGED
|
@@ -34,6 +34,8 @@ const require_apis_creditMovements_CreditMovementsApi = require('./creditMovemen
|
|
|
34
34
|
require('./creditMovements/index.cjs');
|
|
35
35
|
const require_apis_customFields_CustomFieldsApi = require('./customFields/CustomFieldsApi.cjs');
|
|
36
36
|
require('./customFields/index.cjs');
|
|
37
|
+
const require_apis_dashboard_DashboardApi = require('./dashboard/DashboardApi.cjs');
|
|
38
|
+
require('./dashboard/index.cjs');
|
|
37
39
|
const require_apis_departments_DepartmentsApi = require('./departments/DepartmentsApi.cjs');
|
|
38
40
|
require('./departments/index.cjs');
|
|
39
41
|
const require_apis_distribution_DistributionApi = require('./distribution/DistributionApi.cjs');
|
|
@@ -62,6 +64,8 @@ const require_apis_messages_MessagesApi = require('./messages/MessagesApi.cjs');
|
|
|
62
64
|
require('./messages/index.cjs');
|
|
63
65
|
const require_apis_notifications_NotificationsApi = require('./notifications/NotificationsApi.cjs');
|
|
64
66
|
require('./notifications/index.cjs');
|
|
67
|
+
const require_apis_now_NowApi = require('./now/NowApi.cjs');
|
|
68
|
+
require('./now/index.cjs');
|
|
65
69
|
const require_apis_organizations_OrganizationsApi = require('./organizations/OrganizationsApi.cjs');
|
|
66
70
|
require('./organizations/index.cjs');
|
|
67
71
|
const require_apis_people_PeopleApi = require('./people/PeopleApi.cjs');
|
|
@@ -128,6 +132,7 @@ exports.ContactBlockListsControlsApi = require_apis_contactBlockListsControls_Co
|
|
|
128
132
|
exports.ContactsApi = require_apis_contacts_ContactsApi.ContactsApi;
|
|
129
133
|
exports.CreditMovementsApi = require_apis_creditMovements_CreditMovementsApi.CreditMovementsApi;
|
|
130
134
|
exports.CustomFieldsApi = require_apis_customFields_CustomFieldsApi.CustomFieldsApi;
|
|
135
|
+
exports.DashboardApi = require_apis_dashboard_DashboardApi.DashboardApi;
|
|
131
136
|
exports.DepartmentsApi = require_apis_departments_DepartmentsApi.DepartmentsApi;
|
|
132
137
|
exports.DistributionApi = require_apis_distribution_DistributionApi.DistributionApi;
|
|
133
138
|
exports.FilesApi = require_apis_files_FilesApi.FilesApi;
|
|
@@ -142,6 +147,7 @@ exports.KnowledgeBaseItemApi = require_apis_knowledgeBaseItem_KnowledgeBaseItemA
|
|
|
142
147
|
exports.MeApi = require_apis_me_MeApi.MeApi;
|
|
143
148
|
exports.MessagesApi = require_apis_messages_MessagesApi.MessagesApi;
|
|
144
149
|
exports.NotificationsApi = require_apis_notifications_NotificationsApi.NotificationsApi;
|
|
150
|
+
exports.NowApi = require_apis_now_NowApi.NowApi;
|
|
145
151
|
exports.OrganizationsApi = require_apis_organizations_OrganizationsApi.OrganizationsApi;
|
|
146
152
|
exports.PeopleApi = require_apis_people_PeopleApi.PeopleApi;
|
|
147
153
|
exports.PermissionsApi = require_apis_permissions_PermissionsApi.PermissionsApi;
|
package/dist/apis/index.d.ts
CHANGED
|
@@ -15,6 +15,7 @@ export * from './contactBlockListsControls';
|
|
|
15
15
|
export * from './contacts';
|
|
16
16
|
export * from './creditMovements';
|
|
17
17
|
export * from './customFields';
|
|
18
|
+
export * from './dashboard';
|
|
18
19
|
export * from './departments';
|
|
19
20
|
export * from './distribution';
|
|
20
21
|
export * from './files';
|
|
@@ -29,6 +30,7 @@ export * from './knowledgeBaseItem';
|
|
|
29
30
|
export * from './me';
|
|
30
31
|
export * from './messages';
|
|
31
32
|
export * from './notifications';
|
|
33
|
+
export * from './now';
|
|
32
34
|
export * from './organizations';
|
|
33
35
|
export * from './people';
|
|
34
36
|
export * from './permissions';
|
package/dist/apis/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/apis/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,mBAAmB,CAAA;AACjC,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,MAAM,CAAA;AACpB,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,2BAA2B,CAAA;AACzC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,6BAA6B,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/apis/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,mBAAmB,CAAA;AACjC,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,MAAM,CAAA;AACpB,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,OAAO,CAAA;AACrB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,2BAA2B,CAAA;AACzC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,6BAA6B,CAAA"}
|
package/dist/apis/index.mjs
CHANGED
|
@@ -33,6 +33,8 @@ import { CreditMovementsApi } from "./creditMovements/CreditMovementsApi.mjs";
|
|
|
33
33
|
import "./creditMovements/index.mjs";
|
|
34
34
|
import { CustomFieldsApi } from "./customFields/CustomFieldsApi.mjs";
|
|
35
35
|
import "./customFields/index.mjs";
|
|
36
|
+
import { DashboardApi } from "./dashboard/DashboardApi.mjs";
|
|
37
|
+
import "./dashboard/index.mjs";
|
|
36
38
|
import { DepartmentsApi } from "./departments/DepartmentsApi.mjs";
|
|
37
39
|
import "./departments/index.mjs";
|
|
38
40
|
import { DistributionApi } from "./distribution/DistributionApi.mjs";
|
|
@@ -61,6 +63,8 @@ import { MessagesApi } from "./messages/MessagesApi.mjs";
|
|
|
61
63
|
import "./messages/index.mjs";
|
|
62
64
|
import { NotificationsApi } from "./notifications/NotificationsApi.mjs";
|
|
63
65
|
import "./notifications/index.mjs";
|
|
66
|
+
import { NowApi } from "./now/NowApi.mjs";
|
|
67
|
+
import "./now/index.mjs";
|
|
64
68
|
import { OrganizationsApi } from "./organizations/OrganizationsApi.mjs";
|
|
65
69
|
import "./organizations/index.mjs";
|
|
66
70
|
import { PeopleApi } from "./people/PeopleApi.mjs";
|
|
@@ -110,4 +114,4 @@ import "./webhooks/index.mjs";
|
|
|
110
114
|
import { WhatsappBusinessTemplatesApi } from "./whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.mjs";
|
|
111
115
|
import "./whatsappBusinessTemplates/index.mjs";
|
|
112
116
|
|
|
113
|
-
export { AbsenceApi, AcceptanceTermsApi, AccountsApi, ActivityLogApi, AnswersApi, AuthHistoryApi, BotVersionsApi, BotsApi, CampaignsApi, CardsApi, CategoriesApi, ClientFeedbackApi, ContactBlockListsApi, ContactBlockListsControlsApi, ContactsApi, CreditMovementsApi, CustomFieldsApi, DepartmentsApi, DistributionApi, FilesApi, HolidayApi, IntegrationsApi, InteractiveMessagesApi, KanbanBoardsApi, KanbanCardsApi, KanbanColumnsApi, KnowledgeBaseApi, KnowledgeBaseItemApi, MeApi, MessagesApi, NotificationsApi, OrganizationsApi, PeopleApi, PermissionsApi, PersonalAccessTokensApi, PipelineApi, PlanAiHistoryApi, QuestionsApi, QuickRepliesApi, RolesApi, ScheduleApi, ServiceAccessManagementApi, ServiceEventsApi, ServicesApi, StickerUsersApi, StickersApi, TagsApi, TermsApi, TicketTopicsApi, TicketsApi, TimetableApi, TranscriptsApi, UsersApi, WebhooksApi, WhatsappBusinessTemplatesApi, scopes_exports as scopes };
|
|
117
|
+
export { AbsenceApi, AcceptanceTermsApi, AccountsApi, ActivityLogApi, AnswersApi, AuthHistoryApi, BotVersionsApi, BotsApi, CampaignsApi, CardsApi, CategoriesApi, ClientFeedbackApi, ContactBlockListsApi, ContactBlockListsControlsApi, ContactsApi, CreditMovementsApi, CustomFieldsApi, DashboardApi, DepartmentsApi, DistributionApi, FilesApi, HolidayApi, IntegrationsApi, InteractiveMessagesApi, KanbanBoardsApi, KanbanCardsApi, KanbanColumnsApi, KnowledgeBaseApi, KnowledgeBaseItemApi, MeApi, MessagesApi, NotificationsApi, NowApi, OrganizationsApi, PeopleApi, PermissionsApi, PersonalAccessTokensApi, PipelineApi, PlanAiHistoryApi, QuestionsApi, QuickRepliesApi, RolesApi, ScheduleApi, ServiceAccessManagementApi, ServiceEventsApi, ServicesApi, StickerUsersApi, StickersApi, TagsApi, TermsApi, TicketTopicsApi, TicketsApi, TimetableApi, TranscriptsApi, UsersApi, WebhooksApi, WhatsappBusinessTemplatesApi, scopes_exports as scopes };
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
+
const require_core_BaseApi = require('../../core/BaseApi.cjs');
|
|
3
|
+
|
|
4
|
+
//#region src/apis/now/NowApi.ts
|
|
5
|
+
/**
|
|
6
|
+
* The "Agora" (now) overview: live totals of tickets and attendants. Every route requires
|
|
7
|
+
* `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's
|
|
8
|
+
* departments).
|
|
9
|
+
*/
|
|
10
|
+
var NowApi = class extends require_core_BaseApi.BaseApi {
|
|
11
|
+
basePath = "/now";
|
|
12
|
+
/**
|
|
13
|
+
* Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.
|
|
14
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
15
|
+
*/
|
|
16
|
+
getResume(query, headers) {
|
|
17
|
+
return this.client.get(`${this.basePath}/resume${this.toQueryString(query)}`, headers);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Per-attendant totals (name, departments, status and open tickets).
|
|
21
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
22
|
+
*/
|
|
23
|
+
getAttendanceResume(query, headers) {
|
|
24
|
+
return this.client.get(`${this.basePath}/attendance-resume${this.toQueryString(query)}`, headers);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Per-department totals (online/offline/absent users, queued and open tickets).
|
|
28
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
29
|
+
*/
|
|
30
|
+
getDepartmentsResume(query, headers) {
|
|
31
|
+
return this.client.get(`${this.basePath}/departments-resume${this.toQueryString(query)}`, headers);
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
//#endregion
|
|
36
|
+
exports.NowApi = NowApi;
|
|
37
|
+
//# sourceMappingURL=NowApi.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"NowApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/now/NowApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n NowAttendanceResume,\n NowDepartmentResume,\n NowQuery,\n NowResponse,\n NowResumeTotals,\n} from './types'\n\n/**\n * The \"Agora\" (now) overview: live totals of tickets and attendants. Every route requires\n * `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's\n * departments).\n */\nexport class NowApi extends BaseApi {\n public readonly basePath = '/now'\n\n /**\n * Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.\n * @permissions overview.now.view.all | overview.now.view.departments\n */\n getResume(\n query?: NowQuery,\n headers?: Record<string, string>,\n ): Promise<NowResponse<NowResumeTotals>> {\n return this.client.get<NowResponse<NowResumeTotals>>(\n `${this.basePath}/resume${this.toQueryString(query)}`,\n headers,\n )\n }\n\n /**\n * Per-attendant totals (name, departments, status and open tickets).\n * @permissions overview.now.view.all | overview.now.view.departments\n */\n getAttendanceResume(\n query?: NowQuery,\n headers?: Record<string, string>,\n ): Promise<NowResponse<NowAttendanceResume[]>> {\n return this.client.get<NowResponse<NowAttendanceResume[]>>(\n `${this.basePath}/attendance-resume${this.toQueryString(query)}`,\n headers,\n )\n }\n\n /**\n * Per-department totals (online/offline/absent users, queued and open tickets).\n * @permissions overview.now.view.all | overview.now.view.departments\n */\n getDepartmentsResume(\n query?: NowQuery,\n headers?: Record<string, string>,\n ): Promise<NowResponse<NowDepartmentResume[]>> {\n return this.client.get<NowResponse<NowDepartmentResume[]>>(\n `${this.basePath}/departments-resume${this.toQueryString(query)}`,\n headers,\n )\n }\n}\n"],"mappings":";;;;;;;;;AAcA,IAAa,SAAb,cAA4BA,6BAAQ;CAClC,AAAgB,WAAW;;;;;CAM3B,UACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,SAAS,KAAK,cAAc,MAAM,IACnD,QACD;;;;;;CAOH,oBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,oBAAoB,KAAK,cAAc,MAAM,IAC9D,QACD;;;;;;CAOH,qBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,qBAAqB,KAAK,cAAc,MAAM,IAC/D,QACD"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { BaseApi } from '../../core/BaseApi';
|
|
2
|
+
import type { NowAttendanceResume, NowDepartmentResume, NowQuery, NowResponse, NowResumeTotals } from './types';
|
|
3
|
+
/**
|
|
4
|
+
* The "Agora" (now) overview: live totals of tickets and attendants. Every route requires
|
|
5
|
+
* `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's
|
|
6
|
+
* departments).
|
|
7
|
+
*/
|
|
8
|
+
export declare class NowApi extends BaseApi {
|
|
9
|
+
readonly basePath = "/now";
|
|
10
|
+
/**
|
|
11
|
+
* Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.
|
|
12
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
13
|
+
*/
|
|
14
|
+
getResume(query?: NowQuery, headers?: Record<string, string>): Promise<NowResponse<NowResumeTotals>>;
|
|
15
|
+
/**
|
|
16
|
+
* Per-attendant totals (name, departments, status and open tickets).
|
|
17
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
18
|
+
*/
|
|
19
|
+
getAttendanceResume(query?: NowQuery, headers?: Record<string, string>): Promise<NowResponse<NowAttendanceResume[]>>;
|
|
20
|
+
/**
|
|
21
|
+
* Per-department totals (online/offline/absent users, queued and open tickets).
|
|
22
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
23
|
+
*/
|
|
24
|
+
getDepartmentsResume(query?: NowQuery, headers?: Record<string, string>): Promise<NowResponse<NowDepartmentResume[]>>;
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=NowApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"NowApi.d.ts","sourceRoot":"","sources":["../../../src/apis/now/NowApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,QAAQ,EACR,WAAW,EACX,eAAe,EAChB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,OAAO;IACjC,SAAgB,QAAQ,UAAS;IAEjC;;;OAGG;IACH,SAAS,CACP,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAOxC;;;OAGG;IACH,mBAAmB,CACjB,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAO9C;;;OAGG;IACH,oBAAoB,CAClB,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;CAM/C"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { BaseApi } from "../../core/BaseApi.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/apis/now/NowApi.ts
|
|
4
|
+
/**
|
|
5
|
+
* The "Agora" (now) overview: live totals of tickets and attendants. Every route requires
|
|
6
|
+
* `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's
|
|
7
|
+
* departments).
|
|
8
|
+
*/
|
|
9
|
+
var NowApi = class extends BaseApi {
|
|
10
|
+
basePath = "/now";
|
|
11
|
+
/**
|
|
12
|
+
* Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.
|
|
13
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
14
|
+
*/
|
|
15
|
+
getResume(query, headers) {
|
|
16
|
+
return this.client.get(`${this.basePath}/resume${this.toQueryString(query)}`, headers);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Per-attendant totals (name, departments, status and open tickets).
|
|
20
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
21
|
+
*/
|
|
22
|
+
getAttendanceResume(query, headers) {
|
|
23
|
+
return this.client.get(`${this.basePath}/attendance-resume${this.toQueryString(query)}`, headers);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Per-department totals (online/offline/absent users, queued and open tickets).
|
|
27
|
+
* @permissions overview.now.view.all | overview.now.view.departments
|
|
28
|
+
*/
|
|
29
|
+
getDepartmentsResume(query, headers) {
|
|
30
|
+
return this.client.get(`${this.basePath}/departments-resume${this.toQueryString(query)}`, headers);
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
//#endregion
|
|
35
|
+
export { NowApi };
|
|
36
|
+
//# sourceMappingURL=NowApi.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"NowApi.mjs","names":[],"sources":["../../../src/apis/now/NowApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type {\n NowAttendanceResume,\n NowDepartmentResume,\n NowQuery,\n NowResponse,\n NowResumeTotals,\n} from './types'\n\n/**\n * The \"Agora\" (now) overview: live totals of tickets and attendants. Every route requires\n * `overview.now.view.all` or `overview.now.view.departments` (the latter is scoped to the user's\n * departments).\n */\nexport class NowApi extends BaseApi {\n public readonly basePath = '/now'\n\n /**\n * Account totals: open/queued tickets, attendants with/without attendance and online/offline/absent users.\n * @permissions overview.now.view.all | overview.now.view.departments\n */\n getResume(\n query?: NowQuery,\n headers?: Record<string, string>,\n ): Promise<NowResponse<NowResumeTotals>> {\n return this.client.get<NowResponse<NowResumeTotals>>(\n `${this.basePath}/resume${this.toQueryString(query)}`,\n headers,\n )\n }\n\n /**\n * Per-attendant totals (name, departments, status and open tickets).\n * @permissions overview.now.view.all | overview.now.view.departments\n */\n getAttendanceResume(\n query?: NowQuery,\n headers?: Record<string, string>,\n ): Promise<NowResponse<NowAttendanceResume[]>> {\n return this.client.get<NowResponse<NowAttendanceResume[]>>(\n `${this.basePath}/attendance-resume${this.toQueryString(query)}`,\n headers,\n )\n }\n\n /**\n * Per-department totals (online/offline/absent users, queued and open tickets).\n * @permissions overview.now.view.all | overview.now.view.departments\n */\n getDepartmentsResume(\n query?: NowQuery,\n headers?: Record<string, string>,\n ): Promise<NowResponse<NowDepartmentResume[]>> {\n return this.client.get<NowResponse<NowDepartmentResume[]>>(\n `${this.basePath}/departments-resume${this.toQueryString(query)}`,\n headers,\n )\n }\n}\n"],"mappings":";;;;;;;;AAcA,IAAa,SAAb,cAA4B,QAAQ;CAClC,AAAgB,WAAW;;;;;CAM3B,UACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,SAAS,KAAK,cAAc,MAAM,IACnD,QACD;;;;;;CAOH,oBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,oBAAoB,KAAK,cAAc,MAAM,IAC9D,QACD;;;;;;CAOH,qBACE,OACA,SAC6C;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,qBAAqB,KAAK,cAAc,MAAM,IAC/D,QACD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/apis/now/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,mBAAmB,SAAS,CAAA"}
|
|
File without changes
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import type { User } from '../users/types';
|
|
2
|
+
/**
|
|
3
|
+
* Filters of the "Agora" (now) overview. Each accepts one id, an array or a comma-separated list.
|
|
4
|
+
* A user with only `overview.now.view.departments` gets 403 for departments/users outside their
|
|
5
|
+
* departments.
|
|
6
|
+
*/
|
|
7
|
+
export type NowQuery = {
|
|
8
|
+
departmentId?: string | string[];
|
|
9
|
+
userId?: string | string[];
|
|
10
|
+
};
|
|
11
|
+
/** Every `/now` route answers its data under `totals`. */
|
|
12
|
+
export type NowResponse<T> = {
|
|
13
|
+
totals: T;
|
|
14
|
+
};
|
|
15
|
+
export type NowResumeTotals = {
|
|
16
|
+
openTickets: number;
|
|
17
|
+
queueTickets: number;
|
|
18
|
+
usersWithAttendance: number;
|
|
19
|
+
usersWithoutAttendance: number;
|
|
20
|
+
/** Postgres `avg()` — a numeric string, or `0` when there is no data. */
|
|
21
|
+
averageOpenTicketsTime: number | string;
|
|
22
|
+
/** Postgres `avg()` — a numeric string, or `0` when there is no data. */
|
|
23
|
+
averageOpenTicketsWaitTime: number | string;
|
|
24
|
+
onlineUsersCount: number;
|
|
25
|
+
offlineUsersCount: number;
|
|
26
|
+
absentUsersCount: number;
|
|
27
|
+
};
|
|
28
|
+
/** One entry per department. */
|
|
29
|
+
export type NowDepartmentResume = {
|
|
30
|
+
name: string;
|
|
31
|
+
onlineUserCount: number;
|
|
32
|
+
offlineUserCount: number;
|
|
33
|
+
absentUserCount: number;
|
|
34
|
+
onQueueTicketCount: number;
|
|
35
|
+
openTicketCount: number;
|
|
36
|
+
};
|
|
37
|
+
/** One entry per attendant (user). */
|
|
38
|
+
export type NowAttendanceResume = {
|
|
39
|
+
name?: string;
|
|
40
|
+
/** Department names — `0` when the attendant has no department. */
|
|
41
|
+
departments: string[] | 0;
|
|
42
|
+
status?: User['status'];
|
|
43
|
+
ticketsOpenCount: number;
|
|
44
|
+
};
|
|
45
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/now/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC3B,CAAA;AAED,0DAA0D;AAC1D,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,CAAA;AAE1C,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,sBAAsB,EAAE,MAAM,CAAA;IAC9B,yEAAyE;IACzE,sBAAsB,EAAE,MAAM,GAAG,MAAM,CAAA;IACvC,yEAAyE;IACzE,0BAA0B,EAAE,MAAM,GAAG,MAAM,CAAA;IAC3C,gBAAgB,EAAE,MAAM,CAAA;IACxB,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,gCAAgC;AAChC,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;IACvB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,sCAAsC;AACtC,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,mEAAmE;IACnE,WAAW,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA"}
|
|
File without changes
|
|
@@ -13,10 +13,15 @@ export type Person = {
|
|
|
13
13
|
export type PersonRelationships = 'organizations' | 'contacts';
|
|
14
14
|
export type CreatePersonPayload = {
|
|
15
15
|
name: string;
|
|
16
|
-
document?: string;
|
|
16
|
+
document?: string | null;
|
|
17
|
+
/** Organizations of the account to link the person to (400 if any belongs to another account). */
|
|
18
|
+
organizationIds?: string[];
|
|
17
19
|
};
|
|
18
20
|
export type UpdatePersonPayload = {
|
|
19
|
-
|
|
21
|
+
/** Required by the backend on every update (400 `required` otherwise). */
|
|
22
|
+
name: string;
|
|
20
23
|
document?: string | null;
|
|
24
|
+
/** Replaces the linked organizations: `[]` unlinks all, omitting it keeps them. */
|
|
25
|
+
organizationIds?: string[];
|
|
21
26
|
};
|
|
22
27
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/people/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAE1D,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,UAAU,CAAA;AAE9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/people/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAE1D,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,UAAU,CAAA;AAE9D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kGAAkG;IAClG,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,mFAAmF;IACnF,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B,CAAA"}
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
-
const
|
|
2
|
+
const require_core_BaseReadApi = require('../../core/BaseReadApi.cjs');
|
|
3
3
|
|
|
4
4
|
//#region src/apis/permissions/PermissionsApi.ts
|
|
5
|
-
|
|
5
|
+
/**
|
|
6
|
+
* The permission catalog used by roles. The backend only serves `GET /permissions` and
|
|
7
|
+
* `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.
|
|
8
|
+
*/
|
|
9
|
+
var PermissionsApi = class extends require_core_BaseReadApi.BaseReadApi {
|
|
6
10
|
constructor(client) {
|
|
7
11
|
super(client, "/permissions");
|
|
8
12
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PermissionsApi.cjs","names":["
|
|
1
|
+
{"version":3,"file":"PermissionsApi.cjs","names":["BaseReadApi"],"sources":["../../../src/apis/permissions/PermissionsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseReadApi } from '../../core/BaseReadApi'\nimport type { Permission } from './types'\n\n/**\n * The permission catalog used by roles. The backend only serves `GET /permissions` and\n * `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.\n */\nexport class PermissionsApi extends BaseReadApi<Permission> {\n constructor(client: ApiClient) {\n super(client, '/permissions')\n }\n}\n"],"mappings":";;;;;;;;AAQA,IAAa,iBAAb,cAAoCA,qCAAwB;CAC1D,YAAY,QAAmB;AAC7B,QAAM,QAAQ,eAAe"}
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import type { ApiClient } from '../../core/ApiClient';
|
|
2
|
-
import {
|
|
3
|
-
import type { Permission
|
|
4
|
-
|
|
2
|
+
import { BaseReadApi } from '../../core/BaseReadApi';
|
|
3
|
+
import type { Permission } from './types';
|
|
4
|
+
/**
|
|
5
|
+
* The permission catalog used by roles. The backend only serves `GET /permissions` and
|
|
6
|
+
* `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.
|
|
7
|
+
*/
|
|
8
|
+
export declare class PermissionsApi extends BaseReadApi<Permission> {
|
|
5
9
|
constructor(client: ApiClient);
|
|
6
10
|
}
|
|
7
11
|
//# sourceMappingURL=PermissionsApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PermissionsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/PermissionsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,
|
|
1
|
+
{"version":3,"file":"PermissionsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/permissions/PermissionsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEzC;;;GAGG;AACH,qBAAa,cAAe,SAAQ,WAAW,CAAC,UAAU,CAAC;gBAC7C,MAAM,EAAE,SAAS;CAG9B"}
|
|
@@ -1,7 +1,11 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { BaseReadApi } from "../../core/BaseReadApi.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/apis/permissions/PermissionsApi.ts
|
|
4
|
-
|
|
4
|
+
/**
|
|
5
|
+
* The permission catalog used by roles. The backend only serves `GET /permissions` and
|
|
6
|
+
* `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.
|
|
7
|
+
*/
|
|
8
|
+
var PermissionsApi = class extends BaseReadApi {
|
|
5
9
|
constructor(client) {
|
|
6
10
|
super(client, "/permissions");
|
|
7
11
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PermissionsApi.mjs","names":[],"sources":["../../../src/apis/permissions/PermissionsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport {
|
|
1
|
+
{"version":3,"file":"PermissionsApi.mjs","names":[],"sources":["../../../src/apis/permissions/PermissionsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseReadApi } from '../../core/BaseReadApi'\nimport type { Permission } from './types'\n\n/**\n * The permission catalog used by roles. The backend only serves `GET /permissions` and\n * `GET /permissions/:id` (guarded by `roles.view`), so there is no create/update/delete.\n */\nexport class PermissionsApi extends BaseReadApi<Permission> {\n constructor(client: ApiClient) {\n super(client, '/permissions')\n }\n}\n"],"mappings":";;;;;;;AAQA,IAAa,iBAAb,cAAoC,YAAwB;CAC1D,YAAY,QAAmB;AAC7B,QAAM,QAAQ,eAAe"}
|
|
@@ -1,22 +1,12 @@
|
|
|
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
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';
|
|
3
|
+
/**
|
|
4
|
+
* A permission, as `GET /permissions` answers it (the transformer only picks these fields).
|
|
5
|
+
* Permissions are a fixed catalog: the API is read-only.
|
|
6
|
+
*/
|
|
3
7
|
export type Permission = {
|
|
4
8
|
id: string;
|
|
5
9
|
name: PermissionName;
|
|
6
10
|
type: PermissionType | null;
|
|
7
|
-
description: string | null;
|
|
8
|
-
createdAt: string;
|
|
9
|
-
updatedAt: string;
|
|
10
|
-
deletedAt: string | null;
|
|
11
|
-
};
|
|
12
|
-
export type CreatePermissionPayload = {
|
|
13
|
-
name: PermissionName;
|
|
14
|
-
type?: PermissionType;
|
|
15
|
-
description?: string;
|
|
16
|
-
};
|
|
17
|
-
export type UpdatePermissionPayload = {
|
|
18
|
-
name?: PermissionName;
|
|
19
|
-
type?: PermissionType | null;
|
|
20
|
-
description?: string | null;
|
|
21
11
|
};
|
|
22
12
|
//# sourceMappingURL=types.d.ts.map
|