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

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 (198) hide show
  1. package/README.md +26 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +8 -0
  4. package/sdk/application/ApplicationClient.js +14 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
  6. package/sdk/application/Cart/CartApplicationClient.js +20 -20
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
  8. package/sdk/application/Cart/CartApplicationModel.js +783 -552
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
  10. package/sdk/application/Cart/CartApplicationValidator.js +100 -114
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
  15. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
  16. package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  18. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
  20. package/sdk/application/Common/CommonApplicationModel.js +59 -58
  21. package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
  22. package/sdk/application/Common/CommonApplicationValidator.js +3 -3
  23. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
  25. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
  26. package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
  27. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
  28. package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
  29. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
  30. package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
  31. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
  33. package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
  34. package/sdk/application/Content/ContentApplicationClient.js +16 -16
  35. package/sdk/application/Content/ContentApplicationModel.d.ts +1206 -281
  36. package/sdk/application/Content/ContentApplicationModel.js +342 -276
  37. package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
  38. package/sdk/application/Content/ContentApplicationValidator.js +11 -10
  39. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  40. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  41. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
  42. package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
  46. package/sdk/application/Lead/LeadApplicationModel.js +110 -67
  47. package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
  48. package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
  49. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
  50. package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
  51. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
  52. package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
  53. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
  54. package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
  55. package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
  56. package/sdk/application/Order/OrderApplicationClient.js +10 -10
  57. package/sdk/application/Order/OrderApplicationModel.d.ts +1401 -324
  58. package/sdk/application/Order/OrderApplicationModel.js +392 -316
  59. package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
  60. package/sdk/application/Order/OrderApplicationValidator.js +15 -14
  61. package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
  62. package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
  63. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
  64. package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
  65. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
  66. package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
  69. package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
  70. package/sdk/application/Share/ShareApplicationModel.js +53 -37
  71. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
  72. package/sdk/application/Share/ShareApplicationValidator.js +2 -1
  73. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
  75. package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
  76. package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
  77. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
  78. package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
  79. package/sdk/application/User/UserApplicationClient.d.ts +36 -36
  80. package/sdk/application/User/UserApplicationClient.js +36 -36
  81. package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
  82. package/sdk/application/User/UserApplicationModel.js +298 -244
  83. package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
  84. package/sdk/application/User/UserApplicationValidator.js +40 -40
  85. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  86. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  87. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
  88. package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
  89. package/sdk/common/Clickstream.js +95 -15
  90. package/sdk/common/Constant.d.ts +9 -0
  91. package/sdk/common/Constant.js +11 -0
  92. package/sdk/common/Utility.js +19 -0
  93. package/sdk/common/utils.js +8 -1
  94. package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
  95. package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
  96. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +75 -8
  97. package/sdk/partner/Logistics/LogisticsPartnerModel.js +59 -7
  98. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
  99. package/sdk/partner/PartnerClient.d.ts +8 -0
  100. package/sdk/partner/PartnerClient.js +14 -0
  101. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
  102. package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
  103. package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
  104. package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
  105. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  106. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  107. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
  108. package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
  109. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
  110. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
  111. package/sdk/platform/Billing/BillingPlatformClient.d.ts +21 -10
  112. package/sdk/platform/Billing/BillingPlatformClient.js +167 -83
  113. package/sdk/platform/Billing/BillingPlatformModel.d.ts +2849 -565
  114. package/sdk/platform/Billing/BillingPlatformModel.js +935 -556
  115. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +30 -14
  116. package/sdk/platform/Billing/BillingPlatformValidator.js +31 -16
  117. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
  118. package/sdk/platform/Cart/CartPlatformModel.js +8 -8
  119. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  120. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
  121. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
  122. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
  123. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
  124. package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
  125. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
  126. package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
  127. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
  128. package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
  131. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
  132. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
  134. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
  136. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
  137. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
  138. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
  139. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  140. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
  141. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
  142. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
  143. package/sdk/platform/Content/ContentPlatformModel.d.ts +60 -17
  144. package/sdk/platform/Content/ContentPlatformModel.js +30 -15
  145. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
  146. package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
  147. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
  148. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
  149. package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
  150. package/sdk/platform/Finance/FinancePlatformClient.js +30 -30
  151. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1601 -348
  152. package/sdk/platform/Finance/FinancePlatformModel.js +488 -352
  153. package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
  154. package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
  155. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
  156. package/sdk/platform/Order/OrderPlatformClient.js +165 -0
  157. package/sdk/platform/Order/OrderPlatformModel.d.ts +631 -39
  158. package/sdk/platform/Order/OrderPlatformModel.js +367 -41
  159. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
  160. package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
  161. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
  162. package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
  163. package/sdk/platform/PlatformClient.d.ts +8 -0
  164. package/sdk/platform/PlatformClient.js +14 -0
  165. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
  166. package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
  167. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
  168. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
  169. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
  170. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
  171. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +139 -22
  172. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +98 -21
  173. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
  174. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
  175. package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
  176. package/sdk/platform/Share/SharePlatformModel.js +7 -7
  177. package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
  178. package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
  179. package/sdk/platform/User/UserPlatformModel.d.ts +18 -20
  180. package/sdk/platform/User/UserPlatformModel.js +9 -11
  181. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +54 -33
  182. package/sdk/platform/Webhook/WebhookPlatformModel.js +33 -33
  183. package/sdk/public/Billing/BillingPublicClient.d.ts +11 -0
  184. package/sdk/public/Billing/BillingPublicClient.js +80 -0
  185. package/sdk/public/Billing/BillingPublicModel.d.ts +584 -99
  186. package/sdk/public/Billing/BillingPublicModel.js +252 -87
  187. package/sdk/public/Billing/BillingPublicValidator.d.ts +10 -1
  188. package/sdk/public/Billing/BillingPublicValidator.js +12 -0
  189. package/sdk/public/PublicClient.d.ts +0 -2
  190. package/sdk/public/PublicClient.js +0 -4
  191. package/sdk/public/index.d.ts +0 -1
  192. package/sdk/public/index.js +0 -2
  193. package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
  194. package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
  195. package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
  196. package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
  197. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
  198. package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
@@ -1,46 +1,51 @@
1
1
  export = CatalogApplicationModel;
2
2
  /**
3
3
  * @typedef ProductDetailCustomOrder
4
- * @property {number} [manufacturing_time]
5
- * @property {string} [manufacturing_time_unit]
6
- * @property {boolean} [is_custom_order]
4
+ * @property {number} [manufacturing_time] - The unit of time taken for manufacturing.
5
+ * @property {string} [manufacturing_time_unit] - The unit of time required for
6
+ * manufacturing is defined in hours or days.
7
+ * @property {boolean} [is_custom_order] - A boolean flag indicating whether MTO
8
+ * (Make to Order) is enabled or not.
7
9
  */
8
10
  /**
9
11
  * @typedef Meta
10
- * @property {string} [source]
12
+ * @property {string} [source] - The source or origin of the media file, which
13
+ * could be a URL or a reference to where the media was obtained.
11
14
  */
12
15
  /**
13
16
  * @typedef Media
14
- * @property {string} [url]
15
- * @property {string} [type]
17
+ * @property {string} [url] - Absolute url for Media.
18
+ * @property {string} [type] - The type of media, such as image, video.
16
19
  * @property {Meta} [meta]
17
- * @property {string} [alt]
20
+ * @property {string} [alt] - Alternative text for the media, used for
21
+ * accessibility and SEO purposes.
18
22
  */
19
23
  /**
20
24
  * @typedef ProductListingActionPage
21
- * @property {string} [type]
22
- * @property {Object} [query]
23
- * @property {Object} [params]
25
+ * @property {string} [type] - The type of action such as product, products,
26
+ * category, brand.
27
+ * @property {Object} [query] - Query parameter if any to be added to the action.
28
+ * @property {Object} [params] - Parameters that should be considered in path.
24
29
  */
25
30
  /**
26
31
  * @typedef ProductListingAction
27
- * @property {string} [type]
32
+ * @property {string} [type] - Type of action to be taken e.g, page.
28
33
  * @property {ProductListingActionPage} [page]
29
34
  */
30
35
  /**
31
36
  * @typedef ProductBrand
32
- * @property {number} [uid]
37
+ * @property {number} [uid] - Unique identifier for the product brand.
33
38
  * @property {Media} [logo]
34
- * @property {string} [description]
35
- * @property {string} [name]
39
+ * @property {string} [description] - Description of the product brand.
40
+ * @property {string} [name] - Name of the product brand.
36
41
  * @property {ProductListingAction} [action]
37
42
  */
38
43
  /**
39
44
  * @typedef ProductDepartment
40
- * @property {number} [uid]
45
+ * @property {number} [uid] - Unique identifier for the product department.
41
46
  * @property {Media} [logo]
42
- * @property {string} [slug]
43
- * @property {string} [name]
47
+ * @property {string} [slug] - URL-friendly identifier for the product department.
48
+ * @property {string} [name] - Name of the product department.
44
49
  */
45
50
  /**
46
51
  * @typedef ProductCategoryMap
@@ -61,19 +66,20 @@ export = CatalogApplicationModel;
61
66
  */
62
67
  /**
63
68
  * @typedef ApplicationItemSEO
64
- * @property {Object} [title] - The SEO title of the item
65
- * @property {Object} [description] - The SEO description of the item
69
+ * @property {Object} [title] - The SEO title of the item.
70
+ * @property {Object} [description] - The SEO description of the item.
66
71
  */
67
72
  /**
68
73
  * @typedef ProductDetailAttribute
69
- * @property {string} [value]
70
- * @property {string} [type]
71
- * @property {string} [key]
74
+ * @property {string} [value] - The value of the product attribute.
75
+ * @property {string} [type] - The type or category of the product attribute.
76
+ * @property {string} [key] - The key or name of the product attribute.
72
77
  */
73
78
  /**
74
79
  * @typedef ProductDetailGroupedAttribute
75
- * @property {string} [title]
76
- * @property {ProductDetailAttribute[]} [details]
80
+ * @property {string} [title] - The title or name of the attribute group.
81
+ * @property {ProductDetailAttribute[]} [details] - A list of product attributes
82
+ * within this group.
77
83
  */
78
84
  /**
79
85
  * @typedef ApplicationItemMOQ
@@ -104,61 +110,74 @@ export = CatalogApplicationModel;
104
110
  */
105
111
  /**
106
112
  * @typedef ProductDetail
107
- * @property {number} [uid]
113
+ * @property {number} [uid] - Unique identifier for the product.
108
114
  * @property {ProductDetailCustomOrder} [custom_order]
109
115
  * @property {ProductCategoryMap} [category_map]
110
116
  * @property {NetQuantity} [net_quantity]
111
- * @property {number} [rating_count]
112
- * @property {CustomMetaFields[]} [_custom_meta]
113
- * @property {string[]} [similars]
114
- * @property {string[]} [tags]
117
+ * @property {number} [rating_count] - Count of ratings the product has received.
118
+ * @property {CustomMetaFields[]} [_custom_meta] - Custom metadata fields
119
+ * associated with the product.
120
+ * @property {string[]} [similars] - List of products marked similar to given product.
121
+ * @property {string[]} [tags] - Tags associated with the product for better
122
+ * categorization.
115
123
  * @property {ApplicationItemSEO} [seo]
116
- * @property {string} [image_nature]
117
- * @property {boolean} [has_variant]
118
- * @property {string} [item_type]
119
- * @property {string} [description]
120
- * @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
121
- * @property {Media[]} [medias]
122
- * @property {string} [color]
123
- * @property {string} [type]
124
- * @property {string} [product_online_date]
125
- * @property {Object} [_custom_json]
126
- * @property {string} [item_code]
127
- * @property {string} [name]
124
+ * @property {string} [image_nature] - Type of the images associated with the
125
+ * product such as standard.
126
+ * @property {boolean} [has_variant] - Indicates whether the product has variants.
127
+ * @property {string} [item_type] - This field describes the type of item,
128
+ * indicating the category or nature of the product. Possible values are
129
+ * Standard, Composite, Wet, Digital.
130
+ * @property {string} [description] - Detailed description of the product.
131
+ * @property {ProductDetailGroupedAttribute[]} [grouped_attributes] - Grouped
132
+ * attributes detailing various characteristics of the product.
133
+ * @property {Media[]} [medias] - Media files associated with the product.
134
+ * @property {string} [color] - Color of the product, if applicable.
135
+ * @property {string} [type] - Product type or classification.
136
+ * @property {string} [product_online_date] - Date and time when the product was
137
+ * made available online.
138
+ * @property {Object} [_custom_json] - Custom JSON object for additional product data.
139
+ * @property {string} [item_code] - Item Code defined for the product.
140
+ * @property {string} [name] - Name of the product.
128
141
  * @property {ApplicationItemMOQ} [moq]
129
- * @property {string} [short_description]
130
- * @property {ProductBrand[]} [categories]
131
- * @property {Object} [attributes]
132
- * @property {string} [discount]
133
- * @property {string[]} [tryouts]
134
- * @property {string} slug
142
+ * @property {string} [short_description] - Brief description of the product.
143
+ * @property {ProductBrand[]} [categories] - List of product categories
144
+ * associated with the product.
145
+ * @property {Object} [attributes] - Additional attributes or characteristics of
146
+ * the product.
147
+ * @property {string} [discount] - Discount applied to the product, if any.
148
+ * @property {string[]} [tryouts] - Identifiers or names of tryout versions of
149
+ * the product.
150
+ * @property {string} slug - URL-friendly identifier for the product.
135
151
  * @property {ProductListingAction} [action]
136
- * @property {number} [rating]
137
- * @property {boolean} [is_dependent]
138
- * @property {string[]} [product_group_tag]
139
- * @property {string[]} [highlights]
152
+ * @property {number} [rating] - The rating of the product.
153
+ * @property {boolean} [is_dependent] - Indicates whether the product can be
154
+ * sold as an individual product.
155
+ * @property {string[]} [product_group_tag] - List of bundle/product grouping
156
+ * slugs mapped to the product.
157
+ * @property {string[]} [highlights] - Key highlights or features of the product.
140
158
  * @property {ProductListingPrice} [price]
141
159
  * @property {ProductBrand} [brand]
142
160
  * @property {ProductDepartment} [department]
143
- * @property {string} [teaser_tag]
161
+ * @property {string} [teaser_tag] - Teaser tag or short promotional phrase for
162
+ * the product.
144
163
  */
145
164
  /**
146
165
  * @typedef ErrorResponse
147
- * @property {string} [error]
166
+ * @property {string} [error] - A brief description of the error.
148
167
  */
149
168
  /**
150
169
  * @typedef Dimension
151
- * @property {string} unit - The unit of dimension
152
- * @property {number} height - The height of the product
153
- * @property {number} length - The length of the product
154
- * @property {number} width - The width of the product
155
- * @property {boolean} is_default - Whether the dimension is the default one or not
170
+ * @property {string} unit - The unit of dimension.
171
+ * @property {number} height - The height of the product.
172
+ * @property {number} length - The length of the product.
173
+ * @property {number} width - The width of the product.
174
+ * @property {boolean} is_default - Whether the dimension is the default one or not.
156
175
  */
157
176
  /**
158
177
  * @typedef Weight
159
- * @property {string} unit - The unit of weight
160
- * @property {number} shipping - The shipping weight of the product
161
- * @property {boolean} is_default - Whether the weight is the default one or not
178
+ * @property {string} unit - The unit of weight.
179
+ * @property {number} shipping - The shipping weight of the product.
180
+ * @property {boolean} is_default - Whether the weight is the default one or not.
162
181
  */
163
182
  /**
164
183
  * @typedef DiscountMeta
@@ -171,27 +190,30 @@ export = CatalogApplicationModel;
171
190
  */
172
191
  /**
173
192
  * @typedef ProductSize
174
- * @property {number} [quantity]
193
+ * @property {number} [quantity] - The quantity of the product size available.
175
194
  * @property {Dimension} [dimension]
176
195
  * @property {Weight} [weight]
177
- * @property {boolean} [is_available]
178
- * @property {string[]} [seller_identifiers]
179
- * @property {string} [value]
180
- * @property {string} [display]
196
+ * @property {boolean} [is_available] - Indicates whether the product size is
197
+ * available for purchase.
198
+ * @property {string[]} [seller_identifiers] - List of identifiers used by
199
+ * sellers for the product size.
200
+ * @property {string} [value] - The value or label representing the product size.
201
+ * @property {string} [display] - Display name of the product size.
181
202
  */
182
203
  /**
183
204
  * @typedef SizeChartValues
184
- * @property {string} [col_3]
185
- * @property {string} [col_6]
186
- * @property {string} [col_2]
187
- * @property {string} [col_4]
188
- * @property {string} [col_1]
189
- * @property {string} [col_5]
205
+ * @property {string} [col_3] - Value for column 3.
206
+ * @property {string} [col_6] - Value for column 6.
207
+ * @property {string} [col_2] - Value for column 2.
208
+ * @property {string} [col_4] - Value for column 4.
209
+ * @property {string} [col_1] - Value for column 1.
210
+ * @property {string} [col_5] - Value for column 5.
190
211
  */
191
212
  /**
192
213
  * @typedef ColumnHeader
193
- * @property {boolean} [convertable]
194
- * @property {string} [value]
214
+ * @property {boolean} [convertable] - Indicates if the column value can be
215
+ * converted or transformed.
216
+ * @property {string} [value] - The value or title of the column header.
195
217
  */
196
218
  /**
197
219
  * @typedef ColumnHeaders
@@ -204,53 +226,56 @@ export = CatalogApplicationModel;
204
226
  */
205
227
  /**
206
228
  * @typedef SizeChart
207
- * @property {string} [unit]
208
- * @property {string} [image]
209
- * @property {string} [size_tip]
210
- * @property {SizeChartValues[]} [sizes]
211
- * @property {string} [description]
212
- * @property {string} [title]
229
+ * @property {string} [unit] - Unit of measurement used in the size chart (e.g., in, cm).
230
+ * @property {string} [image] - URL of the image representing the size chart.
231
+ * @property {string} [size_tip] - Additional tip or guideline related to sizing.
232
+ * @property {SizeChartValues[]} [sizes] - Array of size chart values for different sizes.
233
+ * @property {string} [description] - Description related to the size chart.
234
+ * @property {string} [title] - Title or name of the size chart.
213
235
  * @property {ColumnHeaders} [headers]
214
236
  */
215
237
  /**
216
238
  * @typedef ProductSizeStores
217
- * @property {number} [count]
239
+ * @property {number} [count] - Number of stores where the product size is available.
218
240
  */
219
241
  /**
220
242
  * @typedef ProductSizes
221
- * @property {ProductSize[]} [sizes]
243
+ * @property {ProductSize[]} [sizes] - List of available sizes for the product.
222
244
  * @property {ProductSizesPrice} [price]
223
245
  * @property {ProductSizesPrice} [price_per_piece]
224
246
  * @property {SizeChart} [size_chart]
225
- * @property {boolean} [sellable]
226
- * @property {boolean} [multi_size]
227
- * @property {string} [discount]
247
+ * @property {boolean} [sellable] - Whether the product sizes are available for sale.
248
+ * @property {boolean} [multi_size] - Whether the product supports multiple sizes.
249
+ * @property {string} [discount] - Discount information applicable to the product sizes.
228
250
  * @property {ProductSizeStores} [stores]
229
251
  * @property {DiscountMeta} [discount_meta]
230
252
  */
231
253
  /**
232
254
  * @typedef AttributeDetail
233
- * @property {string} [logo]
234
- * @property {string} [description]
235
- * @property {string} [display]
236
- * @property {string} [key]
255
+ * @property {string} [logo] - URL or path to the logo associated with the attribute.
256
+ * @property {string} [description] - A description of the attribute.
257
+ * @property {string} [display] - Display name or label for the attribute.
258
+ * @property {string} [key] - Unique key or identifier for the attribute.
237
259
  */
238
260
  /**
239
261
  * @typedef AttributeMetadata
240
- * @property {string} [title]
241
- * @property {AttributeDetail[]} [details]
262
+ * @property {string} [title] - Title or name of the attribute metadata.
263
+ * @property {AttributeDetail[]} [details] - List of detailed information about
264
+ * attributes.
242
265
  */
243
266
  /**
244
267
  * @typedef ProductsComparisonResponse
245
- * @property {ProductDetail[]} [items]
246
- * @property {AttributeMetadata[]} [attributes_metadata]
268
+ * @property {ProductDetail[]} [items] - List of product details for comparison.
269
+ * @property {AttributeMetadata[]} [attributes_metadata] - Metadata about
270
+ * attributes used for comparing products.
247
271
  */
248
272
  /**
249
273
  * @typedef ProductCompareResponse
250
- * @property {string} [title]
251
- * @property {ProductDetail[]} [items]
252
- * @property {AttributeMetadata[]} [attributes_metadata]
253
- * @property {string} [subtitle]
274
+ * @property {string} [title] - Title or name of the comparison.
275
+ * @property {ProductDetail[]} [items] - List of product details for comparison.
276
+ * @property {AttributeMetadata[]} [attributes_metadata] - Metadata about
277
+ * attributes used for comparing products.
278
+ * @property {string} [subtitle] - Subtitle or additional description for the comparison.
254
279
  */
