@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

package/sdk/platform/Share/SharePlatformModel.js

@@ -99,13 +99,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

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

@@ -114,7 +114,7 @@ export = ThemePlatformModel;
  */
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -532,9 +532,9 @@ export = ThemePlatformModel;
  */
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 /**
@@ -549,6 +549,7 @@ export = ThemePlatformModel;
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -779,6 +780,9 @@ type SEObreadcrumb = {
 /** @returns {Action} */
 declare function Action(): Action;
 type Action = {
+    /**
+     * - Type of action to be taken e.g, page.
+     */
     type?: string;
     page?: ActionPage;
     popup?: ActionPage;
@@ -1593,8 +1597,17 @@ type CompanyPrivateTheme = {
 /** @returns {ActionPage} */
 declare function ActionPage(): ActionPage;
 type ActionPage = {
+    /**
+     * - Parameters that should be considered in path.
+     */
     params?: any;
+    /**
+     * - Query parameter if any to be added to the action.
+     */
     query?: any;
+    /**
+     * - The URL for the action.
+     */
     url?: string;
     type: PageType;
 };
@@ -1604,4 +1617,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "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";
+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";

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -131,7 +131,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -612,9 +612,9 @@ const Joi = require("joi");
 
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 
@@ -630,6 +630,7 @@ const Joi = require("joi");
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -1480,6 +1481,8 @@ class ThemePlatformModel {
 
       "collections",
 
+      "custom",
+
       "contact-us",
 
       "external",

package/sdk/platform/User/UserPlatformModel.d.ts

@@ -457,18 +457,18 @@ export = UserPlatformModel;
  */
 /**
  * @typedef PhoneNumber
- * @property {string} [phone] - Phone number
- * @property {number} [country_code] - Country code
- * @property {boolean} [active] - Is the phone number active
- * @property {boolean} [primary] - Is it a primary phone number
- * @property {boolean} [verified] - Is the phone number verified
+ * @property {string} [phone] - Phone number of the user.
+ * @property {number} [country_code] - Country code for mobile number.
+ * @property {boolean} [active] - Is the phone number active.
+ * @property {boolean} [primary] - Is it a primary phone number.
+ * @property {boolean} [verified] - Is the phone number verified.
  */
 /**
  * @typedef Email
- * @property {string} [email] - Email address
- * @property {boolean} [active] - Is the email active
- * @property {boolean} [primary] - Is it a primary email
- * @property {boolean} [verified] - Is the email verified
+ * @property {string} [email] - Email address.
+ * @property {boolean} [active] - Is the email active.
+ * @property {boolean} [primary] - Is it a primary email.
+ * @property {boolean} [verified] - Is the email verified.
  */
 declare class UserPlatformModel {
 }
@@ -1131,23 +1131,23 @@ type UserSearchSchema = {
 declare function PhoneNumber(): PhoneNumber;
 type PhoneNumber = {
     /**
-     * - Phone number
+     * - Phone number of the user.
      */
     phone?: string;
     /**
-     * - Country code
+     * - Country code for mobile number.
      */
     country_code?: number;
     /**
-     * - Is the phone number active
+     * - Is the phone number active.
      */
     active?: boolean;
     /**
-     * - Is it a primary phone number
+     * - Is it a primary phone number.
      */
     primary?: boolean;
     /**
-     * - Is the phone number verified
+     * - Is the phone number verified.
      */
     verified?: boolean;
 };
@@ -1155,19 +1155,19 @@ type PhoneNumber = {
 declare function Email(): Email;
 type Email = {
     /**
-     * - Email address
+     * - Email address.
      */
     email?: string;
     /**
-     * - Is the email active
+     * - Is the email active.
      */
     active?: boolean;
     /**
-     * - Is it a primary email
+     * - Is it a primary email.
      */
     primary?: boolean;
     /**
-     * - Is the email verified
+     * - Is the email verified.
      */
     verified?: boolean;
 };

package/sdk/platform/User/UserPlatformModel.js

@@ -516,19 +516,19 @@ const Joi = require("joi");
 
 /**
  * @typedef PhoneNumber
- * @property {string} [phone] - Phone number
- * @property {number} [country_code] - Country code
- * @property {boolean} [active] - Is the phone number active
- * @property {boolean} [primary] - Is it a primary phone number
- * @property {boolean} [verified] - Is the phone number verified
+ * @property {string} [phone] - Phone number of the user.
+ * @property {number} [country_code] - Country code for mobile number.
+ * @property {boolean} [active] - Is the phone number active.
+ * @property {boolean} [primary] - Is it a primary phone number.
+ * @property {boolean} [verified] - Is the phone number verified.
  */
 
 /**
  * @typedef Email
- * @property {string} [email] - Email address
- * @property {boolean} [active] - Is the email active
- * @property {boolean} [primary] - Is it a primary email
- * @property {boolean} [verified] - Is the email verified
+ * @property {string} [email] - Email address.
+ * @property {boolean} [active] - Is the email active.
+ * @property {boolean} [primary] - Is it a primary email.
+ * @property {boolean} [verified] - Is the email verified.
  */
 
 class UserPlatformModel {

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

@@ -41,13 +41,13 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef PingWebhook
@@ -352,12 +352,33 @@ type EventProcessReportObject = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {PingWebhook} */

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -47,13 +47,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

package/sdk/public/PublicClient.d.ts

@@ -12,10 +12,8 @@ declare class PublicClient {
      */
     constructor(config: import("./PublicConfig"));
     config: import("./PublicConfig");
-    billing: Billing;
     configuration: Configuration;
     content: Content;
-    inventory: Inventory;
     partner: Partner;
     webhook: Webhook;
     /**
@@ -26,9 +24,7 @@ declare class PublicClient {
      */
     setExtraHeaders(header: object): void;
 }
-import Billing = require("./Billing/BillingPublicClient");
 import Configuration = require("./Configuration/ConfigurationPublicClient");
 import Content = require("./Content/ContentPublicClient");
-import Inventory = require("./Inventory/InventoryPublicClient");
 import Partner = require("./Partner/PartnerPublicClient");
 import Webhook = require("./Webhook/WebhookPublicClient");

package/sdk/public/PublicClient.js

@@ -1,11 +1,7 @@
-const Billing = require("./Billing/BillingPublicClient");
-
 const Configuration = require("./Configuration/ConfigurationPublicClient");
 
 const Content = require("./Content/ContentPublicClient");
 
-const Inventory = require("./Inventory/InventoryPublicClient");
-
 const Partner = require("./Partner/PartnerPublicClient");
 
 const Webhook = require("./Webhook/WebhookPublicClient");
@@ -26,14 +22,10 @@ class PublicClient {
   constructor(config) {
     this.config = config;
 
-    this.billing = new Billing(config);
-
     this.configuration = new Configuration(config);
 
     this.content = new Content(config);
 
-    this.inventory = new Inventory(config);
-
     this.partner = new Partner(config);
 
     this.webhook = new Webhook(config);

package/sdk/public/index.d.ts

@@ -1,10 +1,8 @@
 export const PublicConfig: typeof import("./PublicConfig");
 export const PublicClient: typeof import("./PublicClient");
 export namespace PublicModel {
-    const BillingPublicModel: typeof import("./Billing/BillingPublicModel");
     const ConfigurationPublicModel: typeof import("./Configuration/ConfigurationPublicModel");
     const ContentPublicModel: typeof import("./Content/ContentPublicModel");
-    const InventoryPublicModel: typeof import("./Inventory/InventoryPublicModel");
     const PartnerPublicModel: typeof import("./Partner/PartnerPublicModel");
     const WebhookPublicModel: typeof import("./Webhook/WebhookPublicModel");
 }

package/sdk/public/index.js

@@ -2,14 +2,10 @@ module.exports = {
   PublicConfig: require("./PublicConfig"),
   PublicClient: require("./PublicClient"),
   PublicModel: {
-    BillingPublicModel: require("./Billing/BillingPublicModel"),
-
     ConfigurationPublicModel: require("./Configuration/ConfigurationPublicModel"),
 
     ContentPublicModel: require("./Content/ContentPublicModel"),
 
-    InventoryPublicModel: require("./Inventory/InventoryPublicModel"),
-
     PartnerPublicModel: require("./Partner/PartnerPublicModel"),
 
     WebhookPublicModel: require("./Webhook/WebhookPublicModel"),

package/sdk/public/Billing/BillingPublicClient.d.ts

@@ -1,45 +0,0 @@
-export = Billing;
-declare class Billing {
-    constructor(_conf: any);
-    _conf: any;
-    _relativeUrls: {
-        getPlanDetails: string;
-        getStandardPlans: string;
-        planList: string;
-    };
-    _urls: {};
-    updateUrls(urls: any): void;
-    /**
-     * @param {BillingPublicValidator.GetPlanDetailsParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<BillingPublicModel.PlanDetails>} - Success response
-     * @name getPlanDetails
-     * @summary: Get plan details
-     * @description: Get plan details.
-     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getPlanDetails/).
-     */
-    getPlanDetails({ planId, requestHeaders }?: BillingPublicValidator.GetPlanDetailsParam, { responseHeaders }?: object): Promise<BillingPublicModel.PlanDetails>;
-    /**
-     * @param {BillingPublicValidator.GetStandardPlansParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<BillingPublicModel.DetailList>} - Success response
-     * @name getStandardPlans
-     * @summary: Get Standard/Public Plans
-     * @description: Get Standard/Public Plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
-     */
-    getStandardPlans({ platform, requestHeaders }?: BillingPublicValidator.GetStandardPlansParam, { responseHeaders }?: object): Promise<BillingPublicModel.DetailList>;
-    /**
-     * @param {BillingPublicValidator.PlanListParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<BillingPublicModel.PlanList[]>} - Success response
-     * @name planList
-     * @summary: Get List of all plans
-     * @description: Get List of all plans - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/planList/).
-     */
-    planList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<BillingPublicModel.PlanList[]>;
-}
-import BillingPublicValidator = require("./BillingPublicValidator");
-import BillingPublicModel = require("./BillingPublicModel");