@vonage/audit 1.8.2 → 1.10.0

package/dist/audit.d.ts

@@ -1,9 +1,74 @@
 import { AuthenticationType, Client } from '@vonage/server-client';
-import { AuditParams } from './types/auditParams';
-import { AuditEvent } from './types/auditEvent';
+import { AuditEvent, AuditParams } from './types';
+/**
+ * Represents an SDK client for interacting with audit-related functionality.
+ *
+ * @remarks
+ * This client is only available as a standalone client. It cannot be
+ * instantiated from a Vonage client.
+ *
+ * @example
+ * Create a standalone Audit client
+ *
+ * ```ts
+ * import { Audit } from '@vonage/audit';
+ *
+ * const auditClient = new Audit({
+ *  apiKey: VONAGE_API_KEY,
+ *  apiSecret: VONAGE_API_SECRET
+ * });
+ * ```
+ */
 export declare class Audit extends Client {
     protected BASE_PATH: string;
-    protected authType: AuthenticationType;
+    authType: AuthenticationType;
+    /**
+     * Retrieves a list of audit events based on specified parameters.
+     *
+     * @param {AuditParams} params - The query parameters for filtering audit events.
+     * @return { AsyncGenerator<AuditEvent>} An async generator that yields audit events.
+     *
+     * @example
+     * Retrieve a list of audit events
+     *
+     * ```ts
+     * const auditEvents = auditClient.getEvents({
+     *   page: 1,
+     *   size: 10,
+     *   dateFrom: '2021-01-01T00:00:00Z',
+     *   dateTo: '2021-01-31T23:59:59Z',
+     *   eventType: 'message',
+     *   search: 'search term'
+     * });
+     *
+     * for await (const event of auditEvents) {
+     *   console.log(event.id);
+     *   console.log(event.type);
+     *   console.log(event.created);
+     *   console.log(event.accountId);
+     *   console.log(event.requestId);
+     *   console.log(event.request);
+     *   console.log(event.response);
+     *   console.log(event.ipAddress);
+     *   console.log(event.country);
+     *   console.log(event.msisdn);
+     * }
+     * ```
+     */
     getEvents(params: AuditParams): AsyncGenerator<AuditEvent, void, undefined>;
+    /**
+     * Retrieves a specific audit event by its ID.
+     *
+     * @param {string} eventId - The ID of the audit event to retrieve.
+     * @return {Promise<AuditEvent>} A promise that resolves to the retrieved audit event.
+     *
+     * @example
+     * Retrieve a specific audit event
+     *
+     * ```ts
+     * const auditEvent = await auditClient.getEvent('event-id');
+     * console.log(auditEvent.id);
+     * ```
+     */
     getEvent(eventId: string): Promise<AuditEvent>;
 }

package/dist/audit.js

@@ -2,25 +2,95 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Audit = void 0;
 const server_client_1 = require("@vonage/server-client");
