@gofynd/fdk-client-javascript 1.4.0-beta.1 → 1.4.0-beta.2

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -72,6 +72,7 @@ const Joi = require("joi");
 /**
  * @typedef AvailablePageSchema
  * @property {string} [_id]
+ * @property {string} [created_at] - The creation timestamp of the page
  * @property {string} [path]
  * @property {Object[]} [props]
  * @property {AvailablePageSchemaSections[]} [sections]
@@ -80,6 +81,7 @@ const Joi = require("joi");
  * @property {string} [text]
  * @property {string} [theme]
  * @property {string} [type]
+ * @property {string} [updated_at] - The last update timestamp of the page
  * @property {string} [value]
  */
 
@@ -91,6 +93,7 @@ const Joi = require("joi");
  * @property {AvailablePagePredicate} [predicate]
  * @property {Object} [preset]
  * @property {Object} [props]
+ * @property {string} [source]
  */
 
 /**
@@ -109,7 +112,6 @@ const Joi = require("joi");
  * @typedef AvailablePageSeo
  * @property {string} [_id]
  * @property {SEObreadcrumb[]} [breadcrumb]
- * @property {string} [canonical_url]
  * @property {string} [description]
  * @property {SEOMetaItem[]} [meta_tags]
  * @property {SEOSitemap} [sitemap]
@@ -202,6 +204,7 @@ const Joi = require("joi");
 
 /**
  * @typedef CSS
+ * @property {string} [link]
  * @property {string[]} [links]
  */
 
@@ -249,6 +252,12 @@ const Joi = require("joi");
  *   price color
  */
 
+/**
+ * @typedef DividerStrokeHighlight
+ * @property {string} [divider_strokes]
+ * @property {string} [highlight]
+ */
+
 /**
  * @typedef DummyResponse
  * @property {string} [message]
@@ -322,10 +331,22 @@ const Joi = require("joi");
  * @property {string} [_id] - The unique identifier for the marketplace theme.
  * @property {string} [created_at] - Creation date of the theme
  * @property {boolean} [is_default] - Whether the theme is the default theme.
- * @property {ReleaseVersionOnly} [release]
+ * @property {Release} [release]
  * @property {string} [updated_at] - Update date of the theme
  */
 
+/**
+ * @typedef OrderTracking
+ * @property {boolean} [show_footer]
+ * @property {boolean} [show_header]
+ */
+
+/**
+ * @typedef OverlayPopup
+ * @property {string} [dialog_backgroung]
+ * @property {string} [overlay]
+ */
+
 /**
  * @typedef Page
  * @property {number} [current]
@@ -356,6 +377,7 @@ const Joi = require("joi");
  * @property {string} [info] - Additional information about the property
  * @property {string} [label] - The label of the property
  * @property {string} [type] - The type of the property
+ * @property {string} [value] - The value of the property
  */
 
 /**
@@ -370,11 +392,6 @@ const Joi = require("joi");
  * @property {string} [version] - The version of the theme
  */
 
-/**
- * @typedef ReleaseVersionOnly
- * @property {string} [version] - The version of the theme
- */
-
 /**
  * @typedef Route
  * @property {string} [exact_url] - The exact URL of the route.
@@ -448,12 +465,22 @@ const Joi = require("joi");
  * @property {string} [value] - The value of the text property.
  */
 
+/**
+ * @typedef ThemeConfigListPage
+ * @property {string} [page] - Name of the page
+ * @property {ThemeConfigListPageSettingsProps} [settings]
+ */
+
+/**
+ * @typedef ThemeConfigListPageSettingsProps
+ * @property {Object} [props]
+ */
+
 /**
  * @typedef ThemeConfiguration
- * @property {CustomConfig} [custom]
  * @property {Object} [global_config]
  * @property {string} [name] - The name of the configuration
- * @property {string[]} [page] - An array of pages
+ * @property {ThemeConfigListPage[]} [page] - An array of pages
  */
 
 /**
@@ -500,6 +527,7 @@ const Joi = require("joi");
  * @property {string} [marketplace_theme_id] - The ID of the theme in the marketplace
  * @property {ThemeMeta} [meta]
  * @property {string} [name] - The name of the theme
+ * @property {string} [src]
  * @property {Object} [styles] - The styles associated with the theme
  * @property {string[]} [tags] - An array of tags associated with the theme
  * @property {string} [template_theme_id] - The ID of the template theme
@@ -529,6 +557,7 @@ const Joi = require("joi");
 
 /**
  * @typedef UMDJs
+ * @property {string} [link]
  * @property {string[]} [links] - An array of pages
  */
 
