@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -91,6 +91,12 @@ export = ThemePlatformModel;
 /**
  * @typedef AvailablePageSectionMetaAttributes
  * @property {Object} [attributes]
+ * @property {CanvasItem} [canvas]
+ */
+/**
+ * @typedef CanvasItem
+ * @property {string} [value]
+ * @property {string} [label]
  */
 /**
  * @typedef SEOMetaItem
@@ -131,11 +137,21 @@ export = ThemePlatformModel;
  * @typedef AvailablePageSchemaSections
  * @property {string} [name]
  * @property {string} [label]
+ * @property {string} [canvas]
  * @property {Object} [props]
+ * @property {string} [custom_css] - Custom CSS for a section
  * @property {Object[]} [blocks]
  * @property {Object} [preset]
  * @property {AvailablePagePredicate} [predicate]
- * @property {string} [source]
+ * @property {SectionSource} [__source]
+ */
+/**
+ * @typedef SectionSource
+ * @property {string} [id] - The source id specifying the source of the section.
+ * @property {string} [bundle_name] - This is the extension binding name
+ *   containing this section.
+ * @property {string} [type] - This is source type. It will either be
+ *   themeBundle or extension.
  */
 /**
  * @typedef AvailablePagePredicate
@@ -237,7 +253,7 @@ export = ThemePlatformModel;
  * @property {string} [src]
  */
 /**
- * @typedef ThemeUpgradableResponse
+ * @typedef ThemeUpgradable
  * @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
  * @property {ThemeVersions} [versions]
  * @property {string} [message] - A message describing the theme upgrade status
@@ -379,7 +395,16 @@ export = ThemePlatformModel;
  */
 /**
  * @typedef GlobalSchema
- * @property {Object[]} [props]
+ * @property {Prop[]} [props]
+ */
+/**
+ * @typedef Prop
+ * @property {string} [type] - The type of the property
+ * @property {string} [category] - The category of the property
+ * @property {string} [value] - The value of the property
+ * @property {string} [id] - The ID of the property
+ * @property {string} [label] - The label of the property
+ * @property {string} [info] - Additional information about the property
  */
 /**
  * @typedef Assets
@@ -500,7 +525,7 @@ export = ThemePlatformModel;
  * @property {string} [applied_theme] - The version of the applied theme
  */
 /**
- * @typedef DummyResponse
+ * @typedef DummyTheme
  * @property {string} [message]
  */
 /**
@@ -557,8 +582,8 @@ export = ThemePlatformModel;
  *   | "profile-order-shipment"
  *   | "profile-basic"
  *   | "profile-company"
- *   | "profile-emails"
- *   | "profile-phones"
+ *   | "profile-email"
+ *   | "profile-phone"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -576,12 +601,15 @@ export = ThemePlatformModel;
  *   | "shipping-policy"
  *   | "return-policy"
  *   | "order-status"
- *   | "locate-us"} PageType
+ *   | "locate-us"
+ *   | "single-page-checkout"
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 declare class ThemePlatformModel {
 }
 declare namespace ThemePlatformModel {
-    export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradableResponse, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyResponse, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
+    export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, CanvasItem, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
 }
 /** @returns {GetExtensionSectionRes} */
 declare function GetExtensionSectionRes(): GetExtensionSectionRes;