+/**
+ * Represents an SDK client for interacting with audit-related functionality.
+ *
+ * @remarks
+ * This client is only available as a standalone client. It cannot be
+ * instantiated from a Vonage client.
+ *
+ * @example
+ * Create a standalone Audit client
+ *
+ * ```ts
+ * import { Audit } from '@vonage/audit';
+ *
+ * const auditClient = new Audit({
+ *  apiKey: VONAGE_API_KEY,
+ *  apiSecret: VONAGE_API_SECRET
+ * });
+ * ```
+ */
 class Audit extends server_client_1.Client {
-    BASE_PATH = 'beta';
-    authType = server_client_1.AuthenticationType.BASIC;
+    constructor() {
+        super(...arguments);
+        // The base path for audit-related API endpoints
+        this.BASE_PATH = 'beta';
+        // Authentication type for the client
+        this.authType = server_client_1.AuthenticationType.BASIC;
+    }
+    /**
+     * Retrieves a list of audit events based on specified parameters.
+     *
+     * @param {AuditParams} params - The query parameters for filtering audit events.
+     * @return { AsyncGenerator<AuditEvent>} An async generator that yields audit events.
+     *
+     * @example
+     * Retrieve a list of audit events
+     *
+     * ```ts
+     * const auditEvents = auditClient.getEvents({
+     *   page: 1,
+     *   size: 10,
+     *   dateFrom: '2021-01-01T00:00:00Z',
+     *   dateTo: '2021-01-31T23:59:59Z',
+     *   eventType: 'message',
+     *   search: 'search term'
+     * });
+     *
+     * for await (const event of auditEvents) {
+     *   console.log(event.id);
+     *   console.log(event.type);
+     *   console.log(event.created);
+     *   console.log(event.accountId);
+     *   console.log(event.requestId);
+     *   console.log(event.request);
+     *   console.log(event.response);
+     *   console.log(event.ipAddress);
+     *   console.log(event.country);
+     *   console.log(event.msisdn);
+     * }
+     * ```
+     */
     async *getEvents(params) {
         let totalPages = 0;
         let page = params?.page || 1;
         do {
             params.page = page;
             const resp = await this.sendGetRequest(`${this.config.apiHost}/${this.BASE_PATH}/audit/events`, server_client_1.Client.transformers.snakeCaseObjectKeys(params));
-            const events = (resp.data?._embedded.events || []).map((event) => server_client_1.Client.transformers.camelCaseObjectKeys(event, true));
+            const events = (resp.data?._embedded?.events || []).map((event) => server_client_1.Client.transformers.camelCaseObjectKeys(event, true));
             totalPages = resp.data?.page?.totalPages || 0;
             yield* events;
             page++;
         } while (page <= totalPages);
     }
+    /**
+     * Retrieves a specific audit event by its ID.
+     *
+     * @param {string} eventId - The ID of the audit event to retrieve.
+     * @return {Promise<AuditEvent>} A promise that resolves to the retrieved audit event.
+     *
+     * @example
+     * Retrieve a specific audit event
+     *
+     * ```ts
+     * const auditEvent = await auditClient.getEvent('event-id');
+     * console.log(auditEvent.id);
+     * ```
+     */
     async getEvent(eventId) {
         const resp = await this.sendGetRequest(`${this.config.apiHost}/${this.BASE_PATH}/audit/events/${eventId}`);
         return server_client_1.Client.transformers.camelCaseObjectKeys(resp.data, true);
     }
 }
 exports.Audit = Audit;
-//# sourceMappingURL=audit.js.map

package/dist/enums.d.ts

