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

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 (314) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.d.ts +2 -0
  8. package/sdk/application/ApplicationClient.js +2 -18
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
  10. package/sdk/application/Cart/CartApplicationClient.js +108 -1199
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
  14. package/sdk/application/Common/CommonApplicationClient.js +2 -92
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
  20. package/sdk/application/Content/ContentApplicationClient.js +43 -1065
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
  23. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  24. package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
  25. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
  26. package/sdk/application/Lead/LeadApplicationClient.js +5 -217
  27. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
  29. package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
  30. package/sdk/application/Order/OrderApplicationClient.js +52 -507
  31. package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
  32. package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
  33. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
  34. package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
  35. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  36. package/sdk/application/Share/ShareApplicationClient.js +7 -309
  37. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  38. package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
  39. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  40. package/sdk/application/User/UserApplicationClient.js +44 -1820
  41. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  42. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
  43. package/sdk/application/index.d.ts +0 -18
  44. package/sdk/application/index.js +0 -33
  45. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  51. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  52. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  53. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  54. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  55. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +157 -30
  56. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
  57. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
  58. package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
  59. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
  60. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
  61. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  62. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  63. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  64. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  65. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  66. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  67. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  68. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  69. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  70. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  71. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  73. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  75. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  82. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  83. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  84. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  85. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  86. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  87. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  89. package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
  91. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
  92. package/sdk/platform/Cart/CartPlatformModel.d.ts +5060 -1300
  93. package/sdk/platform/Cart/CartPlatformModel.js +1985 -1217
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  97. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  98. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +178 -117
  99. package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
  100. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
  101. package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
  103. package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -24
  104. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  105. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  106. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  107. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  112. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  113. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  114. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  120. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  124. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  126. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  128. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  130. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +122 -191
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
  132. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
  134. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  135. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  136. package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
  137. package/sdk/platform/Content/ContentPlatformModel.js +514 -487
  138. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  139. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  144. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  145. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  150. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  152. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  154. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  156. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  157. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  158. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  159. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  160. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  161. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  162. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  163. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  164. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  165. package/sdk/platform/Order/OrderPlatformClient.js +424 -198
  166. package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
  167. package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
  168. package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
  169. package/sdk/platform/Order/OrderPlatformValidator.js +145 -77
  170. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  171. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  172. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  173. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  174. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  175. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  176. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  177. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  178. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  179. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  180. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  181. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  182. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  183. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  184. package/sdk/platform/PlatformClient.d.ts +0 -2
  185. package/sdk/platform/PlatformClient.js +0 -4
  186. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  187. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  188. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  189. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  190. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  191. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +132 -44
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
  202. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  203. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  204. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  205. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  206. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  208. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  210. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  211. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  212. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  213. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  214. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  215. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  216. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  217. package/sdk/platform/User/UserPlatformModel.js +23 -23
  218. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  219. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  220. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  221. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  222. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  223. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  224. package/sdk/platform/index.d.ts +0 -1
  225. package/sdk/platform/index.js +0 -2
  226. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  227. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
  228. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  229. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  230. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  231. package/sdk/public/Content/ContentPublicClient.js +795 -7
  232. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  233. package/sdk/public/Content/ContentPublicModel.js +649 -3
  234. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  235. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  236. package/sdk/public/Partner/PartnerPublicClient.js +4 -2
  237. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  238. package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
  239. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  240. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  241. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  242. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  243. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
  244. package/sdk/application/Cart/CartApplicationModel.js +0 -2497
  245. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
  246. package/sdk/application/Cart/CartApplicationValidator.js +0 -530
  247. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
  248. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
  249. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  250. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  251. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  252. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  253. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  254. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  255. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  256. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  257. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  258. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  259. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
  260. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
  261. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  262. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  263. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
  264. package/sdk/application/Content/ContentApplicationModel.js +0 -1589
  265. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
  266. package/sdk/application/Content/ContentApplicationValidator.js +0 -264
  267. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
  268. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
  269. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  270. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  271. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  272. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  273. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  274. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  275. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
  276. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
  277. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
  278. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
  279. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
  280. package/sdk/application/Order/OrderApplicationModel.js +0 -1471
  281. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
  282. package/sdk/application/Order/OrderApplicationValidator.js +0 -197
  283. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
  284. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
  285. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  286. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  287. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  288. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  289. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  290. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  291. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  292. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  293. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  294. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  295. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
  296. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
  297. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
  298. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
  299. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  300. package/sdk/application/User/UserApplicationModel.js +0 -1382
  301. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  302. package/sdk/application/User/UserApplicationValidator.js +0 -573
  303. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
  304. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
  305. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  306. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  307. package/sdk/common/Clickstream.d.ts +0 -1
  308. package/sdk/common/Clickstream.js +0 -464
  309. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  310. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  311. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  312. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  313. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  314. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -1,10 +1,10 @@
1
1
  export = ServiceabilityPlatformModel;
2
2
  /**
3
- * @typedef UpdateZoneConfigRequest
3
+ * @typedef UpdateZoneConfigDetails
4
4
  * @property {string} [serviceability_type]
5
5
  */
6
6
  /**
7
- * @typedef ServiceabilityErrorResponse
7
+ * @typedef ServiceabilityErrorResult
8
8
  * @property {string} message
9
9
  * @property {string} value
10
10
  * @property {string} type
@@ -16,13 +16,13 @@ export = ServiceabilityPlatformModel;
16
16
  * @property {string} channel_type
17
17
  */
18
18
  /**
19
- * @typedef ApplicationServiceabilityConfigResponse
20
- * @property {ServiceabilityErrorResponse} [error]
19
+ * @typedef ApplicationServiceabilityConfigResult
20
+ * @property {ServiceabilityErrorResult} [error]
21
21
  * @property {ApplicationServiceabilityConfig} [data]
22
22
  * @property {boolean} success
23
23
  */
24
24
  /**
25
- * @typedef EntityRegionView_Request
25
+ * @typedef EntityRegionView_Details
26
26
  * @property {string[]} sub_type
27
27
  * @property {string[]} [parent_id]
28
28
  */
@@ -41,7 +41,7 @@ export = ServiceabilityPlatformModel;
41
41
  * @property {number} current
42
42
  */
43
43
  /**
44
- * @typedef getAppRegionZonesResponse
44
+ * @typedef getAppRegionZonesResult
45
45
  * @property {PageSchema[]} page
46
46
  * @property {ListViewItems[]} items
47
47
  */
@@ -60,7 +60,7 @@ export = ServiceabilityPlatformModel;
60
60
  * @property {string} name
61
61
  */
62
62
  /**
63
- * @typedef EntityRegionView_Response
63
+ * @typedef EntityRegionView_Result
64
64
  * @property {EntityRegionView_Error} error
65
65
  * @property {EntityRegionView_page} page
66
66
  * @property {EntityRegionView_Items[]} data
@@ -106,7 +106,7 @@ export = ServiceabilityPlatformModel;
106
106
  * @property {ListViewChannels[]} channels - The name of the zone.
107
107
  */
108
108
  /**
109
- * @typedef ListViewResponse
109
+ * @typedef ListViewResult
110
110
  * @property {ZoneDataItem} page
111
111
  * @property {ListViewItems[]} items
112
112
  */
@@ -119,7 +119,7 @@ export = ServiceabilityPlatformModel;
119
119
  * @property {number} current
120
120
  */
121
121
  /**
122
- * @typedef CompanyStoreView_Response
122
+ * @typedef CompanyStoreView_Result
123
123
  * @property {CompanyStoreView_PageItems[]} page
124
124
  * @property {Object[]} [items]
125
125
  */
@@ -130,8 +130,9 @@ export = ServiceabilityPlatformModel;
130
130
  */
131
131
  /**
132
132
  * @typedef ZoneProductTypes
133
- * @property {string} type
134
- * @property {string[]} tags
133
+ * @property {string} type - Denotes if the zone is applicable for all the
134
+ * products or specific products.
135
+ * @property {string[]} tags - List of product tags.
135
136
  */
136
137
  /**
137
138
  * @typedef ZoneMappingDetailType
@@ -140,8 +141,8 @@ export = ServiceabilityPlatformModel;
140
141
  */
141
142
  /**
142
143
  * @typedef ZoneMappingType
143
- * @property {string} country
144
- * @property {string[]} regions
144
+ * @property {string} country - Uid for the country.
145
+ * @property {string[]} regions - List of region uid for the given country.
145
146
  */
146
147
  /**
147
148
  * @typedef ZoneMappingRegions
@@ -153,78 +154,89 @@ export = ServiceabilityPlatformModel;
153
154
  */
154
155
  /**
155
156
  * @typedef UpdateZoneData
156
- * @property {string} zone_id
157
- * @property {string} name
158
- * @property {string} slug
159
- * @property {number} company_id
160
- * @property {boolean} is_active
161
- * @property {GetZoneDataViewChannels[]} channels
157
+ * @property {string} zone_id - Unique identifier for the zone.
158
+ * @property {string} name - Name for the zone.
159
+ * @property {string} slug - A human-readable and unique identifier for the
160
+ * zone, derived from the name.
161
+ * @property {number} company_id - Company id associated with the zone.
162
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
163
+ * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
162
164
  * @property {ZoneProductTypes} product
163
- * @property {number[]} store_ids
164
- * @property {string} region_type
165
- * @property {ZoneMappingType[]} mapping
165
+ * @property {number[]} store_ids - A list of store identifiers associated with the zone.
166
+ * @property {string} region_type - Type of region that belongs in the zone.
167
+ * @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
166
168
  */
167
169
  /**
168
- * @typedef ZoneUpdateRequest
170
+ * @typedef ZoneUpdateDetails
169
171
  * @property {string} identifier
170
172
  * @property {UpdateZoneData} data
171
173
  */
172
174
  /**
173
- * @typedef ZoneSuccessResponse
175
+ * @typedef ZoneSuccessResult
174
176
  * @property {number} status_code
175
177
  * @property {boolean} success
176
178
  */
177
179
  /**
178
180
  * @typedef GetZoneDataViewItems
179
- * @property {string} zone_id
180
- * @property {string} name
181
- * @property {string} slug
182
- * @property {number} [company_id]
183
- * @property {boolean} is_active
184
- * @property {GetZoneDataViewChannels[]} channels
181
+ * @property {string} zone_id - The unique identifier for the zone.
182
+ * @property {string} name - The name of the zone for easy identification.
183
+ * @property {string} slug - A URL-friendly version of the zone’s name, used for
184
+ * routing or linking.
185
+ * @property {number} [company_id] - The ID of the company associated with this zone.
186
+ * @property {boolean} is_active - A flag indicating whether the zone is active
187
+ * (true) or inactive (false).
188
+ * @property {GetZoneDataViewChannels[]} channels - A list of channels available
189
+ * within this zone.
185
190
  * @property {ZoneProductTypes} product
186
- * @property {number[]} store_ids
187
- * @property {string} [region_type]
188
- * @property {ZoneMappingType[]} mapping
189
- * @property {number} stores_count
191
+ * @property {number[]} store_ids - A collection of store IDs linked to this zone.
192
+ * @property {string} [region_type] - The type of region the zone represents.
193
+ * @property {ZoneMappingType[]} mapping - A list of mappings defining
194
+ * relationships between this zone and other entities.
195
+ * @property {string} [assignment_preference] - The preferred method for
196
+ * assigning stores or products to the zone.
197
+ * @property {number} stores_count - The total number of stores assigned to this zone.
190
198
  */
191
199
  /**
192
- * @typedef GetSingleZoneDataViewResponse
200
+ * @typedef GetSingleZoneDataViewResult
193
201
  * @property {GetZoneDataViewItems} data
194
202
  */
195
203
  /**
196
204
  * @typedef GetZoneByIdSchema
197
- * @property {string} zone_id
198
- * @property {string} name
199
- * @property {string} slug
200
- * @property {number} [company_id]
201
- * @property {boolean} is_active
202
- * @property {GetZoneDataViewChannels[]} channels
205
+ * @property {string} zone_id - Unique identifier for the zone.
206
+ * @property {string} name - Name for the zone.
207
+ * @property {string} slug - A human-readable and unique identifier for the
208
+ * zone, derived from the name.
209
+ * @property {number} [company_id] - Company id associated with the zone.
210
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
211
+ * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
203
212
  * @property {ZoneProductTypes} product
204
- * @property {number[]} store_ids
205
- * @property {string} region_type
213
+ * @property {number[]} store_ids - A list of store identifiers associated with the zone.
214
+ * @property {string} region_type - Type of region that belongs in the zone.
206
215
  * @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
216
+ * @property {number} [stores_count]
207
217
  */
208
218
  /**
209
219
  * @typedef CreateZoneData
210
- * @property {string} name
211
- * @property {string} slug
212
- * @property {number} company_id
213
- * @property {boolean} is_active
214
- * @property {GetZoneDataViewChannels[]} channels
215
- * @property {number[]} store_ids
216
- * @property {ZoneProductTypes} product
217
- * @property {string} region_type
218
- * @property {ZoneMappingType[]} mapping
220
+ * @property {string} name - Name of the zone.
221
+ * @property {string} slug - A human-readable and unique identifier for the
222
+ * zone, derived from the name.
223
+ * @property {number} company_id - Unique identifier of the company for which
224
+ * the zone is created.
225
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
226
+ * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
227
+ * @property {number[]} store_ids - A list of store identifiers associated with the zone.
228
+ * @property {string} region_type - Type of region that belongs in the zone.
229
+ * @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
230
+ * @property {ZoneProductTypes} [product]
219
231
  */
220
232
  /**
221
- * @typedef ZoneResponse
222
- * @property {number} status_code
233
+ * @typedef ZoneResult
234
+ * @property {number} [status_code]
223
235
  * @property {string} zone_id
224
236
  * @property {boolean} success
225
237
  */
226
238
  /**
227
- * @typedef GetZoneFromPincodeViewRequest
239
+ * @typedef GetZoneFromPincodeViewDetails
228
240
  * @property {string} country
229
241
  * @property {string} pincode
230
242
  */
@@ -239,17 +251,17 @@ export = ServiceabilityPlatformModel;
239
251
  * @property {number[]} store_ids
240
252
  */
241
253
  /**
242
- * @typedef GetZoneFromPincodeViewResponse
254
+ * @typedef GetZoneFromPincodeViewResult
243
255
  * @property {string} serviceability_type
244
256
  * @property {Zone[]} zones
245
257
  */
246
258
  /**
247
- * @typedef GetZoneFromApplicationIdViewResponse
259
+ * @typedef GetZoneFromApplicationIdViewResult
248
260
  * @property {ZoneDataItem[]} page
249
261
  * @property {ListViewItems[]} items
250
262
  */
251
263
  /**
252
- * @typedef ServiceabilityPageResponse
264
+ * @typedef ServiceabilityPageResult
253
265
  * @property {string} [type]
254
266
  * @property {boolean} [has_next]
255
267
  * @property {number} [item_total]
@@ -262,32 +274,32 @@ export = ServiceabilityPlatformModel;
262
274
  * @property {number} [country_code]
263
275
  */
264
276
  /**
265
- * @typedef ManagerResponse
277
+ * @typedef ManagerResult
266
278
  * @property {string} [email]
267
279
  * @property {MobileNo} [mobile_no]
268
280
  * @property {string} [name]
269
281
  */
270
282
  /**
271
- * @typedef ModifiedByResponse
283
+ * @typedef ModifiedByResult
272
284
  * @property {string} [username]
273
285
  * @property {string} [user_id]
274
286
  */
275
287
  /**
276
- * @typedef IntegrationTypeResponse
288
+ * @typedef IntegrationTypeResult
277
289
  * @property {string} [inventory]
278
290
  * @property {string} [order]
279
291
  */
280
292
  /**
281
- * @typedef ProductReturnConfigResponse
293
+ * @typedef ProductReturnConfigResult
282
294
  * @property {boolean} [on_same_store]
283
295
  */
284
296
  /**
285
- * @typedef ContactNumberResponse
297
+ * @typedef ContactNumberResult
286
298
  * @property {string} [number]
287
299
  * @property {number} [country_code]
288
300
  */
289
301
  /**
290
- * @typedef AddressResponse
302
+ * @typedef AddressResult
291
303
  * @property {string} [city]
292
304
  * @property {string} [address1]
293
305
  * @property {number} [pincode]
@@ -299,25 +311,25 @@ export = ServiceabilityPlatformModel;
299
311
  * @property {number} [longitude]
300
312
  */
301
313
  /**
302
- * @typedef CreatedByResponse
314
+ * @typedef CreatedByResult
303
315
  * @property {string} [username]
304
316
  * @property {string} [user_id]
305
317
  */
306
318
  /**
307
- * @typedef EwayBillResponse
319
+ * @typedef EwayBillResult
308
320
  * @property {boolean} [enabled]
309
321
  */
310
322
  /**
311
- * @typedef EinvoiceResponse
323
+ * @typedef EinvoiceResult
312
324
  * @property {boolean} [enabled]
313
325
  */
314
326
  /**
315
- * @typedef GstCredentialsResponse
316
- * @property {EwayBillResponse} [e_waybill]
317
- * @property {EinvoiceResponse} [e_invoice]
327
+ * @typedef GstCredentialsResult
328
+ * @property {EwayBillResult} [e_waybill]
329
+ * @property {EinvoiceResult} [e_invoice]
318
330
  */
319
331
  /**
320
- * @typedef WarningsResponse
332
+ * @typedef WarningsResult
321
333
  * @property {string} [store_address]
322
334
  */
323
335
  /**
@@ -326,14 +338,14 @@ export = ServiceabilityPlatformModel;
326
338
  * @property {number} [hour]
327
339
  */
328
340
  /**
329
- * @typedef TimmingResponse
341
+ * @typedef TimmingResult
330
342
  * @property {boolean} [open]
331
343
  * @property {string} [weekday]
332
344
  * @property {OpeningClosing} [closing]
333
345
  * @property {OpeningClosing} [opening]
334
346
  */
335
347
  /**
336
- * @typedef DocumentsResponse
348
+ * @typedef DocumentsResult
337
349
  * @property {string} [legal_name]
338
350
  * @property {string} [value]
339
351
  * @property {string} [type]
@@ -353,99 +365,108 @@ export = ServiceabilityPlatformModel;
353
365
  * @property {boolean} [assign_dp_from_sb]
354
366
  */
355
367
  /**
356
- * @typedef LogisticsResponse
368
+ * @typedef LogisticsResult
357
369
  * @property {boolean} [override]
358
370
  * @property {Dp} [dp]
359
371
  */
360
372
  /**
361
- * @typedef ItemResponse
373
+ * @typedef ItemResult
362
374
  * @property {string} [created_on]
363
- * @property {ManagerResponse} [manager]
364
- * @property {ModifiedByResponse} [modified_by]
365
- * @property {IntegrationTypeResponse} [integration_type]
375
+ * @property {ManagerResult} [manager]
376
+ * @property {ModifiedByResult} [modified_by]
377
+ * @property {IntegrationTypeResult} [integration_type]
366
378
  * @property {string} [verified_on]
367
- * @property {ProductReturnConfigResponse} [product_return_config]
368
- * @property {ContactNumberResponse[]} [contact_numbers]
369
- * @property {ModifiedByResponse} [verified_by]
379
+ * @property {ProductReturnConfigResult} [product_return_config]
380
+ * @property {ContactNumberResult[]} [contact_numbers]
381
+ * @property {ModifiedByResult} [verified_by]
370
382
  * @property {string} [stage]
371
- * @property {AddressResponse} [address]
383
+ * @property {AddressResult} [address]
372
384
  * @property {string} [modified_on]
373
- * @property {CreatedByResponse} [created_by]
374
- * @property {GstCredentialsResponse} [gst_credentials]
385
+ * @property {CreatedByResult} [created_by]
386
+ * @property {GstCredentialsResult} [gst_credentials]
375
387
  * @property {string} [display_name]
376
388
  * @property {number} [company_id]
377
389
  * @property {number} [uid]
378
- * @property {Object} [_custom_json]
390
+ * @property {Object} [_custom_json] - Custom JSON for internal usage
379
391
  * @property {string} [code]
380
- * @property {WarningsResponse} [warnings]
392
+ * @property {WarningsResult} [warnings]
381
393
  * @property {string} [name]
382
- * @property {TimmingResponse[]} [timing]
383
- * @property {DocumentsResponse[]} [documents]
394
+ * @property {TimmingResult[]} [timing]
395
+ * @property {DocumentsResult[]} [documents]
384
396
  * @property {string} [store_type]
385
397
  * @property {string} [sub_type]
386
398
  * @property {number} [company]
387
399
  * @property {string} [_cls]
388
- * @property {LogisticsResponse} [logistics]
400
+ * @property {LogisticsResult} [logistics]
389
401
  * @property {string[]} [notification_emails]
390
402
  */
391
403
  /**
392
- * @typedef GetStoresViewResponse
393
- * @property {ServiceabilityPageResponse} page
394
- * @property {ItemResponse[]} [items]
404
+ * @typedef GetStoresViewResult
405
+ * @property {ServiceabilityPageResult} page
406
+ * @property {ItemResult[]} [items]
395
407
  */
396
408
  /**
397
409
  * @typedef PincodeMopData
398
- * @property {number[]} pincodes
399
- * @property {string} country
400
- * @property {string} action
410
+ * @property {number[]} pincodes - A list of pincodes.
411
+ * @property {string} country - Name of the country.
412
+ * @property {string} action - Denotes wether to activate or deavtivate pincodes
413
+ * for COD mode of payment.
401
414
  */
402
415
  /**
403
- * @typedef PincodeMopUpdateResponse
404
- * @property {number} pincode
405
- * @property {string} channel_id
406
- * @property {string} country
407
- * @property {boolean} is_active
416
+ * @typedef PincodeMopUpdateResult
417
+ * @property {number} pincode - Pincode of the region.
418
+ * @property {string} channel_id - Unique identifier of the sales channel.
419
+ * @property {string} country - Country name.
420
+ * @property {boolean} is_active - Denotes whether the pincode mode of payment
421
+ * is active or not.
408
422
  */
