@vonage/audit 1.17.2 → 1.18.0-alpha.0

package/dist/esm/{audit.js → audit.d.mts}

@@ -1,4 +1,8 @@
-import { AuthenticationType, Client } from '@vonage/server-client';
+import { Client, AuthenticationType } from '@vonage/server-client';
+import { AuditEvent } from './types/auditEvent.mjs';
+import { AuditParams } from './types/auditParams.mjs';
+import './enums.mjs';
+
 /**
  * Represents an SDK client for interacting with audit-related functionality.
  *
@@ -18,11 +22,9 @@ import { AuthenticationType, Client } from '@vonage/server-client';
  * });
  * ```
  */
-export class Audit extends Client {
-    // The base path for audit-related API endpoints
-    BASE_PATH = 'beta';
-    // Authentication type for the client
-    authType = AuthenticationType.BASIC;
+declare class Audit extends Client {
+    protected BASE_PATH: string;
+    authType: AuthenticationType;
     /**
      * Retrieves a list of audit events based on specified parameters.
      *
@@ -56,18 +58,7 @@ export class Audit extends Client {
      * }
      * ```
      */
-    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`, Client.transformers.snakeCaseObjectKeys(params));
-            const events = (resp.data?._embedded?.events || []).map((event) => Client.transformers.camelCaseObjectKeys(event, true));
-            totalPages = resp.data?.page?.totalPages || 0;
-            yield* events;
-            page++;
-        } while (page <= totalPages);
-    }
+    getEvents(params: AuditParams): AsyncGenerator<AuditEvent, void, undefined>;
     /**
      * Retrieves a specific audit event by its ID.
      *
@@ -82,9 +73,7 @@ export class Audit extends Client {
      * console.log(auditEvent.id);
      * ```
      */
-    async getEvent(eventId) {
-        const resp = await this.sendGetRequest(`${this.config.apiHost}/${this.BASE_PATH}/audit/events/${eventId}`);
-        return Client.transformers.camelCaseObjectKeys(resp.data, true);
-    }
+    getEvent(eventId: string): Promise<AuditEvent>;
 }
-//# sourceMappingURL=audit.js.map
+
+export { Audit };

package/dist/esm/audit.mjs

@@ -0,0 +1,6 @@
+import {
+  Audit
+} from "./chunk-OBZ3KD3U.mjs";
+export {
+  Audit
+};

package/dist/esm/chunk-OBZ3KD3U.mjs

@@ -0,0 +1,85 @@
+// lib/audit.ts
+import { AuthenticationType, Client } from "@vonage/server-client";
+var Audit = class extends Client {
+  // The base path for audit-related API endpoints
+  BASE_PATH = "beta";
+  // Authentication type for the client
+  authType = 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`,
+        Client.transformers.snakeCaseObjectKeys(params)
+      );
+      const events = (resp.data?._embedded?.events || []).map(
+        (event) => 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 Client.transformers.camelCaseObjectKeys(
+      resp.data,
+      true
+    );
+  }
+};
+
+export {
+  Audit
+};

package/dist/esm/chunk-XMMZY7PJ.mjs

@@ -0,0 +1,35 @@
+// lib/enums.ts
+var AuditEventTypes = /* @__PURE__ */ ((AuditEventTypes2) => {
+  AuditEventTypes2["USER_STATUS"] = "USER_STATUS";
+  AuditEventTypes2["USER_UPDATE"] = "USER_UPDATE";
+  AuditEventTypes2["USER_BILLING_UPDATE"] = "USER_BILLING_UPDATE";
+  AuditEventTypes2["USER_CREATE"] = "USER_CREATE";
+  AuditEventTypes2["USER_LOGIN"] = "USER_LOGIN";
+  AuditEventTypes2["USER_LOGOUT"] = "USER_LOGOUT";
+  AuditEventTypes2["USER_PRODUCT_SEARCH"] = "USER_PRODUCT_SEARCH";
+  AuditEventTypes2["USER_API_KEYS_UPDATE"] = "USER_API_KEYS_UPDATE";
+  AuditEventTypes2["ACCOUNT_SECRET_DELETE"] = "ACCOUNT_SECRET_DELETE";
+  AuditEventTypes2["ACCOUNT_SECRET_CREATE"] = "ACCOUNT_SECRET_CREATE";
+  AuditEventTypes2["ACCOUNT_UPDATE_SPAMMER"] = "ACCOUNT_UPDATE_SPAMMER";
+  AuditEventTypes2["ACCOUNT_UPDATE_SETTINGS_API"] = "ACCOUNT_UPDATE_SETTINGS_API";
+  AuditEventTypes2["NUMBER_ASSIGN"] = "NUMBER_ASSIGN";
+  AuditEventTypes2["NUMBER_UPDATED"] = "NUMBER_UPDATED";
+  AuditEventTypes2["NUMBER_RELEASE"] = "NUMBER_RELEASE";
+  AuditEventTypes2["NUMBER_LINKED"] = "NUMBER_LINKED";
+  AuditEventTypes2["NUMBER_UNLINKED"] = "NUMBER_UNLINKED";
+  AuditEventTypes2["APP_CREATE"] = "APP_CREATE";
+  AuditEventTypes2["APP_UPDATE"] = "APP_UPDATE";
+  AuditEventTypes2["APP_DELETE"] = "APP_DELETE";
+  AuditEventTypes2["APP_DISABLE"] = "APP_DISABLE";
+  AuditEventTypes2["APP_ENABLE"] = "APP_ENABLE";
+  AuditEventTypes2["IP_WHITELIST_CREATE"] = "IP_WHITELIST_CREATE";
+  AuditEventTypes2["IP_WHITELIST_DELETE"] = "IP_WHITELIST_DELETE";
+  AuditEventTypes2["AUTORELOAD_ENABLE"] = "AUTORELOAD_ENABLE";
+  AuditEventTypes2["AUTORELOAD_UPDATE"] = "AUTORELOAD_UPDATE";
+  AuditEventTypes2["AUTORELOAD_DISABLE"] = "AUTORELOAD_DISABLE";
+  return AuditEventTypes2;
+})(AuditEventTypes || {});
+
+export {
+  AuditEventTypes
+};

package/dist/esm/{enums.js → enums.d.mts}

@@ -11,115 +11,115 @@
  *
  * @see Documentation {@link https://developer.vonage.com/en/audit/concepts/audit-events}
  */
-export var AuditEventTypes;
-(function (AuditEventTypes) {
+declare enum AuditEventTypes {
     /**
      * User status updated.
      */
-    AuditEventTypes["USER_STATUS"] = "USER_STATUS";
+    USER_STATUS = "USER_STATUS",
     /**
      * User updated.
      */
-    AuditEventTypes["USER_UPDATE"] = "USER_UPDATE";
+    USER_UPDATE = "USER_UPDATE",
     /**
      * User billing updated.
      */
-    AuditEventTypes["USER_BILLING_UPDATE"] = "USER_BILLING_UPDATE";
+    USER_BILLING_UPDATE = "USER_BILLING_UPDATE",
     /**
      * User created.
      */
-    AuditEventTypes["USER_CREATE"] = "USER_CREATE";
+    USER_CREATE = "USER_CREATE",
     /**
      * User login (Premium Support only).
      */
-    AuditEventTypes["USER_LOGIN"] = "USER_LOGIN";
+    USER_LOGIN = "USER_LOGIN",
     /**
      * User logout (Premium Support only).
      */
-    AuditEventTypes["USER_LOGOUT"] = "USER_LOGOUT";
+    USER_LOGOUT = "USER_LOGOUT",
     /**
      * Relates to searching for CDRs or logs in Dashboard.
      */
-    AuditEventTypes["USER_PRODUCT_SEARCH"] = "USER_PRODUCT_SEARCH";
+    USER_PRODUCT_SEARCH = "USER_PRODUCT_SEARCH",
     /**
      * Sub-accounts for user updated.
      */
-    AuditEventTypes["USER_API_KEYS_UPDATE"] = "USER_API_KEYS_UPDATE";
+    USER_API_KEYS_UPDATE = "USER_API_KEYS_UPDATE",
     /**
      * Secret Rotation operation.
      */
-    AuditEventTypes["ACCOUNT_SECRET_DELETE"] = "ACCOUNT_SECRET_DELETE";
+    ACCOUNT_SECRET_DELETE = "ACCOUNT_SECRET_DELETE",
     /**
      * Secret Rotation operation.
      */
-    AuditEventTypes["ACCOUNT_SECRET_CREATE"] = "ACCOUNT_SECRET_CREATE";
+    ACCOUNT_SECRET_CREATE = "ACCOUNT_SECRET_CREATE",
     /**
      * Account Settings updated via API.
      */
-    AuditEventTypes["ACCOUNT_UPDATE_SPAMMER"] = "ACCOUNT_UPDATE_SPAMMER";
+    ACCOUNT_UPDATE_SPAMMER = "ACCOUNT_UPDATE_SPAMMER",
     /**
      * Account Settings updated via API.
      */
-    AuditEventTypes["ACCOUNT_UPDATE_SETTINGS_API"] = "ACCOUNT_UPDATE_SETTINGS_API";
+    ACCOUNT_UPDATE_SETTINGS_API = "ACCOUNT_UPDATE_SETTINGS_API",
     /**
      * Number assigned.
      */
-    AuditEventTypes["NUMBER_ASSIGN"] = "NUMBER_ASSIGN";
+    NUMBER_ASSIGN = "NUMBER_ASSIGN",
     /**
      * Number updated.
      */
-    AuditEventTypes["NUMBER_UPDATED"] = "NUMBER_UPDATED";
+    NUMBER_UPDATED = "NUMBER_UPDATED",
     /**
      * Number released.
      */
-    AuditEventTypes["NUMBER_RELEASE"] = "NUMBER_RELEASE";
+    NUMBER_RELEASE = "NUMBER_RELEASE",
     /**
      * Number linked to Vonage application.
      */
-    AuditEventTypes["NUMBER_LINKED"] = "NUMBER_LINKED";
+    NUMBER_LINKED = "NUMBER_LINKED",
     /**
      * Number unlinked from Vonage application.
      */
-    AuditEventTypes["NUMBER_UNLINKED"] = "NUMBER_UNLINKED";
+    NUMBER_UNLINKED = "NUMBER_UNLINKED",
     /**
      * App created.
      */
-    AuditEventTypes["APP_CREATE"] = "APP_CREATE";
+    APP_CREATE = "APP_CREATE",
     /**
      * App updated.
      */
-    AuditEventTypes["APP_UPDATE"] = "APP_UPDATE";
+    APP_UPDATE = "APP_UPDATE",
     /**
      * App deleted.
      */
-    AuditEventTypes["APP_DELETE"] = "APP_DELETE";
+    APP_DELETE = "APP_DELETE",
     /**
      * App disabled.
      */
-    AuditEventTypes["APP_DISABLE"] = "APP_DISABLE";
+    APP_DISABLE = "APP_DISABLE",
     /**
      * App enabled.
      */
-    AuditEventTypes["APP_ENABLE"] = "APP_ENABLE";
+    APP_ENABLE = "APP_ENABLE",
     /**
      * Whitelist IP added.
      */
-    AuditEventTypes["IP_WHITELIST_CREATE"] = "IP_WHITELIST_CREATE";
+    IP_WHITELIST_CREATE = "IP_WHITELIST_CREATE",
     /**
      * Whitelist IP deleted.
      */
-    AuditEventTypes["IP_WHITELIST_DELETE"] = "IP_WHITELIST_DELETE";
+    IP_WHITELIST_DELETE = "IP_WHITELIST_DELETE",
     /**
      * Automatic reload enabled.
      */
-    AuditEventTypes["AUTORELOAD_ENABLE"] = "AUTORELOAD_ENABLE";
+    AUTORELOAD_ENABLE = "AUTORELOAD_ENABLE",
     /**
      * Automatic reload settings updated.
      */
-    AuditEventTypes["AUTORELOAD_UPDATE"] = "AUTORELOAD_UPDATE";
+    AUTORELOAD_UPDATE = "AUTORELOAD_UPDATE",
     /**
      * Automatic reload disabled.
      */
-    AuditEventTypes["AUTORELOAD_DISABLE"] = "AUTORELOAD_DISABLE";
-})(AuditEventTypes || (AuditEventTypes = {}));
-//# sourceMappingURL=enums.js.map
+    AUTORELOAD_DISABLE = "AUTORELOAD_DISABLE"
+}
+
+export { AuditEventTypes };

package/dist/esm/enums.mjs

@@ -0,0 +1,6 @@
+import {
+  AuditEventTypes
+} from "./chunk-XMMZY7PJ.mjs";
+export {
+  AuditEventTypes
+};

package/dist/esm/index.d.mts

@@ -0,0 +1,10 @@
+export { Audit } from './audit.mjs';
+export { AuditEventTypes } from './enums.mjs';
+export { AuditEvent } from './types/auditEvent.mjs';
+export { AuditEventListResponse } from './types/auditEventListResponse.mjs';
+export { AuditEventPage } from './types/auditEventPage.mjs';
+export { AuditParams } from './types/auditParams.mjs';
+export { AuditResponse } from './types/auditResponse.mjs';
+export { AuditEventResponse } from './types/auditEventResponse.mjs';
+import '@vonage/server-client';
+import '@vonage/vetch';

package/dist/esm/index.mjs

@@ -0,0 +1,17 @@
+import "./chunk-H2HTRM5V.mjs";
+import "./chunk-67PEDNZG.mjs";
+import {
+  Audit
+} from "./chunk-OBZ3KD3U.mjs";
+import {
+  AuditEventTypes
+} from "./chunk-XMMZY7PJ.mjs";
+import "./chunk-YPBMBXT7.mjs";
+import "./chunk-J2WIUYQ3.mjs";
+import "./chunk-A6RND7HO.mjs";
+import "./chunk-OVBSHGNZ.mjs";
+import "./chunk-YQNVDASO.mjs";
+export {
+  Audit,
+  AuditEventTypes
+};

package/dist/esm/types/auditEvent.d.mts

@@ -0,0 +1,50 @@
+import { AuditEventTypes } from '../enums.mjs';
+
+/**
+ * Represents an Audit Event.
+ */
+type AuditEvent = {
+    /**
+     * UUID of the audit event.
+     */
+    id: string;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Additional context information for the audit event.
+     */
+    context?: unknown;
+};
+
+export type { AuditEvent };

package/dist/esm/types/auditEvent.mjs

@@ -0,0 +1 @@
+import "../chunk-YPBMBXT7.mjs";

package/dist/esm/types/auditEventListResponse.d.mts

@@ -0,0 +1,30 @@
+import { APILinks } from '@vonage/server-client';
+import { AuditEvent } from './auditEvent.mjs';
+import { AuditEventPage } from './auditEventPage.mjs';
+import '../enums.mjs';
+
+/**
+ * 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`
+ */
+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;
+};
+
+export type { AuditEventListResponse };

package/dist/esm/types/auditEventListResponse.mjs

@@ -0,0 +1 @@
+import "../chunk-J2WIUYQ3.mjs";

package/dist/esm/types/auditEventPage.d.mts

@@ -0,0 +1,23 @@
+/**
+ * Represents information about the pagination of audit events.
+ */
+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;
+};
+
+export type { AuditEventPage };