@@ -549,6 +578,16 @@ const Joi = require("joi");
  * @property {string} [value] - The value of the URL property.
  */
 
+/**
+ * @typedef UserAlerts
+ * @property {string} [error_background]
+ * @property {string} [error_text]
+ * @property {string} [info_background]
+ * @property {string} [info_text]
+ * @property {string} [success_background]
+ * @property {string} [success_text]
+ */
+
 /**
  * @typedef {| "about-us"
  *   | "addresses"
@@ -698,6 +737,7 @@ class ThemePlatformModel {
   static AvailablePageSchema() {
     return Joi.object({
       _id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
       path: Joi.string().allow(""),
       props: Joi.array().items(Joi.any()),
       sections: Joi.array().items(
@@ -710,6 +750,7 @@ class ThemePlatformModel {
       text: Joi.string().allow(""),
       theme: Joi.string().allow(""),
       type: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });
   }
@@ -723,6 +764,7 @@ class ThemePlatformModel {
       predicate: ThemePlatformModel.AvailablePagePredicate(),
       preset: Joi.any(),
       props: Joi.any(),
+      source: Joi.string().allow(""),
     });
   }
 
@@ -747,7 +789,6 @@ class ThemePlatformModel {
     return Joi.object({
       _id: Joi.string().allow(""),
       breadcrumb: Joi.array().items(ThemePlatformModel.SEObreadcrumb()),
-      canonical_url: Joi.string().allow(""),
       description: Joi.string().allow(""),
       meta_tags: Joi.array().items(ThemePlatformModel.SEOMetaItem()),
       sitemap: ThemePlatformModel.SEOSitemap(),
@@ -865,6 +906,7 @@ class ThemePlatformModel {
   /** @returns {CSS} */
   static CSS() {
     return Joi.object({
+      link: Joi.string().allow(""),
       links: Joi.array().items(Joi.string().allow("")),
     });
   }
@@ -912,6 +954,14 @@ class ThemePlatformModel {
     });
   }
 
