@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.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 (229) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
  4. package/sdk/application/Cart/CartApplicationClient.js +5 -3
  5. package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
  6. package/sdk/application/Cart/CartApplicationModel.js +74 -0
  7. package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
  8. package/sdk/application/Cart/CartApplicationValidator.js +4 -0
  9. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
  10. package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
  11. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
  12. package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
  13. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
  14. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
  15. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
  16. package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
  17. package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
  18. package/sdk/application/Content/ContentApplicationClient.js +246 -0
  19. package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
  20. package/sdk/application/Content/ContentApplicationModel.js +252 -0
  21. package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
  22. package/sdk/application/Content/ContentApplicationValidator.js +41 -0
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
  25. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
  26. package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
  27. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
  28. package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
  29. package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
  30. package/sdk/application/Order/OrderApplicationClient.js +32 -8
  31. package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
  32. package/sdk/application/Order/OrderApplicationModel.js +6 -0
  33. package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
  34. package/sdk/application/Order/OrderApplicationValidator.js +8 -0
  35. package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
  36. package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
  37. package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
  38. package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
  39. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
  40. package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
  41. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
  42. package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
  43. package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
  44. package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
  45. package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
  46. package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
  47. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
  48. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
  49. package/sdk/application/User/UserApplicationClient.d.ts +33 -0
  50. package/sdk/application/User/UserApplicationClient.js +239 -0
  51. package/sdk/application/User/UserApplicationModel.d.ts +28 -13
  52. package/sdk/application/User/UserApplicationModel.js +36 -12
  53. package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
  54. package/sdk/application/User/UserApplicationValidator.js +36 -0
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
  56. package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
  58. package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
  59. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
  60. package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
  62. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
  63. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
  64. package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
  65. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
  66. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
  67. package/sdk/partner/PartnerClient.d.ts +6 -0
  68. package/sdk/partner/PartnerClient.js +9 -0
  69. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
  70. package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
  71. package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
  72. package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
  73. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
  74. package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
  75. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
  76. package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
  77. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
  78. package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
  79. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
  80. package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
  81. package/sdk/partner/index.d.ts +3 -0
  82. package/sdk/partner/index.js +6 -0
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
  84. package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
  85. package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
  86. package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
  87. package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
  88. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
  89. package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
  90. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
  91. package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
  92. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
  93. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
  94. package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
  95. package/sdk/platform/Cart/CartPlatformModel.js +71 -4
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
  97. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
  98. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
  100. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
  101. package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
  102. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
  103. package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
  104. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
  105. package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
  106. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
  110. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
  111. package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
  112. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
  113. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
  114. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
  118. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
  119. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
  120. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
  121. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
  122. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
  123. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
  124. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
  125. package/sdk/platform/Content/ContentPlatformApplicationClient.js +3630 -1059
  126. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +342 -1
  127. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +401 -0
  128. package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
  129. package/sdk/platform/Content/ContentPlatformClient.js +2000 -0
  130. package/sdk/platform/Content/ContentPlatformModel.d.ts +1094 -1
  131. package/sdk/platform/Content/ContentPlatformModel.js +1356 -46
  132. package/sdk/platform/Content/ContentPlatformValidator.d.ts +238 -0
  133. package/sdk/platform/Content/ContentPlatformValidator.js +310 -0
  134. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
  137. package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
  141. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -5
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +18 -4
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
  145. package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
  147. package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
  148. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
  149. package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
  150. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
  151. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
  152. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
  153. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
  154. package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
  155. package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
  156. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
  157. package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
  158. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
  159. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
  160. package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
  161. package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
  162. package/sdk/platform/Order/OrderPlatformModel.d.ts +1030 -468
  163. package/sdk/platform/Order/OrderPlatformModel.js +1176 -523
  164. package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
  165. package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
  166. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
  167. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
  168. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
  169. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
  170. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
  171. package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
  172. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
  173. package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
  174. package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
  175. package/sdk/platform/PlatformApplicationClient.js +4 -4
  176. package/sdk/platform/PlatformClient.d.ts +4 -2
  177. package/sdk/platform/PlatformClient.js +8 -4
  178. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
  179. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
  180. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
  181. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
  182. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
  183. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
  188. package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
  189. package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
  190. package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
  191. package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
  192. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
  193. package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
  194. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
  195. package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
  196. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
  197. package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
  198. package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
  199. package/sdk/platform/User/UserPlatformModel.js +256 -5
  200. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
  201. package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
  202. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
  203. package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
  204. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
  205. package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
  206. package/sdk/platform/index.d.ts +1 -1
  207. package/sdk/platform/index.js +2 -2
  208. package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
  209. package/sdk/public/Billing/BillingPublicClient.js +116 -0
  210. package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
  211. package/sdk/public/Billing/BillingPublicModel.js +96 -0
  212. package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
  213. package/sdk/public/Billing/BillingPublicValidator.js +19 -0
  214. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  215. package/sdk/public/Content/ContentPublicClient.js +114 -0
  216. package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
  217. package/sdk/public/Content/ContentPublicModel.js +60 -0
  218. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
  219. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  220. package/sdk/public/PublicClient.d.ts +4 -0
  221. package/sdk/public/PublicClient.js +8 -0
  222. package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
  223. package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
  224. package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
  225. package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
  226. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
  227. package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
  228. package/sdk/public/index.d.ts +2 -0
  229. package/sdk/public/index.js +4 -0
@@ -20,6 +20,7 @@ export = ConfigurationPlatformModel;
20
20
  * @property {boolean} [bulk_coupons] - Allow creation of bulk coupons
21
21
  * @property {DeliveryCharges} [delivery_charges]
22
22
  * @property {boolean} [enabled] - Shows whether cart configuration is enabled or not
23
+ * @property {InternationalDeliveryCharges} [international_delivery_charges]
23
24
  * @property {number} [max_cart_items] - Maximum number of items that can be
24
25
  * added to cart by the customer
25
26
  * @property {number} [min_cart_value] - Minimum cart value below which customer
@@ -30,9 +31,15 @@ export = ConfigurationPlatformModel;
30
31
  */
31
32
  /**
32
33
  * @typedef AppCurrencyResponse
34
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
35
+ * of the currency configuration supported by the application
33
36
  * @property {string} [application] - Alphanumeric ID allotted to an application
34
37
  * (sales channel website) created within a business account
38
+ * @property {string} [created_at] - ISO 8601 timestamp when currency was added
39
+ * in the list of currencies supported by the sales channel
35
40
  * @property {DefaultCurrency} [default_currency]
41
+ * @property {string} [modified_at] - ISO 8601 timestamp when currency was
42
+ * updated in the list of currencies supported by the sales channel
36
43
  * @property {Currency[]} [supported_currency]
37
44
  */
38
45
  /**
@@ -51,13 +58,13 @@ export = ConfigurationPlatformModel;
51
58
  * the features were configured
52
59
  * @property {HomePageFeature} [home_page]
53
60
  * @property {LandingPageFeature} [landing_page]
61
+ * @property {string} [modified_at] - ISO 8601 timestamp of last known
62
+ * modifications to the sales channel feature configuration
54
63
  * @property {OrderFeature} [order]
55
64
  * @property {PcrFeature} [pcr]
56
65
  * @property {ProductDetailFeature} [product_detail]
57
66
  * @property {QrFeature} [qr]
58
67
  * @property {RegistrationPageFeature} [registration_page]
59
- * @property {string} [updated_at] - ISO 8601 timestamp of last known
60
- * modifications to the sales channel feature configuration
61
68
  */
62
69
  /**
63
70
  * @typedef AppFeatureRequest
@@ -70,16 +77,8 @@ export = ConfigurationPlatformModel;
70
77
  /**
71
78
  * @typedef AppInventory
72
79
  * @property {InventoryArticleAssignment} [article_assignment]
73
- * @property {InventoryBrandRule} [brand]
74
- * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
75
- * to consume the current sales channel's inventory and sell products
76
- * @property {string[]} [image]
77
- * @property {boolean} [only_verified_products] - Show only verified products
78
- * (the ones whose data have been verified by the admin)
79
- * @property {boolean} [out_of_stock] - Indicates whether out of stock products
80
- * are allowed to show up on the website.
80
+ * @property {InventoryConfig} [inventory]
81
81
  * @property {InventoryPaymentConfig} [payment]
82
- * @property {InventoryStoreRule} [store]
83
82
  */
84
83
  /**
85
84
  * @typedef AppInventoryCompanies
@@ -92,6 +91,7 @@ export = ConfigurationPlatformModel;
92
91
  * @typedef AppInventoryConfig
93
92
  * @property {InventoryBrand} [brand]
94
93
  * @property {InventoryCategory} [category]
94
+ * @property {number} [company_id]
95
95
  * @property {Object[]} [company_store] - List of selling locations whose
96
96
  * inventory is available to the sales channel for displaying on the website
97
97
  * @property {InventoryDiscount} [discount]
@@ -120,10 +120,12 @@ export = ConfigurationPlatformModel;
120
120
  * @typedef AppInventoryStores
121
121
  * @property {string} [_id] - The unique identifier of the store (24-digit Mongo
122
122
  * Object ID) in the sales channel inventory
123
+ * @property {Object} [address]
123
124
  * @property {number} [company_id] - Company ID of the selling location (store)
124
125
  * added to the sales channel's inventory
125
126
  * @property {string} [display_name] - Display name of the sales channel
126
127
  * inventory store (can be different than the actual store name), e.g. Reebok MUM
128
+ * @property {Object} [integration_type]
127
129
  * @property {string} [modified_on] - ISO 8601 timestamp of last known updation
128
130
  * to the stores in sales channel inventory
129
131
  * @property {string} [name] - Name of the store in the sales channel inventory,
@@ -161,14 +163,18 @@ export = ConfigurationPlatformModel;
161
163
  * @property {SecureUrl} [logo]
162
164
  * @property {ApplicationMeta[]} [meta]
163
165
  * @property {SecureUrl} [mobile_logo]
166
+ * @property {string} [mode]
167
+ * @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
164
168
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
165
169
  * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
166
170
  * of owner who owns the application
167
171
  * @property {ApplicationRedirections[]} [redirections]
172
+ * @property {string} [secret]
168
173
  * @property {string} [slug]
174
+ * @property {string} [status]
169
175
  * @property {string} [token] - Random generated fix length string for sales
170
176
  * channel. It is required and auto-generated.
171
- * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
177
+ * @property {TokenSchema[]} [tokens]
172
178
  * @property {ApplicationWebsite} [website]
173
179
  */