255
280
  /**
256
281
  * @typedef ProductFrequentlyComparedSimilarResponse
@@ -258,178 +283,209 @@ export = CatalogApplicationModel;
258
283
  */
259
284
  /**
260
285
  * @typedef ProductVariantItemResponse
261
- * @property {number} [uid]
262
- * @property {string} [color_name]
263
- * @property {string} [color]
264
- * @property {Media[]} [medias]
265
- * @property {boolean} [is_available]
266
- * @property {CustomMetaFields[]} [_custom_meta]
267
- * @property {string} [name]
268
- * @property {string} [value]
269
- * @property {string} [slug]
270
- * @property {Object} [_custom_json]
286
+ * @property {number} [uid] - Unique identifier for the product variant.
287
+ * @property {string} [color_name] - Name of the color for the variant.
288
+ * @property {string} [color] - Color code or representation for the variant.
289
+ * @property {Media[]} [medias] - Media files associated with the product variant.
290
+ * @property {boolean} [is_available] - Indicates whether the product variant is
291
+ * available for purchase.
292
+ * @property {CustomMetaFields[]} [_custom_meta] - Custom metadata fields
293
+ * associated with the product.
294
+ * @property {string} [name] - Name of the product variant.
295
+ * @property {string} [value] - Value or label representing the product variant.
296
+ * @property {string} [slug] - URL-friendly identifier for the product.
297
+ * @property {Object} [_custom_json] - Custom JSON object for additional data
298
+ * related to the product.
271
299
  * @property {ProductListingAction} [action]
272
300
  */
273
301
  /**
274
302
  * @typedef ProductVariantResponse
275
- * @property {string} [display_type]
276
- * @property {string} [header]
277
- * @property {string} [group_id]
278
- * @property {ProductVariantItemResponse[]} [items]
279
- * @property {string} [key]
280
- * @property {string} [logo]
303
+ * @property {string} [display_type] - The type of display for the product
304
+ * variant (e.g., image, text, image, color).
305
+ * @property {string} [header] - Header or title for the product variant section.
306
+ * @property {string} [group_id] - Group ID used to group variants.
307
+ * @property {ProductVariantItemResponse[]} [items] - List of product variant items.
308
+ * @property {string} [key] - Attribute identifier of the variant.
309
+ * @property {string} [logo] - URL or path to the logo associated with the
310
+ * product variant.
281
311
  */
282
312
  /**
283
313
  * @typedef ProductVariantsResponse
284
- * @property {ProductVariantResponse[]} [variants]
314
+ * @property {ProductVariantResponse[]} [variants] - A list of product variant
315
+ * responses, each detailing a specific variant.
285
316
  */
286
317
  /**
287
318
  * @typedef StoreDetail
288
- * @property {string} [name]
289
- * @property {string} [city]
290
- * @property {number} [id]
291
- * @property {string} [code]
319
+ * @property {string} [name] - NA.
320
+ * @property {string} [city] - NA.
321
+ * @property {number} [id] - NA.
322
+ * @property {string} [code] - NA.
292
323
  */
293
324
  /**
294
325
  * @typedef ProductStockPrice
295
- * @property {number} [effective]
296
- * @property {string} [currency]
297
- * @property {number} [marked]
326
+ * @property {number} [effective] - NA.
327
+ * @property {string} [currency] - NA.
328
+ * @property {number} [marked] - NA.
298
329
  */
299
330
  /**
300
331
  * @typedef CompanyDetail
301
- * @property {string} [name]
302
- * @property {number} [id]
332
+ * @property {string} [name] - NA.
333
+ * @property {number} [id] - NA.
303
334
  */
304
335
  /**
305
336
  * @typedef Seller
306
- * @property {number} [uid]
307
- * @property {string} [name]
308
- * @property {number} [count]
337
+ * @property {number} [uid] - NA.
338
+ * @property {string} [name] - NA.
339
+ * @property {number} [count] - NA.
309
340
  */
310
341
  /**
311
342
  * @typedef ProductStockStatusItem
312
- * @property {string} [uid]
313
- * @property {number} [quantity]
343
+ * @property {string} [uid] - NA.
344
+ * @property {number} [quantity] - NA.
314
345
  * @property {StoreDetail} [store]
315
- * @property {string} [size]
346
+ * @property {string} [size] - NA.
316
347
  * @property {ProductStockPrice} [price]
317
348
  * @property {CompanyDetail} [company]
318
- * @property {number} [item_id]
349
+ * @property {number} [item_id] - NA.
319
350
  * @property {Seller} [seller]
320
- * @property {Object} [identifier]
351
+ * @property {Object} [identifier] - NA.
321
352
  */
322
353
  /**
323
354
  * @typedef ProductStockStatusResponse
324
- * @property {ProductStockStatusItem[]} [items]
355
+ * @property {ProductStockStatusItem[]} [items] - NA.
325
356
  */
326
357
  /**
327
358
  * @typedef Page
328
- * @property {number} [item_total]
329
- * @property {string} [next_id]
330
- * @property {boolean} [has_previous]
331
- * @property {boolean} [has_next]
332
- * @property {number} [current]
333
- * @property {string} type
334
- * @property {number} [size]
359
+ * @property {number} [item_total] - The total number of items on the page.
360
+ * @property {string} [next_id] - The identifier for the next page.
361
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
362
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
363
+ * @property {number} [current] - The current page number.
364
+ * @property {string} type - The type of the page, such as 'PageType'.
365
+ * @property {number} [size] - The number of items per page.
335
366
  */
336
367
  /**
337
368
  * @typedef ProductStockPolling
338
- * @property {ProductStockStatusItem[]} [items]
369
+ * @property {ProductStockStatusItem[]} [items] - NA.
339
370
  * @property {Page} page
340
371
  */
341
372
  /**
342
373
  * @typedef ProductVariantListingResponse
343
- * @property {string} [header]
344
- * @property {ProductVariantItemResponse[]} [items]
345
- * @property {number} [total]
346
- * @property {string} [key]
347
- * @property {string} [display_type]
374
+ * @property {string} [header] - Header or title for the product variant section.
375
+ * @property {ProductVariantItemResponse[]} [items] - List of Upto 5 product
376
+ * variant items.
377
+ * @property {number} [total] - The total number of product variants available.
378
+ * @property {string} [key] - Attribute identifier of the variant.
379
+ * @property {string} [display_type] - The type of display for the product
380
+ * variant (e.g., image, text, image, color).
348
381
  */
349
382
  /**
350
383
  * @typedef ProductListingDetail
351
- * @property {number} [uid]
384
+ * @property {number} [uid] - Unique identifier for the product.
352
385
  * @property {ProductDetailCustomOrder} [custom_order]
353
- * @property {string[]} [sizes]
386
+ * @property {string[]} [sizes] - Available sizes for the product.
354
387
  * @property {ProductCategoryMap} [category_map]
355
388
  * @property {NetQuantity} [net_quantity]
356
- * @property {number} [rating_count]
357
- * @property {CustomMetaFields[]} [_custom_meta]
358
- * @property {string[]} [similars]
359
- * @property {string[]} [tags]
389
+ * @property {number} [rating_count] - The number of ratings the product has received.
390
+ * @property {CustomMetaFields[]} [_custom_meta] - Custom metadata fields
391
+ * associated with the product.
392
+ * @property {string[]} [similars] - List of products marked similar to given product.
393
+ * @property {string[]} [tags] - Tags associated with the product for better
394
+ * categorization.
360
395
  * @property {ApplicationItemSEO} [seo]
361
- * @property {string} [image_nature]
362
- * @property {boolean} [has_variant]
363
- * @property {string} [item_type]
364
- * @property {string} [description]
365
- * @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
366
- * @property {Media[]} [medias]
367
- * @property {string} [color]
368
- * @property {string} [type]
369
- * @property {string} [product_online_date]
370
- * @property {Object} [_custom_json]
371
- * @property {string} [item_code]
372
- * @property {string} [name]
396
+ * @property {string} [image_nature] - Type of the images associated with the
397
+ * product such as standard.
398
+ * @property {boolean} [has_variant] - Indicates whether the product has variants.
399
+ * @property {string} [item_type] - This field describes the type of item,
400
+ * indicating the category or nature of the product. Possible values are
401
+ * Standard, Composite, Wet, Digital.
402
+ * @property {string} [description] - Detailed description of the product.
403
+ * @property {ProductDetailGroupedAttribute[]} [grouped_attributes] - Grouped
404
+ * attributes detailing various characteristics of the product.
405
+ * @property {Media[]} [medias] - Media files associated with the product.
406
+ * @property {string} [color] - Color of the product, if applicable.
407
+ * @property {string} [type] - Product type or classification.
408
+ * @property {string} [product_online_date] - Date and time when the product was
409
+ * made available online.
410
+ * @property {Object} [_custom_json] - Custom JSON object for additional product data.
411
+ * @property {string} [item_code] - Item Code defined for the product.
412
+ * @property {string} [name] - Name of the product.
373
413
  * @property {ApplicationItemMOQ} [moq]
374
- * @property {string} [short_description]
375
- * @property {ProductBrand[]} [categories]
376
- * @property {boolean} [sellable]
377
- * @property {Object} [attributes]
378
- * @property {ProductVariantListingResponse[]} [variants]
379
- * @property {string} [discount]
380
- * @property {string[]} [tryouts]
381
- * @property {string[]} [identifiers]
382
- * @property {string} slug
414
+ * @property {string} [short_description] - Brief description of the product.
415
+ * @property {ProductBrand[]} [categories] - List of product categories
416
+ * associated with the product.
417
+ * @property {boolean} [sellable] - Indicates whether the product is available for sale.
418
+ * @property {Object} [attributes] - Additional attributes or characteristics of
419
+ * the product.
420
+ * @property {ProductVariantListingResponse[]} [variants] - List of product
421
+ * variants available for the product.
422
+ * @property {string} [discount] - Discount details or percentage applied to the product.
423
+ * @property {string[]} [tryouts] - List of tryout options available for the product.
424
+ * @property {string[]} [identifiers] - List of seller identifiers for the product.
425
+ * @property {string} slug - URL-friendly identifier for the product.
383
426
  * @property {ProductListingAction} [action]
384
- * @property {number} [rating]
385
- * @property {boolean} [is_dependent]
386
- * @property {string[]} [product_group_tag]
387
- * @property {string[]} [highlights]
427
+ * @property {number} [rating] - Rating of the product.
428
+ * @property {boolean} [is_dependent] - Indicates whether the product can be
429
+ * sold as an individual product.
430
+ * @property {string[]} [product_group_tag] - List of bundle/product grouping
431
+ * slugs mapped to the product.
432
+ * @property {string[]} [highlights] - Key highlights or features of the product.
388
433
  * @property {ProductListingPrice} [price]
389
434
  * @property {ProductBrand} [brand]
390
- * @property {string} [teaser_tag]
435
+ * @property {string} [teaser_tag] - Teaser tag or short promotional phrase for
436
+ * the product.
391
437
  */
392
438
  /**
393
439
  * @typedef ProductFiltersValue
394
- * @property {number} [min]
395
- * @property {string} [display_format]
396
- * @property {number} [selected_max]
397
- * @property {string} [value]
398
- * @property {string} [query_format]
399
- * @property {string} [currency_symbol]
400
- * @property {number} [selected_min]
401
- * @property {string} [currency_code]
402
- * @property {boolean} is_selected
403
- * @property {string} display
404
- * @property {number} [count]
405
- * @property {number} [max]
440
+ * @property {number} [min] - Minimum value for the range filter.
441
+ * @property {string} [display_format] - Format in which the filter value is displayed.
442
+ * @property {number} [selected_max] - The maximum value selected by the user
443
+ * for range filter.
444
+ * @property {string} [value] - Value associated with the filter option.
445
+ * @property {string} [query_format] - Format used for the filter value in queries.
446
+ * @property {string} [currency_symbol] - Currency symbol for the price type filters.
447
+ * @property {number} [selected_min] - The minimum value selected by the user
448
+ * for range filter.
449
+ * @property {string} [currency_code] - Currency code for the currency used for
450
+ * price type filters.
451
+ * @property {boolean} is_selected - Whether this filter value is currently selected.
452
+ * @property {string} display - Display name or label for the filter value.
453
+ * @property {number} [count] - Number of products that match this filter value.
454
+ * @property {number} [max] - Maximum value of the filter range.
406
455
  */
407
456
  /**
408
457
  * @typedef ProductFiltersKey
409
- * @property {string} [logo]
410
- * @property {string} name
411
- * @property {string} [kind]
412
- * @property {string} display
458
+ * @property {string} [logo] - URL or path to the logo associated with the filter key.
459
+ * @property {string} name - Name or identifier of the filter key.
460
+ * @property {string} [kind] - Type or category of the filter key (e.g., range,
461
+ * multivalued).
462
+ * @property {string} display - Display name or label for the filter key.
413
463
  */
414
464
  /**
415
465
  * @typedef ProductFilters
416
- * @property {ProductFiltersValue[]} values
466
+ * @property {ProductFiltersValue[]} values - List of filter values associated
467
+ * with the filter key.
417
468
  * @property {ProductFiltersKey} key
418
469
  */
419
470
  /**
420
471
  * @typedef ProductSortOn
421
- * @property {string} [logo]
422
- * @property {boolean} [is_selected]
423
- * @property {string} [name]
424
- * @property {string} [value]
425
- * @property {string} [display]
472
+ * @property {string} [logo] - URL or path to the logo associated with the sorting option.
473
+ * @property {boolean} [is_selected] - Indicates whether this sorting option is
474
+ * currently selected.
475
+ * @property {string} [name] - Name or identifier of the sorting option.
476
+ * @property {string} [value] - Value used to specify the sorting order (e.g.,
477
+ * price_asc, discount_dsc).
478
+ * @property {string} [display] - Display name or label for the sorting option.
426
479
  */
427
480
  /**
428
481
  * @typedef ProductListingResponse
429
- * @property {ProductListingDetail[]} [items]
430
- * @property {ProductFilters[]} [filters]
482
+ * @property {ProductListingDetail[]} [items] - List of product details included
483
+ * in the response.
484
+ * @property {ProductFilters[]} [filters] - List of filters available for
485
+ * refining the product listings.
431
486
  * @property {Page} page
432
- * @property {ProductSortOn[]} [sort_on]
487
+ * @property {ProductSortOn[]} [sort_on] - List of sorting options available for
488
+ * the product listings.
433
489
  */
434
490
  /**
435
491
  * @typedef ImageUrls
@@ -438,29 +494,35 @@ export = CatalogApplicationModel;
438
494
  */
439
495
  /**
440
496
  * @typedef BrandItem
441
- * @property {number} [uid]
497
+ * @property {number} [uid] - The unique identifier for the brand.
442
498
  * @property {Media} [logo]
443
- * @property {string} [description]
499
+ * @property {string} [description] - Detailed description of the brand,
500
+ * including its history, values, product offerings, and other relevant information.
444
501
  * @property {ImageUrls} [banners]
445
- * @property {string[]} [departments]
446
- * @property {string} [discount]
447
- * @property {string} [name]
448
- * @property {string} [slug]
502
+ * @property {string[]} [departments] - Lists the departments or categories
503
+ * under which the brand's products are listed.
504
+ * @property {string} [discount] - Details about any discounts currently
505
+ * available on the brand's products.
506
+ * @property {string} [name] - Name of the brand.
507
+ * @property {string} [slug] - URL-friendly version of the brand's name, used in
508
+ * the web address to access the brand's page on the platform.
449
509
  * @property {ProductListingAction} [action]
450
510
  */
451
511
  /**
452
512
  * @typedef BrandListingResponse
453
- * @property {BrandItem[]} [items]
513
+ * @property {BrandItem[]} [items] - List of brand items included in the response.
454
514
  * @property {Page} page
455
515
  */
456
516
  /**
457
517
  * @typedef BrandDetailResponse
458
518
  * @property {Media} [logo]
459
- * @property {number} [uid]
460
- * @property {string} [description]
519
+ * @property {number} [uid] - The unique identifier for the brand.
520
+ * @property {string} [description] - Detailed description of the brand,
521
+ * including its history, values, product offerings, and other relevant information.
461
522
  * @property {ImageUrls} [banners]
462
- * @property {Object} [_custom_json]
463
- * @property {string} [name]
523
+ * @property {Object} [_custom_json] - Custom JSON data related to the brand,
524
+ * allowing for additional metadata.
525
+ * @property {string} [name] - Name of the brand.
464
526
  */
465
527
  /**
466
528
  * @typedef CategoryBanner
@@ -469,192 +531,240 @@ export = CatalogApplicationModel;
469
531
  */
470
532
  /**
471
533
  * @typedef ThirdLevelChild
472
- * @property {number} [uid]
534
+ * @property {number} [uid] - Unique identifier for the L3 category.
473
535
  * @property {ImageUrls} [banners]
474
- * @property {Object[]} [childs]
475
- * @property {Object} [_custom_json]
476
- * @property {string} [name]
477
- * @property {string} [slug]
536
+ * @property {Object[]} [childs] - List of categories under the L3 category.
537
+ * @property {Object} [_custom_json] - Custom JSON data related to the L3
538
+ * category, allowing for additional metadata.
539
+ * @property {string} [name] - Name of the L3 category.
540
+ * @property {string} [slug] - Slug or URL-friendly identifier for the L3 category.
478
541
  * @property {ProductListingAction} [action]
479
542
  */
480
543
  /**
481
544
  * @typedef SecondLevelChild
482
- * @property {number} [uid]
545
+ * @property {number} [uid] - Unique identifier for the L2 category.
483
546
  * @property {ImageUrls} [banners]
484
- * @property {ThirdLevelChild[]} [childs]
485
- * @property {Object} [_custom_json]
486
- * @property {string} [name]
487
- * @property {string} [slug]
547
+ * @property {ThirdLevelChild[]} [childs] - List of categories under the L2 category.
548
+ * @property {Object} [_custom_json] - Custom JSON data related to the L2
549
+ * category, allowing for additional metadata.
550
+ * @property {string} [name] - Name of the L2 category.
551
+ * @property {string} [slug] - Slug or URL-friendly identifier for the L2 category.
488
552
  * @property {ProductListingAction} [action]
489
553
  */
490
554
  /**
491
555
  * @typedef Child
492
- * @property {number} [uid]
556
+ * @property {number} [uid] - Unique identifier for the L1 category.
493
557
  * @property {ImageUrls} [banners]
494
- * @property {SecondLevelChild[]} [childs]
495
- * @property {Object} [_custom_json]
496
- * @property {string} [name]
497
- * @property {string} [slug]
558
+ * @property {SecondLevelChild[]} [childs] - List of categories under the L1 category.
559
+ * @property {Object} [_custom_json] - Custom JSON data related to the L1
560
+ * category, allowing for additional metadata.
561
+ * @property {string} [name] - Name of the L1 category.
562
+ * @property {string} [slug] - Slug or URL-friendly identifier for the L1 category.
498
563
  * @property {ProductListingAction} [action]
499
564
  */
500
565
  /**
501
566
  * @typedef CategoryItems
502
- * @property {number} uid
567
+ * @property {number} uid - Unique identifier for the category.
503
568
  * @property {CategoryBanner} banners
504
- * @property {Child[]} [childs]
505
- * @property {string} name
506
- * @property {string} slug
569
+ * @property {Child[]} [childs] - List of L1 categories under the main category.
570
+ * @property {string} name - Name of the category.
571
+ * @property {string} slug - Slug or URL-friendly identifier for the category.
507
572
  * @property {ProductListingAction} action
508
573
  */
509
574
  /**
510
575
  * @typedef DepartmentCategoryTree
511
- * @property {CategoryItems[]} [items]
512
- * @property {string} department
576
+ * @property {CategoryItems[]} [items] - List of categories within the department.
577
+ * @property {string} department - Name of the department.
513
578
  */
514
579
  /**
515
580
  * @typedef DepartmentIdentifier
516
- * @property {number} [uid]
517
- * @property {string} [slug]
581
+ * @property {number} [uid] - Unique identifier for the department.
582
+ * @property {string} [slug] - Slug or URL-friendly identifier for the department.
518
583
  */
519
584
  /**
520
585
  * @typedef CategoryListingResponse
521
- * @property {DepartmentCategoryTree[]} [data]
522
- * @property {DepartmentIdentifier[]} [departments]
586
+ * @property {DepartmentCategoryTree[]} [data] - List of department category trees.
587
+ * @property {DepartmentIdentifier[]} [departments] - List of departments.
523
588
  */
524
589
  /**
525
590
  * @typedef CategoryMetaResponse
526
591
  * @property {Media} [logo]
527
- * @property {number} [uid]
592
+ * @property {number} [uid] - Unique identifier for the category.
528
593
  * @property {ImageUrls} [banners]
529
- * @property {Object} [_custom_json]
530
- * @property {string} [name]
594
+ * @property {Object} [_custom_json] - Custom JSON data related to the category,
595
+ * allowing for additional metadata.
596
+ * @property {string} [name] - Name of the category.
531
597
  */