+  /** @returns {DividerStrokeHighlight} */
+  static DividerStrokeHighlight() {
+    return Joi.object({
+      divider_strokes: Joi.string().allow(""),
+      highlight: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {DummyResponse} */
   static DummyResponse() {
     return Joi.object({
@@ -1006,11 +1056,27 @@ class ThemePlatformModel {
       _id: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       is_default: Joi.boolean(),
-      release: ThemePlatformModel.ReleaseVersionOnly(),
+      release: ThemePlatformModel.Release(),
       updated_at: Joi.string().allow(""),
     });
   }
 
+  /** @returns {OrderTracking} */
+  static OrderTracking() {
+    return Joi.object({
+      show_footer: Joi.boolean(),
+      show_header: Joi.boolean(),
+    });
+  }
+
+  /** @returns {OverlayPopup} */
+  static OverlayPopup() {
+    return Joi.object({
+      dialog_backgroung: Joi.string().allow(""),
+      overlay: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {Page} */
   static Page() {
     return Joi.object({
@@ -1048,6 +1114,7 @@ class ThemePlatformModel {
       info: Joi.string().allow(""),
       label: Joi.string().allow(""),
       type: Joi.string().allow(""),
+      value: Joi.string().allow(""),
     });
   }
 
@@ -1067,13 +1134,6 @@ class ThemePlatformModel {
     });
   }
 
-  /** @returns {ReleaseVersionOnly} */
-  static ReleaseVersionOnly() {
-    return Joi.object({
-      version: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {Route} */
   static Route() {
     return Joi.object({
@@ -1169,13 +1229,27 @@ class ThemePlatformModel {
     });
   }
 
+  /** @returns {ThemeConfigListPage} */
+  static ThemeConfigListPage() {
+    return Joi.object({
+      page: Joi.string().allow(""),
+      settings: ThemePlatformModel.ThemeConfigListPageSettingsProps(),
+    });
+  }
+
+  /** @returns {ThemeConfigListPageSettingsProps} */
+  static ThemeConfigListPageSettingsProps() {
+    return Joi.object({
+      props: Joi.any(),
+    });
+  }
+
   /** @returns {ThemeConfiguration} */
   static ThemeConfiguration() {
     return Joi.object({
-      custom: ThemePlatformModel.CustomConfig(),
       global_config: Joi.any(),
       name: Joi.string().allow(""),
-      page: Joi.array().items(Joi.string().allow("")),
+      page: Joi.array().items(ThemePlatformModel.ThemeConfigListPage()),
     });
   }
 
@@ -1231,6 +1305,7 @@ class ThemePlatformModel {
       marketplace_theme_id: Joi.string().allow(""),
       meta: ThemePlatformModel.ThemeMeta(),
       name: Joi.string().allow(""),
+      src: Joi.string().allow(""),
       styles: Joi.any(),
       tags: Joi.array().items(Joi.string().allow("")),
       template_theme_id: Joi.string().allow(""),
@@ -1268,6 +1343,7 @@ class ThemePlatformModel {
   /** @returns {UMDJs} */
   static UMDJs() {
     return Joi.object({
+      link: Joi.string().allow(""),
       links: Joi.array().items(Joi.string().allow("")),
     });
   }
@@ -1295,6 +1371,18 @@ class ThemePlatformModel {
     });
   }
 
+  /** @returns {UserAlerts} */
+  static UserAlerts() {
+    return Joi.object({
+      error_background: Joi.string().allow(""),
+      error_text: Joi.string().allow(""),
+      info_background: Joi.string().allow(""),
+      info_text: Joi.string().allow(""),
+      success_background: Joi.string().allow(""),
+      success_text: Joi.string().allow(""),
+    });
+  }
+
   /**
    * Enum: PageType Used By: Theme
    *

package/sdk/platform/Webhook/WebhookPlatformClient.d.ts

@@ -28,13 +28,13 @@ declare class Webhook {
      * @param {WebhookPlatformValidator.FetchAllEventConfigurationsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
+     * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
      * @name fetchAllEventConfigurations
      * @summary: Get All Webhook Events.
      * @description: To fetch all webhook events.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
      */
-    fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
+    fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
     /**
      * @param {WebhookPlatformValidator.GetDeliveryReportsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Webhook/WebhookPlatformClient.js

@@ -180,7 +180,7 @@ class Webhook {
    * @param {WebhookPlatformValidator.FetchAllEventConfigurationsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
+   * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
    * @name fetchAllEventConfigurations
    * @summary: Get All Webhook Events.
    * @description: To fetch all webhook events.
@@ -233,7 +233,9 @@ class Webhook {
       responseData = response[0];
     }
 
-    const { error: res_error } = Joi.any().validate(responseData, {
+    const {
+      error: res_error,
+    } = WebhookPlatformModel.EventConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

package/sdk/platform/Webhook/WebhookPlatformModel.d.ts

@@ -47,22 +47,15 @@ export = WebhookPlatformModel;
  * @property {string} [display_name]
  * @property {string} [event_category]
  * @property {string} [event_name]
+ * @property {Object} [event_schema]
  * @property {string} [event_type]
  * @property {number} [id]
+ * @property {string} [updated_on]
  * @property {string} [version]
  */
 /**
  * @typedef EventConfigResponse
- * @property {string} [created_on]
- * @property {string} [description]
- * @property {string} [display_name]
- * @property {string} [event_category]
- * @property {string} [event_name]
- * @property {Object} [event_schema]
- * @property {string} [event_type]
- * @property {number} [id]
- * @property {string} [updated_on]
- * @property {string} [version]
+ * @property {EventConfig[]} [event_configs]
  */
 /**
  * @typedef EventConfigs
@@ -224,7 +217,7 @@ export = WebhookPlatformModel;
  * @property {number[]} [event_id]
  * @property {number} [id]
  * @property {string} [name]
- * @property {string} [status]
+ * @property {SubscriberStatus} [status]
  * @property {string} [webhook_url]
  */
 /**
@@ -243,7 +236,7 @@ export = WebhookPlatformModel;
  * @property {number} [id]
  * @property {string} [modified_by]
  * @property {string} [name]
- * @property {string} [status]
+ * @property {SubscriberStatus} [status]
  * @property {string} [type]
  * @property {string} [updated_on]
  * @property {string} [webhook_url]
@@ -272,7 +265,7 @@ export = WebhookPlatformModel;
  * @property {number} [id]
  * @property {string} [modified_by]
  * @property {string} [name]
- * @property {string} [status]
+ * @property {SubscriberStatus} [status]
  * @property {string} [type]
  * @property {string} [updated_on]
  * @property {string} [webhook_url]
@@ -286,10 +279,11 @@ export = WebhookPlatformModel;
  * @property {string} [name] - The name of the uploaded report file.
  * @property {string} [url] - The URL of the uploaded report file.
  */
+/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
 declare class WebhookPlatformModel {
 }
 declare namespace WebhookPlatformModel {
-    export { Association, AuthMeta, CancelResponse, CdnObject, DownloadReportResponse, Err, Error, Event, EventConfig, EventConfigResponse, EventConfigs, EventProcessReportObject, EventProcessReports, EventProcessRequest, HistoryAssociation, HistoryFilters, HistoryItems, HistoryPayload, HistoryResponse, Item, Page, PingWebhook, PingWebhookResponse, ReportFilterResponse, ReportFiltersPayload, RetryCountResponse, RetryEventRequest, RetryFailureResponse, RetryStatusResponse, RetrySuccessResponse, SubscriberConfig, SubscriberConfigList, SubscriberConfigResponse, SubscriberEventMapping, SubscriberFailureResponse, SubscriberResponse, UploadServiceObject, Url };
+    export { Association, AuthMeta, CancelResponse, CdnObject, DownloadReportResponse, Err, Error, Event, EventConfig, EventConfigResponse, EventConfigs, EventProcessReportObject, EventProcessReports, EventProcessRequest, HistoryAssociation, HistoryFilters, HistoryItems, HistoryPayload, HistoryResponse, Item, Page, PingWebhook, PingWebhookResponse, ReportFilterResponse, ReportFiltersPayload, RetryCountResponse, RetryEventRequest, RetryFailureResponse, RetryStatusResponse, RetrySuccessResponse, SubscriberConfig, SubscriberConfigList, SubscriberConfigResponse, SubscriberEventMapping, SubscriberFailureResponse, SubscriberResponse, UploadServiceObject, Url, SubscriberStatus };
 }
 /** @returns {Association} */
 declare function Association(): Association;
@@ -354,23 +348,16 @@ type EventConfig = {
     display_name?: string;
     event_category?: string;
     event_name?: string;
+    event_schema?: any;
     event_type?: string;
     id?: number;
+    updated_on?: string;
     version?: string;
 };
 /** @returns {EventConfigResponse} */
 declare function EventConfigResponse(): EventConfigResponse;
 type EventConfigResponse = {
-    created_on?: string;
-    description?: string;
-    display_name?: string;
-    event_category?: string;
-    event_name?: string;
-    event_schema?: any;
-    event_type?: string;
-    id?: number;
-    updated_on?: string;
-    version?: string;
+    event_configs?: EventConfig[];
 };
 /** @returns {EventConfigs} */
 declare function EventConfigs(): EventConfigs;
@@ -658,7 +645,7 @@ type SubscriberConfig = {
     event_id?: number[];
     id?: number;
     name?: string;
-    status?: string;
+    status?: SubscriberStatus;
     webhook_url?: string;
 };
 /** @returns {SubscriberConfigList} */
@@ -679,7 +666,7 @@ type SubscriberConfigResponse = {
     id?: number;
     modified_by?: string;
     name?: string;
-    status?: string;
+    status?: SubscriberStatus;
     type?: string;
     updated_on?: string;
     webhook_url?: string;
@@ -711,7 +698,7 @@ type SubscriberResponse = {
     id?: number;
     modified_by?: string;
     name?: string;
-    status?: string;
+    status?: SubscriberStatus;
     type?: string;
     updated_on?: string;
     webhook_url?: string;
@@ -733,3 +720,10 @@ type Url = {
      */
     url?: string;
 };
+/**
+ * Enum: SubscriberStatus Used By: Webhook
+ *
+ * @returns {SubscriberStatus}
+ */
+declare function SubscriberStatus(): SubscriberStatus;
+type SubscriberStatus = "active" | "inactive" | "blocked";

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -56,23 +56,16 @@ const Joi = require("joi");
  * @property {string} [display_name]
  * @property {string} [event_category]
  * @property {string} [event_name]
+ * @property {Object} [event_schema]
  * @property {string} [event_type]
  * @property {number} [id]
+ * @property {string} [updated_on]
  * @property {string} [version]
  */
 
 /**
  * @typedef EventConfigResponse
- * @property {string} [created_on]
- * @property {string} [description]
- * @property {string} [display_name]
- * @property {string} [event_category]
- * @property {string} [event_name]
- * @property {Object} [event_schema]
- * @property {string} [event_type]
- * @property {number} [id]
- * @property {string} [updated_on]
- * @property {string} [version]
+ * @property {EventConfig[]} [event_configs]
  */
 
 /**
@@ -255,7 +248,7 @@ const Joi = require("joi");
  * @property {number[]} [event_id]
  * @property {number} [id]
  * @property {string} [name]
- * @property {string} [status]
+ * @property {SubscriberStatus} [status]
  * @property {string} [webhook_url]
  */
 
@@ -276,7 +269,7 @@ const Joi = require("joi");
  * @property {number} [id]
  * @property {string} [modified_by]
  * @property {string} [name]
- * @property {string} [status]
+ * @property {SubscriberStatus} [status]
  * @property {string} [type]
  * @property {string} [updated_on]
  * @property {string} [webhook_url]
@@ -308,7 +301,7 @@ const Joi = require("joi");
  * @property {number} [id]
  * @property {string} [modified_by]
  * @property {string} [name]
- * @property {string} [status]
+ * @property {SubscriberStatus} [status]
  * @property {string} [type]
  * @property {string} [updated_on]
  * @property {string} [webhook_url]
@@ -325,6 +318,8 @@ const Joi = require("joi");
  * @property {string} [url] - The URL of the uploaded report file.
  */
 
+/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
+
 class WebhookPlatformModel {
   /** @returns {Association} */
   static Association() {
@@ -395,12 +390,14 @@ class WebhookPlatformModel {
   static EventConfig() {
     return Joi.object({
       created_on: Joi.string().allow(""),
-      description: Joi.string().allow(""),
+      description: Joi.string().allow("").allow(null),
       display_name: Joi.string().allow(""),
       event_category: Joi.string().allow(""),
       event_name: Joi.string().allow(""),
+      event_schema: Joi.object().pattern(/\S/, Joi.any()),
       event_type: Joi.string().allow(""),
       id: Joi.number(),
+      updated_on: Joi.string().allow(""),
       version: Joi.string().allow(""),
     });
   }
@@ -408,16 +405,7 @@ class WebhookPlatformModel {
   /** @returns {EventConfigResponse} */
   static EventConfigResponse() {
     return Joi.object({
-      created_on: Joi.string().allow(""),
-      description: Joi.string().allow("").allow(null),
-      display_name: Joi.string().allow(""),
-      event_category: Joi.string().allow(""),
-      event_name: Joi.string().allow(""),
-      event_schema: Joi.object().pattern(/\S/, Joi.any()),
-      event_type: Joi.string().allow(""),
-      id: Joi.number(),
-      updated_on: Joi.string().allow(""),
-      version: Joi.string().allow(""),
+      event_configs: Joi.array().items(WebhookPlatformModel.EventConfig()),
     });
   }
 
@@ -636,7 +624,7 @@ class WebhookPlatformModel {
       event_id: Joi.array().items(Joi.number()),
       id: Joi.number(),
       name: Joi.string().allow(""),
-      status: Joi.string().allow(""),
+      status: WebhookPlatformModel.SubscriberStatus(),
       webhook_url: Joi.string().allow(""),
     });
   }
@@ -661,7 +649,7 @@ class WebhookPlatformModel {
       id: Joi.number(),
       modified_by: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      status: Joi.string().allow(""),
+      status: WebhookPlatformModel.SubscriberStatus(),
       type: Joi.string().allow("").allow(null),
       updated_on: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
@@ -699,7 +687,7 @@ class WebhookPlatformModel {
       id: Joi.number(),
       modified_by: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      status: Joi.string().allow(""),
+      status: WebhookPlatformModel.SubscriberStatus(),
       type: Joi.string().allow("").allow(null),
       updated_on: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
@@ -720,5 +708,20 @@ class WebhookPlatformModel {
       url: Joi.string().allow(""),
     });
   }
+
+  /**
+   * Enum: SubscriberStatus Used By: Webhook
+   *
+   * @returns {SubscriberStatus}
+   */
+  static SubscriberStatus() {
+    return Joi.string().valid(
+      "active",
+
+      "inactive",
+
+      "blocked"
+    );
+  }
 }
 module.exports = WebhookPlatformModel;