@gofynd/fdk-client-javascript 1.3.5 → 1.3.6-beta.1

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -47,6 +47,22 @@ const Joi = require("joi");
  * @property {string} [type]
  */
 
+/**
+ * @typedef AppCategoryReturnConfig
+ * @property {number} category_id - Unique identifier for L3 category
+ * @property {ProductReturnConfigBaseSerializer} return_config - Return
+ *   configuration details
+ */
+
+/**
+ * @typedef AppCategoryReturnConfigResponse
+ * @property {string} [app_id] - Channel identifier
+ * @property {number} [category_id] - Unique identifer of L3 category
+ * @property {string} [logo]
+ * @property {string} [name] - Name of L3 category
+ * @property {ProductReturnConfigBaseSerializer} [return_config]
+ */
+
 /**
  * @typedef AppConfiguration
  * @property {string} app_id
@@ -184,6 +200,19 @@ const Joi = require("joi");
  * @property {Object} _custom_json
  */
 
+/**
+ * @typedef AppReturnConfigResponse
+ * @property {string} [app_id] - Channel identifier
+ * @property {number} [category_count] - Count of L3 category return config set
+ *   for application
+ * @property {number} [company_id] - Unique identifer of company
+ * @property {Object} [created_by] - User details
+ * @property {Object} [modified_by] - User details
+ * @property {string} [modified_on] - Modification date
+ * @property {string} [return_config_level] - Configuration level of return
+ *   window category|product|no-return
+ */
+
 /**
  * @typedef ArticleAssignment
  * @property {string} [level]
@@ -342,6 +371,19 @@ const Joi = require("joi");
  * @property {string} [url]
  */
 
+/**
+ * @typedef BaseAppCategoryReturnConfig
+ * @property {string} app_id - Channel identifier
+ * @property {number} company_id - Unique identifer of company
+ * @property {AppCategoryReturnConfig[]} data - Category level return config details
+ */
+
+/**
+ * @typedef BaseAppCategoryReturnConfigResponse
+ * @property {AppCategoryReturnConfigResponse[]} [data]
+ * @property {PageResponse} [page]
+ */
+
 /**
  * @typedef Brand
  * @property {Logo} [logo]
@@ -934,6 +976,14 @@ const Joi = require("joi");
  * @property {string[]} [words]
  */
 
+/**
+ * @typedef CreateUpdateAppReturnConfig
+ * @property {string} app_id - Channel identifier
+ * @property {number} company_id - Unique identifer of company
+ * @property {string} return_config_level - Return configurtion Level
+ *   category|product|no-return
+ */
+
 /**
  * @typedef CrossSellingData
  * @property {number} [articles]
@@ -966,6 +1016,13 @@ const Joi = require("joi");
  * @property {string} default_key
  */
 
+/**
+ * @typedef DeleteAppCategoryReturnConfig
+ * @property {string} app_id - Channel identifier
+ * @property {number[]} category_ids - List of category_ids to be deleted.
+ * @property {number} company_id - Unique identifer of company
+ */
+
 /**
  * @typedef DeleteResponse
  * @property {string} [message]
@@ -2177,6 +2234,16 @@ const Joi = require("joi");
  * @property {number} [size] - It is the size of each page.
  */
 
+/**
+ * @typedef PageResponse1
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {boolean} [has_previous]
+ * @property {number} [item_total]
+ * @property {number} [size]
+ * @property {string} [type]
+ */
+
 /**
  * @typedef PageResponseType
  * @property {number} current
@@ -2578,6 +2645,13 @@ const Joi = require("joi");
  * @property {number} [product_online_date]
  */
 
