@gofynd/fdk-client-javascript 3.3.6 → 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  4. package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
  5. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
  6. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  7. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +4 -4
  8. package/sdk/partner/Logistics/LogisticsPartnerModel.js +2 -2
  9. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
  10. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
  11. package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -1
  12. package/sdk/platform/Cart/CartPlatformModel.js +123 -0
  13. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
  14. package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
  15. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
  16. package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
  17. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
  18. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
  19. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
  20. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
  21. package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -1
  22. package/sdk/platform/Order/OrderPlatformModel.js +22 -0
  23. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
  24. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
  25. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  27. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
  28. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
  29. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
  30. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
  31. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  32. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  33. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
  34. package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
  35. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  36. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  37. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  38. package/sdk/platform/User/UserPlatformModel.js +276 -7
  39. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
  40. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
@@ -1035,6 +1035,43 @@ const Joi = require("joi");
1035
1035
  * often used for internal reference
1036
1036
  */
1037
1037
 
1038
+ /**
1039
+ * @typedef FulfillmentOptionSchema
1040
+ * @property {string} [slug] - Unique identifier for the delivery type.
1041
+ * @property {string} [description] - Description of the delivery service.
1042
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
1043
+ * @property {string} [id] - Unique ID of the delivery service.
1044
+ * @property {string} [type] - Type of fulfillment option.
1045
+ * @property {string} [name] - Name of the delivery service.
1046
+ */
1047
+
1048
+ /**
1049
+ * @typedef StoreTimingSchema
1050
+ * @property {number} [hour] - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
1051
+ * @property {number} [minute] - The minute of the store (e.g., 30 for 9:30 AM).
1052
+ */
1053
+
1054
+ /**
1055
+ * @typedef StoreHoursSchema
1056
+ * @property {string} [weekday] - The day of the week (e.g., "Monday", "Tuesday").
1057
+ * @property {StoreTimingSchema} [opening]
1058
+ * @property {StoreTimingSchema} [closing]
1059
+ * @property {boolean} [open] - Indicates whether the store is open on the
1060
+ * specified weekday.
1061
+ */
1062
+
1063
+ /**
1064
+ * @typedef PickupStoreDetailSchema
1065
+ * @property {number} [store_id] - A unique identifier for the store.
1066
+ * @property {string} [name] - The name of the store or pickup location.
1067
+ * @property {string} [pincode] - The postal code of the store's location.
1068
+ * @property {number} [distance] - The distance between the store and the
1069
+ * customer's location.
1070
+ * @property {string} [address] - The full address of the store.
1071
+ * @property {Object} [store_hours] - The store's operational hours for each day
1072
+ * of the week.
1073
+ */
1074
+
1038
1075
  /**
1039
1076
  * @typedef ProductArticle
1040
1077
  * @property {string} [seller_identifier] - List of identifiers used by sellers
@@ -1066,6 +1103,8 @@ const Joi = require("joi");
1066
1103
  * @property {Object} [meta] - Meta data of article in cart
1067
1104
  * @property {string} [size] - Size of the article added in cart
1068
1105
  * @property {StoreInfo} [store]
1106
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
1107
+ * @property {PickupStoreDetailSchema} [pickup_store_detail]
1069
1108
  * @property {number} [item_index] - Specify the index of article in cart.
1070
1109
  * @property {string[]} [tags] - A list of article tags
1071
1110
  */
@@ -1511,6 +1550,17 @@ const Joi = require("joi");
1511
1550
  * @property {DeliveryChargesConfig} [delivery_charges_config]
1512
1551
  */
1513
1552
 
