@gofynd/fdk-client-javascript 1.4.13 → 1.4.14

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 (294) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +60 -53
  6. package/sdk/application/Cart/CartApplicationClient.js +130 -53
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +489 -143
  8. package/sdk/application/Cart/CartApplicationModel.js +380 -159
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +38 -19
  10. package/sdk/application/Cart/CartApplicationValidator.js +34 -18
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +88 -68
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +114 -94
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +194 -142
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +171 -133
  15. package/sdk/application/Common/CommonApplicationClient.d.ts +3 -2
  16. package/sdk/application/Common/CommonApplicationClient.js +6 -5
  17. package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
  18. package/sdk/application/Common/CommonApplicationModel.js +6 -6
  19. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -27
  20. package/sdk/application/Configuration/ConfigurationApplicationClient.js +34 -27
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +45 -57
  22. package/sdk/application/Configuration/ConfigurationApplicationModel.js +35 -47
  23. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +23 -33
  26. package/sdk/application/Content/ContentApplicationClient.js +54 -75
  27. package/sdk/application/Content/ContentApplicationModel.d.ts +93 -37
  28. package/sdk/application/Content/ContentApplicationModel.js +83 -32
  29. package/sdk/application/Content/ContentApplicationValidator.d.ts +23 -17
  30. package/sdk/application/Content/ContentApplicationValidator.js +15 -10
  31. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -8
  32. package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -13
  33. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -25
  34. package/sdk/application/FileStorage/FileStorageApplicationModel.js +16 -18
  35. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
  36. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
  37. package/sdk/application/Finance/FinanceApplicationClient.d.ts +36 -0
  38. package/sdk/application/Finance/FinanceApplicationClient.js +202 -0
  39. package/sdk/application/Finance/FinanceApplicationModel.d.ts +289 -0
  40. package/sdk/application/Finance/FinanceApplicationModel.js +208 -0
  41. package/sdk/application/Finance/FinanceApplicationValidator.d.ts +25 -0
  42. package/sdk/application/Finance/FinanceApplicationValidator.js +31 -0
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +2 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
  46. package/sdk/application/Lead/LeadApplicationModel.js +19 -19
  47. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +39 -16
  48. package/sdk/application/Logistic/LogisticApplicationClient.js +189 -21
  49. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +532 -173
  50. package/sdk/application/Logistic/LogisticApplicationModel.js +409 -139
  51. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +54 -9
  52. package/sdk/application/Logistic/LogisticApplicationValidator.js +42 -8
  53. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -10
  54. package/sdk/application/Order/OrderApplicationClient.js +96 -13
  55. package/sdk/application/Order/OrderApplicationModel.d.ts +434 -102
  56. package/sdk/application/Order/OrderApplicationModel.js +278 -73
  57. package/sdk/application/Order/OrderApplicationValidator.d.ts +17 -3
  58. package/sdk/application/Order/OrderApplicationValidator.js +15 -2
  59. package/sdk/application/Payment/PaymentApplicationClient.d.ts +96 -99
  60. package/sdk/application/Payment/PaymentApplicationClient.js +111 -114
  61. package/sdk/application/Payment/PaymentApplicationModel.d.ts +293 -289
  62. package/sdk/application/Payment/PaymentApplicationModel.js +243 -241
  63. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
  64. package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
  65. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -16
  66. package/sdk/application/Rewards/RewardsApplicationClient.js +19 -22
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
  69. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
  70. package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
  71. package/sdk/application/Share/ShareApplicationModel.js +1 -1
  72. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  73. package/sdk/application/Theme/ThemeApplicationClient.js +8 -6
  74. package/sdk/application/Theme/ThemeApplicationModel.d.ts +48 -17
  75. package/sdk/application/Theme/ThemeApplicationModel.js +42 -22
  76. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +16 -3
  77. package/sdk/application/Theme/ThemeApplicationValidator.js +9 -2
  78. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  79. package/sdk/application/User/UserApplicationClient.js +10 -10
  80. package/sdk/application/User/UserApplicationModel.d.ts +17 -17
  81. package/sdk/application/User/UserApplicationModel.js +16 -16
  82. package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
  83. package/sdk/application/User/UserApplicationValidator.js +2 -2
  84. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  85. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
  86. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +11 -9
  87. package/sdk/application/Webhook/WebhookApplicationModel.js +8 -6
  88. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
  89. package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
  90. package/sdk/application/index.d.ts +1 -0
  91. package/sdk/application/index.js +2 -0
  92. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  93. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  94. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  95. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  96. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  97. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  98. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  99. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  100. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  101. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  102. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  103. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  104. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +767 -85
  105. package/sdk/partner/Logistics/LogisticsPartnerModel.js +429 -76
  106. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  107. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +120 -6
  108. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  109. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  110. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  111. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  112. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  113. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  114. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  115. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  116. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  117. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  118. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  119. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  120. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  121. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  122. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  124. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  125. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  126. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  127. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  128. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  129. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  130. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  131. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  132. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  133. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  134. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  135. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  136. package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
  137. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
  138. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
  139. package/sdk/platform/Cart/CartPlatformModel.d.ts +4978 -1303
  140. package/sdk/platform/Cart/CartPlatformModel.js +1922 -1217
  141. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +208 -183
  142. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +383 -358
  143. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +122 -126
  144. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +66 -68
  145. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +141 -118
  146. package/sdk/platform/Catalog/CatalogPlatformClient.js +193 -170
  147. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1516 -1766
  148. package/sdk/platform/Catalog/CatalogPlatformModel.js +1393 -1224
  149. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
  150. package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
  151. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  152. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  153. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  154. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  156. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  157. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  158. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  159. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  160. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  161. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  167. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  171. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  173. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  175. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  177. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  179. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  181. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  182. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  183. package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
  184. package/sdk/platform/Content/ContentPlatformModel.js +521 -390
  185. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  186. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  187. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  188. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  189. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  190. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  191. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  192. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  194. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  195. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  196. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  197. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  198. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  199. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  200. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  201. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  202. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  203. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  204. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  205. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  206. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  207. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +15 -4
  208. package/sdk/platform/Order/OrderPlatformApplicationClient.js +83 -5
  209. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +25 -4
  210. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  211. package/sdk/platform/Order/OrderPlatformClient.d.ts +178 -97
  212. package/sdk/platform/Order/OrderPlatformClient.js +589 -229
  213. package/sdk/platform/Order/OrderPlatformModel.d.ts +5447 -3071
  214. package/sdk/platform/Order/OrderPlatformModel.js +3496 -1653
  215. package/sdk/platform/Order/OrderPlatformValidator.d.ts +241 -176
  216. package/sdk/platform/Order/OrderPlatformValidator.js +153 -97
  217. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  218. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  219. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  220. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  221. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  222. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  223. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  224. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  225. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  226. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  227. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +327 -313
  228. package/sdk/platform/Payment/PaymentPlatformModel.js +283 -273
  229. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  230. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  231. package/sdk/platform/PlatformClient.d.ts +0 -2
  232. package/sdk/platform/PlatformClient.js +0 -4
  233. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  234. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  235. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  236. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  237. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  238. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  239. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +45 -35
  240. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +117 -38
  241. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +22 -13
  242. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +24 -12
  243. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
  244. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
  245. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +602 -341
  246. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +483 -284
  247. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
  248. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
  249. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  250. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  251. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  252. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  253. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  254. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  255. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  256. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  257. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  258. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  259. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  260. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  261. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  262. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  263. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  264. package/sdk/platform/User/UserPlatformModel.js +23 -23
  265. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  266. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  267. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  268. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  269. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  270. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  271. package/sdk/platform/index.d.ts +0 -1
  272. package/sdk/platform/index.js +0 -2
  273. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  274. package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
  275. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  276. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  277. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  278. package/sdk/public/Content/ContentPublicClient.js +791 -5
  279. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  280. package/sdk/public/Content/ContentPublicModel.js +649 -3
  281. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  282. package/sdk/public/Content/ContentPublicValidator.js +88 -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 +21 -21
  286. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  287. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  288. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  289. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  290. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  291. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  292. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  293. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  294. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -14,15 +14,13 @@ const OrderPlatformModel = require("./OrderPlatformModel");