409
423
  /**
410
- * @typedef PincodeMOPresponse
411
- * @property {boolean} success
412
- * @property {number} status_code
413
- * @property {string} batch_id
414
- * @property {string} country
415
- * @property {string} action
416
- * @property {number[]} [pincodes]
417
- * @property {PincodeMopUpdateResponse[]} [updated_pincodes]
424
+ * @typedef PincodeMOPResult
425
+ * @property {boolean} success - Denotes if the action was successful or not.
426
+ * @property {number} status_code - Status code for the response.
427
+ * @property {string} batch_id - Unique identifier identifying the perticular request.
428
+ * @property {string} country - Name of the country.
429
+ * @property {string} action - Denotes wether to activate or deavtivate pincodes
430
+ * for COD mode of payment.
431
+ * @property {number[]} [pincodes] - List of pincodes.
432
+ * @property {PincodeMopUpdateResult[]} [updated_pincodes] - Details of the
433
+ * updated pincodes.
418
434
  */
419
435
  /**
420
436
  * @typedef CommonError
421
- * @property {string} [status_code]
437
+ * @property {string} [status_code] - Status code for the error.
422
438
  * @property {Object} [error]
423
- * @property {string} [success]
439
+ * @property {string} [success] - Whether operation was successful.
424
440
  */
425
441
  /**
426
442
  * @typedef PincodeMopBulkData
427
- * @property {string} batch_id
428
- * @property {string} s3_url
443
+ * @property {string} batch_id - Unique identifier for the request.
444
+ * @property {string} s3_url - CDN url for the uploaded file.
429
445
  */
430
446
  /**
431
- * @typedef PincodeBulkViewResponse
447
+ * @typedef PincodeBulkViewResult
432
448
  * @property {string} batch_id
433
- * @property {string} s3_url
449
+ * @property {string} s3_url - CDN url for the uploaded file.
434
450
  */
435
451
  /**
436
- * @typedef PincodeCodStatusListingRequest
437
- * @property {string} [country]
438
- * @property {boolean} [is_active]
439
- * @property {number} [pincode]
452
+ * @typedef PincodeCodStatusListingDetails
453
+ * @property {string} [country] - Name of the country.
454
+ * @property {boolean} [is_active] - Search based on the active or inactive flag.
455
+ * @property {number} [pincode] - Search based on the pincode.
440
456
  * @property {number} [current]
441
457
  * @property {number} [page_size]
442
458
  */
443
459
  /**
444
- * @typedef PincodeCodStatusListingResponse
445
- * @property {string} country
446
- * @property {PincodeCodStatusListingResponse[]} data
447
- * @property {boolean} success
448
- * @property {Error[]} [errors]
460
+ * @typedef PincodeCodStatusItem
461
+ * @property {boolean} [active] - Denoted if the pincode is active or not.
462
+ * @property {string} [pincode] - Name of the pincode.
463
+ */
464
+ /**
465
+ * @typedef PincodeCodStatusListingResult
466
+ * @property {string} country - Name of the country.
467
+ * @property {PincodeCodStatusListingResult[]} data - List of pincode details.
468
+ * @property {boolean} success - Denotes if the request was successful or not.
469
+ * @property {Error[]} [errors] - List of error object in case of unsuccessful response.
449
470
  * @property {PincodeCodStatusListingPage} page
450
471
  * @property {PincodeCodStatusListingSummary} summary
451
472
  */
@@ -465,13 +486,13 @@ export = ServiceabilityPlatformModel;
465
486
  */
466
487
  /**
467
488
  * @typedef PincodeCodStatusListingSummary
468
- * @property {number} total_active_pincodes
469
- * @property {number} total_inactive_pincodes
489
+ * @property {number} total_active_pincodes - Count of the total active pincodes.
490
+ * @property {number} total_inactive_pincodes - Count of the total inactive pincodes.
470
491
  */
471
492
  /**
472
- * @typedef PincodeMopUpdateAuditHistoryRequest
473
- * @property {string} entity_type
474
- * @property {string} [file_name]
493
+ * @typedef PincodeMopUpdateAuditHistoryDetails
494
+ * @property {string} entity_type - Type of the entity requested.
495
+ * @property {string} [file_name] - Name of the file.
475
496
  */
476
497
  /**
477
498
  * @typedef PincodeMopUpdateAuditHistoryPaging
@@ -482,21 +503,22 @@ export = ServiceabilityPlatformModel;
482
503
  * @property {number} [item_total]
483
504
  */
484
505
  /**
485
- * @typedef PincodeMopUpdateAuditHistoryResponse
486
- * @property {string} [batch_id]
487
- * @property {string} [entity_type]
488
- * @property {string} [error_file_s3_url]
489
- * @property {string} [s3_url]
490
- * @property {string} [file_name]
506
+ * @typedef PincodeMopUpdateAuditHistoryResult
507
+ * @property {string} [batch_id] - Uniquie identifier of the request.
508
+ * @property {string} [entity_type] - Type of the entity requested.
509
+ * @property {string} [error_file_s3_url] - URL for the error file.
510
+ * @property {string} [s3_url] - CDN url for the file uploaded.
511
+ * @property {string} [file_name] - Name of the file.
491
512
  * @property {string} [updated_at]
492
513
  * @property {string} [updated_by]
493
- * @property {boolean} [success]
514
+ * @property {boolean} [success] - Denotes if the request was successfully processed.
494
515
  */
495
516
  /**
496
- * @typedef PincodeMopUpdateAuditHistoryResponseData
497
- * @property {string} [entity_type]
517
+ * @typedef PincodeMopUpdateAuditHistoryResultData
518
+ * @property {string} [entity_type] - Type of the entity requested.
498
519
  * @property {PincodeMopUpdateAuditHistoryPaging} page
499
- * @property {PincodeMopUpdateAuditHistoryResponse[]} data
520
+ * @property {PincodeMopUpdateAuditHistoryResult[]} data - History records of
521
+ * the uploaded files.
500
522
  */
501
523
  /**
502
524
  * @typedef ArithmeticOperations
@@ -523,34 +545,49 @@ export = ServiceabilityPlatformModel;
523
545
  * @property {string[]} [payment_mode]
524
546
  * @property {SchemeRulesFeatures} [feature]
525
547
  */
548
+ /**
549
+ * @typedef CourierAccountUpdateDetails
550
+ * @property {string} extension_id - Unique identifier of courier partner extension.
551
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
552
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
553
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
554
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
555
+ * account or not.
556
+ */
526
557
  /**
527
558
  * @typedef CourierAccount
528
- * @property {string} extension_id
529
- * @property {string} account_id
530
- * @property {string} scheme_id
531
- * @property {boolean} is_self_ship
532
- * @property {string} stage
533
- * @property {boolean} is_own_account
559
+ * @property {number} company_id - Company id associated with the account.
560
+ * @property {string} extension_id - Unique identifier of courier partner extension.
561
+ * @property {string} account_id - Unique identifier of courier partner scheme
562
+ * and company id combination.
563
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
564
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
565
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
566
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
567
+ * account or not.
568
+ * @property {CourierPartnerSchemeModel} scheme_rules
534
569
  */
535
570
  /**
536
- * @typedef CourierAccountRequestBody
537
- * @property {string} extension_id
538
- * @property {string} [account_id]
539
- * @property {string} scheme_id
540
- * @property {boolean} is_self_ship
541
- * @property {string} stage
542
- * @property {boolean} is_own_account
571
+ * @typedef CourierAccountDetailsBody
572
+ * @property {string} extension_id - Unique identifier of courier partner extension.
573
+ * @property {string} [account_id] - Unique identifier of courier partner scheme
574
+ * and company id combination.
575
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
576
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
577
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
578
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
579
+ * account or not.
543
580
  */
544
581
  /**
545
- * @typedef ErrorResponse
546
- * @property {string} value
547
- * @property {string} message
548
- * @property {string} type
582
+ * @typedef ErrorResult
583
+ * @property {string} value - Fields containing the error.
584
+ * @property {string} message - Description of the error.
585
+ * @property {string} type - Type of the error.
549
586
  */
550
587
  /**
551
- * @typedef CourierPartnerAccountFailureResponse
552
- * @property {boolean} success
553
- * @property {ErrorResponse[]} error
588
+ * @typedef CourierPartnerAccountFailureResult
589
+ * @property {boolean} success - Denotes whether the request is a success or failure.
590
+ * @property {ErrorResult[]} error
554
591
  */
555
592
  /**
556
593
  * @typedef Page
@@ -563,31 +600,38 @@ export = ServiceabilityPlatformModel;
563
600
  * @property {number} [size] - The number of items per page.
564
601
  */
565
602
  /**
566
- * @typedef CourierPartnerRuleCPListResponse
567
- * @property {string} [account_id]
568
- * @property {string} [extension_id]
569
- * @property {boolean} [is_self_ship]
570
- * @property {Object} [scheme_rules]
603
+ * @typedef CourierPartnerRuleCPListResult
604
+ * @property {string} account_id - Unique identifier of courier partner scheme
605
+ * and company id combination.
606
+ * @property {string} extension_id - Unique identifier of courier partner extension.
607
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
608
+ * @property {Object} [scheme_rules] - Denotes the scheme rules associated with
609
+ * the courier partner account.
571
610
  */
572
611
  /**
573
- * @typedef CourierPartnerRuleResponse
574
- * @property {boolean} [is_active]
575
- * @property {string} [application_id]
576
- * @property {number} [company_id]
577
- * @property {CourierPartnerRuleConditions} [conditions]
578
- * @property {string[]} [sort]
579
- * @property {Object} [created_by]
580
- * @property {string} [id]
581
- * @property {Object} [modified_by]
582
- * @property {string} [modified_on]
583
- * @property {string} [name]
584
- * @property {string} [type]
585
- * @property {CourierPartnerRuleCPListResponse[]} [cp_list]
612
+ * @typedef CourierPartnerRuleResult
613
+ * @property {boolean} is_active - Denotes whether the given courier partner
614
+ * rule is inactive or active.
615
+ * @property {string} application_id - Unique identifier of the sales channel.
616
+ * @property {number} company_id - Unique identifier of the company.
617
+ * @property {CourierPartnerRuleConditions} conditions
618
+ * @property {string[]} sort - Sort Strategy of the courier partners.
619
+ * @property {Object} [created_by] - The Fynd account used to create the courier
620
+ * partner rule.
621
+ * @property {string} id - Unique identifier of the courier partner rule.
622
+ * @property {Object} [modified_by] - The Fynd account used to modify the
623
+ * courier partner rule.
624
+ * @property {string} [modified_on] - The datetime at which courier partner rule
625
+ * is modified.
626
+ * @property {string} name - Name for the courier partner rule.
627
+ * @property {string} type - The type of the rule.
628
+ * @property {CourierPartnerRuleCPListResult[]} [cp_list]
586
629
  */
587
630
  /**
588
631
  * @typedef CourierPartnerList
589
- * @property {string} extension_id
590
- * @property {string} account_id
632
+ * @property {string} extension_id - Unique identifier of courier partner extension.
633
+ * @property {string} account_id - Unique identifier of courier partner scheme
634
+ * and company id combination.
591
635
  */
592
636
  /**
593
637
  * @typedef LocationRuleValues
@@ -595,7 +639,7 @@ export = ServiceabilityPlatformModel;
595
639
  * @property {string} [sub_type]
596
640
  * @property {string} [name]
597
641
  * @property {string} [display_name]
598
- * @property {string} [parent_id]
642
+ * @property {string[]} [parent_id]
599
643
  * @property {string[]} [parent_ids]
600
644
  */
601
645
  /**
@@ -632,86 +676,168 @@ export = ServiceabilityPlatformModel;
632
676
  */
633
677
  /**
634
678
  * @typedef CourierPartnerRule
635
- * @property {boolean} is_active
636
- * @property {CourierPartnerList[]} [cp_list]
637
- * @property {string} name
679
+ * @property {boolean} is_active - Denotes whether the given courier partner
680
+ * rule is inactive or active.
681
+ * @property {CourierPartnerList[]} [cp_list] - A list of courier partners.
682
+ * @property {string} name - Name for the courier partner rule.
638
683
  * @property {CourierPartnerRuleConditions} conditions
639
- * @property {string[]} sort
684
+ * @property {string[]} sort - Sort Strategy for the courier partners.
685
+ * @property {string} [type] - Denotes the type of the rule.
640
686
  */
641
687
  /**
642
- * @typedef FailureResponse
688
+ * @typedef FailureResult
643
689
  * @property {boolean} success
644
- * @property {ErrorResponse[]} error
690
+ * @property {ErrorResult[]} error
645
691
  */
646
692
  /**
647
- * @typedef CourierPartnerRulesListResponse
648
- * @property {CourierPartnerRuleResponse[]} items
693
+ * @typedef CourierPartnerRulesListResult
694
+ * @property {CourierPartnerRuleResult[]} items
649
695
  * @property {Page} page
650
696
  */
697
+ /**
698
+ * @typedef ShipmentsArticles
699
+ * @property {number} [item_id] - Unique identifier of the item.
700
+ * @property {number} [category_id] - Unique identifier of the category.
701
+ * @property {number} [brand_id] - Unique identifier of the brand.
702
+ * @property {number} [department_id] - Unique identifier of the department.
703
+ * @property {string[]} [tags] - Tags associated with the item.
704
+ */
705
+ /**
706
+ * @typedef ShipmentDimension
707
+ * @property {number} height - Height of the shipment in centimeters.
708
+ * @property {number} length - Length of the shipment in centimeters.
709
+ * @property {number} width - Width of the shipment in centimeters.
710
+ */
711
+ /**
712
+ * @typedef Shipments
713
+ * @property {string} [id] - Unique identifier of the shipment.
714
+ * @property {number} [location_id] - Unique identifier of the selling location.
715
+ * @property {string[]} [location_tags] - Tags associated with the selling location.
716
+ * @property {number} [shipment_weight] - Weight of the shipment.
717
+ * @property {number} [shipment_volumetric_weight] - Volumetric weight of the shipment.
718
+ * @property {number} [shipment_cost] - Total Cost of the shipment.
719
+ * @property {ShipmentDimension} [shipment_dimension]
720
+ * @property {string[]} [courier_partner_schemes] - A List of courier schemes.
721
+ * @property {ShipmentsArticles[]} [articles] - List of articles in the shipment.
722
+ */
723
+ /**
724
+ * @typedef ShipmentCourierPartnerDetails
725
+ * @property {ShipmentsCourierPartnersServiceability} from_location
726
+ * @property {ShipmentsCourierPartnersServiceability} to_location
727
+ * @property {Shipments[]} [shipments] - List of shipments.
728
+ * @property {string} [journey] - Journey type of the shipment forward or return.
729
+ * @property {string} [payment_mode] - Payment mode opted for the shipment.
730
+ */
731
+ /**
732
+ * @typedef CourierPartnerPromise
733
+ * @property {string} min - The earliest possible timestamp.
734
+ * @property {string} max - The latest possible timestamp.
735
+ */
736
+ /**
737
+ * @typedef CourierPartners
738
+ * @property {string} [extension_id] - Unique identifier of courier partner extension.
739
+ * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
740
+ * @property {string} [name] - Name of the courier partner.
741
+ * @property {CourierPartnerPromise} [delivery_promise]
742
+ */
743
+ /**
744
+ * @typedef ShipmentCourierPartners
745
+ * @property {string} [id] - Unique identifier of the shipment.
746
+ * @property {CourierPartners[]} [courier_partners] - Courier partners of the shipment.
747
+ */
748
+ /**
749
+ * @typedef ShipmentCourierPartnerResult
750
+ * @property {CourierPartners[]} [courier_partners]
751
+ * @property {ShipmentCourierPartners[]} [shipments]
752
+ */
753
+ /**
754
+ * @typedef ShipmentsCourierPartnersServiceability
755
+ * @property {string} [pincode] - Postal code or PIN code of the address area.
756
+ * @property {string} [sector_code] - Specifies the sector or district code of
757
+ * the address if applicable.
758
+ * @property {string} [state_code] - Indicates the state or province code of the address.
759
+ * @property {string} [city_code] - Denote the city or municipality code of the address.
760
+ * @property {string} country_code - ISO2 code for the country of the address.
761
+ */
651
762
  /**
652
763
  * @typedef CompanyConfig
653
- * @property {string[]} rule_ids
654
- * @property {string[]} sort
655
- * @property {boolean} [logistics_as_actual]
764
+ * @property {string[]} rule_ids - A list for courier partner rules.
765
+ * @property {string[]} sort - Sort strategy for the courier partners.
766
+ * @property {string} [logistics_as_actual] - Depicts if the courier partner
767
+ * rule configuration plan is subscribed by the seller for which mode.
768
+ * @property {number} company_id - Unique identifier of the company.
769
+ * @property {string} [application_id] - Unique identifier of the sales channel.
656
770
  */
657
771
  /**
658
772
  * @typedef ZoneConfig
659
- * @property {string} [serviceability_type]
773
+ * @property {string} [serviceability_type] - Serviceability type of the delivery zone.
774
+ * @property {number} [active_count] - Count of active delivery zones associated
775
+ * with the sales channel.
776
+ * @property {number} [total_count] - Count of total delivery zones associated
777
+ * with the sales channel.
660
778
  */
661
779
  /**
662
780
  * @typedef ApplicationConfig
663
- * @property {string[]} [rule_ids]
664
- * @property {string[]} [sort]
781
+ * @property {string[]} [rule_ids] - A list of courier partner rules.
782
+ * @property {string[]} [sort] - Strategy adopted to sort the courier partners.
665
783
  * @property {ZoneConfig} [zones]
666
784
  */
667
785
  /**
668
- * @typedef BulkRegionJobSerializer
669
- * @property {string} [file_path]
670
- * @property {string} country
671
- * @property {string} action
672
- * @property {string} region
786
+ * @typedef BulkRegionJobDetails
787
+ * @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
788
+ * @property {string} country - Country for which the tat or serviceability is
789
+ * to be imported or exported.
790
+ * @property {string} action - Denotes the import or export action to be performed.
791
+ * @property {string} region - Region of the country for which import or export
792
+ * is triggered.
673
793
  */
674
794
  /**
675
- * @typedef BulkRegionResponseItemData
676
- * @property {string} file_path
677
- * @property {number} [failed]
795
+ * @typedef BulkRegionResultItemData
796
+ * @property {string} [file_path] - CDN path of the file which was used for bulk import.
797
+ * @property {number} [failed] - Count of the failed records.
678
798
  * @property {Object[]} [failed_records]
679
- * @property {string} action
680
- * @property {string} batch_id
681
- * @property {string} country
682
- * @property {number} [success]
683
- * @property {string} region
684
- * @property {string} status
685
- * @property {number} [total]
686
- * @property {string} [error_file_path]
687
- */
688
- /**
689
- * @typedef BulkRegionResponse
690
- * @property {BulkRegionResponseItemData[]} items
799
+ * @property {string} action - Denotes the import or export action performed.
800
+ * @property {string} batch_id - Unique id to identify the import or export query.
801
+ * @property {string} country - Country for which the import or export action is
802
+ * performed.
803
+ * @property {number} [success] - Denoted if the import or export was successful
804
+ * or failure.
805
+ * @property {string} region - Region of the country for which import or export
806
+ * is triggered.
807
+ * @property {string} status - Current status of the import or export action performed.
808
+ * @property {number} [total] - Count of total records.
809
+ * @property {string} [error_file_path] - Path of the error file.
810
+ */
811
+ /**
812
+ * @typedef BulkRegionResult
813
+ * @property {BulkRegionResultItemData[]} items
691
814
  * @property {Page} page
692
815
  */
693
816
  /**
694
- * @typedef SelfShipResponse
817
+ * @typedef SelfShipResult
695
818
  * @property {boolean} is_active
696
819
  * @property {number} tat
697
820
  */
698
821
  /**
699
822
  * @typedef ApplicationSelfShipConfig
700
- * @property {Object} [self_ship]
823
+ * @property {SelfShipResult} [self_ship]
701
824
  */
702
825
  /**
703
- * @typedef ApplicationSelfShipConfigResponse
704
- * @property {ServiceabilityErrorResponse} [error]
826
+ * @typedef ApplicationSelfShipConfigResult
827
+ * @property {ServiceabilityErrorResult} [error]
705
828
  * @property {ApplicationSelfShipConfig} [data]
706
829
  * @property {boolean} success
707
830
  */
708
831
  /**
709
832
  * @typedef StoreRuleConfigData
710
- * @property {string[]} [rule_ids]
711
- * @property {string[]} [type_based_priority]
712
- * @property {string[]} [tag_based_priority]
713
- * @property {StorePrioritySchema[]} [store_priority]
714
- * @property {string[]} [sort]
833
+ * @property {string[]} [rule_ids] - List of rule ids which are active in the application.
834
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
835
+ * used in the basic prioritization sorting of stores.
836
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
837
+ * used in the basic prioritization sorting of stores.
838
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
839
+ * stores to be used for sorting of stores.
840
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
715
841
  */
716
842
  /**
717
843
  * @typedef CustomerRadiusSchema
@@ -737,203 +863,263 @@ export = ServiceabilityPlatformModel;
737
863
  */
738
864
  /**
739
865
  * @typedef StoreRuleDataSchema
740
- * @property {string} [id]
741
- * @property {string} [name]
742
- * @property {number} [company_id]
743
- * @property {string} [application_id]
744
- * @property {string[]} [type_based_priority]
745
- * @property {string[]} [tag_based_priority]
746
- * @property {StorePrioritySchema[]} [store_priority]
747
- * @property {string[]} [sort]
866
+ * @property {string} [id] - Id of the rule.
867
+ * @property {string} [name] - Name of the rule.
868
+ * @property {number} [company_id] - Company id for which the rule is created.
869
+ * @property {string} [application_id] - Application id for which the rule is created.
870
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
871
+ * used in the basic prioritization sorting of stores.
872
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
873
+ * used in the basic prioritization sorting of stores.
874
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
875
+ * stores to be used for sorting of stores.
876
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
748
877
  * @property {StoreRuleConditionSchema} [conditions]
749
- * @property {boolean} [is_active]
878
+ * @property {boolean} [is_active] - Denotes whether the rule is active or inactive.
750
879
  */
751
880
  /**
752
881
  * @typedef StorePrioritySchema
753
- * @property {string} [id]
754
- * @property {string} [name]
882
+ * @property {number} [id] - Id of the store.
883
+ * @property {string} [name] - Name of the store.
755
884
  */
