@gofynd/fdk-client-javascript 1.2.0 → 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

@@ -4,40 +4,44 @@ declare class AuditTrail {
     config: any;
     /**
      * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
      */
-    createAuditLog({ body }?: AuditTrailPlatformValidator.CreateAuditLogParam, { headers }?: import("../PlatformAPIClient").Options): Promise<AuditTrailPlatformModel.CreateLogResponse>;
+    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 audit log
      * @description: Get detailed log information by their id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
      */
-    getAuditLog({ id }?: AuditTrailPlatformValidator.GetAuditLogParam, { headers }?: import("../PlatformAPIClient").Options): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
+    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 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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
      */
-    getAuditLogs({ qs }?: AuditTrailPlatformValidator.GetAuditLogsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
+    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: 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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
      */
-    getEntityTypes({ headers }?: any): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
+    getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
 }
 import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
 import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -13,13 +13,17 @@ 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
    * @name createAuditLog
    * @summary: Create logs for auditing later on
    * @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 } = {}, { headers } = { headers: false }) {
+  async createAuditLog(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = AuditTrailPlatformValidator.createAuditLog().validate(
       {
         body,
@@ -56,12 +60,12 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -84,13 +88,17 @@ class AuditTrail {
 
   /**
    * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
    */
-  async getAuditLog({ id } = {}, { headers } = { headers: false }) {
+  async getAuditLog(
+    { id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = AuditTrailPlatformValidator.getAuditLog().validate(
       {
         id,
@@ -127,12 +135,12 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -155,16 +163,22 @@ class AuditTrail {
 
   /**
    * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
    */
-  async getAuditLogs({ qs } = {}, { headers } = { headers: false }) {
+  async getAuditLogs(
+    { qs, limit, sort, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = AuditTrailPlatformValidator.getAuditLogs().validate(
       {
         qs,
+        limit,
+        sort,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -178,6 +192,8 @@ class AuditTrail {
     } = AuditTrailPlatformValidator.getAuditLogs().validate(
       {
         qs,
+        limit,
+        sort,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -190,6 +206,8 @@ class AuditTrail {
 
     const query_params = {};
     query_params["qs"] = qs;
+    query_params["limit"] = limit;
+    query_params["sort"] = sort;
 
     const xHeaders = {};
 
@@ -199,12 +217,12 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -227,13 +245,17 @@ class AuditTrail {
 
   /**
    * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
    */
-  async getEntityTypes({ headers } = { headers: false }) {
+  async getEntityTypes(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = AuditTrailPlatformValidator.getEntityTypes().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -266,12 +288,12 @@ class AuditTrail {
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 

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

@@ -80,14 +80,10 @@ export = AuditTrailPlatformModel;
  * @property {LogMetaObj} log_meta
  * @property {Object} log_payload
  */
-/**
- * @typedef ResourceNotFound
- * @property {string} [message] - Resource not found with {id}
- */
 declare class AuditTrailPlatformModel {
 }
 declare namespace AuditTrailPlatformModel {
-    export { BadRequest, CreateLogResponse, DeviceInfo, EntityObj, EntityObject, EntityTypeObj, EntityTypesResponse, InternalServerError, Location, LogDocs, LogMetaObj, LogSchemaResponse, Modifier, RequestBodyAuditLog, ResourceNotFound };
+    export { BadRequest, CreateLogResponse, DeviceInfo, EntityObj, EntityObject, EntityTypeObj, EntityTypesResponse, InternalServerError, Location, LogDocs, LogMetaObj, LogSchemaResponse, Modifier, RequestBodyAuditLog };
 }
 /** @returns {BadRequest} */
 declare function BadRequest(): BadRequest;
@@ -193,11 +189,3 @@ type RequestBodyAuditLog = {
     log_meta: LogMetaObj;
     log_payload: any;
 };
-/** @returns {ResourceNotFound} */
-declare function ResourceNotFound(): ResourceNotFound;
-type ResourceNotFound = {
-    /**
-     * - Resource not found with {id}
-     */
-    message?: string;
-};

package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js

@@ -95,11 +95,6 @@ const Joi = require("joi");
  * @property {Object} log_payload
  */
 
-/**
- * @typedef ResourceNotFound
- * @property {string} [message] - Resource not found with {id}
- */
-
 class AuditTrailPlatformModel {
   /** @returns {BadRequest} */
   static BadRequest() {
@@ -223,12 +218,5 @@ class AuditTrailPlatformModel {
       log_payload: Joi.any().required(),
     });
   }
-
-  /** @returns {ResourceNotFound} */
-  static ResourceNotFound() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
 }
 module.exports = AuditTrailPlatformModel;

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

@@ -10,6 +10,8 @@ export = AuditTrailPlatformValidator;
 /**
  * @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 {
@@ -39,6 +41,14 @@ 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

@@ -15,6 +15,8 @@ const AuditTrailPlatformModel = require("./AuditTrailPlatformModel");
 /**
  * @typedef GetAuditLogsParam
  * @property {string} qs - Logs Query
+ * @property {number} [limit] - Current request items count
+ * @property {Object} [sort] - To sort based on _id
  */
 
 /** @typedef GetEntityTypesParam */
@@ -38,6 +40,8 @@ class AuditTrailPlatformValidator {
   static getAuditLogs() {
     return Joi.object({
       qs: Joi.string().allow("").required(),
+      limit: Joi.number(),
+      sort: Joi.any(),
     }).required();
   }