14
14
 
15
15
  /**
16
16
  * @typedef BulkListingParam
17
- * @property {number} pageSize - The number of records to return per page in the response.
18
- * @property {number} pageNo - The page number to fetch from the paginated results.
19
- * @property {string} startDate - The start date for filtering the jobs,
20
- * expressed in UTC format
21
- * @property {string} endDate - The end date for filtering the jobs, expressed
22
- * in UTC format
23
- * @property {string} [status] - The status of the jobs to filter the results.
24
- * @property {string} [bulkActionType] - Pecifies the type of job action being requested.
25
- * @property {string} [searchKey] - A key or keyword used to search for specific jobs.
17
+ * @property {number} pageSize - Page size
18
+ * @property {number} pageNo - Page number
19
+ * @property {string} startDate - UTC start date in ISO format
20
+ * @property {string} endDate - UTC end date in ISO format
21
+ * @property {string} [status] - Status for which to fetch the jobs.
22
+ * @property {string} [bulkActionType] - Job type.
23
+ * @property {string} [searchKey] - Search_key.
26
24
  */
27
25
 
28
26
  /**
@@ -35,6 +33,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
35
33
  * @property {OrderPlatformModel.OrderStatus} body
36
34
  */
37
35
 
36
+ /**
37
+ * @typedef CreateChannelConfigParam
38
+ * @property {OrderPlatformModel.CreateChannelConfigData} body
39
+ */
40
+
38
41
  /**
39
42
  * @typedef CreateOrderParam
40
43
  * @property {OrderPlatformModel.CreateOrderAPI} body
@@ -52,7 +55,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
52
55
 
53
56
  /**
54
57
  * @typedef DownloadLanesReportParam
55
- * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
58
+ * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
56
59
  */
