@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1

package/sdk/partner/Webhook/WebhookPartnerValidator.js

@@ -21,7 +21,7 @@ class WebhookValidator {
   static getDeliveryDetailInsights() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: WebhookModel.DeliveryDetailsPayload().required(),
+      body: WebhookModel.DeliveryDetailsRequest().required(),
     }).required();
   }
 
@@ -60,7 +60,7 @@ class WebhookValidator {
   static getInvalidEventList() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: WebhookModel.InvalidEventsPayload().required(),
+      body: WebhookModel.InvalidEventsRequest().required(),
     }).required();
   }
 
@@ -74,7 +74,7 @@ class WebhookValidator {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
       subscriberId: Joi.number().required(),
-      body: WebhookModel.SubscriberUpdate().required(),
+      body: WebhookModel.UpdateSubscriberRequest().required(),
     }).required();
   }
 }

package/sdk/partner/index.d.ts

@@ -1,9 +1,12 @@
 export const PartnerConfig: typeof import("./PartnerConfig");
 export const PartnerClient: typeof import("./PartnerClient");
 export namespace PartnerModel {
+    const AuthorizationPartnerModel: typeof import("./Authorization/AuthorizationPartnerModel");
+    const CatalogPartnerModel: typeof import("./Catalog/CatalogPartnerModel");
     const FileStoragePartnerModel: typeof import("./FileStorage/FileStoragePartnerModel");
     const LeadPartnerModel: typeof import("./Lead/LeadPartnerModel");
     const LogisticsPartnerModel: typeof import("./Logistics/LogisticsPartnerModel");
+    const PaymentPartnerModel: typeof import("./Payment/PaymentPartnerModel");
     const ThemePartnerModel: typeof import("./Theme/ThemePartnerModel");
     const WebhookPartnerModel: typeof import("./Webhook/WebhookPartnerModel");
 }

package/sdk/partner/index.js