@@ -1,29 +1,123 @@
+/**
+ * Audit Events are generated automatically by Vonage as the user interacts with
+ * either a Vonage API or the Vonage Dashboard. Each Audit Event object has a
+ * type and associated metadata.
+ *
+ * @remarks
+ *
+ * The list of supported event types does change from time to time. For
+ * this reason the OPTIONS method is provided to return event types. You can
+ * see how to return the definitive list of event types from the {@link https://developer.vonage.com/en/audit/code-snippets/get-event-types}
+ *
+ * @see Documentation {@link https://developer.vonage.com/en/audit/concepts/audit-events}
+ */
 export declare enum AuditEventTypes {
-    'USER_STATUS' = "USER_STATUS",
-    'USER_UPDATE' = "USER_UPDATE",
-    'USER_BILLING_UPDATE' = "USER_BILLING_UPDATE",
-    'USER_CREATE' = "USER_CREATE",
-    'USER_LOGIN' = "USER_LOGIN",
-    'USER_LOGOUT' = "USER_LOGOUT",
-    'USER_PRODUCT_SEARCH' = "USER_PRODUCT_SEARCH",
-    'USER_API_KEYS_UPDATE' = "USER_API_KEYS_UPDATE",
-    'ACCOUNT_SECRET_DELETE' = "ACCOUNT_SECRET_DELETE",
-    'ACCOUNT_SECRET_CREATE' = "ACCOUNT_SECRET_CREATE",
-    'ACCOUNT_UPDATE_SPAMMER' = "ACCOUNT_UPDATE_SPAMMER",
-    'ACCOUNT_UPDATE_SETTINGS_API' = "ACCOUNT_UPDATE_SETTINGS_API",
-    'NUMBER_ASSIGN' = "NUMBER_ASSIGN",
-    'NUMBER_UPDATED' = "NUMBER_UPDATED",
-    'NUMBER_RELEASE' = "NUMBER_RELEASE",
-    'NUMBER_LINKED' = "NUMBER_LINKED",
-    'NUMBER_UNLINKED' = "NUMBER_UNLINKED",
-    'APP_CREATE' = "APP_CREATE",
-    'APP_UPDATE' = "APP_UPDATE",
-    'APP_DELETE' = "APP_DELETE",
-    'APP_DISABLE' = "APP_DISABLE",
-    'APP_ENABLE' = "APP_ENABLE",
-    'IP_WHITELIST_CREATE' = "IP_WHITELIST_CREATE",
-    'IP_WHITELIST_DELETE' = "IP_WHITELIST_DELETE",
-    'AUTORELOAD_ENABLE' = "AUTORELOAD_ENABLE",
-    'AUTORELOAD_UPDATE' = "AUTORELOAD_UPDATE",
-    'AUTORELOAD_DISABLE' = "AUTORELOAD_DISABLE"
+    /**
+     * User status updated.
+     */
+    USER_STATUS = "USER_STATUS",
+    /**
+     * User updated.
+     */
+    USER_UPDATE = "USER_UPDATE",
+    /**
+     * User billing updated.
+     */
+    USER_BILLING_UPDATE = "USER_BILLING_UPDATE",
+    /**
+     * User created.
+     */
+    USER_CREATE = "USER_CREATE",
+    /**
+     * User login (Premium Support only).
+     */
+    USER_LOGIN = "USER_LOGIN",
+    /**
+     * User logout (Premium Support only).
+     */
+    USER_LOGOUT = "USER_LOGOUT",
+    /**
+     * Relates to searching for CDRs or logs in Dashboard.
+     */
+    USER_PRODUCT_SEARCH = "USER_PRODUCT_SEARCH",
+    /**
+     * Sub-accounts for user updated.
+     */
+    USER_API_KEYS_UPDATE = "USER_API_KEYS_UPDATE",
+    /**
+     * Secret Rotation operation.
+     */
+    ACCOUNT_SECRET_DELETE = "ACCOUNT_SECRET_DELETE",
+    /**
+     * Secret Rotation operation.
+     */
+    ACCOUNT_SECRET_CREATE = "ACCOUNT_SECRET_CREATE",
+    /**
+     * Account Settings updated via API.
+     */
+    ACCOUNT_UPDATE_SPAMMER = "ACCOUNT_UPDATE_SPAMMER",
+    /**
+     * Account Settings updated via API.
+     */
+    ACCOUNT_UPDATE_SETTINGS_API = "ACCOUNT_UPDATE_SETTINGS_API",
+    /**
+     * Number assigned.
+     */
+    NUMBER_ASSIGN = "NUMBER_ASSIGN",
+    /**
+     * Number updated.
+     */
+    NUMBER_UPDATED = "NUMBER_UPDATED",
+    /**
+     * Number released.
+     */
+    NUMBER_RELEASE = "NUMBER_RELEASE",
+    /**
+     * Number linked to Vonage application.
+     */
+    NUMBER_LINKED = "NUMBER_LINKED",
+    /**
+     * Number unlinked from Vonage application.
+     */
+    NUMBER_UNLINKED = "NUMBER_UNLINKED",
+    /**
+     * App created.
+     */
+    APP_CREATE = "APP_CREATE",
+    /**
+     * App updated.
+     */
+    APP_UPDATE = "APP_UPDATE",
+    /**
+     * App deleted.
+     */
+    APP_DELETE = "APP_DELETE",
+    /**
+     * App disabled.
+     */
+    APP_DISABLE = "APP_DISABLE",
+    /**
+     * App enabled.
+     */
+    APP_ENABLE = "APP_ENABLE",
+    /**
+     * Whitelist IP added.
+     */
+    IP_WHITELIST_CREATE = "IP_WHITELIST_CREATE",
+    /**
+     * Whitelist IP deleted.
+     */
+    IP_WHITELIST_DELETE = "IP_WHITELIST_DELETE",
+    /**
+     * Automatic reload enabled.
+     */
+    AUTORELOAD_ENABLE = "AUTORELOAD_ENABLE",
+    /**
+     * Automatic reload settings updated.
+     */
+    AUTORELOAD_UPDATE = "AUTORELOAD_UPDATE",
+    /**
+     * Automatic reload disabled.
+     */
+    AUTORELOAD_DISABLE = "AUTORELOAD_DISABLE"
 }