174
180
  /**
@@ -184,6 +190,7 @@ export = ConfigurationPlatformModel;
184
190
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
185
191
  * for the sales channel details
186
192
  * @property {SecureUrl} [banner]
193
+ * @property {number} [company_id]
187
194
  * @property {string} [description] - It gives a detailed information about the
188
195
  * sales channel. It is required.
189
196
  * @property {Domain} [domain]
@@ -192,6 +199,7 @@ export = ConfigurationPlatformModel;
192
199
  * @property {SecureUrl} [logo]
193
200
  * @property {SecureUrl} [mobile_logo]
194
201
  * @property {string} name - Name of the sales channel. It is required.
202
+ * @property {string} [slug]
195
203
  */
196
204
  /**
197
205
  * @typedef ApplicationInformation
@@ -201,19 +209,20 @@ export = ConfigurationPlatformModel;
201
209
  * @property {InformationAddress} [address]
202
210
  * @property {string} [application] - Alphanumeric ID allotted to a sales
203
211
  * channel application created within a business account
204
- * @property {BusinessHighlights} [business_highlights]
212
+ * @property {BusinessHighlights[]} [business_highlights]
205
213
  * @property {string} [copyright_text] - Copyright statement usually seen at the
206
214
  * site's footer
207
215
  * @property {string} [created_at] - ISO 8601 timestamp of creation of the
208
216
  * application information
209
217
  * @property {Links[]} [links]
218
+ * @property {string} [modified_at] - ISO 8601 timestamp of updation of the
219
+ * application information
210
220
  * @property {SocialLinks} [social_links]
211
221
  * @property {InformationSupport} [support]
212
- * @property {string} [updated_at] - ISO 8601 timestamp of updation of the
213
- * application information
214
222
  */
215
223
  /**
216
224
  * @typedef ApplicationInventory
225
+ * @property {number} [__v]
217
226
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
218
227
  * of the sales channel inventory
219
228
  * @property {string} [app] - Current sales channel ID
@@ -230,14 +239,16 @@ export = ConfigurationPlatformModel;
230
239
  * @property {AppInventoryConfig} [inventory]
231
240
  * @property {AppLogisticsConfig} [logistics]
232
241
  * @property {LoyaltyPointsConfig} [loyalty_points]
242
+ * @property {string} [modified_at] - ISO 8601 timestamp of sales channel
243
+ * inventory updation
233
244
  * @property {string} [modified_by] - User ID of the person who made the latest
234
245
  * changes in the sales channel inventory
235
246
  * @property {AppOrderConfig} [order]
236
247
  * @property {AppPaymentConfig} [payment]
248
+ * @property {PiiMasking} [pii_masking]
237
249
  * @property {string[]} [platforms]
238
250
  * @property {RewardPointsConfig} [reward_points]
239
- * @property {string} [updated_at] - ISO 8601 timestamp of sales channel
240
- * inventory updation
251
+ * @property {string[]} [tags]
241
252
  */
242
253
  /**
243
254
  * @typedef ApplicationMeta
@@ -291,10 +302,11 @@ export = ConfigurationPlatformModel;
291
302
  * @property {PaymentSelectionLock} [payment_selection_lock]
292
303
  * @property {string} [source] - Source of the payment mode, e.g. 'ECOMM'.
293
304
  * Default value is FYND.
305
+ * @property {number} [user_cod_limit]
294
306
  */
295
307
  /**
296
308
  * @typedef AppStoreRules
297
- * @property {Object[]} [brands] - List of brands whose products will be shown
309
+ * @property {number[]} [brands] - List of brands whose products will be shown
298
310
  * on the website
299
311
  * @property {number[]} [companies] - List of companies whose inventory is
300
312
  * available to the sales channel for displaying on the website
@@ -308,12 +320,13 @@ export = ConfigurationPlatformModel;
308
320
  * @property {string} [created_at] - ISO 8601 timestamp when currency was added
309
321
  * in the list of currencies supported by the sales channel
310
322
  * @property {DefaultCurrency} [default_currency]
311
- * @property {string[]} [supported_currency]
312
- * @property {string} [updated_at] - ISO 8601 timestamp when currency was
323
+ * @property {string} [modified_at] - ISO 8601 timestamp when currency was
313
324
  * updated in the list of currencies supported by the sales channel
325
+ * @property {string[]} [supported_currency]
314
326
  */
315
327
  /**
316
328
  * @typedef ArticleAssignmentConfig
329
+ * @property {number[]} [enforced_stores]
317
330
  * @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
318
331
  * @property {ArticleAssignmentRules} [rules]
319
332
  */
@@ -344,7 +357,7 @@ export = ConfigurationPlatformModel;
344
357
  */
345
358
  /**
346
359
  * @typedef BrandsByCompanyResponse
347
- * @property {CompanyBrandInfo} [brands]
360
+ * @property {CompanyBrandInfo[]} [brands]
348
361
  */
349
362
  /**
350
363
  * @typedef BrandStoreInfo
@@ -365,10 +378,11 @@ export = ConfigurationPlatformModel;
365
378
  * @property {string} [build_status] - Current progress of the mobile build,
366
379
  * e.g. pending, cancelled, failed, success
367
380
  * @property {string} [created_at] - ISO 8601 timestamp of app creation
381
+ * @property {LandingImage} [download_url]
382
+ * @property {string} [modified_at] - ISO 8601 timestamp of last known
383
+ * modifications to the app build
368
384
  * @property {string} [platform_type] - Device platform for which the mobile app
369
385
  * was built, e.g. android, ios.
370
- * @property {string} [updated_at] - ISO 8601 timestamp of last known
371
- * modifications to the app build
372
386
  * @property {number} [version_code] - A positive integer used as an internal
373
387
  * version number
374
388
  * @property {string} [version_name] - Version number of the mobile build, in
@@ -378,7 +392,7 @@ export = ConfigurationPlatformModel;
378
392
  * @typedef BuildVersionHistory
379
393
  * @property {string} [latest_available_version_name] - Latest version number of
380
394
  * the mobile build, in dot-decimal notation
381
- * @property {BuildVersion} [versions]
395
+ * @property {BuildVersion[]} [versions]
382
396
  */
383
397
  /**
384
398
  * @typedef BusinessHighlights
@@ -420,6 +434,8 @@ export = ConfigurationPlatformModel;
420
434
  * @property {CurrencyFeature} [currency]
421
435
  * @property {DeploymentStoreSelectionFeature} [deployment_store_selection]
422
436
  * @property {FeedbackFeature} [feedback]
437
+ * @property {InternationalShipping} [international_shipping]
438
+ * @property {ListingPageFeature} [listing_page]
423
439
  * @property {ListingPriceFeature} [listing_price]
424
440
  * @property {RevenueEngineFeature} [revenue_engine]
425
441
  * @property {RewardPointsConfig} [reward_points]
@@ -440,7 +456,7 @@ export = ConfigurationPlatformModel;
440
456
  */
441
457
  /**
442
458
  * @typedef CompaniesResponse
443
- * @property {AppInventoryCompanies} [items]
459
+ * @property {AppInventoryCompanies[]} [items]
444
460
  * @property {Page} [page]
445
461
  */
446
462
  /**
@@ -475,7 +491,7 @@ export = ConfigurationPlatformModel;
475
491
  /**
476
492
  * @typedef CreateApplicationRequest
477
493
  * @property {App} [app]
478
- * @property {AppInventory} [configuration]
494
+ * @property {ApplicationInventory} [configuration]
479
495
  * @property {AppDomain} [domain]
480
496
  */
481
497
  /**
@@ -510,6 +526,8 @@ export = ConfigurationPlatformModel;
510
526
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
511
527
  * of the current sales channel supported currency
512
528
  * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
529
+ * @property {string} [country_code]
530
+ * @property {string} [country_name]
513
531
  * @property {string} [created_at] - ISO 8601 timestamp of sales channel support
514
532
  * currency creation
515
533
  * @property {number} [decimal_digits] - Acceptable decimal limits for a given
@@ -517,10 +535,10 @@ export = ConfigurationPlatformModel;
517
535
  * value of a currency.
518
536
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
519
537
  * sales channel
538
+ * @property {string} [modified_at] - ISO 8601 timestamp of sales channel
539
+ * support currency updation
520
540
  * @property {string} [name] - Name of the currency, e.g Indian Rupee
521
541
  * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
522
- * @property {string} [updated_at] - ISO 8601 timestamp of sales channel support
523
- * currency updation
524
542
  */
525
543
  /**
526
544
  * @typedef CurrencyFeature
@@ -550,6 +568,7 @@ export = ConfigurationPlatformModel;
550
568
  */