@@ -744,6 +772,13 @@ type AvailablePageSchema = {
 declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
 type AvailablePageSectionMetaAttributes = {
     attributes?: any;
+    canvas?: CanvasItem;
+};
+/** @returns {CanvasItem} */
+declare function CanvasItem(): CanvasItem;
+type CanvasItem = {
+    value?: string;
+    label?: string;
 };
 /** @returns {SEOMetaItem} */
 declare function SEOMetaItem(): SEOMetaItem;
@@ -794,11 +829,34 @@ declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
 type AvailablePageSchemaSections = {
     name?: string;
     label?: string;
+    canvas?: string;
     props?: any;
+    /**
+     * - Custom CSS for a section
+     */
+    custom_css?: string;
     blocks?: any[];
     preset?: any;
     predicate?: AvailablePagePredicate;
-    source?: string;
+    __source?: SectionSource;
+};
+/** @returns {SectionSource} */
+declare function SectionSource(): SectionSource;
+type SectionSource = {
+    /**
+     * - The source id specifying the source of the section.
+     */
+    id?: string;
+    /**
+     * - This is the extension binding name
+     * containing this section.
+     */
+    bundle_name?: string;
+    /**
+     * - This is source type. It will either be
+     * themeBundle or extension.
+     */
+    type?: string;
 };
 /** @returns {AvailablePagePredicate} */
 declare function AvailablePagePredicate(): AvailablePagePredicate;
@@ -967,9 +1025,9 @@ type ThemesSchema = {
     company_id?: number;
     src?: string;
 };
-/** @returns {ThemeUpgradableResponse} */
-declare function ThemeUpgradableResponse(): ThemeUpgradableResponse;
-type ThemeUpgradableResponse = {
+/** @returns {ThemeUpgradable} */
+declare function ThemeUpgradable(): ThemeUpgradable;
+type ThemeUpgradable = {
     /**
      * - Indicates if the theme is upgradable or not
      */
@@ -1277,7 +1335,35 @@ type CustomProps = {
 /** @returns {GlobalSchema} */
 declare function GlobalSchema(): GlobalSchema;
 type GlobalSchema = {
-    props?: any[];
+    props?: Prop[];
+};
+/** @returns {Prop} */
+declare function Prop(): Prop;
+type Prop = {
+    /**
+     * - The type of the property
+     */
+    type?: string;
+    /**
+     * - The category of the property
+     */
+    category?: string;
+    /**
+     * - The value of the property
+     */
+    value?: string;
+    /**
+     * - The ID of the property
+     */
+    id?: string;
+    /**
+     * - The label of the property
+     */
+    label?: string;
+    /**
+     * - Additional information about the property
+     */
+    info?: string;
 };
 /** @returns {Assets} */
 declare function Assets(): Assets;
@@ -1500,9 +1586,9 @@ type ThemeVersions = {
      */
     applied_theme?: string;
 };
-/** @returns {DummyResponse} */
-declare function DummyResponse(): DummyResponse;
-type DummyResponse = {
+/** @returns {DummyTheme} */
+declare function DummyTheme(): DummyTheme;
+type DummyTheme = {
     message?: string;
 };
 /** @returns {AppliedThemes} */
@@ -1581,4 +1667,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -103,6 +103,13 @@ const Joi = require("joi");
 /**
  * @typedef AvailablePageSectionMetaAttributes
  * @property {Object} [attributes]
+ * @property {CanvasItem} [canvas]
+ */
+
+/**
+ * @typedef CanvasItem
+ * @property {string} [value]
+ * @property {string} [label]
  */
 
 /**
@@ -150,11 +157,22 @@ const Joi = require("joi");
  * @typedef AvailablePageSchemaSections
  * @property {string} [name]
  * @property {string} [label]
+ * @property {string} [canvas]
  * @property {Object} [props]
+ * @property {string} [custom_css] - Custom CSS for a section
  * @property {Object[]} [blocks]
  * @property {Object} [preset]
  * @property {AvailablePagePredicate} [predicate]
- * @property {string} [source]
+ * @property {SectionSource} [__source]
+ */
+
+/**
+ * @typedef SectionSource
+ * @property {string} [id] - The source id specifying the source of the section.
+ * @property {string} [bundle_name] - This is the extension binding name
+ *   containing this section.
+ * @property {string} [type] - This is source type. It will either be
+ *   themeBundle or extension.
  */
 
 /**
@@ -271,7 +289,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ThemeUpgradableResponse
+ * @typedef ThemeUpgradable
  * @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
  * @property {ThemeVersions} [versions]
  * @property {string} [message] - A message describing the theme upgrade status
@@ -432,7 +450,17 @@ const Joi = require("joi");
 
 /**
  * @typedef GlobalSchema
- * @property {Object[]} [props]
+ * @property {Prop[]} [props]
+ */
+
+/**
+ * @typedef Prop
+ * @property {string} [type] - The type of the property
+ * @property {string} [category] - The category of the property
+ * @property {string} [value] - The value of the property
+ * @property {string} [id] - The ID of the property
+ * @property {string} [label] - The label of the property
+ * @property {string} [info] - Additional information about the property
  */
 
 /**
@@ -576,7 +604,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef DummyResponse
+ * @typedef DummyTheme
  * @property {string} [message]
  */
 
@@ -637,8 +665,8 @@ const Joi = require("joi");
  *   | "profile-order-shipment"
  *   | "profile-basic"
  *   | "profile-company"
- *   | "profile-emails"
- *   | "profile-phones"
+ *   | "profile-email"
+ *   | "profile-phone"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -656,7 +684,10 @@ const Joi = require("joi");
  *   | "shipping-policy"
  *   | "return-policy"
  *   | "order-status"
- *   | "locate-us"} PageType
+ *   | "locate-us"
+ *   | "single-page-checkout"
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 
 class ThemePlatformModel {
@@ -787,7 +818,16 @@ class ThemePlatformModel {
   /** @returns {AvailablePageSectionMetaAttributes} */
   static AvailablePageSectionMetaAttributes() {
     return Joi.object({
-      attributes: Joi.any(),
+      attributes: Joi.object().pattern(/\S/, Joi.any()),
+      canvas: ThemePlatformModel.CanvasItem(),
+    });
+  }
+
+  /** @returns {CanvasItem} */
+  static CanvasItem() {
+    return Joi.object({
+      value: Joi.string().allow(""),
+      label: Joi.string().allow(""),
     });
   }
 
@@ -849,11 +889,22 @@ class ThemePlatformModel {
     return Joi.object({
       name: Joi.string().allow(""),
       label: Joi.string().allow(""),
-      props: Joi.any(),
+      canvas: Joi.string().allow(""),
+      props: Joi.object().pattern(/\S/, Joi.any()),
+      custom_css: Joi.string().allow(""),
       blocks: Joi.array().items(Joi.any()),
-      preset: Joi.any(),
+      preset: Joi.object().pattern(/\S/, Joi.any()),
       predicate: ThemePlatformModel.AvailablePagePredicate(),
-      source: Joi.string().allow(""),
+      __source: ThemePlatformModel.SectionSource(),
+    });
+  }
+
+  /** @returns {SectionSource} */
+  static SectionSource() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      bundle_name: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     });
   }
 
@@ -891,7 +942,7 @@ class ThemePlatformModel {
     return Joi.object({
       selected: Joi.string().allow(""),
       exact_url: Joi.string().allow(""),
-      query: Joi.any(),
+      query: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -987,7 +1038,7 @@ class ThemePlatformModel {
       name: Joi.string().allow(""),
       template_theme_id: Joi.string().allow(""),
       version: Joi.string().allow(""),
-      styles: Joi.any(),
+      styles: Joi.object().pattern(/\S/, Joi.any()),
       created_at: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
       assets: ThemePlatformModel.Assets(),
@@ -998,8 +1049,8 @@ class ThemePlatformModel {
     });
   }
 
-  /** @returns {ThemeUpgradableResponse} */
-  static ThemeUpgradableResponse() {
+  /** @returns {ThemeUpgradable} */
+  static ThemeUpgradable() {
     return Joi.object({
       upgrade: Joi.boolean(),
       versions: ThemePlatformModel.ThemeVersions(),
@@ -1065,7 +1116,7 @@ class ThemePlatformModel {
   static ThemeConfiguration() {
     return Joi.object({
       name: Joi.string().allow(""),
-      global_config: Joi.any(),
+      global_config: Joi.object().pattern(/\S/, Joi.any()),
       page: Joi.array().items(ThemePlatformModel.ThemeConfigListPage()),
     });
   }
@@ -1117,7 +1168,7 @@ class ThemePlatformModel {
   /** @returns {ThemeConfigListPageSettingsProps} */
   static ThemeConfigListPageSettingsProps() {
     return Joi.object({
-      props: Joi.any(),
+      props: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -1196,7 +1247,19 @@ class ThemePlatformModel {
   /** @returns {GlobalSchema} */
   static GlobalSchema() {
     return Joi.object({
-      props: Joi.array().items(Joi.any()),
+      props: Joi.array().items(ThemePlatformModel.Prop()),
+    });
+  }
+
+  /** @returns {Prop} */
+  static Prop() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      category: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      label: Joi.string().allow(""),
+      info: Joi.string().allow(""),
     });
   }
 
@@ -1384,8 +1447,8 @@ class ThemePlatformModel {
     });
   }
 
-  /** @returns {DummyResponse} */
-  static DummyResponse() {
+  /** @returns {DummyTheme} */
+  static DummyTheme() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
@@ -1494,9 +1557,9 @@ class ThemePlatformModel {
 
       "profile-company",
 
-      "profile-emails",
+      "profile-email",
 
-      "profile-phones",
+      "profile-phone",
 
       "rate-us",
 
@@ -1532,7 +1595,13 @@ class ThemePlatformModel {
 
       "order-status",
 
-      "locate-us"
+      "locate-us",
+
+      "single-page-checkout",
+
+      "request-reattempt",
+
+      "files"
     );
   }
 }