@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1

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 (298) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
  6. package/sdk/application/Cart/CartApplicationClient.js +270 -139
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +197 -36
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  20. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  26. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  32. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  33. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  34. package/sdk/application/User/UserApplicationClient.js +9 -57
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  37. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  41. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  42. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  43. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  44. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  45. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  46. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  47. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  48. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  56. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  58. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  59. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  63. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  65. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  66. package/sdk/partner/PartnerClient.d.ts +6 -0
  67. package/sdk/partner/PartnerClient.js +9 -0
  68. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  69. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  70. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  71. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  72. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  73. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  74. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  75. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  76. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  77. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  78. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  79. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  80. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  81. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  82. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
  83. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
  84. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  85. package/sdk/partner/index.d.ts +3 -0
  86. package/sdk/partner/index.js +6 -0
  87. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  88. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  89. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  90. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  95. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  97. package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
  98. package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
  99. package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
  100. package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
  102. package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
  104. package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
  105. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  106. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  107. package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
  108. package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
  111. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
  112. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
  113. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
  114. package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
  115. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
  116. package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
  117. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
  118. package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
  119. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  120. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  121. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  122. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
  125. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  126. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  127. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  128. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
  131. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  132. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  137. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
  138. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  141. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  142. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  143. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  144. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  145. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
  146. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
  147. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  148. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  149. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
  150. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
  151. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  152. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  153. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  154. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  155. package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
  156. package/sdk/platform/Content/ContentPlatformModel.js +893 -582
  157. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  158. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  159. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  160. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  161. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  162. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  163. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  164. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  167. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  168. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  169. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  170. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  171. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  172. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  173. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  174. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  175. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  176. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  177. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  178. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  179. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  180. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  181. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  182. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  183. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  184. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  185. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  186. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  187. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  188. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  189. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  190. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  191. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  192. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  193. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  194. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  195. package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
  196. package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
  197. package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
  198. package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
  199. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  200. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  201. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  202. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  203. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  204. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  205. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  206. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  207. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  208. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  209. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  210. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  211. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
  212. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
  213. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  214. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  215. package/sdk/platform/PlatformClient.d.ts +2 -0
  216. package/sdk/platform/PlatformClient.js +4 -0
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  220. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  221. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  222. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
  231. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
  232. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
  233. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  234. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  235. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  236. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  237. package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
  238. package/sdk/platform/Share/SharePlatformModel.js +3 -43
  239. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
  240. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
  241. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
  242. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
  243. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  244. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  245. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  246. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  247. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  248. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  249. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
  250. package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
  251. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
  252. package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
  253. package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
  254. package/sdk/platform/User/UserPlatformModel.js +209 -216
  255. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  256. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  257. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
  258. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
  259. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  260. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  261. package/sdk/platform/index.d.ts +1 -0
  262. package/sdk/platform/index.js +2 -0
  263. package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
  264. package/sdk/public/Billing/BillingPublicClient.js +397 -0
  265. package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
  266. package/sdk/public/Billing/BillingPublicModel.js +560 -0
  267. package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
  268. package/sdk/public/Billing/BillingPublicValidator.js +50 -0
  269. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  270. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  271. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  272. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  273. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  274. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  275. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  276. package/sdk/public/Content/ContentPublicClient.js +183 -0
  277. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  278. package/sdk/public/Content/ContentPublicModel.js +47 -1
  279. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  280. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  281. package/sdk/public/PublicClient.d.ts +2 -2
  282. package/sdk/public/PublicClient.js +2 -2
  283. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  284. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  285. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  286. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  287. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  288. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  289. package/sdk/public/index.d.ts +1 -1
  290. package/sdk/public/index.js +1 -1
  291. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  292. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  293. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  294. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  295. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  296. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  297. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  298. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -1,78 +1,39 @@
1
1
  export = ServiceabilityPlatformValidator;
2
- /**
3
- * @typedef BulkServiceabilityParam
4
- * @property {string} extensionId - Unique Identifier of courier partner extension.
5
- * @property {string} schemeId - Unique identifier of courier partner scheme.
6
- * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
7
- */
8
- /**
9
- * @typedef BulkTatParam
10
- * @property {string} extensionId - Unique Identifier of courier partner extension.
11
- * @property {string} schemeId - Unique identifier of courier partner scheme.
12
- * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
13
- */
14
2
  /**
15
3
  * @typedef CreateCourierPartnerAccountParam
16
- * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
17
- */
18
- /**
19
- * @typedef CreateCourierPartnerSchemeParam
20
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
4
+ * @property {ServiceabilityPlatformModel.CourierAccount} body
21
5
  */