1553
+ /**
1554
+ * @typedef PlatformAlternatePickupPerson
1555
+ * @property {boolean} [enabled] - Indicates whether an alternate pickup person
1556
+ * is enabled.
1557
+ * @property {string} [name] - Name of the alternate pickup person.
1558
+ * @property {string} [email] - Email address of the alternate pickup person.
1559
+ * @property {string} [phone] - Phone number of the alternate pickup person.
1560
+ * @property {string} [country_phone_code] - Country phone code of the alternate
1561
+ * pickup person (e.g., "+91").
1562
+ */
1563
+
1514
1564
  /**
1515
1565
  * @typedef CartDetailResult
1516
1566
  * @property {number} [cart_id] - Unique identifier of the user cart
@@ -1552,6 +1602,7 @@ const Joi = require("joi");
1552
1602
  * @property {string} [pan_no] - Permanent Account Number of the user
1553
1603
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
1554
1604
  * checkout API payload
1605
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
1555
1606
  * @property {boolean} [free_gift_selection_available] - Determines if the cart
1556
1607
  * has available promotion free gift items to choose on its added items
1557
1608
  */
@@ -1584,6 +1635,10 @@ const Joi = require("joi");
1584
1635
  * @property {boolean} [pos] - Filed to determine whether user is making request
1585
1636
  * from pos or not
1586
1637
  * @property {string} [seller_identifier] - Add items using seller identifier for store os
1638
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
1639
+ * method, indicating whether an order is for home delivery or store pickup
1640
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
1641
+ * selected by the user from which user wants to pickup the product.
1587
1642
  */
1588
1643
 
1589
1644
  /**
@@ -1634,6 +1689,10 @@ const Joi = require("joi");
1634
1689
  * product falls to be updated
1635
1690
  * @property {CartProductIdentifer} identifiers
1636
1691
  * @property {string} [article_id] - Article id of the product in cart
1692
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
1693
+ * method, indicating whether an order is for home delivery or store pickup
1694
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
1695
+ * selected by the user from which user
1637
1696
  */
1638
1697
 
1639
1698
  /**
@@ -2069,6 +2128,7 @@ const Joi = require("joi");
2069
2128
  * @property {string} [dp_id] - Delivery partner id of the shipment
2070
2129
  * @property {string} [fulfillment_type] - Fulfilment type of shipment
2071
2130
  * @property {ShipmentArticle[]} [articles] - List of articles in shipment
2131
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
2072
2132
  */
2073
2133
 
2074
2134
  /**
@@ -2129,6 +2189,7 @@ const Joi = require("joi");
2129
2189
  * @property {string} [gstin] - GSTIN number to be added in user cart
2130
2190
  * @property {Object} [pick_up_customer_details] - Customer contact details for
2131
2191
  * customer pickup at store
2192
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
2132
2193
  * @property {string} [checkout_mode] - Checkout mode of user cart
2133
2194
  * @property {Object} [gift_details] - Gift details is open json which can
2134
2195
  * include gift message
@@ -3648,6 +3709,48 @@ class CartPlatformModel {
3648
3709
  });
3649
3710
  }
3650
3711
 
3712
+ /** @returns {FulfillmentOptionSchema} */
3713
+ static FulfillmentOptionSchema() {
3714
+ return Joi.object({
3715
+ slug: Joi.string().allow(""),
3716
+ description: Joi.string().allow(""),
3717
+ is_default: Joi.boolean(),
3718
+ id: Joi.string().allow(""),
3719
+ type: Joi.string().allow(""),
3720
+ name: Joi.string().allow(""),
3721
+ });
3722
+ }
3723
+
3724
+ /** @returns {StoreTimingSchema} */
3725
+ static StoreTimingSchema() {
3726
+ return Joi.object({
3727
+ hour: Joi.number(),
3728
+ minute: Joi.number(),
3729
+ });
3730
+ }
3731
+
3732
+ /** @returns {StoreHoursSchema} */
3733
+ static StoreHoursSchema() {
3734
+ return Joi.object({
3735
+ weekday: Joi.string().allow(""),
3736
+ opening: CartPlatformModel.StoreTimingSchema(),
3737
+ closing: CartPlatformModel.StoreTimingSchema(),
3738
+ open: Joi.boolean(),
3739
+ });
3740
+ }
3741
+
3742
+ /** @returns {PickupStoreDetailSchema} */
3743
+ static PickupStoreDetailSchema() {
3744
+ return Joi.object({
3745
+ store_id: Joi.number(),
3746
+ name: Joi.string().allow(""),
3747
+ pincode: Joi.string().allow(""),
3748
+ distance: Joi.number(),
3749
+ address: Joi.string().allow(""),
3750
+ store_hours: Joi.any(),
3751
+ });
3752
+ }
3753
+
3651
3754
  /** @returns {ProductArticle} */
