@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.8

package/sdk/application/Theme/ThemeApplicationModel.js

@@ -1,5 +1,20 @@
 const Joi = require("joi");
 
+/**
+ * @typedef Action
+ * @property {ActionPage} [page]
+ * @property {ActionPage} [popup]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef ActionPage
+ * @property {Object} [params]
+ * @property {Object} [query]
+ * @property {PageType} type
+ * @property {string} [url]
+ */
+
 /**
  * @typedef AdvanceSetting
  * @property {DividerStrokeHighlightSetting} [divider_stroke_highlight]
@@ -25,11 +40,21 @@ const Joi = require("joi");
  * @property {boolean} [show_header_auth] - Whether to show header authentication or not
  */
 
+/**
+ * @typedef AvailablePagePlatformPredicate
+ * @property {boolean} [android] - Section visibility on android platform
+ * @property {boolean} [ios] - Section visibility on ios platform
+ * @property {boolean} [web] - Section visibility on web platform
+ */
+
 /**
  * @typedef AvailablePagePredicate
+ * @property {AvailablePagePlatformPredicate} [platform]
  * @property {AvailablePageRoutePredicate} [route]
+ * @property {AvailablePageSchedulePredicate} [schedule]
  * @property {AvailablePageScreenPredicate} [screen]
  * @property {AvailablePageUserPredicate} [user]
+ * @property {string[]} [zones] - An array of zone ids associated with the section
  */
 
 /**
@@ -39,6 +64,13 @@ const Joi = require("joi");
  * @property {string} [selected]
  */
 
+/**
+ * @typedef AvailablePageSchedulePredicate
+ * @property {string} [cron]
+ * @property {string} [end]
+ * @property {string} [start]
+ */
+
 /**
  * @typedef AvailablePageSchema
  * @property {string} [_id]
@@ -78,7 +110,11 @@ 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]
  * @property {string} [title]
  */
 
@@ -272,17 +308,6 @@ const Joi = require("joi");
  * @property {string} [mobile] - The URL of the mobile image
  */
 
-/**
- * @typedef Meta
- * @property {string} [description] - The description of the theme
- * @property {Images} [images]
- * @property {string[]} [industry] - An array of industries associated with the theme
- * @property {string} [name] - The name of the theme
- * @property {ThemePayment} [payment]
- * @property {Release} [release]
- * @property {string} [slug] - The slug of the theme
- */
-
 /**
  * @typedef OverlayPopupSetting
  * @property {string} [dialog_backgroung] - The dialog background color
@@ -390,6 +415,30 @@ const Joi = require("joi");
  * @property {TextProp} [title]
  */
 
+/**
+ * @typedef SEObreadcrumb
+ * @property {Action} [action]
+ * @property {string} [url]
+ */
+
+/**
+ * @typedef SEOMetaItem
+ * @property {SEOMetaItems[]} [items]
+ * @property {string} [title]
+ */
+
+/**
+ * @typedef SEOMetaItems
+ * @property {string} [key]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef SEOSitemap
+ * @property {string} [frequency]
+ * @property {number} [priority]
+ */
+
 /**
  * @typedef StaticConfig
  * @property {StaticProps} [props]
@@ -423,6 +472,17 @@ const Joi = require("joi");
  * @property {string[]} [page] - An array of pages
  */
 