22
6
  /**
23
7
  * @typedef CreatePackageMaterialParam
8
+ * @property {number} [pageNo] - Index of the item to start returning with
24
9
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
25
10
  */
26
11
  /**
27
12
  * @typedef CreatePackageMaterialRuleParam
28
- * @property {ServiceabilityPlatformModel.PackageRule} body
29
- */
30
- /**
31
- * @typedef CreateZoneParam
32
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
33
- */
34
- /** @typedef GetAllStoresParam */
35
- /**
36
- * @typedef GetBulkServiceabilityParam
37
- * @property {string} extensionId - Unique Identifier of courier partner extension.
38
- * @property {string} schemeId - Unique identifier of courier partner scheme.
39
- * @property {number} [pageNo] - Index of the item to start returning with
40
- * @property {number} [pageSize] - Determines the items to be displayed in a page
41
- * @property {string} [batchId] - Unique identifier of bulk job
42
- * @property {string} [action] - Import or export bulk type
43
- * @property {string} [status] - Status of the bulk actions
44
- * @property {string} [country] - Country for which bulk job is initiated
45
- * @property {string} [region] - Region for which bulk job is initiated
46
- * @property {string} [startDate] - Fetch job history after a particule date
47
- * @property {string} [endDate] - Fetch job history before a particule date
48
- */
49
- /**
50
- * @typedef GetBulkTatParam
51
- * @property {string} extensionId - Unique Identifier of courier partner extension.
52
- * @property {string} schemeId - Unique identifier of courier partner scheme.
53
- * @property {number} [pageNo] - Index of the item to start returning with
54
- * @property {number} [pageSize] - Determines the items to be displayed in a page
55
- * @property {string} [batchId] - Unique identifier of bulk job
56
- * @property {string} [action] - Import or export bulk type
57
- * @property {string} [status] - Status of the bulk actions
58
- * @property {string} [country] - Country for which bulk job is initiated
59
- * @property {string} [region] - Region for which bulk job is initiated
60
- * @property {string} [startDate] - Fetch job history after a particule date
61
- * @property {string} [endDate] - Fetch job history before a particule date
13
+ * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
62
14
  */
63
15
  /** @typedef GetCompanyConfigurationParam */
16
+ /** @typedef GetCompanySelfShipParam */
64
17
  /**
65
18
  * @typedef GetCountriesParam
66
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
19
+ * @property {boolean} [onboard] - Only fetch countries which allowed for
67
20
  * onboard on Platform.
68
- * @property {number} [pageNo] - Page number.
69
- * @property {number} [pageSize] - Page size.
70
- * @property {string} [q] - Search.
71
- * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
21
+ * @property {number} [pageNo] - The page number to navigate through the given
22
+ * set of results. Default value is 1.
23
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
24
+ * Default value is 12
25
+ * @property {string} [q] - The search string to search in the list of countries by name.
26
+ * @property {string} [hierarchy] - The search filter to filter countries based
27
+ * on their available hierarchy.
28
+ */
29
+ /**
30
+ * @typedef GetCountryParam
31
+ * @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
32
+ * code for the country.
72
33
  */
73
34
  /**
74
35
  * @typedef GetCourierPartnerAccountParam
75
- * @property {string} accountId - Unique ID of courier partner account
36
+ * @property {string} accountId - Unique ID of courier account
76
37
  */
77
38
  /**
78
39
  * @typedef GetCourierPartnerAccountsParam
@@ -81,24 +42,54 @@ export = ServiceabilityPlatformValidator;
81
42
  * @property {string} [stage] - Stage of the account. enabled/disabled
82
43
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
83
44
  * @property {string} [transportType] - Filters dp accounts based on transport_type
45
+ * @property {string[]} [accountIds] - Filters dp accounts based on their ids
46
+ * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
47
+ * @property {boolean} [ownAccount] - Filters seller owned or admin owned dp accounts
48
+ * @property {string} [q] - Filters dp accounts based on case sensitive partial
49
+ * account name
50
+ */
51
+ /**
52
+ * @typedef GetInstalledCourierPartnerExtensionsParam
53
+ * @property {number} [pageNo] - Index of the item to start returning with
54
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
55
+ * @property {string} [isInstalled] - Filter to get installed extensions only
56
+ */
57
+ /**
58
+ * @typedef GetListPackageMaterialRuleDetailsParam
59
+ * @property {number} [pageNo] - Index of the item to start returning with
60
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
61
+ * @property {string} [isActive] - Filters items based on given is_active
84
62
  */