57
60
 
58
61
  /**
@@ -65,6 +68,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
65
68
  * @property {string} logId - Log Error ID
66
69
  */
67
70
 
71
+ /**
72
+ * @typedef FetchCreditBalanceDetailParam
73
+ * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
74
+ */
75
+
68
76
  /**
69
77
  * @typedef FetchRefundModeConfigParam
70
78
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
@@ -85,21 +93,21 @@ const OrderPlatformModel = require("./OrderPlatformModel");
85
93
 
86
94
  /**
87
95
  * @typedef GenerateProcessManifestParam
88
- * @property {OrderPlatformModel.ProcessManifestRequest} body
96
+ * @property {OrderPlatformModel.ProcessManifestRequestSchema} body
89
97
  */
90
98
 
91
99
  /**
92
100
  * @typedef GetAllowedStateTransitionParam
93
- * @property {string} orderingChannel - The channel through which orders are placed.
94
- * @property {string} status - The status key indicates the current status for
95
- * which the API will provide a list of possible next state transitions.
101
+ * @property {string} orderingChannel - Ordering channel
102
+ * @property {string} status - Current status of a shipment
96
103
  */
97
104
 
98
105
  /** @typedef GetAllowedTemplatesForBulkParam */
99
106
 
100
107
  /**
101
108
  * @typedef GetAnnouncementsParam
102
- * @property {string} [date] - Date On which the announcement is Active.
109
+ * @property {string} [date] - Date On which the announcement is Active (Date
110
+ * should in ISO Datetime format IST Time)
103
111
  */
104
112
 
105
113
  /**
@@ -128,8 +136,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
128
136
  * @typedef GetBulkShipmentExcelFileParam
129
137
  * @property {string} [salesChannels] - Comma separated values of sales channel ids
130
138
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
131
- * @property {string} [startDate] - UTC start date in ISO format
132
- * @property {string} [endDate] - UTC end date in ISO format
139
+ * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
140
+ * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
133
141
  * @property {string} [stores] - Comma separated values of store ids
134
142
  * @property {string} [tags] - Comma separated values of tags
135
143
  * @property {string} [bagStatus] - Comma separated values of bag statuses
@@ -140,12 +148,14 @@ const OrderPlatformModel = require("./OrderPlatformModel");
140
148
  * @property {number} [pageSize]
141
149
  */
142
150
 
151
+ /** @typedef GetChannelConfigParam */
152
+
143
153
  /**
144
154
  * @typedef GetFileByStatusParam
145
- * @property {string} batchId - Batch Id to identify the bulk operation request.
146
- * @property {string} status - The status of the jobs to filter the results.
147
- * @property {string} fileType - The type of file to be downloaded.
148
- * @property {string} [reportType] - The type of report to be downloaded.
155
+ * @property {string} batchId
156
+ * @property {string} status
157
+ * @property {string} fileType - It contains the type of file.
158
+ * @property {string} [reportType]
149
159
  */
150
160
 
151
161
  /**
@@ -161,40 +171,46 @@ const OrderPlatformModel = require("./OrderPlatformModel");
161
171
  * @property {string} [salesChannels]
162
172
  * @property {string} [paymentMode] - Comma separated values of payment modes
163
173
  * @property {string} [bagStatus] - Comma separated values of bag statuses
164
- * @property {string} [searchType]
174
+ * @property {string} [searchType] - Search_type refers to the field that will
175
+ * be used as the target for the search operation
165
176
  * @property {string} [searchValue]
166
177
  * @property {string} [tags]
167
- * @property {number} [timeToDispatch]
178
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
168
179
  * @property {string} [paymentMethods]
169
180
  * @property {boolean} [myOrders]
170
181
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
171
182
  * company order
172
- * @property {string} [orderType]
183
+ * @property {string} [orderType] - Defines the specific journey a shipment will
184
+ * follow based on the application's operational needs and customer
185
+ * preferences. This field categorizes orders into distinct types, each
186
+ * associated with a unique processing flow. For example:
187
+ *
188
+ * - "HomeDelivery": The order undergoes all state transitions typical for a
189
+ * delivery, from processing the shipment to final delivery at the
190
+ * customer's address.
191
+ * - "PickAtStore": The order is prepared for pickup and moved to a state where it
192
+ * is ready to be handed over directly to the customer at the store. This
193
+ * type streamlines the process by bypassing traditional shipping stages
194
+ * and facilitating a quicker transition to the final handover stage.
173
195
  */