756
885
  /**
757
- * @typedef GetStoreRulesApiResponse
886
+ * @typedef GetStoreRulesApiResult
758
887
  * @property {StoreRuleDataSchema[]} [items]
759
888
  * @property {Page} [page]
760
889
  */
761
890
  /**
762
- * @typedef CreateStoreRuleRequestSchema
763
- * @property {string} [name]
764
- * @property {boolean} [is_active]
891
+ * @typedef CreateStoreRuleDetailsSchema
892
+ * @property {string} [name] - Name of the rule.
893
+ * @property {boolean} [is_active] - Denotes if the rule is active or not.
765
894
  * @property {StoreRuleConditionSchema} [conditions]
766
- * @property {string[]} [type_based_priority]
767
- * @property {string[]} [tag_based_priority]
768
- * @property {StorePrioritySchema[]} [store_priority]
769
- * @property {string[]} [sort]
770
- */
771
- /**
772
- * @typedef StoreRuleResponseSchema
773
- * @property {string} [id]
774
- * @property {string} [name]
775
- * @property {string} [type]
776
- * @property {string[]} [type_based_priority]
777
- * @property {string[]} [tag_based_priority]
778
- * @property {StorePrioritySchema[]} [store_priority]
779
- * @property {string[]} [sort]
895
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
896
+ * used in the basic prioritization sorting of stores.
897
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
898
+ * used in the basic prioritization sorting of stores.
899
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
900
+ * stores to be used for sorting of stores.
901
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
902
+ */
903
+ /**
904
+ * @typedef StoreRuleResultSchema
905
+ * @property {string} [id] - Id of the rule created.
906
+ * @property {string} [name] - Name of the rule created.
907
+ * @property {string} [type] - Type of the rule created.
908
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
909
+ * used in the rule for sorting of stores.
910
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
911
+ * used in the rule for sorting of stores.
912
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
913
+ * stores to be used for sorting of stores.
914
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
780
915
  * @property {StoreRuleConditionSchema} [conditions]
781
- * @property {boolean} [is_active]
782
- */
783
- /**
784
- * @typedef StoreRuleUpdateResponseSchema
785
- * @property {string} [id]
786
- * @property {string} [name]
787
- * @property {string} [type]
788
- * @property {string[]} [type_based_priority]
789
- * @property {string[]} [tag_based_priority]
790
- * @property {StorePrioritySchema[]} [store_priority]
791
- * @property {string[]} [sort]
916
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
917
+ */
918
+ /**
919
+ * @typedef StoreRuleUpdateResultSchema
920
+ * @property {string} [id] - Id of the rule created.
921
+ * @property {string} [name] - Name of the rule created.
922
+ * @property {string} [type] - Type of the rule created.
923
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
924
+ * used in the rule for sorting of stores.
925
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
926
+ * used in the rule for sorting of stores.
927
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
928
+ * stores to be used for sorting of stores.
929
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
792
930
  * @property {StoreRuleConditionSchema} [conditions]
793
- * @property {boolean} [is_active]
794
- * @property {number} [company_id]
795
- * @property {string} [application_id]
931
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
932
+ * @property {number} [company_id] - Company id for which the rule is created.
933
+ * @property {string} [application_id] - Application id for which the rule is created.
796
934
  */
797
935
  /**
798
936
  * @typedef ServiceabilityModel
799
937
  * @property {number} lm_cod_limit
800
938
  * @property {boolean} is_qc
801
- * @property {string} pickup_cutoff
802
- * @property {string} route_code
939
+ * @property {string} [pickup_cutoff]
940
+ * @property {string} [route_code]
803
941
  * @property {boolean} is_first_mile
942
+ * @property {boolean} [is_reverse_pickup]
804
943
  * @property {boolean} is_return
805
944
  * @property {boolean} is_installation
806
945
  * @property {boolean} is_last_mile
807
946
  */
808
947
  /**
809
948
  * @typedef CourierPartnerSchemeFeatures
810
- * @property {boolean} [doorstep_qc]
811
- * @property {boolean} [qr]
812
- * @property {boolean} [mps]
813
- * @property {boolean} [ndr]
814
- * @property {number} [ndr_attempts]
815
- * @property {boolean} [dangerous_goods]
816
- * @property {boolean} [fragile_goods]
817
- * @property {boolean} [restricted_goods]
818
- * @property {boolean} [cold_storage_goods]
819
- * @property {boolean} [doorstep_exchange]
820
- * @property {boolean} [doorstep_return]
821
- * @property {boolean} [product_installation]
822
- * @property {boolean} [openbox_delivery]
823
- * @property {string} [status_updates]
824
- * @property {boolean} [multi_pick_single_drop]
825
- * @property {boolean} [single_pick_multi_drop]
826
- * @property {boolean} [multi_pick_multi_drop]
827
- * @property {boolean} [ewaybill]
949
+ * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
950
+ * doorstep quality check services.
951
+ * @property {boolean} [qr] - Specifies whether the courier partner supports QR
952
+ * code-based operations.
953
+ * @property {boolean} [mps] - Denotes if the courier partner supports
954
+ * multi-part shipment services.
955
+ * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
956
+ * feature is supported by the courier partner.
957
+ * @property {number} [ndr_attempts] - Number of attempts allowed for resolving
958
+ * Non-Delivery Reports (NDR).
959
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
960
+ * handles the transportation of dangerous goods.
961
+ * @property {boolean} [fragile_goods] - Indicates whether the courier partner
962
+ * manages the shipment of fragile goods.
963
+ * @property {boolean} [restricted_goods] - Indicates if the courier partner
964
+ * handles restricted goods, as per regulatory guidelines.
965
+ * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
966
+ * provides cold storage facilities for goods.
967
+ * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
968
+ * supports doorstep exchange services.
969
+ * @property {boolean} [doorstep_return] - Specifies if the courier partner
970
+ * offers doorstep return services.
971
+ * @property {boolean} [product_installation] - Indicates if the courier partner
972
+ * provides product installation services upon delivery.
973
+ * @property {boolean} [openbox_delivery] - Specifies whether the courier
974
+ * partner supports open-box delivery, allowing customers to inspect goods
975
+ * before accepting.
976
+ * @property {string} [status_updates] - Describes the type of status updates
977
+ * provided by the courier partner (e.g., real-time, periodic).
978
+ * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
979
+ * partner supports multiple pickups to a single drop location.
980
+ * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
981
+ * partner supports single pickup to multiple drop locations.
982
+ * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
983
+ * offers services for multiple pickups to multiple drop locations.
984
+ * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
985
+ * supports the generation of e-waybills for shipments.
986
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
987
+ * of items allowed in a quality check shipment.
988
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
989
+ * quantity of items allowed in a non-quality check shipment.
828
990
  */
829
991
  /**
830
992
  * @typedef CourierPartnerSchemeModel
831
- * @property {string} extension_id
832
- * @property {string} scheme_id
993
+ * @property {string} [name] - Name of the scheme.
994
+ * @property {string} extension_id - Unique identifier of courier partner extension.
995
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
996
+ * @property {ArithmeticOperations} [volumetric_weight]
833
997
  * @property {ArithmeticOperations} weight
834
- * @property {string} transport_type
835
- * @property {string} region
836
- * @property {string} delivery_type
837
- * @property {string[]} payment_mode
838
- * @property {string} stage
998
+ * @property {string} transport_type - Mode of transport associated with the
999
+ * courier partner scheme.
1000
+ * @property {string} region - Serviceable region associated with the courier
1001
+ * partner scheme.
1002
+ * @property {string} delivery_type - Type of delivery associated with the
1003
+ * courier partner scheme.
1004
+ * @property {string[]} payment_mode - Mode of payment associated with the
1005
+ * courier partner scheme.
1006
+ * @property {string} stage - Indicates if the courier partner scheme is
1007
+ * currently active or inactive.
839
1008
  * @property {CourierPartnerSchemeFeatures} feature
840
1009
  */
841
1010
  /**
842
- * @typedef CourierAccountResponse
843
- * @property {string} account_id
844
- * @property {string} scheme_id
845
- * @property {boolean} is_self_ship
846
- * @property {string} stage
847
- * @property {boolean} is_own_account
848
- * @property {CourierPartnerSchemeModel} scheme_rules
1011
+ * @typedef CourierAccountResult
1012
+ * @property {number} company_id - Company id associated with the account.
1013
+ * @property {string} [extension_id] - Unique identifier of courier partner extension.
1014
+ * @property {string} account_id - Unique identifier of courier partner scheme
1015
+ * and company id combination.
1016
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
1017
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
1018
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
1019
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
1020
+ * account or not.
1021
+ * @property {CourierPartnerSchemeModel} [scheme_rules]
849
1022
  */
850
1023
  /**
851
- * @typedef CompanyCourierPartnerAccountListResponse
852
- * @property {CourierAccountResponse[]} items
1024
+ * @typedef CompanyCourierPartnerAccountListResult
1025
+ * @property {CourierAccountResult[]} items
853
1026
  * @property {Page} page
854
1027
  */
855
1028
  /**
856
1029
  * @typedef PackageMaterial
857
- * @property {string} name
858
- * @property {number} width
859
- * @property {number} height
860
- * @property {number} length
861
- * @property {PackageMaterialRule[]} [rules]
862
- * @property {number[]} store_ids
863
- * @property {number} weight
864
- * @property {number} error_rate
865
- * @property {string} package_type
866
- * @property {string} size
867
- * @property {string[]} [media]
868
- * @property {Channel[]} channels
869
- * @property {boolean} [track_inventory]
870
- * @property {string} status
871
- * @property {number} [max_weight]
872
- * @property {number} [package_vol_weight]
873
- * @property {boolean} [auto_calculate]
874
- */
875
- /**
876
- * @typedef PackageMaterialResponse
877
- * @property {string} name
878
- * @property {string} [id]
879
- * @property {number} [item_id]
880
- * @property {number} width
881
- * @property {number} height
882
- * @property {number} length
883
- * @property {PackageMaterialRule[]} [rules]
884
- * @property {number[]} store_ids
885
- * @property {number} weight
886
- * @property {number} error_rate
887
- * @property {string} package_type
888
- * @property {string} size
889
- * @property {string[]} [media]
890
- * @property {Channel[]} channels
891
- * @property {boolean} [track_inventory]
892
- * @property {string} status
893
- * @property {number} [max_weight]
894
- * @property {number} [package_vol_weight]
895
- * @property {boolean} [auto_calculate]
1030
+ * @property {string} name - Name of the packaging material.
1031
+ * @property {number} width - Width of the packaging material dimentions in centimeter.
1032
+ * @property {number} height - Height of the packaging material dimentions in centimeter.
1033
+ * @property {number} length - Length of the packaging material dimentions in centimeter.
1034
+ * @property {PackageMaterialRule[]} [rules] - Product group rules associated
1035
+ * with the packaging.
1036
+ * @property {number[]} store_ids - Store ids where the packaging is avaiable.
1037
+ * @property {number} weight - Package's weight in gram.
1038
+ * @property {number} error_rate - Error Rate associated with the packaging dimensions.
1039
+ * @property {string} package_type - Type of package material.
1040
+ * @property {string} size - Physical size of the packaging.
1041
+ * @property {string[]} [media] - Image urls associated with the packaging material.
1042
+ * @property {Channel[]} channels - Sales channel where packaging is applicable.
1043
+ * @property {boolean} [track_inventory] - Denotes if the track of the inventory
1044
+ * should be kept.
1045
+ * @property {string} status - Current status of the packaging material, if it
1046
+ * is active or inactive.
1047
+ * @property {number} [max_weight] - Maximum weight holding capacity.
1048
+ * @property {number} [package_vol_weight] - Volumetric weight that a packaging
1049
+ * material can carry.
1050
+ * @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
1051
+ * should be auto calculated or not.
1052
+ */
1053
+ /**
1054
+ * @typedef PackageMaterialResult
1055
+ * @property {string} name - Name of the packaging material.
1056
+ * @property {string} [id] - Id of the packaging material.
1057
+ * @property {number} [item_id] - Unique identifier of an item associated with
1058
+ * the packaging material.
1059
+ * @property {number} [company_id] - Company id associated with the packaging material.
1060
+ * @property {number} width - Width of the packaging material dimentions in centimeter.
1061
+ * @property {number} height - Height of the packaging material dimentions in centimeter.
1062
+ * @property {number} length - Length of the packaging material dimentions in centimeter.
1063
+ * @property {PackageMaterialRule[]} [rules] - Product group rules associated
1064
+ * with the packaging.
1065
+ * @property {number[]} store_ids - Store ids where the packaging is avaiable.
1066
+ * @property {number} weight - Package's weight in gram.
1067
+ * @property {number} error_rate - Error Rate associated with the packaging dimensions.
1068
+ * @property {string} package_type - Type of package material.
1069
+ * @property {string} size - Physical size of the packaging.
1070
+ * @property {string[]} [media] - Image urls associated with the packaging material.
1071
+ * @property {Channel[]} channels - Sales channel where packaging is applicable.
1072
+ * @property {boolean} [track_inventory] - Denotes if the track of the inventory
1073
+ * should be kept.
1074
+ * @property {string} status - Current status of the packaging material, if it
1075
+ * is active or inactive.
1076
+ * @property {number} [max_weight] - Maximum weight holding capacity.
1077
+ * @property {number} [package_vol_weight] - Volumetric weight that a packaging
1078
+ * material can carry.
1079
+ * @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
1080
+ * should be auto calculated or not.
896
1081
  */
897
1082
  /**
898
1083
  * @typedef PackageMaterialRule
899
- * @property {string} [rule_id]
1084
+ * @property {string} [rule_id] - Unique identifier of the package rule.
900
1085
  * @property {PackageMaterialRuleQuantity} [quantity]
901
- * @property {number} [weight]
1086
+ * @property {number} [weight] - Volumetric weight in gram.
902
1087
  */
903
1088
  /**
904
1089
  * @typedef PackageRule
905
- * @property {string} name
906
- * @property {number} company_id
907
- * @property {string} type
908
- * @property {boolean} [is_active]
1090
+ * @property {string} name - Name of the package rule.
1091
+ * @property {number} company_id - Unique identifier of the company.
1092
+ * @property {string} type - Type of the rule.
1093
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
909
1094
  * @property {PackageRuleProductTag} [product_tag]
910
1095
  * @property {PackageRuleProduct} [product_id]
911
1096
  * @property {PackageRuleCategory} [category_id]
912
1097
  */
913
1098
  /**
914
- * @typedef PackageRuleResponse
915
- * @property {string} [id]
916
- * @property {string} name
917
- * @property {number} company_id
918
- * @property {string} type
919
- * @property {boolean} [is_active]
1099
+ * @typedef PackageRuleResult
1100
+ * @property {string} [id] - Unique id of a package rule.
1101
+ * @property {string} name - Name of a package rule.
1102
+ * @property {number} company_id - Unique identifier of a company associated
1103
+ * with the package rule.
1104
+ * @property {string} type - Type of the rule created.
1105
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
920
1106
  * @property {PackageRuleProductTag} [product_tag]
921
1107
  * @property {PackageRuleProduct} [product_id]
922
1108
  * @property {PackageRuleCategory} [category_id]
923
1109
  */
924
1110
  /**
925
1111
  * @typedef Channel
926
- * @property {string} [type]
927
- * @property {string} [id]
1112
+ * @property {string} [type] - Type of the channel.
1113
+ * @property {string} [id] - Unique identifier of the channel.
928
1114
  */
929
1115
  /**
930
1116
  * @typedef PackageMaterialRuleList
931
- * @property {PackageRuleResponse} [items]
1117
+ * @property {PackageRuleResult} [items]
932
1118
  * @property {Page} [page]
933
1119
  */
934
1120
  /**
935
1121
  * @typedef PackageMaterialList
936
- * @property {PackageMaterialResponse} [items]
1122
+ * @property {PackageMaterialResult} [items]
937
1123
  * @property {Page} [page]
938
1124
  */
939
1125
  /**
@@ -950,17 +1136,18 @@ export = ServiceabilityPlatformModel;
950
1136
  */
951
1137
  /**
952
1138
  * @typedef PackageMaterialRuleQuantity
953
- * @property {number} [min]
954
- * @property {number} [max]
1139
+ * @property {number} [min] - Minimum product's quantity that a packaging can contain.
1140
+ * @property {number} [max] - Maximum product's quantity that a packaging can contain.
955
1141
  */
956
1142
  /**
957
- * @typedef RulePriorityRequest
958
- * @property {string} rule_id
959
- * @property {number} priority
1143
+ * @typedef RulePriorityDetails
1144
+ * @property {string} rule_id - Rule id whose priority needs to be changed.
1145
+ * @property {number} priority - New priority of the rule.
960
1146
  */
961
1147
  /**
962
- * @typedef RulePriorityResponse
963
- * @property {boolean} [success]
1148
+ * @typedef RulePriorityResult
1149
+ * @property {boolean} [success] - Denotes if the priority of the rule is
1150
+ * changes successfully or not.
964
1151
  */
965
1152
  /**
966
1153
  * @typedef ArticleAssignment
@@ -987,7 +1174,7 @@ export = ServiceabilityPlatformModel;
987
1174
  * @typedef OptimalLocationsArticles
988
1175
  * @property {number} item_id
989
1176
  * @property {string} size
990
- * @property {string} quantity
1177
+ * @property {number} quantity
991
1178
  * @property {string} [group_id]
992
1179
  * @property {boolean} [is_primary_item]
993
1180
  * @property {Object} [meta]
@@ -997,15 +1184,15 @@ export = ServiceabilityPlatformModel;
997
1184
  * @property {number} [seller_id]
998
1185
  */
999
1186
  /**
1000
- * @typedef OptimlLocationsRequestSchema
1187
+ * @typedef OptimlLocationsDetailsSchema
1001
1188
  * @property {string} channel_id
1002
1189
  * @property {string} channel_type
1003
1190
  * @property {string} [channel_identifier]
1004
1191
  * @property {LocationDetailsServiceability} to_serviceability
1005
- * @property {OptimalLocationsArticles} [article]
1192
+ * @property {OptimalLocationsArticles[]} [articles]
1006
1193
  */
1007
1194
  /**
1008
- * @typedef OptimalLocationArticlesResponse
1195
+ * @typedef OptimalLocationArticlesResult
1009
1196
  * @property {number} item_id
1010
1197
  * @property {string} size
1011
1198
  * @property {number} quantity
@@ -1022,28 +1209,196 @@ export = ServiceabilityPlatformModel;
1022
1209
  * @property {string} uid
1023
1210
  */
1024
1211
  /**
1025
- * @typedef OptimalLocationAssignedStoresResponse
1212
+ * @typedef OptimalLocationAssignedStoresResult
1026
1213
  * @property {number} store_id
1027
- * @property {OptimalLocationArticlesResponse[]} articles
1214
+ * @property {OptimalLocationArticlesResult[]} articles
1215
+ */
1216
+ /**
1217
+ * @typedef OptimalLocationsResult
1218
+ * @property {OptimalLocationAssignedStoresResult[]} assigned_stores
1219
+ * @property {ErrorResult[]} [faulty_articles]
1220
+ */
1221
+ /**
1222
+ * @typedef ValidationError
1223
+ * @property {string} message - A brief description of the error encountered.
1224
+ * @property {string} field - The field in the request that caused the error.
1225
+ */
1226
+ /**
1227
+ * @typedef StandardError
1228
+ * @property {string} message - A brief description of the error.
1229
+ */
1230
+ /**
1231
+ * @typedef CourierPartnerSchemeV2Features
1232
+ * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
1233
+ * doorstep quality check services.
1234
+ * @property {boolean} [qr] - Specifies whether the courier partner supports QR
1235
+ * code-based operations.
1236
+ * @property {boolean} [mps] - Denotes if the courier partner supports
1237
+ * multi-part shipment services.
1238
+ * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
1239
+ * feature is supported by the courier partner.
1240
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
1241
+ * handles the transportation of dangerous goods.
1242
+ * @property {boolean} [fragile_goods] - Indicates whether the courier partner
1243
+ * manages the shipment of fragile goods.
1244
+ * @property {boolean} [restricted_goods] - Indicates if the courier partner
1245
+ * handles restricted goods, as per regulatory guidelines.
1246
+ * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
1247
+ * provides cold storage facilities for goods.
1248
+ * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
1249
+ * supports doorstep exchange services.
1250
+ * @property {boolean} [doorstep_return] - Specifies if the courier partner
1251
+ * offers doorstep return services.
1252
+ * @property {boolean} [product_installation] - Indicates if the courier partner
1253
+ * provides product installation services upon delivery.
1254
+ * @property {boolean} [openbox_delivery] - Specifies whether the courier
1255
+ * partner supports open-box delivery, allowing customers to inspect goods
1256
+ * before accepting.
1257
+ * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
1258
+ * partner supports multiple pickups to a single drop location.
1259
+ * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
1260
+ * partner supports single pickup to multiple drop locations.
1261
+ * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
1262
+ * offers services for multiple pickups to multiple drop locations.
1263
+ * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
1264
+ * supports the generation of e-waybills for shipments.
1265
+ */
1266
+ /**
1267
+ * @typedef CourierPartnerSchemeV2DetailsModel
1268
+ * @property {string} extension_id - Unique identifier of courier partner extension
1269
+ * @property {string} [scheme_id]
1270
+ * @property {string} name
1271
+ * @property {ArithmeticOperations} weight
1272
+ * @property {ArithmeticOperations} [volumetric_weight]
1273
+ * @property {string} transport_type
1274
+ * @property {string} region
1275
+ * @property {string} delivery_type
1276
+ * @property {string[]} payment_mode
1277
+ * @property {string} stage
1278
+ * @property {string} [status_updates] - Describes the type of status updates
1279
+ * provided by the courier partner (e.g., real-time, periodic).
1280
+ * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
1281
+ * (NDR) feature is supported by the courier partner.
1282
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
1283
+ * of items allowed in a quality check shipment.
1284
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
1285
+ * quantity of items allowed in a non-quality check shipment.
1286
+ * @property {CourierPartnerSchemeV2Features} feature
1287
+ */
1288
+ /**
1289
+ * @typedef CourierPartnerV2SchemeModel
1290
+ * @property {string} extension_id - Unique identifier of courier partner extension.
1291
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
1292
+ * @property {string} [company_id] - Unique identifier of company.
1293
+ * @property {string} name - Name of the scheme.
1294
+ * @property {ArithmeticOperations} weight
1295
+ * @property {ArithmeticOperations} [volumetric_weight]
1296
+ * @property {string} transport_type - Mode of transport associated with the
1297
+ * courier partner scheme.
1298
+ * @property {string} region - Serviceable region associated with the courier
1299
+ * partner scheme.
1300
+ * @property {string} delivery_type - Type of delivery associated with the
1301
+ * courier partner scheme.
1302
+ * @property {string[]} payment_mode - Mode of payment associated with the
1303
+ * courier partner scheme.
1304
+ * @property {string} stage - Indicates if the courier partner scheme is
1305
+ * currently active or inactive.
1306
+ * @property {string} [status_updates] - Describes the type of status updates
1307
+ * provided by the courier partner (e.g., real-time, periodic).
1308
+ * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
1309
+ * (NDR) feature is supported by the courier partner.
1310
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
1311
+ * of items allowed in a quality check shipment.
1312
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
1313
+ * quantity of items allowed in a non-quality check shipment.
1314
+ * @property {CourierPartnerSchemeV2Features} feature
1315
+ */
1316
+ /**
1317
+ * @typedef CourierPartnerSchemeV2UpdateDetails
1318
+ * @property {string} name
1319
+ * @property {ArithmeticOperations} weight
1320
+ * @property {ArithmeticOperations} [volumetric_weight]
1321
+ * @property {string} transport_type
1322
+ * @property {string} region
1323
+ * @property {string} delivery_type
1324
+ * @property {string[]} payment_mode
1325
+ * @property {string} stage
1326
+ * @property {string} [status_updates] - Describes the type of status updates
1327
+ * provided by the courier partner (e.g., real-time, periodic).
1328
+ * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
1329
+ * (NDR) feature is supported by the courier partner.
1330
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
1331
+ * of items allowed in a quality check shipment.
1332
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
1333
+ * quantity of items allowed in a non-quality check shipment.
1334
+ * @property {CourierPartnerSchemeV2Features} feature
1335
+ */
1336
+ /**
1337
+ * @typedef courierPartnerSchemeV2List
1338
+ * @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
1339
+ * @property {Page} page
1340
+ */
1341
+ /**
1342
+ * @typedef BulkRegionServiceabilityTatDetails
1343
+ * @property {string} country
1344
+ * @property {string} region
1345
+ * @property {string} type
1346
+ */
1347
+ /**
1348
+ * @typedef BulkRegionServiceabilityTatResultItemData
1349
+ * @property {string} [country] - Name of the country.
1350
+ * @property {string} [region] - Name of the region for which the
1351
+ * tat/serviceability file needs to be downloaded.
1352
+ * @property {string} [type] - Denotes the type of data.
1353
+ * @property {string} [batch_id] - Unique identifier identifying the perticular request.
1354
+ * @property {string} [status] - Current status of the request.
1355
+ * @property {Object[]} [failed_records] - Information of records which failed
1356
+ * @property {string} [file_path] - CDN path of the file.
1028
1357
  */
