@gofynd/fdk-client-javascript 1.4.13 → 1.4.14

package/sdk/public/Content/ContentPublicValidator.d.ts

@@ -1,18 +1,84 @@
 export = ContentPublicValidator;
+/** @typedef GetAllTagsParam */
+/** @typedef GetAnalyticsTagsParam */
+/** @typedef GetBasicDetailsParam */
 /**
  * @typedef GetCredentialsByEntityParam
- * @property {string} entity - Server Type
+ * @property {string} entityType - Server Type
  */
+/**
+ * @typedef GetCustomPageParam
+ * @property {string} slug - Unique identifier created for each feature object
+ *   in the schema.
+ */
+/** @typedef GetFooterContentParam */
+/**
+ * @typedef GetHomePageContentParam
+ * @property {string} pageType - The type of the page (e.g., pricing).
+ */
+/** @typedef GetMenuContentParam */
+/**
+ * @typedef GetMenuContentByTypeParam
+ * @property {string} type - Type param is type of device
+ */
+/** @typedef GetNavbarParam */
+/** @typedef GetPricingBannerParam */
 declare class ContentPublicValidator {
+    /** @returns {GetAllTagsParam} */
+    static getAllTags(): any;
+    /** @returns {GetAnalyticsTagsParam} */
+    static getAnalyticsTags(): any;
+    /** @returns {GetBasicDetailsParam} */
+    static getBasicDetails(): any;
     /** @returns {GetCredentialsByEntityParam} */
     static getCredentialsByEntity(): GetCredentialsByEntityParam;
+    /** @returns {GetCustomPageParam} */
+    static getCustomPage(): GetCustomPageParam;
+    /** @returns {GetFooterContentParam} */
+    static getFooterContent(): any;
+    /** @returns {GetHomePageContentParam} */
+    static getHomePageContent(): GetHomePageContentParam;
+    /** @returns {GetMenuContentParam} */
+    static getMenuContent(): any;
+    /** @returns {GetMenuContentByTypeParam} */
+    static getMenuContentByType(): GetMenuContentByTypeParam;
+    /** @returns {GetNavbarParam} */
+    static getNavbar(): any;
+    /** @returns {GetPricingBannerParam} */
+    static getPricingBanner(): any;
 }
 declare namespace ContentPublicValidator {
-    export { GetCredentialsByEntityParam };
+    export { GetAllTagsParam, GetAnalyticsTagsParam, GetBasicDetailsParam, GetCredentialsByEntityParam, GetCustomPageParam, GetFooterContentParam, GetHomePageContentParam, GetMenuContentParam, GetMenuContentByTypeParam, GetNavbarParam, GetPricingBannerParam };
 }
 type GetCredentialsByEntityParam = {
     /**
      * - Server Type
      */
-    entity: string;
+    entityType: string;
+};
+type GetCustomPageParam = {
+    /**
+     * - Unique identifier created for each feature object
+     * in the schema.
+     */
+    slug: string;
+};
+type GetHomePageContentParam = {
+    /**
+     * - The type of the page (e.g., pricing).
+     */
+    pageType: string;
+};
+type GetMenuContentByTypeParam = {
+    /**
+     * - Type param is type of device
+     */
+    type: string;
 };
+type GetAllTagsParam = any;
+type GetAnalyticsTagsParam = any;
+type GetBasicDetailsParam = any;
+type GetFooterContentParam = any;
+type GetMenuContentParam = any;
+type GetNavbarParam = any;
+type GetPricingBannerParam = any;

package/sdk/public/Content/ContentPublicValidator.js

@@ -2,18 +2,104 @@ const Joi = require("joi");
 
 const ContentPublicModel = require("./ContentPublicModel");
 
+/** @typedef GetAllTagsParam */
+
+/** @typedef GetAnalyticsTagsParam */
+
+/** @typedef GetBasicDetailsParam */
+
 /**
  * @typedef GetCredentialsByEntityParam
- * @property {string} entity - Server Type
+ * @property {string} entityType - Server Type
+ */
+
+/**
+ * @typedef GetCustomPageParam
+ * @property {string} slug - Unique identifier created for each feature object
+ *   in the schema.
  */
 