174
196
 
175
197
  /**
176
198
  * @typedef GetManifestDetailsParam
177
- * @property {string} manifestId - The unique identifier assigned to the manifest.
178
- * @property {string} [dpIds] - Filter shipments with the specific Courier
179
- * partner Ids which is a combination of courier partner extension and scheme Ids.
180
- * @property {string} [endDate] - End date for the shipment search range in manifest.
181
- * @property {string} [startDate] - Start date for the shipment search range in manifest.
182
- * @property {number} [pageNo] - Page number for pagination.
183
- * @property {number} [pageSize] - Number of records per page for pagination.
199
+ * @property {string} manifestId
184
200
  */
185
201
 
186
202
  /**
187
203
  * @typedef GetManifestShipmentsParam
188
204
  * @property {string} dpIds - Filter shipments with the specific Courier partner
189
205
  * Ids which is a combination of courier partner extension and scheme Ids.
190
- * @property {number} stores - Filter results based on specific store IDs.
206
+ * @property {number} stores - Filter with the specific store.
191
207
  * @property {string} toDate - End date for the shipment search range.
192
208
  * @property {string} fromDate - Start date for the shipment search range.
193
- * @property {string} [dpName] - Filter results based on specific courier partner name.
194
- * @property {string} [salesChannels] - Filter results based on comma-separated
195
- * list of sales channels.
196
- * @property {string} [searchType] - Filter results based on search type.
197
- * @property {string} [searchValue] - Filter results based on the search value.
209
+ * @property {string} [dpName] - Filter with the specific courier partner name.
210
+ * @property {string} [salesChannels] - Comma-separated list of sales channels.
211
+ * @property {string} [searchType] - Type of search (e.g., by shipment ID, order
212
+ * ID, AWB number).
213
+ * @property {string} [searchValue] - Value to search for based on the search type.
198
214
  * @property {number} [pageNo] - Page number for pagination.
199
215
  * @property {number} [pageSize] - Number of records per page for pagination.
200
216
  */
@@ -206,20 +222,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
206
222
 
207
223
  /**
208
224
  * @typedef GetManifestsParam
209
- * @property {string} [status] - Filter for the status of manifests.
210
- * @property {string} [startDate] - The starting date for filtering manifests in
211
- * ISO format
212
- * @property {string} [endDate] - The end date for filtering manifests in ISO format
213
- * @property {string} [searchType] - Specifies the type of search to perform.
214
- * @property {number} [storeId] - Filter to fetch manifests for a specific store
215
- * by its ID.
216
- * @property {string} [searchValue] - The value to search for based on the
217
- * selected search type.
218
- * @property {string} [dpIds] - A comma-separated list of courier partner IDs
219
- * (DP IDs) to filter the manifests.
220
- * @property {number} [pageNo] - The number of the page to fetch data.
221
- * @property {number} [pageSize] - The number of records to return per page for
222
- * pagination.
225
+ * @property {string} [status] - Possible Status [ active, closed ]
226
+ * @property {string} [startDate] - UTC Start Date in ISO format
227
+ * @property {string} [endDate] - UTC End Date in ISO format
228
+ * @property {string} [searchType] - Search type options [ fynd_order_id,
229
+ * shipment_id, manifest_id, dp_name, awb_no ]
230
+ * @property {number} [storeId] - Fetch manifests for a Store.
231
+ * @property {string} [searchValue] - Search value for selected search type
232
+ * @property {string} [dpIds] - DP Ids separated by ',' (comma)
233
+ * @property {number} [pageNo]
234
+ * @property {number} [pageSize]
223
235
  */
224
236
 
