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

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",

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

@@ -290,12 +290,23 @@ export = CatalogPlatformValidator;
  * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
  * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
  * @property {string[]} [itemCode] - Get multiple products filtered by Item Code
+ * @property {string} [name] - Get multiple products filtered by Name (Pattern Match)
+ * @property {string} [slug] - Get multiple products filtered by Slug
+ * @property {string[]} [allIdentifiers] - Get multiple products filtered by All
+ *   Identifiers
  * @property {string} [q] - Get multiple products filtered by q string
  * @property {string[]} [tags] - Get multiple products filtered by tags
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
+ * @property {string} [pageType] - For pagination type value can be cursor or
+ *   number. Default is number.
+ * @property {string} [sortOn] - Field which is to be used for sorting, default
+ *   is latest. Value can be latest (modified_on) or created (record id)
+ * @property {string} [pageId] - If page_type is cursor, each response will
+ *   contain **next_id** param (datetime or id depending upon sort_on), which
+ *   should be sent back as page_id to make cursor pagination work.
  */
 /**
  * @typedef GetSellerInsightsParam
@@ -1137,6 +1148,19 @@ type GetProductsParam = {
      * - Get multiple products filtered by Item Code
      */
     itemCode?: string[];
+    /**
+     * - Get multiple products filtered by Name (Pattern Match)
+     */
+    name?: string;
+    /**
+     * - Get multiple products filtered by Slug
+     */
+    slug?: string;
+    /**
+     * - Get multiple products filtered by All
+     * Identifiers
+     */
+    allIdentifiers?: string[];
     /**
      * - Get multiple products filtered by q string
      */
@@ -1155,6 +1179,22 @@ type GetProductsParam = {
      * Default is 10.
      */
     pageSize?: number;
+    /**
+     * - For pagination type value can be cursor or
+     * number. Default is number.
+     */
+    pageType?: string;
+    /**
+     * - Field which is to be used for sorting, default
+     * is latest. Value can be latest (modified_on) or created (record id)
+     */
+    sortOn?: string;
+    /**
+     * - If page_type is cursor, each response will
+     * contain **next_id** param (datetime or id depending upon sort_on), which
+     * should be sent back as page_id to make cursor pagination work.
+     */
+    pageId?: string;
 };
 type GetSellerInsightsParam = {
     /**

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -345,12 +345,23 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
  * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
  * @property {string[]} [itemCode] - Get multiple products filtered by Item Code
+ * @property {string} [name] - Get multiple products filtered by Name (Pattern Match)
+ * @property {string} [slug] - Get multiple products filtered by Slug
+ * @property {string[]} [allIdentifiers] - Get multiple products filtered by All
+ *   Identifiers
  * @property {string} [q] - Get multiple products filtered by q string
  * @property {string[]} [tags] - Get multiple products filtered by tags
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
+ * @property {string} [pageType] - For pagination type value can be cursor or
+ *   number. Default is number.
+ * @property {string} [sortOn] - Field which is to be used for sorting, default
+ *   is latest. Value can be latest (modified_on) or created (record id)
+ * @property {string} [pageId] - If page_type is cursor, each response will
+ *   contain **next_id** param (datetime or id depending upon sort_on), which
+ *   should be sent back as page_id to make cursor pagination work.
  */
 
 /**
@@ -963,10 +974,16 @@ class CatalogPlatformValidator {
       itemIds: Joi.array().items(Joi.number()),
       departmentIds: Joi.array().items(Joi.number()),
       itemCode: Joi.array().items(Joi.string().allow("")),
+      name: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      allIdentifiers: Joi.array().items(Joi.string().allow("")),
       q: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      pageType: Joi.string().allow(""),
+      sortOn: Joi.string().allow(""),
+      pageId: Joi.string().allow(""),
     }).required();
   }
 

package/sdk/platform/Communication/CommunicationPlatformModel.d.ts

@@ -804,13 +804,13 @@ export = CommunicationPlatformModel;
  */
 /**
  * @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 GenericError
@@ -1825,12 +1825,33 @@ type SystemNotifications = {
 /** @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 {GenericError} */

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -912,13 +912,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/CompanyProfile/CompanyProfilePlatformModel.d.ts

@@ -259,13 +259,13 @@ export = CompanyProfilePlatformModel;
  */
 /**
  * @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 CompanyBrandListSerializer
@@ -733,12 +733,33 @@ type CompanyBrandSerializer = {
 /** @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 {CompanyBrandListSerializer} */

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js

@@ -286,13 +286,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.
  */
 
 /**