+/**
+ * @typedef ThemeMeta
+ * @property {string} [description] - The description of the theme
+ * @property {Images} [images]
+ * @property {string[]} [industry] - An array of industries associated with the theme
+ * @property {string} [name] - The name of the theme
+ * @property {ThemePayment} [payment]
+ * @property {Release} [release]
+ * @property {string} [slug] - The slug of the theme
+ */
+
 /**
  * @typedef ThemePayment
  * @property {number} [amount] - The amount of the theme
@@ -442,16 +502,18 @@ const Joi = require("joi");
  * @property {boolean} [applied] - Whether the theme has been applied or not
  * @property {Assets} [assets]
  * @property {SectionItem[]} [available_sections] - Available sections information
+ * @property {number} [company_id] - The company id in which sales channel exists
  * @property {Config} [config]
  * @property {string} [created_at] - The creation timestamp of the theme
  * @property {Font} [font]
  * @property {boolean} [is_private] - Whether the theme is private or not
  * @property {string} [marketplace_theme_id] - The ID of the theme in the marketplace
- * @property {Meta} [meta]
+ * @property {ThemeMeta} [meta]
  * @property {string} [name] - The name of the theme
  * @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
+ * @property {string} [theme_type]
  * @property {string} [updated_at] - The last update timestamp of the theme
  * @property {string} [version] - The version of the theme
  */
@@ -483,7 +545,81 @@ const Joi = require("joi");
  * @property {string} [success_text] - The success text color
  */
 