225
237
  /**
@@ -243,10 +255,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
243
255
  * associated with the order
244
256
  * @property {string} [searchValue] - Search_value is matched against the field
245
257
  * specified by the search_type
246
- * @property {string} [fromDate]
247
- * @property {string} [toDate]
248
- * @property {string} [startDate]
249
- * @property {string} [endDate]
258
+ * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
259
+ * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
260
+ * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
261
+ * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
250
262
  * @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
251
263
  * @property {string} [stores]
252
264
  * @property {string} [salesChannels]
@@ -261,6 +273,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
261
273
  * @property {string} [orderType]
262
274
  * @property {boolean} [allowInactive] - Flag indicating whether inactive
263
275
  * shipments are allowed
276
+ * @property {string} [groupEntity] - Defines the grouping criterion for
277
+ * retrieving shipments or orders. It specifies whether the results should be
278
+ * organized based on shipment groups or order groups. For example, using
279
+ * 'shipments' groups results by shipment, while an invalid value like 'abcd'
280
+ * may not be recognized, leading to errors or default behavior.
264
281
  */
265
282
 
266
283
  /** @typedef GetRoleBasedActionsParam */
@@ -277,8 +294,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
277
294
 
278
295
  /**
279
296
  * @typedef GetShipmentHistoryParam
280
- * @property {string} [shipmentId] - Identifier for the shipment
281
- * @property {number} [bagId] - Identifier for a bag or product.
297
+ * @property {string} [shipmentId] - Shipment Id
298
+ * @property {number} [bagId] - Bag/Product Id
282
299
  */
283
300
 
284
301
  /**
@@ -297,8 +314,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
297
314
  * @property {string} [bagStatus] - Comma separated values of bag statuses
298
315
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
299
316
  * bag_status and override lane
300
- * @property {number} [timeToDispatch]
301
- * @property {string} [searchType] - Search type key
317
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
318
+ * @property {string} [searchType] - Search_type refers to the field that will
319
+ * be used as the target for the search operation
302
320
  * @property {string} [searchValue] - Search type value
303
321
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
304
322
  * @property {string} [toDate] - End Date in DD-MM-YYYY format
@@ -325,7 +343,24 @@ const OrderPlatformModel = require("./OrderPlatformModel");
325
343
  * company order
326
344
  * @property {string} [tags] - Comma separated values of tags
327
345
  * @property {string} [customerId]
328
- * @property {string} [orderType]
346
+ * @property {string} [orderType] - Defines the specific journey a shipment will
347
+ * follow based on the application's operational needs and customer
348
+ * preferences. This field categorizes orders into distinct types, each
349
+ * associated with a unique processing flow. For example:
350
+ *
351
+ * - "HomeDelivery": The order undergoes all state transitions typical for a
352
+ * delivery, from processing the shipment to final delivery at the
353
+ * customer's address.
354
+ * - "PickAtStore": The order is prepared for pickup and moved to a state where it
355
+ * is ready to be handed over directly to the customer at the store. This
356
+ * type streamlines the process by bypassing traditional shipping stages
357
+ * and facilitating a quicker transition to the final handover stage.
358
+ *
359
+ * @property {string} [groupEntity] - Defines the grouping criterion for
360
+ * retrieving shipments or orders. It specifies whether the results should be
361
+ * organized based on shipment groups or order groups. For example, using
362
+ * 'shipments' groups results by shipment, while an invalid value like 'abcd'
363
+ * may not be recognized, leading to errors or default behavior.
329
364
  */
330
365
 
331
366
  /**
@@ -355,8 +390,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
355
390
 
356
391
  /**
357
392
  * @typedef JobDetailsParam
358
- * @property {string} batchId - A unique identifier for the batch associated
359
- * with this bulk action.
393
+ * @property {string} batchId
360
394
  */
361
395
 
362
396
  /**
@@ -369,6 +403,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
369
403
  * @property {OrderPlatformModel.PostShipmentHistory} body
370
404
  */
371
405
 
406
+ /**
407
+ * @typedef ProcessManifestsParam
408
+ * @property {OrderPlatformModel.ProcessManifest} body
409
+ */
410
+
372
411
  /**
373
412
  * @typedef ReassignLocationParam
374
413
  * @property {OrderPlatformModel.StoreReassign} body
@@ -386,26 +425,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
386
425
 
387
426
  /**
388
427
  * @typedef TrackShipmentParam
389
- * @property {string} [shipmentId] - Unique identifier of a shipment on the platform.
428
+ * @property {string} [shipmentId] - Shipment ID
390
429
  * @property {string} [awb] - AWB number
391
- * @property {number} [pageNo] - Page number for pagination.
392
- * @property {number} [pageSize] - Number of records per page for pagination.
430
+ * @property {number} [pageNo] - Page number
431
+ * @property {number} [pageSize] - Page size
393
432
  */
394
433
 
