@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -18,10 +18,10 @@ class AuditTrail {
    * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
+   * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
    * @name createAuditLog
    * @summary: Create an audit log
-   * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
+   * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/audittrail/createAuditLog/).
    */
   async createAuditLog(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -60,7 +60,7 @@ class AuditTrail {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs`,
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/audit/logs/create`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -74,7 +74,7 @@ class AuditTrail {
 
     const {
       error: res_error,
-    } = AuditTrailPlatformModel.CreateLogResponse().validate(responseData, {
+    } = AuditTrailPlatformModel.CreateLogResp().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -92,246 +92,6 @@ class AuditTrail {
 
     return response;
   }
-
-  /**
-   * @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-   * @name getAuditLog
-   * @summary: Get an audit log
-   * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
-   */
-  async getAuditLog(
-    { id, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = AuditTrailPlatformValidator.getAuditLog().validate(
-      {
-        id,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AuditTrailPlatformValidator.getAuditLog().validate(
-      {
-        id,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLog \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > AuditTrail > getAuditLog \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-   * @name getAuditLogs
-   * @summary: Get audit logs
-   * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
-   */
-  async getAuditLogs(
-    { qs, limit, sort, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = AuditTrailPlatformValidator.getAuditLogs().validate(
-      {
-        qs,
-        limit,
-        sort,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AuditTrailPlatformValidator.getAuditLogs().validate(
-      {
-        qs,
-        limit,
-        sort,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLogs \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["qs"] = qs;
-    query_params["limit"] = limit;
-    query_params["sort"] = sort;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > AuditTrail > getAuditLogs \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
-   * @name getEntityTypes
-   * @summary: List entity types
-   * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
-   */
-  async getEntityTypes(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = AuditTrailPlatformValidator.getEntityTypes().validate(
-      {},
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AuditTrailPlatformValidator.getEntityTypes().validate(
-      {},
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > AuditTrail > getEntityTypes \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AuditTrailPlatformModel.EntityTypesResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > AuditTrail > getEntityTypes \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
 }
 
 module.exports = AuditTrail;

package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts

@@ -2,190 +2,94 @@ export = AuditTrailPlatformModel;
 /**
  * @typedef RequestBodyAuditLog
  * @property {LogMetaObj} log_meta
- * @property {Object} log_payload
+ * @property {Object} log_payload - Detailed information about payload.
  */
 /**
- * @typedef CreateLogResponse
- * @property {string} [message]
- * @property {string} [internal_message]
+ * @typedef CreateLogResp
+ * @property {string} [message] - Acknowledgement about success or failure of audit log.
+ * @property {string} [internal_message] - Status of audit log in internal system.
  */
 /**
  * @typedef LogMetaObj
- * @property {Object} [modifier]
- * @property {string} [application]
+ * @property {Object} [modifier] - Details about user responsible for modifying events.
+ * @property {string} [application] - The application id generating the log event.
  * @property {EntityObject} [entity]
- * @property {Object} [device_info]
- * @property {Object} [location]
+ * @property {Object} [device_info] - Contains device-specific information for
+ *   the log event.
+ * @property {Object} [location] - Holds location-related data for the event context.
+ * @property {string} [sessions] - Identifies the session associated with the log event.
  */
 /**
  * @typedef EntityObject
- * @property {string} [id]
- * @property {string} [type]
- * @property {string} [action]
- */
-/**
- * @typedef LogSchemaResponse
- * @property {LogDocs[]} [docs]
- */
-/**
- * @typedef LogDocs
- * @property {EntityObj} [entity]
- * @property {Modifier} [modifier]
- * @property {DeviceInfo} [device_info]
- * @property {Location} [location]
- * @property {string} [_id]
- * @property {string} [company]
- * @property {string} [application]
- * @property {string} [sessions]
- * @property {string} [date]
- * @property {Object} [logs]
- */
-/**
- * @typedef EntityObj
- * @property {string} [id]
- * @property {string} [type]
- * @property {string} [action]
- * @property {Object} [entity_details]
- */
-/**
- * @typedef Modifier
- * @property {string} [user_id]
- * @property {boolean} [as_administrator]
- * @property {Object} [user_details]
- */
-/**
- * @typedef DeviceInfo
- * @property {string} [user_agent]
- * @property {Object} [extra_meta]
- */
-/**
- * @typedef Location
- * @property {Object} [extra_meta]
- */
-/**
- * @typedef BadRequest
- * @property {string} [message] - Failure message.
- */
-/**
- * @typedef InternalServerError
- * @property {string} [message] - Internal server Server error
- * @property {string} [code] - Error code
- */
-/**
- * @typedef EntityTypesResponse
- * @property {EntityTypeObj[]} [items]
- */
-/**
- * @typedef EntityTypeObj
- * @property {string} [entity_value]
- * @property {string} [display_name]
+ * @property {string} [id] - Unique identifier for the entity.
+ * @property {string} [type] - The type/category of the entity.
+ * @property {string} [action] - The action performed on or by the entity.
  */
 declare class AuditTrailPlatformModel {
 }
 declare namespace AuditTrailPlatformModel {
-    export { RequestBodyAuditLog, CreateLogResponse, LogMetaObj, EntityObject, LogSchemaResponse, LogDocs, EntityObj, Modifier, DeviceInfo, Location, BadRequest, InternalServerError, EntityTypesResponse, EntityTypeObj };
+    export { RequestBodyAuditLog, CreateLogResp, LogMetaObj, EntityObject };
 }
 /** @returns {RequestBodyAuditLog} */
 declare function RequestBodyAuditLog(): RequestBodyAuditLog;
 type RequestBodyAuditLog = {
     log_meta: LogMetaObj;
+    /**
+     * - Detailed information about payload.
+     */
     log_payload: any;
 };
-/** @returns {CreateLogResponse} */
-declare function CreateLogResponse(): CreateLogResponse;
-type CreateLogResponse = {
+/** @returns {CreateLogResp} */
+declare function CreateLogResp(): CreateLogResp;
+type CreateLogResp = {
+    /**
+     * - Acknowledgement about success or failure of audit log.
+     */
     message?: string;
+    /**
+     * - Status of audit log in internal system.
+     */
     internal_message?: string;
 };
 /** @returns {LogMetaObj} */
 declare function LogMetaObj(): LogMetaObj;
 type LogMetaObj = {
+    /**
+     * - Details about user responsible for modifying events.
+     */
     modifier?: any;
+    /**
+     * - The application id generating the log event.
+     */
     application?: string;
     entity?: EntityObject;
+    /**
+     * - Contains device-specific information for
+     * the log event.
+     */
     device_info?: any;
+    /**
+     * - Holds location-related data for the event context.
+     */
     location?: any;
+    /**
+     * - Identifies the session associated with the log event.
+     */
+    sessions?: string;
 };
 /** @returns {EntityObject} */
 declare function EntityObject(): EntityObject;
 type EntityObject = {
-    id?: string;
-    type?: string;
-    action?: string;
-};
-/** @returns {LogSchemaResponse} */
-declare function LogSchemaResponse(): LogSchemaResponse;
-type LogSchemaResponse = {
-    docs?: LogDocs[];
-};
-/** @returns {LogDocs} */
-declare function LogDocs(): LogDocs;
-type LogDocs = {
-    entity?: EntityObj;
-    modifier?: Modifier;
-    device_info?: DeviceInfo;
-    location?: Location;
-    _id?: string;
-    company?: string;
-    application?: string;
-    sessions?: string;
-    date?: string;
-    logs?: any;
-};
-/** @returns {EntityObj} */
-declare function EntityObj(): EntityObj;
-type EntityObj = {
-    id?: string;
-    type?: string;
-    action?: string;
-    entity_details?: any;
-};
-/** @returns {Modifier} */
-declare function Modifier(): Modifier;
-type Modifier = {
-    user_id?: string;
-    as_administrator?: boolean;
-    user_details?: any;
-};
-/** @returns {DeviceInfo} */
-declare function DeviceInfo(): DeviceInfo;
-type DeviceInfo = {
-    user_agent?: string;
-    extra_meta?: any;
-};
-/** @returns {Location} */
-declare function Location(): Location;
-type Location = {
-    extra_meta?: any;
-};
-/** @returns {BadRequest} */
-declare function BadRequest(): BadRequest;
-type BadRequest = {
     /**
-     * - Failure message.
+     * - Unique identifier for the entity.
      */
-    message?: string;
-};
-/** @returns {InternalServerError} */
-declare function InternalServerError(): InternalServerError;
-type InternalServerError = {
+    id?: string;
     /**
-     * - Internal server Server error
+     * - The type/category of the entity.
      */
-    message?: string;
+    type?: string;
     /**
-     * - Error code
+     * - The action performed on or by the entity.
      */
-    code?: string;
-};
-/** @returns {EntityTypesResponse} */
-declare function EntityTypesResponse(): EntityTypesResponse;
-type EntityTypesResponse = {
-    items?: EntityTypeObj[];
-};
-/** @returns {EntityTypeObj} */
-declare function EntityTypeObj(): EntityTypeObj;
-type EntityTypeObj = {
-    entity_value?: string;
-    display_name?: string;
+    action?: string;
 };