85
63
  /**
86
- * @typedef GetCourierPartnerSchemeParam
87
- * @property {string} schemeId - Unique Identifier of Scheme
64
+ * @typedef GetLocalitiesParam
65
+ * @property {string} localityType - A `locality_type` contains unique
66
+ * geographical division.
67
+ * @property {string} [country] - A `country` contains a specific value of the
68
+ * country iso2 code.
69
+ * @property {string} [state] - A `state` contains a specific value of the
70
+ * state, province.
71
+ * @property {string} [city] - A `city` contains a specific value of the city.
72
+ * @property {number} [pageNo] - Page number.
73
+ * @property {number} [pageSize] - Page size.
74
+ * @property {string} [q] - Search.
75
+ * @property {string} [name] - Search for localities. Either provide a full name
76
+ * or a search term.
88
77
  */
89
78
  /**
90
- * @typedef GetCourierPartnerSchemesParam
91
- * @property {string} [schemeType] - Indicates whether a scheme is created by an
92
- * admin for global purposes or customized for a specific company.
93
- * @property {string} [paymentMode] - Indicates payment mode for a scheme.
94
- * @property {string[]} [capabilities] - Indicates whether the scheme possesses
95
- * certain capabilities.
96
- * @property {string[]} [schemeIds] - List of scheme ids which need to be
97
- * returned in the response.
79
+ * @typedef GetLocalityParam
80
+ * @property {string} localityType - A `locality_type` contains value
81
+ * geographical division.
82
+ * @property {string} localityValue - A `locality_value` contains a specific
83
+ * name of the locality.
84
+ * @property {string} [country] - A `country` contains a specific value of the
85
+ * country iso2 code.
86
+ * @property {string} [state] - A `state` contains a specific value of the
87
+ * state, province.
88
+ * @property {string} [city] - A `city` contains a specific value of the city.
98
89
  */
99
90
  /**
100
91
  * @typedef GetOptimalLocationsParam
101
- * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
92
+ * @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
102
93
  */
103
94
  /**
104
95
  * @typedef GetPackageMaterialListParam
@@ -114,202 +105,155 @@ export = ServiceabilityPlatformValidator;
114
105
  * identifier for a Package Material Rule
115
106
  */
116
107
  /**
117
- * @typedef GetPackageMaterialRulesParam
108
+ * @typedef GetPackageMaterialRuleDetailsParam
109
+ * @property {string} ruleId - A `package_material_rule_id` is a unique
110
+ * identifier for a Package Material Rule
118
111
  * @property {number} [pageNo] - Index of the item to start returning with
119
112
  * @property {number} [pageSize] - Determines the items to be displayed in a page
120
113
  * @property {string} [isActive] - Filters items based on given is_active
121
114
  */
122
115
  /**
123
116
  * @typedef GetPackageMaterialsParam
124
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
125
- */
126
- /**
127
- * @typedef GetSampleFileServiceabilityStatusParam
128
- * @property {number} [pageNo] - Index of the item to start returning with
129
- * @property {number} [pageSize] - Determines the items to be displayed in a page
130
- * @property {string} [batchId] - Batch id of the execution
131
- */
132
- /**
133
- * @typedef GetServiceabilityParam
134
- * @property {string} extensionId - Unique Identifier of courier partner extension.
135
- * @property {string} schemeId - Unique identifier of courier partner scheme.
136
- * @property {string} regionId - Unique identifier of a region
137
- */
138
- /**
139
- * @typedef GetZoneByIdParam
140
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
141
- */
142
- /**
143
- * @typedef GetZonesParam
144
- * @property {number} [pageNo] - Index of the item to start returning with
145
- * @property {number} [pageSize] - Determines the items to be displayed in a page
146
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
147
- * @property {string} [channelId] - Zones filtered by an application
148
- * @property {string} [q] - Search with name as a free text
149
- * @property {string} [countryIsoCode] - ISO2 code of the country
150
- * @property {string} [state] - State name
151
- * @property {string} [city] - City name
152
- * @property {string} [pincode] - Pincode value to search zones
153
- * @property {string} [sector] - Sector value to search zones
154
- */
155
- /**
156
- * @typedef SampleFileServiceabilityParam
157
- * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
117
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
118
+ * identifier for a Package Material
158
119
  */
159
120
  /**
160
121
  * @typedef UpdateCompanyConfigurationParam
161
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
122
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationShema} body
162
123
  */
163
124
  /**
164
- * @typedef UpdateCourierPartnerAccountParam
165
- * @property {string} accountId - Unique ID of courier partner account
166
- * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
125
+ * @typedef UpdateCompanySelfShipParam
126
+ * @property {ServiceabilityPlatformModel.CompanySelfShip} body
167
127
  */
