@dx-do/client 7.7.1 → 7.8.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/dist/index.cjs.js +969 -257
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +941 -258
- package/dist/index.esm.js.map +1 -1
- package/dist/src/index.d.ts +2 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/lib/model/alarm/alarm-enrichment-rule.d.ts +263 -0
- package/dist/src/lib/model/alarm/alarm-enrichment-rule.d.ts.map +1 -0
- package/dist/src/lib/model/channel/ticket-enrichment.d.ts +201 -0
- package/dist/src/lib/model/channel/ticket-enrichment.d.ts.map +1 -0
- package/dist/src/lib/services/alarm.service.d.ts +67 -3
- package/dist/src/lib/services/alarm.service.d.ts.map +1 -1
- package/dist/src/lib/services/channel.service.d.ts +42 -0
- package/dist/src/lib/services/channel.service.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -8,6 +8,7 @@ type Policy = PolicyResponse.Policy;
|
|
|
8
8
|
import { DXChannel } from '../model/dxchannel/DXChannel';
|
|
9
9
|
import DXChannelConfiguration = DXChannel.DXChannelConfiguration;
|
|
10
10
|
import { Logging } from '@dx-do/util';
|
|
11
|
+
import type { ServiceDeskField, TicketEnrichmentAlarmField, TicketEnrichmentRule, TicketEnrichmentWriteBody, TicketEnrichmentWriteResponse } from '../model/channel/ticket-enrichment';
|
|
11
12
|
import type { AnyChannel, ChannelDeleteResponse, ChannelWriteBody, ChannelWriteResponse, MessageTemplateField } from '../model/channel/notify-channel';
|
|
12
13
|
import type { AlarmFilterField, PolicyAlarmCategory, PolicyDeleteResponse, PolicyWriteBody, PolicyWriteResponse, TemplateDeleteResponse, TemplateWriteBody, TemplateWriteResponse } from '../model/channel/notify-policy-template';
|
|
13
14
|
import type { ItsmTestConnectionRequest, ItsmTestConnectionResponse, SmtpTestInput, SmtpTestResponse, WebhookTestInput, WebhookTestResponse } from '../model/channel/notify-channel-testing';
|
|
@@ -130,6 +131,47 @@ export declare class ChannelService {
|
|
|
130
131
|
* and message templates via `GET oi/v2/api/alarm/messageTemplate/fields`.
|
|
131
132
|
*/
|
|
132
133
|
listMessageTemplateFields(): Promise<MessageTemplateField[]>;
|
|
134
|
+
/**
|
|
135
|
+
* Lists the tenant's ticket enrichment rules
|
|
136
|
+
* (`GET dxinotify/notify/v1/customMappings/{orgId}`).
|
|
137
|
+
*
|
|
138
|
+
* @remarks A tenant with no rules answers with a bare `{}`, not
|
|
139
|
+
* `{ customMappings: [] }` — normalised to `[]` here.
|
|
140
|
+
* Response-validated, not thrown.
|
|
141
|
+
*/
|
|
142
|
+
listTicketEnrichmentRules(): Promise<TicketEnrichmentRule[]>;
|
|
143
|
+
/**
|
|
144
|
+
* Saves one ticket enrichment rule
|
|
145
|
+
* (`PUT dxinotify/notify/v1/customMappings`). `id: 0` creates, an
|
|
146
|
+
* existing id updates in place.
|
|
147
|
+
*
|
|
148
|
+
* @remarks `orgId` is stamped from the caller's token, so the body's value
|
|
149
|
+
* is ignored. Unlike `saveChannel`, the response carries the persisted rule
|
|
150
|
+
* including its new id. Response-validated, not thrown.
|
|
151
|
+
* @throws ZodError on a malformed body.
|
|
152
|
+
*/
|
|
153
|
+
saveTicketEnrichmentRule(body: TicketEnrichmentWriteBody): Promise<TicketEnrichmentWriteResponse>;
|
|
154
|
+
/** Permanently deletes a ticket enrichment rule (`DELETE .../customMappings/{orgId}/{id}`). */
|
|
155
|
+
deleteTicketEnrichmentRule(ruleId: number): Promise<unknown>;
|
|
156
|
+
/**
|
|
157
|
+
* The service-desk field catalog of one ITSM channel
|
|
158
|
+
* (`GET oi/v2/tenantmgmtservice/properties?channelId=<id>`). A mapping's
|
|
159
|
+
* `svcDeskField` is an entry's `mappedTo`.
|
|
160
|
+
*
|
|
161
|
+
* @remarks Field definitions only — it carries no channel credentials.
|
|
162
|
+
* Response-validated, not thrown.
|
|
163
|
+
*/
|
|
164
|
+
listServiceDeskFields(channelId: number): Promise<ServiceDeskField[]>;
|
|
165
|
+
/**
|
|
166
|
+
* The alarm fields a ticket enrichment rule can read
|
|
167
|
+
* (`GET oi/v2/api/alarm/messageTemplate/fields?usedInTicketEnrichment=true`).
|
|
168
|
+
*
|
|
169
|
+
* @remarks Each entry's `alarmType` lists the catalog codes it is valid
|
|
170
|
+
* for; a rule mapping a field outside its own type's code is rejected with
|
|
171
|
+
* a bare 400. See `TICKET_ENRICHMENT_FIELD_CODES`.
|
|
172
|
+
* Response-validated, not thrown.
|
|
173
|
+
*/
|
|
174
|
+
listTicketEnrichmentAlarmFields(): Promise<TicketEnrichmentAlarmField[]>;
|
|
133
175
|
/** Returns all notification channels using the new DXChannelConfiguration model. */
|
|
134
176
|
retrieveAllChannelsNew(): Promise<DXChannelConfiguration[]>;
|
|
135
177
|
/** Returns all notification channels using the legacy Channel model. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"channel.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/channel.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,KAAK,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;AACvC,KAAK,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC;AAE3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACtE,KAAK,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,sBAAsB,GAAG,SAAS,CAAC,sBAAsB,CAAC;AAEjE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAQtC,OAAO,KAAK,EACV,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AAWzC,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,yCAAyC,CAAC;AASjD,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,aAAa,EAEb,gBAAgB,EAChB,gBAAgB,EAEhB,mBAAmB,EACpB,MAAM,yCAAyC,CAAC;AAEjD;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IAMvB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IANtB;;;OAGG;gBAEO,aAAa,EAAE,aAAa,EACnB,GAAG,GAAE,OAAO,CAAC,SAAuC;IAGvE;;;OAGG;IACH,OAAO,CAAC,aAAa;IAiBrB;;;;;;OAMG;IACG,YAAY,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAa3C;;;;;;;;OAQG;IACG,WAAW,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWxE;;;;;;;;OAQG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IActE;;;;;OAKG;IACG,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAWrE;;;;;;OAMG;IACG,YAAY,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAW3E;;;;OAIG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAc/D;;;;;OAKG;IACG,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,SAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAcrF;;;;OAIG;IACG,qBAAqB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IASvF;;;;;;OAMG;IACG,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgBjE;;;;;;;OAOG;IACG,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgB1E;;;;;;;OAOG;IACG,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAajG;;;OAGG;IACG,yBAAyB,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;IASlE,oFAAoF;IAC7E,sBAAsB,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAalE,wEAAwE;IACjE,mBAAmB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAahD,qFAAqF;IACxE,gBAAgB,CAC3B,eAAe,EAAE,sBAAsB,GACtC,OAAO,CAAC,OAAO,CAAC;IAcnB,yEAAyE;IAC5D,aAAa,CAAC,eAAe,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAclE,oFAAoF;IACvE,gBAAgB,CAC3B,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,sBAAsB,GACpC,OAAO,CAAC,OAAO,CAAC;IAanB,wEAAwE;IAC3D,aAAa,CACxB,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,OAAO,GACrB,OAAO,CAAC,GAAG,CAAC;IAaf,0CAA0C;IACnC,oBAAoB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAalD,gDAAgD;IACzC,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAa/C,sDAAsD;IACtD,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM;IAU1C,gDAAgD;IAChD,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM;IAU1C,4FAA4F;IAC/E,cAAc,CACzB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAyBf,4FAA4F;IACrF,cAAc,CACnB,eAAe,EAAE,QAAQ,EACzB,eAAe,CAAC,EAAE,MAAM,EACxB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,eAAe,CAAC,EAAE,MAAM,EACxB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;CAiBhB"}
|
|
1
|
+
{"version":3,"file":"channel.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/channel.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,KAAK,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;AACvC,KAAK,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC;AAE3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACtE,KAAK,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,sBAAsB,GAAG,SAAS,CAAC,sBAAsB,CAAC;AAEjE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAQtC,OAAO,KAAK,EACV,gBAAgB,EAChB,0BAA0B,EAC1B,oBAAoB,EACpB,yBAAyB,EACzB,6BAA6B,EAC9B,MAAM,oCAAoC,CAAC;AAQ5C,OAAO,KAAK,EACV,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AAWzC,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,yCAAyC,CAAC;AASjD,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,aAAa,EAEb,gBAAgB,EAChB,gBAAgB,EAEhB,mBAAmB,EACpB,MAAM,yCAAyC,CAAC;AAEjD;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IAMvB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IANtB;;;OAGG;gBAEO,aAAa,EAAE,aAAa,EACnB,GAAG,GAAE,OAAO,CAAC,SAAuC;IAGvE;;;OAGG;IACH,OAAO,CAAC,aAAa;IAiBrB;;;;;;OAMG;IACG,YAAY,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAa3C;;;;;;;;OAQG;IACG,WAAW,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWxE;;;;;;;;OAQG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IActE;;;;;OAKG;IACG,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAWrE;;;;;;OAMG;IACG,YAAY,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAW3E;;;;OAIG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAc/D;;;;;OAKG;IACG,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,SAAU,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAcrF;;;;OAIG;IACG,qBAAqB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IASvF;;;;;;OAMG;IACG,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgBjE;;;;;;;OAOG;IACG,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgB1E;;;;;;;OAOG;IACG,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAajG;;;OAGG;IACG,yBAAyB,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAalE;;;;;;;OAOG;IACG,yBAAyB,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;IASlE;;;;;;;;;OASG;IACG,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAWvG,+FAA+F;IACzF,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASlE;;;;;;;OAOG;IACG,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAS3E;;;;;;;;OAQG;IACG,+BAA+B,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;IAW9E,oFAAoF;IAC7E,sBAAsB,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAalE,wEAAwE;IACjE,mBAAmB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAahD,qFAAqF;IACxE,gBAAgB,CAC3B,eAAe,EAAE,sBAAsB,GACtC,OAAO,CAAC,OAAO,CAAC;IAcnB,yEAAyE;IAC5D,aAAa,CAAC,eAAe,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAclE,oFAAoF;IACvE,gBAAgB,CAC3B,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,sBAAsB,GACpC,OAAO,CAAC,OAAO,CAAC;IAanB,wEAAwE;IAC3D,aAAa,CACxB,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,OAAO,GACrB,OAAO,CAAC,GAAG,CAAC;IAaf,0CAA0C;IACnC,oBAAoB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAalD,gDAAgD;IACzC,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAa/C,sDAAsD;IACtD,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM;IAU1C,gDAAgD;IAChD,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM;IAU1C,4FAA4F;IAC/E,cAAc,CACzB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAyBf,4FAA4F;IACrF,cAAc,CACnB,eAAe,EAAE,QAAQ,EACzB,eAAe,CAAC,EAAE,MAAM,EACxB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,eAAe,CAAC,EAAE,MAAM,EACxB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;CAiBhB"}
|