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

package/sdk/platform/Billing/BillingPlatformValidator.d.ts

@@ -26,6 +26,12 @@ export = BillingPlatformValidator;
  * @property {string} extensionId - Extension _id
  * @property {BillingPlatformModel.CreateOneTimeCharge} body
  */
+/**
+ * @typedef CreateSubscriptionChargeParam
+ * @property {string} extensionId - Extension Id for which we need to crete new
+ *   subscription
+ * @property {BillingPlatformModel.CreateSubscriptionCharge} body
+ */
 /**
  * @typedef CreditTransactionParam
  * @property {number} uniqueId - Unique ID of the company
@@ -43,6 +49,11 @@ export = BillingPlatformValidator;
  * @property {string} [productSuite]
  * @property {string} [type]
  */
+/**
+ * @typedef CurrentLimitParam
+ * @property {string} [productSuite]
+ * @property {string} [type]
+ */
 /** @typedef GetBankListParam */
 /**
  * @typedef GetChargeDetailsParam
@@ -51,11 +62,6 @@ export = BillingPlatformValidator;
  */
 /** @typedef GetCustomerDetailParam */
 /** @typedef GetEnterprisePlansParam */
-/**
- * @typedef GetFeatureLimitConfigParam
- * @property {string} [productSuite]
- * @property {string} [type]
- */
 /**
  * @typedef GetInvoiceByIdParam
  * @property {string} invoiceId - Invoice id
@@ -99,7 +105,7 @@ export = BillingPlatformValidator;
  */
 /**
  * @typedef PaymentInitiateParam
- * @property {BillingPlatformModel.SunscribePlan} body
+ * @property {BillingPlatformModel.SubscribePlan} body
  */
 /**
  * @typedef PaymentOptionsParam
@@ -194,10 +200,14 @@ declare class BillingPlatformValidator {
     static checkCouponValidity(): CheckCouponValidityParam;
     /** @returns {CreateOneTimeChargeParam} */
     static createOneTimeCharge(): CreateOneTimeChargeParam;
+    /** @returns {CreateSubscriptionChargeParam} */
+    static createSubscriptionCharge(): CreateSubscriptionChargeParam;
     /** @returns {CreditTransactionParam} */
     static creditTransaction(): CreditTransactionParam;
     /** @returns {CurrentAppLimitParam} */
     static currentAppLimit(): CurrentAppLimitParam;
+    /** @returns {CurrentLimitParam} */
+    static currentLimit(): CurrentLimitParam;
     /** @returns {GetBankListParam} */
     static getBankList(): any;
     /** @returns {GetChargeDetailsParam} */