+/**
+ * @typedef ProductReturnConfigBaseSerializer
+ * @property {boolean} returnable - Boolean Flag for item returnable
+ * @property {number} time - Valid return time for an item
+ * @property {string} unit - Unit of return config days|hours
+ */
+
 /**
  * @typedef ProductReturnConfigSerializer
  * @property {boolean} [on_same_store]
@@ -3461,6 +3535,25 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {AppCategoryReturnConfig} */
+  static AppCategoryReturnConfig() {
+    return Joi.object({
+      category_id: Joi.number().required(),
+      return_config: CatalogPlatformModel.ProductReturnConfigBaseSerializer().required(),
+    });
+  }
+
+  /** @returns {AppCategoryReturnConfigResponse} */
+  static AppCategoryReturnConfigResponse() {
+    return Joi.object({
+      app_id: Joi.string().allow(""),
+      category_id: Joi.number(),
+      logo: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      return_config: CatalogPlatformModel.ProductReturnConfigBaseSerializer(),
+    });
+  }
+
   /** @returns {AppConfiguration} */
   static AppConfiguration() {
     return Joi.object({
@@ -3634,6 +3727,19 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {AppReturnConfigResponse} */
+  static AppReturnConfigResponse() {
+    return Joi.object({
+      app_id: Joi.string().allow(""),
+      category_count: Joi.number(),
+      company_id: Joi.number(),
+      created_by: Joi.any(),
+      modified_by: Joi.any(),
+      modified_on: Joi.string().allow(""),
+      return_config_level: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ArticleAssignment} */
   static ArticleAssignment() {
     return Joi.object({
@@ -3832,6 +3938,27 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {BaseAppCategoryReturnConfig} */
+  static BaseAppCategoryReturnConfig() {
+    return Joi.object({
+      app_id: Joi.string().allow("").required(),
+      company_id: Joi.number().required(),
+      data: Joi.array()
+        .items(CatalogPlatformModel.AppCategoryReturnConfig())
+        .required(),
+    });
+  }
+
+  /** @returns {BaseAppCategoryReturnConfigResponse} */
+  static BaseAppCategoryReturnConfigResponse() {
+    return Joi.object({
+      data: Joi.array().items(
+        CatalogPlatformModel.AppCategoryReturnConfigResponse()
+      ),
+      page: CatalogPlatformModel.PageResponse(),
+    });
+  }
+
   /** @returns {Brand} */
   static Brand() {
     return Joi.object({
@@ -4546,6 +4673,15 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {CreateUpdateAppReturnConfig} */
+  static CreateUpdateAppReturnConfig() {
+    return Joi.object({
+      app_id: Joi.string().allow("").required(),
+      company_id: Joi.number().required(),
+      return_config_level: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {CrossSellingData} */
   static CrossSellingData() {
     return Joi.object({
@@ -4588,6 +4724,15 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {DeleteAppCategoryReturnConfig} */
+  static DeleteAppCategoryReturnConfig() {
+    return Joi.object({
+      app_id: Joi.string().allow("").required(),
+      category_ids: Joi.array().items(Joi.number()).required(),
+      company_id: Joi.number().required(),
+    });
+  }
+
   /** @returns {DeleteResponse} */
   static DeleteResponse() {
     return Joi.object({
@@ -6026,6 +6171,18 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {PageResponse1} */
+  static PageResponse1() {
+    return Joi.object({
+      current: Joi.number(),
+      has_next: Joi.boolean(),
+      has_previous: Joi.boolean(),
+      item_total: Joi.number(),
+      size: Joi.number(),
+      type: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {PageResponseType} */
   static PageResponseType() {
     return Joi.object({
@@ -6503,6 +6660,15 @@ class CatalogPlatformModel {
     });
   }
 
+  /** @returns {ProductReturnConfigBaseSerializer} */
+  static ProductReturnConfigBaseSerializer() {
+    return Joi.object({
+      returnable: Joi.boolean().required(),
+      time: Joi.number().required(),
+      unit: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {ProductReturnConfigSerializer} */
   static ProductReturnConfigSerializer() {
     return Joi.object({

package/sdk/platform/Order/OrderPlatformModel.d.ts

@@ -1074,6 +1074,7 @@ export = OrderPlatformModel;
  * @property {string} [external_invoice_id]
  * @property {string} [invoice_url]
  * @property {string} [label_url]
+ * @property {Object} [links]
  * @property {string} [store_invoice_id]
  * @property {string} [updated_date]
  */
@@ -1171,7 +1172,7 @@ export = OrderPlatformModel;
  * @property {boolean} [is_parent]
  * @property {PlatformItem} [item]
  * @property {number} [line_number]
- * @property {BagMeta} [meta]
+ * @property {Object} [meta]
  * @property {Object} [parent_promo_bags]
  * @property {BagPaymentMethods[]} [payment_methods]
  * @property {Prices} [prices]
@@ -1199,7 +1200,7 @@ export = OrderPlatformModel;
 /**
  * @typedef OrderData
  * @property {string} fynd_order_id
- * @property {OrderMeta} [meta]
+ * @property {Object} [meta]
  * @property {string} order_date
  * @property {Object} [payment_methods]
  * @property {Prices} [prices]
@@ -1835,7 +1836,7 @@ export = OrderPlatformModel;
  * @property {ShipmentItemFulFillingStore} [fulfilling_store]
  * @property {string} [invoice_id]
  * @property {boolean} [lock_status]
- * @property {ShipmentItemMeta} [meta]
+ * @property {Object} [meta]
  * @property {string} [mode_of_payment]
  * @property {string} [order_date]
  * @property {string} order_id
@@ -3738,6 +3739,7 @@ type InvoiceInfo = {
     external_invoice_id?: string;
     invoice_url?: string;
     label_url?: string;
+    links?: any;
     store_invoice_id?: string;
     updated_date?: string;
 };
@@ -3845,7 +3847,7 @@ type OrderBags = {
     is_parent?: boolean;
     item?: PlatformItem;
     line_number?: number;
-    meta?: BagMeta;
+    meta?: any;
     parent_promo_bags?: any;
     payment_methods?: BagPaymentMethods[];
     prices?: Prices;
@@ -3876,7 +3878,7 @@ type OrderConfig = {
 declare function OrderData(): OrderData;
 type OrderData = {
     fynd_order_id: string;
-    meta?: OrderMeta;
+    meta?: any;
     order_date: string;
     payment_methods?: any;
     prices?: Prices;
@@ -4634,7 +4636,7 @@ type ShipmentItem = {
     fulfilling_store?: ShipmentItemFulFillingStore;
     invoice_id?: string;
     lock_status?: boolean;
-    meta?: ShipmentItemMeta;
+    meta?: any;
     mode_of_payment?: string;
     order_date?: string;
     order_id: string;

package/sdk/platform/Order/OrderPlatformModel.js

@@ -1192,6 +1192,7 @@ const Joi = require("joi");
  * @property {string} [external_invoice_id]
  * @property {string} [invoice_url]
  * @property {string} [label_url]
+ * @property {Object} [links]
  * @property {string} [store_invoice_id]
  * @property {string} [updated_date]
  */
@@ -1299,7 +1300,7 @@ const Joi = require("joi");
  * @property {boolean} [is_parent]
  * @property {PlatformItem} [item]
  * @property {number} [line_number]
- * @property {BagMeta} [meta]
+ * @property {Object} [meta]
  * @property {Object} [parent_promo_bags]
  * @property {BagPaymentMethods[]} [payment_methods]
  * @property {Prices} [prices]
@@ -1330,7 +1331,7 @@ const Joi = require("joi");
 /**
  * @typedef OrderData
  * @property {string} fynd_order_id
- * @property {OrderMeta} [meta]
+ * @property {Object} [meta]
  * @property {string} order_date
  * @property {Object} [payment_methods]
  * @property {Prices} [prices]
@@ -2037,7 +2038,7 @@ const Joi = require("joi");
  * @property {ShipmentItemFulFillingStore} [fulfilling_store]
  * @property {string} [invoice_id]
  * @property {boolean} [lock_status]
- * @property {ShipmentItemMeta} [meta]
+ * @property {Object} [meta]
  * @property {string} [mode_of_payment]
  * @property {string} [order_date]
  * @property {string} order_id
@@ -4060,6 +4061,7 @@ class OrderPlatformModel {
       external_invoice_id: Joi.string().allow("").allow(null),
       invoice_url: Joi.string().allow("").allow(null),
       label_url: Joi.string().allow("").allow(null),
+      links: Joi.object().pattern(/\S/, Joi.any()),
       store_invoice_id: Joi.string().allow("").allow(null),
       updated_date: Joi.string().allow("").allow(null),
     });
@@ -4189,7 +4191,7 @@ class OrderPlatformModel {
       is_parent: Joi.boolean().allow(null),
       item: OrderPlatformModel.PlatformItem(),
       line_number: Joi.number().allow(null),
-      meta: OrderPlatformModel.BagMeta(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       parent_promo_bags: Joi.any().allow(null),
       payment_methods: Joi.array().items(
         OrderPlatformModel.BagPaymentMethods()
@@ -4230,7 +4232,7 @@ class OrderPlatformModel {
   static OrderData() {
     return Joi.object({
       fynd_order_id: Joi.string().allow("").required(),
-      meta: OrderPlatformModel.OrderMeta(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       order_date: Joi.string().allow("").required(),
       payment_methods: Joi.any().allow(null),
       prices: OrderPlatformModel.Prices(),
@@ -5089,7 +5091,7 @@ class OrderPlatformModel {
       fulfilling_store: OrderPlatformModel.ShipmentItemFulFillingStore(),
       invoice_id: Joi.string().allow("").allow(null),
       lock_status: Joi.boolean().allow(null),
-      meta: OrderPlatformModel.ShipmentItemMeta(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       mode_of_payment: Joi.string().allow(""),
       order_date: Joi.string().allow("").allow(null),
       order_id: Joi.string().allow("").required(),