+/** @typedef GetFooterContentParam */
+
+/**
+ * @typedef GetHomePageContentParam
+ * @property {string} pageType - The type of the page (e.g., pricing).
+ */
+
+/** @typedef GetMenuContentParam */
+
+/**
+ * @typedef GetMenuContentByTypeParam
+ * @property {string} type - Type param is type of device
+ */
+
+/** @typedef GetNavbarParam */
+
+/** @typedef GetPricingBannerParam */
+
 class ContentPublicValidator {
+  /** @returns {GetAllTagsParam} */
+  static getAllTags() {
+    return Joi.object({});
+  }
+
+  /** @returns {GetAnalyticsTagsParam} */
+  static getAnalyticsTags() {
+    return Joi.object({});
+  }
+
+  /** @returns {GetBasicDetailsParam} */
+  static getBasicDetails() {
+    return Joi.object({});
+  }
+
   /** @returns {GetCredentialsByEntityParam} */
   static getCredentialsByEntity() {
     return Joi.object({
-      entity: Joi.string().allow("").required(),
+      entityType: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCustomPageParam} */
+  static getCustomPage() {
+    return Joi.object({
+      slug: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetFooterContentParam} */
+  static getFooterContent() {
+    return Joi.object({});
+  }
+
+  /** @returns {GetHomePageContentParam} */
+  static getHomePageContent() {
+    return Joi.object({
+      pageType: Joi.string().allow("").required(),
     }).required();
   }
+
+  /** @returns {GetMenuContentParam} */
+  static getMenuContent() {
+    return Joi.object({});
+  }
+
+  /** @returns {GetMenuContentByTypeParam} */
+  static getMenuContentByType() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetNavbarParam} */
+  static getNavbar() {
+    return Joi.object({});
+  }
+
+  /** @returns {GetPricingBannerParam} */
+  static getPricingBanner() {
+    return Joi.object({});
+  }
 }
 
 module.exports = ContentPublicValidator;

package/sdk/public/Webhook/WebhookPublicClient.d.ts

@@ -15,12 +15,12 @@ declare class Webhook {
      * @param {WebhookPublicValidator.FetchAllWebhookEventsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+     * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
      * @name fetchAllWebhookEvents
      * @summary: Fetch all webhook events.
      * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
      */
-    fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
+    fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventDetails>;
     /**
      * @param {WebhookPublicValidator.NotifyDepricatedEventParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -35,32 +35,32 @@ declare class Webhook {
      * @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+     * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
      * @name queryWebhookEventDetails
      * @summary: Query webhook event details.
      * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
      */
-    queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
+    queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventDetails>;
     /**
      * @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - Success response
+     * @returns {Promise<WebhookPublicModel.TransformEventResult>} - Success response
      * @name testHandlerTransformation
      * @summary: Test transformation of handler
      * @description: Test transformation of handler - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/testHandlerTransformation/).
      */
-    testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.TransformEventResponse>;
+    testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.TransformEventResult>;
     /**
      * @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - Success response
+     * @returns {Promise<WebhookPublicModel.ValidateSchemaResult>} - Success response
      * @name validateSchema
      * @summary: Validate Schema for an event
      * @description: Validate Schema for an event - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/validateSchema/).
      */
-    validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.ValidateSchemaResponse>;
+    validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.ValidateSchemaResult>;
 }
 import WebhookPublicModel = require("./WebhookPublicModel");
 import WebhookPublicValidator = require("./WebhookPublicValidator");

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -44,7 +44,7 @@ class Webhook {
    * @param {WebhookPublicValidator.FetchAllWebhookEventsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+   * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
    * @name fetchAllWebhookEvents
    * @summary: Fetch all webhook events.
    * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
@@ -99,7 +99,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
+    } = WebhookPublicModel.EventDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -200,7 +200,7 @@ class Webhook {
    * @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
+   * @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
    * @name queryWebhookEventDetails
    * @summary: Query webhook event details.
    * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
@@ -257,7 +257,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.EventConfigResponse().validate(responseData, {
+    } = WebhookPublicModel.EventDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -280,7 +280,7 @@ class Webhook {
    * @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - Success response
+   * @returns {Promise<WebhookPublicModel.TransformEventResult>} - Success response
    * @name testHandlerTransformation
    * @summary: Test transformation of handler
    * @description: Test transformation of handler - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/testHandlerTransformation/).
@@ -337,7 +337,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.TransformEventResponse().validate(responseData, {
+    } = WebhookPublicModel.TransformEventResult().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -360,7 +360,7 @@ class Webhook {
    * @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - Success response
+   * @returns {Promise<WebhookPublicModel.ValidateSchemaResult>} - Success response
    * @name validateSchema
    * @summary: Validate Schema for an event
    * @description: Validate Schema for an event - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/validateSchema/).
@@ -415,7 +415,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPublicModel.ValidateSchemaResponse().validate(responseData, {
+    } = WebhookPublicModel.ValidateSchemaResult().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

package/sdk/public/Webhook/WebhookPublicModel.d.ts

@@ -14,7 +14,7 @@ export = WebhookPublicModel;
  * @property {string} [group]
  */
 /**
- * @typedef EventConfigResponse
+ * @typedef EventDetails
  * @property {EventConfig[]} [event_configs]
  */
 /**
@@ -58,7 +58,7 @@ export = WebhookPublicModel;
  * @property {number} [company_id]
  */
 /**
- * @typedef TransformEventRequest
+ * @typedef TransformEventPayload
  * @property {string} event_name
  * @property {string} event_type
  * @property {string} event_category
@@ -66,7 +66,7 @@ export = WebhookPublicModel;
  * @property {EventSchema} event
  */
 /**
- * @typedef ValidateSchemaRequest
+ * @typedef ValidateSchemaPayload
  * @property {string} event_name
  * @property {string} event_type
  * @property {string} event_category
@@ -75,12 +75,12 @@ export = WebhookPublicModel;
  * @property {Object} event_schema
  */
 /**
- * @typedef ValidateSchemaResponse
+ * @typedef ValidateSchemaResult
  * @property {boolean} [status]
  * @property {string} [message]
  */
 /**
- * @typedef TransformEventResponse
+ * @typedef TransformEventResult
  * @property {string[]} [event_trace_id]
  * @property {TransformEventData} [data]
  * @property {string} [event_name]
@@ -93,7 +93,7 @@ export = WebhookPublicModel;
 declare class WebhookPublicModel {
 }
 declare namespace WebhookPublicModel {
-    export { EventConfig, EventConfigResponse, EventConfigBase, EventNotifier, EventSchema, InternalTransformEvent, TransformEventData, TransformEventServiceMeta, TransformEventAssociation, TransformEventRequest, ValidateSchemaRequest, ValidateSchemaResponse, TransformEventResponse };
+    export { EventConfig, EventDetails, EventConfigBase, EventNotifier, EventSchema, InternalTransformEvent, TransformEventData, TransformEventServiceMeta, TransformEventAssociation, TransformEventPayload, ValidateSchemaPayload, ValidateSchemaResult, TransformEventResult };
 }
 /** @returns {EventConfig} */
 declare function EventConfig(): EventConfig;
@@ -110,9 +110,9 @@ type EventConfig = {
     updated_on?: string;
     group?: string;
 };
-/** @returns {EventConfigResponse} */
-declare function EventConfigResponse(): EventConfigResponse;
-type EventConfigResponse = {
+/** @returns {EventDetails} */
+declare function EventDetails(): EventDetails;
+type EventDetails = {
     event_configs?: EventConfig[];
 };
 /** @returns {EventConfigBase} */
@@ -162,18 +162,18 @@ declare function TransformEventAssociation(): TransformEventAssociation;
 type TransformEventAssociation = {
     company_id?: number;
 };
-/** @returns {TransformEventRequest} */
-declare function TransformEventRequest(): TransformEventRequest;
-type TransformEventRequest = {
+/** @returns {TransformEventPayload} */
+declare function TransformEventPayload(): TransformEventPayload;
+type TransformEventPayload = {
     event_name: string;
     event_type: string;
     event_category: string;
     event_version: string;
     event: EventSchema;
 };
-/** @returns {ValidateSchemaRequest} */
-declare function ValidateSchemaRequest(): ValidateSchemaRequest;
-type ValidateSchemaRequest = {
+/** @returns {ValidateSchemaPayload} */
+declare function ValidateSchemaPayload(): ValidateSchemaPayload;
+type ValidateSchemaPayload = {
     event_name: string;
     event_type: string;
     event_category: string;
@@ -181,15 +181,15 @@ type ValidateSchemaRequest = {
     event: EventSchema;
     event_schema: any;
 };
-/** @returns {ValidateSchemaResponse} */
-declare function ValidateSchemaResponse(): ValidateSchemaResponse;
-type ValidateSchemaResponse = {
+/** @returns {ValidateSchemaResult} */
+declare function ValidateSchemaResult(): ValidateSchemaResult;
+type ValidateSchemaResult = {
     status?: boolean;
     message?: string;
 };
-/** @returns {TransformEventResponse} */
-declare function TransformEventResponse(): TransformEventResponse;
-type TransformEventResponse = {
+/** @returns {TransformEventResult} */
+declare function TransformEventResult(): TransformEventResult;
+type TransformEventResult = {
     event_trace_id?: string[];
     data?: TransformEventData;
     event_name?: string;

package/sdk/public/Webhook/WebhookPublicModel.js

@@ -16,7 +16,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef EventConfigResponse
+ * @typedef EventDetails
  * @property {EventConfig[]} [event_configs]
  */
 
@@ -68,7 +68,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef TransformEventRequest
+ * @typedef TransformEventPayload
  * @property {string} event_name
  * @property {string} event_type
  * @property {string} event_category
@@ -77,7 +77,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ValidateSchemaRequest
+ * @typedef ValidateSchemaPayload
  * @property {string} event_name
  * @property {string} event_type
  * @property {string} event_category
@@ -87,13 +87,13 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ValidateSchemaResponse
+ * @typedef ValidateSchemaResult
  * @property {boolean} [status]
  * @property {string} [message]
  */
 
 /**
- * @typedef TransformEventResponse
+ * @typedef TransformEventResult
  * @property {string[]} [event_trace_id]
  * @property {TransformEventData} [data]
  * @property {string} [event_name]
@@ -122,8 +122,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {EventConfigResponse} */
-  static EventConfigResponse() {
+  /** @returns {EventDetails} */
+  static EventDetails() {
     return Joi.object({
       event_configs: Joi.array().items(WebhookPublicModel.EventConfig()),
     });
@@ -190,8 +190,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {TransformEventRequest} */
-  static TransformEventRequest() {
+  /** @returns {TransformEventPayload} */
+  static TransformEventPayload() {
     return Joi.object({
       event_name: Joi.string().allow("").required(),
       event_type: Joi.string().allow("").required(),
@@ -201,8 +201,8 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {ValidateSchemaRequest} */
-  static ValidateSchemaRequest() {
+  /** @returns {ValidateSchemaPayload} */
+  static ValidateSchemaPayload() {
     return Joi.object({
       event_name: Joi.string().allow("").required(),
       event_type: Joi.string().allow("").required(),
@@ -213,16 +213,16 @@ class WebhookPublicModel {
     });
   }
 
-  /** @returns {ValidateSchemaResponse} */
-  static ValidateSchemaResponse() {
+  /** @returns {ValidateSchemaResult} */
+  static ValidateSchemaResult() {
     return Joi.object({
       status: Joi.boolean(),
       message: Joi.string().allow(""),
     });
   }
 
-  /** @returns {TransformEventResponse} */
-  static TransformEventResponse() {
+  /** @returns {TransformEventResult} */
+  static TransformEventResult() {
     return Joi.object({
       event_trace_id: Joi.array().items(Joi.string().allow("")),
       data: WebhookPublicModel.TransformEventData(),

package/sdk/public/Webhook/WebhookPublicValidator.d.ts

@@ -7,11 +7,11 @@ export = WebhookPublicValidator;
  */
 /**
  * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventRequest} body
+ * @property {WebhookPublicModel.TransformEventPayload} body
  */
 /**
  * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaRequest} body
+ * @property {WebhookPublicModel.ValidateSchemaPayload} body
  */
 declare class WebhookPublicValidator {
     /** @returns {FetchAllWebhookEventsParam} */
@@ -32,10 +32,10 @@ type QueryWebhookEventDetailsParam = {
     body: WebhookPublicModel.EventConfigBase[];
 };
 type TestHandlerTransformationParam = {
-    body: WebhookPublicModel.TransformEventRequest;
+    body: WebhookPublicModel.TransformEventPayload;
 };
 type ValidateSchemaParam = {
-    body: WebhookPublicModel.ValidateSchemaRequest;
+    body: WebhookPublicModel.ValidateSchemaPayload;
 };
 type FetchAllWebhookEventsParam = any;
 type NotifyDepricatedEventParam = any;

package/sdk/public/Webhook/WebhookPublicValidator.js

@@ -13,12 +13,12 @@ const WebhookPublicModel = require("./WebhookPublicModel");
 
 /**
  * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventRequest} body
+ * @property {WebhookPublicModel.TransformEventPayload} body
  */
 
 /**
  * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaRequest} body
+ * @property {WebhookPublicModel.ValidateSchemaPayload} body
  */
 
 class WebhookPublicValidator {
@@ -42,14 +42,14 @@ class WebhookPublicValidator {
   /** @returns {TestHandlerTransformationParam} */
   static testHandlerTransformation() {
     return Joi.object({
-      body: WebhookPublicModel.TransformEventRequest().required(),
+      body: WebhookPublicModel.TransformEventPayload().required(),
     }).required();
   }
 
   /** @returns {ValidateSchemaParam} */
   static validateSchema() {
     return Joi.object({
-      body: WebhookPublicModel.ValidateSchemaRequest().required(),
+      body: WebhookPublicModel.ValidateSchemaPayload().required(),
     }).required();
   }
 }