168
128
  /**
169
- * @typedef UpdateCourierPartnerSchemeParam
170
- * @property {string} schemeId - Unique Identifier of Scheme
171
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
129
+ * @typedef UpdateCourierPartnerAccountParam
130
+ * @property {string} accountId - Unique ID of courier account
131
+ * @property {ServiceabilityPlatformModel.CourierAccount} body
172
132
  */
173
133
  /**
174
134
  * @typedef UpdatePackageMaterialRuleParam
175
135
  * @property {string} ruleId - A `package_material_rule_id` is a unique
176
136
  * identifier for a Package Material Rule
177
- * @property {ServiceabilityPlatformModel.PackageRule} body
137
+ * @property {ServiceabilityPlatformModel.PackageRuleRequest} body
178
138
  */
179
139
  /**
180
140
  * @typedef UpdatePackageMaterialsParam
181
- * @property {string} packageMaterialId - Unique identifier for a Package. Material
141
+ * @property {string} packageMaterialId - A `package_material_id` is a unique
142
+ * identifier for a Package Material
182
143
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
183
144
  */
184
145
  /**
185
- * @typedef UpdateServiceabilityParam
186
- * @property {string} extensionId - Unique Identifier of courier partner extension.
187
- * @property {string} schemeId - Unique identifier of courier partner scheme.
188
- * @property {string} regionId - Unique identifier of a region
189
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
190
- */
191
- /**
192
- * @typedef UpdateZoneByIdParam
193
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
194
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
146
+ * @typedef ValidateAddressParam
147
+ * @property {string} countryIsoCode - The ISO code of the country.
148
+ * @property {string} templateName - The type of address form.
149
+ * @property {ServiceabilityPlatformModel.ValidateAddressRequest} body
195
150
  */
196
151
  declare class ServiceabilityPlatformValidator {
197
- /** @returns {BulkServiceabilityParam} */
198
- static bulkServiceability(): BulkServiceabilityParam;
199
- /** @returns {BulkTatParam} */
200
- static bulkTat(): BulkTatParam;
201
152
  /** @returns {CreateCourierPartnerAccountParam} */
202
153
  static createCourierPartnerAccount(): CreateCourierPartnerAccountParam;
203
- /** @returns {CreateCourierPartnerSchemeParam} */
204
- static createCourierPartnerScheme(): CreateCourierPartnerSchemeParam;
205
154
  /** @returns {CreatePackageMaterialParam} */
206
155
  static createPackageMaterial(): CreatePackageMaterialParam;
207
156
  /** @returns {CreatePackageMaterialRuleParam} */
208
157
  static createPackageMaterialRule(): CreatePackageMaterialRuleParam;
209
- /** @returns {CreateZoneParam} */
210
- static createZone(): CreateZoneParam;
211
- /** @returns {GetAllStoresParam} */
212
- static getAllStores(): any;
213
- /** @returns {GetBulkServiceabilityParam} */
214
- static getBulkServiceability(): GetBulkServiceabilityParam;
215
- /** @returns {GetBulkTatParam} */
216
- static getBulkTat(): GetBulkTatParam;
217
158
  /** @returns {GetCompanyConfigurationParam} */
218
159
  static getCompanyConfiguration(): any;
160
+ /** @returns {GetCompanySelfShipParam} */
161
+ static getCompanySelfShip(): any;
219
162
  /** @returns {GetCountriesParam} */
220
163
  static getCountries(): GetCountriesParam;
164
+ /** @returns {GetCountryParam} */
165
+ static getCountry(): GetCountryParam;
221
166
  /** @returns {GetCourierPartnerAccountParam} */
222
167
  static getCourierPartnerAccount(): GetCourierPartnerAccountParam;
223
168
  /** @returns {GetCourierPartnerAccountsParam} */
224
169
  static getCourierPartnerAccounts(): GetCourierPartnerAccountsParam;
225
- /** @returns {GetCourierPartnerSchemeParam} */
226
- static getCourierPartnerScheme(): GetCourierPartnerSchemeParam;
227
- /** @returns {GetCourierPartnerSchemesParam} */
228
- static getCourierPartnerSchemes(): GetCourierPartnerSchemesParam;
170
+ /** @returns {GetInstalledCourierPartnerExtensionsParam} */
171
+ static getInstalledCourierPartnerExtensions(): GetInstalledCourierPartnerExtensionsParam;
172
+ /** @returns {GetListPackageMaterialRuleDetailsParam} */
173
+ static getListPackageMaterialRuleDetails(): GetListPackageMaterialRuleDetailsParam;
174
+ /** @returns {GetLocalitiesParam} */
175
+ static getLocalities(): GetLocalitiesParam;
176
+ /** @returns {GetLocalityParam} */
177
+ static getLocality(): GetLocalityParam;
229
178
  /** @returns {GetOptimalLocationsParam} */
230
179
  static getOptimalLocations(): GetOptimalLocationsParam;
231
180
  /** @returns {GetPackageMaterialListParam} */
232
181
  static getPackageMaterialList(): GetPackageMaterialListParam;
233
182
  /** @returns {GetPackageMaterialRuleParam} */
234
183
  static getPackageMaterialRule(): GetPackageMaterialRuleParam;
235
- /** @returns {GetPackageMaterialRulesParam} */
236
- static getPackageMaterialRules(): GetPackageMaterialRulesParam;
184
+ /** @returns {GetPackageMaterialRuleDetailsParam} */
185
+ static getPackageMaterialRuleDetails(): GetPackageMaterialRuleDetailsParam;
237
186
  /** @returns {GetPackageMaterialsParam} */
238
187
  static getPackageMaterials(): GetPackageMaterialsParam;
239
- /** @returns {GetSampleFileServiceabilityStatusParam} */
240
- static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
241
- /** @returns {GetServiceabilityParam} */
242
- static getServiceability(): GetServiceabilityParam;
243
- /** @returns {GetZoneByIdParam} */
244
- static getZoneById(): GetZoneByIdParam;
245
- /** @returns {GetZonesParam} */
246
- static getZones(): GetZonesParam;
247
- /** @returns {SampleFileServiceabilityParam} */
248
- static sampleFileServiceability(): SampleFileServiceabilityParam;
249
188
  /** @returns {UpdateCompanyConfigurationParam} */
250
189
  static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
190
+ /** @returns {UpdateCompanySelfShipParam} */
191
+ static updateCompanySelfShip(): UpdateCompanySelfShipParam;
251
192
  /** @returns {UpdateCourierPartnerAccountParam} */
252
193
  static updateCourierPartnerAccount(): UpdateCourierPartnerAccountParam;
253
- /** @returns {UpdateCourierPartnerSchemeParam} */
254
- static updateCourierPartnerScheme(): UpdateCourierPartnerSchemeParam;
255
194
  /** @returns {UpdatePackageMaterialRuleParam} */
256
195
  static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
257
196
  /** @returns {UpdatePackageMaterialsParam} */
258
197
  static updatePackageMaterials(): UpdatePackageMaterialsParam;
259
- /** @returns {UpdateServiceabilityParam} */
260
- static updateServiceability(): UpdateServiceabilityParam;
261
- /** @returns {UpdateZoneByIdParam} */
262
- static updateZoneById(): UpdateZoneByIdParam;
198
+ /** @returns {ValidateAddressParam} */
199
+ static validateAddress(): ValidateAddressParam;
263
200
  }