3652
3755
  static ProductArticle() {
3653
3756
  return Joi.object({
@@ -3670,6 +3773,8 @@ class CartPlatformModel {
3670
3773
  meta: Joi.object().pattern(/\S/, Joi.any()),
3671
3774
  size: Joi.string().allow(""),
3672
3775
  store: CartPlatformModel.StoreInfo(),
3776
+ fulfillment_option: CartPlatformModel.FulfillmentOptionSchema(),
3777
+ pickup_store_detail: CartPlatformModel.PickupStoreDetailSchema(),
3673
3778
  item_index: Joi.number(),
3674
3779
  tags: Joi.array().items(Joi.string().allow("")),
3675
3780
  });
@@ -4151,6 +4256,17 @@ class CartPlatformModel {
4151
4256
  });
4152
4257
  }
4153
4258
 
4259
+ /** @returns {PlatformAlternatePickupPerson} */
4260
+ static PlatformAlternatePickupPerson() {
4261
+ return Joi.object({
4262
+ enabled: Joi.boolean(),
4263
+ name: Joi.string().allow(""),
4264
+ email: Joi.string().allow(""),
4265
+ phone: Joi.string().allow(""),
4266
+ country_phone_code: Joi.string().allow(""),
4267
+ });
4268
+ }
4269
+
4154
4270
  /** @returns {CartDetailResult} */
4155
4271
  static CartDetailResult() {
4156
4272
  return Joi.object({
@@ -4183,6 +4299,7 @@ class CartPlatformModel {
4183
4299
  ),
4184
4300
  pan_no: Joi.string().allow(""),
4185
4301
  custom_cart_meta: Joi.object().pattern(/\S/, Joi.any()),
4302
+ alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
4186
4303
  free_gift_selection_available: Joi.boolean(),
4187
4304
  });
4188
4305
  }
@@ -4208,6 +4325,8 @@ class CartPlatformModel {
4208
4325
  meta: Joi.object().pattern(/\S/, Joi.any()),
4209
4326
  pos: Joi.boolean(),
4210
4327
  seller_identifier: Joi.string().allow(""),
4328
+ fulfillment_option_slug: Joi.string().allow(""),
4329
+ pickup_store_id: Joi.number(),
4211
4330
  });
4212
4331
  }
4213
4332
 
@@ -4256,6 +4375,8 @@ class CartPlatformModel {
4256
4375
  item_index: Joi.number(),
4257
4376
  identifiers: CartPlatformModel.CartProductIdentifer().required(),
4258
4377
  article_id: Joi.string().allow(""),
4378
+ fulfillment_option_slug: Joi.string().allow(""),
4379
+ pickup_store_id: Joi.number(),
4259
4380
  });
4260
4381
  }
4261
4382
 
@@ -4702,6 +4823,7 @@ class CartPlatformModel {
4702
4823
  dp_id: Joi.string().allow("").allow(null),
4703
4824
  fulfillment_type: Joi.string().allow(""),
4704
4825
  articles: Joi.array().items(CartPlatformModel.ShipmentArticle()),
4826
+ fulfillment_option: CartPlatformModel.FulfillmentOptionSchema(),
4705
4827
  });
4706
4828
  }
4707
4829
 