package/dist/enums.js

@@ -1,34 +1,127 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuditEventTypes = void 0;
+/**
+ * Audit Events are generated automatically by Vonage as the user interacts with
+ * either a Vonage API or the Vonage Dashboard. Each Audit Event object has a
+ * type and associated metadata.
+ *
+ * @remarks
+ *
+ * The list of supported event types does change from time to time. For
+ * this reason the OPTIONS method is provided to return event types. You can
+ * see how to return the definitive list of event types from the {@link https://developer.vonage.com/en/audit/code-snippets/get-event-types}
+ *
+ * @see Documentation {@link https://developer.vonage.com/en/audit/concepts/audit-events}
+ */
 var AuditEventTypes;
 (function (AuditEventTypes) {
+    /**
+     * User status updated.
+     */
     AuditEventTypes["USER_STATUS"] = "USER_STATUS";
+    /**
+     * User updated.
+     */
     AuditEventTypes["USER_UPDATE"] = "USER_UPDATE";
+    /**
+     * User billing updated.
+     */
     AuditEventTypes["USER_BILLING_UPDATE"] = "USER_BILLING_UPDATE";
+    /**
+     * User created.
+     */
     AuditEventTypes["USER_CREATE"] = "USER_CREATE";
+    /**
+     * User login (Premium Support only).
+     */
     AuditEventTypes["USER_LOGIN"] = "USER_LOGIN";
+    /**
+     * User logout (Premium Support only).
+     */
     AuditEventTypes["USER_LOGOUT"] = "USER_LOGOUT";
+    /**
+     * Relates to searching for CDRs or logs in Dashboard.
+     */
     AuditEventTypes["USER_PRODUCT_SEARCH"] = "USER_PRODUCT_SEARCH";
+    /**
+     * Sub-accounts for user updated.
+     */
     AuditEventTypes["USER_API_KEYS_UPDATE"] = "USER_API_KEYS_UPDATE";
+    /**
+     * Secret Rotation operation.
+     */
     AuditEventTypes["ACCOUNT_SECRET_DELETE"] = "ACCOUNT_SECRET_DELETE";
+    /**
+     * Secret Rotation operation.
+     */
     AuditEventTypes["ACCOUNT_SECRET_CREATE"] = "ACCOUNT_SECRET_CREATE";
+    /**
+     * Account Settings updated via API.
+     */
     AuditEventTypes["ACCOUNT_UPDATE_SPAMMER"] = "ACCOUNT_UPDATE_SPAMMER";
+    /**
+     * Account Settings updated via API.
+     */
     AuditEventTypes["ACCOUNT_UPDATE_SETTINGS_API"] = "ACCOUNT_UPDATE_SETTINGS_API";
+    /**
+     * Number assigned.
+     */
     AuditEventTypes["NUMBER_ASSIGN"] = "NUMBER_ASSIGN";
+    /**
+     * Number updated.
+     */
     AuditEventTypes["NUMBER_UPDATED"] = "NUMBER_UPDATED";
+    /**
+     * Number released.
+     */
     AuditEventTypes["NUMBER_RELEASE"] = "NUMBER_RELEASE";
+    /**
+     * Number linked to Vonage application.
+     */
     AuditEventTypes["NUMBER_LINKED"] = "NUMBER_LINKED";
+    /**
+     * Number unlinked from Vonage application.
+     */
     AuditEventTypes["NUMBER_UNLINKED"] = "NUMBER_UNLINKED";
+    /**
+     * App created.
+     */
     AuditEventTypes["APP_CREATE"] = "APP_CREATE";
+    /**
+     * App updated.
+     */
     AuditEventTypes["APP_UPDATE"] = "APP_UPDATE";
+    /**
+     * App deleted.
+     */
     AuditEventTypes["APP_DELETE"] = "APP_DELETE";
+    /**
+     * App disabled.
+     */
     AuditEventTypes["APP_DISABLE"] = "APP_DISABLE";
+    /**
+     * App enabled.
+     */
     AuditEventTypes["APP_ENABLE"] = "APP_ENABLE";
+    /**
+     * Whitelist IP added.
+     */
     AuditEventTypes["IP_WHITELIST_CREATE"] = "IP_WHITELIST_CREATE";
+    /**
+     * Whitelist IP deleted.
+     */
     AuditEventTypes["IP_WHITELIST_DELETE"] = "IP_WHITELIST_DELETE";
+    /**
+     * Automatic reload enabled.
+     */
     AuditEventTypes["AUTORELOAD_ENABLE"] = "AUTORELOAD_ENABLE";
+    /**
+     * Automatic reload settings updated.
+     */
     AuditEventTypes["AUTORELOAD_UPDATE"] = "AUTORELOAD_UPDATE";
+    /**
+     * Automatic reload disabled.
+     */
     AuditEventTypes["AUTORELOAD_DISABLE"] = "AUTORELOAD_DISABLE";
 })(AuditEventTypes || (exports.AuditEventTypes = AuditEventTypes = {}));