1029
1358
  /**
1030
- * @typedef OptimalLocationsResponse
1031
- * @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
1032
- * @property {ErrorResponse[]} [faulty_articles]
1359
+ * @typedef BulkRegionServiceabilityTatResult
1360
+ * @property {BulkRegionServiceabilityTatResultItemData[]} [items]
1361
+ * @property {Page} [page]
1362
+ */
1363
+ /**
1364
+ * @typedef HierarchyItems
1365
+ * @property {string} [display_name]
1366
+ * @property {string} [slug]
1367
+ */
1368
+ /**
1369
+ * @typedef GetCountriesItems
1370
+ * @property {string} [id]
1371
+ * @property {string} [name]
1372
+ * @property {string} [iso2]
1373
+ * @property {string} [iso3]
1374
+ * @property {string[]} [timezones]
1375
+ * @property {HierarchyItems[]} [hierarchy]
1376
+ * @property {string} [phone_code]
1377
+ * @property {string} [currency]
1378
+ * @property {string} [type]
1379
+ * @property {string} [latitude]
1380
+ * @property {string} [longitude]
1381
+ * @property {string} [display_name]
1382
+ * @property {boolean} [has_next_hierarchy]
1383
+ */
1384
+ /**
1385
+ * @typedef GetCountries
1386
+ * @property {GetCountriesItems[]} items
1387
+ * @property {Page} page
1033
1388
  */
1034
1389
  declare class ServiceabilityPlatformModel {
1035
1390
  }
1036
1391
  declare namespace ServiceabilityPlatformModel {
1037
- export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingDetailType, ZoneMappingType, ZoneMappingRegions, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerRuleCPListResponse, CourierPartnerRuleResponse, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
1392
+ export { UpdateZoneConfigDetails, ServiceabilityErrorResult, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResult, EntityRegionView_Details, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResult, PageSchema, EntityRegionView_Items, EntityRegionView_Result, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResult, CompanyStoreView_PageItems, CompanyStoreView_Result, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingDetailType, ZoneMappingType, ZoneMappingRegions, UpdateZoneData, ZoneUpdateDetails, ZoneSuccessResult, GetZoneDataViewItems, GetSingleZoneDataViewResult, GetZoneByIdSchema, CreateZoneData, ZoneResult, GetZoneFromPincodeViewDetails, Zone, GetZoneFromPincodeViewResult, GetZoneFromApplicationIdViewResult, ServiceabilityPageResult, MobileNo, ManagerResult, ModifiedByResult, IntegrationTypeResult, ProductReturnConfigResult, ContactNumberResult, AddressResult, CreatedByResult, EwayBillResult, EinvoiceResult, GstCredentialsResult, WarningsResult, OpeningClosing, TimmingResult, DocumentsResult, Dp, LogisticsResult, ItemResult, GetStoresViewResult, PincodeMopData, PincodeMopUpdateResult, PincodeMOPResult, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusItem, PincodeCodStatusListingResult, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, PincodeMopUpdateAuditHistoryResultData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccountUpdateDetails, CourierAccount, CourierAccountDetailsBody, ErrorResult, CourierPartnerAccountFailureResult, Page, CourierPartnerRuleCPListResult, CourierPartnerRuleResult, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResult, CourierPartnerRulesListResult, ShipmentsArticles, ShipmentDimension, Shipments, ShipmentCourierPartnerDetails, CourierPartnerPromise, CourierPartners, ShipmentCourierPartners, ShipmentCourierPartnerResult, ShipmentsCourierPartnersServiceability, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, SelfShipResult, ApplicationSelfShipConfig, ApplicationSelfShipConfigResult, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialResult, PackageMaterialRule, PackageRule, PackageRuleResult, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityDetails, RulePriorityResult, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsDetailsSchema, OptimalLocationArticlesResult, OptimalLocationAssignedStoresResult, OptimalLocationsResult, ValidationError, StandardError, CourierPartnerSchemeV2Features, CourierPartnerSchemeV2DetailsModel, CourierPartnerV2SchemeModel, CourierPartnerSchemeV2UpdateDetails, courierPartnerSchemeV2List, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, HierarchyItems, GetCountriesItems, GetCountries };
1038
1393
  }