532
598
  /**
533
599
  * @typedef HomeListingResponse
534
- * @property {ProductListingDetail[]} [items]
600
+ * @property {ProductListingDetail[]} [items] - List of product details
601
+ * displayed on the home page.
535
602
  * @property {Page} page
536
- * @property {string} [message]
603
+ * @property {string} [message] - Message related to the home listing response.
537
604
  */
538
605
  /**
539
606
  * @typedef Department
540
- * @property {number} [uid]
607
+ * @property {number} [uid] - Unique identifier for the department.
541
608
  * @property {Media} [logo]
542
- * @property {number} [priority_order]
543
- * @property {string} [name]
544
- * @property {string} [slug]
609
+ * @property {number} [priority_order] - Specifies the display order of the
610
+ * department, determining its position in lists and navigation menus based on
611
+ * priority.
612
+ * @property {string} [name] - Name of the department.
613
+ * @property {string} [slug] - URL-friendly version of the department's name,
614
+ * used in the web address to access the department's page on the platform.
545
615
  */
546
616
  /**
547
617
  * @typedef DepartmentResponse
548
- * @property {Department[]} [items]
618
+ * @property {Department[]} [items] - List of department detail objects.
549
619
  */
550
620
  /**
551
621
  * @typedef AutocompleteItem
552
622
  * @property {Media} [logo]
553
- * @property {string} [display]
554
- * @property {string} [type]
555
- * @property {Object} [_custom_json]
623
+ * @property {string} [display] - Text or value displayed for the autocomplete item.
624
+ * @property {string} [type] - The type of action such as product, products,
625
+ * category, brand.
626
+ * @property {Object} [_custom_json] - Custom JSON data related to the
627
+ * autocomplete item, allowing for additional metadata.
556
628
  * @property {ProductListingAction} [action]
557
629
  */
558
630
  /**
559
631
  * @typedef AutoCompleteResponse
560
- * @property {AutocompleteItem[]} [items]
632
+ * @property {AutocompleteItem[]} [items] - List of autocomplete items suggested
633
+ * based on user input.
561
634
  */
562
635
  /**
563
636
  * @typedef CollectionQuery
564
- * @property {string} op
565
- * @property {Object[]} value
566
- * @property {string} attribute
637
+ * @property {string} op - The operator used for filtering the collection.
638
+ * @property {Object[]} value - The values used for filtering based on the attribute.
639
+ * @property {string} attribute - The attribute on which the filter is applied.
567
640
  */
568
641
  /**
569
642
  * @typedef GetCollectionDetailNest
570
- * @property {boolean} [is_active]
571
- * @property {string} [uid]
572
- * @property {string} [sort_on]
573
- * @property {Object} [meta]
643
+ * @property {boolean} [is_active] - Indicates whether the collection is currently active.
644
+ * @property {string} [uid] - The unique identifier for the collection.
645
+ * @property {string} [sort_on] - The attribute by which the collection items are sorted.
646
+ * @property {Object} [meta] - Additional metadata related to the collection.
574
647
  * @property {ImageUrls} [banners]
575
- * @property {Object} [cron]
576
- * @property {Object} [_schedule]
577
- * @property {CollectionQuery[]} [query]
578
- * @property {string} [description]
579
- * @property {string} [type]
580
- * @property {Object} [_custom_json]
581
- * @property {string} [name]
582
- * @property {boolean} [allow_sort]
583
- * @property {string[]} [visible_facets_keys]
584
- * @property {Object} [badge]
585
- * @property {string} [slug]
648
+ * @property {Object} [cron] - Cron details for scheduling related to the collection.
649
+ * @property {Object} [_schedule] - The `Schedule` schema defines the timing and
650
+ * details for recurring or one-time tasks. It includes information on when
651
+ * the job should start and end, the frequency of the task, and any additional
652
+ * metadata. This schema helps in scheduling jobs or tasks based on specified
653
+ * timings and durations.
654
+ * @property {CollectionQuery[]} [query] - A list of queries used to filter the
655
+ * collection.
656
+ * @property {string} [description] - A detailed description of the collection.
657
+ * @property {string} [type] - Type of collections e.g query, items.
658
+ * @property {Object} [_custom_json] - Custom JSON data associated with the collection.
659
+ * @property {string} [name] - The name of the collection.
660
+ * @property {boolean} [allow_sort] - Indicates if sorting is allowed for this collection.
661
+ * @property {string[]} [visible_facets_keys] - Keys of the facets visible for
662
+ * filtering within the collection.
663
+ * @property {Object} [badge] - Badge information associated with the collection.
664
+ * @property {string} [slug] - The URL-friendly identifier for the collection.
586
665
  * @property {ProductListingAction} [action]
587
- * @property {boolean} [allow_facets]
666
+ * @property {boolean} [allow_facets] - Indicates if facets are allowed for
667
+ * filtering within the collection.
588
668
  * @property {Media} [logo]
589
- * @property {number} [priority]
590
- * @property {string[]} [tags]
591
- * @property {string} [app_id]
669
+ * @property {number} [priority] - Priority level of the collection for sorting
670
+ * or display purposes.
671
+ * @property {string[]} [tags] - Tags associated with the collection.
672
+ * @property {string} [app_id] - Application ID associated with the collection.
592
673
  */
593
674
  /**
594
675
  * @typedef CollectionListingFilterTag
595
- * @property {string} [name]
596
- * @property {boolean} [is_selected]
597
- * @property {string} [display]
676
+ * @property {string} [name] - The name of the tag. This is typically used as a
677
+ * label for filtering purposes.
678
+ * @property {boolean} [is_selected] - A flag indicating whether the tag is
679
+ * currently selected as a filter option.
680
+ * @property {string} [display] - The display name of the tag. This may be a
681
+ * user-friendly version of the tag name shown in the UI.
598
682
  */
599
683
  /**
600
684
  * @typedef CollectionListingFilterType
601
- * @property {string} [name]
602
- * @property {boolean} [is_selected]
603
- * @property {string} [display]
685
+ * @property {string} [name] - The name of the filter type. This indicates the
686
+ * type of filtering being applied, such as items, query.
687
+ * @property {boolean} [is_selected] - A flag indicating whether this filter
688
+ * type is currently selected as a filter option.
689
+ * @property {string} [display] - The display name of the filter type. This is
690
+ * the user-friendly name shown in the UI for the filter type.
604
691
  */
605
692
  /**
606
693
  * @typedef CollectionListingFilter
607
- * @property {CollectionListingFilterTag[]} [tags]
608
- * @property {CollectionListingFilterType[]} [type]
694
+ * @property {CollectionListingFilterTag[]} [tags] - An array of tag filters
695
+ * available for the collection listings. Each tag allows for filtering based
696
+ * on specific attributes.
697
+ * @property {CollectionListingFilterType[]} [type] - An array of filter types
698
+ * available for the collection listings. Each type represents a different
699
+ * category or attribute for filtering.
609
700
  */
610
701
  /**
611
702
  * @typedef GetCollectionListingResponse
612
- * @property {GetCollectionDetailNest[]} [items]
703
+ * @property {GetCollectionDetailNest[]} [items] - An array of collection
704
+ * details. Each item in the array represents a collection with various
705
+ * attributes and configurations.
613
706
  * @property {CollectionListingFilter} [filters]
614
707
  * @property {Page} page
615
708
  */
616
709
  /**
617
710
  * @typedef CollectionDetailResponse
618
- * @property {boolean} [is_active]
619
- * @property {string} [sort_on]
620
- * @property {Object} [meta]
711
+ * @property {boolean} [is_active] - Indicates whether the collection is active.
712
+ * @property {string} [sort_on] - Criteria used to sort the items within the
713
+ * collection, such as price, popularity, or newest first.
714
+ * @property {Object} [meta] - Metadata associated with the collection.
621
715
  * @property {ImageUrls} [banners]
622
- * @property {Object} [cron]
623
- * @property {Object} [_schedule]
624
- * @property {CollectionQuery[]} [query]
625
- * @property {string} [description]
626
- * @property {string} [type]
627
- * @property {Object} [_custom_json]
628
- * @property {string} [name]
629
- * @property {boolean} [allow_sort]
630
- * @property {string[]} [visible_facets_keys]
631
- * @property {Object} [badge]
632
- * @property {string} [slug]
633
- * @property {boolean} [allow_facets]
716
+ * @property {Object} [cron] - Cron schedule details related to the collection,
717
+ * if applicable.
718
+ * @property {Object} [_schedule] - Schedule details for the collection,
719
+ * including timing and duration information.
720
+ * @property {CollectionQuery[]} [query] - Search or filter query used to
721
+ * dynamically generate the collection based on specific criteria or conditions.
722
+ * @property {string} [description] - Detailed description of the collection,.
723
+ * @property {string} [type] - Type of collection, specifying the nature or
724
+ * category of the collection.
725
+ * @property {Object} [_custom_json] - Custom JSON object containing additional
726
+ * properties specific to the collection.
727
+ * @property {string} [name] - The name of the collection.
728
+ * @property {boolean} [allow_sort] - Indicates if sorting is allowed for this collection.
729
+ * @property {string[]} [visible_facets_keys] - Keys of the facets visible for
730
+ * filtering within the collection.
731
+ * @property {Object} [badge] - Badge information associated with the collection.
732
+ * @property {string} [slug] - The URL-friendly identifier for the collection.
733
+ * @property {boolean} [allow_facets] - Indicates if facets are allowed for
734
+ * filtering within the collection.
634
735
  * @property {Media} [logo]
635
- * @property {number} [priority]
636
- * @property {string[]} [tag]
637
- * @property {string} [app_id]
736
+ * @property {number} [priority] - Priority level of the collection for sorting
737
+ * or display purposes.
738
+ * @property {string[]} [tag] - Tags associated with the collection.
739
+ * @property {string} [app_id] - Application ID associated with the collection.
638
740
  */
639
741
  /**
640
742
  * @typedef GetFollowListingResponse
641
- * @property {ProductListingDetail[]} items
743
+ * @property {ProductListingDetail[]} items - An array of product details that
744
+ * the user is following. Each item includes information such as the product
745
+ * name, price, and other attributes.
642
746
  * @property {Page} page
643
747
  */
644
748
  /**
645
749
  * @typedef FollowPostResponse
646
- * @property {string} message
647
- * @property {string} id
750
+ * @property {string} message - A message indicating the result of the follow or
751
+ * unfollow operation. This could be a confirmation message or an error message.
752
+ * @property {string} id - A unique identifier for the follow operation, which
753
+ * can be used to reference or track the follow status.
648
754
  */
649
755
  /**
650
756
  * @typedef FollowerCountResponse
651
- * @property {number} [count]
757
+ * @property {number} [count] - The number of followers for the item. This count
758
+ * indicates how many users are following the specified item.
652
759
  */
653
760
  /**
654
761
  * @typedef FollowIdsData
655
- * @property {number[]} [products]
656
- * @property {number[]} [collections]
657
- * @property {number[]} [brands]
762
+ * @property {number[]} [products] - An array of IDs representing the products
763
+ * that the user is following.
764
+ * @property {number[]} [collections] - An array of IDs representing the
765
+ * collections that the user is following.
766
+ * @property {number[]} [brands] - An array of IDs representing the brands that
767
+ * the user is following.
658
768
  */
659
769
  /**
660
770
  * @typedef FollowIdsResponse
@@ -662,107 +772,125 @@ export = CatalogApplicationModel;
662
772
  */
663
773
  /**
664
774
  * @typedef LatLong
665
- * @property {number[]} [coordinates]
666
- * @property {string} [type]
775
+ * @property {number[]} [coordinates] - An array containing the latitude and
776
+ * longitude values of the location.
777
+ * @property {string} [type] - The type of geographic coordinate system used.
778
+ * For example, "Point" indicates a single point in a geographic coordinate system.
667
779
  */
668
780
  /**
669
781
  * @typedef Store
670
- * @property {number} [uid]
671
- * @property {string} [store_email]
672
- * @property {string} [state]
673
- * @property {string} [country]
674
- * @property {number} [pincode]
675
- * @property {string} [city]
676
- * @property {string} [address]
677
- * @property {string} [store_code]
782
+ * @property {number} [uid] - A unique identifier for the store.
783
+ * @property {string} [store_email] - The manager's email address for the store.
784
+ * @property {string} [state] - The state or province where the store is located.
785
+ * @property {string} [country] - The country where the store is located.
786
+ * @property {number} [pincode] - The postal code or zip code for the store's location.
787
+ * @property {string} [city] - The city where the store is located.
788
+ * @property {string} [address] - The street address of the store.
789
+ * @property {string} [store_code] - A unique code or identifier for the store,
790
+ * often used for internal reference.
678
791
  * @property {LatLong} [lat_long]
679
- * @property {string} [name]
680
- * @property {string[]} [tags]
792
+ * @property {string} [name] - The name of the store.
793
+ * @property {string[]} [tags] - The list of tags mapped to the store.
681
794
  */
682
795
  /**
683
796
  * @typedef StoreListingResponse
684
- * @property {Store[]} items
797
+ * @property {Store[]} items - An array of store details. Each store includes
798
+ * information such as name, address, and geographic coordinates.
685
799
  * @property {Page} page
686
800
  */
687
801
  /**
688
802
  * @typedef StoreDepartments
689
- * @property {number} [uid]
690
- * @property {Object} [logo]
691
- * @property {number} [priority_order]
692
- * @property {string} [name]
693
- * @property {string} [slug]
803
+ * @property {number} [uid] - The unique identifier assigned to the store department.
804
+ * @property {Object} [logo] - An object containing information about the store
805
+ * department's logo, such as the URL or other related media details.
806
+ * @property {number} [priority_order] - The priority or ranking of the
807
+ * department within the store. This field is used to determine the order in
808
+ * which departments are displayed or processed.
809
+ * @property {string} [name] - The name of the store department, which is
810
+ * typically used for display and identification purposes.
811
+ * @property {string} [slug] - A URL-friendly identifier for the store
812
+ * department, often used in web addresses and routing to uniquely identify
813
+ * the department.
694
814
  */
695
815
  /**
696
816
  * @typedef CompanyStore
697
- * @property {number} [uid]
698
- * @property {string} [name]
699
- * @property {string} [company_type]
700
- * @property {string} [business_type]
817
+ * @property {number} [uid] - The unique identifier for the company store.
818
+ * @property {string} [name] - The name of the company store.
819
+ * @property {string} [company_type] - The type of company, which can be one of
820
+ * the following: - `distributor`: Distributor - `franchise`: Franchise -
821
+ * `mbo`: MBO (Managed Business Operations) - `manufacturer-owner`: Owner/Manufacturer.
822
+ * @property {string} [business_type] - The type of business structure, which
823
+ * can be one of the following: - `Private`: Private Limited Company -
824
+ * `LLP/Partnership`: Limited Liability Partnership or Partnership -
825
+ * `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
701
826
  */
702
827
  /**
703
828
  * @typedef SellerPhoneNumber
704
- * @property {number} country_code
705
- * @property {string} number
829
+ * @property {number} country_code - The country code of the seller's phone number.
830
+ * @property {string} number - The seller's contact number.
706
831
  */
707
832
  /**
708
833
  * @typedef StoreManagerSerializer
709
- * @property {string} [name]
710
- * @property {string} [email]
834
+ * @property {string} [name] - The name of the store manager.
835
+ * @property {string} [email] - The email address of the store manager.
711
836
  * @property {SellerPhoneNumber} [mobile_no]
712
837
  */
713
838
  /**
714
839
  * @typedef StoreAddressSerializer
715
- * @property {number} [latitude]
716
- * @property {string} [state]
717
- * @property {string} [country]
718
- * @property {string} [landmark]
719
- * @property {string} [address1]
720
- * @property {number} [pincode]
721
- * @property {string} [city]
722
- * @property {number} [longitude]
723
- * @property {string} [address2]
840
+ * @property {number} [latitude] - The latitude of the store's location.
841
+ * @property {string} [state] - The state where the store is located.
842
+ * @property {string} [country] - The country where the store is located.
843
+ * @property {string} [landmark] - A landmark near the store.
844
+ * @property {string} [address1] - The address line 1 of the store.
845
+ * @property {number} [pincode] - The postal code for the store's location.
846
+ * @property {string} [city] - The city where the store is located.
847
+ * @property {number} [longitude] - The longitude of the store's location.
848
+ * @property {string} [address2] - The address line2 of the store.
724
849
  */
725
850
  /**
726
851
  * @typedef AppStore
727
- * @property {number} [uid]
728
- * @property {StoreDepartments[]} [departments]
852
+ * @property {number} [uid] - The unique identifier for the application store.
853
+ * @property {StoreDepartments[]} [departments] - A list of departments within the store.
729
854
  * @property {CompanyStore} [company]
730
855
  * @property {StoreManagerSerializer} [manager]
731
- * @property {string} [store_code]
856
+ * @property {string} [store_code] - A unique code for identifying the store.
732
857
  * @property {StoreAddressSerializer} [address]
733
- * @property {string} [name]
734
- * @property {SellerPhoneNumber[]} [contact_numbers]
858
+ * @property {string} [name] - The name of the store.
859
+ * @property {SellerPhoneNumber[]} [contact_numbers] - A list of contact numbers
860
+ * for the store.
735
861
  */
736
862
  /**
737
863
  * @typedef ApplicationStoreListing
738
- * @property {Object[]} [filters]
739
- * @property {AppStore[]} [items]
864
+ * @property {Object[]} [filters] - A list of filters applied to the store listing.
865
+ * @property {AppStore[]} [items] - A list of application stores.
740
866
  * @property {Page} [page]
741
867
  */
742
868
  /**
743
869
  * @typedef Time
744
- * @property {number} [hour]
745
- * @property {number} [minute]
870
+ * @property {number} [hour] - The hour part of the time.
871
+ * @property {number} [minute] - The minute part of the time.
746
872
  */
747
873
  /**
748
874
  * @typedef StoreTiming
749
- * @property {boolean} [open]
875
+ * @property {boolean} [open] - Indicates if the store is open on this day.
750
876
  * @property {Time} [closing]
751
- * @property {string} [weekday]
877
+ * @property {string} [weekday] - The day of the week.
752
878
  * @property {Time} [opening]
753
879
  */
754
880
  /**
755
881
  * @typedef StoreDetails
756
- * @property {number} [uid]
757
- * @property {StoreDepartments[]} [departments]
882
+ * @property {number} [uid] - The unique identifier for the store.
883
+ * @property {StoreDepartments[]} [departments] - A list of departments within the store.
758
884
  * @property {CompanyStore} [company]
759
885
  * @property {StoreManagerSerializer} [manager]
760
- * @property {string} [store_code]
761
- * @property {StoreTiming[]} [timing]
886
+ * @property {string} [store_code] - A unique code for identifying the store.
887
+ * @property {StoreTiming[]} [timing] - The opening and closing times for the
888
+ * store throughout the week.
762
889
  * @property {StoreAddressSerializer} [address]
763
- * @property {Object} [_custom_json]
764
- * @property {string} [name]
765
- * @property {SellerPhoneNumber[]} [contact_numbers]
890
+ * @property {Object} [_custom_json] - Custom JSON data for the store.
891
+ * @property {string} [name] - The name of the store.
892
+ * @property {SellerPhoneNumber[]} [contact_numbers] - A list of contact numbers
893
+ * for the store.
766
894
  */
767
895
  /**
768
896
  * @typedef UserDetail
@@ -773,10 +901,10 @@ export = CatalogApplicationModel;
773
901
  */
774
902
  /**
775
903
  * @typedef Size
776
- * @property {number} [quantity] - The quantity of this size available
777
- * @property {Object} [value] - The value of the size
778
- * @property {Object} [display] - The display string for the size
779
- * @property {boolean} [is_available] - Whether or not this size is available
904
+ * @property {number} [quantity] - The quantity of this size available.
905
+ * @property {Object} [value] - The value of the size.
906
+ * @property {Object} [display] - The display string for the size.
907
+ * @property {boolean} [is_available] - Whether or not this size is available.
780
908
  */
781
909
  /**
782
910
  * @typedef ProductGroupPrice
@@ -788,121 +916,125 @@ export = CatalogApplicationModel;
788
916
  */