@@ -4761,6 +4883,7 @@ class CartPlatformModel {
4761
4883
  return Joi.object({
4762
4884
  gstin: Joi.string().allow(""),
4763
4885
  pick_up_customer_details: Joi.object().pattern(/\S/, Joi.any()),
4886
+ alternate_pickup_person: CartPlatformModel.PlatformAlternatePickupPerson(),
4764
4887
  checkout_mode: Joi.string().allow(""),
4765
4888
  gift_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
4766
4889
  pan_no: Joi.string().allow(""),
@@ -411,7 +411,7 @@ declare class Catalog {
411
411
  * @summary: List bulk inventory upload history
412
412
  * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBulkUploadHistory/).
413
413
  */
414
- getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
414
+ getInventoryBulkUploadHistory({ pageNo, pageSize, search, startDate, endDate, stage, tags, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
415
415
  /**
416
416
  * @param {Object} arg - Arg object.
417
417
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
@@ -421,16 +421,18 @@ declare class Catalog {
421
421
  * @param {string} [arg.endDate] - Filter results by the job's end date.
422
422
  * @param {string} [arg.stage] - Filter results by the current stage of the
423
423
  * import job.
424
+ * @param {string} [arg.tags] - Filter results by the tags of the import job.
424
425
  * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
425
426
  * @summary: List bulk inventory upload history
426
427
  * @description: Helps to get bulk Inventory upload jobs status.
427
428
  */
428
- getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, }?: {
429
+ getInventoryBulkUploadHistoryPaginator({ pageSize, search, startDate, endDate, stage, tags, }?: {
429
430
  pageSize?: number;
430
431
  search?: string;
431
432
  startDate?: string;
432
433
  endDate?: string;
433
434
  stage?: string;
435
+ tags?: string;
434
436
  }): Paginator<CatalogPlatformModel.BulkInventoryGet>;
435
437
  /**
436
438
  * @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
@@ -2853,9 +2853,16 @@ class Catalog {
2853
2853
  * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getInventoryBulkUploadHistory/).
2854
2854
  */
2855
2855
  async getInventoryBulkUploadHistory(
2856
- { pageNo, pageSize, search, startDate, endDate, stage, requestHeaders } = {
2857
- requestHeaders: {},
2858
- },
2856
+ {
2857
+ pageNo,
2858
+ pageSize,
2859
+ search,
2860
+ startDate,
2861
+ endDate,
2862
+ stage,
2863
+ tags,
2864
+ requestHeaders,
2865
+ } = { requestHeaders: {} },
2859
2866
  { responseHeaders } = { responseHeaders: false }
2860
2867
  ) {
2861
2868
  const {
@@ -2868,6 +2875,7 @@ class Catalog {
2868
2875
  startDate,
2869
2876
  endDate,
2870
2877
  stage,
2878
+ tags,
2871
2879
  },
2872
2880
  { abortEarly: false, allowUnknown: true }
2873
2881
  );
@@ -2886,6 +2894,7 @@ class Catalog {
2886
2894
  startDate,
2887
2895
  endDate,
2888
2896
  stage,
2897
+ tags,
2889
2898
  },
2890
2899
  { abortEarly: false, allowUnknown: false }
2891
2900
  );
@@ -2903,6 +2912,7 @@ class Catalog {
2903
2912
  query_params["start_date"] = startDate;
2904
2913
  query_params["end_date"] = endDate;
2905
2914
  query_params["stage"] = stage;
2915
+ query_params["tags"] = tags;
2906
2916
 
2907
2917
  const xHeaders = {};
2908
2918
 
@@ -2951,6 +2961,7 @@ class Catalog {
2951
2961
  * @param {string} [arg.endDate] - Filter results by the job's end date.
2952
2962
  * @param {string} [arg.stage] - Filter results by the current stage of the
2953
2963
  * import job.
2964
+ * @param {string} [arg.tags] - Filter results by the tags of the import job.
2954
2965
  * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
2955
2966
  * @summary: List bulk inventory upload history
2956
2967
  * @description: Helps to get bulk Inventory upload jobs status.
@@ -2961,6 +2972,7 @@ class Catalog {
2961
2972
  startDate,
2962
2973
  endDate,
2963
2974
  stage,
2975
+ tags,
2964
2976
  } = {}) {
2965
2977
  const paginator = new Paginator();
2966
2978
  const callback = async () => {
@@ -2974,6 +2986,7 @@ class Catalog {
2974
2986
  startDate: startDate,
2975
2987
  endDate: endDate,
2976
2988
  stage: stage,
2989
+ tags: tags,
2977
2990
  });
2978
2991
  paginator.setPaginator({
2979
2992
  hasNext: data.page.has_next ? true : false,
@@ -589,6 +589,7 @@ export = CatalogPlatformModel;
589
589
  * @property {string} [stage]
590
590
  * @property {number} [succeed]
591
591
  * @property {number} [total]
592
+ * @property {string[]} [tags]
592
593
  * @property {BulkMeta} [meta]
593
594
  */
594
595
  /**
@@ -631,6 +632,7 @@ export = CatalogPlatformModel;
631
632
  * @property {string} [template_tag]
632
633
  * @property {number} [total]
633
634
  * @property {string} [tracking_url]
635
+ * @property {string[]} [tags]
634
636
  */
635
637
  /**
636
638
  * @typedef BulkProductRequestSchema
@@ -2200,7 +2202,11 @@ export = CatalogPlatformModel;
2200
2202
  * @property {string} seller_identifier - The identifier of the seller.
2201
2203
  * @property {number} store_id - The ID of the store.
2202
2204
  * @property {string[]} [tags] - The tags associated with the inventory item.
2205
+ * @property {string} [mode] - Indicates whether delta or replace operation for inventory
2203
2206
  * @property {number} [total_quantity] - The total quantity of the inventory item.
2207
+ * @property {number} [damaged_quantity] - The damaged quantity of the inventory item.
2208
+ * @property {number} [not_available_quantity] - The not available quantity of
2209
+ * the inventory item.
2204
2210
  * @property {string} [trace_id] - The trace ID of the inventory payload.
2205
2211
  */
2206
2212
  /**
@@ -2623,7 +2629,9 @@ export = CatalogPlatformModel;
2623
2629
  /**
2624
2630
  * @typedef LocationQuantityRequestSchema
2625
2631
  * @property {string} [expiration_date] - The expiration date of the inventory item.
2626
- * @property {number} total_quantity - The total quantity of the inventory item.
2632
+ * @property {number} [total_quantity] - The total quantity of the inventory item.
2633
+ * @property {number} [damaged_quantity] - The total quantity of the inventory item.
2634
+ * @property {number} [not_available_quantity] - The total quantity of the inventory item.
2627
2635
  */
2628
2636
  /**
2629
2637
  * @typedef LocationPriceQuantitySuccessResponseSchema
@@ -5645,6 +5653,7 @@ type BulkInventoryGetItems = {
5645
5653
  stage?: string;
5646
5654
  succeed?: number;
5647
5655
  total?: number;
5656
+ tags?: string[];
5648
5657
  meta?: BulkMeta;
5649
5658
  };
5650
5659
  /** @returns {BulkMeta} */
@@ -5729,6 +5738,7 @@ type BulkJob = {
5729
5738
  template_tag?: string;
5730
5739
  total?: number;
5731
5740
  tracking_url?: string;
5741
+ tags?: string[];
5732
5742
  };
5733
5743
  /** @returns {BulkProductRequestSchema} */
5734
5744
  declare function BulkProductRequestSchema(): BulkProductRequestSchema;
@@ -9073,10 +9083,23 @@ type InventoryPayload = {
9073
9083
  * - The tags associated with the inventory item.
9074
9084
  */
9075
9085
  tags?: string[];
9086
+ /**
9087
+ * - Indicates whether delta or replace operation for inventory
9088
+ */
9089
+ mode?: string;
9076
9090
  /**
9077
9091
  * - The total quantity of the inventory item.
9078
9092
  */
9079
9093
  total_quantity?: number;
9094
+ /**
9095
+ * - The damaged quantity of the inventory item.
9096
+ */
9097
+ damaged_quantity?: number;
9098
+ /**
9099
+ * - The not available quantity of
9100
+ * the inventory item.
9101
+ */
9102
+ not_available_quantity?: number;
9080
9103
  /**
9081
9104
  * - The trace ID of the inventory payload.
9082
9105
  */
@@ -10012,7 +10035,15 @@ type LocationQuantityRequestSchema = {
10012
10035
  /**
10013
10036
  * - The total quantity of the inventory item.
10014
10037
  */
10015
- total_quantity: number;
10038
+ total_quantity?: number;
10039
+ /**
10040
+ * - The total quantity of the inventory item.
10041
+ */
10042
+ damaged_quantity?: number;
10043
+ /**
10044
+ * - The total quantity of the inventory item.
10045
+ */
10046
+ not_available_quantity?: number;
10016
10047
  };
10017
10048
  /** @returns {LocationPriceQuantitySuccessResponseSchema} */
10018
10049
  declare function LocationPriceQuantitySuccessResponseSchema(): LocationPriceQuantitySuccessResponseSchema;
@@ -648,6 +648,7 @@ const Joi = require("joi");
648
648
  * @property {string} [stage]
649
649
  * @property {number} [succeed]
650
650
  * @property {number} [total]
651
+ * @property {string[]} [tags]
651
652
  * @property {BulkMeta} [meta]
652
653
  */
653
654
 
@@ -693,6 +694,7 @@ const Joi = require("joi");
693
694
  * @property {string} [template_tag]
694
695
  * @property {number} [total]
695
696
  * @property {string} [tracking_url]
697
+ * @property {string[]} [tags]
696
698
  */
697
699
 
698
700
  /**
@@ -2417,7 +2419,11 @@ const Joi = require("joi");
2417
2419
  * @property {string} seller_identifier - The identifier of the seller.
2418
2420
  * @property {number} store_id - The ID of the store.
2419
2421
  * @property {string[]} [tags] - The tags associated with the inventory item.
2422
+ * @property {string} [mode] - Indicates whether delta or replace operation for inventory
2420
2423
  * @property {number} [total_quantity] - The total quantity of the inventory item.
2424
+ * @property {number} [damaged_quantity] - The damaged quantity of the inventory item.
2425
+ * @property {number} [not_available_quantity] - The not available quantity of
2426
+ * the inventory item.
2421
2427
  * @property {string} [trace_id] - The trace ID of the inventory payload.
2422
2428
  */
2423
2429
 
@@ -2885,7 +2891,9 @@ const Joi = require("joi");
2885
2891
  /**
2886
2892
  * @typedef LocationQuantityRequestSchema
2887
2893
  * @property {string} [expiration_date] - The expiration date of the inventory item.
2888
- * @property {number} total_quantity - The total quantity of the inventory item.
2894
+ * @property {number} [total_quantity] - The total quantity of the inventory item.
2895
+ * @property {number} [damaged_quantity] - The total quantity of the inventory item.
2896
+ * @property {number} [not_available_quantity] - The total quantity of the inventory item.
2889
2897
  */
2890
2898
 
2891
2899
  /**
@@ -5507,6 +5515,7 @@ class CatalogPlatformModel {
5507
5515
  stage: Joi.string().allow(""),
5508
5516
  succeed: Joi.number(),
5509
5517
  total: Joi.number(),
5518
+ tags: Joi.array().items(Joi.string().allow("")),
5510
5519
  meta: CatalogPlatformModel.BulkMeta(),
5511
5520
  });
5512
5521
  }
@@ -5553,6 +5562,7 @@ class CatalogPlatformModel {
5553
5562
  template_tag: Joi.string().allow(""),
5554
5563
  total: Joi.number(),
5555
5564
  tracking_url: Joi.string().allow(""),
5565
+ tags: Joi.array().items(Joi.string().allow("")),
5556
5566
  });
5557
5567
  }
5558
5568
 
@@ -7414,7 +7424,10 @@ class CatalogPlatformModel {
7414
7424
  seller_identifier: Joi.string().allow("").required(),
7415
7425
  store_id: Joi.number().required(),
7416
7426
  tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
7427
+ mode: Joi.string().allow(""),
7417
7428
  total_quantity: Joi.number().allow(null),
7429
+ damaged_quantity: Joi.number().allow(null),
7430
+ not_available_quantity: Joi.number().allow(null),
7418
7431
  trace_id: Joi.string().allow(""),
7419
7432
  });
7420
7433
  }
@@ -7934,7 +7947,9 @@ class CatalogPlatformModel {
7934
7947
  static LocationQuantityRequestSchema() {
7935
7948
  return Joi.object({
7936
7949
  expiration_date: Joi.string().allow(""),
7937
- total_quantity: Joi.number().required(),
7950
+ total_quantity: Joi.number(),
7951
+ damaged_quantity: Joi.number(),
7952
+ not_available_quantity: Joi.number(),
7938
7953
  });
7939
7954
  }
7940
7955
 
@@ -188,6 +188,7 @@ export = CatalogPlatformValidator;
188
188
  * @property {string} [startDate] - Filter results by the job's start date.
189
189
  * @property {string} [endDate] - Filter results by the job's end date.
190
190
  * @property {string} [stage] - Filter results by the current stage of the import job.
191
+ * @property {string} [tags] - Filter results by the tags of the import job.
191
192
  */
192
193
  /**
193
194
  * @typedef GetInventoryBySizeParam
@@ -975,6 +976,10 @@ type GetInventoryBulkUploadHistoryParam = {
975
976
  * - Filter results by the current stage of the import job.
976
977
  */
977
978
  stage?: string;
979
+ /**
980
+ * - Filter results by the tags of the import job.
981
+ */
982
+ tags?: string;
978
983
  };
979
984
  type GetInventoryBySizeParam = {
980
985
  /**
@@ -224,6 +224,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
224
224
  * @property {string} [startDate] - Filter results by the job's start date.
225
225
  * @property {string} [endDate] - Filter results by the job's end date.
226
226
  * @property {string} [stage] - Filter results by the current stage of the import job.
227
+ * @property {string} [tags] - Filter results by the tags of the import job.
227
228
  */
228
229
 
229
230
  /**
@@ -845,6 +846,7 @@ class CatalogPlatformValidator {
845
846
  startDate: Joi.string().allow(""),
846
847
  endDate: Joi.string().allow(""),
847
848
  stage: Joi.string().allow(""),
849
+ tags: Joi.string().allow(""),
848
850
  }).required();
849
851
  }
850
852
 
@@ -895,6 +895,11 @@ export = ConfigurationPlatformModel;
895
895
  * @typedef DeliveryStrategy
896
896
  * @property {string} [value] - Indicates the delivery strategy value.
897
897
  */
898
+ /**
899
+ * @typedef FulfillmentOption
900
+ * @property {number} [count] - Total count of available fulfillment options
901
+ * configured for a specific application.
902
+ */
898
903
  /**
899
904
  * @typedef AppFeature
900
905
  * @property {ProductDetailFeature} [product_detail]
@@ -908,6 +913,7 @@ export = ConfigurationPlatformModel;
908
913
  * @property {OrderFeature} [order]
909
914
  * @property {BuyboxFeature} [buybox]
910
915
  * @property {DeliveryStrategy} [delivery_strategy]
916
+ * @property {FulfillmentOption} [fulfillment_option]
911
917
  * @property {string} [_id] - The unique identifier for the sales channel features
912
918
  * @property {string} [app] - Application ID of the sales channel
913
919
  * @property {string} [created_at] - ISO 8601 timestamp showing the date when
@@ -1403,7 +1409,7 @@ export = ConfigurationPlatformModel;
1403
1409
  declare class ConfigurationPlatformModel {
1404
1410
  }
1405
1411
  declare namespace ConfigurationPlatformModel {
1406
- export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
1412
+ export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
1407
1413
  }
1408
1414
  /** @returns {CurrencyExchangeResponseV2} */
1409
1415
  declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
@@ -3210,6 +3216,15 @@ type DeliveryStrategy = {
3210
3216
  */
3211
3217
  value?: string;
3212
3218
  };
3219
+ /** @returns {FulfillmentOption} */
3220
+ declare function FulfillmentOption(): FulfillmentOption;
3221
+ type FulfillmentOption = {
3222
+ /**
3223
+ * - Total count of available fulfillment options
3224
+ * configured for a specific application.
3225
+ */
3226
+ count?: number;
3227
+ };
3213
3228
  /** @returns {AppFeature} */
3214
3229
  declare function AppFeature(): AppFeature;
3215
3230
  type AppFeature = {
@@ -3224,6 +3239,7 @@ type AppFeature = {
3224
3239
  order?: OrderFeature;
3225
3240
  buybox?: BuyboxFeature;
3226
3241
  delivery_strategy?: DeliveryStrategy;
3242
+ fulfillment_option?: FulfillmentOption;
3227
3243
  /**
3228
3244
  * - The unique identifier for the sales channel features
3229
3245
  */
@@ -1016,6 +1016,12 @@ const Joi = require("joi");
1016
1016
  * @property {string} [value] - Indicates the delivery strategy value.
1017
1017
  */
1018
1018
 
1019
+ /**
1020
+ * @typedef FulfillmentOption
1021
+ * @property {number} [count] - Total count of available fulfillment options
1022
+ * configured for a specific application.
1023
+ */
1024
+
1019
1025
  /**
1020
1026
  * @typedef AppFeature
1021
1027
  * @property {ProductDetailFeature} [product_detail]
@@ -1029,6 +1035,7 @@ const Joi = require("joi");
1029
1035
  * @property {OrderFeature} [order]
1030
1036
  * @property {BuyboxFeature} [buybox]
1031
1037
  * @property {DeliveryStrategy} [delivery_strategy]
1038
+ * @property {FulfillmentOption} [fulfillment_option]
1032
1039
  * @property {string} [_id] - The unique identifier for the sales channel features
1033
1040
  * @property {string} [app] - Application ID of the sales channel
1034
1041
  * @property {string} [created_at] - ISO 8601 timestamp showing the date when
@@ -2714,6 +2721,13 @@ class ConfigurationPlatformModel {
2714
2721
  });
2715
2722
  }
2716
2723
 
2724
+ /** @returns {FulfillmentOption} */
2725
+ static FulfillmentOption() {
2726
+ return Joi.object({
2727
+ count: Joi.number(),
2728
+ });
2729
+ }
2730
+
2717
2731
  /** @returns {AppFeature} */
2718
2732
  static AppFeature() {
2719
2733
  return Joi.object({
@@ -2728,6 +2742,7 @@ class ConfigurationPlatformModel {
2728
2742
  order: ConfigurationPlatformModel.OrderFeature(),
2729
2743
  buybox: ConfigurationPlatformModel.BuyboxFeature(),
2730
2744
  delivery_strategy: ConfigurationPlatformModel.DeliveryStrategy(),
2745
+ fulfillment_option: ConfigurationPlatformModel.FulfillmentOption(),
2731
2746
  _id: Joi.string().allow(""),
2732
2747
  app: Joi.string().allow(""),
2733
2748
  created_at: Joi.string().allow(""),