264
201
  declare namespace ServiceabilityPlatformValidator {
265
- export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
202
+ export { CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, GetCompanyConfigurationParam, GetCompanySelfShipParam, GetCountriesParam, GetCountryParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetInstalledCourierPartnerExtensionsParam, GetListPackageMaterialRuleDetailsParam, GetLocalitiesParam, GetLocalityParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRuleDetailsParam, GetPackageMaterialsParam, UpdateCompanyConfigurationParam, UpdateCompanySelfShipParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, ValidateAddressParam };
266
203
  }
267
- type BulkServiceabilityParam = {
204
+ type CreateCourierPartnerAccountParam = {
205
+ body: ServiceabilityPlatformModel.CourierAccount;
206
+ };
207
+ type CreatePackageMaterialParam = {
268
208
  /**
269
- * - Unique Identifier of courier partner extension.
209
+ * - Index of the item to start returning with
270
210
  */
271
- extensionId: string;
211
+ pageNo?: number;
212
+ body: ServiceabilityPlatformModel.PackageMaterial;
213
+ };
214
+ type CreatePackageMaterialRuleParam = {
215
+ body: ServiceabilityPlatformModel.PackageRuleRequest;
216
+ };
217
+ type GetCountriesParam = {
272
218
  /**
273
- * - Unique identifier of courier partner scheme.
219
+ * - Only fetch countries which allowed for
220
+ * onboard on Platform.
274
221
  */
275
- schemeId: string;
276
- body: ServiceabilityPlatformModel.BulkRegionJobDetails;
277
- };
278
- type BulkTatParam = {
222
+ onboard?: boolean;
279
223
  /**
280
- * - Unique Identifier of courier partner extension.
224
+ * - The page number to navigate through the given
225
+ * set of results. Default value is 1.
281
226
  */
282
- extensionId: string;
227
+ pageNo?: number;
283
228
  /**
284
- * - Unique identifier of courier partner scheme.
229
+ * - The number of items to retrieve in each page.
230
+ * Default value is 12
285
231
  */
286
- schemeId: string;
287
- body: ServiceabilityPlatformModel.BulkRegionJobDetails;
288
- };
289
- type CreateCourierPartnerAccountParam = {
290
- body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
291
- };
292
- type CreateCourierPartnerSchemeParam = {
293
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel;
294
- };
295
- type CreatePackageMaterialParam = {
296
- body: ServiceabilityPlatformModel.PackageMaterial;
297
- };
298
- type CreatePackageMaterialRuleParam = {
299
- body: ServiceabilityPlatformModel.PackageRule;
300
- };
301
- type CreateZoneParam = {
302
- body: ServiceabilityPlatformModel.CreateZoneData;
232
+ pageSize?: number;
233
+ /**
234
+ * - The search string to search in the list of countries by name.
235
+ */
236
+ q?: string;
237
+ /**
238
+ * - The search filter to filter countries based
239
+ * on their available hierarchy.
240
+ */
241
+ hierarchy?: string;
303
242
  };
304
- type GetBulkServiceabilityParam = {
243
+ type GetCountryParam = {
305
244
  /**
306
- * - Unique Identifier of courier partner extension.
245
+ * - The `country_iso_code` is ISO-2 (alpha-2)
246
+ * code for the country.
307
247
  */
308
- extensionId: string;
248
+ countryIsoCode: string;
249
+ };
250
+ type GetCourierPartnerAccountParam = {
309
251
  /**
310
- * - Unique identifier of courier partner scheme.
252
+ * - Unique ID of courier account
311
253
  */
312
- schemeId: string;
254
+ accountId: string;
255
+ };
256
+ type GetCourierPartnerAccountsParam = {
313
257
  /**
314
258
  * - Index of the item to start returning with
315
259
  */
@@ -319,43 +263,36 @@ type GetBulkServiceabilityParam = {
319
263
  */
320
264
  pageSize?: number;
321
265
  /**
322
- * - Unique identifier of bulk job
266
+ * - Stage of the account. enabled/disabled
323
267
  */
324
- batchId?: string;
268
+ stage?: string;
325
269
  /**
326
- * - Import or export bulk type
270
+ * - Filters dp accounts based on payment mode
327
271
  */
328
- action?: string;
272
+ paymentMode?: string;
329
273
  /**
330
- * - Status of the bulk actions
274
+ * - Filters dp accounts based on transport_type
331
275
  */
332
- status?: string;
276
+ transportType?: string;
333
277
  /**
334
- * - Country for which bulk job is initiated
278
+ * - Filters dp accounts based on their ids
335
279
  */
336
- country?: string;
280
+ accountIds?: string[];
337
281
  /**
338
- * - Region for which bulk job is initiated
282
+ * - To filter self ship/non self ship dp accounts
339
283
  */
340
- region?: string;
284
+ selfShip?: boolean;
341
285
  /**
342
- * - Fetch job history after a particule date
286
+ * - Filters seller owned or admin owned dp accounts
343
287
  */
344
- startDate?: string;
288
+ ownAccount?: boolean;
345
289
  /**
346
- * - Fetch job history before a particule date
290
+ * - Filters dp accounts based on case sensitive partial
291
+ * account name
347
292
  */
348
- endDate?: string;
293
+ q?: string;
349
294
  };
350
- type GetBulkTatParam = {
351
- /**
352
- * - Unique Identifier of courier partner extension.
353
- */
354
- extensionId: string;
355
- /**
356
- * - Unique identifier of courier partner scheme.
357
- */
358
- schemeId: string;
295
+ type GetInstalledCourierPartnerExtensionsParam = {
359
296
  /**
360
297
  * - Index of the item to start returning with
361
298
  */
@@ -365,40 +302,44 @@ type GetBulkTatParam = {
365
302
  */
366
303
  pageSize?: number;
367
304
  /**
368
- * - Unique identifier of bulk job
305
+ * - Filter to get installed extensions only
369
306
  */
370
- batchId?: string;
307
+ isInstalled?: string;
308
+ };
309
+ type GetListPackageMaterialRuleDetailsParam = {
371
310
  /**
372
- * - Import or export bulk type
311
+ * - Index of the item to start returning with
373
312
  */
374
- action?: string;
313
+ pageNo?: number;
375
314
  /**
376
- * - Status of the bulk actions
315
+ * - Determines the items to be displayed in a page
377
316
  */
378
- status?: string;
317
+ pageSize?: number;
379
318
  /**
380
- * - Country for which bulk job is initiated
319
+ * - Filters items based on given is_active
381
320
  */
382
- country?: string;
321
+ isActive?: string;
322
+ };
323
+ type GetLocalitiesParam = {
383
324
  /**
384
- * - Region for which bulk job is initiated
325
+ * - A `locality_type` contains unique
326
+ * geographical division.
385
327
  */
386
- region?: string;
328
+ localityType: string;
387
329
  /**
388
- * - Fetch job history after a particule date
330
+ * - A `country` contains a specific value of the
331
+ * country iso2 code.
389
332
  */
390
- startDate?: string;
333
+ country?: string;
391
334
  /**
392
- * - Fetch job history before a particule date
335
+ * - A `state` contains a specific value of the
336
+ * state, province.
393
337
  */
394
- endDate?: string;
395
- };
396
- type GetCountriesParam = {
338
+ state?: string;
397
339
  /**
398
- * - Only fetch countries which allowed for
399
- * onboard on Platform.
340
+ * - A `city` contains a specific value of the city.
400
341
  */
401
- onboarding?: boolean;
342
+ city?: string;
402
343
  /**
403
344
  * - Page number.
404
345
  */
@@ -412,67 +353,39 @@ type GetCountriesParam = {
412
353
  */
413
354
  q?: string;
414
355
  /**
415
- * - Fetch countries that has certain heirarchy present.
416
- */
417
- hierarchy?: string;
418
- };
419
- type GetCourierPartnerAccountParam = {
420
- /**
421
- * - Unique ID of courier partner account
422
- */
423
- accountId: string;
424
- };
425
- type GetCourierPartnerAccountsParam = {
426
- /**
427
- * - Index of the item to start returning with
428
- */
429
- pageNo?: number;
430
- /**
431
- * - Determines the items to be displayed in a page
432
- */
433
- pageSize?: number;
434
- /**
435
- * - Stage of the account. enabled/disabled
436
- */
437
- stage?: string;
438
- /**
439
- * - Filters dp accounts based on payment mode
440
- */
441
- paymentMode?: string;
442
- /**
443
- * - Filters dp accounts based on transport_type
356
+ * - Search for localities. Either provide a full name
357
+ * or a search term.
444
358
  */
445
- transportType?: string;
359
+ name?: string;
446
360
  };
447
- type GetCourierPartnerSchemeParam = {
361
+ type GetLocalityParam = {
448
362
  /**
449
- * - Unique Identifier of Scheme
363
+ * - A `locality_type` contains value
364
+ * geographical division.
450
365
  */
451
- schemeId: string;
452
- };
453
- type GetCourierPartnerSchemesParam = {
366
+ localityType: string;
454
367
  /**
455
- * - Indicates whether a scheme is created by an
456
- * admin for global purposes or customized for a specific company.
368
+ * - A `locality_value` contains a specific
369
+ * name of the locality.
457
370
  */
458
- schemeType?: string;
371
+ localityValue: string;
459
372
  /**
460
- * - Indicates payment mode for a scheme.
373
+ * - A `country` contains a specific value of the
374
+ * country iso2 code.
461
375
  */
462
- paymentMode?: string;
376
+ country?: string;
463
377
  /**
464
- * - Indicates whether the scheme possesses
465
- * certain capabilities.
378
+ * - A `state` contains a specific value of the
379
+ * state, province.
466
380
  */
467
- capabilities?: string[];
381
+ state?: string;
468
382
  /**
469
- * - List of scheme ids which need to be
470
- * returned in the response.
383
+ * - A `city` contains a specific value of the city.
471
384
  */
472
- schemeIds?: string[];
385
+ city?: string;
473
386
  };
474
387
  type GetOptimalLocationsParam = {
475
- body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
388
+ body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
476
389
  };
477
390
  type GetPackageMaterialListParam = {
478
391
  /**
@@ -503,7 +416,12 @@ type GetPackageMaterialRuleParam = {
503
416
  */
504
417
  ruleId: string;
505
418
  };
506
- type GetPackageMaterialRulesParam = {
419
+ type GetPackageMaterialRuleDetailsParam = {
420
+ /**
421
+ * - A `package_material_rule_id` is a unique
422
+ * identifier for a Package Material Rule
423
+ */
424
+ ruleId: string;
507
425
  /**
508
426
  * - Index of the item to start returning with
509
427
  */
@@ -519,105 +437,23 @@ type GetPackageMaterialRulesParam = {
519
437
  };
520
438
  type GetPackageMaterialsParam = {
521
439
  /**
522
- * - Unique identifier for a Package. Material
440
+ * - A `package_material_id` is a unique
441
+ * identifier for a Package Material
523
442
  */
524
443
  packageMaterialId: string;
525
444
  };
526
- type GetSampleFileServiceabilityStatusParam = {
527
- /**
528
- * - Index of the item to start returning with
529
- */
530
- pageNo?: number;
531
- /**
532
- * - Determines the items to be displayed in a page
533
- */
534
- pageSize?: number;
535
- /**
536
- * - Batch id of the execution
537
- */
538
- batchId?: string;
539
- };
540
- type GetServiceabilityParam = {
541
- /**
542
- * - Unique Identifier of courier partner extension.
543
- */
544
- extensionId: string;
545
- /**
546
- * - Unique identifier of courier partner scheme.
547
- */
548
- schemeId: string;
549
- /**
550
- * - Unique identifier of a region
551
- */
552
- regionId: string;
553
- };
554
- type GetZoneByIdParam = {
555
- /**
556
- * - A `zone_id` is a unique identifier for a particular zone.
557
- */
558
- zoneId: string;
559
- };
560
- type GetZonesParam = {
561
- /**
562
- * - Index of the item to start returning with
563
- */
564
- pageNo?: number;
565
- /**
566
- * - Determines the items to be displayed in a page
567
- */
568
- pageSize?: number;
569
- /**
570
- * - Status of Zone (either active or inactive)
571
- */
572
- isActive?: boolean;
573
- /**
574
- * - Zones filtered by an application
575
- */
576
- channelId?: string;
577
- /**
578
- * - Search with name as a free text
579
- */
580
- q?: string;
581
- /**
582
- * - ISO2 code of the country
583
- */
584
- countryIsoCode?: string;
585
- /**
586
- * - State name
587
- */
588
- state?: string;
589
- /**
590
- * - City name
591
- */
592
- city?: string;
593
- /**
594
- * - Pincode value to search zones
595
- */
596
- pincode?: string;
597
- /**
598
- * - Sector value to search zones
599
- */
600
- sector?: string;
601
- };
602
- type SampleFileServiceabilityParam = {
603
- body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
604
- };
605
445
  type UpdateCompanyConfigurationParam = {
606
- body: ServiceabilityPlatformModel.CompanyConfig;
446
+ body: ServiceabilityPlatformModel.CompanyConfigurationShema;
447
+ };
448
+ type UpdateCompanySelfShipParam = {
449
+ body: ServiceabilityPlatformModel.CompanySelfShip;
607
450
  };
608
451
  type UpdateCourierPartnerAccountParam = {
609
452
  /**
610
- * - Unique ID of courier partner account
453
+ * - Unique ID of courier account
611
454
  */
612
455
  accountId: string;
613
- body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
614
- };
615
- type UpdateCourierPartnerSchemeParam = {
616
- /**
617
- * - Unique Identifier of Scheme
618
- */
619
- schemeId: string;
620
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails;
456
+ body: ServiceabilityPlatformModel.CourierAccount;
621
457
  };
622
458
  type UpdatePackageMaterialRuleParam = {
623
459
  /**
@@ -625,37 +461,27 @@ type UpdatePackageMaterialRuleParam = {
625
461
  * identifier for a Package Material Rule
626
462
  */
627
463
  ruleId: string;
628
- body: ServiceabilityPlatformModel.PackageRule;
464
+ body: ServiceabilityPlatformModel.PackageRuleRequest;
629
465
  };
630
466
  type UpdatePackageMaterialsParam = {
631
467
  /**
632
- * - Unique identifier for a Package. Material
468
+ * - A `package_material_id` is a unique
469
+ * identifier for a Package Material
633
470
  */
634
471
  packageMaterialId: string;
635
472
  body: ServiceabilityPlatformModel.PackageMaterial;
636
473
  };
637
- type UpdateServiceabilityParam = {
638
- /**
639
- * - Unique Identifier of courier partner extension.
640
- */
641
- extensionId: string;
474
+ type ValidateAddressParam = {
642
475
  /**
643
- * - Unique identifier of courier partner scheme.
476
+ * - The ISO code of the country.
644
477
  */
645
- schemeId: string;
646
- /**
647
- * - Unique identifier of a region
648
- */
649
- regionId: string;
650
- body: ServiceabilityPlatformModel.ServiceabilityModel;
651
- };
652
- type UpdateZoneByIdParam = {
478
+ countryIsoCode: string;
653
479
  /**
654
- * - A `zone_id` is a unique identifier for a particular zone.
480
+ * - The type of address form.
655
481
  */
656
- zoneId: string;
657
- body: ServiceabilityPlatformModel.UpdateZoneData;
482
+ templateName: string;
483
+ body: ServiceabilityPlatformModel.ValidateAddressRequest;
658
484
  };
659
- type GetAllStoresParam = any;
660
485
  type GetCompanyConfigurationParam = any;
486
+ type GetCompanySelfShipParam = any;
661
487
  import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");