@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-beta.2

package/sdk/platform/Cart/CartPlatformModel.js

@@ -624,6 +624,11 @@ const Joi = require("joi");
  * @property {PriceAdjustment} [data]
  */
 
+/**
+ * @typedef GetPriceAdjustmentResponse
+ * @property {PriceAdjustment[]} [data]
+ */
+
 /**
  * @typedef PriceAdjustmentAdd
  * @property {number} value
@@ -830,22 +835,12 @@ const Joi = require("joi");
  * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
  */
 
-/**
- * @typedef FreeGiftItem
- * @property {string} [item_name] - Item name
- * @property {Object} [item_price_details] - Item price details
- * @property {string} [item_brand_name] - Item brand name
- * @property {string[]} [item_images_url] - Item images URL
- * @property {number} [item_id] - Item id
- * @property {string} [item_slug] - Item slug
- */
-
 /**
  * @typedef AppliedFreeArticles
  * @property {string} [parent_item_identifier] - Parent item identifier for free article
  * @property {number} [quantity] - Free article quantity
  * @property {string} [article_id] - Free article id
- * @property {FreeGiftItem} [free_gift_item_details] - Free gift items details
+ * @property {FreeGiftItems} [free_gift_item_details] - Free gift items details
  */
 
 /**
@@ -1234,6 +1229,7 @@ const Joi = require("joi");
  * @property {string} [gstin]
  * @property {AppliedPromotion[]} [applied_promo_details]
  * @property {string} [pan_no]
+ * @property {Object} [custom_cart_meta]
  */
 
 /**
@@ -1333,6 +1329,7 @@ const Joi = require("joi");
  * @property {string} currency_code
  * @property {string} aggregator
  * @property {string} order_type
+ * @property {string} [callback_url]
  * @property {OverrideCartItem[]} cart_items
  * @property {number} [ordering_store]
  * @property {Object} [shipping_address]
@@ -1390,6 +1387,7 @@ const Joi = require("joi");
  * @property {boolean} [buy_now]
  * @property {number} [cart_id]
  * @property {string} [gstin]
+ * @property {Object} [custom_cart_meta]
  */
 
 /**
@@ -1453,6 +1451,7 @@ const Joi = require("joi");
  * @property {string} [last_modified]
  * @property {boolean} [buy_now]
  * @property {string} [gstin]
+ * @property {Object} [custom_cart_meta]
  * @property {AppliedPromotion[]} [applied_promo_details]
  * @property {string} [pan_no]
  */
@@ -1647,6 +1646,7 @@ const Joi = require("joi");
  * @property {AppliedPromotion[]} [applied_promo_details]
  * @property {boolean} [error]
  * @property {string} [pan_no]
+ * @property {Object} [custom_cart_meta]
  */
 
 /**
@@ -1778,6 +1778,7 @@ const Joi = require("joi");
  * @property {string} [gstin]
  * @property {boolean} [cod_available]
  * @property {number} [delivery_charges]
+ * @property {Object} [custom_cart_meta]
  */
 
 /**
@@ -1915,6 +1916,68 @@ const Joi = require("joi");
  * @property {PaymentMethod[]} [payment_methods]
  */
 