1039
- /** @returns {UpdateZoneConfigRequest} */
1040
- declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
1041
- type UpdateZoneConfigRequest = {
1394
+ /** @returns {UpdateZoneConfigDetails} */
1395
+ declare function UpdateZoneConfigDetails(): UpdateZoneConfigDetails;
1396
+ type UpdateZoneConfigDetails = {
1042
1397
  serviceability_type?: string;
1043
1398
  };
1044
- /** @returns {ServiceabilityErrorResponse} */
1045
- declare function ServiceabilityErrorResponse(): ServiceabilityErrorResponse;
1046
- type ServiceabilityErrorResponse = {
1399
+ /** @returns {ServiceabilityErrorResult} */
1400
+ declare function ServiceabilityErrorResult(): ServiceabilityErrorResult;
1401
+ type ServiceabilityErrorResult = {
1047
1402
  message: string;
1048
1403
  value: string;
1049
1404
  type: string;
@@ -1055,16 +1410,16 @@ type ApplicationServiceabilityConfig = {
1055
1410
  serviceability_type: string;
1056
1411
  channel_type: string;
1057
1412
  };
1058
- /** @returns {ApplicationServiceabilityConfigResponse} */
1059
- declare function ApplicationServiceabilityConfigResponse(): ApplicationServiceabilityConfigResponse;
1060
- type ApplicationServiceabilityConfigResponse = {
1061
- error?: ServiceabilityErrorResponse;
1413
+ /** @returns {ApplicationServiceabilityConfigResult} */
1414
+ declare function ApplicationServiceabilityConfigResult(): ApplicationServiceabilityConfigResult;
1415
+ type ApplicationServiceabilityConfigResult = {
1416
+ error?: ServiceabilityErrorResult;
1062
1417
  data?: ApplicationServiceabilityConfig;
1063
1418
  success: boolean;
1064
1419
  };
1065
- /** @returns {EntityRegionView_Request} */
1066
- declare function EntityRegionView_Request(): EntityRegionView_Request;
1067
- type EntityRegionView_Request = {
1420
+ /** @returns {EntityRegionView_Details} */
1421
+ declare function EntityRegionView_Details(): EntityRegionView_Details;
1422
+ type EntityRegionView_Details = {
1068
1423
  sub_type: string[];
1069
1424
  parent_id?: string[];
1070
1425
  };
@@ -1084,9 +1439,9 @@ type EntityRegionView_page = {
1084
1439
  size: number;
1085
1440
  current: number;
1086
1441
  };
1087
- /** @returns {getAppRegionZonesResponse} */
1088
- declare function getAppRegionZonesResponse(): getAppRegionZonesResponse;
1089
- type getAppRegionZonesResponse = {
1442
+ /** @returns {getAppRegionZonesResult} */
1443
+ declare function getAppRegionZonesResult(): getAppRegionZonesResult;
1444
+ type getAppRegionZonesResult = {
1090
1445
  page: PageSchema[];
1091
1446
  items: ListViewItems[];
1092
1447
  };
@@ -1106,9 +1461,9 @@ type EntityRegionView_Items = {
1106
1461
  uid: string;
1107
1462
  name: string;
1108
1463
  };
1109
- /** @returns {EntityRegionView_Response} */
1110
- declare function EntityRegionView_Response(): EntityRegionView_Response;
1111
- type EntityRegionView_Response = {
1464
+ /** @returns {EntityRegionView_Result} */
1465
+ declare function EntityRegionView_Result(): EntityRegionView_Result;
1466
+ type EntityRegionView_Result = {
1112
1467
  error: EntityRegionView_Error;
1113
1468
  page: EntityRegionView_page;
1114
1469
  data: EntityRegionView_Items[];
@@ -1185,9 +1540,9 @@ type ListViewItems = {
1185
1540
  */
1186
1541
  channels: ListViewChannels[];
1187
1542
  };
1188
- /** @returns {ListViewResponse} */
1189
- declare function ListViewResponse(): ListViewResponse;
1190
- type ListViewResponse = {
1543
+ /** @returns {ListViewResult} */
1544
+ declare function ListViewResult(): ListViewResult;
1545
+ type ListViewResult = {
1191
1546
  page: ZoneDataItem;
1192
1547
  items: ListViewItems[];
1193
1548
  };
@@ -1200,9 +1555,9 @@ type CompanyStoreView_PageItems = {
1200
1555
  size: number;
1201
1556
  current: number;
1202
1557
  };
1203
- /** @returns {CompanyStoreView_Response} */
1204
- declare function CompanyStoreView_Response(): CompanyStoreView_Response;
1205
- type CompanyStoreView_Response = {
1558
+ /** @returns {CompanyStoreView_Result} */
1559
+ declare function CompanyStoreView_Result(): CompanyStoreView_Result;
1560
+ type CompanyStoreView_Result = {
1206
1561
  page: CompanyStoreView_PageItems[];
1207
1562
  items?: any[];
1208
1563
  };
@@ -1215,7 +1570,14 @@ type GetZoneDataViewChannels = {
1215
1570
  /** @returns {ZoneProductTypes} */
1216
1571
  declare function ZoneProductTypes(): ZoneProductTypes;
1217
1572
  type ZoneProductTypes = {
1573
+ /**
1574
+ * - Denotes if the zone is applicable for all the
1575
+ * products or specific products.
1576
+ */
1218
1577
  type: string;
1578
+ /**
1579
+ * - List of product tags.
1580
+ */
1219
1581
  tags: string[];
1220
1582
  };
1221
1583
  /** @returns {ZoneMappingDetailType} */
@@ -1233,7 +1595,13 @@ type ZoneMappingDetailType = {
1233
1595
  /** @returns {ZoneMappingType} */
1234
1596
  declare function ZoneMappingType(): ZoneMappingType;
1235
1597
  type ZoneMappingType = {
1598
+ /**
1599
+ * - Uid for the country.
1600
+ */
1236
1601
  country: string;
1602
+ /**
1603
+ * - List of region uid for the given country.
1604
+ */
1237
1605
  regions: string[];
1238
1606
  };
1239
1607
  /** @returns {ZoneMappingRegions} */
@@ -1260,89 +1628,208 @@ type ZoneMappingRegions = {
1260
1628
  /** @returns {UpdateZoneData} */
1261
1629
  declare function UpdateZoneData(): UpdateZoneData;
1262
1630
  type UpdateZoneData = {
1631
+ /**
1632
+ * - Unique identifier for the zone.
1633
+ */
1263
1634
  zone_id: string;
1635
+ /**
1636
+ * - Name for the zone.
1637
+ */
1264
1638
  name: string;
1639
+ /**
1640
+ * - A human-readable and unique identifier for the
1641
+ * zone, derived from the name.
1642
+ */
1265
1643
  slug: string;
1644
+ /**
1645
+ * - Company id associated with the zone.
1646
+ */
1266
1647
  company_id: number;
1648
+ /**
1649
+ * - A flag indicating whether the zone is active.
1650
+ */
1267
1651
  is_active: boolean;
1652
+ /**
1653
+ * - Channels for which the zone is active.
1654
+ */
1268
1655
  channels: GetZoneDataViewChannels[];
1269
1656
  product: ZoneProductTypes;
1657
+ /**
1658
+ * - A list of store identifiers associated with the zone.
1659
+ */
1270
1660
  store_ids: number[];
1661
+ /**
1662
+ * - Type of region that belongs in the zone.
1663
+ */
1271
1664
  region_type: string;
1665
+ /**
1666
+ * - Country to region mapping for the zone.
1667
+ */
1272
1668
  mapping: ZoneMappingType[];
1273
1669
  };
1274
- /** @returns {ZoneUpdateRequest} */
1275
- declare function ZoneUpdateRequest(): ZoneUpdateRequest;
1276
- type ZoneUpdateRequest = {
1670
+ /** @returns {ZoneUpdateDetails} */
1671
+ declare function ZoneUpdateDetails(): ZoneUpdateDetails;
1672
+ type ZoneUpdateDetails = {
1277
1673
  identifier: string;
1278
1674
  data: UpdateZoneData;
1279
1675
  };
1280
- /** @returns {ZoneSuccessResponse} */
1281
- declare function ZoneSuccessResponse(): ZoneSuccessResponse;
1282
- type ZoneSuccessResponse = {
1676
+ /** @returns {ZoneSuccessResult} */
1677
+ declare function ZoneSuccessResult(): ZoneSuccessResult;
1678
+ type ZoneSuccessResult = {
1283
1679
  status_code: number;
1284
1680
  success: boolean;
1285
1681
  };
1286
1682
  /** @returns {GetZoneDataViewItems} */
1287
1683
  declare function GetZoneDataViewItems(): GetZoneDataViewItems;
1288
1684
  type GetZoneDataViewItems = {
1685
+ /**
1686
+ * - The unique identifier for the zone.
1687
+ */
1289
1688
  zone_id: string;
1689
+ /**
1690
+ * - The name of the zone for easy identification.
1691
+ */
1290
1692
  name: string;
1693
+ /**
1694
+ * - A URL-friendly version of the zone’s name, used for
1695
+ * routing or linking.
1696
+ */
1291
1697
  slug: string;
1698
+ /**
1699
+ * - The ID of the company associated with this zone.
1700
+ */
1292
1701
  company_id?: number;
1702
+ /**
1703
+ * - A flag indicating whether the zone is active
1704
+ * (true) or inactive (false).
1705
+ */
1293
1706
  is_active: boolean;
1707
+ /**
1708
+ * - A list of channels available
1709
+ * within this zone.
1710
+ */
1294
1711
  channels: GetZoneDataViewChannels[];
1295
1712
  product: ZoneProductTypes;
1713
+ /**
1714
+ * - A collection of store IDs linked to this zone.
1715
+ */
1296
1716
  store_ids: number[];
1717
+ /**
1718
+ * - The type of region the zone represents.
1719
+ */
1297
1720
  region_type?: string;
1721
+ /**
1722
+ * - A list of mappings defining
1723
+ * relationships between this zone and other entities.
1724
+ */
1298
1725
  mapping: ZoneMappingType[];
1726
+ /**
1727
+ * - The preferred method for
1728
+ * assigning stores or products to the zone.
1729
+ */
1730
+ assignment_preference?: string;
1731
+ /**
1732
+ * - The total number of stores assigned to this zone.
1733
+ */
1299
1734
  stores_count: number;
1300
1735
  };
1301
- /** @returns {GetSingleZoneDataViewResponse} */
1302
- declare function GetSingleZoneDataViewResponse(): GetSingleZoneDataViewResponse;
1303
- type GetSingleZoneDataViewResponse = {
1736
+ /** @returns {GetSingleZoneDataViewResult} */
1737
+ declare function GetSingleZoneDataViewResult(): GetSingleZoneDataViewResult;
1738
+ type GetSingleZoneDataViewResult = {
1304
1739
  data: GetZoneDataViewItems;
1305
1740
  };
1306
1741
  /** @returns {GetZoneByIdSchema} */
1307
1742
  declare function GetZoneByIdSchema(): GetZoneByIdSchema;
1308
1743
  type GetZoneByIdSchema = {
1744
+ /**
1745
+ * - Unique identifier for the zone.
1746
+ */
1309
1747
  zone_id: string;
1748
+ /**
1749
+ * - Name for the zone.
1750
+ */
1310
1751
  name: string;
1752
+ /**
1753
+ * - A human-readable and unique identifier for the
1754
+ * zone, derived from the name.
1755
+ */
1311
1756
  slug: string;
1757
+ /**
1758
+ * - Company id associated with the zone.
1759
+ */
1312
1760
  company_id?: number;
1761
+ /**
1762
+ * - A flag indicating whether the zone is active.
1763
+ */
1313
1764
  is_active: boolean;
1765
+ /**
1766
+ * - Channels for which the zone is active.
1767
+ */
1314
1768
  channels: GetZoneDataViewChannels[];
1315
1769
  product: ZoneProductTypes;
1770
+ /**
1771
+ * - A list of store identifiers associated with the zone.
1772
+ */
1316
1773
  store_ids: number[];
1774
+ /**
1775
+ * - Type of region that belongs in the zone.
1776
+ */
1317
1777
  region_type: string;
1318
1778
  /**
1319
1779
  * - Country to region mapping for the zone.
1320
1780
  */
1321
1781
  mapping: ZoneMappingDetailType[];
1782
+ stores_count?: number;
1322
1783
  };
1323
1784
  /** @returns {CreateZoneData} */
1324
1785
  declare function CreateZoneData(): CreateZoneData;
1325
1786
  type CreateZoneData = {
1787
+ /**
1788
+ * - Name of the zone.
1789
+ */
1326
1790
  name: string;
1791
+ /**
1792
+ * - A human-readable and unique identifier for the
1793
+ * zone, derived from the name.
1794
+ */
1327
1795
  slug: string;
1796
+ /**
1797
+ * - Unique identifier of the company for which
1798
+ * the zone is created.
1799
+ */
1328
1800
  company_id: number;
1329
- is_active: boolean;
1330
- channels: GetZoneDataViewChannels[];
1801
+ /**
1802
+ * - A flag indicating whether the zone is active.
1803
+ */
1804
+ is_active: boolean;
1805
+ /**
1806
+ * - Channels for which the zone is active.
1807
+ */
1808
+ channels: GetZoneDataViewChannels[];
1809
+ /**
1810
+ * - A list of store identifiers associated with the zone.
1811
+ */
1331
1812
  store_ids: number[];
1332
- product: ZoneProductTypes;
1813
+ /**
1814
+ * - Type of region that belongs in the zone.
1815
+ */
1333
1816
  region_type: string;
1817
+ /**
1818
+ * - Country to region mapping for the zone.
1819
+ */
1334
1820
  mapping: ZoneMappingType[];
1821
+ product?: ZoneProductTypes;
1335
1822
  };
1336
- /** @returns {ZoneResponse} */
1337
- declare function ZoneResponse(): ZoneResponse;
1338
- type ZoneResponse = {
1339
- status_code: number;
1823
+ /** @returns {ZoneResult} */
1824
+ declare function ZoneResult(): ZoneResult;
1825
+ type ZoneResult = {
1826
+ status_code?: number;
1340
1827
  zone_id: string;
1341
1828
  success: boolean;
1342
1829
  };
1343
- /** @returns {GetZoneFromPincodeViewRequest} */
1344
- declare function GetZoneFromPincodeViewRequest(): GetZoneFromPincodeViewRequest;
1345
- type GetZoneFromPincodeViewRequest = {
1830
+ /** @returns {GetZoneFromPincodeViewDetails} */
1831
+ declare function GetZoneFromPincodeViewDetails(): GetZoneFromPincodeViewDetails;
1832
+ type GetZoneFromPincodeViewDetails = {
1346
1833
  country: string;
1347
1834
  pincode: string;
1348
1835
  };
@@ -1357,21 +1844,21 @@ type Zone = {
1357
1844
  is_active: boolean;
1358
1845
  store_ids: number[];
1359
1846
  };
1360
- /** @returns {GetZoneFromPincodeViewResponse} */
1361
- declare function GetZoneFromPincodeViewResponse(): GetZoneFromPincodeViewResponse;
1362
- type GetZoneFromPincodeViewResponse = {
1847
+ /** @returns {GetZoneFromPincodeViewResult} */
1848
+ declare function GetZoneFromPincodeViewResult(): GetZoneFromPincodeViewResult;
1849
+ type GetZoneFromPincodeViewResult = {
1363
1850
  serviceability_type: string;
1364
1851
  zones: Zone[];
1365
1852
  };
1366
- /** @returns {GetZoneFromApplicationIdViewResponse} */
1367
- declare function GetZoneFromApplicationIdViewResponse(): GetZoneFromApplicationIdViewResponse;
1368
- type GetZoneFromApplicationIdViewResponse = {
1853
+ /** @returns {GetZoneFromApplicationIdViewResult} */
1854
+ declare function GetZoneFromApplicationIdViewResult(): GetZoneFromApplicationIdViewResult;
1855
+ type GetZoneFromApplicationIdViewResult = {
1369
1856
  page: ZoneDataItem[];
1370
1857
  items: ListViewItems[];
1371
1858
  };
1372
- /** @returns {ServiceabilityPageResponse} */
1373
- declare function ServiceabilityPageResponse(): ServiceabilityPageResponse;
1374
- type ServiceabilityPageResponse = {
1859
+ /** @returns {ServiceabilityPageResult} */
1860
+ declare function ServiceabilityPageResult(): ServiceabilityPageResult;
1861
+ type ServiceabilityPageResult = {
1375
1862
  type?: string;
1376
1863
  has_next?: boolean;
1377
1864
  item_total?: number;
@@ -1384,39 +1871,39 @@ type MobileNo = {
1384
1871
  number?: string;
1385
1872
  country_code?: number;
1386
1873
  };
1387
- /** @returns {ManagerResponse} */
1388
- declare function ManagerResponse(): ManagerResponse;
1389
- type ManagerResponse = {
1874
+ /** @returns {ManagerResult} */
1875
+ declare function ManagerResult(): ManagerResult;
1876
+ type ManagerResult = {
1390
1877
  email?: string;
1391
1878
  mobile_no?: MobileNo;
1392
1879
  name?: string;
1393
1880
  };
1394
- /** @returns {ModifiedByResponse} */
1395
- declare function ModifiedByResponse(): ModifiedByResponse;
1396
- type ModifiedByResponse = {
1881
+ /** @returns {ModifiedByResult} */
1882
+ declare function ModifiedByResult(): ModifiedByResult;
1883
+ type ModifiedByResult = {
1397
1884
  username?: string;
1398
1885
  user_id?: string;
1399
1886
  };
1400
- /** @returns {IntegrationTypeResponse} */
1401
- declare function IntegrationTypeResponse(): IntegrationTypeResponse;
1402
- type IntegrationTypeResponse = {
1887
+ /** @returns {IntegrationTypeResult} */
1888
+ declare function IntegrationTypeResult(): IntegrationTypeResult;
1889
+ type IntegrationTypeResult = {
1403
1890
  inventory?: string;
1404
1891
  order?: string;
1405
1892
  };
1406
- /** @returns {ProductReturnConfigResponse} */
1407
- declare function ProductReturnConfigResponse(): ProductReturnConfigResponse;
1408
- type ProductReturnConfigResponse = {
1893
+ /** @returns {ProductReturnConfigResult} */
1894
+ declare function ProductReturnConfigResult(): ProductReturnConfigResult;
1895
+ type ProductReturnConfigResult = {
1409
1896
  on_same_store?: boolean;
1410
1897
  };
1411
- /** @returns {ContactNumberResponse} */
1412
- declare function ContactNumberResponse(): ContactNumberResponse;
1413
- type ContactNumberResponse = {
1898
+ /** @returns {ContactNumberResult} */
1899
+ declare function ContactNumberResult(): ContactNumberResult;
1900
+ type ContactNumberResult = {
1414
1901
  number?: string;
1415
1902
  country_code?: number;
1416
1903
  };
1417
- /** @returns {AddressResponse} */
1418
- declare function AddressResponse(): AddressResponse;
1419
- type AddressResponse = {
1904
+ /** @returns {AddressResult} */
1905
+ declare function AddressResult(): AddressResult;
1906
+ type AddressResult = {
1420
1907
  city?: string;
1421
1908
  address1?: string;
1422
1909
  pincode?: number;
@@ -1427,31 +1914,31 @@ type AddressResponse = {
1427
1914
  latitude?: number;
1428
1915
  longitude?: number;
1429
1916
  };
1430
- /** @returns {CreatedByResponse} */
1431
- declare function CreatedByResponse(): CreatedByResponse;
1432
- type CreatedByResponse = {
1917
+ /** @returns {CreatedByResult} */
1918
+ declare function CreatedByResult(): CreatedByResult;
1919
+ type CreatedByResult = {
1433
1920
  username?: string;
1434
1921
  user_id?: string;
1435
1922
  };
1436
- /** @returns {EwayBillResponse} */
1437
- declare function EwayBillResponse(): EwayBillResponse;
1438
- type EwayBillResponse = {
1923
+ /** @returns {EwayBillResult} */
1924
+ declare function EwayBillResult(): EwayBillResult;
1925
+ type EwayBillResult = {
1439
1926
  enabled?: boolean;
1440
1927
  };
1441
- /** @returns {EinvoiceResponse} */
1442
- declare function EinvoiceResponse(): EinvoiceResponse;
1443
- type EinvoiceResponse = {
1928
+ /** @returns {EinvoiceResult} */
1929
+ declare function EinvoiceResult(): EinvoiceResult;
1930
+ type EinvoiceResult = {
1444
1931
  enabled?: boolean;
1445
1932
  };
1446
- /** @returns {GstCredentialsResponse} */
1447
- declare function GstCredentialsResponse(): GstCredentialsResponse;
1448
- type GstCredentialsResponse = {
1449
- e_waybill?: EwayBillResponse;
1450
- e_invoice?: EinvoiceResponse;
1933
+ /** @returns {GstCredentialsResult} */
1934
+ declare function GstCredentialsResult(): GstCredentialsResult;
1935
+ type GstCredentialsResult = {
1936
+ e_waybill?: EwayBillResult;
1937
+ e_invoice?: EinvoiceResult;
1451
1938
  };
1452
- /** @returns {WarningsResponse} */
1453
- declare function WarningsResponse(): WarningsResponse;
1454
- type WarningsResponse = {
1939
+ /** @returns {WarningsResult} */
1940
+ declare function WarningsResult(): WarningsResult;
1941
+ type WarningsResult = {
1455
1942
  store_address?: string;
1456
1943
  };
1457
1944
  /** @returns {OpeningClosing} */
@@ -1460,17 +1947,17 @@ type OpeningClosing = {
1460
1947
  minute?: number;
1461
1948
  hour?: number;
1462
1949
  };
1463
- /** @returns {TimmingResponse} */
1464
- declare function TimmingResponse(): TimmingResponse;
1465
- type TimmingResponse = {
1950
+ /** @returns {TimmingResult} */
1951
+ declare function TimmingResult(): TimmingResult;
1952
+ type TimmingResult = {
1466
1953
  open?: boolean;
1467
1954
  weekday?: string;
1468
1955
  closing?: OpeningClosing;
1469
1956
  opening?: OpeningClosing;
1470
1957
  };
1471
- /** @returns {DocumentsResponse} */
1472
- declare function DocumentsResponse(): DocumentsResponse;
1473
- type DocumentsResponse = {
1958
+ /** @returns {DocumentsResult} */
1959
+ declare function DocumentsResult(): DocumentsResult;
1960
+ type DocumentsResult = {
1474
1961
  legal_name?: string;
1475
1962
  value?: string;
1476
1963
  type?: string;
@@ -1490,110 +1977,207 @@ type Dp = {
1490
1977
  transport_mode?: string;
1491
1978
  assign_dp_from_sb?: boolean;
1492
1979
  };
1493
- /** @returns {LogisticsResponse} */
1494
- declare function LogisticsResponse(): LogisticsResponse;
1495
- type LogisticsResponse = {
1980
+ /** @returns {LogisticsResult} */
1981
+ declare function LogisticsResult(): LogisticsResult;
1982
+ type LogisticsResult = {
1496
1983
  override?: boolean;
1497
1984
  dp?: Dp;
1498
1985
  };
1499
- /** @returns {ItemResponse} */
1500
- declare function ItemResponse(): ItemResponse;
1501
- type ItemResponse = {
1986
+ /** @returns {ItemResult} */
1987
+ declare function ItemResult(): ItemResult;
1988
+ type ItemResult = {
1502
1989
  created_on?: string;
1503
- manager?: ManagerResponse;
1504
- modified_by?: ModifiedByResponse;
1505
- integration_type?: IntegrationTypeResponse;
1990
+ manager?: ManagerResult;
1991
+ modified_by?: ModifiedByResult;
1992
+ integration_type?: IntegrationTypeResult;
1506
1993
  verified_on?: string;
1507
- product_return_config?: ProductReturnConfigResponse;
1508
- contact_numbers?: ContactNumberResponse[];
1509
- verified_by?: ModifiedByResponse;
1994
+ product_return_config?: ProductReturnConfigResult;
1995
+ contact_numbers?: ContactNumberResult[];
1996
+ verified_by?: ModifiedByResult;
1510
1997
  stage?: string;
1511
- address?: AddressResponse;
1998
+ address?: AddressResult;
1512
1999
  modified_on?: string;
1513
- created_by?: CreatedByResponse;
1514
- gst_credentials?: GstCredentialsResponse;
2000
+ created_by?: CreatedByResult;
2001
+ gst_credentials?: GstCredentialsResult;
1515
2002
  display_name?: string;
1516
2003
  company_id?: number;
1517
2004
  uid?: number;
2005
+ /**
2006
+ * - Custom JSON for internal usage
2007
+ */
1518
2008
  _custom_json?: any;
1519
2009
  code?: string;
1520
- warnings?: WarningsResponse;
2010
+ warnings?: WarningsResult;
1521
2011
  name?: string;
1522
- timing?: TimmingResponse[];
1523
- documents?: DocumentsResponse[];
2012
+ timing?: TimmingResult[];
2013
+ documents?: DocumentsResult[];
1524
2014
  store_type?: string;
1525
2015
  sub_type?: string;
1526
2016
  company?: number;
1527
2017
  _cls?: string;
1528
- logistics?: LogisticsResponse;
2018
+ logistics?: LogisticsResult;
1529
2019
  notification_emails?: string[];
1530
2020
  };
1531
- /** @returns {GetStoresViewResponse} */
1532
- declare function GetStoresViewResponse(): GetStoresViewResponse;
1533
- type GetStoresViewResponse = {
1534
- page: ServiceabilityPageResponse;
1535
- items?: ItemResponse[];
2021
+ /** @returns {GetStoresViewResult} */
2022
+ declare function GetStoresViewResult(): GetStoresViewResult;
2023
+ type GetStoresViewResult = {
2024
+ page: ServiceabilityPageResult;
2025
+ items?: ItemResult[];
1536
2026
  };
1537
2027
  /** @returns {PincodeMopData} */
1538
2028
  declare function PincodeMopData(): PincodeMopData;
1539
2029
  type PincodeMopData = {
2030
+ /**
2031
+ * - A list of pincodes.
2032
+ */
1540
2033
  pincodes: number[];
2034
+ /**
2035
+ * - Name of the country.
2036
+ */
1541
2037
  country: string;
2038
+ /**
2039
+ * - Denotes wether to activate or deavtivate pincodes
2040
+ * for COD mode of payment.
2041
+ */
1542
2042
  action: string;
1543
2043
  };
1544
- /** @returns {PincodeMopUpdateResponse} */
1545
- declare function PincodeMopUpdateResponse(): PincodeMopUpdateResponse;
1546
- type PincodeMopUpdateResponse = {
2044
+ /** @returns {PincodeMopUpdateResult} */
2045
+ declare function PincodeMopUpdateResult(): PincodeMopUpdateResult;
2046
+ type PincodeMopUpdateResult = {
2047
+ /**
2048
+ * - Pincode of the region.
2049
+ */
1547
2050
  pincode: number;
2051
+ /**
2052
+ * - Unique identifier of the sales channel.
2053
+ */
1548
2054
  channel_id: string;
2055
+ /**
2056
+ * - Country name.
2057
+ */
1549
2058
  country: string;
2059
+ /**
2060
+ * - Denotes whether the pincode mode of payment
2061
+ * is active or not.
2062
+ */
1550
2063
  is_active: boolean;
1551
2064
  };
1552
- /** @returns {PincodeMOPresponse} */
1553
- declare function PincodeMOPresponse(): PincodeMOPresponse;
1554
- type PincodeMOPresponse = {
2065
+ /** @returns {PincodeMOPResult} */
2066
+ declare function PincodeMOPResult(): PincodeMOPResult;
2067
+ type PincodeMOPResult = {
2068
+ /**
2069
+ * - Denotes if the action was successful or not.
2070
+ */
1555
2071
  success: boolean;
2072
+ /**
2073
+ * - Status code for the response.
2074
+ */
1556
2075
  status_code: number;
2076
+ /**
2077
+ * - Unique identifier identifying the perticular request.
2078
+ */
1557
2079
  batch_id: string;
2080
+ /**
2081
+ * - Name of the country.
2082
+ */
1558
2083
  country: string;
2084
+ /**
2085
+ * - Denotes wether to activate or deavtivate pincodes
2086
+ * for COD mode of payment.
2087
+ */
1559
2088
  action: string;
2089
+ /**
2090
+ * - List of pincodes.
2091
+ */
1560
2092
  pincodes?: number[];
1561
- updated_pincodes?: PincodeMopUpdateResponse[];
2093
+ /**
2094
+ * - Details of the
2095
+ * updated pincodes.
2096
+ */
2097
+ updated_pincodes?: PincodeMopUpdateResult[];
1562
2098
  };
1563
2099
  /** @returns {CommonError} */
1564
2100
  declare function CommonError(): CommonError;
1565
2101
  type CommonError = {
2102
+ /**
2103
+ * - Status code for the error.
2104
+ */
1566
2105
  status_code?: string;
1567
2106
  error?: any;
2107
+ /**
2108
+ * - Whether operation was successful.
2109
+ */
1568
2110
  success?: string;
1569
2111
  };
1570
2112
  /** @returns {PincodeMopBulkData} */
1571
2113
  declare function PincodeMopBulkData(): PincodeMopBulkData;
1572
2114
  type PincodeMopBulkData = {
2115
+ /**
2116
+ * - Unique identifier for the request.
2117
+ */
1573
2118
  batch_id: string;
2119
+ /**
2120
+ * - CDN url for the uploaded file.
2121
+ */
1574
2122
  s3_url: string;
1575
2123
  };
1576
- /** @returns {PincodeBulkViewResponse} */
1577
- declare function PincodeBulkViewResponse(): PincodeBulkViewResponse;
1578
- type PincodeBulkViewResponse = {
2124
+ /** @returns {PincodeBulkViewResult} */
2125
+ declare function PincodeBulkViewResult(): PincodeBulkViewResult;
2126
+ type PincodeBulkViewResult = {
1579
2127
  batch_id: string;
2128
+ /**
2129
+ * - CDN url for the uploaded file.
2130
+ */
1580
2131
  s3_url: string;
1581
2132
  };
1582
- /** @returns {PincodeCodStatusListingRequest} */
1583
- declare function PincodeCodStatusListingRequest(): PincodeCodStatusListingRequest;
1584
- type PincodeCodStatusListingRequest = {
2133
+ /** @returns {PincodeCodStatusListingDetails} */
2134
+ declare function PincodeCodStatusListingDetails(): PincodeCodStatusListingDetails;
2135
+ type PincodeCodStatusListingDetails = {
2136
+ /**
2137
+ * - Name of the country.
2138
+ */
1585
2139
  country?: string;
2140
+ /**
2141
+ * - Search based on the active or inactive flag.
2142
+ */
1586
2143
  is_active?: boolean;
2144
+ /**
2145
+ * - Search based on the pincode.
2146
+ */
1587
2147
  pincode?: number;
1588
2148
  current?: number;
1589
2149
  page_size?: number;
1590
2150
  };
1591
- /** @returns {PincodeCodStatusListingResponse} */
1592
- declare function PincodeCodStatusListingResponse(): PincodeCodStatusListingResponse;
1593
- type PincodeCodStatusListingResponse = {
2151
+ /** @returns {PincodeCodStatusItem} */
2152
+ declare function PincodeCodStatusItem(): PincodeCodStatusItem;
2153
+ type PincodeCodStatusItem = {
2154
+ /**
2155
+ * - Denoted if the pincode is active or not.
2156
+ */
2157
+ active?: boolean;
2158
+ /**
2159
+ * - Name of the pincode.
2160
+ */
2161
+ pincode?: string;
2162
+ };
2163
+ /** @returns {PincodeCodStatusListingResult} */
2164
+ declare function PincodeCodStatusListingResult(): PincodeCodStatusListingResult;
2165
+ type PincodeCodStatusListingResult = {
2166
+ /**
2167
+ * - Name of the country.
2168
+ */
1594
2169
  country: string;
1595
- data: PincodeCodStatusListingResponse[];
2170
+ /**
2171
+ * - List of pincode details.
2172
+ */
2173
+ data: PincodeCodStatusListingResult[];
2174
+ /**
2175
+ * - Denotes if the request was successful or not.
2176
+ */
1596
2177
  success: boolean;
2178
+ /**
2179
+ * - List of error object in case of unsuccessful response.
2180
+ */
1597
2181
  errors?: Error[];
1598
2182
  page: PincodeCodStatusListingPage;
1599
2183
  summary: PincodeCodStatusListingSummary;
@@ -1617,13 +2201,25 @@ type PincodeCodStatusListingPage = {
1617
2201
  /** @returns {PincodeCodStatusListingSummary} */
1618
2202
  declare function PincodeCodStatusListingSummary(): PincodeCodStatusListingSummary;
1619
2203
  type PincodeCodStatusListingSummary = {
2204
+ /**
2205
+ * - Count of the total active pincodes.
2206
+ */
1620
2207
  total_active_pincodes: number;
2208
+ /**
2209
+ * - Count of the total inactive pincodes.
2210
+ */
1621
2211
  total_inactive_pincodes: number;
1622
2212
  };
1623
- /** @returns {PincodeMopUpdateAuditHistoryRequest} */
1624
- declare function PincodeMopUpdateAuditHistoryRequest(): PincodeMopUpdateAuditHistoryRequest;
1625
- type PincodeMopUpdateAuditHistoryRequest = {
2213
+ /** @returns {PincodeMopUpdateAuditHistoryDetails} */
2214
+ declare function PincodeMopUpdateAuditHistoryDetails(): PincodeMopUpdateAuditHistoryDetails;
2215
+ type PincodeMopUpdateAuditHistoryDetails = {
2216
+ /**
2217
+ * - Type of the entity requested.
2218
+ */
1626
2219
  entity_type: string;
2220
+ /**
2221
+ * - Name of the file.
2222
+ */
1627
2223
  file_name?: string;
1628
2224
  };
1629
2225
  /** @returns {PincodeMopUpdateAuditHistoryPaging} */
@@ -1635,24 +2231,49 @@ type PincodeMopUpdateAuditHistoryPaging = {
1635
2231
  has_next?: boolean;
1636
2232
  item_total?: number;
1637
2233
  };
1638
- /** @returns {PincodeMopUpdateAuditHistoryResponse} */
1639
- declare function PincodeMopUpdateAuditHistoryResponse(): PincodeMopUpdateAuditHistoryResponse;
1640
- type PincodeMopUpdateAuditHistoryResponse = {
2234
+ /** @returns {PincodeMopUpdateAuditHistoryResult} */
2235
+ declare function PincodeMopUpdateAuditHistoryResult(): PincodeMopUpdateAuditHistoryResult;
2236
+ type PincodeMopUpdateAuditHistoryResult = {
2237
+ /**
2238
+ * - Uniquie identifier of the request.
2239
+ */
1641
2240
  batch_id?: string;
2241
+ /**
2242
+ * - Type of the entity requested.
2243
+ */
1642
2244
  entity_type?: string;
2245
+ /**
2246
+ * - URL for the error file.
2247
+ */
1643
2248
  error_file_s3_url?: string;
2249
+ /**
2250
+ * - CDN url for the file uploaded.
2251
+ */
1644
2252
  s3_url?: string;
2253
+ /**
2254
+ * - Name of the file.
2255
+ */
1645
2256
  file_name?: string;
1646
2257
  updated_at?: string;
1647
2258
  updated_by?: string;
2259
+ /**
2260
+ * - Denotes if the request was successfully processed.
2261
+ */
1648
2262
  success?: boolean;
1649
2263
  };
1650
- /** @returns {PincodeMopUpdateAuditHistoryResponseData} */
1651
- declare function PincodeMopUpdateAuditHistoryResponseData(): PincodeMopUpdateAuditHistoryResponseData;
1652
- type PincodeMopUpdateAuditHistoryResponseData = {
2264
+ /** @returns {PincodeMopUpdateAuditHistoryResultData} */
2265
+ declare function PincodeMopUpdateAuditHistoryResultData(): PincodeMopUpdateAuditHistoryResultData;
2266
+ type PincodeMopUpdateAuditHistoryResultData = {
2267
+ /**
2268
+ * - Type of the entity requested.
2269
+ */
1653
2270
  entity_type?: string;
1654
2271
  page: PincodeMopUpdateAuditHistoryPaging;
1655
- data: PincodeMopUpdateAuditHistoryResponse[];
2272
+ /**
2273
+ * - History records of
2274
+ * the uploaded files.
2275
+ */
2276
+ data: PincodeMopUpdateAuditHistoryResult[];
1656
2277
  };
1657
2278
  /** @returns {ArithmeticOperations} */
1658
2279
  declare function ArithmeticOperations(): ArithmeticOperations;
@@ -1682,38 +2303,120 @@ type SchemeRules = {
1682
2303
  payment_mode?: string[];
1683
2304
  feature?: SchemeRulesFeatures;
1684
2305
  };
2306
+ /** @returns {CourierAccountUpdateDetails} */
2307
+ declare function CourierAccountUpdateDetails(): CourierAccountUpdateDetails;
2308
+ type CourierAccountUpdateDetails = {
2309
+ /**
2310
+ * - Unique identifier of courier partner extension.
2311
+ */
2312
+ extension_id: string;
2313
+ /**
2314
+ * - Unique identifier of courier partner scheme.
2315
+ */
2316
+ scheme_id: string;
2317
+ /**
2318
+ * - Denotes if the account is of self delivery type.
2319
+ */
2320
+ is_self_ship: boolean;
2321
+ /**
2322
+ * - Denotes whether the account is in enabled or disabled stage.
2323
+ */
2324
+ stage: string;
2325
+ /**
2326
+ * - Denotes whether it is the seller's own
2327
+ * account or not.
2328
+ */
2329
+ is_own_account: boolean;
2330
+ };
1685
2331
  /** @returns {CourierAccount} */
1686
2332
  declare function CourierAccount(): CourierAccount;
1687
2333
  type CourierAccount = {
2334
+ /**
2335
+ * - Company id associated with the account.
2336
+ */
2337
+ company_id: number;
2338
+ /**
2339
+ * - Unique identifier of courier partner extension.
2340
+ */
1688
2341
  extension_id: string;
2342
+ /**
2343
+ * - Unique identifier of courier partner scheme
2344
+ * and company id combination.
2345
+ */
1689
2346
  account_id: string;
2347
+ /**
2348
+ * - Unique identifier of courier partner scheme.
2349
+ */
1690
2350
  scheme_id: string;
2351
+ /**
2352
+ * - Denotes if the account is of self delivery type.
2353
+ */
1691
2354
  is_self_ship: boolean;
2355
+ /**
2356
+ * - Denotes whether the account is in enabled or disabled stage.
2357
+ */
1692
2358
  stage: string;
2359
+ /**
2360
+ * - Denotes whether it is the seller's own
2361
+ * account or not.
2362
+ */
1693
2363
  is_own_account: boolean;
2364
+ scheme_rules: CourierPartnerSchemeModel;
1694
2365
  };
1695
- /** @returns {CourierAccountRequestBody} */
1696
- declare function CourierAccountRequestBody(): CourierAccountRequestBody;
1697
- type CourierAccountRequestBody = {
2366
+ /** @returns {CourierAccountDetailsBody} */
2367
+ declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
2368
+ type CourierAccountDetailsBody = {
2369
+ /**
2370
+ * - Unique identifier of courier partner extension.
2371
+ */
1698
2372
  extension_id: string;
2373
+ /**
2374
+ * - Unique identifier of courier partner scheme
2375
+ * and company id combination.
2376
+ */
1699
2377
  account_id?: string;
2378
+ /**
2379
+ * - Unique identifier of courier partner scheme.
2380
+ */
1700
2381
  scheme_id: string;
2382
+ /**
2383
+ * - Denotes if the account is of self delivery type.
2384
+ */
1701
2385
  is_self_ship: boolean;
2386
+ /**
2387
+ * - Denotes whether the account is in enabled or disabled stage.
2388
+ */
1702
2389
  stage: string;
2390
+ /**
2391
+ * - Denotes whether it is the seller's own
2392
+ * account or not.
2393
+ */
1703
2394
  is_own_account: boolean;
1704
2395
  };
1705
- /** @returns {ErrorResponse} */
1706
- declare function ErrorResponse(): ErrorResponse;
1707
- type ErrorResponse = {
2396
+ /** @returns {ErrorResult} */
2397
+ declare function ErrorResult(): ErrorResult;
2398
+ type ErrorResult = {
2399
+ /**
2400
+ * - Fields containing the error.
2401
+ */
1708
2402
  value: string;
2403
+ /**
2404
+ * - Description of the error.
2405
+ */
1709
2406
  message: string;
2407
+ /**
2408
+ * - Type of the error.
2409
+ */
1710
2410
  type: string;
1711
2411
  };
1712
- /** @returns {CourierPartnerAccountFailureResponse} */
1713
- declare function CourierPartnerAccountFailureResponse(): CourierPartnerAccountFailureResponse;
1714
- type CourierPartnerAccountFailureResponse = {
2412
+ /** @returns {CourierPartnerAccountFailureResult} */
2413
+ declare function CourierPartnerAccountFailureResult(): CourierPartnerAccountFailureResult;
2414
+ type CourierPartnerAccountFailureResult = {
2415
+ /**
2416
+ * - Denotes whether the request is a success or failure.
2417
+ */
1715
2418
  success: boolean;
1716
- error: ErrorResponse[];
2419
+ error: ErrorResult[];
1717
2420
  };
1718
2421
  /** @returns {Page} */
1719
2422
  declare function Page(): Page;
@@ -1747,34 +2450,89 @@ type Page = {
1747
2450
  */
1748
2451
  size?: number;
1749
2452
  };
1750
- /** @returns {CourierPartnerRuleCPListResponse} */
1751
- declare function CourierPartnerRuleCPListResponse(): CourierPartnerRuleCPListResponse;
1752
- type CourierPartnerRuleCPListResponse = {
1753
- account_id?: string;
1754
- extension_id?: string;
1755
- is_self_ship?: boolean;
2453
+ /** @returns {CourierPartnerRuleCPListResult} */
2454
+ declare function CourierPartnerRuleCPListResult(): CourierPartnerRuleCPListResult;
2455
+ type CourierPartnerRuleCPListResult = {
2456
+ /**
2457
+ * - Unique identifier of courier partner scheme
2458
+ * and company id combination.
2459
+ */
2460
+ account_id: string;
2461
+ /**
2462
+ * - Unique identifier of courier partner extension.
2463
+ */
2464
+ extension_id: string;
2465
+ /**
2466
+ * - Denotes if the account is of self delivery type.
2467
+ */
2468
+ is_self_ship: boolean;
2469
+ /**
2470
+ * - Denotes the scheme rules associated with
2471
+ * the courier partner account.
2472
+ */
1756
2473
  scheme_rules?: any;
1757
2474
  };
1758
- /** @returns {CourierPartnerRuleResponse} */
1759
- declare function CourierPartnerRuleResponse(): CourierPartnerRuleResponse;
1760
- type CourierPartnerRuleResponse = {
1761
- is_active?: boolean;
1762
- application_id?: string;
1763
- company_id?: number;
1764
- conditions?: CourierPartnerRuleConditions;
1765
- sort?: string[];
2475
+ /** @returns {CourierPartnerRuleResult} */
2476
+ declare function CourierPartnerRuleResult(): CourierPartnerRuleResult;
2477
+ type CourierPartnerRuleResult = {
2478
+ /**
2479
+ * - Denotes whether the given courier partner
2480
+ * rule is inactive or active.
2481
+ */
2482
+ is_active: boolean;
2483
+ /**
2484
+ * - Unique identifier of the sales channel.
2485
+ */
2486
+ application_id: string;
2487
+ /**
2488
+ * - Unique identifier of the company.
2489
+ */
2490
+ company_id: number;
2491
+ conditions: CourierPartnerRuleConditions;
2492
+ /**
2493
+ * - Sort Strategy of the courier partners.
2494
+ */
2495
+ sort: string[];
2496
+ /**
2497
+ * - The Fynd account used to create the courier
2498
+ * partner rule.
2499
+ */
1766
2500
  created_by?: any;
1767
- id?: string;
2501
+ /**
2502
+ * - Unique identifier of the courier partner rule.
2503
+ */
2504
+ id: string;
2505
+ /**
2506
+ * - The Fynd account used to modify the
2507
+ * courier partner rule.
2508
+ */
1768
2509
  modified_by?: any;
2510
+ /**
2511
+ * - The datetime at which courier partner rule
2512
+ * is modified.
2513
+ */
1769
2514
  modified_on?: string;
1770
- name?: string;
1771
- type?: string;
1772
- cp_list?: CourierPartnerRuleCPListResponse[];
2515
+ /**
2516
+ * - Name for the courier partner rule.
2517
+ */
2518
+ name: string;
2519
+ /**
2520
+ * - The type of the rule.
2521
+ */
2522
+ type: string;
2523
+ cp_list?: CourierPartnerRuleCPListResult[];
1773
2524
  };
1774
2525
  /** @returns {CourierPartnerList} */
1775
2526
  declare function CourierPartnerList(): CourierPartnerList;
1776
2527
  type CourierPartnerList = {
2528
+ /**
2529
+ * - Unique identifier of courier partner extension.
2530
+ */
1777
2531
  extension_id: string;
2532
+ /**
2533
+ * - Unique identifier of courier partner scheme
2534
+ * and company id combination.
2535
+ */
1778
2536
  account_id: string;
1779
2537
  };
1780
2538
  /** @returns {LocationRuleValues} */
@@ -1784,7 +2542,7 @@ type LocationRuleValues = {
1784
2542
  sub_type?: string;
1785
2543
  name?: string;
1786
2544
  display_name?: string;
1787
- parent_id?: string;
2545
+ parent_id?: string[];
1788
2546
  parent_ids?: string[];
1789
2547
  };
1790
2548
  /** @returns {LocationRule} */
@@ -1826,97 +2584,383 @@ type CourierPartnerRuleConditions = {
1826
2584
  /** @returns {CourierPartnerRule} */
1827
2585
  declare function CourierPartnerRule(): CourierPartnerRule;
1828
2586
  type CourierPartnerRule = {
2587
+ /**
2588
+ * - Denotes whether the given courier partner
2589
+ * rule is inactive or active.
2590
+ */
1829
2591
  is_active: boolean;
2592
+ /**
2593
+ * - A list of courier partners.
2594
+ */
1830
2595
  cp_list?: CourierPartnerList[];
2596
+ /**
2597
+ * - Name for the courier partner rule.
2598
+ */
1831
2599
  name: string;
1832
2600
  conditions: CourierPartnerRuleConditions;
2601
+ /**
2602
+ * - Sort Strategy for the courier partners.
2603
+ */
1833
2604
  sort: string[];
2605
+ /**
2606
+ * - Denotes the type of the rule.
2607
+ */
2608
+ type?: string;
1834
2609
  };
1835
- /** @returns {FailureResponse} */
1836
- declare function FailureResponse(): FailureResponse;
1837
- type FailureResponse = {
2610
+ /** @returns {FailureResult} */
2611
+ declare function FailureResult(): FailureResult;
2612
+ type FailureResult = {
1838
2613
  success: boolean;
1839
- error: ErrorResponse[];
2614
+ error: ErrorResult[];
1840
2615
  };
1841
- /** @returns {CourierPartnerRulesListResponse} */
1842
- declare function CourierPartnerRulesListResponse(): CourierPartnerRulesListResponse;
1843
- type CourierPartnerRulesListResponse = {
1844
- items: CourierPartnerRuleResponse[];
2616
+ /** @returns {CourierPartnerRulesListResult} */
2617
+ declare function CourierPartnerRulesListResult(): CourierPartnerRulesListResult;
2618
+ type CourierPartnerRulesListResult = {
2619
+ items: CourierPartnerRuleResult[];
1845
2620
  page: Page;
1846
2621
  };
1847
- /** @returns {CompanyConfig} */
1848
- declare function CompanyConfig(): CompanyConfig;
1849
- type CompanyConfig = {
1850
- rule_ids: string[];
1851
- sort: string[];
1852
- logistics_as_actual?: boolean;
1853
- };
1854
- /** @returns {ZoneConfig} */
1855
- declare function ZoneConfig(): ZoneConfig;
1856
- type ZoneConfig = {
1857
- serviceability_type?: string;
1858
- };
1859
- /** @returns {ApplicationConfig} */
1860
- declare function ApplicationConfig(): ApplicationConfig;
1861
- type ApplicationConfig = {
1862
- rule_ids?: string[];
1863
- sort?: string[];
1864
- zones?: ZoneConfig;
2622
+ /** @returns {ShipmentsArticles} */
2623
+ declare function ShipmentsArticles(): ShipmentsArticles;
2624
+ type ShipmentsArticles = {
2625
+ /**
2626
+ * - Unique identifier of the item.
2627
+ */
2628
+ item_id?: number;
2629
+ /**
2630
+ * - Unique identifier of the category.
2631
+ */
2632
+ category_id?: number;
2633
+ /**
2634
+ * - Unique identifier of the brand.
2635
+ */
2636
+ brand_id?: number;
2637
+ /**
2638
+ * - Unique identifier of the department.
2639
+ */
2640
+ department_id?: number;
2641
+ /**
2642
+ * - Tags associated with the item.
2643
+ */
2644
+ tags?: string[];
1865
2645
  };
1866
- /** @returns {BulkRegionJobSerializer} */
1867
- declare function BulkRegionJobSerializer(): BulkRegionJobSerializer;
1868
- type BulkRegionJobSerializer = {
1869
- file_path?: string;
1870
- country: string;
1871
- action: string;
1872
- region: string;
2646
+ /** @returns {ShipmentDimension} */
2647
+ declare function ShipmentDimension(): ShipmentDimension;
2648
+ type ShipmentDimension = {
2649
+ /**
2650
+ * - Height of the shipment in centimeters.
2651
+ */
2652
+ height: number;
2653
+ /**
2654
+ * - Length of the shipment in centimeters.
2655
+ */
2656
+ length: number;
2657
+ /**
2658
+ * - Width of the shipment in centimeters.
2659
+ */
2660
+ width: number;
1873
2661
  };
1874
- /** @returns {BulkRegionResponseItemData} */
1875
- declare function BulkRegionResponseItemData(): BulkRegionResponseItemData;
1876
- type BulkRegionResponseItemData = {
1877
- file_path: string;
2662
+ /** @returns {Shipments} */
2663
+ declare function Shipments(): Shipments;
2664
+ type Shipments = {
2665
+ /**
2666
+ * - Unique identifier of the shipment.
2667
+ */
2668
+ id?: string;
2669
+ /**
2670
+ * - Unique identifier of the selling location.
2671
+ */
2672
+ location_id?: number;
2673
+ /**
2674
+ * - Tags associated with the selling location.
2675
+ */
2676
+ location_tags?: string[];
2677
+ /**
2678
+ * - Weight of the shipment.
2679
+ */
2680
+ shipment_weight?: number;
2681
+ /**
2682
+ * - Volumetric weight of the shipment.
2683
+ */
2684
+ shipment_volumetric_weight?: number;
2685
+ /**
2686
+ * - Total Cost of the shipment.
2687
+ */
2688
+ shipment_cost?: number;
2689
+ shipment_dimension?: ShipmentDimension;
2690
+ /**
2691
+ * - A List of courier schemes.
2692
+ */
2693
+ courier_partner_schemes?: string[];
2694
+ /**
2695
+ * - List of articles in the shipment.
2696
+ */
2697
+ articles?: ShipmentsArticles[];
2698
+ };
2699
+ /** @returns {ShipmentCourierPartnerDetails} */
2700
+ declare function ShipmentCourierPartnerDetails(): ShipmentCourierPartnerDetails;
2701
+ type ShipmentCourierPartnerDetails = {
2702
+ from_location: ShipmentsCourierPartnersServiceability;
2703
+ to_location: ShipmentsCourierPartnersServiceability;
2704
+ /**
2705
+ * - List of shipments.
2706
+ */
2707
+ shipments?: Shipments[];
2708
+ /**
2709
+ * - Journey type of the shipment forward or return.
2710
+ */
2711
+ journey?: string;
2712
+ /**
2713
+ * - Payment mode opted for the shipment.
2714
+ */
2715
+ payment_mode?: string;
2716
+ };
2717
+ /** @returns {CourierPartnerPromise} */
2718
+ declare function CourierPartnerPromise(): CourierPartnerPromise;
2719
+ type CourierPartnerPromise = {
2720
+ /**
2721
+ * - The earliest possible timestamp.
2722
+ */
2723
+ min: string;
2724
+ /**
2725
+ * - The latest possible timestamp.
2726
+ */
2727
+ max: string;
2728
+ };
2729
+ /** @returns {CourierPartners} */
2730
+ declare function CourierPartners(): CourierPartners;
2731
+ type CourierPartners = {
2732
+ /**
2733
+ * - Unique identifier of courier partner extension.
2734
+ */
2735
+ extension_id?: string;
2736
+ /**
2737
+ * - Unique identifier of courier partner scheme.
2738
+ */
2739
+ scheme_id?: string;
2740
+ /**
2741
+ * - Name of the courier partner.
2742
+ */
2743
+ name?: string;
2744
+ delivery_promise?: CourierPartnerPromise;
2745
+ };
2746
+ /** @returns {ShipmentCourierPartners} */
2747
+ declare function ShipmentCourierPartners(): ShipmentCourierPartners;
2748
+ type ShipmentCourierPartners = {
2749
+ /**
2750
+ * - Unique identifier of the shipment.
2751
+ */
2752
+ id?: string;
2753
+ /**
2754
+ * - Courier partners of the shipment.
2755
+ */
2756
+ courier_partners?: CourierPartners[];
2757
+ };
2758
+ /** @returns {ShipmentCourierPartnerResult} */
2759
+ declare function ShipmentCourierPartnerResult(): ShipmentCourierPartnerResult;
2760
+ type ShipmentCourierPartnerResult = {
2761
+ courier_partners?: CourierPartners[];
2762
+ shipments?: ShipmentCourierPartners[];
2763
+ };
2764
+ /** @returns {ShipmentsCourierPartnersServiceability} */
2765
+ declare function ShipmentsCourierPartnersServiceability(): ShipmentsCourierPartnersServiceability;
2766
+ type ShipmentsCourierPartnersServiceability = {
2767
+ /**
2768
+ * - Postal code or PIN code of the address area.
2769
+ */
2770
+ pincode?: string;
2771
+ /**
2772
+ * - Specifies the sector or district code of
2773
+ * the address if applicable.
2774
+ */
2775
+ sector_code?: string;
2776
+ /**
2777
+ * - Indicates the state or province code of the address.
2778
+ */
2779
+ state_code?: string;
2780
+ /**
2781
+ * - Denote the city or municipality code of the address.
2782
+ */
2783
+ city_code?: string;
2784
+ /**
2785
+ * - ISO2 code for the country of the address.
2786
+ */
2787
+ country_code: string;
2788
+ };
2789
+ /** @returns {CompanyConfig} */
2790
+ declare function CompanyConfig(): CompanyConfig;
2791
+ type CompanyConfig = {
2792
+ /**
2793
+ * - A list for courier partner rules.
2794
+ */
2795
+ rule_ids: string[];
2796
+ /**
2797
+ * - Sort strategy for the courier partners.
2798
+ */
2799
+ sort: string[];
2800
+ /**
2801
+ * - Depicts if the courier partner
2802
+ * rule configuration plan is subscribed by the seller for which mode.
2803
+ */
2804
+ logistics_as_actual?: string;
2805
+ /**
2806
+ * - Unique identifier of the company.
2807
+ */
2808
+ company_id: number;
2809
+ /**
2810
+ * - Unique identifier of the sales channel.
2811
+ */
2812
+ application_id?: string;
2813
+ };
2814
+ /** @returns {ZoneConfig} */
2815
+ declare function ZoneConfig(): ZoneConfig;
2816
+ type ZoneConfig = {
2817
+ /**
2818
+ * - Serviceability type of the delivery zone.
2819
+ */
2820
+ serviceability_type?: string;
2821
+ /**
2822
+ * - Count of active delivery zones associated
2823
+ * with the sales channel.
2824
+ */
2825
+ active_count?: number;
2826
+ /**
2827
+ * - Count of total delivery zones associated
2828
+ * with the sales channel.
2829
+ */
2830
+ total_count?: number;
2831
+ };
2832
+ /** @returns {ApplicationConfig} */
2833
+ declare function ApplicationConfig(): ApplicationConfig;
2834
+ type ApplicationConfig = {
2835
+ /**
2836
+ * - A list of courier partner rules.
2837
+ */
2838
+ rule_ids?: string[];
2839
+ /**
2840
+ * - Strategy adopted to sort the courier partners.
2841
+ */
2842
+ sort?: string[];
2843
+ zones?: ZoneConfig;
2844
+ };
2845
+ /** @returns {BulkRegionJobDetails} */
2846
+ declare function BulkRegionJobDetails(): BulkRegionJobDetails;
2847
+ type BulkRegionJobDetails = {
2848
+ /**
2849
+ * - CDN path of the uploaded csv file for bulk import.
2850
+ */
2851
+ file_path?: string;
2852
+ /**
2853
+ * - Country for which the tat or serviceability is
2854
+ * to be imported or exported.
2855
+ */
2856
+ country: string;
2857
+ /**
2858
+ * - Denotes the import or export action to be performed.
2859
+ */
2860
+ action: string;
2861
+ /**
2862
+ * - Region of the country for which import or export
2863
+ * is triggered.
2864
+ */
2865
+ region: string;
2866
+ };
2867
+ /** @returns {BulkRegionResultItemData} */
2868
+ declare function BulkRegionResultItemData(): BulkRegionResultItemData;
2869
+ type BulkRegionResultItemData = {
2870
+ /**
2871
+ * - CDN path of the file which was used for bulk import.
2872
+ */
2873
+ file_path?: string;
2874
+ /**
2875
+ * - Count of the failed records.
2876
+ */
1878
2877
  failed?: number;
1879
2878
  failed_records?: any[];
2879
+ /**
2880
+ * - Denotes the import or export action performed.
2881
+ */
1880
2882
  action: string;
2883
+ /**
2884
+ * - Unique id to identify the import or export query.
2885
+ */
1881
2886
  batch_id: string;
2887
+ /**
2888
+ * - Country for which the import or export action is
2889
+ * performed.
2890
+ */
1882
2891
  country: string;
2892
+ /**
2893
+ * - Denoted if the import or export was successful
2894
+ * or failure.
2895
+ */
1883
2896
  success?: number;
2897
+ /**
2898
+ * - Region of the country for which import or export
2899
+ * is triggered.
2900
+ */
1884
2901
  region: string;
2902
+ /**
2903
+ * - Current status of the import or export action performed.
2904
+ */
1885
2905
  status: string;
2906
+ /**
2907
+ * - Count of total records.
2908
+ */
1886
2909
  total?: number;
2910
+ /**
2911
+ * - Path of the error file.
2912
+ */
1887
2913
  error_file_path?: string;
1888
2914
  };
1889
- /** @returns {BulkRegionResponse} */
1890
- declare function BulkRegionResponse(): BulkRegionResponse;
1891
- type BulkRegionResponse = {
1892
- items: BulkRegionResponseItemData[];
2915
+ /** @returns {BulkRegionResult} */
2916
+ declare function BulkRegionResult(): BulkRegionResult;
2917
+ type BulkRegionResult = {
2918
+ items: BulkRegionResultItemData[];
1893
2919
  page: Page;
1894
2920
  };
1895
- /** @returns {SelfShipResponse} */
1896
- declare function SelfShipResponse(): SelfShipResponse;
1897
- type SelfShipResponse = {
2921
+ /** @returns {SelfShipResult} */
2922
+ declare function SelfShipResult(): SelfShipResult;
2923
+ type SelfShipResult = {
1898
2924
  is_active: boolean;
1899
2925
  tat: number;
1900
2926
  };
1901
2927
  /** @returns {ApplicationSelfShipConfig} */
1902
2928
  declare function ApplicationSelfShipConfig(): ApplicationSelfShipConfig;
1903
2929
  type ApplicationSelfShipConfig = {
1904
- self_ship?: any;
2930
+ self_ship?: SelfShipResult;
1905
2931
  };
1906
- /** @returns {ApplicationSelfShipConfigResponse} */
1907
- declare function ApplicationSelfShipConfigResponse(): ApplicationSelfShipConfigResponse;
1908
- type ApplicationSelfShipConfigResponse = {
1909
- error?: ServiceabilityErrorResponse;
2932
+ /** @returns {ApplicationSelfShipConfigResult} */
2933
+ declare function ApplicationSelfShipConfigResult(): ApplicationSelfShipConfigResult;
2934
+ type ApplicationSelfShipConfigResult = {
2935
+ error?: ServiceabilityErrorResult;
1910
2936
  data?: ApplicationSelfShipConfig;
1911
2937
  success: boolean;
1912
2938
  };
1913
2939
  /** @returns {StoreRuleConfigData} */
1914
2940
  declare function StoreRuleConfigData(): StoreRuleConfigData;
1915
2941
  type StoreRuleConfigData = {
2942
+ /**
2943
+ * - List of rule ids which are active in the application.
2944
+ */
1916
2945
  rule_ids?: string[];
2946
+ /**
2947
+ * - Priority of the store type to be
2948
+ * used in the basic prioritization sorting of stores.
2949
+ */
1917
2950
  type_based_priority?: string[];
2951
+ /**
2952
+ * - Priority of the store tags to be
2953
+ * used in the basic prioritization sorting of stores.
2954
+ */
1918
2955
  tag_based_priority?: string[];
2956
+ /**
2957
+ * - Priority of explicit
2958
+ * stores to be used for sorting of stores.
2959
+ */
1919
2960
  store_priority?: StorePrioritySchema[];
2961
+ /**
2962
+ * - Criteria on which the selected stores should be sorted.
2963
+ */
1920
2964
  sort?: string[];
1921
2965
  };
1922
2966
  /** @returns {CustomerRadiusSchema} */
@@ -1946,66 +2990,183 @@ type StoreRuleConditionSchema = {
1946
2990
  /** @returns {StoreRuleDataSchema} */
1947
2991
  declare function StoreRuleDataSchema(): StoreRuleDataSchema;
1948
2992
  type StoreRuleDataSchema = {
2993
+ /**
2994
+ * - Id of the rule.
2995
+ */
1949
2996
  id?: string;
2997
+ /**
2998
+ * - Name of the rule.
2999
+ */
1950
3000
  name?: string;
3001
+ /**
3002
+ * - Company id for which the rule is created.
3003
+ */
1951
3004
  company_id?: number;
3005
+ /**
3006
+ * - Application id for which the rule is created.
3007
+ */
1952
3008
  application_id?: string;
3009
+ /**
3010
+ * - Priority of the store type to be
3011
+ * used in the basic prioritization sorting of stores.
3012
+ */
1953
3013
  type_based_priority?: string[];
3014
+ /**
3015
+ * - Priority of the store tags to be
3016
+ * used in the basic prioritization sorting of stores.
3017
+ */
1954
3018
  tag_based_priority?: string[];
3019
+ /**
3020
+ * - Priority of explicit
3021
+ * stores to be used for sorting of stores.
3022
+ */
1955
3023
  store_priority?: StorePrioritySchema[];
3024
+ /**
3025
+ * - Criteria on which the selected stores should be sorted.
3026
+ */
1956
3027
  sort?: string[];
1957
3028
  conditions?: StoreRuleConditionSchema;
3029
+ /**
3030
+ * - Denotes whether the rule is active or inactive.
3031
+ */
1958
3032
  is_active?: boolean;
1959
3033
  };
1960
3034
  /** @returns {StorePrioritySchema} */
1961
3035
  declare function StorePrioritySchema(): StorePrioritySchema;
1962
3036
  type StorePrioritySchema = {
1963
- id?: string;
3037
+ /**
3038
+ * - Id of the store.
3039
+ */
3040
+ id?: number;
3041
+ /**
3042
+ * - Name of the store.
3043
+ */
1964
3044
  name?: string;
1965
3045
  };
1966
- /** @returns {GetStoreRulesApiResponse} */
1967
- declare function GetStoreRulesApiResponse(): GetStoreRulesApiResponse;
1968
- type GetStoreRulesApiResponse = {
3046
+ /** @returns {GetStoreRulesApiResult} */
3047
+ declare function GetStoreRulesApiResult(): GetStoreRulesApiResult;
3048
+ type GetStoreRulesApiResult = {
1969
3049
  items?: StoreRuleDataSchema[];
1970
3050
  page?: Page;
1971
3051
  };
1972
- /** @returns {CreateStoreRuleRequestSchema} */
1973
- declare function CreateStoreRuleRequestSchema(): CreateStoreRuleRequestSchema;
1974
- type CreateStoreRuleRequestSchema = {
3052
+ /** @returns {CreateStoreRuleDetailsSchema} */
3053
+ declare function CreateStoreRuleDetailsSchema(): CreateStoreRuleDetailsSchema;
3054
+ type CreateStoreRuleDetailsSchema = {
3055
+ /**
3056
+ * - Name of the rule.
3057
+ */
1975
3058
  name?: string;
3059
+ /**
3060
+ * - Denotes if the rule is active or not.
3061
+ */
1976
3062
  is_active?: boolean;
1977
3063
  conditions?: StoreRuleConditionSchema;
3064
+ /**
3065
+ * - Priority of the store type to be
3066
+ * used in the basic prioritization sorting of stores.
3067
+ */
1978
3068
  type_based_priority?: string[];
3069
+ /**
3070
+ * - Priority of the store tags to be
3071
+ * used in the basic prioritization sorting of stores.
3072
+ */
1979
3073
  tag_based_priority?: string[];
3074
+ /**
3075
+ * - Priority of explicit
3076
+ * stores to be used for sorting of stores.
3077
+ */
1980
3078
  store_priority?: StorePrioritySchema[];
3079
+ /**
3080
+ * - Criteria on which the selected stores should be sorted.
3081
+ */
1981
3082
  sort?: string[];
1982
3083
  };
1983
- /** @returns {StoreRuleResponseSchema} */
1984
- declare function StoreRuleResponseSchema(): StoreRuleResponseSchema;
1985
- type StoreRuleResponseSchema = {
3084
+ /** @returns {StoreRuleResultSchema} */
3085
+ declare function StoreRuleResultSchema(): StoreRuleResultSchema;
3086
+ type StoreRuleResultSchema = {
3087
+ /**
3088
+ * - Id of the rule created.
3089
+ */
1986
3090
  id?: string;
3091
+ /**
3092
+ * - Name of the rule created.
3093
+ */
1987
3094
  name?: string;
3095
+ /**
3096
+ * - Type of the rule created.
3097
+ */
1988
3098
  type?: string;
3099
+ /**
3100
+ * - Priority of the store type to be
3101
+ * used in the rule for sorting of stores.
3102
+ */
1989
3103
  type_based_priority?: string[];
3104
+ /**
3105
+ * - Priority of the store tags to be
3106
+ * used in the rule for sorting of stores.
3107
+ */
1990
3108
  tag_based_priority?: string[];
3109
+ /**
3110
+ * - Priority of explicit
3111
+ * stores to be used for sorting of stores.
3112
+ */
1991
3113
  store_priority?: StorePrioritySchema[];
3114
+ /**
3115
+ * - Criteria on which the selected stores should be sorted.
3116
+ */
1992
3117
  sort?: string[];
1993
3118
  conditions?: StoreRuleConditionSchema;
3119
+ /**
3120
+ * - Denotes if the rule is active or inactive.
3121
+ */
1994
3122
  is_active?: boolean;
1995
3123
  };
1996
- /** @returns {StoreRuleUpdateResponseSchema} */
1997
- declare function StoreRuleUpdateResponseSchema(): StoreRuleUpdateResponseSchema;
1998
- type StoreRuleUpdateResponseSchema = {
3124
+ /** @returns {StoreRuleUpdateResultSchema} */
3125
+ declare function StoreRuleUpdateResultSchema(): StoreRuleUpdateResultSchema;
3126
+ type StoreRuleUpdateResultSchema = {
3127
+ /**
3128
+ * - Id of the rule created.
3129
+ */
1999
3130
  id?: string;
3131
+ /**
3132
+ * - Name of the rule created.
3133
+ */
2000
3134
  name?: string;
3135
+ /**
3136
+ * - Type of the rule created.
3137
+ */
2001
3138
  type?: string;
3139
+ /**
3140
+ * - Priority of the store type to be
3141
+ * used in the rule for sorting of stores.
3142
+ */
2002
3143
  type_based_priority?: string[];
3144
+ /**
3145
+ * - Priority of the store tags to be
3146
+ * used in the rule for sorting of stores.
3147
+ */
2003
3148
  tag_based_priority?: string[];
3149
+ /**
3150
+ * - Priority of explicit
3151
+ * stores to be used for sorting of stores.
3152
+ */
2004
3153
  store_priority?: StorePrioritySchema[];
3154
+ /**
3155
+ * - Criteria on which the selected stores should be sorted.
3156
+ */
2005
3157
  sort?: string[];
2006
3158
  conditions?: StoreRuleConditionSchema;
3159
+ /**
3160
+ * - Denotes if the rule is active or inactive.
3161
+ */
2007
3162
  is_active?: boolean;
3163
+ /**
3164
+ * - Company id for which the rule is created.
3165
+ */
2008
3166
  company_id?: number;
3167
+ /**
3168
+ * - Application id for which the rule is created.
3169
+ */
2009
3170
  application_id?: string;
2010
3171
  };
2011
3172
  /** @returns {ServiceabilityModel} */
@@ -2013,9 +3174,10 @@ declare function ServiceabilityModel(): ServiceabilityModel;
2013
3174
  type ServiceabilityModel = {
2014
3175
  lm_cod_limit: number;
2015
3176
  is_qc: boolean;
2016
- pickup_cutoff: string;
2017
- route_code: string;
3177
+ pickup_cutoff?: string;
3178
+ route_code?: string;
2018
3179
  is_first_mile: boolean;
3180
+ is_reverse_pickup?: boolean;
2019
3181
  is_return: boolean;
2020
3182
  is_installation: boolean;
2021
3183
  is_last_mile: boolean;
@@ -2023,123 +3185,419 @@ type ServiceabilityModel = {
2023
3185
  /** @returns {CourierPartnerSchemeFeatures} */
2024
3186
  declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
2025
3187
  type CourierPartnerSchemeFeatures = {
3188
+ /**
3189
+ * - Indicates if the courier partner offers
3190
+ * doorstep quality check services.
3191
+ */
2026
3192
  doorstep_qc?: boolean;
3193
+ /**
3194
+ * - Specifies whether the courier partner supports QR
3195
+ * code-based operations.
3196
+ */
2027
3197
  qr?: boolean;
3198
+ /**
3199
+ * - Denotes if the courier partner supports
3200
+ * multi-part shipment services.
3201
+ */
2028
3202
  mps?: boolean;
3203
+ /**
3204
+ * - Indicates if the Non-Delivery Report (NDR)
3205
+ * feature is supported by the courier partner.
3206
+ */
2029
3207
  ndr?: boolean;
3208
+ /**
3209
+ * - Number of attempts allowed for resolving
3210
+ * Non-Delivery Reports (NDR).
3211
+ */
2030
3212
  ndr_attempts?: number;
3213
+ /**
3214
+ * - Specifies if the courier partner
3215
+ * handles the transportation of dangerous goods.
3216
+ */
2031
3217
  dangerous_goods?: boolean;
3218
+ /**
3219
+ * - Indicates whether the courier partner
3220
+ * manages the shipment of fragile goods.
3221
+ */
2032
3222
  fragile_goods?: boolean;
3223
+ /**
3224
+ * - Indicates if the courier partner
3225
+ * handles restricted goods, as per regulatory guidelines.
3226
+ */
2033
3227
  restricted_goods?: boolean;
3228
+ /**
3229
+ * - Denotes if the courier partner
3230
+ * provides cold storage facilities for goods.
3231
+ */
2034
3232
  cold_storage_goods?: boolean;
3233
+ /**
3234
+ * - Indicates if the courier partner
3235
+ * supports doorstep exchange services.
3236
+ */
2035
3237
  doorstep_exchange?: boolean;
3238
+ /**
3239
+ * - Specifies if the courier partner
3240
+ * offers doorstep return services.
3241
+ */
2036
3242
  doorstep_return?: boolean;
3243
+ /**
3244
+ * - Indicates if the courier partner
3245
+ * provides product installation services upon delivery.
3246
+ */
2037
3247
  product_installation?: boolean;
3248
+ /**
3249
+ * - Specifies whether the courier
3250
+ * partner supports open-box delivery, allowing customers to inspect goods
3251
+ * before accepting.
3252
+ */
2038
3253
  openbox_delivery?: boolean;
3254
+ /**
3255
+ * - Describes the type of status updates
3256
+ * provided by the courier partner (e.g., real-time, periodic).
3257
+ */
2039
3258
  status_updates?: string;
3259
+ /**
3260
+ * - Indicates if the courier
3261
+ * partner supports multiple pickups to a single drop location.
3262
+ */
2040
3263
  multi_pick_single_drop?: boolean;
3264
+ /**
3265
+ * - Indicates whether the courier
3266
+ * partner supports single pickup to multiple drop locations.
3267
+ */
2041
3268
  single_pick_multi_drop?: boolean;
3269
+ /**
3270
+ * - Denotes if the courier partner
3271
+ * offers services for multiple pickups to multiple drop locations.
3272
+ */
2042
3273
  multi_pick_multi_drop?: boolean;
3274
+ /**
3275
+ * - Specifies if the courier partner requires or
3276
+ * supports the generation of e-waybills for shipments.
3277
+ */
2043
3278
  ewaybill?: boolean;
3279
+ /**
3280
+ * - Defines the maximum quantity
3281
+ * of items allowed in a quality check shipment.
3282
+ */
3283
+ qc_shipment_item_quantity?: number;
3284
+ /**
3285
+ * - Defines the maximum
3286
+ * quantity of items allowed in a non-quality check shipment.
3287
+ */
3288
+ non_qc_shipment_item_quantity?: number;
2044
3289
  };
2045
3290
  /** @returns {CourierPartnerSchemeModel} */
2046
3291
  declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
2047
3292
  type CourierPartnerSchemeModel = {
3293
+ /**
3294
+ * - Name of the scheme.
3295
+ */
3296
+ name?: string;
3297
+ /**
3298
+ * - Unique identifier of courier partner extension.
3299
+ */
2048
3300
  extension_id: string;
3301
+ /**
3302
+ * - Unique identifier of courier partner scheme.
3303
+ */
2049
3304
  scheme_id: string;
3305
+ volumetric_weight?: ArithmeticOperations;
2050
3306
  weight: ArithmeticOperations;
3307
+ /**
3308
+ * - Mode of transport associated with the
3309
+ * courier partner scheme.
3310
+ */
2051
3311
  transport_type: string;
3312
+ /**
3313
+ * - Serviceable region associated with the courier
3314
+ * partner scheme.
3315
+ */
2052
3316
  region: string;
3317
+ /**
3318
+ * - Type of delivery associated with the
3319
+ * courier partner scheme.
3320
+ */
2053
3321
  delivery_type: string;
3322
+ /**
3323
+ * - Mode of payment associated with the
3324
+ * courier partner scheme.
3325
+ */
2054
3326
  payment_mode: string[];
3327
+ /**
3328
+ * - Indicates if the courier partner scheme is
3329
+ * currently active or inactive.
3330
+ */
2055
3331
  stage: string;
2056
3332
  feature: CourierPartnerSchemeFeatures;
2057
3333
  };
2058
- /** @returns {CourierAccountResponse} */
2059
- declare function CourierAccountResponse(): CourierAccountResponse;
2060
- type CourierAccountResponse = {
3334
+ /** @returns {CourierAccountResult} */
3335
+ declare function CourierAccountResult(): CourierAccountResult;
3336
+ type CourierAccountResult = {
3337
+ /**
3338
+ * - Company id associated with the account.
3339
+ */
3340
+ company_id: number;
3341
+ /**
3342
+ * - Unique identifier of courier partner extension.
3343
+ */
3344
+ extension_id?: string;
3345
+ /**
3346
+ * - Unique identifier of courier partner scheme
3347
+ * and company id combination.
3348
+ */
2061
3349
  account_id: string;
3350
+ /**
3351
+ * - Unique identifier of courier partner scheme.
3352
+ */
2062
3353
  scheme_id: string;
3354
+ /**
3355
+ * - Denotes if the account is of self delivery type.
3356
+ */
2063
3357
  is_self_ship: boolean;
3358
+ /**
3359
+ * - Denotes whether the account is in enabled or disabled stage.
3360
+ */
2064
3361
  stage: string;
3362
+ /**
3363
+ * - Denotes whether it is the seller's own
3364
+ * account or not.
3365
+ */
2065
3366
  is_own_account: boolean;
2066
- scheme_rules: CourierPartnerSchemeModel;
3367
+ scheme_rules?: CourierPartnerSchemeModel;
2067
3368
  };
2068
- /** @returns {CompanyCourierPartnerAccountListResponse} */
2069
- declare function CompanyCourierPartnerAccountListResponse(): CompanyCourierPartnerAccountListResponse;
2070
- type CompanyCourierPartnerAccountListResponse = {
2071
- items: CourierAccountResponse[];
3369
+ /** @returns {CompanyCourierPartnerAccountListResult} */
3370
+ declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
3371
+ type CompanyCourierPartnerAccountListResult = {
3372
+ items: CourierAccountResult[];
2072
3373
  page: Page;
2073
3374
  };
2074
3375
  /** @returns {PackageMaterial} */
2075
3376
  declare function PackageMaterial(): PackageMaterial;
2076
3377
  type PackageMaterial = {
3378
+ /**
3379
+ * - Name of the packaging material.
3380
+ */
2077
3381
  name: string;
3382
+ /**
3383
+ * - Width of the packaging material dimentions in centimeter.
3384
+ */
2078
3385
  width: number;
3386
+ /**
3387
+ * - Height of the packaging material dimentions in centimeter.
3388
+ */
2079
3389
  height: number;
3390
+ /**
3391
+ * - Length of the packaging material dimentions in centimeter.
3392
+ */
2080
3393
  length: number;
3394
+ /**
3395
+ * - Product group rules associated
3396
+ * with the packaging.
3397
+ */
2081
3398
  rules?: PackageMaterialRule[];
3399
+ /**
3400
+ * - Store ids where the packaging is avaiable.
3401
+ */
2082
3402
  store_ids: number[];
3403
+ /**
3404
+ * - Package's weight in gram.
3405
+ */
2083
3406
  weight: number;
3407
+ /**
3408
+ * - Error Rate associated with the packaging dimensions.
3409
+ */
2084
3410
  error_rate: number;
3411
+ /**
3412
+ * - Type of package material.
3413
+ */
2085
3414
  package_type: string;
3415
+ /**
3416
+ * - Physical size of the packaging.
3417
+ */
2086
3418
  size: string;
3419
+ /**
3420
+ * - Image urls associated with the packaging material.
3421
+ */
2087
3422
  media?: string[];
3423
+ /**
3424
+ * - Sales channel where packaging is applicable.
3425
+ */
2088
3426
  channels: Channel[];
3427
+ /**
3428
+ * - Denotes if the track of the inventory
3429
+ * should be kept.
3430
+ */
2089
3431
  track_inventory?: boolean;
3432
+ /**
3433
+ * - Current status of the packaging material, if it
3434
+ * is active or inactive.
3435
+ */
2090
3436
  status: string;
3437
+ /**
3438
+ * - Maximum weight holding capacity.
3439
+ */
2091
3440
  max_weight?: number;
3441
+ /**
3442
+ * - Volumetric weight that a packaging
3443
+ * material can carry.
3444
+ */
2092
3445
  package_vol_weight?: number;
3446
+ /**
3447
+ * - Denotes whether the volumetric weight
3448
+ * should be auto calculated or not.
3449
+ */
2093
3450
  auto_calculate?: boolean;
2094
3451
  };
2095
- /** @returns {PackageMaterialResponse} */
2096
- declare function PackageMaterialResponse(): PackageMaterialResponse;
2097
- type PackageMaterialResponse = {
3452
+ /** @returns {PackageMaterialResult} */
3453
+ declare function PackageMaterialResult(): PackageMaterialResult;
3454
+ type PackageMaterialResult = {
3455
+ /**
3456
+ * - Name of the packaging material.
3457
+ */
2098
3458
  name: string;
3459
+ /**
3460
+ * - Id of the packaging material.
3461
+ */
2099
3462
  id?: string;
3463
+ /**
3464
+ * - Unique identifier of an item associated with
3465
+ * the packaging material.
3466
+ */
2100
3467
  item_id?: number;
3468
+ /**
3469
+ * - Company id associated with the packaging material.
3470
+ */
3471
+ company_id?: number;
3472
+ /**
3473
+ * - Width of the packaging material dimentions in centimeter.
3474
+ */
2101
3475
  width: number;
3476
+ /**
3477
+ * - Height of the packaging material dimentions in centimeter.
3478
+ */
2102
3479
  height: number;
3480
+ /**
3481
+ * - Length of the packaging material dimentions in centimeter.
3482
+ */
2103
3483
  length: number;
3484
+ /**
3485
+ * - Product group rules associated
3486
+ * with the packaging.
3487
+ */
2104
3488
  rules?: PackageMaterialRule[];
3489
+ /**
3490
+ * - Store ids where the packaging is avaiable.
3491
+ */
2105
3492
  store_ids: number[];
3493
+ /**
3494
+ * - Package's weight in gram.
3495
+ */
2106
3496
  weight: number;
3497
+ /**
3498
+ * - Error Rate associated with the packaging dimensions.
3499
+ */
2107
3500
  error_rate: number;
3501
+ /**
3502
+ * - Type of package material.
3503
+ */
2108
3504
  package_type: string;
3505
+ /**
3506
+ * - Physical size of the packaging.
3507
+ */
2109
3508
  size: string;
3509
+ /**
3510
+ * - Image urls associated with the packaging material.
3511
+ */
2110
3512
  media?: string[];
3513
+ /**
3514
+ * - Sales channel where packaging is applicable.
3515
+ */
2111
3516
  channels: Channel[];
3517
+ /**
3518
+ * - Denotes if the track of the inventory
3519
+ * should be kept.
3520
+ */
2112
3521
  track_inventory?: boolean;
3522
+ /**
3523
+ * - Current status of the packaging material, if it
3524
+ * is active or inactive.
3525
+ */
2113
3526
  status: string;
3527
+ /**
3528
+ * - Maximum weight holding capacity.
3529
+ */
2114
3530
  max_weight?: number;
3531
+ /**
3532
+ * - Volumetric weight that a packaging
3533
+ * material can carry.
3534
+ */
2115
3535
  package_vol_weight?: number;
3536
+ /**
3537
+ * - Denotes whether the volumetric weight
3538
+ * should be auto calculated or not.
3539
+ */
2116
3540
  auto_calculate?: boolean;
2117
3541
  };
2118
3542
  /** @returns {PackageMaterialRule} */
2119
3543
  declare function PackageMaterialRule(): PackageMaterialRule;
2120
3544
  type PackageMaterialRule = {
3545
+ /**
3546
+ * - Unique identifier of the package rule.
3547
+ */
2121
3548
  rule_id?: string;
2122
3549
  quantity?: PackageMaterialRuleQuantity;
3550
+ /**
3551
+ * - Volumetric weight in gram.
3552
+ */
2123
3553
  weight?: number;
2124
3554
  };
2125
3555
  /** @returns {PackageRule} */
2126
3556
  declare function PackageRule(): PackageRule;
2127
3557
  type PackageRule = {
3558
+ /**
3559
+ * - Name of the package rule.
3560
+ */
2128
3561
  name: string;
3562
+ /**
3563
+ * - Unique identifier of the company.
3564
+ */
2129
3565
  company_id: number;
3566
+ /**
3567
+ * - Type of the rule.
3568
+ */
2130
3569
  type: string;
3570
+ /**
3571
+ * - Denotes if the rule is active or inactive.
3572
+ */
2131
3573
  is_active?: boolean;
2132
3574
  product_tag?: PackageRuleProductTag;
2133
3575
  product_id?: PackageRuleProduct;
2134
3576
  category_id?: PackageRuleCategory;
2135
3577
  };
2136
- /** @returns {PackageRuleResponse} */
2137
- declare function PackageRuleResponse(): PackageRuleResponse;
2138
- type PackageRuleResponse = {
3578
+ /** @returns {PackageRuleResult} */
3579
+ declare function PackageRuleResult(): PackageRuleResult;
3580
+ type PackageRuleResult = {
3581
+ /**
3582
+ * - Unique id of a package rule.
3583
+ */
2139
3584
  id?: string;
3585
+ /**
3586
+ * - Name of a package rule.
3587
+ */
2140
3588
  name: string;
3589
+ /**
3590
+ * - Unique identifier of a company associated
3591
+ * with the package rule.
3592
+ */
2141
3593
  company_id: number;
3594
+ /**
3595
+ * - Type of the rule created.
3596
+ */
2142
3597
  type: string;
3598
+ /**
3599
+ * - Denotes if the rule is active or inactive.
3600
+ */
2143
3601
  is_active?: boolean;
2144
3602
  product_tag?: PackageRuleProductTag;
2145
3603
  product_id?: PackageRuleProduct;
@@ -2148,19 +3606,25 @@ type PackageRuleResponse = {
2148
3606
  /** @returns {Channel} */
2149
3607
  declare function Channel(): Channel;
2150
3608
  type Channel = {
3609
+ /**
3610
+ * - Type of the channel.
3611
+ */
2151
3612
  type?: string;
3613
+ /**
3614
+ * - Unique identifier of the channel.
3615
+ */
2152
3616
  id?: string;
2153
3617
  };
2154
3618
  /** @returns {PackageMaterialRuleList} */
2155
3619
  declare function PackageMaterialRuleList(): PackageMaterialRuleList;
2156
3620
  type PackageMaterialRuleList = {
2157
- items?: PackageRuleResponse;
3621
+ items?: PackageRuleResult;
2158
3622
  page?: Page;
2159
3623
  };
2160
3624
  /** @returns {PackageMaterialList} */
2161
3625
  declare function PackageMaterialList(): PackageMaterialList;
2162
3626
  type PackageMaterialList = {
2163
- items?: PackageMaterialResponse;
3627
+ items?: PackageMaterialResult;
2164
3628
  page?: Page;
2165
3629
  };
2166
3630
  /** @returns {PackageRuleProduct} */
@@ -2181,18 +3645,34 @@ type PackageRuleCategory = {
2181
3645
  /** @returns {PackageMaterialRuleQuantity} */
2182
3646
  declare function PackageMaterialRuleQuantity(): PackageMaterialRuleQuantity;
2183
3647
  type PackageMaterialRuleQuantity = {
3648
+ /**
3649
+ * - Minimum product's quantity that a packaging can contain.
3650
+ */
2184
3651
  min?: number;
3652
+ /**
3653
+ * - Maximum product's quantity that a packaging can contain.
3654
+ */
2185
3655
  max?: number;
2186
3656
  };
2187
- /** @returns {RulePriorityRequest} */
2188
- declare function RulePriorityRequest(): RulePriorityRequest;
2189
- type RulePriorityRequest = {
3657
+ /** @returns {RulePriorityDetails} */
3658
+ declare function RulePriorityDetails(): RulePriorityDetails;
3659
+ type RulePriorityDetails = {
3660
+ /**
3661
+ * - Rule id whose priority needs to be changed.
3662
+ */
2190
3663
  rule_id: string;
3664
+ /**
3665
+ * - New priority of the rule.
3666
+ */
2191
3667
  priority: number;
2192
3668
  };
2193
- /** @returns {RulePriorityResponse} */
2194
- declare function RulePriorityResponse(): RulePriorityResponse;
2195
- type RulePriorityResponse = {
3669
+ /** @returns {RulePriorityResult} */
3670
+ declare function RulePriorityResult(): RulePriorityResult;
3671
+ type RulePriorityResult = {
3672
+ /**
3673
+ * - Denotes if the priority of the rule is
3674
+ * changes successfully or not.
3675
+ */
2196
3676
  success?: boolean;
2197
3677
  };
2198
3678
  /** @returns {ArticleAssignment} */
@@ -2251,7 +3731,7 @@ declare function OptimalLocationsArticles(): OptimalLocationsArticles;
2251
3731
  type OptimalLocationsArticles = {
2252
3732
  item_id: number;
2253
3733
  size: string;
2254
- quantity: string;
3734
+ quantity: number;
2255
3735
  group_id?: string;
2256
3736
  is_primary_item?: boolean;
2257
3737
  meta?: any;
@@ -2260,18 +3740,18 @@ type OptimalLocationsArticles = {
2260
3740
  assign_locations: number[];
2261
3741
  seller_id?: number;
2262
3742
  };
2263
- /** @returns {OptimlLocationsRequestSchema} */
2264
- declare function OptimlLocationsRequestSchema(): OptimlLocationsRequestSchema;
2265
- type OptimlLocationsRequestSchema = {
3743
+ /** @returns {OptimlLocationsDetailsSchema} */
3744
+ declare function OptimlLocationsDetailsSchema(): OptimlLocationsDetailsSchema;
3745
+ type OptimlLocationsDetailsSchema = {
2266
3746
  channel_id: string;
2267
3747
  channel_type: string;
2268
3748
  channel_identifier?: string;
2269
3749
  to_serviceability: LocationDetailsServiceability;
2270
- article?: OptimalLocationsArticles;
3750
+ articles?: OptimalLocationsArticles[];
2271
3751
  };
2272
- /** @returns {OptimalLocationArticlesResponse} */
2273
- declare function OptimalLocationArticlesResponse(): OptimalLocationArticlesResponse;
2274
- type OptimalLocationArticlesResponse = {
3752
+ /** @returns {OptimalLocationArticlesResult} */
3753
+ declare function OptimalLocationArticlesResult(): OptimalLocationArticlesResult;
3754
+ type OptimalLocationArticlesResult = {
2275
3755
  item_id: number;
2276
3756
  size: string;
2277
3757
  quantity: number;
@@ -2287,15 +3767,343 @@ type OptimalLocationArticlesResponse = {
2287
3767
  _id: string;
2288
3768
  uid: string;
2289
3769
  };
2290
- /** @returns {OptimalLocationAssignedStoresResponse} */
2291
- declare function OptimalLocationAssignedStoresResponse(): OptimalLocationAssignedStoresResponse;
2292
- type OptimalLocationAssignedStoresResponse = {
3770
+ /** @returns {OptimalLocationAssignedStoresResult} */
3771
+ declare function OptimalLocationAssignedStoresResult(): OptimalLocationAssignedStoresResult;
3772
+ type OptimalLocationAssignedStoresResult = {
2293
3773
  store_id: number;
2294
- articles: OptimalLocationArticlesResponse[];
3774
+ articles: OptimalLocationArticlesResult[];
3775
+ };
3776
+ /** @returns {OptimalLocationsResult} */
3777
+ declare function OptimalLocationsResult(): OptimalLocationsResult;
3778
+ type OptimalLocationsResult = {
3779
+ assigned_stores: OptimalLocationAssignedStoresResult[];
3780
+ faulty_articles?: ErrorResult[];
3781
+ };
3782
+ /** @returns {ValidationError} */
3783
+ declare function ValidationError(): ValidationError;
3784
+ type ValidationError = {
3785
+ /**
3786
+ * - A brief description of the error encountered.
3787
+ */
3788
+ message: string;
3789
+ /**
3790
+ * - The field in the request that caused the error.
3791
+ */
3792
+ field: string;
3793
+ };
3794
+ /** @returns {StandardError} */
3795
+ declare function StandardError(): StandardError;
3796
+ type StandardError = {
3797
+ /**
3798
+ * - A brief description of the error.
3799
+ */
3800
+ message: string;
3801
+ };
3802
+ /** @returns {CourierPartnerSchemeV2Features} */
3803
+ declare function CourierPartnerSchemeV2Features(): CourierPartnerSchemeV2Features;
3804
+ type CourierPartnerSchemeV2Features = {
3805
+ /**
3806
+ * - Indicates if the courier partner offers
3807
+ * doorstep quality check services.
3808
+ */
3809
+ doorstep_qc?: boolean;
3810
+ /**
3811
+ * - Specifies whether the courier partner supports QR
3812
+ * code-based operations.
3813
+ */
3814
+ qr?: boolean;
3815
+ /**
3816
+ * - Denotes if the courier partner supports
3817
+ * multi-part shipment services.
3818
+ */
3819
+ mps?: boolean;
3820
+ /**
3821
+ * - Indicates if the Non-Delivery Report (NDR)
3822
+ * feature is supported by the courier partner.
3823
+ */
3824
+ ndr?: boolean;
3825
+ /**
3826
+ * - Specifies if the courier partner
3827
+ * handles the transportation of dangerous goods.
3828
+ */
3829
+ dangerous_goods?: boolean;
3830
+ /**
3831
+ * - Indicates whether the courier partner
3832
+ * manages the shipment of fragile goods.
3833
+ */
3834
+ fragile_goods?: boolean;
3835
+ /**
3836
+ * - Indicates if the courier partner
3837
+ * handles restricted goods, as per regulatory guidelines.
3838
+ */
3839
+ restricted_goods?: boolean;
3840
+ /**
3841
+ * - Denotes if the courier partner
3842
+ * provides cold storage facilities for goods.
3843
+ */
3844
+ cold_storage_goods?: boolean;
3845
+ /**
3846
+ * - Indicates if the courier partner
3847
+ * supports doorstep exchange services.
3848
+ */
3849
+ doorstep_exchange?: boolean;
3850
+ /**
3851
+ * - Specifies if the courier partner
3852
+ * offers doorstep return services.
3853
+ */
3854
+ doorstep_return?: boolean;
3855
+ /**
3856
+ * - Indicates if the courier partner
3857
+ * provides product installation services upon delivery.
3858
+ */
3859
+ product_installation?: boolean;
3860
+ /**
3861
+ * - Specifies whether the courier
3862
+ * partner supports open-box delivery, allowing customers to inspect goods
3863
+ * before accepting.
3864
+ */
3865
+ openbox_delivery?: boolean;
3866
+ /**
3867
+ * - Indicates if the courier
3868
+ * partner supports multiple pickups to a single drop location.
3869
+ */
3870
+ multi_pick_single_drop?: boolean;
3871
+ /**
3872
+ * - Indicates whether the courier
3873
+ * partner supports single pickup to multiple drop locations.
3874
+ */
3875
+ single_pick_multi_drop?: boolean;
3876
+ /**
3877
+ * - Denotes if the courier partner
3878
+ * offers services for multiple pickups to multiple drop locations.
3879
+ */
3880
+ multi_pick_multi_drop?: boolean;
3881
+ /**
3882
+ * - Specifies if the courier partner requires or
3883
+ * supports the generation of e-waybills for shipments.
3884
+ */
3885
+ ewaybill?: boolean;
3886
+ };
3887
+ /** @returns {CourierPartnerSchemeV2DetailsModel} */
3888
+ declare function CourierPartnerSchemeV2DetailsModel(): CourierPartnerSchemeV2DetailsModel;
3889
+ type CourierPartnerSchemeV2DetailsModel = {
3890
+ /**
3891
+ * - Unique identifier of courier partner extension
3892
+ */
3893
+ extension_id: string;
3894
+ scheme_id?: string;
3895
+ name: string;
3896
+ weight: ArithmeticOperations;
3897
+ volumetric_weight?: ArithmeticOperations;
3898
+ transport_type: string;
3899
+ region: string;
3900
+ delivery_type: string;
3901
+ payment_mode: string[];
3902
+ stage: string;
3903
+ /**
3904
+ * - Describes the type of status updates
3905
+ * provided by the courier partner (e.g., real-time, periodic).
3906
+ */
3907
+ status_updates?: string;
3908
+ /**
3909
+ * - Indicates if the Non-Delivery Report
3910
+ * (NDR) feature is supported by the courier partner.
3911
+ */
3912
+ ndr_attempts?: number;
3913
+ /**
3914
+ * - Defines the maximum quantity
3915
+ * of items allowed in a quality check shipment.
3916
+ */
3917
+ qc_shipment_item_quantity?: number;
3918
+ /**
3919
+ * - Defines the maximum
3920
+ * quantity of items allowed in a non-quality check shipment.
3921
+ */
3922
+ non_qc_shipment_item_quantity?: number;
3923
+ feature: CourierPartnerSchemeV2Features;
3924
+ };
3925
+ /** @returns {CourierPartnerV2SchemeModel} */
3926
+ declare function CourierPartnerV2SchemeModel(): CourierPartnerV2SchemeModel;
3927
+ type CourierPartnerV2SchemeModel = {
3928
+ /**
3929
+ * - Unique identifier of courier partner extension.
3930
+ */
3931
+ extension_id: string;
3932
+ /**
3933
+ * - Unique identifier of courier partner scheme.
3934
+ */
3935
+ scheme_id: string;
3936
+ /**
3937
+ * - Unique identifier of company.
3938
+ */
3939
+ company_id?: string;
3940
+ /**
3941
+ * - Name of the scheme.
3942
+ */
3943
+ name: string;
3944
+ weight: ArithmeticOperations;
3945
+ volumetric_weight?: ArithmeticOperations;
3946
+ /**
3947
+ * - Mode of transport associated with the
3948
+ * courier partner scheme.
3949
+ */
3950
+ transport_type: string;
3951
+ /**
3952
+ * - Serviceable region associated with the courier
3953
+ * partner scheme.
3954
+ */
3955
+ region: string;
3956
+ /**
3957
+ * - Type of delivery associated with the
3958
+ * courier partner scheme.
3959
+ */
3960
+ delivery_type: string;
3961
+ /**
3962
+ * - Mode of payment associated with the
3963
+ * courier partner scheme.
3964
+ */
3965
+ payment_mode: string[];
3966
+ /**
3967
+ * - Indicates if the courier partner scheme is
3968
+ * currently active or inactive.
3969
+ */
3970
+ stage: string;
3971
+ /**
3972
+ * - Describes the type of status updates
3973
+ * provided by the courier partner (e.g., real-time, periodic).
3974
+ */
3975
+ status_updates?: string;
3976
+ /**
3977
+ * - Indicates if the Non-Delivery Report
3978
+ * (NDR) feature is supported by the courier partner.
3979
+ */
3980
+ ndr_attempts?: number;
3981
+ /**
3982
+ * - Defines the maximum quantity
3983
+ * of items allowed in a quality check shipment.
3984
+ */
3985
+ qc_shipment_item_quantity?: number;
3986
+ /**
3987
+ * - Defines the maximum
3988
+ * quantity of items allowed in a non-quality check shipment.
3989
+ */
3990
+ non_qc_shipment_item_quantity?: number;
3991
+ feature: CourierPartnerSchemeV2Features;
3992
+ };
3993
+ /** @returns {CourierPartnerSchemeV2UpdateDetails} */
3994
+ declare function CourierPartnerSchemeV2UpdateDetails(): CourierPartnerSchemeV2UpdateDetails;
3995
+ type CourierPartnerSchemeV2UpdateDetails = {
3996
+ name: string;
3997
+ weight: ArithmeticOperations;
3998
+ volumetric_weight?: ArithmeticOperations;
3999
+ transport_type: string;
4000
+ region: string;
4001
+ delivery_type: string;
4002
+ payment_mode: string[];
4003
+ stage: string;
4004
+ /**
4005
+ * - Describes the type of status updates
4006
+ * provided by the courier partner (e.g., real-time, periodic).
4007
+ */
4008
+ status_updates?: string;
4009
+ /**
4010
+ * - Indicates if the Non-Delivery Report
4011
+ * (NDR) feature is supported by the courier partner.
4012
+ */
4013
+ ndr_attempts?: number;
4014
+ /**
4015
+ * - Defines the maximum quantity
4016
+ * of items allowed in a quality check shipment.
4017
+ */
4018
+ qc_shipment_item_quantity?: number;
4019
+ /**
4020
+ * - Defines the maximum
4021
+ * quantity of items allowed in a non-quality check shipment.
4022
+ */
4023
+ non_qc_shipment_item_quantity?: number;
4024
+ feature: CourierPartnerSchemeV2Features;
4025
+ };
4026
+ /** @returns {courierPartnerSchemeV2List} */
4027
+ declare function courierPartnerSchemeV2List(): courierPartnerSchemeV2List;
4028
+ type courierPartnerSchemeV2List = {
4029
+ /**
4030
+ * - List of courier partner schemes
4031
+ */
4032
+ items: CourierPartnerV2SchemeModel[];
4033
+ page: Page;
4034
+ };
4035
+ /** @returns {BulkRegionServiceabilityTatDetails} */
4036
+ declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
4037
+ type BulkRegionServiceabilityTatDetails = {
4038
+ country: string;
4039
+ region: string;
4040
+ type: string;
4041
+ };
4042
+ /** @returns {BulkRegionServiceabilityTatResultItemData} */
4043
+ declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
4044
+ type BulkRegionServiceabilityTatResultItemData = {
4045
+ /**
4046
+ * - Name of the country.
4047
+ */
4048
+ country?: string;
4049
+ /**
4050
+ * - Name of the region for which the
4051
+ * tat/serviceability file needs to be downloaded.
4052
+ */
4053
+ region?: string;
4054
+ /**
4055
+ * - Denotes the type of data.
4056
+ */
4057
+ type?: string;
4058
+ /**
4059
+ * - Unique identifier identifying the perticular request.
4060
+ */
4061
+ batch_id?: string;
4062
+ /**
4063
+ * - Current status of the request.
4064
+ */
4065
+ status?: string;
4066
+ /**
4067
+ * - Information of records which failed
4068
+ */
4069
+ failed_records?: any[];
4070
+ /**
4071
+ * - CDN path of the file.
4072
+ */
4073
+ file_path?: string;
4074
+ };
4075
+ /** @returns {BulkRegionServiceabilityTatResult} */
4076
+ declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
4077
+ type BulkRegionServiceabilityTatResult = {
4078
+ items?: BulkRegionServiceabilityTatResultItemData[];
4079
+ page?: Page;
2295
4080
  };
2296
- /** @returns {OptimalLocationsResponse} */
2297
- declare function OptimalLocationsResponse(): OptimalLocationsResponse;
2298
- type OptimalLocationsResponse = {
2299
- assigned_stores: OptimalLocationAssignedStoresResponse[];
2300
- faulty_articles?: ErrorResponse[];
4081
+ /** @returns {HierarchyItems} */
4082
+ declare function HierarchyItems(): HierarchyItems;
4083
+ type HierarchyItems = {
4084
+ display_name?: string;
4085
+ slug?: string;
4086
+ };
4087
+ /** @returns {GetCountriesItems} */
4088
+ declare function GetCountriesItems(): GetCountriesItems;
4089
+ type GetCountriesItems = {
4090
+ id?: string;
4091
+ name?: string;
4092
+ iso2?: string;
4093
+ iso3?: string;
4094
+ timezones?: string[];
4095
+ hierarchy?: HierarchyItems[];
4096
+ phone_code?: string;
4097
+ currency?: string;
4098
+ type?: string;
4099
+ latitude?: string;
4100
+ longitude?: string;
4101
+ display_name?: string;
4102
+ has_next_hierarchy?: boolean;
4103
+ };
4104
+ /** @returns {GetCountries} */
4105
+ declare function GetCountries(): GetCountries;
4106
+ type GetCountries = {
4107
+ items: GetCountriesItems[];
4108
+ page: Page;
2301
4109
  };