@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,18 +1,191 @@
-export = AuditTrailModel;
-declare class AuditTrailModel {
-    static BadRequest(): any;
-    static CreateLogResponse(): any;
-    static DeviceInfo(): any;
-    static EntityObj(): any;
-    static EntityObject(): any;
-    static EntityTypeObj(): any;
-    static EntityTypesResponse(): any;
-    static InternalServerError(): any;
-    static Location(): any;
-    static LogDocs(): any;
-    static LogMetaObj(): any;
-    static LogSchemaResponse(): any;
-    static Modifier(): any;
-    static RequestBodyAuditLog(): any;
-    static ResourceNotFound(): any;
+export = AuditTrailPlatformModel;
+/**
+ * @typedef BadRequest
+ * @property {string} [message] - Failure message.
+ */
+/**
+ * @typedef CreateLogResponse
+ * @property {string} [internal_message]
+ * @property {string} [message]
+ */
+/**
+ * @typedef DeviceInfo
+ * @property {Object} [extra_meta]
+ * @property {string} [user_agent]
+ */
+/**
+ * @typedef EntityObj
+ * @property {string} [action]
+ * @property {Object} [entity_details]
+ * @property {string} [id]
+ * @property {string} [type]
+ */
+/**
+ * @typedef EntityObject
+ * @property {string} [action]
+ * @property {string} [id]
+ * @property {string} [type]
+ */
+/**
+ * @typedef EntityTypeObj
+ * @property {string} [display_name]
+ * @property {string} [entity_value]
+ */
+/**
+ * @typedef EntityTypesResponse
+ * @property {EntityTypeObj[]} [items]
+ */
+/**
+ * @typedef InternalServerError
+ * @property {string} [code] - Error code
+ * @property {string} [message] - Internal server Server error
+ */
+/**
+ * @typedef Location
+ * @property {Object} [extra_meta]
+ */
+/**
+ * @typedef LogDocs
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [company]
+ * @property {string} [date]
+ * @property {DeviceInfo} [device_info]
+ * @property {EntityObj} [entity]
+ * @property {Location} [location]
+ * @property {Object} [logs]
+ * @property {Modifier} [modifier]
+ * @property {string} [sessions]
+ */
+/**
+ * @typedef LogMetaObj
+ * @property {string} [application]
+ * @property {Object} [device_info]
+ * @property {EntityObject} [entity]
+ * @property {Object} [location]
+ * @property {Object} [modifier]
+ */
+/**
+ * @typedef LogSchemaResponse
+ * @property {LogDocs[]} [docs]
+ */
+/**
+ * @typedef Modifier
+ * @property {boolean} [as_administrator]
+ * @property {Object} [user_details]
+ * @property {string} [user_id]
+ */
+/**
+ * @typedef RequestBodyAuditLog
+ * @property {LogMetaObj} log_meta
+ * @property {Object} log_payload
+ */
+declare class AuditTrailPlatformModel {
 }
+declare namespace AuditTrailPlatformModel {
+    export { BadRequest, CreateLogResponse, DeviceInfo, EntityObj, EntityObject, EntityTypeObj, EntityTypesResponse, InternalServerError, Location, LogDocs, LogMetaObj, LogSchemaResponse, Modifier, RequestBodyAuditLog };
+}
+/** @returns {BadRequest} */
+declare function BadRequest(): BadRequest;
+type BadRequest = {
+    /**
+     * - Failure message.
+     */
+    message?: string;
+};
+/** @returns {CreateLogResponse} */
+declare function CreateLogResponse(): CreateLogResponse;
+type CreateLogResponse = {
+    internal_message?: string;
+    message?: string;
+};
+/** @returns {DeviceInfo} */
+declare function DeviceInfo(): DeviceInfo;
+type DeviceInfo = {
+    extra_meta?: any;
+    user_agent?: string;
+};
+/** @returns {EntityObj} */
+declare function EntityObj(): EntityObj;
+type EntityObj = {
+    action?: string;
+    entity_details?: any;
+    id?: string;
+    type?: string;
+};
+/** @returns {EntityObject} */
+declare function EntityObject(): EntityObject;
+type EntityObject = {
+    action?: string;
+    id?: string;
+    type?: string;
+};
+/** @returns {EntityTypeObj} */
+declare function EntityTypeObj(): EntityTypeObj;
+type EntityTypeObj = {
+    display_name?: string;
+    entity_value?: string;
+};
+/** @returns {EntityTypesResponse} */
+declare function EntityTypesResponse(): EntityTypesResponse;
+type EntityTypesResponse = {
+    items?: EntityTypeObj[];
+};
+/** @returns {InternalServerError} */
+declare function InternalServerError(): InternalServerError;
+type InternalServerError = {
+    /**
+     * - Error code
+     */
+    code?: string;
+    /**
+     * - Internal server Server error
+     */
+    message?: string;
+};
+/** @returns {Location} */
+declare function Location(): Location;
+type Location = {
+    extra_meta?: any;
+};
+/** @returns {LogDocs} */
+declare function LogDocs(): LogDocs;
+type LogDocs = {
+    _id?: string;
+    application?: string;
+    company?: string;
+    date?: string;
+    device_info?: DeviceInfo;
+    entity?: EntityObj;
+    location?: Location;
+    logs?: any;
+    modifier?: Modifier;
+    sessions?: string;
+};
+/** @returns {LogMetaObj} */
+declare function LogMetaObj(): LogMetaObj;
+type LogMetaObj = {
+    application?: string;
+    device_info?: any;
+    entity?: EntityObject;
+    location?: any;
+    modifier?: any;
+};
+/** @returns {LogSchemaResponse} */
+declare function LogSchemaResponse(): LogSchemaResponse;
+type LogSchemaResponse = {
+    docs?: LogDocs[];
+};
+/** @returns {Modifier} */
+declare function Modifier(): Modifier;
+type Modifier = {
+    as_administrator?: boolean;
+    user_details?: any;
+    user_id?: string;
+};
+/** @returns {RequestBodyAuditLog} */
+declare function RequestBodyAuditLog(): RequestBodyAuditLog;
+type RequestBodyAuditLog = {
+    log_meta: LogMetaObj;
+    log_payload: any;
+};

package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js

@@ -1,23 +1,125 @@
 const Joi = require("joi");
 
-class AuditTrailModel {
+/**
+ * @typedef BadRequest
+ * @property {string} [message] - Failure message.
+ */
+
+/**
+ * @typedef CreateLogResponse
+ * @property {string} [internal_message]
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef DeviceInfo
+ * @property {Object} [extra_meta]
+ * @property {string} [user_agent]
+ */
+
+/**
+ * @typedef EntityObj
+ * @property {string} [action]
+ * @property {Object} [entity_details]
+ * @property {string} [id]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef EntityObject
+ * @property {string} [action]
+ * @property {string} [id]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef EntityTypeObj
+ * @property {string} [display_name]
+ * @property {string} [entity_value]
+ */
+
+/**
+ * @typedef EntityTypesResponse
+ * @property {EntityTypeObj[]} [items]
+ */
+
+/**
+ * @typedef InternalServerError
+ * @property {string} [code] - Error code
+ * @property {string} [message] - Internal server Server error
+ */
+
+/**
+ * @typedef Location
+ * @property {Object} [extra_meta]
+ */
+
+/**
+ * @typedef LogDocs
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [company]
+ * @property {string} [date]
+ * @property {DeviceInfo} [device_info]
+ * @property {EntityObj} [entity]
+ * @property {Location} [location]
+ * @property {Object} [logs]
+ * @property {Modifier} [modifier]
+ * @property {string} [sessions]
+ */
+
+/**
+ * @typedef LogMetaObj
+ * @property {string} [application]
+ * @property {Object} [device_info]
+ * @property {EntityObject} [entity]
+ * @property {Object} [location]
+ * @property {Object} [modifier]
+ */
+
+/**
+ * @typedef LogSchemaResponse
+ * @property {LogDocs[]} [docs]
+ */
+
+/**
+ * @typedef Modifier
+ * @property {boolean} [as_administrator]
+ * @property {Object} [user_details]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef RequestBodyAuditLog
+ * @property {LogMetaObj} log_meta
+ * @property {Object} log_payload
+ */
+
+class AuditTrailPlatformModel {
+  /** @returns {BadRequest} */
   static BadRequest() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CreateLogResponse} */
   static CreateLogResponse() {
     return Joi.object({
       internal_message: Joi.string().allow(""),
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {DeviceInfo} */
   static DeviceInfo() {
     return Joi.object({
       extra_meta: Joi.any(),
       user_agent: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EntityObj} */
   static EntityObj() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -26,6 +128,8 @@ class AuditTrailModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EntityObject} */
   static EntityObject() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -33,56 +137,72 @@ class AuditTrailModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EntityTypeObj} */
   static EntityTypeObj() {
     return Joi.object({
       display_name: Joi.string().allow(""),
       entity_value: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EntityTypesResponse} */
   static EntityTypesResponse() {
     return Joi.object({
-      items: Joi.array().items(AuditTrailModel.EntityTypeObj()),
+      items: Joi.array().items(AuditTrailPlatformModel.EntityTypeObj()),
     });
   }
+
+  /** @returns {InternalServerError} */
   static InternalServerError() {
     return Joi.object({
       code: Joi.string().allow(""),
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Location} */
   static Location() {
     return Joi.object({
       extra_meta: Joi.any(),
     });
   }
+
+  /** @returns {LogDocs} */
   static LogDocs() {
     return Joi.object({
       _id: Joi.string().allow(""),
       application: Joi.string().allow(""),
       company: Joi.string().allow(""),
       date: Joi.string().allow(""),
-      device_info: AuditTrailModel.DeviceInfo(),
-      entity: AuditTrailModel.EntityObj(),
-      location: AuditTrailModel.Location(),
+      device_info: AuditTrailPlatformModel.DeviceInfo(),
+      entity: AuditTrailPlatformModel.EntityObj(),
+      location: AuditTrailPlatformModel.Location(),
       logs: Joi.any(),
-      modifier: AuditTrailModel.Modifier(),
+      modifier: AuditTrailPlatformModel.Modifier(),
       sessions: Joi.string().allow(""),
     });
   }
+
+  /** @returns {LogMetaObj} */
   static LogMetaObj() {
     return Joi.object({
       application: Joi.string().allow(""),
       device_info: Joi.any(),
-      entity: AuditTrailModel.EntityObject(),
+      entity: AuditTrailPlatformModel.EntityObject(),
       location: Joi.any(),
       modifier: Joi.any(),
     });
   }
+
+  /** @returns {LogSchemaResponse} */
   static LogSchemaResponse() {
     return Joi.object({
-      docs: Joi.array().items(AuditTrailModel.LogDocs()),
+      docs: Joi.array().items(AuditTrailPlatformModel.LogDocs()),
     });
   }
+
+  /** @returns {Modifier} */
   static Modifier() {
     return Joi.object({
       as_administrator: Joi.boolean(),
@@ -90,16 +210,13 @@ class AuditTrailModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RequestBodyAuditLog} */
   static RequestBodyAuditLog() {
     return Joi.object({
-      log_meta: AuditTrailModel.LogMetaObj().required(),
+      log_meta: AuditTrailPlatformModel.LogMetaObj().required(),
       log_payload: Joi.any().required(),
     });
   }
-  static ResourceNotFound() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
 }
-module.exports = AuditTrailModel;
+module.exports = AuditTrailPlatformModel;

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

@@ -1,7 +1,54 @@
-export = AuditTrailValidator;
-declare class AuditTrailValidator {
-    static createAuditLog(): any;
-    static getAuditLog(): any;
-    static getAuditLogs(): any;
+export = AuditTrailPlatformValidator;
+/**
+ * @typedef CreateAuditLogParam
+ * @property {AuditTrailPlatformModel.RequestBodyAuditLog} body
+ */
+/**
+ * @typedef GetAuditLogParam
+ * @property {string} id - Log uuid
+ */
+/**
+ * @typedef GetAuditLogsParam
+ * @property {string} qs - Logs Query
+ * @property {number} [limit] - Current request items count
+ * @property {Object} [sort] - To sort based on _id
+ */
+/** @typedef GetEntityTypesParam */
+declare class AuditTrailPlatformValidator {
+    /** @returns {CreateAuditLogParam} */
+    static createAuditLog(): CreateAuditLogParam;
+    /** @returns {GetAuditLogParam} */
+    static getAuditLog(): GetAuditLogParam;
+    /** @returns {GetAuditLogsParam} */
+    static getAuditLogs(): GetAuditLogsParam;
+    /** @returns {GetEntityTypesParam} */
     static getEntityTypes(): any;
 }
+declare namespace AuditTrailPlatformValidator {
+    export { CreateAuditLogParam, GetAuditLogParam, GetAuditLogsParam, GetEntityTypesParam };
+}
+type CreateAuditLogParam = {
+    body: AuditTrailPlatformModel.RequestBodyAuditLog;
+};
+type GetAuditLogParam = {
+    /**
+     * - Log uuid
+     */
+    id: string;
+};
+type GetAuditLogsParam = {
+    /**
+     * - Logs Query
+     */
+    qs: string;
+    /**
+     * - Current request items count
+     */
+    limit?: number;
+    /**
+     * - To sort based on _id
+     */
+    sort?: any;
+};
+type GetEntityTypesParam = any;
+import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");

package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js

@@ -1,28 +1,54 @@
 const Joi = require("joi");
 
-const AuditTrailModel = require("./AuditTrailPlatformModel");
-class AuditTrailValidator {
+const AuditTrailPlatformModel = require("./AuditTrailPlatformModel");
+
+/**
+ * @typedef CreateAuditLogParam
+ * @property {AuditTrailPlatformModel.RequestBodyAuditLog} body
+ */
+
+/**
+ * @typedef GetAuditLogParam
+ * @property {string} id - Log uuid
+ */
+
+/**
+ * @typedef GetAuditLogsParam
+ * @property {string} qs - Logs Query
+ * @property {number} [limit] - Current request items count
+ * @property {Object} [sort] - To sort based on _id
+ */
+
+/** @typedef GetEntityTypesParam */
+
+class AuditTrailPlatformValidator {
+  /** @returns {CreateAuditLogParam} */
   static createAuditLog() {
     return Joi.object({
-      body: AuditTrailModel.RequestBodyAuditLog().required(),
+      body: AuditTrailPlatformModel.RequestBodyAuditLog().required(),
     }).required();
   }
 
+  /** @returns {GetAuditLogParam} */
   static getAuditLog() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetAuditLogsParam} */
   static getAuditLogs() {
     return Joi.object({
       qs: Joi.string().allow("").required(),
+      limit: Joi.number(),
+      sort: Joi.any(),
     }).required();
   }
 
+  /** @returns {GetEntityTypesParam} */
   static getEntityTypes() {
     return Joi.object({}).required();
   }
 }
 
-module.exports = AuditTrailValidator;
+module.exports = AuditTrailPlatformValidator;