@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/partner/PartnerClient.d.ts

@@ -1,6 +1,23 @@
 export = PartnerClient;
+/**
+ * Represents the client for the partner APIs.
+ *
+ * @class
+ */
 declare class PartnerClient {
-    constructor(config: any);
-    config: any;
-    setExtraHeaders(header: any): void;
+    /**
+     * Creates an instance of PartnerClient.
+     *
+     * @param {import("./PartnerConfig")} config - The configuration for the
+     *   partner client.
+     */
+    constructor(config: import("./PartnerConfig"));
+    config: import("./PartnerConfig");
+    /**
+     * Sets the extra headers for the partner client.
+     *
+     * @param {object} header - The header object to set.
+     * @throws {FDKClientValidationError} When the provided header is not an object.
+     */
+    setExtraHeaders(header: object): void;
 }

package/sdk/partner/PartnerClient.js

@@ -1,10 +1,27 @@
 const { FDKClientValidationError } = require("../common/FDKError");
 
+/**
+ * Represents the client for the partner APIs.
+ *
+ * @class
+ */
 class PartnerClient {
+  /**
+   * Creates an instance of PartnerClient.
+   *
+   * @param {import("./PartnerConfig")} config - The configuration for the
+   *   partner client.
+   */
   constructor(config) {
     this.config = config;
   }
 
+  /**
+   * Sets the extra headers for the partner client.
+   *
+   * @param {object} header - The header object to set.
+   * @throws {FDKClientValidationError} When the provided header is not an object.
+   */
   setExtraHeaders(header) {
     if (typeof header === "object") {
       this.config.extraHeaders.push(header);

package/sdk/partner/PartnerConfig.d.ts

@@ -1,30 +1,56 @@
 export = PartnerConfig;
+/**
+ * Represents the configuration for the partner.
+ *
+ * @class
+ */
 declare class PartnerConfig {
+    /** @typedef {"TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"} logLevelEnum */
     /**
-     * @param {Object} config
-     * @param {string} config.companyId
-     * @param {string} config.domain
-     * @param {string} config.apiKey
-     * @param {string} config.apiSecret
-     * @param {boolean} config.useAutoRenewTimer
+     * Creates an instance of PartnerConfig.
+     *
+     * @param {Object} config - The partner configuration.
+     * @param {string} config.organizationId - The ID of the organization.
+     * @param {string} [config.domain='https://api.fynd.com'] - The domain for
+     *   API. Write the full domain. Default is `'https://api.fynd.com'`
+     * @param {string} config.apiKey - The API key for authentication.
+     * @param {string} config.apiSecret - The API secret for authentication.
+     * @param {string} [config.scope] - The scope of the partner.
+     * @param {boolean} [config.useAutoRenewTimer=true] - Flag indicating whether
+     *   to use the auto-renew timer. Default is `true`
+     * @param {logLevelEnum} [config.logLevel='ERROR'] - The log level. Available
+     *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
      */
     constructor(config: {
-        companyId: string;
-        domain: string;
+        organizationId: string;
+        domain?: string;
         apiKey: string;
         apiSecret: string;
-        useAutoRenewTimer: boolean;
+        scope?: string;
+        useAutoRenewTimer?: boolean;
+        logLevel?: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
     });
-    organizationId: any;
+    organizationId: string;
     domain: string;
     apiKey: string;
     apiSecret: string;
-    scope: any;
+    scope: string;
     useAutoRenewTimer: boolean;
     oauthClient: OauthClient;
-    logLevel: any;
+    logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
     extraHeaders: any[];
-    setLogLevel(level: any): void;
-    getAccessToken(): Promise<any>;
+    /**
+     * Sets the log level for the partner.
+     *
+     * @param {logLevelEnum} level - The log level to set.
+     */
+    setLogLevel(level: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"): void;
+    /**
+     * Retrieves the access token from the OAuth client.
+     *
+     * @async
+     * @returns {Promise<string>} - The access token.
+     */
+    getAccessToken(): Promise<string>;
 }
 import OauthClient = require("./OAuthClient");

package/sdk/partner/PartnerConfig.js

@@ -1,14 +1,28 @@
 const OauthClient = require("./OAuthClient");
 const { setLoggerLevel } = require("../common/Logger");
 
+/**
+ * Represents the configuration for the partner.
+ *
+ * @class
+ */
 class PartnerConfig {
+  /** @typedef {"TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"} logLevelEnum */
+
   /**
-   * @param {Object} config
-   * @param {string} config.companyId
-   * @param {string} config.domain
-   * @param {string} config.apiKey
-   * @param {string} config.apiSecret
-   * @param {boolean} config.useAutoRenewTimer
+   * Creates an instance of PartnerConfig.
+   *
+   * @param {Object} config - The partner configuration.
+   * @param {string} config.organizationId - The ID of the organization.
+   * @param {string} [config.domain='https://api.fynd.com'] - The domain for
+   *   API. Write the full domain. Default is `'https://api.fynd.com'`
+   * @param {string} config.apiKey - The API key for authentication.
+   * @param {string} config.apiSecret - The API secret for authentication.
+   * @param {string} [config.scope] - The scope of the partner.
+   * @param {boolean} [config.useAutoRenewTimer=true] - Flag indicating whether
+   *   to use the auto-renew timer. Default is `true`
+   * @param {logLevelEnum} [config.logLevel='ERROR'] - The log level. Available
+   *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
    */
   constructor(config) {
     this.organizationId = config.organizationId;
@@ -26,10 +40,21 @@ class PartnerConfig {
     this.extraHeaders = [];
   }
 
+  /**
+   * Sets the log level for the partner.
+   *
+   * @param {logLevelEnum} level - The log level to set.
+   */
   setLogLevel(level) {
     setLoggerLevel(level);
   }
 
+  /**
+   * Retrieves the access token from the OAuth client.
+   *
+   * @async
+   * @returns {Promise<string>} - The access token.
+   */
   async getAccessToken() {
     let token = await this.oauthClient.getAccessToken();
     return token.access_token;

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

@@ -3,40 +3,41 @@ declare class AuditTrail {
     constructor(config: any);
     config: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {RequestBodyAuditLog} arg.body
-     * @returns {Promise<CreateLogResponse>} - Success response
+     * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
+     * @name createAuditLog
      * @summary: Create logs for auditing later on
-     * @description: Create a log instance that stores all the relevant info to be logged
+     * @description: Create a log instance that stores all the relevant info to be logged - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
      */
-    createAuditLog({ body }?: {
-        body: RequestBodyAuditLog;
-    }): Promise<CreateLogResponse>;
+    createAuditLog({ body }?: AuditTrailPlatformValidator.CreateAuditLogParam, { headers }?: import("../PlatformAPIClient").Options): Promise<AuditTrailPlatformModel.CreateLogResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Log uuid
-     * @returns {Promise<LogSchemaResponse>} - Success response
+     * @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
+     * @name getAuditLog
      * @summary: Get audit log
-     * @description: Get detailed log information by their id
+     * @description: Get detailed log information by their id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
      */
-    getAuditLog({ id }?: {
-        id: string;
-    }): Promise<LogSchemaResponse>;
+    getAuditLog({ id }?: AuditTrailPlatformValidator.GetAuditLogParam, { headers }?: import("../PlatformAPIClient").Options): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.qs - Logs Query
-     * @returns {Promise<LogSchemaResponse>} - Success response
+     * @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
+     * @name getAuditLogs
      * @summary: Get paginated audit logs
-     * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
+     * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
      */
-    getAuditLogs({ qs }?: {
-        qs: string;
-    }): Promise<LogSchemaResponse>;
+    getAuditLogs({ qs }?: AuditTrailPlatformValidator.GetAuditLogsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<EntityTypesResponse>} - Success response
+     * @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
+     * @name getEntityTypes
      * @summary: Get entity types
-     * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better
+     * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
      */
-    getEntityTypes({}?: any): Promise<EntityTypesResponse>;
+    getEntityTypes({ headers }?: any): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
 }
+import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
+import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -1,8 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
-const AuditTrailValidator = require("./AuditTrailPlatformValidator");
-const AuditTrailModel = require("./AuditTrailPlatformModel");
+const AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
+const AuditTrailPlatformModel = require("./AuditTrailPlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -12,14 +12,15 @@ class AuditTrail {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {RequestBodyAuditLog} arg.body
-   * @returns {Promise<CreateLogResponse>} - Success response
+   * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
+   * @name createAuditLog
    * @summary: Create logs for auditing later on
-   * @description: Create a log instance that stores all the relevant info to be logged
+   * @description: Create a log instance that stores all the relevant info to be logged - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
    */
-  async createAuditLog({ body } = {}) {
-    const { error } = AuditTrailValidator.createAuditLog().validate(
+  async createAuditLog({ body } = {}, { headers } = { headers: false }) {
+    const { error } = AuditTrailPlatformValidator.createAuditLog().validate(
       {
         body,
       },
@@ -30,7 +31,9 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.createAuditLog().validate(
+    const {
+      error: warrning,
+    } = AuditTrailPlatformValidator.createAuditLog().validate(
       {
         body,
       },
@@ -39,9 +42,8 @@ class AuditTrail {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createAuditLog",
+        message: `Parameter Validation warrnings for platform > AuditTrail > createAuditLog \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -54,12 +56,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.CreateLogResponse().validate(response, {
+    } = AuditTrailPlatformModel.CreateLogResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -67,23 +75,23 @@ class AuditTrail {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createAuditLog",
+        message: `Response Validation Warnnings for platform > AuditTrail > createAuditLog \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.id - Log uuid
-   * @returns {Promise<LogSchemaResponse>} - Success response
+   * @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
+   * @name getAuditLog
    * @summary: Get audit log
-   * @description: Get detailed log information by their id
+   * @description: Get detailed log information by their id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
    */
-  async getAuditLog({ id } = {}) {
-    const { error } = AuditTrailValidator.getAuditLog().validate(
+  async getAuditLog({ id } = {}, { headers } = { headers: false }) {
+    const { error } = AuditTrailPlatformValidator.getAuditLog().validate(
       {
         id,
       },
@@ -94,7 +102,9 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getAuditLog().validate(
+    const {
+      error: warrning,
+    } = AuditTrailPlatformValidator.getAuditLog().validate(
       {
         id,
       },
@@ -103,9 +113,8 @@ class AuditTrail {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getAuditLog",
+        message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLog \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -118,12 +127,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -131,23 +146,23 @@ class AuditTrail {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getAuditLog",
+        message: `Response Validation Warnnings for platform > AuditTrail > getAuditLog \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.qs - Logs Query
-   * @returns {Promise<LogSchemaResponse>} - Success response
+   * @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
+   * @name getAuditLogs
    * @summary: Get paginated audit logs
-   * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
+   * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
    */
-  async getAuditLogs({ qs } = {}) {
-    const { error } = AuditTrailValidator.getAuditLogs().validate(
+  async getAuditLogs({ qs } = {}, { headers } = { headers: false }) {
+    const { error } = AuditTrailPlatformValidator.getAuditLogs().validate(
       {
         qs,
       },
@@ -158,7 +173,9 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
+    const {
+      error: warrning,
+    } = AuditTrailPlatformValidator.getAuditLogs().validate(
       {
         qs,
       },
@@ -167,9 +184,8 @@ class AuditTrail {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getAuditLogs",
+        message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLogs \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -183,12 +199,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -196,22 +218,23 @@ class AuditTrail {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getAuditLogs",
+        message: `Response Validation Warnnings for platform > AuditTrail > getAuditLogs \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<EntityTypesResponse>} - Success response
+   * @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
+   * @name getEntityTypes
    * @summary: Get entity types
-   * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better
+   * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
    */
-  async getEntityTypes({} = {}) {
-    const { error } = AuditTrailValidator.getEntityTypes().validate(
+  async getEntityTypes({ headers } = { headers: false }) {
+    const { error } = AuditTrailPlatformValidator.getEntityTypes().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -220,16 +243,17 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getEntityTypes().validate(
+    const {
+      error: warrning,
+    } = AuditTrailPlatformValidator.getEntityTypes().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getEntityTypes",
+        message: `Parameter Validation warrnings for platform > AuditTrail > getEntityTypes \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -242,12 +266,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.EntityTypesResponse().validate(response, {
+    } = AuditTrailPlatformModel.EntityTypesResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -255,9 +285,8 @@ class AuditTrail {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getEntityTypes",
+        message: `Response Validation Warnnings for platform > AuditTrail > getEntityTypes \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;