-//# sourceMappingURL=enums.js.map

package/dist/index.d.ts

@@ -1,7 +1,3 @@
-export { Audit } from './audit';
+export * from './audit';
 export * from './enums';
-export * from './interfaces/auditResponse';
-export { AuditParams } from './types/auditParams';
-export { AuditEvent } from './types/auditEvent';
-export { AuditEventPage } from './interfaces/auditEventPage';
-export { AuditEventListResponse } from './interfaces/auditEventListResponse';
+export * from './types';

package/dist/index.js

@@ -14,9 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Audit = void 0;
-var audit_1 = require("./audit");
-Object.defineProperty(exports, "Audit", { enumerable: true, get: function () { return audit_1.Audit; } });
+__exportStar(require("./audit"), exports);
 __exportStar(require("./enums"), exports);
-__exportStar(require("./interfaces/auditResponse"), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require("./types"), exports);

package/dist/types/auditEvent.d.ts

@@ -1,13 +1,47 @@
 import { AuditEventTypes } from '../enums';
+/**
+ * Represents an Audit Event.
+ */
 export type AuditEvent = {
+    /**
+     * UUID of the audit event.
+     */
     id: string;
-    eventType: AuditEventTypes;
+    /**
+     * The type of the audit event.
+     *
+     */
+    eventType: AuditEventTypes | string;
+    /**
+     * The date when the audit event was created.
+     */
     createdAt: string;
+    /**
+     * Email of the user whose account the audit event is associated with.
+     */
     userEmail?: string;
+    /**
+     * The ID of the user that the audit event is associated with.
+     */
     userId?: string;
+    /**
+     * The API_KEY of the Vonage API account that the audit event is associated with.
+     */
     accountId: string;
-    source: string;
-    sourceDescription: string;
+    /**
+     * The source of the event.
+     */
+    source: 'CD' | 'DEVAPI';
+    /**
+     * Description of the audit event source.
+     */
+    sourceDescription: 'Customer Dashboard' | 'Developer API';
+    /**
+     * ISO 3166-1 Alpha-2 country code recorded for the event.
+     */
     sourceCountry: string;
-    context?: object;
+    /**
+     * Additional context information for the audit event.
+     */
+    context?: unknown;
 };