551
569
  /**
552
570
  * @typedef DeploymentMeta
571
+ * @property {number} [__v]
553
572
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
554
573
  * of the ordering stores
555
574
  * @property {boolean} [all_stores] - Allow all stores from the ordering store
@@ -577,6 +596,7 @@ export = ConfigurationPlatformModel;
577
596
  * @property {boolean} [is_primary] - Domain is primary or not. Primary domain
578
597
  * is the default/main domain.
579
598
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
599
+ * @property {string} [message]
580
600
  * @property {string} [name] - Full domain name, e.g. newton.com
581
601
  * @property {boolean} [verified] - Domain is verified or not. TXT and A records
582
602
  * should propagate correctly.
@@ -682,6 +702,7 @@ export = ConfigurationPlatformModel;
682
702
  */
683
703
  /**
684
704
  * @typedef FyndRewardsCredentials
705
+ * @property {string} [private_key] - Public key for integrating with Fynd rewards.
685
706
  * @property {string} [public_key] - Public key for integrating with Fynd rewards.
686
707
  */
687
708
  /**
@@ -724,10 +745,15 @@ export = ConfigurationPlatformModel;
724
745
  * @property {string[]} [address_line] - Contact address of the sales channel
725
746
  * @property {string} [city] - Name of the city, e.g. Mumbai
726
747
  * @property {string} [country] - Name of the country, e.g. India
727
- * @property {string} [loc] - Co-ordinates of the location
748
+ * @property {InformationLoc} [loc]
728
749
  * @property {InformationPhone[]} [phone]
729
750
  * @property {number} [pincode] - 6-digit PIN Code of the city, e.g. 400001
730
751
  */
752
+ /**
753
+ * @typedef InformationLoc
754
+ * @property {number[]} [coordinates] - 10-digit mobile number
755
+ * @property {string} [type] - Country code for contact number, e.g. +91 (for India)
756
+ */
731
757
  /**
732
758
  * @typedef InformationPhone
733
759
  * @property {string} [code] - Country code for contact number, e.g. +91 (for India)
@@ -735,10 +761,21 @@ export = ConfigurationPlatformModel;
735
761
  */
736
762
  /**
737
763
  * @typedef InformationSupport
738
- * @property {string[]} [email]
739
- * @property {string[]} [phone]
764
+ * @property {InformationSupportEmail[]} [email]
765
+ * @property {InformationSupportPhone[]} [phone]
740
766
  * @property {string} [timing] - Working hours of support team, e.g. 9 AM to 9 PM
741
767
  */
768
+ /**
769
+ * @typedef InformationSupportEmail
770
+ * @property {string} [key]
771
+ * @property {string} [value] - Value of email.
772
+ */
773
+ /**
774
+ * @typedef InformationSupportPhone
775
+ * @property {string} [code] - Country code for contact number, e.g. +91 (for India)
776
+ * @property {string} [key]
777
+ * @property {string} [number] - 10-digit mobile number
778
+ */
742
779
  /**
743
780
  * @typedef InstagramLink
744
781
  * @property {string} [icon] - Hosted URL of social icon image shown on the website
@@ -750,22 +787,24 @@ export = ConfigurationPlatformModel;
750
787
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
751
788
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
752
789
  * of the integration
753
- * @property {Object[]} [companies]
790
+ * @property {string[]} [companies]
754
791
  * @property {Object} [constants]
755
792
  * @property {string} [created_at] - ISO 8601 timestamp of integration creation
756
793
  * @property {string} [description] - Basic description about the integration
757
794
  * @property {string} [description_html] - Basic HTML description about the integration
795
+ * @property {boolean} [hidden]
758
796
  * @property {string} [icon] - Hosted URL of the icon image
759
797
  * @property {IntegrationMeta[]} [meta]
798
+ * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
760
799
  * @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
761
800
  * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
762
801
  * of the user who created the integration
763
802
  * @property {string} [secret] - Randomly generated fixed-length string for
764
803
  * opted integration. It is auto-generated. It would never change once it is generated.
804
+ * @property {string} [slug] - Name of the integration, e.g. SAP RBL Integration
765
805
  * @property {string[]} [support]
766
806
  * @property {string} [token] - Randomly generated fixed-length string for opted
767
807
  * integration. It is auto-generated. It would never change once it is generated.
768
- * @property {string} [updated_at] - ISO 8601 timestamp of integration updation
769
808
  * @property {Validators} [validators]
770
809
  */
771
810
  /**
@@ -777,6 +816,7 @@ export = ConfigurationPlatformModel;
777
816
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
778
817
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
779
818
  * of the integration config
819
+ * @property {number} [company_id] - Unique id of company.
780
820
  * @property {string} [created_at] - ISO 8601 timestamp of integration config creation
781
821
  * @property {Object} [data] - Schema data of the integration stored in key-value pairs
782
822
  * @property {string} [integration] - Integration id. Shows which integration
@@ -784,15 +824,17 @@ export = ConfigurationPlatformModel;
784
824
  * @property {LastPatch[]} [last_patch]
785
825
  * @property {string} [level] - Shows for what level the integration is set up.
786
826
  * It can be company level or store level.
827
+ * @property {string} [message]
787
828
  * @property {IntegrationMeta[]} [meta]
829
+ * @property {string} [modified_at] - ISO 8601 timestamp of integration config updation
788
830
  * @property {boolean} [opted] - Shows this integration is opted or not opted
789
831
  * for the current company
790
832
  * @property {Object[]} [permissions]
833
+ * @property {boolean} [success]
791
834
  * @property {string} [token] - Randomly generated fixed-length string for opted
792
835
  * integration. It is auto-generated. It would never change once it is generated.
793
836
  * @property {number} [uid] - It can be store uid or company uid. Depends on the
794
837
  * level of integration.
795
- * @property {string} [updated_at] - ISO 8601 timestamp of integration config updation
796
838
  */
797
839
  /**
798
840
  * @typedef IntegrationMeta
@@ -807,28 +849,40 @@ export = ConfigurationPlatformModel;
807
849
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
808
850
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
809
851
  * of the opted integration
810
- * @property {Object[]} [companies]
852
+ * @property {string[]} [companies]
811
853
  * @property {string} [constants]
812
854
  * @property {string} [created_at] - ISO 8601 timestamp of integration creation
813
855
  * @property {string} [description] - Basic description about the opted integration
814
856
  * @property {string} [description_html] - Basic HTML description about the
815
857
  * opted integration
858
+ * @property {boolean} [hidden]
816
859
  * @property {string} [icon] - Hosted URL of the icon image
817
860
  * @property {IntegrationMeta[]} [meta]
861
+ * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
818
862
  * @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
819
863
  * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
820
864
  * of the user who created the integration
821
865
  * @property {string} [secret] - Randomly generated fixed-length string for
822
866
  * opted integration. It is auto-generated. It would never change once it is generated.
867
+ * @property {string} [slug] - Slug of the opted integration, e.g. ginesys
823
868
  * @property {string[]} [support]
824
869
  * @property {string} [token] - Randomly generated fixed-length string for opted
825
870
  * integration. It is auto-generated. It would never change once it is generated.
826
- * @property {string} [updated_at] - ISO 8601 timestamp of integration updation
827
871
  * @property {Validators} [validators]
828
872
  */
873
+ /**
874
+ * @typedef InternationalDeliveryCharges
875
+ * @property {Charges[]} [charges]
876
+ * @property {boolean} [enabled] - Allow international delivery charges
877
+ */
878
+ /**
879
+ * @typedef InternationalShipping
880
+ * @property {boolean} [enabled] - International shipping is enabled or not.
881
+ */
829
882
  /**
830
883
  * @typedef InvalidPayloadRequest
831
884
  * @property {string} [message] - Error message when request body payload is improper
885
+ * @property {boolean} [success] - Flag for required not successfull.
832
886
  */
833
887
  /**
834
888
  * @typedef InventoryArticleAssignment
@@ -837,7 +891,7 @@ export = ConfigurationPlatformModel;
837
891
  */
838
892
  /**
839
893
  * @typedef InventoryBrand
840
- * @property {Object[]} [brands] - List of brands
894
+ * @property {number[]} [brands] - List of brands
841
895
  * @property {string} [criteria] - All brands or specific (explicit) brands to
842
896
  * be shown on the website
843
897
  */
@@ -853,6 +907,18 @@ export = ConfigurationPlatformModel;
853
907
  * shown on the website
854
908
  * @property {string} [criteria]
855
909
  */
910
+ /**
911
+ * @typedef InventoryConfig
912
+ * @property {InventoryBrandRule} [brand]
913
+ * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
914
+ * to consume the current sales channel's inventory and sell products
915
+ * @property {string[]} [image]
916
+ * @property {boolean} [only_verified_products] - Show only verified products
917
+ * (the ones whose data have been verified by the admin)
918
+ * @property {boolean} [out_of_stock] - Indicates whether out of stock products
919
+ * are allowed to show up on the website.
920
+ * @property {InventoryStoreRule} [store]
921
+ */
856
922
  /**
857
923
  * @typedef InventoryDiscount
858
924
  * @property {number} [max] - Maximum inventory discount
@@ -945,6 +1011,10 @@ export = ConfigurationPlatformModel;
945
1011
  * @property {string} [link] - Web URL for redirecting to a related page
946
1012
  * @property {string} [title] - Name of the related page or link
947
1013
  */
