@vonage/audit 1.17.2 → 1.18.0-alpha.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/{types → cjs}/audit.d.ts +8 -4
- package/dist/cjs/audit.js +109 -0
- package/dist/{types → cjs}/enums.d.ts +3 -2
- package/dist/cjs/enums.js +59 -0
- package/dist/cjs/index.d.ts +10 -0
- package/dist/cjs/index.js +145 -0
- package/dist/cjs/package.json +3 -0
- package/dist/{types → cjs}/types/auditEvent.d.ts +4 -2
- package/dist/cjs/types/auditEvent.js +18 -0
- package/dist/{types → cjs}/types/auditEventListResponse.d.ts +5 -2
- package/dist/cjs/types/auditEventListResponse.js +18 -0
- package/dist/{types → cjs}/types/auditEventPage.d.ts +3 -2
- package/dist/cjs/types/auditEventPage.js +18 -0
- package/dist/{types → cjs}/types/auditEventResponse.d.ts +4 -2
- package/dist/cjs/types/auditEventResponse.js +18 -0
- package/dist/{types → cjs}/types/auditParams.d.ts +4 -2
- package/dist/cjs/types/auditParams.js +18 -0
- package/dist/cjs/types/auditResponse.d.ts +8 -0
- package/dist/cjs/types/auditResponse.js +18 -0
- package/dist/cjs/types/index.d.ts +9 -0
- package/dist/cjs/types/index.js +18 -0
- package/dist/esm/{audit.js → audit.d.mts} +12 -23
- package/dist/esm/audit.mjs +6 -0
- package/dist/esm/chunk-67PEDNZG.mjs +0 -0
- package/dist/esm/chunk-A6RND7HO.mjs +0 -0
- package/dist/esm/chunk-H2HTRM5V.mjs +0 -0
- package/dist/esm/chunk-J2WIUYQ3.mjs +0 -0
- package/dist/esm/chunk-OBZ3KD3U.mjs +85 -0
- package/dist/esm/chunk-OVBSHGNZ.mjs +0 -0
- package/dist/esm/chunk-XMMZY7PJ.mjs +35 -0
- package/dist/esm/chunk-YPBMBXT7.mjs +0 -0
- package/dist/esm/chunk-YQNVDASO.mjs +0 -0
- package/dist/esm/{enums.js → enums.d.mts} +31 -31
- package/dist/esm/enums.mjs +6 -0
- package/dist/esm/index.d.mts +10 -0
- package/dist/esm/index.mjs +17 -0
- package/dist/esm/types/auditEvent.d.mts +50 -0
- package/dist/esm/types/auditEvent.mjs +1 -0
- package/dist/esm/types/auditEventListResponse.d.mts +30 -0
- package/dist/esm/types/auditEventListResponse.mjs +1 -0
- package/dist/esm/types/auditEventPage.d.mts +23 -0
- package/dist/esm/types/auditEventPage.mjs +1 -0
- package/dist/esm/types/auditEventResponse.d.mts +43 -0
- package/dist/esm/types/auditEventResponse.mjs +1 -0
- package/dist/esm/types/auditParams.d.mts +33 -0
- package/dist/esm/types/auditParams.mjs +1 -0
- package/dist/esm/types/auditResponse.d.mts +8 -0
- package/dist/esm/types/auditResponse.mjs +1 -0
- package/dist/esm/types/index.d.mts +9 -0
- package/dist/esm/types/index.mjs +7 -0
- package/package.json +25 -30
- package/dist/cjs/audit.cjs +0 -94
- package/dist/cjs/audit.js.map +0 -1
- package/dist/cjs/enums.cjs +0 -128
- package/dist/cjs/enums.js.map +0 -1
- package/dist/cjs/index.cjs +0 -20
- package/dist/cjs/index.js.map +0 -1
- package/dist/cjs/types/auditEvent.cjs +0 -3
- package/dist/cjs/types/auditEvent.js.map +0 -1
- package/dist/cjs/types/auditEventListResponse.cjs +0 -3
- package/dist/cjs/types/auditEventListResponse.js.map +0 -1
- package/dist/cjs/types/auditEventPage.cjs +0 -3
- package/dist/cjs/types/auditEventPage.js.map +0 -1
- package/dist/cjs/types/auditEventResponse.cjs +0 -3
- package/dist/cjs/types/auditEventResponse.js.map +0 -1
- package/dist/cjs/types/auditParams.cjs +0 -3
- package/dist/cjs/types/auditParams.js.map +0 -1
- package/dist/cjs/types/auditResponse.cjs +0 -3
- package/dist/cjs/types/auditResponse.js.map +0 -1
- package/dist/cjs/types/index.cjs +0 -23
- package/dist/cjs/types/index.js.map +0 -1
- package/dist/esm/audit.js.map +0 -1
- package/dist/esm/enums.js.map +0 -1
- package/dist/esm/index.js +0 -4
- package/dist/esm/index.js.map +0 -1
- package/dist/esm/types/auditEvent.js +0 -2
- package/dist/esm/types/auditEvent.js.map +0 -1
- package/dist/esm/types/auditEventListResponse.js +0 -2
- package/dist/esm/types/auditEventListResponse.js.map +0 -1
- package/dist/esm/types/auditEventPage.js +0 -2
- package/dist/esm/types/auditEventPage.js.map +0 -1
- package/dist/esm/types/auditEventResponse.js +0 -2
- package/dist/esm/types/auditEventResponse.js.map +0 -1
- package/dist/esm/types/auditParams.js +0 -2
- package/dist/esm/types/auditParams.js.map +0 -1
- package/dist/esm/types/auditResponse.js +0 -2
- package/dist/esm/types/auditResponse.js.map +0 -1
- package/dist/esm/types/index.js +0 -7
- package/dist/esm/types/index.js.map +0 -1
- package/dist/types/audit.d.ts.map +0 -1
- package/dist/types/enums.d.ts.map +0 -1
- package/dist/types/index.d.ts +0 -4
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/types/auditEvent.d.ts.map +0 -1
- package/dist/types/types/auditEventListResponse.d.ts.map +0 -1
- package/dist/types/types/auditEventPage.d.ts.map +0 -1
- package/dist/types/types/auditEventResponse.d.ts.map +0 -1
- package/dist/types/types/auditParams.d.ts.map +0 -1
- package/dist/types/types/auditResponse.d.ts +0 -6
- package/dist/types/types/auditResponse.d.ts.map +0 -1
- package/dist/types/types/index.d.ts +0 -7
- package/dist/types/types/index.d.ts.map +0 -1
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { AuditEvent
|
|
1
|
+
import { Client, AuthenticationType } from '@vonage/server-client';
|
|
2
|
+
import { AuditEvent } from './types/auditEvent.js';
|
|
3
|
+
import { AuditParams } from './types/auditParams.js';
|
|
4
|
+
import './enums.js';
|
|
5
|
+
|
|
3
6
|
/**
|
|
4
7
|
* Represents an SDK client for interacting with audit-related functionality.
|
|
5
8
|
*
|
|
@@ -19,7 +22,7 @@ import { AuditEvent, AuditParams } from './types/index.js';
|
|
|
19
22
|
* });
|
|
20
23
|
* ```
|
|
21
24
|
*/
|
|
22
|
-
|
|
25
|
+
declare class Audit extends Client {
|
|
23
26
|
protected BASE_PATH: string;
|
|
24
27
|
authType: AuthenticationType;
|
|
25
28
|
/**
|
|
@@ -72,4 +75,5 @@ export declare class Audit extends Client {
|
|
|
72
75
|
*/
|
|
73
76
|
getEvent(eventId: string): Promise<AuditEvent>;
|
|
74
77
|
}
|
|
75
|
-
|
|
78
|
+
|
|
79
|
+
export { Audit };
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// lib/audit.ts
|
|
21
|
+
var audit_exports = {};
|
|
22
|
+
__export(audit_exports, {
|
|
23
|
+
Audit: () => Audit
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(audit_exports);
|
|
26
|
+
var import_server_client = require("@vonage/server-client");
|
|
27
|
+
var Audit = class extends import_server_client.Client {
|
|
28
|
+
// The base path for audit-related API endpoints
|
|
29
|
+
BASE_PATH = "beta";
|
|
30
|
+
// Authentication type for the client
|
|
31
|
+
authType = import_server_client.AuthenticationType.BASIC;
|
|
32
|
+
/**
|
|
33
|
+
* Retrieves a list of audit events based on specified parameters.
|
|
34
|
+
*
|
|
35
|
+
* @param {AuditParams} params - The query parameters for filtering audit events.
|
|
36
|
+
* @return { AsyncGenerator<AuditEvent>} An async generator that yields audit events.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* Retrieve a list of audit events
|
|
40
|
+
*
|
|
41
|
+
* ```ts
|
|
42
|
+
* const auditEvents = auditClient.getEvents({
|
|
43
|
+
* page: 1,
|
|
44
|
+
* size: 10,
|
|
45
|
+
* dateFrom: '2021-01-01T00:00:00Z',
|
|
46
|
+
* dateTo: '2021-01-31T23:59:59Z',
|
|
47
|
+
* eventType: 'message',
|
|
48
|
+
* search: 'search term'
|
|
49
|
+
* });
|
|
50
|
+
*
|
|
51
|
+
* for await (const event of auditEvents) {
|
|
52
|
+
* console.log(event.id);
|
|
53
|
+
* console.log(event.type);
|
|
54
|
+
* console.log(event.created);
|
|
55
|
+
* console.log(event.accountId);
|
|
56
|
+
* console.log(event.requestId);
|
|
57
|
+
* console.log(event.request);
|
|
58
|
+
* console.log(event.response);
|
|
59
|
+
* console.log(event.ipAddress);
|
|
60
|
+
* console.log(event.country);
|
|
61
|
+
* console.log(event.msisdn);
|
|
62
|
+
* }
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
async *getEvents(params) {
|
|
66
|
+
let totalPages = 0;
|
|
67
|
+
let page = params?.page || 1;
|
|
68
|
+
do {
|
|
69
|
+
params.page = page;
|
|
70
|
+
const resp = await this.sendGetRequest(
|
|
71
|
+
`${this.config.apiHost}/${this.BASE_PATH}/audit/events`,
|
|
72
|
+
import_server_client.Client.transformers.snakeCaseObjectKeys(params)
|
|
73
|
+
);
|
|
74
|
+
const events = (resp.data?._embedded?.events || []).map(
|
|
75
|
+
(event) => import_server_client.Client.transformers.camelCaseObjectKeys(event, true)
|
|
76
|
+
);
|
|
77
|
+
totalPages = resp.data?.page?.totalPages || 0;
|
|
78
|
+
yield* events;
|
|
79
|
+
page++;
|
|
80
|
+
} while (page <= totalPages);
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Retrieves a specific audit event by its ID.
|
|
84
|
+
*
|
|
85
|
+
* @param {string} eventId - The ID of the audit event to retrieve.
|
|
86
|
+
* @return {Promise<AuditEvent>} A promise that resolves to the retrieved audit event.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* Retrieve a specific audit event
|
|
90
|
+
*
|
|
91
|
+
* ```ts
|
|
92
|
+
* const auditEvent = await auditClient.getEvent('event-id');
|
|
93
|
+
* console.log(auditEvent.id);
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
async getEvent(eventId) {
|
|
97
|
+
const resp = await this.sendGetRequest(
|
|
98
|
+
`${this.config.apiHost}/${this.BASE_PATH}/audit/events/${eventId}`
|
|
99
|
+
);
|
|
100
|
+
return import_server_client.Client.transformers.camelCaseObjectKeys(
|
|
101
|
+
resp.data,
|
|
102
|
+
true
|
|
103
|
+
);
|
|
104
|
+
}
|
|
105
|
+
};
|
|
106
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
107
|
+
0 && (module.exports = {
|
|
108
|
+
Audit
|
|
109
|
+
});
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*
|
|
12
12
|
* @see Documentation {@link https://developer.vonage.com/en/audit/concepts/audit-events}
|
|
13
13
|
*/
|
|
14
|
-
|
|
14
|
+
declare enum AuditEventTypes {
|
|
15
15
|
/**
|
|
16
16
|
* User status updated.
|
|
17
17
|
*/
|
|
@@ -121,4 +121,5 @@ export declare enum AuditEventTypes {
|
|
|
121
121
|
*/
|
|
122
122
|
AUTORELOAD_DISABLE = "AUTORELOAD_DISABLE"
|
|
123
123
|
}
|
|
124
|
-
|
|
124
|
+
|
|
125
|
+
export { AuditEventTypes };
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// lib/enums.ts
|
|
21
|
+
var enums_exports = {};
|
|
22
|
+
__export(enums_exports, {
|
|
23
|
+
AuditEventTypes: () => AuditEventTypes
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(enums_exports);
|
|
26
|
+
var AuditEventTypes = /* @__PURE__ */ ((AuditEventTypes2) => {
|
|
27
|
+
AuditEventTypes2["USER_STATUS"] = "USER_STATUS";
|
|
28
|
+
AuditEventTypes2["USER_UPDATE"] = "USER_UPDATE";
|
|
29
|
+
AuditEventTypes2["USER_BILLING_UPDATE"] = "USER_BILLING_UPDATE";
|
|
30
|
+
AuditEventTypes2["USER_CREATE"] = "USER_CREATE";
|
|
31
|
+
AuditEventTypes2["USER_LOGIN"] = "USER_LOGIN";
|
|
32
|
+
AuditEventTypes2["USER_LOGOUT"] = "USER_LOGOUT";
|
|
33
|
+
AuditEventTypes2["USER_PRODUCT_SEARCH"] = "USER_PRODUCT_SEARCH";
|
|
34
|
+
AuditEventTypes2["USER_API_KEYS_UPDATE"] = "USER_API_KEYS_UPDATE";
|
|
35
|
+
AuditEventTypes2["ACCOUNT_SECRET_DELETE"] = "ACCOUNT_SECRET_DELETE";
|
|
36
|
+
AuditEventTypes2["ACCOUNT_SECRET_CREATE"] = "ACCOUNT_SECRET_CREATE";
|
|
37
|
+
AuditEventTypes2["ACCOUNT_UPDATE_SPAMMER"] = "ACCOUNT_UPDATE_SPAMMER";
|
|
38
|
+
AuditEventTypes2["ACCOUNT_UPDATE_SETTINGS_API"] = "ACCOUNT_UPDATE_SETTINGS_API";
|
|
39
|
+
AuditEventTypes2["NUMBER_ASSIGN"] = "NUMBER_ASSIGN";
|
|
40
|
+
AuditEventTypes2["NUMBER_UPDATED"] = "NUMBER_UPDATED";
|
|
41
|
+
AuditEventTypes2["NUMBER_RELEASE"] = "NUMBER_RELEASE";
|
|
42
|
+
AuditEventTypes2["NUMBER_LINKED"] = "NUMBER_LINKED";
|
|
43
|
+
AuditEventTypes2["NUMBER_UNLINKED"] = "NUMBER_UNLINKED";
|
|
44
|
+
AuditEventTypes2["APP_CREATE"] = "APP_CREATE";
|
|
45
|
+
AuditEventTypes2["APP_UPDATE"] = "APP_UPDATE";
|
|
46
|
+
AuditEventTypes2["APP_DELETE"] = "APP_DELETE";
|
|
47
|
+
AuditEventTypes2["APP_DISABLE"] = "APP_DISABLE";
|
|
48
|
+
AuditEventTypes2["APP_ENABLE"] = "APP_ENABLE";
|
|
49
|
+
AuditEventTypes2["IP_WHITELIST_CREATE"] = "IP_WHITELIST_CREATE";
|
|
50
|
+
AuditEventTypes2["IP_WHITELIST_DELETE"] = "IP_WHITELIST_DELETE";
|
|
51
|
+
AuditEventTypes2["AUTORELOAD_ENABLE"] = "AUTORELOAD_ENABLE";
|
|
52
|
+
AuditEventTypes2["AUTORELOAD_UPDATE"] = "AUTORELOAD_UPDATE";
|
|
53
|
+
AuditEventTypes2["AUTORELOAD_DISABLE"] = "AUTORELOAD_DISABLE";
|
|
54
|
+
return AuditEventTypes2;
|
|
55
|
+
})(AuditEventTypes || {});
|
|
56
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
57
|
+
0 && (module.exports = {
|
|
58
|
+
AuditEventTypes
|
|
59
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export { Audit } from './audit.js';
|
|
2
|
+
export { AuditEventTypes } from './enums.js';
|
|
3
|
+
export { AuditEvent } from './types/auditEvent.js';
|
|
4
|
+
export { AuditEventListResponse } from './types/auditEventListResponse.js';
|
|
5
|
+
export { AuditEventPage } from './types/auditEventPage.js';
|
|
6
|
+
export { AuditParams } from './types/auditParams.js';
|
|
7
|
+
export { AuditResponse } from './types/auditResponse.js';
|
|
8
|
+
export { AuditEventResponse } from './types/auditEventResponse.js';
|
|
9
|
+
import '@vonage/server-client';
|
|
10
|
+
import '@vonage/vetch';
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// lib/index.ts
|
|
21
|
+
var index_exports = {};
|
|
22
|
+
__export(index_exports, {
|
|
23
|
+
Audit: () => Audit,
|
|
24
|
+
AuditEventTypes: () => AuditEventTypes
|
|
25
|
+
});
|
|
26
|
+
module.exports = __toCommonJS(index_exports);
|
|
27
|
+
|
|
28
|
+
// lib/audit.ts
|
|
29
|
+
var import_server_client = require("@vonage/server-client");
|
|
30
|
+
var Audit = class extends import_server_client.Client {
|
|
31
|
+
// The base path for audit-related API endpoints
|
|
32
|
+
BASE_PATH = "beta";
|
|
33
|
+
// Authentication type for the client
|
|
34
|
+
authType = import_server_client.AuthenticationType.BASIC;
|
|
35
|
+
/**
|
|
36
|
+
* Retrieves a list of audit events based on specified parameters.
|
|
37
|
+
*
|
|
38
|
+
* @param {AuditParams} params - The query parameters for filtering audit events.
|
|
39
|
+
* @return { AsyncGenerator<AuditEvent>} An async generator that yields audit events.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* Retrieve a list of audit events
|
|
43
|
+
*
|
|
44
|
+
* ```ts
|
|
45
|
+
* const auditEvents = auditClient.getEvents({
|
|
46
|
+
* page: 1,
|
|
47
|
+
* size: 10,
|
|
48
|
+
* dateFrom: '2021-01-01T00:00:00Z',
|
|
49
|
+
* dateTo: '2021-01-31T23:59:59Z',
|
|
50
|
+
* eventType: 'message',
|
|
51
|
+
* search: 'search term'
|
|
52
|
+
* });
|
|
53
|
+
*
|
|
54
|
+
* for await (const event of auditEvents) {
|
|
55
|
+
* console.log(event.id);
|
|
56
|
+
* console.log(event.type);
|
|
57
|
+
* console.log(event.created);
|
|
58
|
+
* console.log(event.accountId);
|
|
59
|
+
* console.log(event.requestId);
|
|
60
|
+
* console.log(event.request);
|
|
61
|
+
* console.log(event.response);
|
|
62
|
+
* console.log(event.ipAddress);
|
|
63
|
+
* console.log(event.country);
|
|
64
|
+
* console.log(event.msisdn);
|
|
65
|
+
* }
|
|
66
|
+
* ```
|
|
67
|
+
*/
|
|
68
|
+
async *getEvents(params) {
|
|
69
|
+
let totalPages = 0;
|
|
70
|
+
let page = params?.page || 1;
|
|
71
|
+
do {
|
|
72
|
+
params.page = page;
|
|
73
|
+
const resp = await this.sendGetRequest(
|
|
74
|
+
`${this.config.apiHost}/${this.BASE_PATH}/audit/events`,
|
|
75
|
+
import_server_client.Client.transformers.snakeCaseObjectKeys(params)
|
|
76
|
+
);
|
|
77
|
+
const events = (resp.data?._embedded?.events || []).map(
|
|
78
|
+
(event) => import_server_client.Client.transformers.camelCaseObjectKeys(event, true)
|
|
79
|
+
);
|
|
80
|
+
totalPages = resp.data?.page?.totalPages || 0;
|
|
81
|
+
yield* events;
|
|
82
|
+
page++;
|
|
83
|
+
} while (page <= totalPages);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Retrieves a specific audit event by its ID.
|
|
87
|
+
*
|
|
88
|
+
* @param {string} eventId - The ID of the audit event to retrieve.
|
|
89
|
+
* @return {Promise<AuditEvent>} A promise that resolves to the retrieved audit event.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* Retrieve a specific audit event
|
|
93
|
+
*
|
|
94
|
+
* ```ts
|
|
95
|
+
* const auditEvent = await auditClient.getEvent('event-id');
|
|
96
|
+
* console.log(auditEvent.id);
|
|
97
|
+
* ```
|
|
98
|
+
*/
|
|
99
|
+
async getEvent(eventId) {
|
|
100
|
+
const resp = await this.sendGetRequest(
|
|
101
|
+
`${this.config.apiHost}/${this.BASE_PATH}/audit/events/${eventId}`
|
|
102
|
+
);
|
|
103
|
+
return import_server_client.Client.transformers.camelCaseObjectKeys(
|
|
104
|
+
resp.data,
|
|
105
|
+
true
|
|
106
|
+
);
|
|
107
|
+
}
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
// lib/enums.ts
|
|
111
|
+
var AuditEventTypes = /* @__PURE__ */ ((AuditEventTypes2) => {
|
|
112
|
+
AuditEventTypes2["USER_STATUS"] = "USER_STATUS";
|
|
113
|
+
AuditEventTypes2["USER_UPDATE"] = "USER_UPDATE";
|
|
114
|
+
AuditEventTypes2["USER_BILLING_UPDATE"] = "USER_BILLING_UPDATE";
|
|
115
|
+
AuditEventTypes2["USER_CREATE"] = "USER_CREATE";
|
|
116
|
+
AuditEventTypes2["USER_LOGIN"] = "USER_LOGIN";
|
|
117
|
+
AuditEventTypes2["USER_LOGOUT"] = "USER_LOGOUT";
|
|
118
|
+
AuditEventTypes2["USER_PRODUCT_SEARCH"] = "USER_PRODUCT_SEARCH";
|
|
119
|
+
AuditEventTypes2["USER_API_KEYS_UPDATE"] = "USER_API_KEYS_UPDATE";
|
|
120
|
+
AuditEventTypes2["ACCOUNT_SECRET_DELETE"] = "ACCOUNT_SECRET_DELETE";
|
|
121
|
+
AuditEventTypes2["ACCOUNT_SECRET_CREATE"] = "ACCOUNT_SECRET_CREATE";
|
|
122
|
+
AuditEventTypes2["ACCOUNT_UPDATE_SPAMMER"] = "ACCOUNT_UPDATE_SPAMMER";
|
|
123
|
+
AuditEventTypes2["ACCOUNT_UPDATE_SETTINGS_API"] = "ACCOUNT_UPDATE_SETTINGS_API";
|
|
124
|
+
AuditEventTypes2["NUMBER_ASSIGN"] = "NUMBER_ASSIGN";
|
|
125
|
+
AuditEventTypes2["NUMBER_UPDATED"] = "NUMBER_UPDATED";
|
|
126
|
+
AuditEventTypes2["NUMBER_RELEASE"] = "NUMBER_RELEASE";
|
|
127
|
+
AuditEventTypes2["NUMBER_LINKED"] = "NUMBER_LINKED";
|
|
128
|
+
AuditEventTypes2["NUMBER_UNLINKED"] = "NUMBER_UNLINKED";
|
|
129
|
+
AuditEventTypes2["APP_CREATE"] = "APP_CREATE";
|
|
130
|
+
AuditEventTypes2["APP_UPDATE"] = "APP_UPDATE";
|
|
131
|
+
AuditEventTypes2["APP_DELETE"] = "APP_DELETE";
|
|
132
|
+
AuditEventTypes2["APP_DISABLE"] = "APP_DISABLE";
|
|
133
|
+
AuditEventTypes2["APP_ENABLE"] = "APP_ENABLE";
|
|
134
|
+
AuditEventTypes2["IP_WHITELIST_CREATE"] = "IP_WHITELIST_CREATE";
|
|
135
|
+
AuditEventTypes2["IP_WHITELIST_DELETE"] = "IP_WHITELIST_DELETE";
|
|
136
|
+
AuditEventTypes2["AUTORELOAD_ENABLE"] = "AUTORELOAD_ENABLE";
|
|
137
|
+
AuditEventTypes2["AUTORELOAD_UPDATE"] = "AUTORELOAD_UPDATE";
|
|
138
|
+
AuditEventTypes2["AUTORELOAD_DISABLE"] = "AUTORELOAD_DISABLE";
|
|
139
|
+
return AuditEventTypes2;
|
|
140
|
+
})(AuditEventTypes || {});
|
|
141
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
142
|
+
0 && (module.exports = {
|
|
143
|
+
Audit,
|
|
144
|
+
AuditEventTypes
|
|
145
|
+
});
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { AuditEventTypes } from '../enums.js';
|
|
2
|
+
|
|
2
3
|
/**
|
|
3
4
|
* Represents an Audit Event.
|
|
4
5
|
*/
|
|
5
|
-
|
|
6
|
+
type AuditEvent = {
|
|
6
7
|
/**
|
|
7
8
|
* UUID of the audit event.
|
|
8
9
|
*/
|
|
@@ -45,4 +46,5 @@ export type AuditEvent = {
|
|
|
45
46
|
*/
|
|
46
47
|
context?: unknown;
|
|
47
48
|
};
|
|
48
|
-
|
|
49
|
+
|
|
50
|
+
export type { AuditEvent };
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// lib/types/auditEvent.ts
|
|
17
|
+
var auditEvent_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(auditEvent_exports);
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { APILinks } from '@vonage/server-client';
|
|
2
2
|
import { AuditEvent } from './auditEvent.js';
|
|
3
3
|
import { AuditEventPage } from './auditEventPage.js';
|
|
4
|
+
import '../enums.js';
|
|
5
|
+
|
|
4
6
|
/**
|
|
5
7
|
* Represents the response containing a list of audit events.
|
|
6
8
|
*
|
|
@@ -8,7 +10,7 @@ import { AuditEventPage } from './auditEventPage.js';
|
|
|
8
10
|
* Vonage API's will return information using `snake_case`. This represents the
|
|
9
11
|
* pure response before the client will transform the keys into `camelCase`
|
|
10
12
|
*/
|
|
11
|
-
|
|
13
|
+
type AuditEventListResponse = {
|
|
12
14
|
/**
|
|
13
15
|
* An object containing an array of audit events.
|
|
14
16
|
*/
|
|
@@ -24,4 +26,5 @@ export type AuditEventListResponse = {
|
|
|
24
26
|
*/
|
|
25
27
|
page: AuditEventPage;
|
|
26
28
|
};
|
|
27
|
-
|
|
29
|
+
|
|
30
|
+
export type { AuditEventListResponse };
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// lib/types/auditEventListResponse.ts
|
|
17
|
+
var auditEventListResponse_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(auditEventListResponse_exports);
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Represents information about the pagination of audit events.
|
|
3
3
|
*/
|
|
4
|
-
|
|
4
|
+
type AuditEventPage = {
|
|
5
5
|
/**
|
|
6
6
|
* The number of items per page.
|
|
7
7
|
*/
|
|
@@ -19,4 +19,5 @@ export type AuditEventPage = {
|
|
|
19
19
|
*/
|
|
20
20
|
number: number;
|
|
21
21
|
};
|
|
22
|
-
|
|
22
|
+
|
|
23
|
+
export type { AuditEventPage };
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// lib/types/auditEventPage.ts
|
|
17
|
+
var auditEventPage_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(auditEventPage_exports);
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { AuditEventTypes } from '../enums.js';
|
|
2
2
|
import { AuditEvent } from './auditEvent.js';
|
|
3
|
+
|
|
3
4
|
/**
|
|
4
5
|
* Represents an Audit Event.
|
|
5
6
|
*
|
|
@@ -7,7 +8,7 @@ import { AuditEvent } from './auditEvent.js';
|
|
|
7
8
|
* Vonage API's will return information using `snake_case`. This represents the
|
|
8
9
|
* pure response before the client will transform the keys into `camelCase`
|
|
9
10
|
*/
|
|
10
|
-
|
|
11
|
+
type AuditEventResponse = {
|
|
11
12
|
/**
|
|
12
13
|
* The type of the audit event.
|
|
13
14
|
*
|
|
@@ -38,4 +39,5 @@ export type AuditEventResponse = {
|
|
|
38
39
|
*/
|
|
39
40
|
source_country: string;
|
|
40
41
|
} & Pick<AuditEvent, 'id' | 'source' | 'context'>;
|
|
41
|
-
|
|
42
|
+
|
|
43
|
+
export type { AuditEventResponse };
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// lib/types/auditEventResponse.ts
|
|
17
|
+
var auditEventResponse_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(auditEventResponse_exports);
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { AuditEventTypes } from '../enums.js';
|
|
2
|
+
|
|
2
3
|
/**
|
|
3
4
|
* Represents parameters for querying audit events.
|
|
4
5
|
*/
|
|
5
|
-
|
|
6
|
+
type AuditParams = {
|
|
6
7
|
/**
|
|
7
8
|
* The type of the audit event to filter by.
|
|
8
9
|
*/
|
|
@@ -28,4 +29,5 @@ export type AuditParams = {
|
|
|
28
29
|
*/
|
|
29
30
|
size?: number;
|
|
30
31
|
};
|
|
31
|
-
|
|
32
|
+
|
|
33
|
+
export type { AuditParams };
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// lib/types/auditParams.ts
|
|
17
|
+
var auditParams_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(auditParams_exports);
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// lib/types/auditResponse.ts
|
|
17
|
+
var auditResponse_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(auditResponse_exports);
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export { AuditEvent } from './auditEvent.js';
|
|
2
|
+
export { AuditEventListResponse } from './auditEventListResponse.js';
|
|
3
|
+
export { AuditEventPage } from './auditEventPage.js';
|
|
4
|
+
export { AuditParams } from './auditParams.js';
|
|
5
|
+
export { AuditResponse } from './auditResponse.js';
|
|
6
|
+
export { AuditEventResponse } from './auditEventResponse.js';
|
|
7
|
+
import '../enums.js';
|
|
8
|
+
import '@vonage/server-client';
|
|
9
|
+
import '@vonage/vetch';
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __copyProps = (to, from, except, desc) => {
|
|
7
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
8
|
+
for (let key of __getOwnPropNames(from))
|
|
9
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
10
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
11
|
+
}
|
|
12
|
+
return to;
|
|
13
|
+
};
|
|
14
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
15
|
+
|
|
16
|
+
// lib/types/index.ts
|
|
17
|
+
var types_exports = {};
|
|
18
|
+
module.exports = __toCommonJS(types_exports);
|