395
434
  /**
396
435
  * @typedef UpdateAddressParam
397
- * @property {string} shipmentId
398
- * @property {string} [name]
399
- * @property {string} [address]
400
- * @property {string} [addressType]
401
- * @property {string} [pincode]
402
- * @property {string} [phone]
403
- * @property {string} [email]
404
- * @property {string} [landmark]
405
- * @property {string} addressCategory
406
- * @property {string} [city]
407
- * @property {string} [state]
408
- * @property {string} [country]
436
+ * @property {string} shipmentId - Unique shipment no. that is auto-generated
437
+ * @property {OrderPlatformModel.UpdateAddressRequestBody} body
409
438
  */
410
439
 
411
440
  /**
@@ -413,6 +442,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
413
442
  * @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
414
443
  */
415
444
 
445
+ /**
446
+ * @typedef UpdatePaymentInfoParam
447
+ * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
448
+ */
449
+
416
450
  /**
417
451
  * @typedef UpdateShipmentLockParam
418
452
  * @property {OrderPlatformModel.UpdateShipmentLockPayload} body
@@ -430,7 +464,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
430
464
 
431
465
  /**
432
466
  * @typedef UploadConsentsParam
433
- * @property {OrderPlatformModel.UploadManifestConsent} body
467
+ * @property {string} manifestId
468
+ * @property {OrderPlatformModel.UploadConsent} body
434
469
  */
435
470
 
436
471
  /**
@@ -480,6 +515,13 @@ class OrderPlatformValidator {
480
515
  }).required();
481
516
  }
482
517
 
518
+ /** @returns {CreateChannelConfigParam} */
519
+ static createChannelConfig() {
520
+ return Joi.object({
521
+ body: OrderPlatformModel.CreateChannelConfigData().required(),
522
+ }).required();
523
+ }
524
+
483
525
  /** @returns {CreateOrderParam} */