+/**
+ * @typedef {| "about-us"
+ *   | "addresses"
+ *   | "blog"
+ *   | "brands"
+ *   | "cards"
+ *   | "cart"
+ *   | "categories"
+ *   | "brand"
+ *   | "category"
+ *   | "collection"
+ *   | "collections"
+ *   | "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"} PageType
+ */
+
 class ThemeApplicationModel {
+  /** @returns {Action} */
+  static Action() {
+    return Joi.object({
+      page: ThemeApplicationModel.ActionPage(),
+      popup: ThemeApplicationModel.ActionPage(),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ActionPage} */
+  static ActionPage() {
+    return Joi.object({
+      params: Joi.object().pattern(
+        /\S/,
+        Joi.array().items(Joi.string().allow(""))
+      ),
+      query: Joi.object().pattern(
+        /\S/,
+        Joi.array().items(Joi.string().allow(""))
+      ),
+      type: ThemeApplicationModel.PageType().required(),
+      url: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {AdvanceSetting} */
   static AdvanceSetting() {
     return Joi.object({
@@ -517,12 +653,24 @@ class ThemeApplicationModel {
     });
   }
 
+  /** @returns {AvailablePagePlatformPredicate} */
+  static AvailablePagePlatformPredicate() {
+    return Joi.object({
+      android: Joi.boolean(),
+      ios: Joi.boolean(),
+      web: Joi.boolean(),
+    });
+  }
+
   /** @returns {AvailablePagePredicate} */
   static AvailablePagePredicate() {
     return Joi.object({
+      platform: ThemeApplicationModel.AvailablePagePlatformPredicate(),
       route: ThemeApplicationModel.AvailablePageRoutePredicate(),
+      schedule: ThemeApplicationModel.AvailablePageSchedulePredicate(),
       screen: ThemeApplicationModel.AvailablePageScreenPredicate(),
       user: ThemeApplicationModel.AvailablePageUserPredicate(),
+      zones: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -535,6 +683,15 @@ class ThemeApplicationModel {
     });
   }
 
+  /** @returns {AvailablePageSchedulePredicate} */
+  static AvailablePageSchedulePredicate() {
+    return Joi.object({
+      cron: Joi.string().allow(""),
+      end: Joi.string().allow(""),
+      start: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {AvailablePageSchema} */
   static AvailablePageSchema() {
     return Joi.object({
@@ -587,7 +744,11 @@ class ThemeApplicationModel {
   static AvailablePageSeo() {
     return Joi.object({
       _id: Joi.string().allow(""),
+      breadcrumb: Joi.array().items(ThemeApplicationModel.SEObreadcrumb()),
+      canonical_url: Joi.string().allow(""),
       description: Joi.string().allow(""),
+      meta_tags: Joi.array().items(ThemeApplicationModel.SEOMetaItem()),
+      sitemap: ThemeApplicationModel.SEOSitemap(),
       title: Joi.string().allow(""),
     });
   }
@@ -827,19 +988,6 @@ class ThemeApplicationModel {
     });
   }
 
-  /** @returns {Meta} */
-  static Meta() {
-    return Joi.object({
-      description: Joi.string().allow(""),
-      images: ThemeApplicationModel.Images(),
-      industry: Joi.array().items(Joi.string().allow("")),
-      name: Joi.string().allow(""),
-      payment: ThemeApplicationModel.ThemePayment(),
-      release: ThemeApplicationModel.Release(),
-      slug: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {OverlayPopupSetting} */
   static OverlayPopupSetting() {
     return Joi.object({
@@ -977,6 +1125,38 @@ class ThemeApplicationModel {
     });
   }
 
+  /** @returns {SEObreadcrumb} */
+  static SEObreadcrumb() {
+    return Joi.object({
+      action: ThemeApplicationModel.Action(),
+      url: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SEOMetaItem} */
+  static SEOMetaItem() {
+    return Joi.object({
+      items: Joi.array().items(ThemeApplicationModel.SEOMetaItems()),
+      title: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SEOMetaItems} */
+  static SEOMetaItems() {
+    return Joi.object({
+      key: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SEOSitemap} */
+  static SEOSitemap() {
+    return Joi.object({
+      frequency: Joi.string().allow(""),
+      priority: Joi.number(),
+    });
+  }
+
   /** @returns {StaticConfig} */
   static StaticConfig() {
     return Joi.object({
@@ -1020,6 +1200,19 @@ class ThemeApplicationModel {
     });
   }
 
+  /** @returns {ThemeMeta} */
+  static ThemeMeta() {
+    return Joi.object({
+      description: Joi.string().allow(""),
+      images: ThemeApplicationModel.Images(),
+      industry: Joi.array().items(Joi.string().allow("")),
+      name: Joi.string().allow(""),
+      payment: ThemeApplicationModel.ThemePayment(),
+      release: ThemeApplicationModel.Release(),
+      slug: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ThemePayment} */
   static ThemePayment() {
     return Joi.object({
@@ -1046,16 +1239,18 @@ class ThemeApplicationModel {
       available_sections: Joi.array().items(
         ThemeApplicationModel.SectionItem()
       ),
+      company_id: Joi.number(),
       config: ThemeApplicationModel.Config(),
       created_at: Joi.string().allow(""),
       font: ThemeApplicationModel.Font(),
       is_private: Joi.boolean(),
       marketplace_theme_id: Joi.string().allow(""),
-      meta: ThemeApplicationModel.Meta(),
+      meta: ThemeApplicationModel.ThemeMeta(),
       name: Joi.string().allow(""),
       styles: Joi.any(),
       tags: Joi.array().items(Joi.string().allow("")),
       template_theme_id: Joi.string().allow(""),
+      theme_type: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
       version: Joi.string().allow(""),
     });
@@ -1095,5 +1290,106 @@ class ThemeApplicationModel {
       success_text: Joi.string().allow(""),
     });
   }
+
+  /**
+   * Enum: PageType Used By: Theme
+   *
+   * @returns {PageType}
+   */
+  static PageType() {
+    return Joi.string().valid(
+      "about-us",
+
+      "addresses",
+
+      "blog",
+
+      "brands",
+
+      "cards",
+
+      "cart",
+
+      "categories",
+
+      "brand",
+
+      "category",
+
+      "collection",
+
+      "collections",
+
+      "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"
+    );
+  }
 }
 module.exports = ThemeApplicationModel;

package/sdk/application/Theme/ThemeApplicationValidator.d.ts

@@ -8,6 +8,8 @@ export = ThemeApplicationValidator;
  * @typedef GetPageParam
  * @property {string} themeId - ID of the theme to be retrieved
  * @property {string} pageValue - Value of the page to be retrieved
+ * @property {string} [filters] - Filters on sections to be applied or not
+ * @property {number} [company] - Company id of the application
  */
 /**
  * @typedef GetThemeForPreviewParam
@@ -41,6 +43,14 @@ type GetPageParam = {
      * - Value of the page to be retrieved
      */
     pageValue: string;
+    /**
+     * - Filters on sections to be applied or not
+     */
+    filters?: string;
+    /**
+     * - Company id of the application
+     */
+    company?: number;
 };
 type GetThemeForPreviewParam = {
     /**

package/sdk/application/Theme/ThemeApplicationValidator.js

@@ -13,6 +13,8 @@ const ThemeApplicationModel = require("./ThemeApplicationModel");
  * @typedef GetPageParam
  * @property {string} themeId - ID of the theme to be retrieved
  * @property {string} pageValue - Value of the page to be retrieved
+ * @property {string} [filters] - Filters on sections to be applied or not
+ * @property {number} [company] - Company id of the application
  */
 
 /**
@@ -38,6 +40,8 @@ class ThemeApplicationValidator {
     return Joi.object({
       themeId: Joi.string().allow("").required(),
       pageValue: Joi.string().allow("").required(),
+      filters: Joi.string().allow(""),
+      company: Joi.number(),
     }).required();
   }
 

package/sdk/application/User/UserApplicationClient.d.ts

@@ -12,6 +12,7 @@ declare class User {
         getListOfActiveSessions: string;
         getLoggedInUser: string;
         getPlatformConfig: string;
+        getUserAttributes: string;
         hasPassword: string;
         loginWithAppleIOS: string;
         loginWithEmailAndPassword: string;
@@ -37,6 +38,8 @@ declare class User {
         setMobileNumberAsPrimary: string;
         updatePassword: string;
         updateProfile: string;
+        updateUserAttributes: string;
+        userExists: string;
         verifyEmail: string;
         verifyEmailForgotOTP: string;
         verifyEmailOTP: string;
@@ -136,6 +139,16 @@ declare class User {
      * @description: Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getPlatformConfig/).
      */
     getPlatformConfig({ name, requestHeaders }?: UserApplicationValidator.GetPlatformConfigParam, { responseHeaders }?: object): Promise<UserApplicationModel.PlatformSchema>;
+    /**
+     * @param {UserApplicationValidator.GetUserAttributesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
+     * @name getUserAttributes
+     * @summary: Get user attributes
+     * @description: Use this API to get the list of user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getUserAttributes/).
+     */
+    getUserAttributes({ slug, requestHeaders }?: UserApplicationValidator.GetUserAttributesParam, { responseHeaders }?: object): Promise<UserApplicationModel.UserAttributes>;
     /**
      * @param {UserApplicationValidator.HasPasswordParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -392,6 +405,26 @@ declare class User {
      * @description: Use this API to update details in the user profile. Details can be first name, last name, gender, email, phone number, or profile picture. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateProfile/).
      */
     updateProfile({ body, platform, requestHeaders }?: UserApplicationValidator.UpdateProfileParam, { responseHeaders }?: object): Promise<UserApplicationModel.ProfileEditSuccess>;
+    /**
+     * @param {UserApplicationValidator.UpdateUserAttributesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<UserApplicationModel.UserAttributes>} - Success response
+     * @name updateUserAttributes
+     * @summary: Update user attributes
+     * @description: Use this API to update user attributes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateUserAttributes/).
+     */
+    updateUserAttributes({ body, requestHeaders }?: UserApplicationValidator.UpdateUserAttributesParam, { responseHeaders }?: object): Promise<UserApplicationModel.UserAttributes>;
+    /**
+     * @param {UserApplicationValidator.UserExistsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<UserApplicationModel.UserExistsResponse>} - Success response
+     * @name userExists
+     * @summary: Check user is already registered or not
+     * @description: Use this API to check whether user is already registered or not to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/userExists/).
+     */
+    userExists({ q, requestHeaders }?: UserApplicationValidator.UserExistsParam, { responseHeaders }?: object): Promise<UserApplicationModel.UserExistsResponse>;
     /**
      * @param {UserApplicationValidator.VerifyEmailParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`