+/**
+ * @typedef PriceMinMax
+ * @property {number} [min]
+ * @property {number} [max]
+ */
+
+/**
+ * @typedef ItemPriceDetails
+ * @property {PriceMinMax} [marked]
+ * @property {PriceMinMax} [effective]
+ * @property {string} [currency]
+ */
+
+/**
+ * @typedef FreeGiftItems
+ * @property {string} [item_slug] - Item slug
+ * @property {string} [item_name] - Item name
+ * @property {ItemPriceDetails} [item_price_details]
+ * @property {string} [item_brand_name] - Item brand name
+ * @property {number} [item_id] - Item id
+ * @property {string[]} [item_images_url] - Item images URL
+ */
+
+/**
+ * @typedef PromotionOffer
+ * @property {string} [id] - Promotion id
+ * @property {Object} [buy_rules] - Buy rules of promotions
+ * @property {string} [offer_text] - Offer title
+ * @property {string} [promotion_type] - Promotion type
+ * @property {string} [promotion_name] - Name of the promotion
+ * @property {string} [promotion_group] - Group of promotion belongs to
+ * @property {string} [valid_till] - Datetime ISOString for promotion end date
+ * @property {Object[]} [discount_rules] - Discount rules of promotions
+ * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
+ * @property {string} [description] - Offer details including T&C
+ */
+
+/**
+ * @typedef PromotionOffersResponse
+ * @property {PromotionOffer[]} [available_promotions]
+ */
+
+/**
+ * @typedef PromotionPaymentOffer
+ * @property {string} [application_id] - Application id
+ * @property {Object[]} [buy_rules] - Buy rules of promotions
+ * @property {string} [calculate_on] - Price on which promotion calculated
+ * @property {string} [description] - Offer details including T&C
+ * @property {Object[]} [discount_rules] - Discount rules of promotions
+ * @property {string} [id] - Promotion id
+ * @property {string} [offer_text] - Offer title
+ * @property {string} [promotion_group] - Group of promotion belongs to
+ * @property {string} [promotion_type] - Promotion type
+ * @property {string} [promotion_name] - Name of the promotion
+ */
+
+/**
+ * @typedef PromotionPaymentOffersResponse
+ * @property {boolean} [success]
+ * @property {PromotionPaymentOffer[]} [promotions]
+ */
+
 class CartPlatformModel {
   /** @returns {CouponDateMeta} */
   static CouponDateMeta() {
@@ -2656,6 +2719,13 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {GetPriceAdjustmentResponse} */
+  static GetPriceAdjustmentResponse() {
+    return Joi.object({
+      data: Joi.array().items(CartPlatformModel.PriceAdjustment()),
+    });
+  }
+
   /** @returns {PriceAdjustmentAdd} */
   static PriceAdjustmentAdd() {
     return Joi.object({
@@ -2898,25 +2968,13 @@ class CartPlatformModel {
     });
   }
 
-  /** @returns {FreeGiftItem} */
-  static FreeGiftItem() {
-    return Joi.object({
-      item_name: Joi.string().allow(""),
-      item_price_details: Joi.any(),
-      item_brand_name: Joi.string().allow(""),
-      item_images_url: Joi.array().items(Joi.string().allow("")),
-      item_id: Joi.number(),
-      item_slug: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {AppliedFreeArticles} */
   static AppliedFreeArticles() {
     return Joi.object({
       parent_item_identifier: Joi.string().allow(""),
       quantity: Joi.number(),
       article_id: Joi.string().allow(""),
-      free_gift_item_details: CartPlatformModel.FreeGiftItem(),
+      free_gift_item_details: CartPlatformModel.FreeGiftItems(),
     });
   }
 
@@ -3385,6 +3443,7 @@ class CartPlatformModel {
         CartPlatformModel.AppliedPromotion()
       ),
       pan_no: Joi.string().allow(""),
+      custom_cart_meta: Joi.any(),
     });
   }
 
@@ -3501,6 +3560,7 @@ class CartPlatformModel {
       currency_code: Joi.string().allow("").required(),
       aggregator: Joi.string().allow("").required(),
       order_type: Joi.string().allow("").required(),
+      callback_url: Joi.string().allow(""),
       cart_items: Joi.array()
         .items(CartPlatformModel.OverrideCartItem())
         .required(),
@@ -3569,6 +3629,7 @@ class CartPlatformModel {
       buy_now: Joi.boolean(),
       cart_id: Joi.number(),
       gstin: Joi.string().allow(""),
+      custom_cart_meta: Joi.any(),
     });
   }
 
@@ -3644,6 +3705,7 @@ class CartPlatformModel {
       last_modified: Joi.string().allow(""),
       buy_now: Joi.boolean(),
       gstin: Joi.string().allow(""),
+      custom_cart_meta: Joi.any(),
       applied_promo_details: Joi.array().items(
         CartPlatformModel.AppliedPromotion()
       ),
@@ -3881,6 +3943,7 @@ class CartPlatformModel {
       ),
       error: Joi.boolean(),
       pan_no: Joi.string().allow(""),
+      custom_cart_meta: Joi.any(),
     });
   }
 