package/dist/esm/types/auditEventPage.mjs

@@ -0,0 +1 @@
+import "../chunk-A6RND7HO.mjs";

package/dist/esm/types/auditEventResponse.d.mts

@@ -0,0 +1,43 @@
+import { AuditEventTypes } from '../enums.mjs';
+import { AuditEvent } from './auditEvent.mjs';
+
+/**
+ * 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`
+ */
+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'>;
+
+export type { AuditEventResponse };

package/dist/esm/types/auditEventResponse.mjs

@@ -0,0 +1 @@
+import "../chunk-OVBSHGNZ.mjs";

package/dist/esm/types/auditParams.d.mts

@@ -0,0 +1,33 @@
+import { AuditEventTypes } from '../enums.mjs';
+
+/**
+ * Represents parameters for querying audit events.
+ */
+type AuditParams = {
+    /**
+     * 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;
+};
+
+export type { AuditParams };

package/dist/esm/types/auditParams.mjs

@@ -0,0 +1 @@
+import "../chunk-YQNVDASO.mjs";

package/dist/esm/types/auditResponse.d.mts

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

package/dist/esm/types/auditResponse.mjs

@@ -0,0 +1 @@
+import "../chunk-67PEDNZG.mjs";

package/dist/esm/types/index.d.mts

@@ -0,0 +1,9 @@
+export { AuditEvent } from './auditEvent.mjs';
+export { AuditEventListResponse } from './auditEventListResponse.mjs';
+export { AuditEventPage } from './auditEventPage.mjs';
+export { AuditParams } from './auditParams.mjs';
+export { AuditResponse } from './auditResponse.mjs';
+export { AuditEventResponse } from './auditEventResponse.mjs';
+import '../enums.mjs';
+import '@vonage/server-client';
+import '@vonage/vetch';

package/dist/esm/types/index.mjs

@@ -0,0 +1,7 @@
+import "../chunk-H2HTRM5V.mjs";
+import "../chunk-67PEDNZG.mjs";
+import "../chunk-YPBMBXT7.mjs";
+import "../chunk-J2WIUYQ3.mjs";
+import "../chunk-A6RND7HO.mjs";
+import "../chunk-OVBSHGNZ.mjs";
+import "../chunk-YQNVDASO.mjs";