@@ -2,12 +2,18 @@ module.exports = {
   PartnerConfig: require("./PartnerConfig"),
   PartnerClient: require("./PartnerClient"),
   PartnerModel: {
+    AuthorizationPartnerModel: require("./Authorization/AuthorizationPartnerModel"),
+
+    CatalogPartnerModel: require("./Catalog/CatalogPartnerModel"),
+
     FileStoragePartnerModel: require("./FileStorage/FileStoragePartnerModel"),
 
     LeadPartnerModel: require("./Lead/LeadPartnerModel"),
 
     LogisticsPartnerModel: require("./Logistics/LogisticsPartnerModel"),
 
+    PaymentPartnerModel: require("./Payment/PaymentPartnerModel"),
+
     ThemePartnerModel: require("./Theme/ThemePartnerModel"),
 
     WebhookPartnerModel: require("./Webhook/WebhookPartnerModel"),

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts

@@ -9,7 +9,7 @@ export = AnalyticsPlatformApplicationValidator;
  */
 /**
  * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
+ * @property {string} exportType
  * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
  */
 declare class AnalyticsPlatformApplicationValidator {
@@ -33,9 +33,6 @@ type ExecuteJobForProvidedParametersV2Param = {
     body: AnalyticsPlatformModel.JobExecute;
 };
 type StartDownloadForQueryV2Param = {
-    /**
-     * - Format in which to be exported(eg. CSV or excel).
-     */
     exportType: string;
     body: AnalyticsPlatformModel.FileDownloadRequestBody;
 };

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -14,7 +14,7 @@ const AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
 
 /**
  * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
+ * @property {string} exportType
  * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
  */
 

package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts

@@ -8,6 +8,7 @@ export = AnalyticsPlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [total] - Total number of items.
  */
 /**
  * @typedef FileDownloadRequestBody
@@ -71,6 +72,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - Total number of items.
+     */
+    total?: number;
 };
 /** @returns {FileDownloadRequestBody} */
 declare function FileDownloadRequestBody(): FileDownloadRequestBody;

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -9,6 +9,7 @@ const Joi = require("joi");
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [total] - Total number of items.
  */
 
 /**
@@ -52,6 +53,7 @@ class AnalyticsPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      total: Joi.number(),
     });
   }
 
@@ -83,7 +85,7 @@ class AnalyticsPlatformModel {
   static JobStatus() {
     return Joi.object({
       start_date: Joi.string().allow(""),
-      end_date: Joi.string().allow("").allow(null),
+      end_date: Joi.string().allow(""),
       status: Joi.string().allow(""),
       message: Joi.string().allow(""),
       file_metadata: Joi.array().items(Joi.any()).allow(null, ""),

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

@@ -6,12 +6,42 @@ declare class AuditTrail {
      * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
+     * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - 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/).
      */
-    createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResp>;
+    createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResponse>;
+    /**
+     * @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/).
+     */
+    getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
+    /**
+     * @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/).
+     */
+    getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
+    /**
+     * @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/).
+     */
+    getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
 }
 import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
 import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -18,7 +18,7 @@ class AuditTrail {
    * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
+   * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - 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/).
@@ -60,7 +60,7 @@ class AuditTrail {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/audit/logs/create`,
+      `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -74,7 +74,7 @@ class AuditTrail {
 
     const {
       error: res_error,
-    } = AuditTrailPlatformModel.CreateLogResp().validate(responseData, {
+    } = AuditTrailPlatformModel.CreateLogResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -92,6 +92,246 @@ 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,94 +2,190 @@ export = AuditTrailPlatformModel;
 /**
  * @typedef RequestBodyAuditLog
  * @property {LogMetaObj} log_meta
- * @property {Object} log_payload - Detailed information about payload.
+ * @property {Object} log_payload
  */
 /**
- * @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 CreateLogResponse
+ * @property {string} [message]
+ * @property {string} [internal_message]
  */
 /**
  * @typedef LogMetaObj
- * @property {Object} [modifier] - Details about user responsible for modifying events.
- * @property {string} [application] - The application id generating the log event.
+ * @property {Object} [modifier]
+ * @property {string} [application]
  * @property {EntityObject} [entity]
- * @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.
+ * @property {Object} [device_info]
+ * @property {Object} [location]
  */
 /**
  * @typedef EntityObject
- * @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.
+ * @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]
  */
 declare class AuditTrailPlatformModel {
 }
 declare namespace AuditTrailPlatformModel {
-    export { RequestBodyAuditLog, CreateLogResp, LogMetaObj, EntityObject };
+    export { RequestBodyAuditLog, CreateLogResponse, LogMetaObj, EntityObject, LogSchemaResponse, LogDocs, EntityObj, Modifier, DeviceInfo, Location, BadRequest, InternalServerError, EntityTypesResponse, EntityTypeObj };
 }
 /** @returns {RequestBodyAuditLog} */
 declare function RequestBodyAuditLog(): RequestBodyAuditLog;
 type RequestBodyAuditLog = {
     log_meta: LogMetaObj;
-    /**
-     * - Detailed information about payload.
-     */
     log_payload: any;
 };
-/** @returns {CreateLogResp} */
-declare function CreateLogResp(): CreateLogResp;
-type CreateLogResp = {
-    /**
-     * - Acknowledgement about success or failure of audit log.
-     */
+/** @returns {CreateLogResponse} */
+declare function CreateLogResponse(): CreateLogResponse;
+type CreateLogResponse = {
     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 = {
     /**
-     * - Unique identifier for the entity.
+     * - Failure message.
      */
-    id?: string;
+    message?: string;
+};
+/** @returns {InternalServerError} */
+declare function InternalServerError(): InternalServerError;
+type InternalServerError = {
     /**
-     * - The type/category of the entity.
+     * - Internal server Server error
      */
-    type?: string;
+    message?: string;
     /**
-     * - The action performed on or by the entity.
+     * - Error code
      */
-    action?: string;
+    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;
 };