@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.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 (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -1,38 +1,41 @@
1
1
  export = ServiceabilityPlatformValidator;
2
2
  /**
3
3
  * @typedef BulkServiceabilityParam
4
- * @property {string} extensionId - Unique Identifier of CP Extension
5
- * @property {string} schemeId - Unique identifier of a scheme
6
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
4
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
5
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
6
+ * or modify scheme details.
7
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
7
8
  */
8
9
  /**
9
10
  * @typedef BulkTatParam
10
- * @property {string} extensionId - Unique Identifier of CP Extension
11
- * @property {string} schemeId - Unique identifier of a scheme
12
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
11
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
12
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
13
+ * or modify scheme details.
14
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
13
15
  */
14
16
  /**
15
17
  * @typedef CreateCourierPartnerAccountParam
16
- * @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
18
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
19
+ */
20
+ /**
21
+ * @typedef CreateCourierPartnerSchemeParam
22
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel} body
17
23
  */
18
24
  /**
19
25
  * @typedef CreatePackageMaterialParam
26
+ * @property {number} [pageNo] - The current page number for paginated results.
20
27
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
21
28
  */
22
29
  /**
23
30
  * @typedef CreatePackageMaterialRuleParam
24
31
  * @property {ServiceabilityPlatformModel.PackageRule} body
25
32
  */
26
- /**
27
- * @typedef CreateZoneParam
28
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
29
- */
30
- /** @typedef GetAllStoresParam */
31
33
  /**
32
34
  * @typedef GetBulkServiceabilityParam
33
- * @property {string} extensionId - Unique Identifier of CP Extension
34
- * @property {string} schemeId - Unique identifier of a scheme
35
- * @property {number} [pageNo] - Index of the item to start returning with
35
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
36
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
37
+ * or modify scheme details.
38
+ * @property {number} [pageNo] - The current page number for paginated results.
36
39
  * @property {number} [pageSize] - Determines the items to be displayed in a page
37
40
  * @property {string} [batchId] - Unique identifier of bulk job
38
41
  * @property {string} [action] - Import or export bulk type
@@ -44,9 +47,10 @@ export = ServiceabilityPlatformValidator;
44
47
  */
45
48
  /**
46
49
  * @typedef GetBulkTatParam
47
- * @property {string} extensionId - Unique Identifier of CP Extension
48
- * @property {string} schemeId - Unique identifier of a scheme
49
- * @property {number} [pageNo] - Index of the item to start returning with
50
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
51
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
52
+ * or modify scheme details.
53
+ * @property {number} [pageNo] - The current page number for paginated results.
50
54
  * @property {number} [pageSize] - Determines the items to be displayed in a page
51
55
  * @property {string} [batchId] - Unique identifier of bulk job
52
56
  * @property {string} [action] - Import or export bulk type
@@ -57,17 +61,62 @@ export = ServiceabilityPlatformValidator;
57
61
  * @property {string} [endDate] - Fetch job history before a particule date
58
62
  */
59
63
  /** @typedef GetCompanyConfigurationParam */
64
+ /**
65
+ * @typedef GetCompanyCourierPartnersListParam
66
+ * @property {ServiceabilityPlatformModel.CourierPartnerDetails} body
67
+ */
68
+ /**
69
+ * @typedef GetCountriesParam
70
+ * @property {boolean} [onboard] - Only fetch countries which allowed for
71
+ * onboard on Platform.
72
+ * @property {number} [pageNo] - The page number to navigate through the given
73
+ * set of results. Default value is 1.
74
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
75
+ * Default value is 12
76
+ * @property {string} [q] - The search string to search in the list of countries by name.
77
+ * @property {string} [hierarchy] - The search filter to filter countries based
78
+ * on their available hierarchy.
79
+ */
60
80
  /**
61
81
  * @typedef GetCourierPartnerAccountParam
62
82
  * @property {string} accountId - Unique ID of courier account
63
83
  */
64
84
  /**
65
85
  * @typedef GetCourierPartnerAccountsParam
66
- * @property {number} [pageNo] - Index of the item to start returning with
86
+ * @property {number} [pageNo] - The current page number for paginated results.
67
87
  * @property {number} [pageSize] - Determines the items to be displayed in a page
68
- * @property {string} [stage] - Stage of the account. enabled/disabled
88
+ * @property {string} [stage] - Stage of the account.
69
89
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
70
90
  * @property {string} [transportType] - Filters dp accounts based on transport_type
91
+ * @property {string[]} [accountIds] - Filters dp accounts based on their ids
92
+ * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
93
+ * @property {boolean} [ownAccount] - Filters seller owned or Fynd Managed dp accounts
94
+ * @property {string} [q] - Filters dp accounts based on case sensitive partial
95
+ * account name
96
+ */
97
+ /**
98
+ * @typedef GetCourierPartnerSchemeParam
99
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
100
+ * or modify scheme details.
101
+ */
102
+ /**
103
+ * @typedef GetCourierPartnerSchemesParam
104
+ * @property {string} [extensionId] - Unique Identifier of courier partner extension.
105
+ * @property {string} [schemeType] - Indicates whether a scheme is created by an
106
+ * admin for global purposes or customized for a specific company.
107
+ * @property {string} [paymentMode] - Indicates payment mode for a scheme.
108
+ * @property {string[]} [capabilities] - Indicates whether the scheme possesses
109
+ * certain capabilities.
110
+ * @property {string[]} [schemeIds] - List of scheme ids which need to be
111
+ * returned in the response.
112
+ * @property {string} [q] - The search string to search in the list of courier
113
+ * partners schemes by name.
114
+ */
115
+ /**
116
+ * @typedef GetInstalledCourierPartnerExtensionsParam
117
+ * @property {number} [pageNo] - The current page number for paginated results.
118
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
119
+ * @property {string} [isInstalled] - Filter to get installed extensions only
71
120
  */
72
121
  /**
73
122
  * @typedef GetOptimalLocationsParam
@@ -75,9 +124,10 @@ export = ServiceabilityPlatformValidator;
75
124
  */
76
125
  /**
77
126
  * @typedef GetPackageMaterialListParam
78
- * @property {number} [pageNo] - Index of the item to start returning with
127
+ * @property {number} [pageNo] - The current page number for paginated results.
79
128
  * @property {number} [pageSize] - Determines the items to be displayed in a page
80
- * @property {string} [q] - Perform regex search on items matching name for given value
129
+ * @property {string} [q] - Used to search for matching results based on the
130
+ * provided input.
81
131
  * @property {string} [size] - Filters items based on given size
82
132
  * @property {string} [packageType] - Filters items based on given package_type
83
133
  */
@@ -86,48 +136,37 @@ export = ServiceabilityPlatformValidator;
86
136
  * @property {string} ruleId - A `package_material_rule_id` is a unique
87
137
  * identifier for a Package Material Rule
88
138
  */
89
- /**
90
- * @typedef GetPackageMaterialRulesParam
91
- * @property {number} [pageNo] - Index of the item to start returning with
92
- * @property {number} [pageSize] - Determines the items to be displayed in a page
93
- * @property {string} [isActive] - Filters items based on given is_active
94
- */
95
139
  /**
96
140
  * @typedef GetPackageMaterialsParam
97
141
  * @property {string} packageMaterialId - A `package_material_id` is a unique
98
142
  * identifier for a Package Material
99
143
  */
100
144
  /**
101
- * @typedef GetServiceabilityParam
102
- * @property {string} extensionId - Unique Identifier of CP Extension
103
- * @property {string} schemeId - Unique identifier of a scheme
104
- * @property {string} regionId - Unique identifier of a region
105
- */
106
- /**
107
- * @typedef GetZoneByIdParam
108
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
145
+ * @typedef GetSampleFileServiceabilityStatusParam
146
+ * @property {number} [pageNo] - The current page number for paginated results.
147
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
148
+ * @property {string} [batchId] - Batch id of the execution
109
149
  */
150
+ /** @typedef GetSelfShipDetailsParam */
110
151
  /**
111
- * @typedef GetZonesParam
112
- * @property {number} [pageNo] - Index of the item to start returning with
113
- * @property {number} [pageSize] - Determines the items to be displayed in a page
114
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
115
- * @property {string} [applicationIds] - Zones filtered by applications
116
- * @property {string} [q] - Search with name as a free text
117
- * @property {string} [countryIsoCode] - ISO2 code of the country
118
- * @property {string} [state] - State name
119
- * @property {string} [city] - City name
120
- * @property {string} [pincode] - Pincode value to search zones
121
- * @property {string} [sector] - Sector value to search zones
152
+ * @typedef SampleFileServiceabilityParam
153
+ * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
122
154
  */
123
155
  /**
124
156
  * @typedef UpdateCompanyConfigurationParam
125
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
157
+ * @property {string} fulfillmentOptionSlug - Slug representing the fulfillment option.
158
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
126
159
  */
127
160
  /**
128
161
  * @typedef UpdateCourierPartnerAccountParam
129
162
  * @property {string} accountId - Unique ID of courier account
130
- * @property {ServiceabilityPlatformModel.CourierAccount} body
163
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
164
+ */
165
+ /**
166
+ * @typedef UpdateCourierPartnerSchemeParam
167
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
168
+ * or modify scheme details.
169
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema} body
131
170
  */
132
171
  /**
133
172
  * @typedef UpdatePackageMaterialRuleParam
@@ -142,16 +181,8 @@ export = ServiceabilityPlatformValidator;
142
181
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
143
182
  */
144
183
  /**
145
- * @typedef UpdateServiceabilityParam
146
- * @property {string} extensionId - Unique Identifier of CP Extension
147
- * @property {string} schemeId - Unique identifier of a scheme
148
- * @property {string} regionId - Unique identifier of a region
149
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
150
- */
151
- /**
152
- * @typedef UpdateZoneByIdParam
153
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
154
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
184
+ * @typedef UpdateSelfShipDetailsParam
185
+ * @property {ServiceabilityPlatformModel.SelfshipSchema} body
155
186
  */
156
187
  declare class ServiceabilityPlatformValidator {
157
188
  /** @returns {BulkServiceabilityParam} */
@@ -160,101 +191,114 @@ declare class ServiceabilityPlatformValidator {
160
191
  static bulkTat(): BulkTatParam;
161
192
  /** @returns {CreateCourierPartnerAccountParam} */
162
193
  static createCourierPartnerAccount(): CreateCourierPartnerAccountParam;
194
+ /** @returns {CreateCourierPartnerSchemeParam} */
195
+ static createCourierPartnerScheme(): CreateCourierPartnerSchemeParam;
163
196
  /** @returns {CreatePackageMaterialParam} */
164
197
  static createPackageMaterial(): CreatePackageMaterialParam;
165
198
  /** @returns {CreatePackageMaterialRuleParam} */
166
199
  static createPackageMaterialRule(): CreatePackageMaterialRuleParam;
167
- /** @returns {CreateZoneParam} */
168
- static createZone(): CreateZoneParam;
169
- /** @returns {GetAllStoresParam} */
170
- static getAllStores(): any;
171
200
  /** @returns {GetBulkServiceabilityParam} */
172
201
  static getBulkServiceability(): GetBulkServiceabilityParam;
173
202
  /** @returns {GetBulkTatParam} */
174
203
  static getBulkTat(): GetBulkTatParam;
175
204
  /** @returns {GetCompanyConfigurationParam} */
176
205
  static getCompanyConfiguration(): any;
206
+ /** @returns {GetCompanyCourierPartnersListParam} */
207
+ static getCompanyCourierPartnersList(): GetCompanyCourierPartnersListParam;
208
+ /** @returns {GetCountriesParam} */
209
+ static getCountries(): GetCountriesParam;
177
210
  /** @returns {GetCourierPartnerAccountParam} */
178
211
  static getCourierPartnerAccount(): GetCourierPartnerAccountParam;
179
212
  /** @returns {GetCourierPartnerAccountsParam} */
180
213
  static getCourierPartnerAccounts(): GetCourierPartnerAccountsParam;
214
+ /** @returns {GetCourierPartnerSchemeParam} */
215
+ static getCourierPartnerScheme(): GetCourierPartnerSchemeParam;
216
+ /** @returns {GetCourierPartnerSchemesParam} */
217
+ static getCourierPartnerSchemes(): GetCourierPartnerSchemesParam;
218
+ /** @returns {GetInstalledCourierPartnerExtensionsParam} */
219
+ static getInstalledCourierPartnerExtensions(): GetInstalledCourierPartnerExtensionsParam;
181
220
  /** @returns {GetOptimalLocationsParam} */
182
221
  static getOptimalLocations(): GetOptimalLocationsParam;
183
222
  /** @returns {GetPackageMaterialListParam} */
184
223
  static getPackageMaterialList(): GetPackageMaterialListParam;
185
224
  /** @returns {GetPackageMaterialRuleParam} */
186
225
  static getPackageMaterialRule(): GetPackageMaterialRuleParam;
187
- /** @returns {GetPackageMaterialRulesParam} */
188
- static getPackageMaterialRules(): GetPackageMaterialRulesParam;
189
226
  /** @returns {GetPackageMaterialsParam} */
190
227
  static getPackageMaterials(): GetPackageMaterialsParam;
191
- /** @returns {GetServiceabilityParam} */
192
- static getServiceability(): GetServiceabilityParam;
193
- /** @returns {GetZoneByIdParam} */
194
- static getZoneById(): GetZoneByIdParam;
195
- /** @returns {GetZonesParam} */
196
- static getZones(): GetZonesParam;
228
+ /** @returns {GetSampleFileServiceabilityStatusParam} */
229
+ static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
230
+ /** @returns {GetSelfShipDetailsParam} */
231
+ static getSelfShipDetails(): any;
232
+ /** @returns {SampleFileServiceabilityParam} */
233
+ static sampleFileServiceability(): SampleFileServiceabilityParam;
197
234
  /** @returns {UpdateCompanyConfigurationParam} */
198
235
  static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
199
236
  /** @returns {UpdateCourierPartnerAccountParam} */
200
237
  static updateCourierPartnerAccount(): UpdateCourierPartnerAccountParam;
238
+ /** @returns {UpdateCourierPartnerSchemeParam} */
239
+ static updateCourierPartnerScheme(): UpdateCourierPartnerSchemeParam;
201
240
  /** @returns {UpdatePackageMaterialRuleParam} */
202
241
  static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
203
242
  /** @returns {UpdatePackageMaterialsParam} */
204
243
  static updatePackageMaterials(): UpdatePackageMaterialsParam;
205
- /** @returns {UpdateServiceabilityParam} */
206
- static updateServiceability(): UpdateServiceabilityParam;
207
- /** @returns {UpdateZoneByIdParam} */
208
- static updateZoneById(): UpdateZoneByIdParam;
244
+ /** @returns {UpdateSelfShipDetailsParam} */
245
+ static updateSelfShipDetails(): UpdateSelfShipDetailsParam;
209
246
  }
210
247
  declare namespace ServiceabilityPlatformValidator {
211
- export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
248
+ export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCompanyCourierPartnersListParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetInstalledCourierPartnerExtensionsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetSelfShipDetailsParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateSelfShipDetailsParam };
212
249
  }
213
250
  type BulkServiceabilityParam = {
214
251
  /**
215
- * - Unique Identifier of CP Extension
252
+ * - Unique Identifier of courier partner extension.
216
253
  */
217
254
  extensionId: string;
218
255
  /**
219
- * - Unique identifier of a scheme
256
+ * - Unique identifier for the scheme, used to fetch
257
+ * or modify scheme details.
220
258
  */
221
259
  schemeId: string;
222
- body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
260
+ body: ServiceabilityPlatformModel.BulkRegionJobDetails;
223
261
  };
224
262
  type BulkTatParam = {
225
263
  /**
226
- * - Unique Identifier of CP Extension
264
+ * - Unique Identifier of courier partner extension.
227
265
  */
228
266
  extensionId: string;
229
267
  /**
230
- * - Unique identifier of a scheme
268
+ * - Unique identifier for the scheme, used to fetch
269
+ * or modify scheme details.
231
270
  */
232
271
  schemeId: string;
233
- body: ServiceabilityPlatformModel.BulkRegionJobSerializer;
272
+ body: ServiceabilityPlatformModel.BulkRegionJobDetails;
234
273
  };
235
274
  type CreateCourierPartnerAccountParam = {
236
- body: ServiceabilityPlatformModel.CourierAccountRequestBody;
275
+ body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
276
+ };
277
+ type CreateCourierPartnerSchemeParam = {
278
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel;
237
279
  };
238
280
  type CreatePackageMaterialParam = {
281
+ /**
282
+ * - The current page number for paginated results.
283
+ */
284
+ pageNo?: number;
239
285
  body: ServiceabilityPlatformModel.PackageMaterial;
240
286
  };
241
287
  type CreatePackageMaterialRuleParam = {
242
288
  body: ServiceabilityPlatformModel.PackageRule;
243
289
  };
244
- type CreateZoneParam = {
245
- body: ServiceabilityPlatformModel.CreateZoneData;
246
- };
247
290
  type GetBulkServiceabilityParam = {
248
291
  /**
249
- * - Unique Identifier of CP Extension
292
+ * - Unique Identifier of courier partner extension.
250
293
  */
251
294
  extensionId: string;
252
295
  /**
253
- * - Unique identifier of a scheme
296
+ * - Unique identifier for the scheme, used to fetch
297
+ * or modify scheme details.
254
298
  */
255
299
  schemeId: string;
256
300
  /**
257
- * - Index of the item to start returning with
301
+ * - The current page number for paginated results.
258
302
  */
259
303
  pageNo?: number;
260
304
  /**
@@ -292,15 +336,16 @@ type GetBulkServiceabilityParam = {
292
336
  };
293
337
  type GetBulkTatParam = {
294
338
  /**
295
- * - Unique Identifier of CP Extension
339
+ * - Unique Identifier of courier partner extension.
296
340
  */
297
341
  extensionId: string;
298
342
  /**
299
- * - Unique identifier of a scheme
343
+ * - Unique identifier for the scheme, used to fetch
344
+ * or modify scheme details.
300
345
  */
301
346
  schemeId: string;
302
347
  /**
303
- * - Index of the item to start returning with
348
+ * - The current page number for paginated results.
304
349
  */
305
350
  pageNo?: number;
306
351
  /**
@@ -336,6 +381,35 @@ type GetBulkTatParam = {
336
381
  */
337
382
  endDate?: string;
338
383
  };
384
+ type GetCompanyCourierPartnersListParam = {
385
+ body: ServiceabilityPlatformModel.CourierPartnerDetails;
386
+ };
387
+ type GetCountriesParam = {
388
+ /**
389
+ * - Only fetch countries which allowed for
390
+ * onboard on Platform.
391
+ */
392
+ onboard?: boolean;
393
+ /**
394
+ * - The page number to navigate through the given
395
+ * set of results. Default value is 1.
396
+ */
397
+ pageNo?: number;
398
+ /**
399
+ * - The number of items to retrieve in each page.
400
+ * Default value is 12
401
+ */
402
+ pageSize?: number;
403
+ /**
404
+ * - The search string to search in the list of countries by name.
405
+ */
406
+ q?: string;
407
+ /**
408
+ * - The search filter to filter countries based
409
+ * on their available hierarchy.
410
+ */
411
+ hierarchy?: string;
412
+ };
339
413
  type GetCourierPartnerAccountParam = {
340
414
  /**
341
415
  * - Unique ID of courier account
@@ -344,7 +418,7 @@ type GetCourierPartnerAccountParam = {
344
418
  };
345
419
  type GetCourierPartnerAccountsParam = {
346
420
  /**
347
- * - Index of the item to start returning with
421
+ * - The current page number for paginated results.
348
422
  */
349
423
  pageNo?: number;
350
424
  /**
@@ -352,7 +426,7 @@ type GetCourierPartnerAccountsParam = {
352
426
  */
353
427
  pageSize?: number;
354
428
  /**
355
- * - Stage of the account. enabled/disabled
429
+ * - Stage of the account.
356
430
  */
357
431
  stage?: string;
358
432
  /**
@@ -363,83 +437,81 @@ type GetCourierPartnerAccountsParam = {
363
437
  * - Filters dp accounts based on transport_type
364
438
  */
365
439
  transportType?: string;
366
- };
367
- type GetOptimalLocationsParam = {
368
- body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
369
- };
370
- type GetPackageMaterialListParam = {
371
440
  /**
372
- * - Index of the item to start returning with
441
+ * - Filters dp accounts based on their ids
373
442
  */
374
- pageNo?: number;
443
+ accountIds?: string[];
375
444
  /**
376
- * - Determines the items to be displayed in a page
445
+ * - To filter self ship/non self ship dp accounts
377
446
  */
378
- pageSize?: number;
447
+ selfShip?: boolean;
379
448
  /**
380
- * - Perform regex search on items matching name for given value
449
+ * - Filters seller owned or Fynd Managed dp accounts
381
450
  */
382
- q?: string;
451
+ ownAccount?: boolean;
383
452
  /**
384
- * - Filters items based on given size
453
+ * - Filters dp accounts based on case sensitive partial
454
+ * account name
385
455
  */
386
- size?: string;
456
+ q?: string;
457
+ };
458
+ type GetCourierPartnerSchemeParam = {
387
459
  /**
388
- * - Filters items based on given package_type
460
+ * - Unique identifier for the scheme, used to fetch
461
+ * or modify scheme details.
389
462
  */
390
- packageType?: string;
463
+ schemeId: string;
391
464
  };
392
- type GetPackageMaterialRuleParam = {
465
+ type GetCourierPartnerSchemesParam = {
393
466
  /**
394
- * - A `package_material_rule_id` is a unique
395
- * identifier for a Package Material Rule
467
+ * - Unique Identifier of courier partner extension.
396
468
  */
397
- ruleId: string;
398
- };
399
- type GetPackageMaterialRulesParam = {
469
+ extensionId?: string;
400
470
  /**
401
- * - Index of the item to start returning with
471
+ * - Indicates whether a scheme is created by an
472
+ * admin for global purposes or customized for a specific company.
402
473
  */
403
- pageNo?: number;
474
+ schemeType?: string;
404
475
  /**
405
- * - Determines the items to be displayed in a page
476
+ * - Indicates payment mode for a scheme.
406
477
  */
407
- pageSize?: number;
478
+ paymentMode?: string;
408
479
  /**
409
- * - Filters items based on given is_active
480
+ * - Indicates whether the scheme possesses
481
+ * certain capabilities.
410
482
  */
411
- isActive?: string;
412
- };
413
- type GetPackageMaterialsParam = {
483
+ capabilities?: string[];
414
484
  /**
415
- * - A `package_material_id` is a unique
416
- * identifier for a Package Material
485
+ * - List of scheme ids which need to be
486
+ * returned in the response.
417
487
  */
418
- packageMaterialId: string;
419
- };
420
- type GetServiceabilityParam = {
488
+ schemeIds?: string[];
421
489
  /**
422
- * - Unique Identifier of CP Extension
490
+ * - The search string to search in the list of courier
491
+ * partners schemes by name.
423
492
  */
424
- extensionId: string;
493
+ q?: string;
494
+ };
495
+ type GetInstalledCourierPartnerExtensionsParam = {
425
496
  /**
426
- * - Unique identifier of a scheme
497
+ * - The current page number for paginated results.
427
498
  */
428
- schemeId: string;
499
+ pageNo?: number;
429
500
  /**
430
- * - Unique identifier of a region
501
+ * - Determines the items to be displayed in a page
431
502
  */
432
- regionId: string;
433
- };
434
- type GetZoneByIdParam = {
503
+ pageSize?: number;
435
504
  /**
436
- * - A `zone_id` is a unique identifier for a particular zone.
505
+ * - Filter to get installed extensions only
437
506
  */
438
- zoneId: string;
507
+ isInstalled?: string;
508
+ };
509
+ type GetOptimalLocationsParam = {
510
+ body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
439
511
  };
440
- type GetZonesParam = {
512
+ type GetPackageMaterialListParam = {
441
513
  /**
442
- * - Index of the item to start returning with
514
+ * - The current page number for paginated results.
443
515
  */
444
516
  pageNo?: number;
445
517
  /**
@@ -447,47 +519,71 @@ type GetZonesParam = {
447
519
  */
448
520
  pageSize?: number;
449
521
  /**
450
- * - Status of Zone (either active or inactive)
522
+ * - Used to search for matching results based on the
523
+ * provided input.
451
524
  */
452
- isActive?: boolean;
525
+ q?: string;
453
526
  /**
454
- * - Zones filtered by applications
527
+ * - Filters items based on given size
455
528
  */
456
- applicationIds?: string;
529
+ size?: string;
457
530
  /**
458
- * - Search with name as a free text
531
+ * - Filters items based on given package_type
459
532
  */
460
- q?: string;
533
+ packageType?: string;
534
+ };
535
+ type GetPackageMaterialRuleParam = {
461
536
  /**
462
- * - ISO2 code of the country
537
+ * - A `package_material_rule_id` is a unique
538
+ * identifier for a Package Material Rule
463
539
  */
464
- countryIsoCode?: string;
540
+ ruleId: string;
541
+ };
542
+ type GetPackageMaterialsParam = {
465
543
  /**
466
- * - State name
544
+ * - A `package_material_id` is a unique
545
+ * identifier for a Package Material
467
546
  */
468
- state?: string;
547
+ packageMaterialId: string;
548
+ };
549
+ type GetSampleFileServiceabilityStatusParam = {
469
550
  /**
470
- * - City name
551
+ * - The current page number for paginated results.
471
552
  */
472
- city?: string;
553
+ pageNo?: number;
473
554
  /**
474
- * - Pincode value to search zones
555
+ * - Determines the items to be displayed in a page
475
556
  */
476
- pincode?: string;
557
+ pageSize?: number;
477
558
  /**
478
- * - Sector value to search zones
559
+ * - Batch id of the execution
479
560
  */
480
- sector?: string;
561
+ batchId?: string;
562
+ };
563
+ type SampleFileServiceabilityParam = {
564
+ body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
481
565
  };
482
566
  type UpdateCompanyConfigurationParam = {
483
- body: ServiceabilityPlatformModel.CompanyConfig;
567
+ /**
568
+ * - Slug representing the fulfillment option.
569
+ */
570
+ fulfillmentOptionSlug: string;
571
+ body: ServiceabilityPlatformModel.CompanyConfigurationSchema;
484
572
  };
485
573
  type UpdateCourierPartnerAccountParam = {
486
574
  /**
487
575
  * - Unique ID of courier account
488
576
  */
489
577
  accountId: string;
490
- body: ServiceabilityPlatformModel.CourierAccount;
578
+ body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
579
+ };
580
+ type UpdateCourierPartnerSchemeParam = {
581
+ /**
582
+ * - Unique identifier for the scheme, used to fetch
583
+ * or modify scheme details.
584
+ */
585
+ schemeId: string;
586
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema;
491
587
  };
492
588
  type UpdatePackageMaterialRuleParam = {
493
589
  /**
@@ -505,28 +601,9 @@ type UpdatePackageMaterialsParam = {
505
601
  packageMaterialId: string;
506
602
  body: ServiceabilityPlatformModel.PackageMaterial;
507
603
  };
508
- type UpdateServiceabilityParam = {
509
- /**
510
- * - Unique Identifier of CP Extension
511
- */
512
- extensionId: string;
513
- /**
514
- * - Unique identifier of a scheme
515
- */
516
- schemeId: string;
517
- /**
518
- * - Unique identifier of a region
519
- */
520
- regionId: string;
521
- body: ServiceabilityPlatformModel.ServiceabilityModel;
522
- };
523
- type UpdateZoneByIdParam = {
524
- /**
525
- * - A `zone_id` is a unique identifier for a particular zone.
526
- */
527
- zoneId: string;
528
- body: ServiceabilityPlatformModel.UpdateZoneData;
604
+ type UpdateSelfShipDetailsParam = {
605
+ body: ServiceabilityPlatformModel.SelfshipSchema;
529
606
  };
530
- type GetAllStoresParam = any;
531
607
  type GetCompanyConfigurationParam = any;
608
+ type GetSelfShipDetailsParam = any;
532
609
  import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");