@vonage/audit 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/audit.d.ts +9 -0
- package/dist/audit.js +26 -0
- package/dist/audit.js.map +1 -0
- package/dist/enums.d.ts +29 -0
- package/dist/enums.js +34 -0
- package/dist/enums.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +22 -0
- package/dist/index.js.map +1 -0
- package/dist/interfaces/auditEventListResponse.d.ts +10 -0
- package/dist/interfaces/auditEventListResponse.js +3 -0
- package/dist/interfaces/auditEventListResponse.js.map +1 -0
- package/dist/interfaces/auditEventPage.d.ts +6 -0
- package/dist/interfaces/auditEventPage.js +3 -0
- package/dist/interfaces/auditEventPage.js.map +1 -0
- package/dist/interfaces/auditResponse.d.ts +2 -0
- package/dist/interfaces/auditResponse.js +3 -0
- package/dist/interfaces/auditResponse.js.map +1 -0
- package/dist/types/auditEvent.d.ts +13 -0
- package/dist/types/auditEvent.js +3 -0
- package/dist/types/auditEvent.js.map +1 -0
- package/dist/types/auditParams.d.ts +9 -0
- package/dist/types/auditParams.js +3 -0
- package/dist/types/auditParams.js.map +1 -0
- package/package.json +1 -1
package/dist/audit.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { AuthenticationType, Client } from '@vonage/server-client';
|
|
2
|
+
import { AuditParams } from './types/auditParams';
|
|
3
|
+
import { AuditEvent } from './types/auditEvent';
|
|
4
|
+
export declare class Audit extends Client {
|
|
5
|
+
protected BASE_PATH: string;
|
|
6
|
+
protected authType: AuthenticationType;
|
|
7
|
+
getEvents(params: AuditParams): AsyncGenerator<AuditEvent, void, undefined>;
|
|
8
|
+
getEvent(eventId: string): Promise<AuditEvent>;
|
|
9
|
+
}
|
package/dist/audit.js
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Audit = void 0;
|
|
4
|
+
const server_client_1 = require("@vonage/server-client");
|
|
5
|
+
class Audit extends server_client_1.Client {
|
|
6
|
+
BASE_PATH = 'beta';
|
|
7
|
+
authType = server_client_1.AuthenticationType.BASIC;
|
|
8
|
+
async *getEvents(params) {
|
|
9
|
+
let totalPages = 0;
|
|
10
|
+
let page = params?.page || 1;
|
|
11
|
+
do {
|
|
12
|
+
params.page = page;
|
|
13
|
+
const resp = await this.sendGetRequest(`${this.config.apiHost}/${this.BASE_PATH}/audit/events`, server_client_1.Client.transformers.snakeCaseObjectKeys(params));
|
|
14
|
+
const events = (resp.data?._embedded.events || []).map((event) => server_client_1.Client.transformers.camelCaseObjectKeys(event, true));
|
|
15
|
+
totalPages = resp.data?.page?.totalPages || 0;
|
|
16
|
+
yield* events;
|
|
17
|
+
page++;
|
|
18
|
+
} while (page <= totalPages);
|
|
19
|
+
}
|
|
20
|
+
async getEvent(eventId) {
|
|
21
|
+
const resp = await this.sendGetRequest(`${this.config.apiHost}/${this.BASE_PATH}/audit/events/${eventId}`);
|
|
22
|
+
return server_client_1.Client.transformers.camelCaseObjectKeys(resp.data, true);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
exports.Audit = Audit;
|
|
26
|
+
//# sourceMappingURL=audit.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"audit.js","sourceRoot":"","sources":["../lib/audit.ts"],"names":[],"mappings":";;;AAAA,yDAAmE;AAKnE,MAAa,KAAM,SAAQ,sBAAM;IACrB,SAAS,GAAG,MAAM,CAAC;IACnB,QAAQ,GAAG,kCAAkB,CAAC,KAAK,CAAC;IAE9C,KAAK,CAAC,CAAC,SAAS,CACd,MAAmB;QAEnB,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,IAAI,IAAI,GAAG,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC;QAC7B,GAAG;YACD,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;YACnB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CACpC,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,eAAe,EACvD,sBAAM,CAAC,YAAY,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAChD,CAAC;YAEF,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC/D,sBAAM,CAAC,YAAY,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,CACrD,CAAC;YAEF,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,IAAI,CAAC,CAAC;YAE9C,KAAK,CAAC,CAAC,MAAM,CAAC;YACd,IAAI,EAAE,CAAC;SACR,QAAQ,IAAI,IAAI,UAAU,EAAE;IAC/B,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,OAAe;QACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CACpC,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,iBAAiB,OAAO,EAAE,CACnE,CAAC;QACF,OAAO,sBAAM,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC;CACF;AAjCD,sBAiCC"}
|
package/dist/enums.d.ts
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export declare enum AuditEventTypes {
|
|
2
|
+
'USER_STATUS' = "USER_STATUS",
|
|
3
|
+
'USER_UPDATE' = "USER_UPDATE",
|
|
4
|
+
'USER_BILLING_UPDATE' = "USER_BILLING_UPDATE",
|
|
5
|
+
'USER_CREATE' = "USER_CREATE",
|
|
6
|
+
'USER_LOGIN' = "USER_LOGIN",
|
|
7
|
+
'USER_LOGOUT' = "USER_LOGOUT",
|
|
8
|
+
'USER_PRODUCT_SEARCH' = "USER_PRODUCT_SEARCH",
|
|
9
|
+
'USER_API_KEYS_UPDATE' = "USER_API_KEYS_UPDATE",
|
|
10
|
+
'ACCOUNT_SECRET_DELETE' = "ACCOUNT_SECRET_DELETE",
|
|
11
|
+
'ACCOUNT_SECRET_CREATE' = "ACCOUNT_SECRET_CREATE",
|
|
12
|
+
'ACCOUNT_UPDATE_SPAMMER' = "ACCOUNT_UPDATE_SPAMMER",
|
|
13
|
+
'ACCOUNT_UPDATE_SETTINGS_API' = "ACCOUNT_UPDATE_SETTINGS_API",
|
|
14
|
+
'NUMBER_ASSIGN' = "NUMBER_ASSIGN",
|
|
15
|
+
'NUMBER_UPDATED' = "NUMBER_UPDATED",
|
|
16
|
+
'NUMBER_RELEASE' = "NUMBER_RELEASE",
|
|
17
|
+
'NUMBER_LINKED' = "NUMBER_LINKED",
|
|
18
|
+
'NUMBER_UNLINKED' = "NUMBER_UNLINKED",
|
|
19
|
+
'APP_CREATE' = "APP_CREATE",
|
|
20
|
+
'APP_UPDATE' = "APP_UPDATE",
|
|
21
|
+
'APP_DELETE' = "APP_DELETE",
|
|
22
|
+
'APP_DISABLE' = "APP_DISABLE",
|
|
23
|
+
'APP_ENABLE' = "APP_ENABLE",
|
|
24
|
+
'IP_WHITELIST_CREATE' = "IP_WHITELIST_CREATE",
|
|
25
|
+
'IP_WHITELIST_DELETE' = "IP_WHITELIST_DELETE",
|
|
26
|
+
'AUTORELOAD_ENABLE' = "AUTORELOAD_ENABLE",
|
|
27
|
+
'AUTORELOAD_UPDATE' = "AUTORELOAD_UPDATE",
|
|
28
|
+
'AUTORELOAD_DISABLE' = "AUTORELOAD_DISABLE"
|
|
29
|
+
}
|
package/dist/enums.js
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AuditEventTypes = void 0;
|
|
4
|
+
var AuditEventTypes;
|
|
5
|
+
(function (AuditEventTypes) {
|
|
6
|
+
AuditEventTypes["USER_STATUS"] = "USER_STATUS";
|
|
7
|
+
AuditEventTypes["USER_UPDATE"] = "USER_UPDATE";
|
|
8
|
+
AuditEventTypes["USER_BILLING_UPDATE"] = "USER_BILLING_UPDATE";
|
|
9
|
+
AuditEventTypes["USER_CREATE"] = "USER_CREATE";
|
|
10
|
+
AuditEventTypes["USER_LOGIN"] = "USER_LOGIN";
|
|
11
|
+
AuditEventTypes["USER_LOGOUT"] = "USER_LOGOUT";
|
|
12
|
+
AuditEventTypes["USER_PRODUCT_SEARCH"] = "USER_PRODUCT_SEARCH";
|
|
13
|
+
AuditEventTypes["USER_API_KEYS_UPDATE"] = "USER_API_KEYS_UPDATE";
|
|
14
|
+
AuditEventTypes["ACCOUNT_SECRET_DELETE"] = "ACCOUNT_SECRET_DELETE";
|
|
15
|
+
AuditEventTypes["ACCOUNT_SECRET_CREATE"] = "ACCOUNT_SECRET_CREATE";
|
|
16
|
+
AuditEventTypes["ACCOUNT_UPDATE_SPAMMER"] = "ACCOUNT_UPDATE_SPAMMER";
|
|
17
|
+
AuditEventTypes["ACCOUNT_UPDATE_SETTINGS_API"] = "ACCOUNT_UPDATE_SETTINGS_API";
|
|
18
|
+
AuditEventTypes["NUMBER_ASSIGN"] = "NUMBER_ASSIGN";
|
|
19
|
+
AuditEventTypes["NUMBER_UPDATED"] = "NUMBER_UPDATED";
|
|
20
|
+
AuditEventTypes["NUMBER_RELEASE"] = "NUMBER_RELEASE";
|
|
21
|
+
AuditEventTypes["NUMBER_LINKED"] = "NUMBER_LINKED";
|
|
22
|
+
AuditEventTypes["NUMBER_UNLINKED"] = "NUMBER_UNLINKED";
|
|
23
|
+
AuditEventTypes["APP_CREATE"] = "APP_CREATE";
|
|
24
|
+
AuditEventTypes["APP_UPDATE"] = "APP_UPDATE";
|
|
25
|
+
AuditEventTypes["APP_DELETE"] = "APP_DELETE";
|
|
26
|
+
AuditEventTypes["APP_DISABLE"] = "APP_DISABLE";
|
|
27
|
+
AuditEventTypes["APP_ENABLE"] = "APP_ENABLE";
|
|
28
|
+
AuditEventTypes["IP_WHITELIST_CREATE"] = "IP_WHITELIST_CREATE";
|
|
29
|
+
AuditEventTypes["IP_WHITELIST_DELETE"] = "IP_WHITELIST_DELETE";
|
|
30
|
+
AuditEventTypes["AUTORELOAD_ENABLE"] = "AUTORELOAD_ENABLE";
|
|
31
|
+
AuditEventTypes["AUTORELOAD_UPDATE"] = "AUTORELOAD_UPDATE";
|
|
32
|
+
AuditEventTypes["AUTORELOAD_DISABLE"] = "AUTORELOAD_DISABLE";
|
|
33
|
+
})(AuditEventTypes = exports.AuditEventTypes || (exports.AuditEventTypes = {}));
|
|
34
|
+
//# sourceMappingURL=enums.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"enums.js","sourceRoot":"","sources":["../lib/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,eA4BX;AA5BD,WAAY,eAAe;IACvB,8CAA6B,CAAA;IAC7B,8CAA6B,CAAA;IAC7B,8DAA6C,CAAA;IAC7C,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,8CAA6B,CAAA;IAC7B,8DAA6C,CAAA;IAC7C,gEAA+C,CAAA;IAC/C,kEAAiD,CAAA;IACjD,kEAAiD,CAAA;IACjD,oEAAmD,CAAA;IACnD,8EAA6D,CAAA;IAC7D,kDAAiC,CAAA;IACjC,oDAAmC,CAAA;IACnC,oDAAmC,CAAA;IACnC,kDAAiC,CAAA;IACjC,sDAAqC,CAAA;IACrC,4CAA2B,CAAA;IAC3B,4CAA2B,CAAA;IAC3B,4CAA2B,CAAA;IAC3B,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,8DAA6C,CAAA;IAC7C,8DAA6C,CAAA;IAC7C,0DAAyC,CAAA;IACzC,0DAAyC,CAAA;IACzC,4DAA2C,CAAA;AAC/C,CAAC,EA5BW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA4B1B"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export { Audit } from './audit';
|
|
2
|
+
export * from './enums';
|
|
3
|
+
export * from './interfaces/auditResponse';
|
|
4
|
+
export { AuditParams } from './types/auditParams';
|
|
5
|
+
export { AuditEvent } from './types/auditEvent';
|
|
6
|
+
export { AuditEventPage } from './interfaces/auditEventPage';
|
|
7
|
+
export { AuditEventListResponse } from './interfaces/auditEventListResponse';
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.Audit = void 0;
|
|
18
|
+
var audit_1 = require("./audit");
|
|
19
|
+
Object.defineProperty(exports, "Audit", { enumerable: true, get: function () { return audit_1.Audit; } });
|
|
20
|
+
__exportStar(require("./enums"), exports);
|
|
21
|
+
__exportStar(require("./interfaces/auditResponse"), exports);
|
|
22
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iCAAgC;AAAvB,8FAAA,KAAK,OAAA;AAEd,0CAAwB;AAExB,6DAA2C"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { APILinks } from '@vonage/server-client';
|
|
2
|
+
import { AuditEvent } from '../types/auditEvent';
|
|
3
|
+
import { AuditEventPage } from './auditEventPage';
|
|
4
|
+
export interface AuditEventListResponse {
|
|
5
|
+
_embedded?: {
|
|
6
|
+
events: AuditEvent[];
|
|
7
|
+
};
|
|
8
|
+
_links: APILinks;
|
|
9
|
+
page: AuditEventPage;
|
|
10
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auditEventListResponse.js","sourceRoot":"","sources":["../../lib/interfaces/auditEventListResponse.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auditEventPage.js","sourceRoot":"","sources":["../../lib/interfaces/auditEventPage.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auditResponse.js","sourceRoot":"","sources":["../../lib/interfaces/auditResponse.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { AuditEventTypes } from '../enums';
|
|
2
|
+
export type AuditEvent = {
|
|
3
|
+
id: string;
|
|
4
|
+
eventType: AuditEventTypes;
|
|
5
|
+
createdAt: string;
|
|
6
|
+
userEmail?: string;
|
|
7
|
+
userId?: string;
|
|
8
|
+
accountId: string;
|
|
9
|
+
source: string;
|
|
10
|
+
sourceDescription: string;
|
|
11
|
+
sourceCountry: string;
|
|
12
|
+
context?: object;
|
|
13
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auditEvent.js","sourceRoot":"","sources":["../../lib/types/auditEvent.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auditParams.js","sourceRoot":"","sources":["../../lib/types/auditParams.ts"],"names":[],"mappings":""}
|