@@ -206,8 +216,6 @@ declare class BillingPlatformValidator {
     static getCustomerDetail(): any;
     /** @returns {GetEnterprisePlansParam} */
     static getEnterprisePlans(): any;
-    /** @returns {GetFeatureLimitConfigParam} */
-    static getFeatureLimitConfig(): GetFeatureLimitConfigParam;
     /** @returns {GetInvoiceByIdParam} */
     static getInvoiceById(): GetInvoiceByIdParam;
     /** @returns {GetInvoicesParam} */
@@ -272,7 +280,7 @@ declare class BillingPlatformValidator {
     static verifyPayment(): VerifyPaymentParam;
 }
 declare namespace BillingPlatformValidator {
-    export { ActivateSubscriptionPlanParam, CancelSubscriptionChargeParam, CancelSubscriptionPlanParam, ChangePlanParam, CheckCouponValidityParam, CreateOneTimeChargeParam, CreditTransactionParam, CurrentAppLimitParam, GetBankListParam, GetChargeDetailsParam, GetCustomerDetailParam, GetEnterprisePlansParam, GetFeatureLimitConfigParam, GetInvoiceByIdParam, GetInvoicesParam, GetPaymentOptionsParam, GetPaymentTransactionParam, GetSubscriptionParam, GetSubscriptionChargeParam, GetentityDetailParam, GlobalSettingsParam, MethodDefaultParam, PaymentCollectParam, PaymentInitiateParam, PaymentOptionsParam, PaymentStatusParam, PlanDowngradeParam, PlanDowngradeGetParam, PlanStatusUpdateParam, SetupIntentParam, SetupMandateParam, SetupPaymentParam, SubscriptionConfigsParam, SubscriptionMethodsParam, SubscriptionMethodsDeleteParam, SubscriptionPlanChangeParam, SubscriptionRenewParam, TopupCancelCreditParam, TopupCreditParam, UpdateConsentParam, UpdateSetupIntentParam, UpgradePlanParam, UpsertCustomerDetailParam, VerifyPaymentParam };
+    export { ActivateSubscriptionPlanParam, CancelSubscriptionChargeParam, CancelSubscriptionPlanParam, ChangePlanParam, CheckCouponValidityParam, CreateOneTimeChargeParam, CreateSubscriptionChargeParam, CreditTransactionParam, CurrentAppLimitParam, CurrentLimitParam, GetBankListParam, GetChargeDetailsParam, GetCustomerDetailParam, GetEnterprisePlansParam, GetInvoiceByIdParam, GetInvoicesParam, GetPaymentOptionsParam, GetPaymentTransactionParam, GetSubscriptionParam, GetSubscriptionChargeParam, GetentityDetailParam, GlobalSettingsParam, MethodDefaultParam, PaymentCollectParam, PaymentInitiateParam, PaymentOptionsParam, PaymentStatusParam, PlanDowngradeParam, PlanDowngradeGetParam, PlanStatusUpdateParam, SetupIntentParam, SetupMandateParam, SetupPaymentParam, SubscriptionConfigsParam, SubscriptionMethodsParam, SubscriptionMethodsDeleteParam, SubscriptionPlanChangeParam, SubscriptionRenewParam, TopupCancelCreditParam, TopupCreditParam, UpdateConsentParam, UpdateSetupIntentParam, UpgradePlanParam, UpsertCustomerDetailParam, VerifyPaymentParam };
 }
 type ActivateSubscriptionPlanParam = {
     body: BillingPlatformModel.SubscriptionActivateReq;
@@ -310,6 +318,14 @@ type CreateOneTimeChargeParam = {
     extensionId: string;
     body: BillingPlatformModel.CreateOneTimeCharge;
 };
+type CreateSubscriptionChargeParam = {
+    /**
+     * - Extension Id for which we need to crete new
+     * subscription
+     */
+    extensionId: string;
+    body: BillingPlatformModel.CreateSubscriptionCharge;
+};
 type CreditTransactionParam = {
     /**
      * - Unique ID of the company
@@ -352,6 +368,10 @@ type CurrentAppLimitParam = {
     productSuite?: string;
     type?: string;
 };
+type CurrentLimitParam = {
+    productSuite?: string;
+    type?: string;
+};
 type GetChargeDetailsParam = {
     /**
      * - Extension _id
@@ -362,10 +382,6 @@ type GetChargeDetailsParam = {
      */
     chargeId: string;
 };
-type GetFeatureLimitConfigParam = {
-    productSuite?: string;
-    type?: string;
-};
 type GetInvoiceByIdParam = {
     /**
      * - Invoice id
@@ -437,7 +453,7 @@ type PaymentCollectParam = {
     body: BillingPlatformModel.PaymentCollectReq;
 };
 type PaymentInitiateParam = {
-    body: BillingPlatformModel.SunscribePlan;
+    body: BillingPlatformModel.SubscribePlan;
 };
 type PaymentOptionsParam = {
     /**

package/sdk/platform/Billing/BillingPlatformValidator.js

@@ -35,6 +35,13 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  * @property {BillingPlatformModel.CreateOneTimeCharge} body
  */
 
+/**
+ * @typedef CreateSubscriptionChargeParam
+ * @property {string} extensionId - Extension Id for which we need to crete new
+ *   subscription
+ * @property {BillingPlatformModel.CreateSubscriptionCharge} body
+ */
+
 /**
  * @typedef CreditTransactionParam
  * @property {number} uniqueId - Unique ID of the company
@@ -54,6 +61,12 @@ const BillingPlatformModel = require("./BillingPlatformModel");
  * @property {string} [type]
  */
 
+/**
+ * @typedef CurrentLimitParam
+ * @property {string} [productSuite]
+ * @property {string} [type]
+ */
+
 /** @typedef GetBankListParam */
 
 /**
@@ -66,12 +79,6 @@ const BillingPlatformModel = require("./BillingPlatformModel");
 
 /** @typedef GetEnterprisePlansParam */
 
-/**
- * @typedef GetFeatureLimitConfigParam
- * @property {string} [productSuite]
- * @property {string} [type]
- */
-
 /**
  * @typedef GetInvoiceByIdParam
  * @property {string} invoiceId - Invoice id
@@ -125,7 +132,7 @@ const BillingPlatformModel = require("./BillingPlatformModel");
 
 /**
  * @typedef PaymentInitiateParam
- * @property {BillingPlatformModel.SunscribePlan} body
+ * @property {BillingPlatformModel.SubscribePlan} body
  */
 
 /**
@@ -274,6 +281,14 @@ class BillingPlatformValidator {
     }).required();
   }
 
+  /** @returns {CreateSubscriptionChargeParam} */
+  static createSubscriptionCharge() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      body: BillingPlatformModel.CreateSubscriptionCharge().required(),
+    }).required();
+  }
+
   /** @returns {CreditTransactionParam} */
   static creditTransaction() {
     return Joi.object({
@@ -297,6 +312,14 @@ class BillingPlatformValidator {
     }).required();
   }
 
+  /** @returns {CurrentLimitParam} */
+  static currentLimit() {
+    return Joi.object({
+      productSuite: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetBankListParam} */
   static getBankList() {
     return Joi.object({}).required();
@@ -320,14 +343,6 @@ class BillingPlatformValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetFeatureLimitConfigParam} */
-  static getFeatureLimitConfig() {
-    return Joi.object({
-      productSuite: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-    }).required();
-  }
-
   /** @returns {GetInvoiceByIdParam} */
   static getInvoiceById() {
     return Joi.object({
@@ -404,7 +419,7 @@ class BillingPlatformValidator {
   /** @returns {PaymentInitiateParam} */
   static paymentInitiate() {
     return Joi.object({
-      body: BillingPlatformModel.SunscribePlan().required(),
+      body: BillingPlatformModel.SubscribePlan().required(),
     }).required();
   }
 

package/sdk/platform/Cart/CartPlatformModel.d.ts

@@ -161,13 +161,13 @@ export = CartPlatformModel;
  */
 /**
  * @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 CouponsResponse
@@ -1982,12 +1982,33 @@ type CouponAdd = {
 /** @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 {CouponsResponse} */

package/sdk/platform/Cart/CartPlatformModel.js

@@ -184,13 +184,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.
  */
 
 /**
@@ -2412,7 +2412,7 @@ class CartPlatformModel {
   /** @returns {Restrictions1} */
   static Restrictions1() {
     return Joi.object({
-      payments: Joi.any(),
+      payments: Joi.object().pattern(/\S/, CartPlatformModel.PaymentModes()),
       user_registered: CartPlatformModel.UserRegistered(),
       platforms: Joi.array().items(Joi.string().allow("")),
       post_order: CartPlatformModel.PostOrder1(),

package/sdk/platform/Catalog/CatalogPlatformClient.d.ts

@@ -681,7 +681,7 @@ declare class Catalog {
      * @summary: List products
      * @description: Retrieve a list of available products - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
      */
-    getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
+    getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
@@ -691,23 +691,33 @@ declare class Catalog {
      * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
      *   Department Ids
      * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
+     * @param {string} [arg.name] - Get multiple products filtered by Name (Pattern Match)
+     * @param {string} [arg.slug] - Get multiple products filtered by Slug
+     * @param {string[]} [arg.allIdentifiers] - Get multiple products filtered
+     *   by All Identifiers
      * @param {string} [arg.q] - Get multiple products filtered by q string
      * @param {string[]} [arg.tags] - Get multiple products filtered by tags
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 10.
+     * @param {string} [arg.sortOn] - Field which is to be used for sorting,
+     *   default is latest. Value can be latest (modified_on) or created (record id)
      * @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
      * @summary: List products
      * @description: Retrieve a list of available products
      */
-    getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageSize, }?: {
+    getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageSize, sortOn, }?: {
         brandIds?: number[];
         categoryIds?: number[];
         itemIds?: number[];
         departmentIds?: number[];
         itemCode?: string[];
+        name?: string;
+        slug?: string;
+        allIdentifiers?: string[];
         q?: string;
         tags?: string[];
         pageSize?: number;
+        sortOn?: string;
     }): Paginator<CatalogPlatformModel.ProductListingResponseV2>;
     /**
      * @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object

package/sdk/platform/Catalog/CatalogPlatformClient.js

@@ -4617,10 +4617,16 @@ class Catalog {
       itemIds,
       departmentIds,
       itemCode,
+      name,
+      slug,
+      allIdentifiers,
       q,
       tags,
       pageNo,
       pageSize,
+      pageType,
+      sortOn,
+      pageId,
       requestHeaders,
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
@@ -4632,10 +4638,16 @@ class Catalog {
         itemIds,
         departmentIds,
         itemCode,
+        name,
+        slug,
+        allIdentifiers,
         q,
         tags,
         pageNo,
         pageSize,
+        pageType,
+        sortOn,
+        pageId,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -4651,10 +4663,16 @@ class Catalog {
         itemIds,
         departmentIds,
         itemCode,
+        name,
+        slug,
+        allIdentifiers,
         q,
         tags,
         pageNo,
         pageSize,
+        pageType,
+        sortOn,
+        pageId,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -4671,10 +4689,16 @@ class Catalog {
     query_params["item_ids"] = itemIds;
     query_params["department_ids"] = departmentIds;
     query_params["item_code"] = itemCode;
+    query_params["name"] = name;
+    query_params["slug"] = slug;
+    query_params["all_identifiers"] = allIdentifiers;
     query_params["q"] = q;
     query_params["tags"] = tags;
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
+    query_params["page_type"] = pageType;
+    query_params["sort_on"] = sortOn;
+    query_params["page_id"] = pageId;
 
     const xHeaders = {};
 
@@ -4723,10 +4747,16 @@ class Catalog {
    * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
    *   Department Ids
    * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
+   * @param {string} [arg.name] - Get multiple products filtered by Name (Pattern Match)
+   * @param {string} [arg.slug] - Get multiple products filtered by Slug
+   * @param {string[]} [arg.allIdentifiers] - Get multiple products filtered
+   *   by All Identifiers
    * @param {string} [arg.q] - Get multiple products filtered by q string
    * @param {string[]} [arg.tags] - Get multiple products filtered by tags
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 10.
+   * @param {string} [arg.sortOn] - Field which is to be used for sorting,
+   *   default is latest. Value can be latest (modified_on) or created (record id)
    * @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
    * @summary: List products
    * @description: Retrieve a list of available products
@@ -4737,25 +4767,35 @@ class Catalog {
     itemIds,
     departmentIds,
     itemCode,
+    name,
+    slug,
+    allIdentifiers,
     q,
     tags,
     pageSize,
+    sortOn,
   } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
       const pageId = paginator.nextId;
       const pageNo = paginator.pageNo;
-      const pageType = "number";
+      const pageType = "cursor";
       const data = await this.getProducts({
         brandIds: brandIds,
         categoryIds: categoryIds,
         itemIds: itemIds,
         departmentIds: departmentIds,
         itemCode: itemCode,
+        name: name,
+        slug: slug,
+        allIdentifiers: allIdentifiers,
         q: q,
         tags: tags,
         pageNo: pageNo,
         pageSize: pageSize,
+        pageType: pageType,
+        sortOn: sortOn,
+        pageId: pageId,
       });
       paginator.setPaginator({
         hasNext: data.page.has_next ? true : false,

package/sdk/platform/Catalog/CatalogPlatformModel.d.ts

@@ -1,7 +1,7 @@
 export = CatalogPlatformModel;
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -2171,13 +2171,13 @@ export = CatalogPlatformModel;
  */
 /**
  * @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 PageResponse
@@ -3285,9 +3285,9 @@ export = CatalogPlatformModel;
  */
 /**
  * @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
  */
 /**
@@ -3302,6 +3302,7 @@ export = CatalogPlatformModel;
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -3346,6 +3347,9 @@ declare namespace CatalogPlatformModel {
 /** @returns {Action} */
 declare function Action(): Action;
 type Action = {
+    /**
+     * - Type of action to be taken e.g, page.
+     */
     type?: string;
     page?: ActionPage;
     popup?: ActionPage;
@@ -6644,12 +6648,33 @@ type PTErrorResponse = {
 /** @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 {PageResponse} */
@@ -8065,8 +8090,17 @@ type UpdateMarketplaceOptinResponse = {
 /** @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;
 };
@@ -8076,4 +8110,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/Catalog/CatalogPlatformModel.js

@@ -2,7 +2,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]
  */
@@ -2427,13 +2427,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.
  */
 
 /**
@@ -3659,9 +3659,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
  */
 
@@ -3677,6 +3677,7 @@ const Joi = require("joi");
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -8150,6 +8151,8 @@ class CatalogPlatformModel {
 
       "collections",
 
+      "custom",
+
       "contact-us",
 
       "external",