@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/partner/Theme/ThemePartnerValidator.d.ts

@@ -0,0 +1,22 @@
+export = ThemeValidator;
+declare class ThemeValidator {
+    static getAllPages(): any;
+    static createPage(): any;
+    static updateMultiplePages(): any;
+    static getPage(): any;
+    static updatePage(): any;
+    static deletePage(): any;
+    static getApplicationThemes(): any;
+    static getThemeById(): any;
+    static updateTheme(): any;
+    static deleteTheme(): any;
+    static getOrganizationThemes(): any;
+    static getOrganizationThemeDetails(): any;
+    static updateDraftTheme(): any;
+    static submitOrganizationTheme(): any;
+    static deleteOrganizationTheme(): any;
+    static getLatestVersionOfThemeBySlug(): any;
+    static createNewThemeInOrganization(): any;
+    static getThemeRejectionReasons(): any;
+    static getThemeVersions(): any;
+}

package/sdk/partner/Theme/ThemePartnerValidator.js

@@ -0,0 +1,157 @@
+const Joi = require("joi");
+
+const ThemeModel = require("./ThemePartnerModel");
+class ThemeValidator {
+  static getAllPages() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static createPage() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+
+      body: ThemeModel.AvailablePageSchema().required(),
+    }).required();
+  }
+
+  static updateMultiplePages() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+
+      body: ThemeModel.AllAvailablePageSchema().required(),
+    }).required();
+  }
+
+  static getPage() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+      pageValue: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static updatePage() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+      pageValue: Joi.string().allow("").required(),
+
+      body: ThemeModel.AvailablePageSchema().required(),
+    }).required();
+  }
+
+  static deletePage() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+      pageValue: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getApplicationThemes() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getThemeById() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static updateTheme() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+
+      body: ThemeModel.UpdateThemeRequestBody().required(),
+    }).required();
+  }
+
+  static deleteTheme() {
+    return Joi.object({
+      companyId: Joi.number().required(),
+      applicationId: Joi.string().allow("").required(),
+      themeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getOrganizationThemes() {
+    return Joi.object({
+      status: Joi.string().allow(""),
+      pageSize: Joi.number(),
+      pageNo: Joi.number(),
+    }).required();
+  }
+
+  static getOrganizationThemeDetails() {
+    return Joi.object({
+      themeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static updateDraftTheme() {
+    return Joi.object({
+      themeId: Joi.string().allow("").required(),
+      body: ThemeModel.MarketplaceTheme().required(),
+    }).required();
+  }
+
+  static submitOrganizationTheme() {
+    return Joi.object({
+      themeId: Joi.string().allow("").required(),
+      body: ThemeModel.MarketplaceTheme().required(),
+    }).required();
+  }
+
+  static deleteOrganizationTheme() {
+    return Joi.object({
+      themeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getLatestVersionOfThemeBySlug() {
+    return Joi.object({
+      slugName: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static createNewThemeInOrganization() {
+    return Joi.object({
+      slug: Joi.string().allow(""),
+      body: ThemeModel.MarketplaceTheme().required(),
+    }).required();
+  }
+
+  static getThemeRejectionReasons() {
+    return Joi.object({
+      themeId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getThemeVersions() {
+    return Joi.object({
+      themeSlug: Joi.string().allow("").required(),
+      pageSize: Joi.number(),
+      pageNo: Joi.number(),
+    }).required();
+  }
+}
+
+module.exports = ThemeValidator;

package/sdk/partner/index.d.ts

@@ -1,3 +1,5 @@
 export const PartnerConfig: typeof import("./PartnerConfig");
 export const PartnerClient: typeof import("./PartnerClient");
-export const PartnerModel: {};
+export namespace PartnerModel {
+    const ThemePartnerModel: typeof import("./Theme/ThemePartnerModel");
+}

package/sdk/partner/index.js

@@ -1,5 +1,7 @@
 module.exports = {
   PartnerConfig: require("./PartnerConfig"),
   PartnerClient: require("./PartnerClient"),
-  PartnerModel: {},
+  PartnerModel: {
+    ThemePartnerModel: require("./Theme/ThemePartnerModel"),
+  },
 };

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

@@ -3,40 +3,45 @@ 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @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, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @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, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @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, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<EntityTypesResponse>} - Success 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: 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({ requestHeaders }?: any, { responseHeaders }?: object): 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,19 @@ class AuditTrail {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {RequestBodyAuditLog} arg.body
-   * @returns {Promise<CreateLogResponse>} - Success response
+   * @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
+   * @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, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = AuditTrailPlatformValidator.createAuditLog().validate(
       {
         body,
       },
@@ -30,7 +35,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 +46,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 +60,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       body,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.CreateLogResponse().validate(response, {
+    } = AuditTrailPlatformModel.CreateLogResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -67,23 +79,27 @@ 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @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, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = AuditTrailPlatformValidator.getAuditLog().validate(
       {
         id,
       },
@@ -94,7 +110,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 +121,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 +135,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -131,25 +154,31 @@ 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @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, limit, sort, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = AuditTrailPlatformValidator.getAuditLogs().validate(
       {
         qs,
+        limit,
+        sort,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -158,22 +187,27 @@ class AuditTrail {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
+    const {
+      error: warrning,
+    } = AuditTrailPlatformValidator.getAuditLogs().validate(
       {
         qs,
+        limit,
+        sort,
       },
       { abortEarly: false, allowUnknown: false }
     );
     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 = {};
     query_params["qs"] = qs;
+    query_params["limit"] = limit;
+    query_params["sort"] = sort;
 
     const xHeaders = {};
 
@@ -183,12 +217,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+    } = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -196,22 +236,27 @@ 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @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(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = AuditTrailPlatformValidator.getEntityTypes().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -220,16 +265,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 +288,18 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = AuditTrailModel.EntityTypesResponse().validate(response, {
+    } = AuditTrailPlatformModel.EntityTypesResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -255,9 +307,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;