@@ -4037,6 +4100,7 @@ class CartPlatformModel {
       gstin: Joi.string().allow(""),
       cod_available: Joi.boolean(),
       delivery_charges: Joi.number(),
+      custom_cart_meta: Joi.any(),
     });
   }
 
@@ -4198,5 +4262,83 @@ class CartPlatformModel {
       payment_methods: Joi.array().items(CartPlatformModel.PaymentMethod()),
     });
   }
+
+  /** @returns {PriceMinMax} */
+  static PriceMinMax() {
+    return Joi.object({
+      min: Joi.number(),
+      max: Joi.number(),
+    });
+  }
+
+  /** @returns {ItemPriceDetails} */
+  static ItemPriceDetails() {
+    return Joi.object({
+      marked: CartPlatformModel.PriceMinMax(),
+      effective: CartPlatformModel.PriceMinMax(),
+      currency: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {FreeGiftItems} */
+  static FreeGiftItems() {
+    return Joi.object({
+      item_slug: Joi.string().allow(""),
+      item_name: Joi.string().allow(""),
+      item_price_details: CartPlatformModel.ItemPriceDetails(),
+      item_brand_name: Joi.string().allow(""),
+      item_id: Joi.number(),
+      item_images_url: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  /** @returns {PromotionOffer} */
+  static PromotionOffer() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      buy_rules: Joi.any(),
+      offer_text: Joi.string().allow(""),
+      promotion_type: Joi.string().allow(""),
+      promotion_name: Joi.string().allow(""),
+      promotion_group: Joi.string().allow(""),
+      valid_till: Joi.string().allow(""),
+      discount_rules: Joi.array().items(Joi.any()),
+      free_gift_items: Joi.array().items(CartPlatformModel.FreeGiftItems()),
+      description: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PromotionOffersResponse} */
+  static PromotionOffersResponse() {
+    return Joi.object({
+      available_promotions: Joi.array().items(
+        CartPlatformModel.PromotionOffer()
+      ),
+    });
+  }
+
+  /** @returns {PromotionPaymentOffer} */
+  static PromotionPaymentOffer() {
+    return Joi.object({
+      application_id: Joi.string().allow(""),
+      buy_rules: Joi.array().items(Joi.any()),
+      calculate_on: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      discount_rules: Joi.array().items(Joi.any()),
+      id: Joi.string().allow(""),
+      offer_text: Joi.string().allow(""),
+      promotion_group: Joi.string().allow(""),
+      promotion_type: Joi.string().allow(""),
+      promotion_name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PromotionPaymentOffersResponse} */
+  static PromotionPaymentOffersResponse() {
+    return Joi.object({
+      success: Joi.boolean(),
+      promotions: Joi.array().items(CartPlatformModel.PromotionPaymentOffer()),
+    });
+  }
 }
 module.exports = CartPlatformModel;

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

@@ -107,12 +107,14 @@ declare class Catalog {
      * @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
+     * @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>}
+     *   - Success response
+     *
      * @name createMarketplaceOptin
      * @summary: Create or Update opt-in infomation
-     * @description: Allows to create and update opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
+     * @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
      */
-    createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdatedResponse>;
+    createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>;
     /**
      * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -422,17 +424,19 @@ declare class Catalog {
      * @summary: List bulk inventory upload history
      * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
      */
-    getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
+    getInventoryBulkUploadHistory({ pageNo, pageSize, search, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 12.
+     * @param {string} [arg.search] - Search string to filter the results by batch id
      * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
      * @summary: List bulk inventory upload history
      * @description: Helps to get bulk Inventory upload jobs status.
      */
-    getInventoryBulkUploadHistoryPaginator({ pageSize }?: {
+    getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
         pageSize?: number;
+        search?: string;
     }): Paginator<CatalogPlatformModel.BulkInventoryGet>;
     /**
      * @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
@@ -636,7 +640,7 @@ declare class Catalog {
      * @summary: Get product export jobs
      * @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
      */
-    getProductExportJobs({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
+    getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
     /**
      * @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -879,7 +883,7 @@ declare class Catalog {
      * @summary: List inventory export jobs
      * @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
      */
-    listInventoryExport({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
+    listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
     /**
      * @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Catalog/CatalogPlatformClient.js

@@ -817,20 +817,22 @@ class Catalog {
    * @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
+   * @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>}
+   *   - Success response
+   *
    * @name createMarketplaceOptin
    * @summary: Create or Update opt-in infomation
-   * @description: Allows to create and update opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
+   * @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
    */
   async createMarketplaceOptin(
-    { marketplace, body, requestHeaders } = { requestHeaders: {} },
+    { marketplaceSlug, body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
     } = CatalogPlatformValidator.createMarketplaceOptin().validate(
       {
-        marketplace,
+        marketplaceSlug,
         body,
       },
       { abortEarly: false, allowUnknown: true }
@@ -844,7 +846,7 @@ class Catalog {
       error: warrning,
     } = CatalogPlatformValidator.createMarketplaceOptin().validate(
       {
-        marketplace,
+        marketplaceSlug,
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -863,7 +865,7 @@ class Catalog {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/catalog/v1.0/company/${this.config.companyId}/marketplaces/${marketplace}/optin/`,
+      `/service/platform/catalog/v1.0/company/${this.config.companyId}/channel/${marketplaceSlug}/opt-in`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -877,10 +879,10 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.UpdatedResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = CatalogPlatformModel.CreateMarketplaceOptinResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -2999,7 +3001,7 @@ class Catalog {
    * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
    */
   async getInventoryBulkUploadHistory(
-    { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
+    { pageNo, pageSize, search, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
@@ -3008,6 +3010,7 @@ class Catalog {
       {
         pageNo,
         pageSize,
+        search,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -3022,6 +3025,7 @@ class Catalog {
       {
         pageNo,
         pageSize,
+        search,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -3035,6 +3039,7 @@ class Catalog {
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
+    query_params["search"] = search;
 
     const xHeaders = {};
 
@@ -3078,11 +3083,12 @@ class Catalog {
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 12.
+   * @param {string} [arg.search] - Search string to filter the results by batch id
    * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
    * @summary: List bulk inventory upload history
    * @description: Helps to get bulk Inventory upload jobs status.
    */
-  getInventoryBulkUploadHistoryPaginator({ pageSize } = {}) {
+  getInventoryBulkUploadHistoryPaginator({ pageSize, search } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
       const pageId = paginator.nextId;
@@ -3091,6 +3097,7 @@ class Catalog {
       const data = await this.getInventoryBulkUploadHistory({
         pageNo: pageNo,
         pageSize: pageSize,
+        search: search,
       });
       paginator.setPaginator({
         hasNext: data.page.has_next ? true : false,
@@ -4266,7 +4273,9 @@ class Catalog {
    * @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
    */
   async getProductExportJobs(
-    { status, fromDate, toDate, q, requestHeaders } = { requestHeaders: {} },
+    { status, fromDate, toDate, q, pageNo, pageSize, requestHeaders } = {
+      requestHeaders: {},
+    },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = CatalogPlatformValidator.getProductExportJobs().validate(
@@ -4275,6 +4284,8 @@ class Catalog {
         fromDate,
         toDate,
         q,
+        pageNo,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -4291,6 +4302,8 @@ class Catalog {
         fromDate,
         toDate,
         q,
+        pageNo,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -4306,6 +4319,8 @@ class Catalog {
     query_params["from_date"] = fromDate;
     query_params["to_date"] = toDate;
     query_params["q"] = q;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
 
     const xHeaders = {};
 
@@ -5701,7 +5716,9 @@ class Catalog {
    * @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
    */
   async listInventoryExport(
-    { status, fromDate, toDate, q, requestHeaders } = { requestHeaders: {} },
+    { status, fromDate, toDate, q, pageNo, pageSize, requestHeaders } = {
+      requestHeaders: {},
+    },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = CatalogPlatformValidator.listInventoryExport().validate(
@@ -5710,6 +5727,8 @@ class Catalog {
         fromDate,
         toDate,
         q,
+        pageNo,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -5726,6 +5745,8 @@ class Catalog {
         fromDate,
         toDate,
         q,
+        pageNo,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -5741,6 +5762,8 @@ class Catalog {
     query_params["from_date"] = fromDate;
     query_params["to_date"] = toDate;
     query_params["q"] = q;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
 
     const xHeaders = {};