@gofynd/fdk-client-javascript 1.4.10 → 1.4.12

package/sdk/platform/Cart/CartPlatformModel.js

@@ -1706,47 +1706,6 @@ const Joi = require("joi");
  * @property {string[]} values
  */
 
-/**
- * @typedef CartCheckoutCustomMeta
- * @property {string} key
- * @property {string} value
- */
-
-/**
- * @typedef PlatformCartCheckoutDetailRequest
- * @property {CartCheckoutCustomMeta[]} [custom_meta]
- * @property {string} [address_id]
- * @property {string} [payment_identifier]
- * @property {Object} [payment_params]
- * @property {boolean} [payment_auto_confirm]
- * @property {string} id
- * @property {boolean} [pos]
- * @property {string} [billing_address_id]
- * @property {string} [merchant_code]
- * @property {string} [aggregator]
- * @property {number} [pick_at_store_uid]
- * @property {string} [device_id]
- * @property {Object} [delivery_address]
- * @property {string} payment_mode
- * @property {string} [checkout_mode]
- * @property {Object} [customer_details] - Customer details
- * @property {Object} [meta]
- * @property {StaffCheckout} [staff]
- * @property {string} [employee_code]
- * @property {Object} [billing_address]
- * @property {string} [callback_url]
- * @property {string} user_id
- * @property {Object} [extra_meta]
- * @property {string} order_type
- * @property {Files[]} [files] - List of file url
- * @property {number} [ordering_store]
- * @property {Object} [payment_extra_identifiers]
- * @property {string} [iin]
- * @property {string} [network]
- * @property {string} [type]
- * @property {string} [card_id]
- */
-
 /**
  * @typedef CheckCart
  * @property {string} [coupon_text]
@@ -4021,53 +3980,6 @@ class CartPlatformModel {
     });
   }
 
-  /** @returns {CartCheckoutCustomMeta} */
-  static CartCheckoutCustomMeta() {
-    return Joi.object({
-      key: Joi.string().allow("").required(),
-      value: Joi.string().allow("").required(),
-    });
-  }
-
-  /** @returns {PlatformCartCheckoutDetailRequest} */
-  static PlatformCartCheckoutDetailRequest() {
-    return Joi.object({
-      custom_meta: Joi.array().items(
-        CartPlatformModel.CartCheckoutCustomMeta()
-      ),
-      address_id: Joi.string().allow(""),
-      payment_identifier: Joi.string().allow("").allow(null),
-      payment_params: Joi.any().allow(null),
-      payment_auto_confirm: Joi.boolean(),
-      id: Joi.string().allow("").required(),
-      pos: Joi.boolean(),
-      billing_address_id: Joi.string().allow(""),
-      merchant_code: Joi.string().allow(""),
-      aggregator: Joi.string().allow(""),
-      pick_at_store_uid: Joi.number().allow(null),
-      device_id: Joi.string().allow("").allow(null),
-      delivery_address: Joi.any(),
-      payment_mode: Joi.string().allow("").required(),
-      checkout_mode: Joi.string().allow(""),
-      customer_details: Joi.any().allow(null),
-      meta: Joi.any(),
-      staff: CartPlatformModel.StaffCheckout(),
-      employee_code: Joi.string().allow("").allow(null),
-      billing_address: Joi.any(),
-      callback_url: Joi.string().allow("").allow(null),
-      user_id: Joi.string().allow("").allow(null).required(),
-      extra_meta: Joi.any(),
-      order_type: Joi.string().allow("").required(),
-      files: Joi.array().items(CartPlatformModel.Files()),
-      ordering_store: Joi.number().allow(null),
-      payment_extra_identifiers: Joi.any(),
-      iin: Joi.string().allow(""),
-      network: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      card_id: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {CheckCart} */
   static CheckCart() {
     return Joi.object({

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

@@ -295,7 +295,7 @@ declare class Catalog {
      * @summary: Get category return configuration
      * @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
      */
-    getAppCategoryReturnConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
+    getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
     /**
      * @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js

@@ -1746,13 +1746,17 @@ class Catalog {
    * @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
    */
   async getAppCategoryReturnConfig(
-    { requestHeaders } = { requestHeaders: {} },
+    { q, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
     } = CatalogPlatformApplicationValidator.getAppCategoryReturnConfig().validate(
-      {},
+      {
+        q,
+        pageNo,
+        pageSize,
+      },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -1763,7 +1767,11 @@ class Catalog {
     const {
       error: warrning,
     } = CatalogPlatformApplicationValidator.getAppCategoryReturnConfig().validate(
-      {},
+      {
+        q,
+        pageNo,
+        pageSize,
+      },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -1774,6 +1782,9 @@ class Catalog {
     }
 
     const query_params = {};
+    query_params["q"] = q;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
 
     const response = await PlatformAPIClient.execute(
       this.config,

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

@@ -96,7 +96,15 @@ export = CatalogPlatformApplicationValidator;
  *   Default is 12.
  */
 /** @typedef GetAllSearchKeywordParam */
-/** @typedef GetAppCategoryReturnConfigParam */
+/**
+ * @typedef GetAppCategoryReturnConfigParam
+ * @property {string} [q] - Get return configurations for categories by matching
+ *   the search string with category names.
+ * @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.
+ */
 /**
  * @typedef GetAppInventoryParam
  * @property {number[]} [itemIds] - The Item Id of the product.
@@ -465,7 +473,7 @@ declare class CatalogPlatformApplicationValidator {
     /** @returns {GetAllSearchKeywordParam} */
     static getAllSearchKeyword(): any;
     /** @returns {GetAppCategoryReturnConfigParam} */
-    static getAppCategoryReturnConfig(): any;
+    static getAppCategoryReturnConfig(): GetAppCategoryReturnConfigParam;
     /** @returns {GetAppInventoryParam} */
     static getAppInventory(): GetAppInventoryParam;
     /** @returns {GetAppLocationsParam} */
@@ -691,6 +699,23 @@ type GetAllCollectionsParam = {
      */
     pageSize?: number;
 };
+type GetAppCategoryReturnConfigParam = {
+    /**
+     * - Get return configurations for categories by matching
+     * the search string with category names.
+     */
+    q?: string;
+    /**
+     * - The page number to navigate through the given
+     * set of results
+     */
+    pageNo?: number;
+    /**
+     * - Number of items to retrieve in each page.
+     * Default is 10.
+     */
+    pageSize?: number;
+};
 type GetAppInventoryParam = {
     /**
      * - The Item Id of the product.
@@ -1289,7 +1314,6 @@ type UpdateSearchKeywordsParam = {
 };
 type DeleteSearchConfigurationParam = any;
 type GetAllSearchKeywordParam = any;
-type GetAppCategoryReturnConfigParam = any;
 type GetAppReturnConfigurationParam = any;
 type GetAutocompleteConfigParam = any;
 type GetCatalogConfigurationParam = any;

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -119,7 +119,15 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /** @typedef GetAllSearchKeywordParam */
 
-/** @typedef GetAppCategoryReturnConfigParam */
+/**
+ * @typedef GetAppCategoryReturnConfigParam
+ * @property {string} [q] - Get return configurations for categories by matching
+ *   the search string with category names.
+ * @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.
+ */
 
 /**
  * @typedef GetAppInventoryParam
@@ -643,7 +651,11 @@ class CatalogPlatformApplicationValidator {
 
   /** @returns {GetAppCategoryReturnConfigParam} */
   static getAppCategoryReturnConfig() {
-    return Joi.object({}).required();
+    return Joi.object({
+      q: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+    }).required();
   }
 
   /** @returns {GetAppInventoryParam} */

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

@@ -62,27 +62,6 @@ declare class Catalog {
      * @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
      */
     createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
-    /**
-     * @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
-     * @name createCategories
-     * @summary: Create categories
-     * @description: Allows to create product categories for specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
-     */
-    createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
-    /**
-     * @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
-     *   Success response
-     * @name createDepartments
-     * @summary: Create departments
-     * @description: Create departments for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
-     */
-    createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
     /**
      * @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -285,6 +264,16 @@ declare class Catalog {
      * @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
      */
     getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
+    /**
+     * @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
+     * @name getAttribute
+     * @summary: Get attribute detail by slug
+     * @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAttribute/).
+     */
+    getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AttributeDetail>;
     /**
      * @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -336,16 +325,6 @@ declare class Catalog {
      * @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
      */
     getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
-    /**
-     * @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
-     * @name getGenderAttribute
-     * @summary: Get gender attribute by slug
-     * @description: Retrieve the gender attribute for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
-     */
-    getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
     /**
      * @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -942,26 +921,6 @@ declare class Catalog {
      * @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
      */
     listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
-    /**
-     * @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
-     * @name updateCategory
-     * @summary: Update category
-     * @description: Modify data for an existing category by its uid for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
-     */
-    updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
-    /**
-     * @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
-     * @name updateDepartment
-     * @summary: Update department
-     * @description: Modify the department data by their uid for a specifc company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
-     */
-    updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
     /**
      * @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`