1014
+ /**
1015
+ * @typedef ListingPageFeature
1016
+ * @property {string} [sort_on]
1017
+ */
948
1018
  /**
949
1019
  * @typedef ListingPriceFeature
950
1020
  * @property {string} [sort] - Sorting of listing price with min or max value.
@@ -998,13 +1068,13 @@ export = ConfigurationPlatformModel;
998
1068
  * configuration creation
999
1069
  * @property {boolean} [is_active] - Indicates the availability of the mobile build
1000
1070
  * @property {LandingImage} [landing_image]
1071
+ * @property {string} [modified_at] - ISO 8601 timestamp of last known
1072
+ * modifications to the app build
1001
1073
  * @property {string} [package_name] - Shows bundle identifier if device
1002
1074
  * platform is iOS, and directory of the app if device platform is Android
1003
1075
  * @property {string} [platform_type] - Device platform for which the mobile app
1004
1076
  * was built, e.g. android, ios.
1005
1077
  * @property {SplashImage} [splash_image]
1006
- * @property {string} [updated_at] - ISO 8601 timestamp of last known
1007
- * modifications to the app build
1008
1078
  */
1009
1079
  /**
1010
1080
  * @typedef Moengage
@@ -1021,6 +1091,7 @@ export = ConfigurationPlatformModel;
1021
1091
  /**
1022
1092
  * @typedef NotFound
1023
1093
  * @property {string} [message] - Response message for not found
1094
+ * @property {boolean} [success] - Flag for required not successfull.
1024
1095
  */
1025
1096
  /**
1026
1097
  * @typedef OptedApplicationResponse
@@ -1035,6 +1106,7 @@ export = ConfigurationPlatformModel;
1035
1106
  */
1036
1107
  /**
1037
1108
  * @typedef OptedCompany
1109
+ * @property {number} [id] - The unique identifier of the opted inventory company
1038
1110
  * @property {string} [name] - Name of the company opted by the other seller's
1039
1111
  * sales channel in its inventory
1040
1112
  * @property {number} [uid] - Company UID opted by the other seller's sales
@@ -1042,7 +1114,7 @@ export = ConfigurationPlatformModel;
1042
1114
  */
1043
1115
  /**
1044
1116
  * @typedef OptedInventory
1045
- * @property {Object} [items]
1117
+ * @property {Object[]} [items]
1046
1118
  * @property {OptType} [opt_type]
1047
1119
  */
1048
1120
  /**
@@ -1066,9 +1138,12 @@ export = ConfigurationPlatformModel;
1066
1138
  * @property {string} [address2] - Address of the opted store
1067
1139
  * @property {string} [city] - City of the opted store, e.g. Mumbai
1068
1140
  * @property {string} [country] - Country of the opted store, e.g. India
1141
+ * @property {string} [country_code] - Country code of the selected country
1069
1142
  * @property {StoreLatLong} [lat_long]
1070
1143
  * @property {number} [pincode] - 6-digit PIN code of the opted store location
1144
+ * @property {string} [sector] - Sector for the opted store.
1071
1145
  * @property {string} [state] - State of the opted store, e.g. Maharashtra
1146
+ * @property {string} [state_code] - Selected state code
1072
1147
  */
1073
1148
  /**
1074
1149
  * @typedef OptedStoreIntegration
@@ -1159,14 +1234,14 @@ export = ConfigurationPlatformModel;
1159
1234
  * @property {string} [level] - Indicates integration level. It can be company
1160
1235
  * level or store level.
1161
1236
  * @property {Object[]} [meta]
1237
+ * @property {string} [modified_at] - ISO 8601 timestamp of other entity
1238
+ * updation for opted store integration
1162
1239
  * @property {boolean} [opted] - Allow other entity opted in integration
1163
1240
  * @property {string[]} [permissions]
1164
1241
  * @property {string} [token] - Randomly generated fixed-length string for opted
1165
1242
  * integration. It is auto-generated. It would never change once it is generated.
1166
1243
  * @property {number} [uid] - It can be store uid or company uid. Depends on the
1167
1244
  * level of integration.
1168
- * @property {string} [updated_at] - ISO 8601 timestamp of other entity updation
1169
- * for opted store integration
1170
1245
  */
1171
1246
  /**
1172
1247
  * @typedef OtherEntityData
@@ -1228,6 +1303,10 @@ export = ConfigurationPlatformModel;
1228
1303
  * @typedef PcrFeature
1229
1304
  * @property {boolean} [staff_selection] - Allow staff selection. Default value is false.
1230
1305
  */
1306
+ /**
1307
+ * @typedef PiiMasking
1308
+ * @property {boolean} [enabled]
1309
+ */
1231
1310
  /**
1232
1311
  * @typedef PinterestLink
1233
1312
  * @property {string} [icon] - Hosted URL of social icon image shown on the website
@@ -1350,7 +1429,7 @@ export = ConfigurationPlatformModel;
1350
1429
  */
1351
1430
  /**
1352
1431
  * @typedef StoresResponse
1353
- * @property {AppInventoryStores} [items]
1432
+ * @property {AppInventoryStores[]} [items]
1354
1433
  * @property {Page} [page]
1355
1434
  */
1356
1435
  /**
@@ -1371,8 +1450,8 @@ export = ConfigurationPlatformModel;
1371
1450
  * @property {string} [application] - Alphanumeric ID allotted to the current
1372
1451
  * application created within the current business account
1373
1452
  * @property {string} [created_at] - ISO 8601 timestamp of token creation
1453
+ * @property {string} [modified_at] - ISO 8601 timestamp of token updation
1374
1454
  * @property {Tokens} [tokens]
1375
- * @property {string} [updated_at] - ISO 8601 timestamp of token updation
1376
1455
  */
1377
1456
  /**
1378
1457
  * @typedef Tokens
@@ -1385,6 +1464,12 @@ export = ConfigurationPlatformModel;
1385
1464
  * @property {Safetynet} [safetynet]
1386
1465
  * @property {Segment} [segment]
1387
1466
  */
1467
+ /**
1468
+ * @typedef TokenSchema
1469
+ * @property {string} [created_at] - ISO 8601 timestamp of when token created
1470
+ * @property {Object} [created_by]
1471
+ * @property {string} [token]
1472
+ */
1388
1473
  /**
1389
1474
  * @typedef TwitterLink
1390
1475
  * @property {string} [icon] - Hosted URL of social icon image shown on the website
@@ -1439,7 +1524,7 @@ export = ConfigurationPlatformModel;
1439
1524
  declare class ConfigurationPlatformModel {
1440
1525
  }
1441
1526
  declare namespace ConfigurationPlatformModel {
1442
- export { Android, App, AppCartConfig, AppCurrencyResponse, AppDomain, AppFeature, AppFeatureRequest, AppFeatureResponse, AppInventory, AppInventoryCompanies, AppInventoryConfig, AppInventoryPartialUpdate, AppInventoryStores, Application, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInformation, ApplicationInventory, ApplicationMeta, ApplicationRedirections, ApplicationsResponse, ApplicationWebsite, AppLogisticsConfig, AppOrderConfig, AppPaymentConfig, AppStoreRules, AppSupportedCurrency, ArticleAssignmentConfig, ArticleAssignmentRule, ArticleAssignmentRules, AuthenticationConfig, BlogLink, BrandCompanyInfo, BrandsByCompanyResponse, BrandStoreInfo, BuildVersion, BuildVersionHistory, BusinessHighlights, CallbackUrl, CartFeature, Charges, CommonFeature, CommsConfig, CommunicationConfig, CommunicationOptinDialogFeature, CompaniesResponse, CompanyBrandInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, CompanyValidator, CompareProductsFeature, CreateApplicationRequest, CreateAppResponse, Credentials, Credit, CurrenciesResponse, Currency, CurrencyFeature, Debit, DefaultCurrency, DeliveryCharges, DeploymentMeta, DeploymentStoreSelectionFeature, Domain, DomainAdd, DomainAddRequest, DomainsResponse, DomainStatus, DomainStatusRequest, DomainStatusResponse, DomainSuggestion, DomainSuggestionsRequest, DomainSuggestionsResponse, FacebookLink, FeedbackFeature, FilterOrderingStoreRequest, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GetIntegrationsOptInsResponse, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationPhone, InformationSupport, InstagramLink, Integration, IntegrationConfigResponse, IntegrationLevel, IntegrationMeta, IntegrationOptIn, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrand, InventoryBrandRule, InventoryCategory, InventoryDiscount, InventoryPaymentConfig, InventoryPrice, InventoryStore, InventoryStoreRule, InventoryValidator, Ios, JsonSchema, LandingImage, LandingPageFeature, LastPatch, LaunchPage, LinkedInLink, Links, ListingPriceFeature, LoyaltyPointsConfig, Methods, MobileAppConfigRequest, MobileAppConfiguration, Moengage, MoengageCredentials, NotFound, OptedApplicationResponse, OptedCompany, OptedInventory, OptedStore, OptedStoreAddress, OptedStoreIntegration, OptOutInventory, OptType, OrderFeature, OrderingStore, OrderingStoreConfig, OrderingStores, OrderingStoreSelect, OrderingStoreSelectRequest, OrderingStoresResponse, OrderValidator, OtherEntity, OtherEntityData, OtherSellerApplication, OtherSellerApplications, OtherSellerCompany, Page, PanCardConfig, PaymentModeConfig, PaymentSelectionLock, PcrFeature, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, SplashImage, StoreByBrandsRequest, StoreByBrandsResponse, StoreCriteriaRule, StoreLatLong, StorePriority, StorePriorityRule, StoresResponse, StoreValidator, SuccessMessageResponse, TokenResponse, Tokens, TwitterLink, UpdateDomain, UpdateDomainTypeRequest, UpdateIntegrationLevelRequest, ValidationFailedResponse, Validators, VimeoLink, YoutubeLink };
1527
+ export { Android, App, AppCartConfig, AppCurrencyResponse, AppDomain, AppFeature, AppFeatureRequest, AppFeatureResponse, AppInventory, AppInventoryCompanies, AppInventoryConfig, AppInventoryPartialUpdate, AppInventoryStores, Application, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInformation, ApplicationInventory, ApplicationMeta, ApplicationRedirections, ApplicationsResponse, ApplicationWebsite, AppLogisticsConfig, AppOrderConfig, AppPaymentConfig, AppStoreRules, AppSupportedCurrency, ArticleAssignmentConfig, ArticleAssignmentRule, ArticleAssignmentRules, AuthenticationConfig, BlogLink, BrandCompanyInfo, BrandsByCompanyResponse, BrandStoreInfo, BuildVersion, BuildVersionHistory, BusinessHighlights, CallbackUrl, CartFeature, Charges, CommonFeature, CommsConfig, CommunicationConfig, CommunicationOptinDialogFeature, CompaniesResponse, CompanyBrandInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, CompanyValidator, CompareProductsFeature, CreateApplicationRequest, CreateAppResponse, Credentials, Credit, CurrenciesResponse, Currency, CurrencyFeature, Debit, DefaultCurrency, DeliveryCharges, DeploymentMeta, DeploymentStoreSelectionFeature, Domain, DomainAdd, DomainAddRequest, DomainsResponse, DomainStatus, DomainStatusRequest, DomainStatusResponse, DomainSuggestion, DomainSuggestionsRequest, DomainSuggestionsResponse, FacebookLink, FeedbackFeature, FilterOrderingStoreRequest, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GetIntegrationsOptInsResponse, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationLoc, InformationPhone, InformationSupport, InformationSupportEmail, InformationSupportPhone, InstagramLink, Integration, IntegrationConfigResponse, IntegrationLevel, IntegrationMeta, IntegrationOptIn, InternationalDeliveryCharges, InternationalShipping, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrand, InventoryBrandRule, InventoryCategory, InventoryConfig, InventoryDiscount, InventoryPaymentConfig, InventoryPrice, InventoryStore, InventoryStoreRule, InventoryValidator, Ios, JsonSchema, LandingImage, LandingPageFeature, LastPatch, LaunchPage, LinkedInLink, Links, ListingPageFeature, ListingPriceFeature, LoyaltyPointsConfig, Methods, MobileAppConfigRequest, MobileAppConfiguration, Moengage, MoengageCredentials, NotFound, OptedApplicationResponse, OptedCompany, OptedInventory, OptedStore, OptedStoreAddress, OptedStoreIntegration, OptOutInventory, OptType, OrderFeature, OrderingStore, OrderingStoreConfig, OrderingStores, OrderingStoreSelect, OrderingStoreSelectRequest, OrderingStoresResponse, OrderValidator, OtherEntity, OtherEntityData, OtherSellerApplication, OtherSellerApplications, OtherSellerCompany, Page, PanCardConfig, PaymentModeConfig, PaymentSelectionLock, PcrFeature, PiiMasking, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, SplashImage, StoreByBrandsRequest, StoreByBrandsResponse, StoreCriteriaRule, StoreLatLong, StorePriority, StorePriorityRule, StoresResponse, StoreValidator, SuccessMessageResponse, TokenResponse, Tokens, TokenSchema, TwitterLink, UpdateDomain, UpdateDomainTypeRequest, UpdateIntegrationLevelRequest, ValidationFailedResponse, Validators, VimeoLink, YoutubeLink };
1443
1528
  }
1444
1529
  /** @returns {Android} */