789
917
  /**
790
918
  * @typedef ProductDetails
791
- * @property {Object} [template_tag] - The template tag of the product
792
- * @property {number} [rating_count] - The number of ratings the product has received
793
- * @property {Object} [image_nature] - The nature of the product's images
794
- * @property {boolean} [has_variant] - Whether or not the product has a variant
795
- * @property {Object} [description] - The long description of the product
796
- * @property {boolean} [out_of_stock] - Whether or not the product is out of stock
797
- * @property {number} [hsn_code] - The HSN code of the product
798
- * @property {Object} [grouped_attributes] - A dictionary of grouped product attributes
799
- * @property {Object} [item_code] - The item code of the product
800
- * @property {Object} [name] - The name of the product
801
- * @property {Object} [country_of_origin] - The country of origin for the product
802
- * @property {Object} [short_description] - The short description of the product
803
- * @property {Object[]} [media] - A list of media objects for the product
804
- * @property {Object} [attributes] - A dictionary of product attributes
805
- * @property {boolean} [is_set] - Whether or not the product is a set of items
806
- * @property {Object[]} [images] - A list of image URLs for the product
807
- * @property {Object} [slug] - The slug of the product
808
- * @property {number} [rating] - The rating of the product
809
- * @property {Object} [identifier] - A dictionary of product identifiers
810
- * @property {Object[]} [highlights] - A list of highlights for the product
811
- * @property {number} [brand_uid] - The unique ID of the product's brand
919
+ * @property {Object} [template_tag] - The template tag of the product.
920
+ * @property {number} [rating_count] - The number of ratings the product has received.
921
+ * @property {Object} [image_nature] - The nature of the product's images.
922
+ * @property {boolean} [has_variant] - Whether or not the product has a variant.
923
+ * @property {Object} [description] - The long description of the product.
924
+ * @property {boolean} [out_of_stock] - Whether or not the product is out of stock.
925
+ * @property {number} [hsn_code] - The HSN code of the product.
926
+ * @property {Object} [grouped_attributes] - A dictionary of grouped product attributes.
927
+ * @property {Object} [item_code] - The item code of the product.
928
+ * @property {Object} [name] - The name of the product.
929
+ * @property {Object} [country_of_origin] - The country of origin for the product.
930
+ * @property {Object} [short_description] - The short description of the product.
931
+ * @property {Object[]} [media] - A list of media objects for the product.
932
+ * @property {Object} [attributes] - A dictionary of product attributes.
933
+ * @property {boolean} [is_set] - Whether or not the product is a set of items.
934
+ * @property {Object[]} [images] - A list of image URLs for the product.
935
+ * @property {Object} [slug] - The slug of the product.
936
+ * @property {number} [rating] - The rating of the product.
937
+ * @property {Object} [identifier] - A dictionary of product identifiers.
938
+ * @property {Object[]} [highlights] - A list of highlights for the product.
939
+ * @property {number} [brand_uid] - The unique ID of the product's brand.
812
940
  */
813
941
  /**
814
942
  * @typedef ProductInGroup
815
- * @property {boolean} [auto_add_to_cart] - A flag indicating whether the
816
- * product should be automatically added to the cart.
943
+ * @property {boolean} [auto_add_to_cart] - Whether the product should be
944
+ * automatically added to the cart.
817
945
  * @property {number} max_quantity - The maximum quantity of the product that
818
946
  * can be added to the cart.
819
947
  * @property {Size[]} [sizes] - The available sizes for the product.
820
- * @property {ProductGroupPrice} [price] - The price details for the product group.
821
- * @property {boolean} [auto_select] - A flag indicating whether the product
822
- * should be automatically selected.
948
+ * @property {ProductGroupPrice} [price] - The price details for the product.
949
+ * @property {boolean} [auto_select] - Whether the product should be
950
+ * automatically selected.
823
951
  * @property {ProductDetails} [product_details] - The details of the product.
824
952
  * @property {number} [min_quantity] - The minimum quantity of the product that
825
953
  * can be added to the cart.
826
- * @property {boolean} [allow_remove] - A flag indicating whether the product
827
- * can be removed from the cart.
954
+ * @property {boolean} [allow_remove] - Whether the product can be removed from the cart.
828
955
  * @property {number} product_uid - The unique ID of the product in the group.
829
956
  */
830
957
  /**
831
958
  * @typedef ProductGroupingModel
832
- * @property {string} [logo] - The URL for the logo of the product grouping.
959
+ * @property {string} [logo] - The URL for the logo of the product group.
833
960
  * @property {boolean} [is_active] - Whether the product grouping is active.
834
961
  * @property {Object} [meta] - A dictionary containing metadata information.
835
962
  * @property {UserDetail} [verified_by] - User details of the verifier of the
836
- * document, if applicable
837
- * @property {string} created_on - Timestamp of the creation of the document
963
+ * document, if applicable.
964
+ * @property {string} created_on - Timestamp of the creation of the document.
838
965
  * @property {number} [company_id] - The ID of the company that owns the product grouping.
839
966
  * @property {Object[]} [page_visibility] - A list of page visibilities of the
840
967
  * product grouping.
841
- * @property {string} modified_on - Timestamp of the last modification of the document
842
- * @property {UserDetail} [created_by] - User details of the creator of the document
968
+ * @property {string} modified_on - Timestamp of the last modification of the document.
969
+ * @property {UserDetail} [created_by] - User details of the creator of the document.
843
970
  * @property {UserDetail} [modified_by] - User details of the last modifier of
844
- * the document
971
+ * the document.
845
972
  * @property {ProductInGroup[]} products - A list of products in the grouping.
846
973
  * @property {boolean} [same_store_assignment] - Whether the products are
847
974
  * assigned to the same store.
848
- * @property {Object} [_id]
975
+ * @property {Object} [_id] - Unique identifier of the product grouping.
849
976
  * @property {Object} name - The name of the product grouping.
850
977
  * @property {Object} [choice] - The choice of the product grouping.
851
978
  * @property {Object} [slug] - The unique identifier for the product grouping.
852
979
  * @property {string} [verified_on] - Timestamp of when the document was
853
- * verified, if applicable
980
+ * verified, if applicable.
854
981
  */
855
982
  /**
856
983
  * @typedef ProductBundle
857
- * @property {ProductGroupingModel[]} [items]
984
+ * @property {ProductGroupingModel[]} [items] - Represents list of
985
+ * bundles/product groupings.
858
986
  */
859
987
  /**
860
988
  * @typedef StoreV3
861
- * @property {number} [uid]
862
- * @property {string} [name]
863
- * @property {number} [count]
989
+ * @property {number} [uid] - The unique identifier for the store.
990
+ * @property {string} [name] - The name of the store.
991
+ * @property {number} [count] - The count associated with the store.
864
992
  */
865
993
  /**
866
994
  * @typedef ArticleAssignmentV3
867
- * @property {string} [strategy]
868
- * @property {string} [level]
995
+ * @property {string} [strategy] - Method used for article assignment, such as
996
+ * optimal, fast-delivery, low-price, or manual.
997
+ * @property {string} [level] - Scope of assignment, which can be
998
+ * multi-companies, single-company, or single-store.
869
999
  */
870
1000
  /**
871
1001
  * @typedef StrategyWiseListingSchemaV3
872
- * @property {number} [distance]
873
- * @property {number} [pincode]
874
- * @property {number} [tat]
875
- * @property {number} [quantity]
1002
+ * @property {number} [distance] - Distance between bullfight location and
1003
+ * customer location in kilometers. .
1004
+ * @property {number} [pincode] - Pincode mapped based on strategy.
1005
+ * @property {number} [tat] - Turn around Time to deliver the product with this strategy.
1006
+ * @property {number} [quantity] - The quantity available for assigned store.
876
1007
  */
877
1008
  /**
878
1009
  * @typedef DetailsSchemaV3
879
- * @property {string} [value]
880
- * @property {string} [type]
881
- * @property {string} [key]
1010
+ * @property {string} [value] - The value of the attribute.
1011
+ * @property {string} [type] - The type of detail e.g, text.
1012
+ * @property {string} [key] - The attribute key associated with the size.
882
1013
  */
883
1014
  /**
884
1015
  * @typedef SellerGroupAttributes
885
- * @property {string} [title]
886
- * @property {DetailsSchemaV3[]} [details]
1016
+ * @property {string} [title] - The title of the attribute group.
1017
+ * @property {DetailsSchemaV3[]} [details] - Detail of the attribute.
887
1018
  */
888
1019
  /**
889
1020
  * @typedef ReturnConfigSchemaV3
890
- * @property {string} [unit]
891
- * @property {boolean} [returnable]
892
- * @property {number} [time]
1021
+ * @property {string} [unit] - The unit for the return configuration.
1022
+ * @property {boolean} [returnable] - Indicates if the item is returnable.
1023
+ * @property {number} [time] - The time duration for the return policy.
893
1024
  */
894
1025
  /**
895
1026
  * @typedef ProductSetDistributionSizeV3
896
- * @property {number} [pieces]
897
- * @property {string} [size]
1027
+ * @property {number} [pieces] - The number of pieces available in this size.
1028
+ * @property {string} [size] - The size of the product.
898
1029
  */
899
1030
  /**
900
1031
  * @typedef ProductSetDistributionV3
901
- * @property {ProductSetDistributionSizeV3[]} [sizes]
1032
+ * @property {ProductSetDistributionSizeV3[]} [sizes] - A list of size
1033
+ * distributions in the product set.
902
1034
  */
903
1035
  /**
904
1036
  * @typedef ProductSetV3
905
- * @property {number} [quantity]
1037
+ * @property {number} [quantity] - The quantity of products in the set.
906
1038
  * @property {ProductSetDistributionV3} [size_distribution]
907
1039
  */
908
1040
  /**
@@ -910,7 +1042,7 @@ export = CatalogApplicationModel;
910
1042
  * @property {number} [effective] - The effective or final price for the product
911
1043
  * at the given pincode.
912
1044
  * @property {string} [currency_code] - The currency code for which the product
913
- * is available
1045
+ * is available.
914
1046
  * @property {string} [currency_symbol] - The currency symbol for the currency
915
1047
  * in which the product is available.
916
1048
  * @property {number} [marked] - The marked price of the product.
@@ -918,64 +1050,82 @@ export = CatalogApplicationModel;
918
1050
  */
919
1051
  /**
920
1052
  * @typedef ProductStockUnitPriceV3
921
- * @property {string} [unit]
922
- * @property {string} [currency_symbol]
923
- * @property {string} [currency_code]
924
- * @property {number} [price]
1053
+ * @property {string} [unit] - The unit of measure for the product.
1054
+ * @property {string} [currency_symbol] - The currency symbol for the unit price.
1055
+ * @property {string} [currency_code] - The currency code for the unit price.
1056
+ * @property {number} [price] - The unit price of the product.
925
1057
  */
926
1058
  /**
927
1059
  * @typedef MarketPlaceSttributesSchemaV3
928
- * @property {string} [title]
929
- * @property {DetailsSchemaV3[]} [details]
1060
+ * @property {string} [title] - The title of the attribute.
1061
+ * @property {DetailsSchemaV3[]} [details] - Detail of the attribute.
930
1062
  */
931
1063
  /**
932
1064
  * @typedef SellerV3
933
- * @property {number} [uid]
934
- * @property {string} [name]
935
- * @property {number} [count]
1065
+ * @property {number} [uid] - The unique identifier for the seller.
1066
+ * @property {string} [name] - The name of the seller.
1067
+ * @property {number} [count] - The store count serviceable by this seller.
936
1068
  */
937
1069
  /**
938
1070
  * @typedef PromiseSchema
939
- * @property {string} [min]
940
- * @property {string} [max]
1071
+ * @property {string} [min] - The minimum promise time.
1072
+ * @property {string} [max] - The maximum promise time.
941
1073
  */
942
1074
  /**
943
1075
  * @typedef ProductSizePriceResponseV3
944
1076
  * @property {StoreV3} [store]
945
1077
  * @property {ArticleAssignmentV3} [article_assignment]
946
- * @property {boolean} [is_cod]
947
- * @property {StrategyWiseListingSchemaV3[]} [strategy_wise_listing]
948
- * @property {number} [quantity]
949
- * @property {string} [item_type]
950
- * @property {SellerGroupAttributes[]} [grouped_attributes]
1078
+ * @property {boolean} [is_cod] - Whether Cash on Delivery (COD) is available
1079
+ * for this product. It is true if COD is available and false otherwise.
1080
+ * @property {StrategyWiseListingSchemaV3[]} [strategy_wise_listing] - Details
1081
+ * about serviceability attributes.
1082
+ * @property {number} [quantity] - Available quantity of the product in stock.
1083
+ * It shows the number of units available for purchase.
1084
+ * @property {string} [item_type] - Type of item, indicating the category or
1085
+ * nature of the product. Possible values are Standard, Composite, Wet, Digital.
1086
+ * @property {SellerGroupAttributes[]} [grouped_attributes] - Collection of
1087
+ * attributes grouped together, which provides detailed characteristics of the
1088
+ * product, such as color, size, material, etc.
951
1089
  * @property {ReturnConfigSchemaV3} [return_config]
952
- * @property {string} [article_id]
953
- * @property {boolean} [is_gift]
1090
+ * @property {string} [article_id] - This unique identifier is assigned to the
1091
+ * specific article. This represents item x size x location.
1092
+ * @property {boolean} [is_gift] - Whether the product can be purchased as a
1093
+ * gift. It is true if the product is available for gifting and false otherwise.
954
1094
  * @property {ProductSetV3} [set]
955
- * @property {number} [seller_count]
1095
+ * @property {number} [seller_count] - Number of sellers offering this product.
1096
+ * It indicates the level of competition and availability from different sellers.
956
1097
  * @property {ProductStockPriceV3} [price_per_piece]
957
1098
  * @property {DiscountMeta} [discount_meta]
958
- * @property {string} [discount]
959
- * @property {number[]} [long_lat]
960
- * @property {string} [special_badge]
1099
+ * @property {string} [discount] - Amount or percentage of discount applied to
1100
+ * the product's price, showing the savings for the customer.
1101
+ * @property {number[]} [long_lat] - Longitude and latitude coordinates,
1102
+ * possibly indicating the location of the store or warehouse where the
1103
+ * product is stocked.
1104
+ * @property {string} [special_badge] - Special badges or labels assigned to the
1105
+ * product, such as "Bestseller," "New Arrival," or "Limited Edition.".
961
1106
  * @property {ProductStockPriceV3} [price]
962
1107
  * @property {ProductStockUnitPriceV3} [price_per_unit]
963
- * @property {number} [pincode]
964
- * @property {MarketPlaceSttributesSchemaV3[]} [marketplace_attributes]
1108
+ * @property {number} [pincode] - Postal code or zip code for which the
1109
+ * product's availability and delivery options are being checked.
1110
+ * @property {MarketPlaceSttributesSchemaV3[]} [marketplace_attributes] -
1111
+ * Attributes specific to the marketplace, such as ratings, reviews, shipping
1112
+ * options, and other marketplace-specific details.
965
1113
  * @property {SellerV3} [seller]
966
1114
  * @property {PromiseSchema} [delivery_promise]
967
1115
  */
968
1116
  /**
969
1117
  * @typedef ProductSizeSellerFilterSchemaV3
970
- * @property {string} [name]
971
- * @property {boolean} [is_selected]
972
- * @property {string} [value]
1118
+ * @property {string} [name] - The name of the store/seller.
1119
+ * @property {boolean} [is_selected] - Whether this filter criterion is selected.
1120
+ * @property {string} [value] - The value associated with this store/seller.
973
1121
  */
974
1122
  /**
975
1123
  * @typedef ProductSizeSellersResponseV3
976
- * @property {ProductSizePriceResponseV3[]} [items]
1124
+ * @property {ProductSizePriceResponseV3[]} [items] - A list of products with
1125
+ * size and price details available from various sellers.
977
1126
  * @property {Page} page
978
- * @property {ProductSizeSellerFilterSchemaV3[]} [sort_on]
1127
+ * @property {ProductSizeSellerFilterSchemaV3[]} [sort_on] - A list of sorting
1128
+ * and filtering criteria applied to the sellers' data.
979
1129
  */
980
1130
  declare class CatalogApplicationModel {
981
1131
  }