package/dist/types/auditEvent.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=auditEvent.js.map

package/dist/types/auditEventListResponse.d.ts

@@ -0,0 +1,26 @@
+import { APILinks } from '@vonage/server-client';
+import { AuditEvent } from './auditEvent';
+import { AuditEventPage } from './auditEventPage';
+/**
+ * Represents the response containing a list of audit events.
+ *
+ * @remarks
+ * Vonage API's will return information using `snake_case`. This represents the
+ * pure response before the client will transform the keys into `camelCase`
+ */
+export type AuditEventListResponse = {
+    /**
+     * An object containing an array of audit events.
+     */
+    _embedded?: {
+        events: AuditEvent[];
+    };
+    /**
+     * Links associated with the API response.
+     */
+    _links: APILinks;
+    /**
+     * Information about the pagination and page details.
+     */
+    page: AuditEventPage;
+};

package/dist/{interfaces → types}/auditEventListResponse.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=auditEventListResponse.js.map

package/dist/types/auditEventPage.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents information about the pagination of audit events.
+ */
+export type AuditEventPage = {
+    /**
+     * The number of items per page.
+     */
+    size: number;
+    /**
+     * The total number of elements across all pages.
+     */
+    totalElements: number;
+    /**
+     * The total number of pages available.
+     */
+    totalPages: number;
+    /**
+     * The current page number.
+     */
+    number: number;
+};

package/dist/{interfaces → types}/auditEventPage.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=auditEventPage.js.map

package/dist/types/auditEventResponse.d.ts

@@ -0,0 +1,40 @@
+import { AuditEventTypes } from '../enums';
+import { AuditEvent } from './auditEvent';
+/**
+ * Represents an Audit Event.
+ *
+ * @remarks
+ * Vonage API's will return information using `snake_case`. This represents the
+ * pure response before the client will transform the keys into `camelCase`
+ */
+export type AuditEventResponse = {
+    /**
+     * The type of the audit event.
+     *
+     */
+    event_type: AuditEventTypes | string;
+    /**
+     * The date when the audit event was created.
+     */
+    created_at: string;
+    /**
+     * Email of the user whose account the audit event is associated with.
+     */
+    user_email?: string;
+    /**
+     * The ID of the user that the audit event is associated with.
+     */
+    user_id?: string;
+    /**
+     * The API_KEY of the Vonage API account that the audit event is associated with.
+     */
+    account_id: string;
+    /**
+     * Description of the audit event source.
+     */
+    source_description: Pick<AuditEvent, 'sourceDescription'>;
+    /**
+     * ISO 3166-1 Alpha-2 country code recorded for the event.
+     */
+    source_country: string;
+} & Pick<AuditEvent, 'id' | 'source' | 'context'>;

package/dist/types/auditEventResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/auditParams.d.ts

@@ -1,9 +1,30 @@
 import { AuditEventTypes } from '../enums';
+/**
+ * Represents parameters for querying audit events.
+ */
 export type AuditParams = {
-    eventType?: AuditEventTypes;
+    /**
+     * The type of the audit event to filter by.
+     */
+    eventType?: AuditEventTypes | string;
+    /**
+     * The start date for the audit event query.
+     */
     dateFrom?: string;
+    /**
+     * The end date for the audit event query.
+     */
     dateTo?: string;
+    /**
+     * Text to search within audit event descriptions.
+     */
     searchText?: string;
+    /**
+     * The page number for paginated results.
+     */
     page?: number;
+    /**
+     * The number of items per page.
+     */
     size?: number;
 };

package/dist/types/auditParams.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=auditParams.js.map

package/dist/{interfaces → types}/auditResponse.d.ts

@@ -1,2 +1,5 @@
 import { VetchResponse } from '@vonage/vetch';
+/**
+ * @deprecated this is not used
+ */
 export type AuditResponse<T> = VetchResponse<T>;