484
526
  static createOrder() {
485
527
  return Joi.object({
@@ -504,7 +546,7 @@ class OrderPlatformValidator {
504
546
  /** @returns {DownloadLanesReportParam} */
505
547
  static downloadLanesReport() {
506
548
  return Joi.object({
507
- body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
549
+ body: OrderPlatformModel.BulkReportsDownloadRequestSchema().required(),
508
550
  }).required();
509
551
  }
510
552
 
@@ -522,6 +564,13 @@ class OrderPlatformValidator {
522
564
  }).required();
523
565
  }
524
566
 
567
+ /** @returns {FetchCreditBalanceDetailParam} */
568
+ static fetchCreditBalanceDetail() {
569
+ return Joi.object({
570
+ body: OrderPlatformModel.FetchCreditBalanceRequestPayload().required(),
571
+ }).required();
572
+ }
573
+
525
574
  /** @returns {FetchRefundModeConfigParam} */
526
575
  static fetchRefundModeConfig() {
527
576
  return Joi.object({
@@ -549,7 +598,7 @@ class OrderPlatformValidator {
549
598
  /** @returns {GenerateProcessManifestParam} */
550
599
  static generateProcessManifest() {
551
600
  return Joi.object({
552
- body: OrderPlatformModel.ProcessManifestRequest().required(),
601
+ body: OrderPlatformModel.ProcessManifestRequestSchema().required(),
553
602
  }).required();
554
603
  }
555
604
 
@@ -620,6 +669,11 @@ class OrderPlatformValidator {
620
669
  }).required();
621
670
  }
622
671
 
672
+ /** @returns {GetChannelConfigParam} */
673
+ static getChannelConfig() {
674
+ return Joi.object({}).required();
675
+ }
676
+
623
677
  /** @returns {GetFileByStatusParam} */
624
678
  static getFileByStatus() {
625
679
  return Joi.object({
@@ -659,11 +713,6 @@ class OrderPlatformValidator {
659
713
  static getManifestDetails() {
660
714
  return Joi.object({
661
715
  manifestId: Joi.string().allow("").required(),
662
- dpIds: Joi.string().allow(""),
663
- endDate: Joi.string().allow(""),
664
- startDate: Joi.string().allow(""),
665
- pageNo: Joi.number(),
666
- pageSize: Joi.number(),
667
716
  }).required();
668
717
  }
669
718
 
@@ -740,6 +789,7 @@ class OrderPlatformValidator {
740
789
  customerId: Joi.string().allow(""),
741
790
  orderType: Joi.string().allow(""),
742
791
  allowInactive: Joi.boolean(),
792
+ groupEntity: Joi.string().allow(""),
743
793
  }).required();
744
794
  }
745
795
 
@@ -809,6 +859,7 @@ class OrderPlatformValidator {
809
859
  tags: Joi.string().allow(""),
810
860
  customerId: Joi.string().allow(""),
811
861
  orderType: Joi.string().allow(""),
862
+ groupEntity: Joi.string().allow(""),
812
863
  }).required();
813
864
  }
814
865
 
@@ -869,6 +920,13 @@ class OrderPlatformValidator {
869
920
  }).required();
870
921
  }
871
922
 
923
+ /** @returns {ProcessManifestsParam} */
924
+ static processManifests() {
925
+ return Joi.object({
926
+ body: OrderPlatformModel.ProcessManifest().required(),
927
+ }).required();
928
+ }
929
+
872
930
  /** @returns {ReassignLocationParam} */
873
931
  static reassignLocation() {
874
932
  return Joi.object({
@@ -904,17 +962,7 @@ class OrderPlatformValidator {
904
962
  static updateAddress() {
905
963
  return Joi.object({
906
964
  shipmentId: Joi.string().allow("").required(),
907
- name: Joi.string().allow(""),
908
- address: Joi.string().allow(""),
909
- addressType: Joi.string().allow(""),
910
- pincode: Joi.string().allow(""),
911
- phone: Joi.string().allow(""),
912
- email: Joi.string().allow(""),
913
- landmark: Joi.string().allow(""),
914
- addressCategory: Joi.string().allow("").required(),
915
- city: Joi.string().allow(""),
916
- state: Joi.string().allow(""),
917
- country: Joi.string().allow(""),
965
+ body: OrderPlatformModel.UpdateAddressRequestBody().required(),
918
966
  }).required();
919
967
  }
920
968
 
@@ -925,6 +973,13 @@ class OrderPlatformValidator {
925
973
  }).required();
926
974
  }
927
975
 
976
+ /** @returns {UpdatePaymentInfoParam} */
977
+ static updatePaymentInfo() {
978
+ return Joi.object({
979
+ body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
980
+ }).required();
981
+ }
982
+
928
983
  /** @returns {UpdateShipmentLockParam} */
929
984
  static updateShipmentLock() {
930
985
  return Joi.object({
@@ -949,7 +1004,8 @@ class OrderPlatformValidator {
949
1004
  /** @returns {UploadConsentsParam} */
950
1005
  static uploadConsents() {
951
1006
  return Joi.object({
952
- body: OrderPlatformModel.UploadManifestConsent().required(),
1007
+ manifestId: Joi.string().allow("").required(),
1008
+ body: OrderPlatformModel.UploadConsent().required(),
953
1009
  }).required();
954
1010
  }
955
1011
 
@@ -7,22 +7,24 @@ declare class Partner {
7
7
  * @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
8
8
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
- * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
10
+ * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
11
+ * Success response
11
12
  * @name addProxyPath
12
13
  * @summary: Create extension proxy
13
14
  * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
14
15
  */
15
- addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
16
+ addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
16
17
  /**
17
18
  * @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
18
19
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
19
20
  * @param {import("../PlatformAPIClient").Options} - Options
20
- * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
21
+ * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
22
+ * Success response
21
23
  * @name removeProxyPath
22
24
  * @summary: Remove extension proxy
23
25
  * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
24
26
  */
25
- removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
27
+ removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
26
28
  }
27
29
  import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
28
30
  import PartnerPlatformModel = require("./PartnerPlatformModel");
@@ -19,7 +19,8 @@ class Partner {
19
19
  * @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
20
20
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
- * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
22
+ * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
23
+ * Success response
23
24
  * @name addProxyPath
24
25
  * @summary: Create extension proxy
25
26
  * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
@@ -77,10 +78,10 @@ class Partner {
77
78
 
78
79
  const {
79
80
  error: res_error,
80
- } = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
81
- abortEarly: false,
82
- allowUnknown: true,
83
- });
81
+ } = PartnerPlatformModel.ExtensionProxyPathCreation().validate(
82
+ responseData,
83
+ { abortEarly: false, allowUnknown: true }
84
+ );
84
85
 
85
86
  if (res_error) {
86
87
  if (this.config.options.strictResponseCheck === true) {
@@ -100,7 +101,8 @@ class Partner {
100
101
  * @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
101
102
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
102
103
  * @param {import("../PlatformAPIClient").Options} - Options
103
- * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
104
+ * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
105
+ * Success response
104
106
  * @name removeProxyPath
105
107
  * @summary: Remove extension proxy
106
108
  * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
@@ -158,7 +160,7 @@ class Partner {
158
160
 
159
161
  const {
160
162
  error: res_error,
161
- } = PartnerPlatformModel.RemoveProxyResponse().validate(responseData, {
163
+ } = PartnerPlatformModel.ExtensionProxyPathDelete().validate(responseData, {
162
164
  abortEarly: false,
163
165
  allowUnknown: true,
164
166
  });
@@ -6,7 +6,7 @@ export = PartnerPlatformModel;
6
6
  * will be generated
7
7
  */
8
8
  /**
9
- * @typedef AddProxyResponse
9
+ * @typedef ExtensionProxyPathCreation
10
10
  * @property {string} [_id]
11
11
  * @property {string} [attached_path]
12
12
  * @property {string} [proxy_url]
@@ -17,7 +17,7 @@ export = PartnerPlatformModel;
17
17
  * @property {string} [modified_at]
18
18
  */
19
19
  /**
20
- * @typedef RemoveProxyResponse
20
+ * @typedef ExtensionProxyPathDelete
21
21
  * @property {string} [message]
22
22
  * @property {Object} [data]
23
23
  */
@@ -32,7 +32,7 @@ export = PartnerPlatformModel;
32
32
  declare class PartnerPlatformModel {
33
33
  }
34
34
  declare namespace PartnerPlatformModel {
35
- export { AddProxyReq, AddProxyResponse, RemoveProxyResponse, APIError };
35
+ export { AddProxyReq, ExtensionProxyPathCreation, ExtensionProxyPathDelete, APIError };
36
36
  }
37
37
  /** @returns {AddProxyReq} */
38
38
  declare function AddProxyReq(): AddProxyReq;
@@ -47,9 +47,9 @@ type AddProxyReq = {
47
47
  */
48
48
  proxy_url?: string;
49
49
  };
50
- /** @returns {AddProxyResponse} */
51
- declare function AddProxyResponse(): AddProxyResponse;
52
- type AddProxyResponse = {
50
+ /** @returns {ExtensionProxyPathCreation} */
51
+ declare function ExtensionProxyPathCreation(): ExtensionProxyPathCreation;
52
+ type ExtensionProxyPathCreation = {
53
53
  _id?: string;
54
54
  attached_path?: string;
55
55
  proxy_url?: string;
@@ -59,9 +59,9 @@ type AddProxyResponse = {
59
59
  created_at?: string;
60
60
  modified_at?: string;
61
61
  };
62
- /** @returns {RemoveProxyResponse} */
63
- declare function RemoveProxyResponse(): RemoveProxyResponse;
64
- type RemoveProxyResponse = {
62
+ /** @returns {ExtensionProxyPathDelete} */
63
+ declare function ExtensionProxyPathDelete(): ExtensionProxyPathDelete;
64
+ type ExtensionProxyPathDelete = {
65
65
  message?: string;
66
66
  data?: any;
67
67
  };
@@ -8,7 +8,7 @@ const Joi = require("joi");
8
8
  */
9
9
 
10
10
  /**
11
- * @typedef AddProxyResponse
11
+ * @typedef ExtensionProxyPathCreation
12
12
  * @property {string} [_id]
13
13
  * @property {string} [attached_path]
14
14
  * @property {string} [proxy_url]
@@ -20,7 +20,7 @@ const Joi = require("joi");
20
20
  */
21
21
 
22
22
  /**
23
- * @typedef RemoveProxyResponse
23
+ * @typedef ExtensionProxyPathDelete
24
24
  * @property {string} [message]
25
25
  * @property {Object} [data]
26
26
  */
@@ -43,8 +43,8 @@ class PartnerPlatformModel {
43
43
  });
44
44
  }
45
45
 
46
- /** @returns {AddProxyResponse} */
47
- static AddProxyResponse() {
46
+ /** @returns {ExtensionProxyPathCreation} */
47
+ static ExtensionProxyPathCreation() {
48
48
  return Joi.object({
49
49
  _id: Joi.string().allow(""),
50
50
  attached_path: Joi.string().allow(""),
@@ -57,11 +57,11 @@ class PartnerPlatformModel {
57
57
  });
58
58
  }
59
59
 
60
- /** @returns {RemoveProxyResponse} */
61
- static RemoveProxyResponse() {
60
+ /** @returns {ExtensionProxyPathDelete} */
61
+ static ExtensionProxyPathDelete() {
62
62
  return Joi.object({
63
63
  message: Joi.string().allow(""),
64
- data: Joi.any(),
64
+ data: Joi.object().pattern(/\S/, Joi.any()),
65
65
  });
66
66
  }
67
67
 
@@ -72,7 +72,7 @@ class PartnerPlatformModel {
72
72
  message: Joi.string().allow(""),
73
73
  info: Joi.string().allow(""),
74
74
  request_id: Joi.string().allow(""),
75
- meta: Joi.any(),
75
+ meta: Joi.object().pattern(/\S/, Joi.any()),
76
76
  });
77
77
  }
78
78
  }