@@ -985,51 +1135,107 @@ declare namespace CatalogApplicationModel {
985
1135
  /** @returns {ProductDetailCustomOrder} */
986
1136
  declare function ProductDetailCustomOrder(): ProductDetailCustomOrder;
987
1137
  type ProductDetailCustomOrder = {
1138
+ /**
1139
+ * - The unit of time taken for manufacturing.
1140
+ */
988
1141
  manufacturing_time?: number;
1142
+ /**
1143
+ * - The unit of time required for
1144
+ * manufacturing is defined in hours or days.
1145
+ */
989
1146
  manufacturing_time_unit?: string;
1147
+ /**
1148
+ * - A boolean flag indicating whether MTO
1149
+ * (Make to Order) is enabled or not.
1150
+ */
990
1151
  is_custom_order?: boolean;
991
1152
  };
992
1153
  /** @returns {Meta} */
993
1154
  declare function Meta(): Meta;
994
1155
  type Meta = {
1156
+ /**
1157
+ * - The source or origin of the media file, which
1158
+ * could be a URL or a reference to where the media was obtained.
1159
+ */
995
1160
  source?: string;
996
1161
  };
997
1162
  /** @returns {Media} */
998
1163
  declare function Media(): Media;
999
1164
  type Media = {
1165
+ /**
1166
+ * - Absolute url for Media.
1167
+ */
1000
1168
  url?: string;
1169
+ /**
1170
+ * - The type of media, such as image, video.
1171
+ */
1001
1172
  type?: string;
1002
1173
  meta?: Meta;
1174
+ /**
1175
+ * - Alternative text for the media, used for
1176
+ * accessibility and SEO purposes.
1177
+ */
1003
1178
  alt?: string;
1004
1179
  };
1005
1180
  /** @returns {ProductListingActionPage} */
1006
1181
  declare function ProductListingActionPage(): ProductListingActionPage;
1007
1182
  type ProductListingActionPage = {
1183
+ /**
1184
+ * - The type of action such as product, products,
1185
+ * category, brand.
1186
+ */
1008
1187
  type?: string;
1188
+ /**
1189
+ * - Query parameter if any to be added to the action.
1190
+ */
1009
1191
  query?: any;
1192
+ /**
1193
+ * - Parameters that should be considered in path.
1194
+ */
1010
1195
  params?: any;
1011
1196
  };
1012
1197
  /** @returns {ProductListingAction} */
1013
1198
  declare function ProductListingAction(): ProductListingAction;
1014
1199
  type ProductListingAction = {
1200
+ /**
1201
+ * - Type of action to be taken e.g, page.
1202
+ */
1015
1203
  type?: string;
1016
1204
  page?: ProductListingActionPage;
1017
1205
  };
1018
1206
  /** @returns {ProductBrand} */
1019
1207
  declare function ProductBrand(): ProductBrand;
1020
1208
  type ProductBrand = {
1209
+ /**
1210
+ * - Unique identifier for the product brand.
1211
+ */
1021
1212
  uid?: number;
1022
1213
  logo?: Media;
1214
+ /**
1215
+ * - Description of the product brand.
1216
+ */
1023
1217
  description?: string;
1218
+ /**
1219
+ * - Name of the product brand.
1220
+ */
1024
1221
  name?: string;
1025
1222
  action?: ProductListingAction;
1026
1223
  };
1027
1224
  /** @returns {ProductDepartment} */
1028
1225
  declare function ProductDepartment(): ProductDepartment;
1029
1226
  type ProductDepartment = {
1227
+ /**
1228
+ * - Unique identifier for the product department.
1229
+ */
1030
1230
  uid?: number;
1031
1231
  logo?: Media;
1232
+ /**
1233
+ * - URL-friendly identifier for the product department.
1234
+ */
1032
1235
  slug?: string;
1236
+ /**
1237
+ * - Name of the product department.
1238
+ */
1033
1239
  name?: string;
1034
1240
  };
1035
1241
  /** @returns {ProductCategoryMap} */
@@ -1068,25 +1274,41 @@ type CustomMetaFields = {
1068
1274
  declare function ApplicationItemSEO(): ApplicationItemSEO;
1069
1275
  type ApplicationItemSEO = {
1070
1276
  /**
1071
- * - The SEO title of the item
1277
+ * - The SEO title of the item.
1072
1278
  */
1073
1279
  title?: any;
1074
1280
  /**
1075
- * - The SEO description of the item
1281
+ * - The SEO description of the item.
1076
1282
  */
1077
1283
  description?: any;
1078
1284
  };
1079
1285
  /** @returns {ProductDetailAttribute} */
1080
1286
  declare function ProductDetailAttribute(): ProductDetailAttribute;
1081
1287
  type ProductDetailAttribute = {
1288
+ /**
1289
+ * - The value of the product attribute.
1290
+ */
1082
1291
  value?: string;
1292
+ /**
1293
+ * - The type or category of the product attribute.
1294
+ */
1083
1295
  type?: string;
1296
+ /**
1297
+ * - The key or name of the product attribute.
1298
+ */
1084
1299
  key?: string;
1085
1300
  };
1086
1301
  /** @returns {ProductDetailGroupedAttribute} */
1087
1302
  declare function ProductDetailGroupedAttribute(): ProductDetailGroupedAttribute;
1088
1303
  type ProductDetailGroupedAttribute = {
1304
+ /**
1305
+ * - The title or name of the attribute group.
1306
+ */
1089
1307
  title?: string;
1308
+ /**
1309
+ * - A list of product attributes
1310
+ * within this group.
1311
+ */
1090
1312
  details?: ProductDetailAttribute[];
1091
1313
  };
1092
1314
  /** @returns {ApplicationItemMOQ} */
@@ -1144,70 +1366,170 @@ type ProductSizesPrice = {
1144
1366
  /** @returns {ProductDetail} */
1145
1367
  declare function ProductDetail(): ProductDetail;
1146
1368
  type ProductDetail = {
1369
+ /**
1370
+ * - Unique identifier for the product.
1371
+ */
1147
1372
  uid?: number;
1148
1373
  custom_order?: ProductDetailCustomOrder;
1149
1374
  category_map?: ProductCategoryMap;
1150
1375
  net_quantity?: NetQuantity;
1376
+ /**
1377
+ * - Count of ratings the product has received.
1378
+ */
1151
1379
  rating_count?: number;
1380
+ /**
1381
+ * - Custom metadata fields
1382
+ * associated with the product.
1383
+ */
1152
1384
  _custom_meta?: CustomMetaFields[];
1385
+ /**
1386
+ * - List of products marked similar to given product.
1387
+ */
1153
1388
  similars?: string[];
1389
+ /**
1390
+ * - Tags associated with the product for better
1391
+ * categorization.
1392
+ */
1154
1393
  tags?: string[];
1155
1394
  seo?: ApplicationItemSEO;
1395
+ /**
1396
+ * - Type of the images associated with the
1397
+ * product such as standard.
1398
+ */
1156
1399
  image_nature?: string;
1400
+ /**
1401
+ * - Indicates whether the product has variants.
1402
+ */
1157
1403
  has_variant?: boolean;
1404
+ /**
1405
+ * - This field describes the type of item,
1406
+ * indicating the category or nature of the product. Possible values are
1407
+ * Standard, Composite, Wet, Digital.
1408
+ */
1158
1409
  item_type?: string;
1410
+ /**
1411
+ * - Detailed description of the product.
1412
+ */
1159
1413
  description?: string;
1414
+ /**
1415
+ * - Grouped
1416
+ * attributes detailing various characteristics of the product.
1417
+ */
1160
1418
  grouped_attributes?: ProductDetailGroupedAttribute[];
1419
+ /**
1420
+ * - Media files associated with the product.
1421
+ */
1161
1422
  medias?: Media[];
1423
+ /**
1424
+ * - Color of the product, if applicable.
1425
+ */
1162
1426
  color?: string;
1427
+ /**
1428
+ * - Product type or classification.
1429
+ */
1163
1430
  type?: string;
1431
+ /**
1432
+ * - Date and time when the product was
1433
+ * made available online.
1434
+ */
1164
1435
  product_online_date?: string;
1436
+ /**
1437
+ * - Custom JSON object for additional product data.
1438
+ */
1165
1439
  _custom_json?: any;
1440
+ /**
1441
+ * - Item Code defined for the product.
1442
+ */
1166
1443
  item_code?: string;
1444
+ /**
1445
+ * - Name of the product.
1446
+ */
1167
1447
  name?: string;
1168
1448
  moq?: ApplicationItemMOQ;
1449
+ /**
1450
+ * - Brief description of the product.
1451
+ */
1169
1452
  short_description?: string;
1453
+ /**
1454
+ * - List of product categories
1455
+ * associated with the product.
1456
+ */
1170
1457
  categories?: ProductBrand[];
1458
+ /**
1459
+ * - Additional attributes or characteristics of
1460
+ * the product.
1461
+ */
1171
1462
  attributes?: any;
1463
+ /**
1464
+ * - Discount applied to the product, if any.
1465
+ */
1172
1466
  discount?: string;
1467
+ /**
1468
+ * - Identifiers or names of tryout versions of
1469
+ * the product.
1470
+ */
1173
1471
  tryouts?: string[];
1472
+ /**
1473
+ * - URL-friendly identifier for the product.
1474
+ */
1174
1475
  slug: string;
1175
1476
  action?: ProductListingAction;
1477
+ /**
1478
+ * - The rating of the product.
1479
+ */
1176
1480
  rating?: number;
1481
+ /**
1482
+ * - Indicates whether the product can be
1483
+ * sold as an individual product.
1484
+ */
1177
1485
  is_dependent?: boolean;
1486
+ /**
1487
+ * - List of bundle/product grouping
1488
+ * slugs mapped to the product.
1489
+ */
1178
1490
  product_group_tag?: string[];
1491
+ /**
1492
+ * - Key highlights or features of the product.
1493
+ */
1179
1494
  highlights?: string[];
1180
1495
  price?: ProductListingPrice;
1181
1496
  brand?: ProductBrand;
1182
1497
  department?: ProductDepartment;
1498
+ /**
1499
+ * - Teaser tag or short promotional phrase for
1500
+ * the product.
1501
+ */
1183
1502
  teaser_tag?: string;
1184
1503
  };
1185
1504
  /** @returns {ErrorResponse} */
1186
1505
  declare function ErrorResponse(): ErrorResponse;
1187
1506
  type ErrorResponse = {
1507
+ /**
1508
+ * - A brief description of the error.
1509
+ */
1188
1510
  error?: string;
1189
1511
  };
1190
1512
  /** @returns {Dimension} */
1191
1513
  declare function Dimension(): Dimension;
1192
1514
  type Dimension = {
1193
1515
  /**
1194
- * - The unit of dimension
1516
+ * - The unit of dimension.
1195
1517
  */
1196
1518
  unit: string;
1197
1519
  /**
1198
- * - The height of the product
1520
+ * - The height of the product.
1199
1521
  */
1200
1522
  height: number;
1201
1523
  /**
1202
- * - The length of the product
1524
+ * - The length of the product.
1203
1525
  */
1204
1526
  length: number;
1205
1527
  /**
1206
- * - The width of the product
1528
+ * - The width of the product.
1207
1529
  */
1208
1530
  width: number;
1209
1531
  /**
1210
- * - Whether the dimension is the default one or not
1532
+ * - Whether the dimension is the default one or not.
1211
1533
  */
1212
1534
  is_default: boolean;
1213
1535
  };
@@ -1215,15 +1537,15 @@ type Dimension = {
1215
1537
  declare function Weight(): Weight;
1216
1538
  type Weight = {
1217
1539
  /**
1218
- * - The unit of weight
1540
+ * - The unit of weight.
1219
1541
  */
1220
1542
  unit: string;
1221
1543
  /**
1222
- * - The shipping weight of the product
1544
+ * - The shipping weight of the product.
1223
1545
  */
1224
1546
  shipping: number;
1225
1547
  /**
1226
- * - Whether the weight is the default one or not
1548
+ * - Whether the weight is the default one or not.
1227
1549
  */
1228
1550
  is_default: boolean;
1229
1551
  };
@@ -1252,28 +1574,70 @@ type DiscountMeta = {
1252
1574
  /** @returns {ProductSize} */
1253
1575
  declare function ProductSize(): ProductSize;
1254
1576
  type ProductSize = {
1577
+ /**
1578
+ * - The quantity of the product size available.
1579
+ */
1255
1580
  quantity?: number;
1256
1581
  dimension?: Dimension;
1257
1582
  weight?: Weight;
1583
+ /**
1584
+ * - Indicates whether the product size is
1585
+ * available for purchase.
1586
+ */
1258
1587
  is_available?: boolean;
1588
+ /**
1589
+ * - List of identifiers used by
1590
+ * sellers for the product size.
1591
+ */
1259
1592
  seller_identifiers?: string[];
1593
+ /**
1594
+ * - The value or label representing the product size.
1595
+ */
1260
1596
  value?: string;
1597
+ /**
1598
+ * - Display name of the product size.
1599
+ */
1261
1600
  display?: string;
1262
1601
  };
1263
1602
  /** @returns {SizeChartValues} */
1264
1603
  declare function SizeChartValues(): SizeChartValues;
1265
1604
  type SizeChartValues = {
1605
+ /**
1606
+ * - Value for column 3.
1607
+ */
1266
1608
  col_3?: string;
1609
+ /**
1610
+ * - Value for column 6.
1611
+ */
1267
1612
  col_6?: string;
1613
+ /**
1614
+ * - Value for column 2.
1615
+ */
1268
1616
  col_2?: string;
1617
+ /**
1618
+ * - Value for column 4.
1619
+ */
1269
1620
  col_4?: string;
1621
+ /**
1622
+ * - Value for column 1.
1623
+ */
1270
1624
  col_1?: string;
1625
+ /**
1626
+ * - Value for column 5.
1627
+ */
1271
1628
  col_5?: string;
1272
1629
  };
1273
1630
  /** @returns {ColumnHeader} */
1274
1631
  declare function ColumnHeader(): ColumnHeader;
1275
1632
  type ColumnHeader = {
1633
+ /**
1634
+ * - Indicates if the column value can be
1635
+ * converted or transformed.
1636
+ */
1276
1637
  convertable?: boolean;
1638
+ /**
1639
+ * - The value or title of the column header.
1640
+ */
1277
1641
  value?: string;
1278
1642
  };
1279
1643
  /** @returns {ColumnHeaders} */
@@ -1289,28 +1653,61 @@ type ColumnHeaders = {
1289
1653
  /** @returns {SizeChart} */
1290
1654
  declare function SizeChart(): SizeChart;
1291
1655
  type SizeChart = {
1656
+ /**
1657
+ * - Unit of measurement used in the size chart (e.g., in, cm).
1658
+ */
1292
1659
  unit?: string;
1660
+ /**
1661
+ * - URL of the image representing the size chart.
1662
+ */
1293
1663
  image?: string;
1664
+ /**
1665
+ * - Additional tip or guideline related to sizing.
1666
+ */
1294
1667
  size_tip?: string;
1668
+ /**
1669
+ * - Array of size chart values for different sizes.
1670
+ */
1295
1671
  sizes?: SizeChartValues[];
1672
+ /**
1673
+ * - Description related to the size chart.
1674
+ */
1296
1675
  description?: string;
1676
+ /**
1677
+ * - Title or name of the size chart.
1678
+ */
1297
1679
  title?: string;
1298
1680
  headers?: ColumnHeaders;
1299
1681
  };
1300
1682
  /** @returns {ProductSizeStores} */
1301
1683
  declare function ProductSizeStores(): ProductSizeStores;
1302
1684
  type ProductSizeStores = {
1685
+ /**
1686
+ * - Number of stores where the product size is available.
1687
+ */
1303
1688
  count?: number;
1304
1689
  };
1305
1690
  /** @returns {ProductSizes} */
1306
1691
  declare function ProductSizes(): ProductSizes;
1307
1692
  type ProductSizes = {
1693
+ /**
1694
+ * - List of available sizes for the product.
1695
+ */
1308
1696
  sizes?: ProductSize[];
1309
1697
  price?: ProductSizesPrice;
1310
1698
  price_per_piece?: ProductSizesPrice;
1311
1699
  size_chart?: SizeChart;
1700
+ /**
1701
+ * - Whether the product sizes are available for sale.
1702
+ */
1312
1703
  sellable?: boolean;
1704
+ /**
1705
+ * - Whether the product supports multiple sizes.
1706
+ */
1313
1707
  multi_size?: boolean;
1708
+ /**
1709
+ * - Discount information applicable to the product sizes.
1710
+ */
1314
1711
  discount?: string;
1315
1712
  stores?: ProductSizeStores;
1316
1713
  discount_meta?: DiscountMeta;
@@ -1318,29 +1715,68 @@ type ProductSizes = {
1318
1715
  /** @returns {AttributeDetail} */
1319
1716
  declare function AttributeDetail(): AttributeDetail;
1320
1717
  type AttributeDetail = {
1718
+ /**
1719
+ * - URL or path to the logo associated with the attribute.
1720
+ */
1321
1721
  logo?: string;
1722
+ /**
1723
+ * - A description of the attribute.
1724
+ */
1322
1725
  description?: string;
1726
+ /**
1727
+ * - Display name or label for the attribute.
1728
+ */
1323
1729
  display?: string;
1730
+ /**
1731
+ * - Unique key or identifier for the attribute.
1732
+ */
1324
1733
  key?: string;
1325
1734
  };
1326
1735
  /** @returns {AttributeMetadata} */
1327
1736
  declare function AttributeMetadata(): AttributeMetadata;
1328
1737
  type AttributeMetadata = {
1738
+ /**
1739
+ * - Title or name of the attribute metadata.
1740
+ */
1329
1741
  title?: string;
1742
+ /**
1743
+ * - List of detailed information about
1744
+ * attributes.
1745
+ */
1330
1746
  details?: AttributeDetail[];
1331
1747
  };
1332
1748
  /** @returns {ProductsComparisonResponse} */
1333
1749
  declare function ProductsComparisonResponse(): ProductsComparisonResponse;
1334
1750
  type ProductsComparisonResponse = {
1751
+ /**
1752
+ * - List of product details for comparison.
1753
+ */
1335
1754
  items?: ProductDetail[];
1755
+ /**
1756
+ * - Metadata about
1757
+ * attributes used for comparing products.
1758
+ */
1336
1759
  attributes_metadata?: AttributeMetadata[];
1337
1760
  };
1338
1761
  /** @returns {ProductCompareResponse} */
1339
1762
  declare function ProductCompareResponse(): ProductCompareResponse;
1340
1763
  type ProductCompareResponse = {
1764
+ /**
1765
+ * - Title or name of the comparison.
1766
+ */
1341
1767
  title?: string;
1768
+ /**
1769
+ * - List of product details for comparison.
1770
+ */
1342
1771
  items?: ProductDetail[];
1772
+ /**
1773
+ * - Metadata about
1774
+ * attributes used for comparing products.
1775
+ */
1343
1776
  attributes_metadata?: AttributeMetadata[];
1777
+ /**
1778
+ * - Subtitle or additional description for the comparison.
1779
+ */
1344
1780
  subtitle?: string;
1345
1781
  };
1346
1782
  /** @returns {ProductFrequentlyComparedSimilarResponse} */
@@ -1351,194 +1787,540 @@ type ProductFrequentlyComparedSimilarResponse = {
1351
1787
  /** @returns {ProductVariantItemResponse} */
1352
1788
  declare function ProductVariantItemResponse(): ProductVariantItemResponse;
1353
1789
  type ProductVariantItemResponse = {
1790
+ /**
1791
+ * - Unique identifier for the product variant.
1792
+ */
1354
1793
  uid?: number;
1794
+ /**
1795
+ * - Name of the color for the variant.
1796
+ */
1355
1797
  color_name?: string;
1798
+ /**
1799
+ * - Color code or representation for the variant.
1800
+ */
1356
1801
  color?: string;
1802
+ /**
1803
+ * - Media files associated with the product variant.
1804
+ */
1357
1805
  medias?: Media[];
1806
+ /**
1807
+ * - Indicates whether the product variant is
1808
+ * available for purchase.
1809
+ */
1358
1810
  is_available?: boolean;
1811
+ /**
1812
+ * - Custom metadata fields
1813
+ * associated with the product.
1814
+ */
1359
1815
  _custom_meta?: CustomMetaFields[];
1816
+ /**
1817
+ * - Name of the product variant.
1818
+ */
1360
1819
  name?: string;
1820
+ /**
1821
+ * - Value or label representing the product variant.
1822
+ */
1361
1823
  value?: string;
1824
+ /**
1825
+ * - URL-friendly identifier for the product.
1826
+ */
1362
1827
  slug?: string;
1828
+ /**
1829
+ * - Custom JSON object for additional data
1830
+ * related to the product.
1831
+ */
1363
1832
  _custom_json?: any;
1364
1833
  action?: ProductListingAction;
1365
1834
  };
1366
1835
  /** @returns {ProductVariantResponse} */
1367
1836
  declare function ProductVariantResponse(): ProductVariantResponse;
1368
1837
  type ProductVariantResponse = {
1838
+ /**
1839
+ * - The type of display for the product
1840
+ * variant (e.g., image, text, image, color).
1841
+ */
1369
1842
  display_type?: string;
1843
+ /**
1844
+ * - Header or title for the product variant section.
1845
+ */
1370
1846
  header?: string;
1847
+ /**
1848
+ * - Group ID used to group variants.
1849
+ */
1371
1850
  group_id?: string;
1851
+ /**
1852
+ * - List of product variant items.
1853
+ */
1372
1854
  items?: ProductVariantItemResponse[];
1855
+ /**
1856
+ * - Attribute identifier of the variant.
1857
+ */
1373
1858
  key?: string;
1859
+ /**
1860
+ * - URL or path to the logo associated with the
1861
+ * product variant.
1862
+ */
1374
1863
  logo?: string;
1375
1864
  };
1376
1865
  /** @returns {ProductVariantsResponse} */
1377
1866
  declare function ProductVariantsResponse(): ProductVariantsResponse;
1378
1867
  type ProductVariantsResponse = {
1868
+ /**
1869
+ * - A list of product variant
1870
+ * responses, each detailing a specific variant.
1871
+ */
1379
1872
  variants?: ProductVariantResponse[];
1380
1873
  };
1381
1874
  /** @returns {StoreDetail} */
1382
1875
  declare function StoreDetail(): StoreDetail;
1383
1876
  type StoreDetail = {
1877
+ /**
1878
+ * - NA.
1879
+ */
1384
1880
  name?: string;
1881
+ /**
1882
+ * - NA.
1883
+ */
1385
1884
  city?: string;
1885
+ /**
1886
+ * - NA.
1887
+ */
1386
1888
  id?: number;
1889
+ /**
1890
+ * - NA.
1891
+ */
1387
1892
  code?: string;
1388
1893
  };
1389
1894
  /** @returns {ProductStockPrice} */
1390
1895
  declare function ProductStockPrice(): ProductStockPrice;
1391
1896
  type ProductStockPrice = {
1897
+ /**
1898
+ * - NA.
1899
+ */
1392
1900
  effective?: number;
1901
+ /**
1902
+ * - NA.
1903
+ */
1393
1904
  currency?: string;
1905
+ /**
1906
+ * - NA.
1907
+ */
1394
1908
  marked?: number;
1395
1909
  };
1396
1910
  /** @returns {CompanyDetail} */
1397
1911
  declare function CompanyDetail(): CompanyDetail;
1398
1912
  type CompanyDetail = {
1913
+ /**
1914
+ * - NA.
1915
+ */
1399
1916
  name?: string;
1917
+ /**
1918
+ * - NA.
1919
+ */
1400
1920
  id?: number;
1401
1921
  };
1402
1922
  /** @returns {Seller} */
1403
1923
  declare function Seller(): Seller;
1404
1924
  type Seller = {
1925
+ /**
1926
+ * - NA.
1927
+ */
1405
1928
  uid?: number;
1929
+ /**
1930
+ * - NA.
1931
+ */
1406
1932
  name?: string;
1933
+ /**
1934
+ * - NA.
1935
+ */
1407
1936
  count?: number;
1408
1937
  };
1409
1938
  /** @returns {ProductStockStatusItem} */
1410
1939
  declare function ProductStockStatusItem(): ProductStockStatusItem;
1411
1940
  type ProductStockStatusItem = {
1941
+ /**
1942
+ * - NA.
1943
+ */
1412
1944
  uid?: string;
1945
+ /**
1946
+ * - NA.
1947
+ */
1413
1948
  quantity?: number;
1414
1949
  store?: StoreDetail;
1950
+ /**
1951
+ * - NA.
1952
+ */
1415
1953
  size?: string;
1416
1954
  price?: ProductStockPrice;
1417
1955
  company?: CompanyDetail;
1956
+ /**
1957
+ * - NA.
1958
+ */
1418
1959
  item_id?: number;
1419
1960
  seller?: Seller;
1961
+ /**
1962
+ * - NA.
1963
+ */
1420
1964
  identifier?: any;
1421
1965
  };
1422
1966
  /** @returns {ProductStockStatusResponse} */
1423
1967
  declare function ProductStockStatusResponse(): ProductStockStatusResponse;
1424
1968
  type ProductStockStatusResponse = {
1969
+ /**
1970
+ * - NA.
1971
+ */
1425
1972
  items?: ProductStockStatusItem[];
1426
1973
  };
1427
1974
  /** @returns {Page} */
1428
1975
  declare function Page(): Page;
1429
1976
  type Page = {
1977
+ /**
1978
+ * - The total number of items on the page.
1979
+ */
1430
1980
  item_total?: number;
1981
+ /**
1982
+ * - The identifier for the next page.
1983
+ */
1431
1984
  next_id?: string;
1985
+ /**
1986
+ * - Indicates whether there is a previous page.
1987
+ */
1432
1988
  has_previous?: boolean;
1989
+ /**
1990
+ * - Indicates whether there is a next page.
1991
+ */
1433
1992
  has_next?: boolean;
1993
+ /**
1994
+ * - The current page number.
1995
+ */
1434
1996
  current?: number;
1997
+ /**
1998
+ * - The type of the page, such as 'PageType'.
1999
+ */
1435
2000
  type: string;
2001
+ /**
2002
+ * - The number of items per page.
2003
+ */
1436
2004
  size?: number;
1437
2005
  };
1438
2006
  /** @returns {ProductStockPolling} */
1439
2007
  declare function ProductStockPolling(): ProductStockPolling;
1440
2008
  type ProductStockPolling = {
2009
+ /**
2010
+ * - NA.
2011
+ */
1441
2012
  items?: ProductStockStatusItem[];
1442
2013
  page: Page;
1443
2014
  };
1444
2015
  /** @returns {ProductVariantListingResponse} */
1445
2016
  declare function ProductVariantListingResponse(): ProductVariantListingResponse;
1446
2017
  type ProductVariantListingResponse = {
2018
+ /**
2019
+ * - Header or title for the product variant section.
2020
+ */
1447
2021
  header?: string;
2022
+ /**
2023
+ * - List of Upto 5 product
2024
+ * variant items.
2025
+ */
1448
2026
  items?: ProductVariantItemResponse[];
2027
+ /**
2028
+ * - The total number of product variants available.
2029
+ */
1449
2030
  total?: number;
2031
+ /**
2032
+ * - Attribute identifier of the variant.
2033
+ */
1450
2034
  key?: string;
2035
+ /**
2036
+ * - The type of display for the product
2037
+ * variant (e.g., image, text, image, color).
2038
+ */
1451
2039
  display_type?: string;
1452
2040
  };
1453
2041
  /** @returns {ProductListingDetail} */
1454
2042
  declare function ProductListingDetail(): ProductListingDetail;
1455
2043
  type ProductListingDetail = {
2044
+ /**
2045
+ * - Unique identifier for the product.
2046
+ */
1456
2047
  uid?: number;
1457
2048
  custom_order?: ProductDetailCustomOrder;
2049
+ /**
2050
+ * - Available sizes for the product.
2051
+ */
1458
2052
  sizes?: string[];
1459
2053
  category_map?: ProductCategoryMap;
1460
2054
  net_quantity?: NetQuantity;
2055
+ /**
2056
+ * - The number of ratings the product has received.
2057
+ */
1461
2058
  rating_count?: number;
2059
+ /**
2060
+ * - Custom metadata fields
2061
+ * associated with the product.
2062
+ */
1462
2063
  _custom_meta?: CustomMetaFields[];
2064
+ /**
2065
+ * - List of products marked similar to given product.
2066
+ */
1463
2067
  similars?: string[];
2068
+ /**
2069
+ * - Tags associated with the product for better
2070
+ * categorization.
2071
+ */
1464
2072
  tags?: string[];
1465
2073
  seo?: ApplicationItemSEO;
2074
+ /**
2075
+ * - Type of the images associated with the
2076
+ * product such as standard.
2077
+ */
1466
2078
  image_nature?: string;
2079
+ /**
2080
+ * - Indicates whether the product has variants.
2081
+ */
1467
2082
  has_variant?: boolean;
2083
+ /**
2084
+ * - This field describes the type of item,
2085
+ * indicating the category or nature of the product. Possible values are
2086
+ * Standard, Composite, Wet, Digital.
2087
+ */
1468
2088
  item_type?: string;
2089
+ /**
2090
+ * - Detailed description of the product.
2091
+ */
1469
2092
  description?: string;
2093
+ /**
2094
+ * - Grouped
2095
+ * attributes detailing various characteristics of the product.
2096
+ */
1470
2097
  grouped_attributes?: ProductDetailGroupedAttribute[];
2098
+ /**
2099
+ * - Media files associated with the product.
2100
+ */
1471
2101
  medias?: Media[];
2102
+ /**
2103
+ * - Color of the product, if applicable.
2104
+ */
1472
2105
  color?: string;
2106
+ /**
2107
+ * - Product type or classification.
2108
+ */
1473
2109
  type?: string;
2110
+ /**
2111
+ * - Date and time when the product was
2112
+ * made available online.
2113
+ */
1474
2114
  product_online_date?: string;
2115
+ /**
2116
+ * - Custom JSON object for additional product data.
2117
+ */
1475
2118
  _custom_json?: any;
2119
+ /**
2120
+ * - Item Code defined for the product.
2121
+ */
1476
2122
  item_code?: string;
2123
+ /**
2124
+ * - Name of the product.
2125
+ */
1477
2126
  name?: string;
1478
2127
  moq?: ApplicationItemMOQ;
2128
+ /**
2129
+ * - Brief description of the product.
2130
+ */
1479
2131
  short_description?: string;
2132
+ /**
2133
+ * - List of product categories
2134
+ * associated with the product.
2135
+ */
1480
2136
  categories?: ProductBrand[];
2137
+ /**
2138
+ * - Indicates whether the product is available for sale.
2139
+ */
1481
2140
  sellable?: boolean;
2141
+ /**
2142
+ * - Additional attributes or characteristics of
2143
+ * the product.
2144
+ */
1482
2145
  attributes?: any;
2146
+ /**
2147
+ * - List of product
2148
+ * variants available for the product.
2149
+ */
1483
2150
  variants?: ProductVariantListingResponse[];
2151
+ /**
2152
+ * - Discount details or percentage applied to the product.
2153
+ */
1484
2154
  discount?: string;
2155
+ /**
2156
+ * - List of tryout options available for the product.
2157
+ */
1485
2158
  tryouts?: string[];
2159
+ /**
2160
+ * - List of seller identifiers for the product.
2161
+ */
1486
2162
  identifiers?: string[];
2163
+ /**
2164
+ * - URL-friendly identifier for the product.
2165
+ */
1487
2166
  slug: string;
1488
2167
  action?: ProductListingAction;
2168
+ /**
2169
+ * - Rating of the product.
2170
+ */
1489
2171
  rating?: number;
2172
+ /**
2173
+ * - Indicates whether the product can be
2174
+ * sold as an individual product.
2175
+ */
1490
2176
  is_dependent?: boolean;
2177
+ /**
2178
+ * - List of bundle/product grouping
2179
+ * slugs mapped to the product.
2180
+ */
1491
2181
  product_group_tag?: string[];
2182
+ /**
2183
+ * - Key highlights or features of the product.
2184
+ */
1492
2185
  highlights?: string[];
1493
2186
  price?: ProductListingPrice;
1494
2187
  brand?: ProductBrand;
2188
+ /**
2189
+ * - Teaser tag or short promotional phrase for
2190
+ * the product.
2191
+ */
1495
2192
  teaser_tag?: string;
1496
2193
  };
1497
2194
  /** @returns {ProductFiltersValue} */
1498
2195
  declare function ProductFiltersValue(): ProductFiltersValue;
1499
2196
  type ProductFiltersValue = {
2197
+ /**
2198
+ * - Minimum value for the range filter.
2199
+ */
1500
2200
  min?: number;
2201
+ /**
2202
+ * - Format in which the filter value is displayed.
2203
+ */
1501
2204
  display_format?: string;
2205
+ /**
2206
+ * - The maximum value selected by the user
2207
+ * for range filter.
2208
+ */
1502
2209
  selected_max?: number;
2210
+ /**
2211
+ * - Value associated with the filter option.
2212
+ */
1503
2213
  value?: string;
2214
+ /**
2215
+ * - Format used for the filter value in queries.
2216
+ */
1504
2217
  query_format?: string;
2218
+ /**
2219
+ * - Currency symbol for the price type filters.
2220
+ */
1505
2221
  currency_symbol?: string;
2222
+ /**
2223
+ * - The minimum value selected by the user
2224
+ * for range filter.
2225
+ */
1506
2226
  selected_min?: number;
2227
+ /**
2228
+ * - Currency code for the currency used for
2229
+ * price type filters.
2230
+ */
1507
2231
  currency_code?: string;
2232
+ /**
2233
+ * - Whether this filter value is currently selected.
2234
+ */
1508
2235
  is_selected: boolean;
2236
+ /**
2237
+ * - Display name or label for the filter value.
2238
+ */
1509
2239
  display: string;
2240
+ /**
2241
+ * - Number of products that match this filter value.
2242
+ */
1510
2243
  count?: number;
2244
+ /**
2245
+ * - Maximum value of the filter range.
2246
+ */
1511
2247
  max?: number;
1512
2248
  };
1513
2249
  /** @returns {ProductFiltersKey} */
1514
2250
  declare function ProductFiltersKey(): ProductFiltersKey;
1515
2251
  type ProductFiltersKey = {
2252
+ /**
2253
+ * - URL or path to the logo associated with the filter key.
2254
+ */
1516
2255
  logo?: string;
2256
+ /**
2257
+ * - Name or identifier of the filter key.
2258
+ */
1517
2259
  name: string;
2260
+ /**
2261
+ * - Type or category of the filter key (e.g., range,
2262
+ * multivalued).
2263
+ */
1518
2264
  kind?: string;
2265
+ /**
2266
+ * - Display name or label for the filter key.
2267
+ */
1519
2268
  display: string;
1520
2269
  };
1521
2270
  /** @returns {ProductFilters} */
1522
2271
  declare function ProductFilters(): ProductFilters;
1523
2272
  type ProductFilters = {
2273
+ /**
2274
+ * - List of filter values associated
2275
+ * with the filter key.
2276
+ */
1524
2277
  values: ProductFiltersValue[];
1525
2278
  key: ProductFiltersKey;
1526
2279
  };
1527
2280
  /** @returns {ProductSortOn} */
1528
2281
  declare function ProductSortOn(): ProductSortOn;
1529
2282
  type ProductSortOn = {
2283
+ /**
2284
+ * - URL or path to the logo associated with the sorting option.
2285
+ */
1530
2286
  logo?: string;
2287
+ /**
2288
+ * - Indicates whether this sorting option is
2289
+ * currently selected.
2290
+ */
1531
2291
  is_selected?: boolean;
2292
+ /**
2293
+ * - Name or identifier of the sorting option.
2294
+ */
1532
2295
  name?: string;
2296
+ /**
2297
+ * - Value used to specify the sorting order (e.g.,
2298
+ * price_asc, discount_dsc).
2299
+ */
1533
2300
  value?: string;
2301
+ /**
2302
+ * - Display name or label for the sorting option.
2303
+ */
1534
2304
  display?: string;
1535
2305
  };
1536
2306
  /** @returns {ProductListingResponse} */
1537
2307
  declare function ProductListingResponse(): ProductListingResponse;
1538
2308
  type ProductListingResponse = {
2309
+ /**
2310
+ * - List of product details included
2311
+ * in the response.
2312
+ */
1539
2313
  items?: ProductListingDetail[];
2314
+ /**
2315
+ * - List of filters available for
2316
+ * refining the product listings.
2317
+ */
1540
2318
  filters?: ProductFilters[];
1541
2319
  page: Page;
2320
+ /**
2321
+ * - List of sorting options available for
2322
+ * the product listings.
2323
+ */
1542
2324
  sort_on?: ProductSortOn[];
1543
2325
  };
1544
2326
  /** @returns {ImageUrls} */
@@ -1550,19 +2332,44 @@ type ImageUrls = {
1550
2332
  /** @returns {BrandItem} */
1551
2333
  declare function BrandItem(): BrandItem;
1552
2334
  type BrandItem = {
2335
+ /**
2336
+ * - The unique identifier for the brand.
2337
+ */
1553
2338
  uid?: number;
1554
2339
  logo?: Media;
2340
+ /**
2341
+ * - Detailed description of the brand,
2342
+ * including its history, values, product offerings, and other relevant information.
2343
+ */
1555
2344
  description?: string;
1556
2345
  banners?: ImageUrls;
2346
+ /**
2347
+ * - Lists the departments or categories
2348
+ * under which the brand's products are listed.
2349
+ */
1557
2350
  departments?: string[];
2351
+ /**
2352
+ * - Details about any discounts currently
2353
+ * available on the brand's products.
2354
+ */
1558
2355
  discount?: string;
2356
+ /**
2357
+ * - Name of the brand.
2358
+ */
1559
2359
  name?: string;
2360
+ /**
2361
+ * - URL-friendly version of the brand's name, used in
2362
+ * the web address to access the brand's page on the platform.
2363
+ */
1560
2364
  slug?: string;
1561
2365
  action?: ProductListingAction;
1562
2366
  };
1563
2367
  /** @returns {BrandListingResponse} */
1564
2368
  declare function BrandListingResponse(): BrandListingResponse;
1565
2369
  type BrandListingResponse = {
2370
+ /**
2371
+ * - List of brand items included in the response.
2372
+ */
1566
2373
  items?: BrandItem[];
1567
2374
  page: Page;
1568
2375
  };
@@ -1570,10 +2377,24 @@ type BrandListingResponse = {
1570
2377
  declare function BrandDetailResponse(): BrandDetailResponse;
1571
2378
  type BrandDetailResponse = {
1572
2379
  logo?: Media;
2380
+ /**
2381
+ * - The unique identifier for the brand.
2382
+ */
1573
2383
  uid?: number;
2384
+ /**
2385
+ * - Detailed description of the brand,
2386
+ * including its history, values, product offerings, and other relevant information.
2387
+ */
1574
2388
  description?: string;
1575
2389
  banners?: ImageUrls;
2390
+ /**
2391
+ * - Custom JSON data related to the brand,
2392
+ * allowing for additional metadata.
2393
+ */
1576
2394
  _custom_json?: any;
2395
+ /**
2396
+ * - Name of the brand.
2397
+ */
1577
2398
  name?: string;
1578
2399
  };
1579
2400
  /** @returns {CategoryBanner} */
@@ -1585,164 +2406,405 @@ type CategoryBanner = {
1585
2406
  /** @returns {ThirdLevelChild} */
1586
2407
  declare function ThirdLevelChild(): ThirdLevelChild;
1587
2408
  type ThirdLevelChild = {
2409
+ /**
2410
+ * - Unique identifier for the L3 category.
2411
+ */
1588
2412
  uid?: number;
1589
2413
  banners?: ImageUrls;
2414
+ /**
2415
+ * - List of categories under the L3 category.
2416
+ */
1590
2417
  childs?: any[];
2418
+ /**
2419
+ * - Custom JSON data related to the L3
2420
+ * category, allowing for additional metadata.
2421
+ */
1591
2422
  _custom_json?: any;
2423
+ /**
2424
+ * - Name of the L3 category.
2425
+ */
1592
2426
  name?: string;
2427
+ /**
2428
+ * - Slug or URL-friendly identifier for the L3 category.
2429
+ */
1593
2430
  slug?: string;
1594
2431
  action?: ProductListingAction;
1595
2432
  };
1596
2433
  /** @returns {SecondLevelChild} */
1597
2434
  declare function SecondLevelChild(): SecondLevelChild;
1598
2435
  type SecondLevelChild = {
2436
+ /**
2437
+ * - Unique identifier for the L2 category.
2438
+ */
1599
2439
  uid?: number;
1600
2440
  banners?: ImageUrls;
2441
+ /**
2442
+ * - List of categories under the L2 category.
2443
+ */
1601
2444
  childs?: ThirdLevelChild[];
2445
+ /**
2446
+ * - Custom JSON data related to the L2
2447
+ * category, allowing for additional metadata.
2448
+ */
1602
2449
  _custom_json?: any;
2450
+ /**
2451
+ * - Name of the L2 category.
2452
+ */
1603
2453
  name?: string;
2454
+ /**
2455
+ * - Slug or URL-friendly identifier for the L2 category.
2456
+ */
1604
2457
  slug?: string;
1605
2458
  action?: ProductListingAction;
1606
2459
  };
1607
2460
  /** @returns {Child} */
1608
2461
  declare function Child(): Child;
1609
2462
  type Child = {
2463
+ /**
2464
+ * - Unique identifier for the L1 category.
2465
+ */
1610
2466
  uid?: number;
1611
2467
  banners?: ImageUrls;
2468
+ /**
2469
+ * - List of categories under the L1 category.
2470
+ */
1612
2471
  childs?: SecondLevelChild[];
2472
+ /**
2473
+ * - Custom JSON data related to the L1
2474
+ * category, allowing for additional metadata.
2475
+ */
1613
2476
  _custom_json?: any;
2477
+ /**
2478
+ * - Name of the L1 category.
2479
+ */
1614
2480
  name?: string;
2481
+ /**
2482
+ * - Slug or URL-friendly identifier for the L1 category.
2483
+ */
1615
2484
  slug?: string;
1616
2485
  action?: ProductListingAction;
1617
2486
  };
1618
2487
  /** @returns {CategoryItems} */
1619
2488
  declare function CategoryItems(): CategoryItems;
1620
2489
  type CategoryItems = {
2490
+ /**
2491
+ * - Unique identifier for the category.
2492
+ */
1621
2493
  uid: number;
1622
2494
  banners: CategoryBanner;
2495
+ /**
2496
+ * - List of L1 categories under the main category.
2497
+ */
1623
2498
  childs?: Child[];
2499
+ /**
2500
+ * - Name of the category.
2501
+ */
1624
2502
  name: string;
2503
+ /**
2504
+ * - Slug or URL-friendly identifier for the category.
2505
+ */
1625
2506
  slug: string;
1626
2507
  action: ProductListingAction;
1627
2508
  };
1628
2509
  /** @returns {DepartmentCategoryTree} */
1629
2510
  declare function DepartmentCategoryTree(): DepartmentCategoryTree;
1630
2511
  type DepartmentCategoryTree = {
2512
+ /**
2513
+ * - List of categories within the department.
2514
+ */
1631
2515
  items?: CategoryItems[];
2516
+ /**
2517
+ * - Name of the department.
2518
+ */
1632
2519
  department: string;
1633
2520
  };
1634
2521
  /** @returns {DepartmentIdentifier} */
1635
2522
  declare function DepartmentIdentifier(): DepartmentIdentifier;
1636
2523
  type DepartmentIdentifier = {
2524
+ /**
2525
+ * - Unique identifier for the department.
2526
+ */
1637
2527
  uid?: number;
2528
+ /**
2529
+ * - Slug or URL-friendly identifier for the department.
2530
+ */
1638
2531
  slug?: string;
1639
2532
  };
1640
2533
  /** @returns {CategoryListingResponse} */
1641
2534
  declare function CategoryListingResponse(): CategoryListingResponse;
1642
2535
  type CategoryListingResponse = {
2536
+ /**
2537
+ * - List of department category trees.
2538
+ */
1643
2539
  data?: DepartmentCategoryTree[];
2540
+ /**
2541
+ * - List of departments.
2542
+ */
1644
2543
  departments?: DepartmentIdentifier[];
1645
2544
  };
1646
2545
  /** @returns {CategoryMetaResponse} */
1647
2546
  declare function CategoryMetaResponse(): CategoryMetaResponse;
1648
2547
  type CategoryMetaResponse = {
1649
2548
  logo?: Media;
2549
+ /**
2550
+ * - Unique identifier for the category.
2551
+ */
1650
2552
  uid?: number;
1651
2553
  banners?: ImageUrls;
2554
+ /**
2555
+ * - Custom JSON data related to the category,
2556
+ * allowing for additional metadata.
2557
+ */
1652
2558
  _custom_json?: any;
2559
+ /**
2560
+ * - Name of the category.
2561
+ */
1653
2562
  name?: string;
1654
2563
  };
1655
2564
  /** @returns {HomeListingResponse} */
1656
2565
  declare function HomeListingResponse(): HomeListingResponse;
1657
2566
  type HomeListingResponse = {
2567
+ /**
2568
+ * - List of product details
2569
+ * displayed on the home page.
2570
+ */
1658
2571
  items?: ProductListingDetail[];
1659
2572
  page: Page;
2573
+ /**
2574
+ * - Message related to the home listing response.
2575
+ */
1660
2576
  message?: string;
1661
2577
  };
1662
2578
  /** @returns {Department} */
1663
2579
  declare function Department(): Department;
1664
2580
  type Department = {
2581
+ /**
2582
+ * - Unique identifier for the department.
2583
+ */
1665
2584
  uid?: number;
1666
2585
  logo?: Media;
2586
+ /**
2587
+ * - Specifies the display order of the
2588
+ * department, determining its position in lists and navigation menus based on
2589
+ * priority.
2590
+ */
1667
2591
  priority_order?: number;
2592
+ /**
2593
+ * - Name of the department.
2594
+ */
1668
2595
  name?: string;
2596
+ /**
2597
+ * - URL-friendly version of the department's name,
2598
+ * used in the web address to access the department's page on the platform.
2599
+ */
1669
2600
  slug?: string;
1670
2601
  };
1671
2602
  /** @returns {DepartmentResponse} */
1672
2603
  declare function DepartmentResponse(): DepartmentResponse;
1673
2604
  type DepartmentResponse = {
2605
+ /**
2606
+ * - List of department detail objects.
2607
+ */
1674
2608
  items?: Department[];
1675
2609
  };
1676
2610
  /** @returns {AutocompleteItem} */
1677
2611
  declare function AutocompleteItem(): AutocompleteItem;
1678
2612
  type AutocompleteItem = {
1679
2613
  logo?: Media;
2614
+ /**
2615
+ * - Text or value displayed for the autocomplete item.
2616
+ */
1680
2617
  display?: string;
2618
+ /**
2619
+ * - The type of action such as product, products,
2620
+ * category, brand.
2621
+ */
1681
2622
  type?: string;
2623
+ /**
2624
+ * - Custom JSON data related to the
2625
+ * autocomplete item, allowing for additional metadata.
2626
+ */
1682
2627
  _custom_json?: any;
1683
2628
  action?: ProductListingAction;
1684
2629
  };
1685
2630
  /** @returns {AutoCompleteResponse} */
1686
2631
  declare function AutoCompleteResponse(): AutoCompleteResponse;
1687
2632
  type AutoCompleteResponse = {
2633
+ /**
2634
+ * - List of autocomplete items suggested
2635
+ * based on user input.
2636
+ */
1688
2637
  items?: AutocompleteItem[];
1689
2638
  };
1690
2639
  /** @returns {CollectionQuery} */
1691
2640
  declare function CollectionQuery(): CollectionQuery;
1692
2641
  type CollectionQuery = {
2642
+ /**
2643
+ * - The operator used for filtering the collection.
2644
+ */
1693
2645
  op: string;
2646
+ /**
2647
+ * - The values used for filtering based on the attribute.
2648
+ */
1694
2649
  value: any[];
2650
+ /**
2651
+ * - The attribute on which the filter is applied.
2652
+ */
1695
2653
  attribute: string;
1696
2654
  };
1697
2655
  /** @returns {GetCollectionDetailNest} */
1698
2656
  declare function GetCollectionDetailNest(): GetCollectionDetailNest;
1699
2657
  type GetCollectionDetailNest = {
2658
+ /**
2659
+ * - Indicates whether the collection is currently active.
2660
+ */
1700
2661
  is_active?: boolean;
2662
+ /**
2663
+ * - The unique identifier for the collection.
2664
+ */
1701
2665
  uid?: string;
2666
+ /**
2667
+ * - The attribute by which the collection items are sorted.
2668
+ */
1702
2669
  sort_on?: string;
2670
+ /**
2671
+ * - Additional metadata related to the collection.
2672
+ */
1703
2673
  meta?: any;
1704
2674
  banners?: ImageUrls;
2675
+ /**
2676
+ * - Cron details for scheduling related to the collection.
2677
+ */
1705
2678
  cron?: any;
2679
+ /**
2680
+ * - The `Schedule` schema defines the timing and
2681
+ * details for recurring or one-time tasks. It includes information on when
2682
+ * the job should start and end, the frequency of the task, and any additional
2683
+ * metadata. This schema helps in scheduling jobs or tasks based on specified
2684
+ * timings and durations.
2685
+ */
1706
2686
  _schedule?: any;
2687
+ /**
2688
+ * - A list of queries used to filter the
2689
+ * collection.
2690
+ */
1707
2691
  query?: CollectionQuery[];
2692
+ /**
2693
+ * - A detailed description of the collection.
2694
+ */
1708
2695
  description?: string;
2696
+ /**
2697
+ * - Type of collections e.g query, items.
2698
+ */
1709
2699
  type?: string;
2700
+ /**
2701
+ * - Custom JSON data associated with the collection.
2702
+ */
1710
2703
  _custom_json?: any;
2704
+ /**
2705
+ * - The name of the collection.
2706
+ */
1711
2707
  name?: string;
2708
+ /**
2709
+ * - Indicates if sorting is allowed for this collection.
2710
+ */
1712
2711
  allow_sort?: boolean;
2712
+ /**
2713
+ * - Keys of the facets visible for
2714
+ * filtering within the collection.
2715
+ */
1713
2716
  visible_facets_keys?: string[];
2717
+ /**
2718
+ * - Badge information associated with the collection.
2719
+ */
1714
2720
  badge?: any;
2721
+ /**
2722
+ * - The URL-friendly identifier for the collection.
2723
+ */
1715
2724
  slug?: string;
1716
2725
  action?: ProductListingAction;
2726
+ /**
2727
+ * - Indicates if facets are allowed for
2728
+ * filtering within the collection.
2729
+ */
1717
2730
  allow_facets?: boolean;
1718
2731
  logo?: Media;
2732
+ /**
2733
+ * - Priority level of the collection for sorting
2734
+ * or display purposes.
2735
+ */
1719
2736
  priority?: number;
2737
+ /**
2738
+ * - Tags associated with the collection.
2739
+ */
1720
2740
  tags?: string[];
2741
+ /**
2742
+ * - Application ID associated with the collection.
2743
+ */
1721
2744
  app_id?: string;
1722
2745
  };
1723
2746
  /** @returns {CollectionListingFilterTag} */
1724
2747
  declare function CollectionListingFilterTag(): CollectionListingFilterTag;
1725
2748
  type CollectionListingFilterTag = {
2749
+ /**
2750
+ * - The name of the tag. This is typically used as a
2751
+ * label for filtering purposes.
2752
+ */
1726
2753
  name?: string;
2754
+ /**
2755
+ * - A flag indicating whether the tag is
2756
+ * currently selected as a filter option.
2757
+ */
1727
2758
  is_selected?: boolean;
2759
+ /**
2760
+ * - The display name of the tag. This may be a
2761
+ * user-friendly version of the tag name shown in the UI.
2762
+ */
1728
2763
  display?: string;
1729
2764
  };
1730
2765
  /** @returns {CollectionListingFilterType} */
1731
2766
  declare function CollectionListingFilterType(): CollectionListingFilterType;
1732
2767
  type CollectionListingFilterType = {
2768
+ /**
2769
+ * - The name of the filter type. This indicates the
2770
+ * type of filtering being applied, such as items, query.
2771
+ */
1733
2772
  name?: string;
2773
+ /**
2774
+ * - A flag indicating whether this filter
2775
+ * type is currently selected as a filter option.
2776
+ */
1734
2777
  is_selected?: boolean;
2778
+ /**
2779
+ * - The display name of the filter type. This is
2780
+ * the user-friendly name shown in the UI for the filter type.
2781
+ */
1735
2782
  display?: string;
1736
2783
  };
1737
2784
  /** @returns {CollectionListingFilter} */
1738
2785
  declare function CollectionListingFilter(): CollectionListingFilter;
1739
2786
  type CollectionListingFilter = {
2787
+ /**
2788
+ * - An array of tag filters
2789
+ * available for the collection listings. Each tag allows for filtering based
2790
+ * on specific attributes.
2791
+ */
1740
2792
  tags?: CollectionListingFilterTag[];
2793
+ /**
2794
+ * - An array of filter types
2795
+ * available for the collection listings. Each type represents a different
2796
+ * category or attribute for filtering.
2797
+ */
1741
2798
  type?: CollectionListingFilterType[];
1742
2799
  };
1743
2800
  /** @returns {GetCollectionListingResponse} */
1744
2801
  declare function GetCollectionListingResponse(): GetCollectionListingResponse;
1745
2802
  type GetCollectionListingResponse = {
2803
+ /**
2804
+ * - An array of collection
2805
+ * details. Each item in the array represents a collection with various
2806
+ * attributes and configurations.
2807
+ */
1746
2808
  items?: GetCollectionDetailNest[];
1747
2809
  filters?: CollectionListingFilter;
1748
2810
  page: Page;
@@ -1750,49 +2812,141 @@ type GetCollectionListingResponse = {
1750
2812
  /** @returns {CollectionDetailResponse} */
1751
2813
  declare function CollectionDetailResponse(): CollectionDetailResponse;
1752
2814
  type CollectionDetailResponse = {
2815
+ /**
2816
+ * - Indicates whether the collection is active.
2817
+ */
1753
2818
  is_active?: boolean;
2819
+ /**
2820
+ * - Criteria used to sort the items within the
2821
+ * collection, such as price, popularity, or newest first.
2822
+ */
1754
2823
  sort_on?: string;
2824
+ /**
2825
+ * - Metadata associated with the collection.
2826
+ */
1755
2827
  meta?: any;
1756
2828
  banners?: ImageUrls;
2829
+ /**
2830
+ * - Cron schedule details related to the collection,
2831
+ * if applicable.
2832
+ */
1757
2833
  cron?: any;
2834
+ /**
2835
+ * - Schedule details for the collection,
2836
+ * including timing and duration information.
2837
+ */
1758
2838
  _schedule?: any;
2839
+ /**
2840
+ * - Search or filter query used to
2841
+ * dynamically generate the collection based on specific criteria or conditions.
2842
+ */
1759
2843
  query?: CollectionQuery[];
2844
+ /**
2845
+ * - Detailed description of the collection,.
2846
+ */
1760
2847
  description?: string;
2848
+ /**
2849
+ * - Type of collection, specifying the nature or
2850
+ * category of the collection.
2851
+ */
1761
2852
  type?: string;
2853
+ /**
2854
+ * - Custom JSON object containing additional
2855
+ * properties specific to the collection.
2856
+ */
1762
2857
  _custom_json?: any;
2858
+ /**
2859
+ * - The name of the collection.
2860
+ */
1763
2861
  name?: string;
2862
+ /**
2863
+ * - Indicates if sorting is allowed for this collection.
2864
+ */
1764
2865
  allow_sort?: boolean;
2866
+ /**
2867
+ * - Keys of the facets visible for
2868
+ * filtering within the collection.
2869
+ */
1765
2870
  visible_facets_keys?: string[];
2871
+ /**
2872
+ * - Badge information associated with the collection.
2873
+ */
1766
2874
  badge?: any;
2875
+ /**
2876
+ * - The URL-friendly identifier for the collection.
2877
+ */
1767
2878
  slug?: string;
2879
+ /**
2880
+ * - Indicates if facets are allowed for
2881
+ * filtering within the collection.
2882
+ */
1768
2883
  allow_facets?: boolean;
1769
2884
  logo?: Media;
2885
+ /**
2886
+ * - Priority level of the collection for sorting
2887
+ * or display purposes.
2888
+ */
1770
2889
  priority?: number;
2890
+ /**
2891
+ * - Tags associated with the collection.
2892
+ */
1771
2893
  tag?: string[];
2894
+ /**
2895
+ * - Application ID associated with the collection.
2896
+ */
1772
2897
  app_id?: string;
1773
2898
  };
1774
2899
  /** @returns {GetFollowListingResponse} */
1775
2900
  declare function GetFollowListingResponse(): GetFollowListingResponse;
1776
2901
  type GetFollowListingResponse = {
2902
+ /**
2903
+ * - An array of product details that
2904
+ * the user is following. Each item includes information such as the product
2905
+ * name, price, and other attributes.
2906
+ */
1777
2907
  items: ProductListingDetail[];
1778
2908
  page: Page;
1779
2909
  };
1780
2910
  /** @returns {FollowPostResponse} */
1781
2911
  declare function FollowPostResponse(): FollowPostResponse;
1782
2912
  type FollowPostResponse = {
2913
+ /**
2914
+ * - A message indicating the result of the follow or
2915
+ * unfollow operation. This could be a confirmation message or an error message.
2916
+ */
1783
2917
  message: string;
2918
+ /**
2919
+ * - A unique identifier for the follow operation, which
2920
+ * can be used to reference or track the follow status.
2921
+ */
1784
2922
  id: string;
1785
2923
  };
1786
2924
  /** @returns {FollowerCountResponse} */
1787
2925
  declare function FollowerCountResponse(): FollowerCountResponse;
1788
2926
  type FollowerCountResponse = {
2927
+ /**
2928
+ * - The number of followers for the item. This count
2929
+ * indicates how many users are following the specified item.
2930
+ */
1789
2931
  count?: number;
1790
2932
  };
1791
2933
  /** @returns {FollowIdsData} */
1792
2934
  declare function FollowIdsData(): FollowIdsData;
1793
2935
  type FollowIdsData = {
2936
+ /**
2937
+ * - An array of IDs representing the products
2938
+ * that the user is following.
2939
+ */
1794
2940
  products?: number[];
2941
+ /**
2942
+ * - An array of IDs representing the
2943
+ * collections that the user is following.
2944
+ */
1795
2945
  collections?: number[];
2946
+ /**
2947
+ * - An array of IDs representing the brands that
2948
+ * the user is following.
2949
+ */
1796
2950
  brands?: number[];
1797
2951
  };
1798
2952
  /** @returns {FollowIdsResponse} */
@@ -1803,118 +2957,295 @@ type FollowIdsResponse = {
1803
2957
  /** @returns {LatLong} */
1804
2958
  declare function LatLong(): LatLong;
1805
2959
  type LatLong = {
2960
+ /**
2961
+ * - An array containing the latitude and
2962
+ * longitude values of the location.
2963
+ */
1806
2964
  coordinates?: number[];
2965
+ /**
2966
+ * - The type of geographic coordinate system used.
2967
+ * For example, "Point" indicates a single point in a geographic coordinate system.
2968
+ */
1807
2969
  type?: string;
1808
2970
  };
1809
2971
  /** @returns {Store} */
1810
2972
  declare function Store(): Store;
1811
2973
  type Store = {
2974
+ /**
2975
+ * - A unique identifier for the store.
2976
+ */
1812
2977
  uid?: number;
2978
+ /**
2979
+ * - The manager's email address for the store.
2980
+ */
1813
2981
  store_email?: string;
2982
+ /**
2983
+ * - The state or province where the store is located.
2984
+ */
1814
2985
  state?: string;
2986
+ /**
2987
+ * - The country where the store is located.
2988
+ */
1815
2989
  country?: string;
2990
+ /**
2991
+ * - The postal code or zip code for the store's location.
2992
+ */
1816
2993
  pincode?: number;
2994
+ /**
2995
+ * - The city where the store is located.
2996
+ */
1817
2997
  city?: string;
2998
+ /**
2999
+ * - The street address of the store.
3000
+ */
1818
3001
  address?: string;
3002
+ /**
3003
+ * - A unique code or identifier for the store,
3004
+ * often used for internal reference.
3005
+ */
1819
3006
  store_code?: string;
1820
3007
  lat_long?: LatLong;
3008
+ /**
3009
+ * - The name of the store.
3010
+ */
1821
3011
  name?: string;
3012
+ /**
3013
+ * - The list of tags mapped to the store.
3014
+ */
1822
3015
  tags?: string[];
1823
3016
  };
1824
3017
  /** @returns {StoreListingResponse} */
1825
3018
  declare function StoreListingResponse(): StoreListingResponse;
1826
3019
  type StoreListingResponse = {
3020
+ /**
3021
+ * - An array of store details. Each store includes
3022
+ * information such as name, address, and geographic coordinates.
3023
+ */
1827
3024
  items: Store[];
1828
3025
  page: Page;
1829
3026
  };
1830
3027
  /** @returns {StoreDepartments} */
1831
3028
  declare function StoreDepartments(): StoreDepartments;
1832
3029
  type StoreDepartments = {
3030
+ /**
3031
+ * - The unique identifier assigned to the store department.
3032
+ */
1833
3033
  uid?: number;
3034
+ /**
3035
+ * - An object containing information about the store
3036
+ * department's logo, such as the URL or other related media details.
3037
+ */
1834
3038
  logo?: any;
3039
+ /**
3040
+ * - The priority or ranking of the
3041
+ * department within the store. This field is used to determine the order in
3042
+ * which departments are displayed or processed.
3043
+ */
1835
3044
  priority_order?: number;
3045
+ /**
3046
+ * - The name of the store department, which is
3047
+ * typically used for display and identification purposes.
3048
+ */
1836
3049
  name?: string;
3050
+ /**
3051
+ * - A URL-friendly identifier for the store
3052
+ * department, often used in web addresses and routing to uniquely identify
3053
+ * the department.
3054
+ */
1837
3055
  slug?: string;
1838
3056
  };
1839
3057
  /** @returns {CompanyStore} */
1840
3058
  declare function CompanyStore(): CompanyStore;
1841
3059
  type CompanyStore = {
3060
+ /**
3061
+ * - The unique identifier for the company store.
3062
+ */
1842
3063
  uid?: number;
3064
+ /**
3065
+ * - The name of the company store.
3066
+ */
1843
3067
  name?: string;
3068
+ /**
3069
+ * - The type of company, which can be one of
3070
+ * the following: - `distributor`: Distributor - `franchise`: Franchise -
3071
+ * `mbo`: MBO (Managed Business Operations) - `manufacturer-owner`: Owner/Manufacturer.
3072
+ */
1844
3073
  company_type?: string;
3074
+ /**
3075
+ * - The type of business structure, which
3076
+ * can be one of the following: - `Private`: Private Limited Company -
3077
+ * `LLP/Partnership`: Limited Liability Partnership or Partnership -
3078
+ * `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
3079
+ */
1845
3080
  business_type?: string;
1846
3081
  };
1847
3082
  /** @returns {SellerPhoneNumber} */
1848
3083
  declare function SellerPhoneNumber(): SellerPhoneNumber;
1849
3084
  type SellerPhoneNumber = {
3085
+ /**
3086
+ * - The country code of the seller's phone number.
3087
+ */
1850
3088
  country_code: number;
3089
+ /**
3090
+ * - The seller's contact number.
3091
+ */
1851
3092
  number: string;
1852
3093
  };
1853
3094
  /** @returns {StoreManagerSerializer} */
1854
3095
  declare function StoreManagerSerializer(): StoreManagerSerializer;
1855
3096
  type StoreManagerSerializer = {
3097
+ /**
3098
+ * - The name of the store manager.
3099
+ */
1856
3100
  name?: string;
3101
+ /**
3102
+ * - The email address of the store manager.
3103
+ */
1857
3104
  email?: string;
1858
3105
  mobile_no?: SellerPhoneNumber;
1859
3106
  };
1860
3107
  /** @returns {StoreAddressSerializer} */
1861
3108
  declare function StoreAddressSerializer(): StoreAddressSerializer;
1862
3109
  type StoreAddressSerializer = {
3110
+ /**
3111
+ * - The latitude of the store's location.
3112
+ */
1863
3113
  latitude?: number;
3114
+ /**
3115
+ * - The state where the store is located.
3116
+ */
1864
3117
  state?: string;
3118
+ /**
3119
+ * - The country where the store is located.
3120
+ */
1865
3121
  country?: string;
3122
+ /**
3123
+ * - A landmark near the store.
3124
+ */
1866
3125
  landmark?: string;
3126
+ /**
3127
+ * - The address line 1 of the store.
3128
+ */
1867
3129
  address1?: string;
3130
+ /**
3131
+ * - The postal code for the store's location.
3132
+ */
1868
3133
  pincode?: number;
3134
+ /**
3135
+ * - The city where the store is located.
3136
+ */
1869
3137
  city?: string;
3138
+ /**
3139
+ * - The longitude of the store's location.
3140
+ */
1870
3141
  longitude?: number;
3142
+ /**
3143
+ * - The address line2 of the store.
3144
+ */
1871
3145
  address2?: string;
1872
3146
  };
1873
3147
  /** @returns {AppStore} */
1874
3148
  declare function AppStore(): AppStore;
1875
3149
  type AppStore = {
3150
+ /**
3151
+ * - The unique identifier for the application store.
3152
+ */
1876
3153
  uid?: number;
3154
+ /**
3155
+ * - A list of departments within the store.
3156
+ */
1877
3157
  departments?: StoreDepartments[];
1878
3158
  company?: CompanyStore;
1879
3159
  manager?: StoreManagerSerializer;
3160
+ /**
3161
+ * - A unique code for identifying the store.
3162
+ */
1880
3163
  store_code?: string;
1881
3164
  address?: StoreAddressSerializer;
3165
+ /**
3166
+ * - The name of the store.
3167
+ */
1882
3168
  name?: string;
3169
+ /**
3170
+ * - A list of contact numbers
3171
+ * for the store.
3172
+ */
1883
3173
  contact_numbers?: SellerPhoneNumber[];
1884
3174
  };
1885
3175
  /** @returns {ApplicationStoreListing} */
1886
3176
  declare function ApplicationStoreListing(): ApplicationStoreListing;
1887
3177
  type ApplicationStoreListing = {
3178
+ /**
3179
+ * - A list of filters applied to the store listing.
3180
+ */
1888
3181
  filters?: any[];
3182
+ /**
3183
+ * - A list of application stores.
3184
+ */
1889
3185
  items?: AppStore[];
1890
3186
  page?: Page;
1891
3187
  };
1892
3188
  /** @returns {Time} */
1893
3189
  declare function Time(): Time;
1894
3190
  type Time = {
3191
+ /**
3192
+ * - The hour part of the time.
3193
+ */
1895
3194
  hour?: number;
3195
+ /**
3196
+ * - The minute part of the time.
3197
+ */
1896
3198
  minute?: number;
1897
3199
  };
1898
3200
  /** @returns {StoreTiming} */
1899
3201
  declare function StoreTiming(): StoreTiming;
1900
3202
  type StoreTiming = {
3203
+ /**
3204
+ * - Indicates if the store is open on this day.
3205
+ */
1901
3206
  open?: boolean;
1902
3207
  closing?: Time;
3208
+ /**
3209
+ * - The day of the week.
3210
+ */
1903
3211
  weekday?: string;
1904
3212
  opening?: Time;
1905
3213
  };
1906
3214
  /** @returns {StoreDetails} */
1907
3215
  declare function StoreDetails(): StoreDetails;
1908
3216
  type StoreDetails = {
3217
+ /**
3218
+ * - The unique identifier for the store.
3219
+ */
1909
3220
  uid?: number;
3221
+ /**
3222
+ * - A list of departments within the store.
3223
+ */
1910
3224
  departments?: StoreDepartments[];
1911
3225
  company?: CompanyStore;
1912
3226
  manager?: StoreManagerSerializer;
3227
+ /**
3228
+ * - A unique code for identifying the store.
3229
+ */
1913
3230
  store_code?: string;
3231
+ /**
3232
+ * - The opening and closing times for the
3233
+ * store throughout the week.
3234
+ */
1914
3235
  timing?: StoreTiming[];
1915
3236
  address?: StoreAddressSerializer;
3237
+ /**
3238
+ * - Custom JSON data for the store.
3239
+ */
1916
3240
  _custom_json?: any;
3241
+ /**
3242
+ * - The name of the store.
3243
+ */
1917
3244
  name?: string;
3245
+ /**
3246
+ * - A list of contact numbers
3247
+ * for the store.
3248
+ */
1918
3249
  contact_numbers?: SellerPhoneNumber[];
1919
3250
  };
1920
3251
  /** @returns {UserDetail} */
@@ -1941,19 +3272,19 @@ type UserDetail = {
1941
3272
  declare function Size(): Size;
1942
3273
  type Size = {
1943
3274
  /**
1944
- * - The quantity of this size available
3275
+ * - The quantity of this size available.
1945
3276
  */
1946
3277
  quantity?: number;
1947
3278
  /**
1948
- * - The value of the size
3279
+ * - The value of the size.
1949
3280
  */
1950
3281
  value?: any;
1951
3282
  /**
1952
- * - The display string for the size
3283
+ * - The display string for the size.
1953
3284
  */
1954
3285
  display?: any;
1955
3286
  /**
1956
- * - Whether or not this size is available
3287
+ * - Whether or not this size is available.
1957
3288
  */
1958
3289
  is_available?: boolean;
1959
3290
  };
@@ -1985,87 +3316,87 @@ type ProductGroupPrice = {
1985
3316
  declare function ProductDetails(): ProductDetails;
1986
3317
  type ProductDetails = {
1987
3318
  /**
1988
- * - The template tag of the product
3319
+ * - The template tag of the product.
1989
3320
  */
1990
3321
  template_tag?: any;
1991
3322
  /**
1992
- * - The number of ratings the product has received
3323
+ * - The number of ratings the product has received.
1993
3324
  */
1994
3325
  rating_count?: number;
1995
3326
  /**
1996
- * - The nature of the product's images
3327
+ * - The nature of the product's images.
1997
3328
  */
1998
3329
  image_nature?: any;
1999
3330
  /**
2000
- * - Whether or not the product has a variant
3331
+ * - Whether or not the product has a variant.
2001
3332
  */
2002
3333
  has_variant?: boolean;
2003
3334
  /**
2004
- * - The long description of the product
3335
+ * - The long description of the product.
2005
3336
  */
2006
3337
  description?: any;
2007
3338
  /**
2008
- * - Whether or not the product is out of stock
3339
+ * - Whether or not the product is out of stock.
2009
3340
  */
2010
3341
  out_of_stock?: boolean;
2011
3342
  /**
2012
- * - The HSN code of the product
3343
+ * - The HSN code of the product.
2013
3344
  */
2014
3345
  hsn_code?: number;
2015
3346
  /**
2016
- * - A dictionary of grouped product attributes
3347
+ * - A dictionary of grouped product attributes.
2017
3348
  */
2018
3349
  grouped_attributes?: any;
2019
3350
  /**
2020
- * - The item code of the product
3351
+ * - The item code of the product.
2021
3352
  */
2022
3353
  item_code?: any;
2023
3354
  /**
2024
- * - The name of the product
3355
+ * - The name of the product.
2025
3356
  */
2026
3357
  name?: any;
2027
3358
  /**
2028
- * - The country of origin for the product
3359
+ * - The country of origin for the product.
2029
3360
  */
2030
3361
  country_of_origin?: any;
2031
3362
  /**
2032
- * - The short description of the product
3363
+ * - The short description of the product.
2033
3364
  */
2034
3365
  short_description?: any;
2035
3366
  /**
2036
- * - A list of media objects for the product
3367
+ * - A list of media objects for the product.
2037
3368
  */
2038
3369
  media?: any[];
2039
3370
  /**
2040
- * - A dictionary of product attributes
3371
+ * - A dictionary of product attributes.
2041
3372
  */
2042
3373
  attributes?: any;
2043
3374
  /**
2044
- * - Whether or not the product is a set of items
3375
+ * - Whether or not the product is a set of items.
2045
3376
  */
2046
3377
  is_set?: boolean;
2047
3378
  /**
2048
- * - A list of image URLs for the product
3379
+ * - A list of image URLs for the product.
2049
3380
  */
2050
3381
  images?: any[];
2051
3382
  /**
2052
- * - The slug of the product
3383
+ * - The slug of the product.
2053
3384
  */
2054
3385
  slug?: any;
2055
3386
  /**
2056
- * - The rating of the product
3387
+ * - The rating of the product.
2057
3388
  */
2058
3389
  rating?: number;
2059
3390
  /**
2060
- * - A dictionary of product identifiers
3391
+ * - A dictionary of product identifiers.
2061
3392
  */
2062
3393
  identifier?: any;
2063
3394
  /**
2064
- * - A list of highlights for the product
3395
+ * - A list of highlights for the product.
2065
3396
  */
2066
3397
  highlights?: any[];
2067
3398
  /**
2068
- * - The unique ID of the product's brand
3399
+ * - The unique ID of the product's brand.
2069
3400
  */
2070
3401
  brand_uid?: number;
2071
3402
  };
@@ -2073,8 +3404,8 @@ type ProductDetails = {
2073
3404
  declare function ProductInGroup(): ProductInGroup;
2074
3405
  type ProductInGroup = {
2075
3406
  /**
2076
- * - A flag indicating whether the
2077
- * product should be automatically added to the cart.
3407
+ * - Whether the product should be
3408
+ * automatically added to the cart.
2078
3409
  */
2079
3410
  auto_add_to_cart?: boolean;
2080
3411
  /**
@@ -2087,12 +3418,12 @@ type ProductInGroup = {
2087
3418
  */
2088
3419
  sizes?: Size[];
2089
3420
  /**
2090
- * - The price details for the product group.
3421
+ * - The price details for the product.
2091
3422
  */
2092
3423
  price?: ProductGroupPrice;
2093
3424
  /**
2094
- * - A flag indicating whether the product
2095
- * should be automatically selected.
3425
+ * - Whether the product should be
3426
+ * automatically selected.
2096
3427
  */
2097
3428
  auto_select?: boolean;
2098
3429
  /**
@@ -2105,8 +3436,7 @@ type ProductInGroup = {
2105
3436
  */
2106
3437
  min_quantity?: number;
2107
3438
  /**
2108
- * - A flag indicating whether the product
2109
- * can be removed from the cart.
3439
+ * - Whether the product can be removed from the cart.
2110
3440
  */
2111
3441
  allow_remove?: boolean;
2112
3442
  /**
@@ -2118,7 +3448,7 @@ type ProductInGroup = {
2118
3448
  declare function ProductGroupingModel(): ProductGroupingModel;
2119
3449
  type ProductGroupingModel = {
2120
3450
  /**
2121
- * - The URL for the logo of the product grouping.
3451
+ * - The URL for the logo of the product group.
2122
3452
  */
2123
3453
  logo?: string;
2124
3454
  /**
@@ -2131,11 +3461,11 @@ type ProductGroupingModel = {
2131
3461
  meta?: any;
2132
3462
  /**
2133
3463
  * - User details of the verifier of the
2134
- * document, if applicable
3464
+ * document, if applicable.
2135
3465
  */
2136
3466
  verified_by?: UserDetail;
2137
3467
  /**
2138
- * - Timestamp of the creation of the document
3468
+ * - Timestamp of the creation of the document.
2139
3469
  */
2140
3470
  created_on: string;
2141
3471
  /**
@@ -2148,16 +3478,16 @@ type ProductGroupingModel = {
2148
3478
  */
2149
3479
  page_visibility?: any[];
2150
3480
  /**
2151
- * - Timestamp of the last modification of the document
3481
+ * - Timestamp of the last modification of the document.
2152
3482
  */
2153
3483
  modified_on: string;
2154
3484
  /**
2155
- * - User details of the creator of the document
3485
+ * - User details of the creator of the document.
2156
3486
  */
2157
3487
  created_by?: UserDetail;
2158
3488
  /**
2159
3489
  * - User details of the last modifier of
2160
- * the document
3490
+ * the document.
2161
3491
  */
2162
3492
  modified_by?: UserDetail;
2163
3493
  /**
@@ -2169,6 +3499,9 @@ type ProductGroupingModel = {
2169
3499
  * assigned to the same store.
2170
3500
  */
2171
3501
  same_store_assignment?: boolean;
3502
+ /**
3503
+ * - Unique identifier of the product grouping.
3504
+ */
2172
3505
  _id?: any;
2173
3506
  /**
2174
3507
  * - The name of the product grouping.
@@ -2184,70 +3517,141 @@ type ProductGroupingModel = {
2184
3517
  slug?: any;
2185
3518
  /**
2186
3519
  * - Timestamp of when the document was
2187
- * verified, if applicable
3520
+ * verified, if applicable.
2188
3521
  */
2189
3522
  verified_on?: string;
2190
3523
  };
2191
3524
  /** @returns {ProductBundle} */
2192
3525
  declare function ProductBundle(): ProductBundle;
2193
3526
  type ProductBundle = {
3527
+ /**
3528
+ * - Represents list of
3529
+ * bundles/product groupings.
3530
+ */
2194
3531
  items?: ProductGroupingModel[];
2195
3532
  };
2196
3533
  /** @returns {StoreV3} */
2197
3534
  declare function StoreV3(): StoreV3;
2198
3535
  type StoreV3 = {
3536
+ /**
3537
+ * - The unique identifier for the store.
3538
+ */
2199
3539
  uid?: number;
3540
+ /**
3541
+ * - The name of the store.
3542
+ */
2200
3543
  name?: string;
3544
+ /**
3545
+ * - The count associated with the store.
3546
+ */
2201
3547
  count?: number;
2202
3548
  };
2203
3549
  /** @returns {ArticleAssignmentV3} */
2204
3550
  declare function ArticleAssignmentV3(): ArticleAssignmentV3;
2205
3551
  type ArticleAssignmentV3 = {
3552
+ /**
3553
+ * - Method used for article assignment, such as
3554
+ * optimal, fast-delivery, low-price, or manual.
3555
+ */
2206
3556
  strategy?: string;
3557
+ /**
3558
+ * - Scope of assignment, which can be
3559
+ * multi-companies, single-company, or single-store.
3560
+ */
2207
3561
  level?: string;
2208
3562
  };
2209
3563
  /** @returns {StrategyWiseListingSchemaV3} */
2210
3564
  declare function StrategyWiseListingSchemaV3(): StrategyWiseListingSchemaV3;
2211
3565
  type StrategyWiseListingSchemaV3 = {
3566
+ /**
3567
+ * - Distance between bullfight location and
3568
+ * customer location in kilometers. .
3569
+ */
2212
3570
  distance?: number;
3571
+ /**
3572
+ * - Pincode mapped based on strategy.
3573
+ */
2213
3574
  pincode?: number;
3575
+ /**
3576
+ * - Turn around Time to deliver the product with this strategy.
3577
+ */
2214
3578
  tat?: number;
3579
+ /**
3580
+ * - The quantity available for assigned store.
3581
+ */
2215
3582
  quantity?: number;
2216
3583
  };
2217
3584
  /** @returns {DetailsSchemaV3} */
2218
3585
  declare function DetailsSchemaV3(): DetailsSchemaV3;
2219
3586
  type DetailsSchemaV3 = {
3587
+ /**
3588
+ * - The value of the attribute.
3589
+ */
2220
3590
  value?: string;
3591
+ /**
3592
+ * - The type of detail e.g, text.
3593
+ */
2221
3594
  type?: string;
3595
+ /**
3596
+ * - The attribute key associated with the size.
3597
+ */
2222
3598
  key?: string;
2223
3599
  };
2224
3600
  /** @returns {SellerGroupAttributes} */
2225
3601
  declare function SellerGroupAttributes(): SellerGroupAttributes;
2226
3602
  type SellerGroupAttributes = {
3603
+ /**
3604
+ * - The title of the attribute group.
3605
+ */
2227
3606
  title?: string;
3607
+ /**
3608
+ * - Detail of the attribute.
3609
+ */
2228
3610
  details?: DetailsSchemaV3[];
2229
3611
  };
2230
3612
  /** @returns {ReturnConfigSchemaV3} */
2231
3613
  declare function ReturnConfigSchemaV3(): ReturnConfigSchemaV3;
2232
3614
  type ReturnConfigSchemaV3 = {
3615
+ /**
3616
+ * - The unit for the return configuration.
3617
+ */
2233
3618
  unit?: string;
3619
+ /**
3620
+ * - Indicates if the item is returnable.
3621
+ */
2234
3622
  returnable?: boolean;
3623
+ /**
3624
+ * - The time duration for the return policy.
3625
+ */
2235
3626
  time?: number;
2236
3627
  };
2237
3628
  /** @returns {ProductSetDistributionSizeV3} */
2238
3629
  declare function ProductSetDistributionSizeV3(): ProductSetDistributionSizeV3;
2239
3630
  type ProductSetDistributionSizeV3 = {
3631
+ /**
3632
+ * - The number of pieces available in this size.
3633
+ */
2240
3634
  pieces?: number;
3635
+ /**
3636
+ * - The size of the product.
3637
+ */
2241
3638
  size?: string;
2242
3639
  };
2243
3640
  /** @returns {ProductSetDistributionV3} */
2244
3641
  declare function ProductSetDistributionV3(): ProductSetDistributionV3;
2245
3642
  type ProductSetDistributionV3 = {
3643
+ /**
3644
+ * - A list of size
3645
+ * distributions in the product set.
3646
+ */
2246
3647
  sizes?: ProductSetDistributionSizeV3[];
2247
3648
  };
2248
3649
  /** @returns {ProductSetV3} */
2249
3650
  declare function ProductSetV3(): ProductSetV3;
2250
3651
  type ProductSetV3 = {
3652
+ /**
3653
+ * - The quantity of products in the set.
3654
+ */
2251
3655
  quantity?: number;
2252
3656
  size_distribution?: ProductSetDistributionV3;
2253
3657
  };
@@ -2261,7 +3665,7 @@ type ProductStockPriceV3 = {
2261
3665
  effective?: number;
2262
3666
  /**
2263
3667
  * - The currency code for which the product
2264
- * is available
3668
+ * is available.
2265
3669
  */
2266
3670
  currency_code?: string;
2267
3671
  /**
@@ -2281,28 +3685,61 @@ type ProductStockPriceV3 = {
2281
3685
  /** @returns {ProductStockUnitPriceV3} */
2282
3686
  declare function ProductStockUnitPriceV3(): ProductStockUnitPriceV3;
2283
3687
  type ProductStockUnitPriceV3 = {
3688
+ /**
3689
+ * - The unit of measure for the product.
3690
+ */
2284
3691
  unit?: string;
3692
+ /**
3693
+ * - The currency symbol for the unit price.
3694
+ */
2285
3695
  currency_symbol?: string;
3696
+ /**
3697
+ * - The currency code for the unit price.
3698
+ */
2286
3699
  currency_code?: string;
3700
+ /**
3701
+ * - The unit price of the product.
3702
+ */
2287
3703
  price?: number;
2288
3704
  };
2289
3705
  /** @returns {MarketPlaceSttributesSchemaV3} */
2290
3706
  declare function MarketPlaceSttributesSchemaV3(): MarketPlaceSttributesSchemaV3;
2291
3707
  type MarketPlaceSttributesSchemaV3 = {
3708
+ /**
3709
+ * - The title of the attribute.
3710
+ */
2292
3711
  title?: string;
3712
+ /**
3713
+ * - Detail of the attribute.
3714
+ */
2293
3715
  details?: DetailsSchemaV3[];
2294
3716
  };
2295
3717
  /** @returns {SellerV3} */
2296
3718
  declare function SellerV3(): SellerV3;
2297
3719
  type SellerV3 = {
3720
+ /**
3721
+ * - The unique identifier for the seller.
3722
+ */
2298
3723
  uid?: number;
3724
+ /**
3725
+ * - The name of the seller.
3726
+ */
2299
3727
  name?: string;
3728
+ /**
3729
+ * - The store count serviceable by this seller.
3730
+ */
2300
3731
  count?: number;
2301
3732
  };
2302
3733
  /** @returns {PromiseSchema} */
2303
3734
  declare function PromiseSchema(): PromiseSchema;
2304
3735
  type PromiseSchema = {
3736
+ /**
3737
+ * - The minimum promise time.
3738
+ */
2305
3739
  min?: string;
3740
+ /**
3741
+ * - The maximum promise time.
3742
+ */
2306
3743
  max?: string;
2307
3744
  };
2308
3745
  /** @returns {ProductSizePriceResponseV3} */
@@ -2310,24 +3747,79 @@ declare function ProductSizePriceResponseV3(): ProductSizePriceResponseV3;
2310
3747
  type ProductSizePriceResponseV3 = {
2311
3748
  store?: StoreV3;
2312
3749
  article_assignment?: ArticleAssignmentV3;
3750
+ /**
3751
+ * - Whether Cash on Delivery (COD) is available
3752
+ * for this product. It is true if COD is available and false otherwise.
3753
+ */
2313
3754
  is_cod?: boolean;
3755
+ /**
3756
+ * - Details
3757
+ * about serviceability attributes.
3758
+ */
2314
3759
  strategy_wise_listing?: StrategyWiseListingSchemaV3[];
3760
+ /**
3761
+ * - Available quantity of the product in stock.
3762
+ * It shows the number of units available for purchase.
3763
+ */
2315
3764
  quantity?: number;
3765
+ /**
3766
+ * - Type of item, indicating the category or
3767
+ * nature of the product. Possible values are Standard, Composite, Wet, Digital.
3768
+ */
2316
3769
  item_type?: string;
3770
+ /**
3771
+ * - Collection of
3772
+ * attributes grouped together, which provides detailed characteristics of the
3773
+ * product, such as color, size, material, etc.
3774
+ */
2317
3775
  grouped_attributes?: SellerGroupAttributes[];
2318
3776
  return_config?: ReturnConfigSchemaV3;
3777
+ /**
3778
+ * - This unique identifier is assigned to the
3779
+ * specific article. This represents item x size x location.
3780
+ */
2319
3781
  article_id?: string;
3782
+ /**
3783
+ * - Whether the product can be purchased as a
3784
+ * gift. It is true if the product is available for gifting and false otherwise.
3785
+ */
2320
3786
  is_gift?: boolean;
2321
3787
  set?: ProductSetV3;
3788
+ /**
3789
+ * - Number of sellers offering this product.
3790
+ * It indicates the level of competition and availability from different sellers.
3791
+ */
2322
3792
  seller_count?: number;
2323
3793
  price_per_piece?: ProductStockPriceV3;
2324
3794
  discount_meta?: DiscountMeta;
3795
+ /**
3796
+ * - Amount or percentage of discount applied to
3797
+ * the product's price, showing the savings for the customer.
3798
+ */
2325
3799
  discount?: string;
3800
+ /**
3801
+ * - Longitude and latitude coordinates,
3802
+ * possibly indicating the location of the store or warehouse where the
3803
+ * product is stocked.
3804
+ */
2326
3805
  long_lat?: number[];
3806
+ /**
3807
+ * - Special badges or labels assigned to the
3808
+ * product, such as "Bestseller," "New Arrival," or "Limited Edition.".
3809
+ */
2327
3810
  special_badge?: string;
2328
3811
  price?: ProductStockPriceV3;
2329
3812
  price_per_unit?: ProductStockUnitPriceV3;
3813
+ /**
3814
+ * - Postal code or zip code for which the
3815
+ * product's availability and delivery options are being checked.
3816
+ */
2330
3817
  pincode?: number;
3818
+ /**
3819
+ * -
3820
+ * Attributes specific to the marketplace, such as ratings, reviews, shipping
3821
+ * options, and other marketplace-specific details.
3822
+ */
2331
3823
  marketplace_attributes?: MarketPlaceSttributesSchemaV3[];
2332
3824
  seller?: SellerV3;
2333
3825
  delivery_promise?: PromiseSchema;
@@ -2335,14 +3827,31 @@ type ProductSizePriceResponseV3 = {
2335
3827
  /** @returns {ProductSizeSellerFilterSchemaV3} */
2336
3828
  declare function ProductSizeSellerFilterSchemaV3(): ProductSizeSellerFilterSchemaV3;
2337
3829
  type ProductSizeSellerFilterSchemaV3 = {
3830
+ /**
3831
+ * - The name of the store/seller.
3832
+ */
2338
3833
  name?: string;
3834
+ /**
3835
+ * - Whether this filter criterion is selected.
3836
+ */
2339
3837
  is_selected?: boolean;
3838
+ /**
3839
+ * - The value associated with this store/seller.
3840
+ */
2340
3841
  value?: string;
2341
3842
  };
2342
3843
  /** @returns {ProductSizeSellersResponseV3} */
2343
3844
  declare function ProductSizeSellersResponseV3(): ProductSizeSellersResponseV3;
2344
3845
  type ProductSizeSellersResponseV3 = {
3846
+ /**
3847
+ * - A list of products with
3848
+ * size and price details available from various sellers.
3849
+ */
2345
3850
  items?: ProductSizePriceResponseV3[];
2346
3851
  page: Page;
3852
+ /**
3853
+ * - A list of sorting
3854
+ * and filtering criteria applied to the sellers' data.
3855
+ */
2347
3856
  sort_on?: ProductSizeSellerFilterSchemaV3[];
2348
3857
  };