package/dist/{interfaces → types}/auditResponse.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=auditResponse.js.map

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './auditEvent';
+export * from './auditEventListResponse';
+export * from './auditEventPage';
+export * from './auditParams';
+export * from './auditResponse';
+export * from './auditEventResponse';

package/dist/types/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./auditEvent"), exports);
+__exportStar(require("./auditEventListResponse"), exports);
+__exportStar(require("./auditEventPage"), exports);
+__exportStar(require("./auditParams"), exports);
+__exportStar(require("./auditResponse"), exports);
+__exportStar(require("./auditEventResponse"), exports);

package/package.json

@@ -1,6 +1,7 @@
 {
+  "$schema": "https://json.schemastore.org/package.json",
   "name": "@vonage/audit",
-  "version": "1.8.2",
+  "version": "1.10.0",
   "description": "Vonage Audit SDK Package",
   "homepage": "https://github.com/vonage/vonage-node-sdk/tree/master/packages/audit#readme",
   "bugs": {
@@ -11,7 +12,12 @@
     "url": "git+https://github.com/Vonage/vonage-node-sdk.git"
   },
   "license": "Apache-2.0",
-  "author": "Chuck \"MANCHUCK\" Reeves",
+  "contributors": [
+    {
+      "name": "Chuck \"MANCHUCK\" Reeves",
+      "url": "https://github.com/manchuck"
+    }
+  ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "directories": {
@@ -24,15 +30,16 @@
   "scripts": {
     "build": "npm run clean && npm run compile",
     "clean": "npx shx rm -rf dist tsconfig.tsbuildinfo",
-    "compile": "npx tsc --build --verbose"
+    "compile": "npx tsc --build --verbose",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@vonage/auth": "^1.6.0",
-    "@vonage/server-client": "^1.8.2",
-    "@vonage/vetch": "^1.5.1"
+    "@vonage/auth": "^1.8.0",
+    "@vonage/server-client": "^1.10.0",
+    "@vonage/vetch": "^1.7.0"
   },
   "devDependencies": {
-    "nock": "^13.3.1"
+    "nock": "^13.3.4"
   },
   "publishConfig": {
     "directory": "dist"

package/dist/audit.js.map

@@ -1 +0,0 @@
-{"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.js.map

@@ -1 +0,0 @@
-{"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,+BAAf,eAAe,QA4B1B"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iCAAgC;AAAvB,8FAAA,KAAK,OAAA;AAEd,0CAAwB;AAExB,6DAA2C"}

package/dist/interfaces/auditEventListResponse.d.ts

@@ -1,10 +0,0 @@
-import { APILinks } from '@vonage/server-client';
-import { AuditEvent } from '../types/auditEvent';
-import { AuditEventPage } from './auditEventPage';
-export interface AuditEventListResponse {
-    _embedded?: {
-        events: AuditEvent[];
-    };
-    _links: APILinks;
-    page: AuditEventPage;
-}

package/dist/interfaces/auditEventListResponse.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auditEventListResponse.js","sourceRoot":"","sources":["../../lib/interfaces/auditEventListResponse.ts"],"names":[],"mappings":""}

package/dist/interfaces/auditEventPage.d.ts

@@ -1,6 +0,0 @@
-export interface AuditEventPage {
-    size: number;
-    totalElements: number;
-    totalPages: number;
-    number: number;
-}

package/dist/interfaces/auditEventPage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auditEventPage.js","sourceRoot":"","sources":["../../lib/interfaces/auditEventPage.ts"],"names":[],"mappings":""}

package/dist/interfaces/auditResponse.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auditResponse.js","sourceRoot":"","sources":["../../lib/interfaces/auditResponse.ts"],"names":[],"mappings":""}

package/dist/types/auditEvent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auditEvent.js","sourceRoot":"","sources":["../../lib/types/auditEvent.ts"],"names":[],"mappings":""}

package/dist/types/auditParams.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auditParams.js","sourceRoot":"","sources":["../../lib/types/auditParams.ts"],"names":[],"mappings":""}