1445
1530
  declare function Android(): Android;
@@ -1489,6 +1574,7 @@ type AppCartConfig = {
1489
1574
  * - Shows whether cart configuration is enabled or not
1490
1575
  */
1491
1576
  enabled?: boolean;
1577
+ international_delivery_charges?: InternationalDeliveryCharges;
1492
1578
  /**
1493
1579
  * - Maximum number of items that can be
1494
1580
  * added to cart by the customer
@@ -1509,12 +1595,27 @@ type AppCartConfig = {
1509
1595
  /** @returns {AppCurrencyResponse} */
1510
1596
  declare function AppCurrencyResponse(): AppCurrencyResponse;
1511
1597
  type AppCurrencyResponse = {
1598
+ /**
1599
+ * - The unique identifier (24-digit Mongo Object ID)
1600
+ * of the currency configuration supported by the application
1601
+ */
1602
+ _id?: string;
1512
1603
  /**
1513
1604
  * - Alphanumeric ID allotted to an application
1514
1605
  * (sales channel website) created within a business account
1515
1606
  */
1516
1607
  application?: string;
1608
+ /**
1609
+ * - ISO 8601 timestamp when currency was added
1610
+ * in the list of currencies supported by the sales channel
1611
+ */
1612
+ created_at?: string;
1517
1613
  default_currency?: DefaultCurrency;
1614
+ /**
1615
+ * - ISO 8601 timestamp when currency was
1616
+ * updated in the list of currencies supported by the sales channel
1617
+ */
1618
+ modified_at?: string;
1518
1619
  supported_currency?: Currency[];
1519
1620
  };
1520
1621
  /** @returns {AppDomain} */
@@ -1550,16 +1651,16 @@ type AppFeature = {
1550
1651
  created_at?: string;
1551
1652
  home_page?: HomePageFeature;
1552
1653
  landing_page?: LandingPageFeature;
1654
+ /**
1655
+ * - ISO 8601 timestamp of last known
1656
+ * modifications to the sales channel feature configuration
1657
+ */
1658
+ modified_at?: string;
1553
1659
  order?: OrderFeature;
1554
1660
  pcr?: PcrFeature;
1555
1661
  product_detail?: ProductDetailFeature;
1556
1662
  qr?: QrFeature;
1557
1663
  registration_page?: RegistrationPageFeature;
1558
- /**
1559
- * - ISO 8601 timestamp of last known
1560
- * modifications to the sales channel feature configuration
1561
- */
1562
- updated_at?: string;
1563
1664
  };
1564
1665
  /** @returns {AppFeatureRequest} */
1565
1666
  declare function AppFeatureRequest(): AppFeatureRequest;
@@ -1575,25 +1676,8 @@ type AppFeatureResponse = {
1575
1676
  declare function AppInventory(): AppInventory;
1576
1677
  type AppInventory = {
1577
1678
  article_assignment?: InventoryArticleAssignment;
1578
- brand?: InventoryBrandRule;
1579
- /**
1580
- * - Allow other businesses (companies)
1581
- * to consume the current sales channel's inventory and sell products
1582
- */
1583
- franchise_enabled?: boolean;
1584
- image?: string[];
1585
- /**
1586
- * - Show only verified products
1587
- * (the ones whose data have been verified by the admin)
1588
- */
1589
- only_verified_products?: boolean;
1590
- /**
1591
- * - Indicates whether out of stock products
1592
- * are allowed to show up on the website.
1593
- */
1594
- out_of_stock?: boolean;
1679
+ inventory?: InventoryConfig;
1595
1680
  payment?: InventoryPaymentConfig;
1596
- store?: InventoryStoreRule;
1597
1681
  };
1598
1682
  /** @returns {AppInventoryCompanies} */
1599
1683
  declare function AppInventoryCompanies(): AppInventoryCompanies;
@@ -1617,6 +1701,7 @@ declare function AppInventoryConfig(): AppInventoryConfig;
1617
1701
  type AppInventoryConfig = {
1618
1702
  brand?: InventoryBrand;
1619
1703
  category?: InventoryCategory;
1704
+ company_id?: number;
1620
1705
  /**
1621
1706
  * - List of selling locations whose
1622
1707
  * inventory is available to the sales channel for displaying on the website
@@ -1668,6 +1753,7 @@ type AppInventoryStores = {
1668
1753
  * Object ID) in the sales channel inventory
1669
1754
  */
1670
1755
  _id?: string;
1756
+ address?: any;
1671
1757
  /**
1672
1758
  * - Company ID of the selling location (store)
1673
1759
  * added to the sales channel's inventory
@@ -1678,6 +1764,7 @@ type AppInventoryStores = {
1678
1764
  * inventory store (can be different than the actual store name), e.g. Reebok MUM
1679
1765
  */
1680
1766
  display_name?: string;
1767
+ integration_type?: any;
1681
1768
  /**
1682
1769
  * - ISO 8601 timestamp of last known updation
1683
1770
  * to the stores in sales channel inventory
@@ -1761,6 +1848,11 @@ type Application = {
1761
1848
  logo?: SecureUrl;
1762
1849
  meta?: ApplicationMeta[];
1763
1850
  mobile_logo?: SecureUrl;
1851
+ mode?: string;
1852
+ /**
1853
+ * - ISO 8601 timestamp of sales channel updation
1854
+ */
1855
+ modified_at?: string;
1764
1856
  /**
1765
1857
  * - Name of the sales channel, e.g. Zenz Fashion
1766
1858
  */
@@ -1771,16 +1863,15 @@ type Application = {
1771
1863
  */
1772
1864
  owner?: string;
1773
1865
  redirections?: ApplicationRedirections[];
1866
+ secret?: string;
1774
1867
  slug?: string;
1868
+ status?: string;
1775
1869
  /**
1776
1870
  * - Random generated fix length string for sales
1777
1871
  * channel. It is required and auto-generated.
1778
1872
  */
1779
1873
  token?: string;
1780
- /**
1781
- * - ISO 8601 timestamp of sales channel updation
1782
- */
1783
- updated_at?: string;
1874
+ tokens?: TokenSchema[];
1784
1875
  website?: ApplicationWebsite;
1785
1876
  };
1786
1877
  /** @returns {ApplicationAuth} */
@@ -1805,6 +1896,7 @@ type ApplicationDetail = {
1805
1896
  */
1806
1897
  _id?: string;
1807
1898
  banner?: SecureUrl;
1899
+ company_id?: number;
1808
1900
  /**
1809
1901
  * - It gives a detailed information about the
1810
1902
  * sales channel. It is required.
@@ -1819,6 +1911,7 @@ type ApplicationDetail = {
1819
1911
  * - Name of the sales channel. It is required.
1820
1912
  */
1821
1913
  name: string;
1914
+ slug?: string;
1822
1915
  };
1823
1916
  /** @returns {ApplicationInformation} */
1824
1917
  declare function ApplicationInformation(): ApplicationInformation;
@@ -1838,7 +1931,7 @@ type ApplicationInformation = {
1838
1931
  * channel application created within a business account
1839
1932
  */
1840
1933
  application?: string;
1841
- business_highlights?: BusinessHighlights;
1934
+ business_highlights?: BusinessHighlights[];
1842
1935
  /**
1843
1936
  * - Copyright statement usually seen at the
1844
1937
  * site's footer
@@ -1850,17 +1943,18 @@ type ApplicationInformation = {
1850
1943
  */
1851
1944
  created_at?: string;
1852
1945
  links?: Links[];
1853
- social_links?: SocialLinks;
1854
- support?: InformationSupport;
1855
1946
  /**
1856
1947
  * - ISO 8601 timestamp of updation of the
1857
1948
  * application information
1858
1949
  */
1859
- updated_at?: string;
1950
+ modified_at?: string;
1951
+ social_links?: SocialLinks;
1952
+ support?: InformationSupport;
1860
1953
  };
1861
1954
  /** @returns {ApplicationInventory} */
1862
1955
  declare function ApplicationInventory(): ApplicationInventory;
1863
1956
  type ApplicationInventory = {
1957
+ __v?: number;
1864
1958
  /**
1865
1959
  * - The unique identifier (24-digit Mongo Object ID)
1866
1960
  * of the sales channel inventory
@@ -1892,6 +1986,11 @@ type ApplicationInventory = {
1892
1986
  inventory?: AppInventoryConfig;
1893
1987
  logistics?: AppLogisticsConfig;
1894
1988
  loyalty_points?: LoyaltyPointsConfig;
1989
+ /**
1990
+ * - ISO 8601 timestamp of sales channel
1991
+ * inventory updation
1992
+ */
1993
+ modified_at?: string;
1895
1994
  /**
1896
1995
  * - User ID of the person who made the latest
1897
1996
  * changes in the sales channel inventory
@@ -1899,13 +1998,10 @@ type ApplicationInventory = {
1899
1998
  modified_by?: string;
1900
1999
  order?: AppOrderConfig;
1901
2000
  payment?: AppPaymentConfig;
2001
+ pii_masking?: PiiMasking;
1902
2002
  platforms?: string[];
1903
2003
  reward_points?: RewardPointsConfig;
1904
- /**
1905
- * - ISO 8601 timestamp of sales channel
1906
- * inventory updation
1907
- */
1908
- updated_at?: string;
2004
+ tags?: string[];
1909
2005
  };
1910
2006
  /** @returns {ApplicationMeta} */
1911
2007
  declare function ApplicationMeta(): ApplicationMeta;
@@ -2014,6 +2110,7 @@ type AppPaymentConfig = {
2014
2110
  * Default value is FYND.
2015
2111
  */
2016
2112
  source?: string;
2113
+ user_cod_limit?: number;
2017
2114
  };
2018
2115
  /** @returns {AppStoreRules} */
2019
2116
  declare function AppStoreRules(): AppStoreRules;
@@ -2022,7 +2119,7 @@ type AppStoreRules = {
2022
2119
  * - List of brands whose products will be shown
2023
2120
  * on the website
2024
2121
  */
2025
- brands?: any[];
2122
+ brands?: number[];
2026
2123
  /**
2027
2124
  * - List of companies whose inventory is
2028
2125
  * available to the sales channel for displaying on the website
@@ -2048,16 +2145,17 @@ type AppSupportedCurrency = {
2048
2145
  */
2049
2146
  created_at?: string;
2050
2147
  default_currency?: DefaultCurrency;
2051
- supported_currency?: string[];
2052
2148
  /**
2053
2149
  * - ISO 8601 timestamp when currency was
2054
2150
  * updated in the list of currencies supported by the sales channel
2055
2151
  */
2056
- updated_at?: string;
2152
+ modified_at?: string;
2153
+ supported_currency?: string[];
2057
2154
  };
2058
2155
  /** @returns {ArticleAssignmentConfig} */
2059
2156
  declare function ArticleAssignmentConfig(): ArticleAssignmentConfig;
2060
2157
  type ArticleAssignmentConfig = {
2158
+ enforced_stores?: number[];
2061
2159
  /**
2062
2160
  * - Allow post order reassigment of article
2063
2161
  */
@@ -2118,7 +2216,7 @@ type BrandCompanyInfo = {
2118
2216
  /** @returns {BrandsByCompanyResponse} */
2119
2217
  declare function BrandsByCompanyResponse(): BrandsByCompanyResponse;
2120
2218
  type BrandsByCompanyResponse = {
2121
- brands?: CompanyBrandInfo;
2219
+ brands?: CompanyBrandInfo[];
2122
2220
  };
2123
2221
  /** @returns {BrandStoreInfo} */
2124
2222
  declare function BrandStoreInfo(): BrandStoreInfo;
@@ -2168,16 +2266,17 @@ type BuildVersion = {
2168
2266
  * - ISO 8601 timestamp of app creation
2169
2267
  */
2170
2268
  created_at?: string;
2269
+ download_url?: LandingImage;
2270
+ /**
2271
+ * - ISO 8601 timestamp of last known
2272
+ * modifications to the app build
2273
+ */
2274
+ modified_at?: string;
2171
2275
  /**
2172
2276
  * - Device platform for which the mobile app
2173
2277
  * was built, e.g. android, ios.
2174
2278
  */
2175
2279
  platform_type?: string;
2176
- /**
2177
- * - ISO 8601 timestamp of last known
2178
- * modifications to the app build
2179
- */
2180
- updated_at?: string;
2181
2280
  /**
2182
2281
  * - A positive integer used as an internal
2183
2282
  * version number
@@ -2197,7 +2296,7 @@ type BuildVersionHistory = {
2197
2296
  * the mobile build, in dot-decimal notation
2198
2297
  */
2199
2298
  latest_available_version_name?: string;
2200
- versions?: BuildVersion;
2299
+ versions?: BuildVersion[];
2201
2300
  };
2202
2301
  /** @returns {BusinessHighlights} */
2203
2302
  declare function BusinessHighlights(): BusinessHighlights;
@@ -2283,6 +2382,8 @@ type CommonFeature = {
2283
2382
  currency?: CurrencyFeature;
2284
2383
  deployment_store_selection?: DeploymentStoreSelectionFeature;
2285
2384
  feedback?: FeedbackFeature;
2385
+ international_shipping?: InternationalShipping;
2386
+ listing_page?: ListingPageFeature;
2286
2387
  listing_price?: ListingPriceFeature;
2287
2388
  revenue_engine?: RevenueEngineFeature;
2288
2389
  reward_points?: RewardPointsConfig;
@@ -2313,7 +2414,7 @@ type CommunicationOptinDialogFeature = {
2313
2414
  /** @returns {CompaniesResponse} */
2314
2415
  declare function CompaniesResponse(): CompaniesResponse;
2315
2416
  type CompaniesResponse = {
2316
- items?: AppInventoryCompanies;
2417
+ items?: AppInventoryCompanies[];
2317
2418
  page?: Page;
2318
2419
  };
2319
2420
  /** @returns {CompanyBrandInfo} */
@@ -2381,7 +2482,7 @@ type CompareProductsFeature = {
2381
2482
  declare function CreateApplicationRequest(): CreateApplicationRequest;
2382
2483
  type CreateApplicationRequest = {
2383
2484
  app?: App;
2384
- configuration?: AppInventory;
2485
+ configuration?: ApplicationInventory;
2385
2486
  domain?: AppDomain;
2386
2487
  };
2387
2488
  /** @returns {CreateAppResponse} */
@@ -2442,6 +2543,8 @@ type Currency = {
2442
2543
  * - 3-character currency code, e.g. INR, USD, EUR.
2443
2544
  */
2444
2545
  code?: string;
2546
+ country_code?: string;
2547
+ country_name?: string;
2445
2548
  /**
2446
2549
  * - ISO 8601 timestamp of sales channel support
2447
2550
  * currency creation
@@ -2458,6 +2561,11 @@ type Currency = {
2458
2561
  * sales channel
2459
2562
  */
2460
2563
  is_active?: boolean;
2564
+ /**
2565
+ * - ISO 8601 timestamp of sales channel
2566
+ * support currency updation
2567
+ */
2568
+ modified_at?: string;
2461
2569
  /**
2462
2570
  * - Name of the currency, e.g Indian Rupee
2463
2571
  */
@@ -2466,11 +2574,6 @@ type Currency = {
2466
2574
  * - Unique symbol for identifying the currency, e.g. ₹
2467
2575
  */
2468
2576
  symbol?: string;
2469
- /**
2470
- * - ISO 8601 timestamp of sales channel support
2471
- * currency updation
2472
- */
2473
- updated_at?: string;
2474
2577
  };
2475
2578
  /** @returns {CurrencyFeature} */
2476
2579
  declare function CurrencyFeature(): CurrencyFeature;
@@ -2535,6 +2638,7 @@ type DeliveryCharges = {
2535
2638
  /** @returns {DeploymentMeta} */
2536
2639
  declare function DeploymentMeta(): DeploymentMeta;
2537
2640
  type DeploymentMeta = {
2641
+ __v?: number;
2538
2642
  /**
2539
2643
  * - The unique identifier (24-digit Mongo Object ID)
2540
2644
  * of the ordering stores
@@ -2597,6 +2701,7 @@ type Domain = {
2597
2701
  * - Shortlink is present or not for the domain
2598
2702
  */
2599
2703
  is_shortlink?: boolean;
2704
+ message?: string;
2600
2705
  /**
2601
2706
  * - Full domain name, e.g. newton.com
2602
2707
  */
@@ -2812,6 +2917,10 @@ type FyndRewards = {
2812
2917
  /** @returns {FyndRewardsCredentials} */
2813
2918
  declare function FyndRewardsCredentials(): FyndRewardsCredentials;
2814
2919
  type FyndRewardsCredentials = {
2920
+ /**
2921
+ * - Public key for integrating with Fynd rewards.
2922
+ */
2923
+ private_key?: string;
2815
2924
  /**
2816
2925
  * - Public key for integrating with Fynd rewards.
2817
2926
  */
@@ -2895,16 +3004,25 @@ type InformationAddress = {
2895
3004
  * - Name of the country, e.g. India
2896
3005
  */
2897
3006
  country?: string;
2898
- /**
2899
- * - Co-ordinates of the location
2900
- */
2901
- loc?: string;
3007
+ loc?: InformationLoc;
2902
3008
  phone?: InformationPhone[];
2903
3009
  /**
2904
3010
  * - 6-digit PIN Code of the city, e.g. 400001
2905
3011
  */
2906
3012
  pincode?: number;
2907
3013
  };
3014
+ /** @returns {InformationLoc} */
3015
+ declare function InformationLoc(): InformationLoc;
3016
+ type InformationLoc = {
3017
+ /**
3018
+ * - 10-digit mobile number
3019
+ */
3020
+ coordinates?: number[];
3021
+ /**
3022
+ * - Country code for contact number, e.g. +91 (for India)
3023
+ */
3024
+ type?: string;
3025
+ };
2908
3026
  /** @returns {InformationPhone} */
2909
3027
  declare function InformationPhone(): InformationPhone;
2910
3028
  type InformationPhone = {
@@ -2920,13 +3038,35 @@ type InformationPhone = {
2920
3038
  /** @returns {InformationSupport} */
2921
3039
  declare function InformationSupport(): InformationSupport;
2922
3040
  type InformationSupport = {
2923
- email?: string[];
2924
- phone?: string[];
3041
+ email?: InformationSupportEmail[];
3042
+ phone?: InformationSupportPhone[];
2925
3043
  /**
2926
3044
  * - Working hours of support team, e.g. 9 AM to 9 PM
2927
3045
  */
2928
3046
  timing?: string;
2929
3047
  };
3048
+ /** @returns {InformationSupportEmail} */
3049
+ declare function InformationSupportEmail(): InformationSupportEmail;
3050
+ type InformationSupportEmail = {
3051
+ key?: string;
3052
+ /**
3053
+ * - Value of email.
3054
+ */
3055
+ value?: string;
3056
+ };
3057
+ /** @returns {InformationSupportPhone} */
3058
+ declare function InformationSupportPhone(): InformationSupportPhone;
3059
+ type InformationSupportPhone = {
3060
+ /**
3061
+ * - Country code for contact number, e.g. +91 (for India)
3062
+ */
3063
+ code?: string;
3064
+ key?: string;
3065
+ /**
3066
+ * - 10-digit mobile number
3067
+ */
3068
+ number?: string;
3069
+ };
2930
3070
  /** @returns {InstagramLink} */
2931
3071
  declare function InstagramLink(): InstagramLink;
2932
3072
  type InstagramLink = {
@@ -2955,7 +3095,7 @@ type Integration = {
2955
3095
  * of the integration
2956
3096
  */
2957
3097
  _id?: string;
2958
- companies?: any[];
3098
+ companies?: string[];
2959
3099
  constants?: any;
2960
3100
  /**
2961
3101
  * - ISO 8601 timestamp of integration creation
@@ -2969,11 +3109,16 @@ type Integration = {
2969
3109
  * - Basic HTML description about the integration
2970
3110
  */
2971
3111
  description_html?: string;
3112
+ hidden?: boolean;
2972
3113
  /**
2973
3114
  * - Hosted URL of the icon image
2974
3115
  */
2975
3116
  icon?: string;
2976
3117
  meta?: IntegrationMeta[];
3118
+ /**
3119
+ * - ISO 8601 timestamp of integration updation
3120
+ */
3121
+ modified_at?: string;
2977
3122
  /**
2978
3123
  * - Name of the integration, e.g. SAP RBL Integration
2979
3124
  */
@@ -2988,16 +3133,16 @@ type Integration = {
2988
3133
  * opted integration. It is auto-generated. It would never change once it is generated.
2989
3134
  */
2990
3135
  secret?: string;
3136
+ /**
3137
+ * - Name of the integration, e.g. SAP RBL Integration
3138
+ */
3139
+ slug?: string;
2991
3140
  support?: string[];
2992
3141
  /**
2993
3142
  * - Randomly generated fixed-length string for opted
2994
3143
  * integration. It is auto-generated. It would never change once it is generated.
2995
3144
  */
2996
3145
  token?: string;
2997
- /**
2998
- * - ISO 8601 timestamp of integration updation
2999
- */
3000
- updated_at?: string;
3001
3146
  validators?: Validators;
3002
3147
  };
3003
3148
  /** @returns {IntegrationConfigResponse} */
@@ -3017,6 +3162,10 @@ type IntegrationLevel = {
3017
3162
  * of the integration config
3018
3163
  */
3019
3164
  _id?: string;
3165
+ /**
3166
+ * - Unique id of company.
3167
+ */
3168
+ company_id?: number;
3020
3169
  /**
3021
3170
  * - ISO 8601 timestamp of integration config creation
3022
3171
  */
@@ -3036,13 +3185,19 @@ type IntegrationLevel = {
3036
3185
  * It can be company level or store level.
3037
3186
  */
3038
3187
  level?: string;
3188
+ message?: string;
3039
3189
  meta?: IntegrationMeta[];
3190
+ /**
3191
+ * - ISO 8601 timestamp of integration config updation
3192
+ */
3193
+ modified_at?: string;
3040
3194
  /**
3041
3195
  * - Shows this integration is opted or not opted
3042
3196
  * for the current company
3043
3197
  */
3044
3198
  opted?: boolean;
3045
3199
  permissions?: any[];
3200
+ success?: boolean;
3046
3201
  /**
3047
3202
  * - Randomly generated fixed-length string for opted
3048
3203
  * integration. It is auto-generated. It would never change once it is generated.
@@ -3053,10 +3208,6 @@ type IntegrationLevel = {
3053
3208
  * level of integration.
3054
3209
  */
3055
3210
  uid?: number;
3056
- /**
3057
- * - ISO 8601 timestamp of integration config updation
3058
- */
3059
- updated_at?: string;
3060
3211
  };
3061
3212
  /** @returns {IntegrationMeta} */
3062
3213
  declare function IntegrationMeta(): IntegrationMeta;
@@ -3088,7 +3239,7 @@ type IntegrationOptIn = {
3088
3239
  * of the opted integration
3089
3240
  */
3090
3241
  _id?: string;
3091
- companies?: any[];
3242
+ companies?: string[];
3092
3243
  constants?: string;
3093
3244
  /**
3094
3245
  * - ISO 8601 timestamp of integration creation
@@ -3103,11 +3254,16 @@ type IntegrationOptIn = {
3103
3254
  * opted integration
3104
3255
  */
3105
3256
  description_html?: string;
3257
+ hidden?: boolean;
3106
3258
  /**
3107
3259
  * - Hosted URL of the icon image
3108
3260
  */
3109
3261
  icon?: string;
3110
3262
  meta?: IntegrationMeta[];
3263
+ /**
3264
+ * - ISO 8601 timestamp of integration updation
3265
+ */
3266
+ modified_at?: string;
3111
3267
  /**
3112
3268
  * - Nmae of the opted integration, e.g. SAP RBL Integration
3113
3269
  */
@@ -3122,17 +3278,34 @@ type IntegrationOptIn = {
3122
3278
  * opted integration. It is auto-generated. It would never change once it is generated.
3123
3279
  */
3124
3280
  secret?: string;
3281
+ /**
3282
+ * - Slug of the opted integration, e.g. ginesys
3283
+ */
3284
+ slug?: string;
3125
3285
  support?: string[];
3126
3286
  /**
3127
3287
  * - Randomly generated fixed-length string for opted
3128
3288
  * integration. It is auto-generated. It would never change once it is generated.
3129
3289
  */
3130
3290
  token?: string;
3291
+ validators?: Validators;
3292
+ };
3293
+ /** @returns {InternationalDeliveryCharges} */
3294
+ declare function InternationalDeliveryCharges(): InternationalDeliveryCharges;
3295
+ type InternationalDeliveryCharges = {
3296
+ charges?: Charges[];
3131
3297
  /**
3132
- * - ISO 8601 timestamp of integration updation
3298
+ * - Allow international delivery charges
3133
3299
  */
3134
- updated_at?: string;
3135
- validators?: Validators;
3300
+ enabled?: boolean;
3301
+ };
3302
+ /** @returns {InternationalShipping} */
3303
+ declare function InternationalShipping(): InternationalShipping;
3304
+ type InternationalShipping = {
3305
+ /**
3306
+ * - International shipping is enabled or not.
3307
+ */
3308
+ enabled?: boolean;
3136
3309
  };
3137
3310
  /** @returns {InvalidPayloadRequest} */
3138
3311
  declare function InvalidPayloadRequest(): InvalidPayloadRequest;
@@ -3141,6 +3314,10 @@ type InvalidPayloadRequest = {
3141
3314
  * - Error message when request body payload is improper
3142
3315
  */
3143
3316
  message?: string;
3317
+ /**
3318
+ * - Flag for required not successfull.
3319
+ */
3320
+ success?: boolean;
3144
3321
  };
3145
3322
  /** @returns {InventoryArticleAssignment} */
3146
3323
  declare function InventoryArticleAssignment(): InventoryArticleAssignment;
@@ -3157,7 +3334,7 @@ type InventoryBrand = {
3157
3334
  /**
3158
3335
  * - List of brands
3159
3336
  */
3160
- brands?: any[];
3337
+ brands?: number[];
3161
3338
  /**
3162
3339
  * - All brands or specific (explicit) brands to
3163
3340
  * be shown on the website
@@ -3184,6 +3361,28 @@ type InventoryCategory = {
3184
3361
  categories?: any[];
3185
3362
  criteria?: string;
3186
3363
  };
3364
+ /** @returns {InventoryConfig} */
3365
+ declare function InventoryConfig(): InventoryConfig;
3366
+ type InventoryConfig = {
3367
+ brand?: InventoryBrandRule;
3368
+ /**
3369
+ * - Allow other businesses (companies)
3370
+ * to consume the current sales channel's inventory and sell products
3371
+ */
3372
+ franchise_enabled?: boolean;
3373
+ image?: string[];
3374
+ /**
3375
+ * - Show only verified products
3376
+ * (the ones whose data have been verified by the admin)
3377
+ */
3378
+ only_verified_products?: boolean;
3379
+ /**
3380
+ * - Indicates whether out of stock products
3381
+ * are allowed to show up on the website.
3382
+ */
3383
+ out_of_stock?: boolean;
3384
+ store?: InventoryStoreRule;
3385
+ };
3187
3386
  /** @returns {InventoryDiscount} */
3188
3387
  declare function InventoryDiscount(): InventoryDiscount;
3189
3388
  type InventoryDiscount = {
@@ -3392,6 +3591,11 @@ type Links = {
3392
3591
  */
3393
3592
  title?: string;
3394
3593
  };
3594
+ /** @returns {ListingPageFeature} */
3595
+ declare function ListingPageFeature(): ListingPageFeature;
3596
+ type ListingPageFeature = {
3597
+ sort_on?: string;
3598
+ };
3395
3599
  /** @returns {ListingPriceFeature} */
3396
3600
  declare function ListingPriceFeature(): ListingPriceFeature;
3397
3601
  type ListingPriceFeature = {
@@ -3486,6 +3690,11 @@ type MobileAppConfiguration = {
3486
3690
  */
3487
3691
  is_active?: boolean;
3488
3692
  landing_image?: LandingImage;
3693
+ /**
3694
+ * - ISO 8601 timestamp of last known
3695
+ * modifications to the app build
3696
+ */
3697
+ modified_at?: string;
3489
3698
  /**
3490
3699
  * - Shows bundle identifier if device
3491
3700
  * platform is iOS, and directory of the app if device platform is Android
@@ -3497,11 +3706,6 @@ type MobileAppConfiguration = {
3497
3706
  */
3498
3707
  platform_type?: string;
3499
3708
  splash_image?: SplashImage;
3500
- /**
3501
- * - ISO 8601 timestamp of last known
3502
- * modifications to the app build
3503
- */
3504
- updated_at?: string;
3505
3709
  };
3506
3710
  /** @returns {Moengage} */
3507
3711
  declare function Moengage(): Moengage;
@@ -3530,6 +3734,10 @@ type NotFound = {
3530
3734
  * - Response message for not found
3531
3735
  */
3532
3736
  message?: string;
3737
+ /**
3738
+ * - Flag for required not successfull.
3739
+ */
3740
+ success?: boolean;
3533
3741
  };
3534
3742
  /** @returns {OptedApplicationResponse} */
3535
3743
  declare function OptedApplicationResponse(): OptedApplicationResponse;
@@ -3558,6 +3766,10 @@ type OptedApplicationResponse = {
3558
3766
  /** @returns {OptedCompany} */
3559
3767
  declare function OptedCompany(): OptedCompany;
3560
3768
  type OptedCompany = {
3769
+ /**
3770
+ * - The unique identifier of the opted inventory company
3771
+ */
3772
+ id?: number;
3561
3773
  /**
3562
3774
  * - Name of the company opted by the other seller's
3563
3775
  * sales channel in its inventory
@@ -3572,7 +3784,7 @@ type OptedCompany = {
3572
3784
  /** @returns {OptedInventory} */
3573
3785
  declare function OptedInventory(): OptedInventory;
3574
3786
  type OptedInventory = {
3575
- items?: any;
3787
+ items?: any[];
3576
3788
  opt_type?: OptType;
3577
3789
  };
3578
3790
  /** @returns {OptedStore} */
@@ -3634,15 +3846,27 @@ type OptedStoreAddress = {
3634
3846
  * - Country of the opted store, e.g. India
3635
3847
  */
3636
3848
  country?: string;
3849
+ /**
3850
+ * - Country code of the selected country
3851
+ */
3852
+ country_code?: string;
3637
3853
  lat_long?: StoreLatLong;
3638
3854
  /**
3639
3855
  * - 6-digit PIN code of the opted store location
3640
3856
  */
3641
3857
  pincode?: number;
3858
+ /**
3859
+ * - Sector for the opted store.
3860
+ */
3861
+ sector?: string;
3642
3862
  /**
3643
3863
  * - State of the opted store, e.g. Maharashtra
3644
3864
  */
3645
3865
  state?: string;
3866
+ /**
3867
+ * - Selected state code
3868
+ */
3869
+ state_code?: string;
3646
3870
  };
3647
3871
  /** @returns {OptedStoreIntegration} */
3648
3872
  declare function OptedStoreIntegration(): OptedStoreIntegration;
@@ -3826,6 +4050,11 @@ type OtherEntity = {
3826
4050
  */
3827
4051
  level?: string;
3828
4052
  meta?: any[];
4053
+ /**
4054
+ * - ISO 8601 timestamp of other entity
4055
+ * updation for opted store integration
4056
+ */
4057
+ modified_at?: string;
3829
4058
  /**
3830
4059
  * - Allow other entity opted in integration
3831
4060
  */
@@ -3841,11 +4070,6 @@ type OtherEntity = {
3841
4070
  * level of integration.
3842
4071
  */
3843
4072
  uid?: number;
3844
- /**
3845
- * - ISO 8601 timestamp of other entity updation
3846
- * for opted store integration
3847
- */
3848
- updated_at?: string;
3849
4073
  };
3850
4074
  /** @returns {OtherEntityData} */
3851
4075
  declare function OtherEntityData(): OtherEntityData;
@@ -3961,6 +4185,11 @@ type PcrFeature = {
3961
4185
  */
3962
4186
  staff_selection?: boolean;
3963
4187
  };
4188
+ /** @returns {PiiMasking} */
4189
+ declare function PiiMasking(): PiiMasking;
4190
+ type PiiMasking = {
4191
+ enabled?: boolean;
4192
+ };
3964
4193
  /** @returns {PinterestLink} */
3965
4194
  declare function PinterestLink(): PinterestLink;
3966
4195
  type PinterestLink = {
@@ -4187,7 +4416,7 @@ type StorePriorityRule = {
4187
4416
  /** @returns {StoresResponse} */
4188
4417
  declare function StoresResponse(): StoresResponse;
4189
4418
  type StoresResponse = {
4190
- items?: AppInventoryStores;
4419
+ items?: AppInventoryStores[];
4191
4420
  page?: Page;
4192
4421
  };
4193
4422
  /** @returns {StoreValidator} */
@@ -4232,11 +4461,11 @@ type TokenResponse = {
4232
4461
  * - ISO 8601 timestamp of token creation
4233
4462
  */
4234
4463
  created_at?: string;
4235
- tokens?: Tokens;
4236
4464
  /**
4237
4465
  * - ISO 8601 timestamp of token updation
4238
4466
  */
4239
- updated_at?: string;
4467
+ modified_at?: string;
4468
+ tokens?: Tokens;
4240
4469
  };
4241
4470
  /** @returns {Tokens} */
4242
4471
  declare function Tokens(): Tokens;
@@ -4250,6 +4479,16 @@ type Tokens = {
4250
4479
  safetynet?: Safetynet;
4251
4480
  segment?: Segment;
4252
4481
  };
4482
+ /** @returns {TokenSchema} */
4483
+ declare function TokenSchema(): TokenSchema;
4484
+ type TokenSchema = {
4485
+ /**
4486
+ * - ISO 8601 timestamp of when token created
4487
+ */
4488
+ created_at?: string;
4489
+ created_by?: any;
4490
+ token?: string;
4491
+ };
4253
4492
  /** @returns {TwitterLink} */
4254
4493
  declare function TwitterLink(): TwitterLink;
4255
4494
  type TwitterLink = {