@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -4,25 +4,33 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
4
4
 
5
5
  /**
6
6
  * @typedef BulkServiceabilityParam
7
- * @property {string} extensionId - Unique Identifier of CP Extension
8
- * @property {string} schemeId - Unique identifier of a scheme
9
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
7
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
8
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
9
+ * or modify scheme details.
10
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
10
11
  */
11
12
 
12
13
  /**
13
14
  * @typedef BulkTatParam
14
- * @property {string} extensionId - Unique Identifier of CP Extension
15
- * @property {string} schemeId - Unique identifier of a scheme
16
- * @property {ServiceabilityPlatformModel.BulkRegionJobSerializer} body
15
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
16
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
17
+ * or modify scheme details.
18
+ * @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
17
19
  */
18
20
 
19
21
  /**
20
22
  * @typedef CreateCourierPartnerAccountParam
21
- * @property {ServiceabilityPlatformModel.CourierAccountRequestBody} body
23
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
24
+ */
25
+
26
+ /**
27
+ * @typedef CreateCourierPartnerSchemeParam
28
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel} body
22
29
  */
23
30
 
24
31
  /**
25
32
  * @typedef CreatePackageMaterialParam
33
+ * @property {number} [pageNo] - The current page number for paginated results.
26
34
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
27
35
  */
28
36
 
@@ -31,18 +39,12 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
31
39
  * @property {ServiceabilityPlatformModel.PackageRule} body
32
40
  */
33
41
 
34
- /**
35
- * @typedef CreateZoneParam
36
- * @property {ServiceabilityPlatformModel.CreateZoneData} body
37
- */
38
-
39
- /** @typedef GetAllStoresParam */
40
-
41
42
  /**
42
43
  * @typedef GetBulkServiceabilityParam
43
- * @property {string} extensionId - Unique Identifier of CP Extension
44
- * @property {string} schemeId - Unique identifier of a scheme
45
- * @property {number} [pageNo] - Index of the item to start returning with
44
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
45
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
46
+ * or modify scheme details.
47
+ * @property {number} [pageNo] - The current page number for paginated results.
46
48
  * @property {number} [pageSize] - Determines the items to be displayed in a page
47
49
  * @property {string} [batchId] - Unique identifier of bulk job
48
50
  * @property {string} [action] - Import or export bulk type
@@ -55,9 +57,10 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
55
57
 
56
58
  /**
57
59
  * @typedef GetBulkTatParam
58
- * @property {string} extensionId - Unique Identifier of CP Extension
59
- * @property {string} schemeId - Unique identifier of a scheme
60
- * @property {number} [pageNo] - Index of the item to start returning with
60
+ * @property {string} extensionId - Unique Identifier of courier partner extension.
61
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
62
+ * or modify scheme details.
63
+ * @property {number} [pageNo] - The current page number for paginated results.
61
64
  * @property {number} [pageSize] - Determines the items to be displayed in a page
62
65
  * @property {string} [batchId] - Unique identifier of bulk job
63
66
  * @property {string} [action] - Import or export bulk type
@@ -70,6 +73,24 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
70
73
 
71
74
  /** @typedef GetCompanyConfigurationParam */
72
75
 
76
+ /**
77
+ * @typedef GetCompanyCourierPartnersListParam
78
+ * @property {ServiceabilityPlatformModel.CourierPartnerDetails} body
79
+ */
80
+
81
+ /**
82
+ * @typedef GetCountriesParam
83
+ * @property {boolean} [onboard] - Only fetch countries which allowed for
84
+ * onboard on Platform.
85
+ * @property {number} [pageNo] - The page number to navigate through the given
86
+ * set of results. Default value is 1.
87
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
88
+ * Default value is 12
89
+ * @property {string} [q] - The search string to search in the list of countries by name.
90
+ * @property {string} [hierarchy] - The search filter to filter countries based
91
+ * on their available hierarchy.
92
+ */
93
+
73
94
  /**
74
95
  * @typedef GetCourierPartnerAccountParam
75
96
  * @property {string} accountId - Unique ID of courier account
@@ -77,11 +98,43 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
77
98
 
78
99
  /**
79
100
  * @typedef GetCourierPartnerAccountsParam
80
- * @property {number} [pageNo] - Index of the item to start returning with
101
+ * @property {number} [pageNo] - The current page number for paginated results.
81
102
  * @property {number} [pageSize] - Determines the items to be displayed in a page
82
- * @property {string} [stage] - Stage of the account. enabled/disabled
103
+ * @property {string} [stage] - Stage of the account.
83
104
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
84
105
  * @property {string} [transportType] - Filters dp accounts based on transport_type
106
+ * @property {string[]} [accountIds] - Filters dp accounts based on their ids
107
+ * @property {boolean} [selfShip] - To filter self ship/non self ship dp accounts
108
+ * @property {boolean} [ownAccount] - Filters seller owned or Fynd Managed dp accounts
109
+ * @property {string} [q] - Filters dp accounts based on case sensitive partial
110
+ * account name
111
+ */
112
+
113
+ /**
114
+ * @typedef GetCourierPartnerSchemeParam
115
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
116
+ * or modify scheme details.
117
+ */
118
+
119
+ /**
120
+ * @typedef GetCourierPartnerSchemesParam
121
+ * @property {string} [extensionId] - Unique Identifier of courier partner extension.
122
+ * @property {string} [schemeType] - Indicates whether a scheme is created by an
123
+ * admin for global purposes or customized for a specific company.
124
+ * @property {string} [paymentMode] - Indicates payment mode for a scheme.
125
+ * @property {string[]} [capabilities] - Indicates whether the scheme possesses
126
+ * certain capabilities.
127
+ * @property {string[]} [schemeIds] - List of scheme ids which need to be
128
+ * returned in the response.
129
+ * @property {string} [q] - The search string to search in the list of courier
130
+ * partners schemes by name.
131
+ */
132
+
133
+ /**
134
+ * @typedef GetInstalledCourierPartnerExtensionsParam
135
+ * @property {number} [pageNo] - The current page number for paginated results.
136
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
137
+ * @property {string} [isInstalled] - Filter to get installed extensions only
85
138
  */
86
139
 
87
140
  /**
@@ -91,9 +144,10 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
91
144
 
92
145
  /**
93
146
  * @typedef GetPackageMaterialListParam
94
- * @property {number} [pageNo] - Index of the item to start returning with
147
+ * @property {number} [pageNo] - The current page number for paginated results.
95
148
  * @property {number} [pageSize] - Determines the items to be displayed in a page
96
- * @property {string} [q] - Perform regex search on items matching name for given value
149
+ * @property {string} [q] - Used to search for matching results based on the
150
+ * provided input.
97
151
  * @property {string} [size] - Filters items based on given size
98
152
  * @property {string} [packageType] - Filters items based on given package_type
99
153
  */
@@ -104,13 +158,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
104
158
  * identifier for a Package Material Rule
105
159
  */
106
160
 
107
- /**
108
- * @typedef GetPackageMaterialRulesParam
109
- * @property {number} [pageNo] - Index of the item to start returning with
110
- * @property {number} [pageSize] - Determines the items to be displayed in a page
111
- * @property {string} [isActive] - Filters items based on given is_active
112
- */
113
-
114
161
  /**
115
162
  * @typedef GetPackageMaterialsParam
116
163
  * @property {string} packageMaterialId - A `package_material_id` is a unique
@@ -118,40 +165,36 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
118
165
  */
119
166
 
120
167
  /**
121
- * @typedef GetServiceabilityParam
122
- * @property {string} extensionId - Unique Identifier of CP Extension
123
- * @property {string} schemeId - Unique identifier of a scheme
124
- * @property {string} regionId - Unique identifier of a region
168
+ * @typedef GetSampleFileServiceabilityStatusParam
169
+ * @property {number} [pageNo] - The current page number for paginated results.
170
+ * @property {number} [pageSize] - Determines the items to be displayed in a page
171
+ * @property {string} [batchId] - Batch id of the execution
125
172
  */
126
173
 
127
- /**
128
- * @typedef GetZoneByIdParam
129
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
130
- */
174
+ /** @typedef GetSelfShipDetailsParam */
131
175
 
132
176
  /**
133
- * @typedef GetZonesParam
134
- * @property {number} [pageNo] - Index of the item to start returning with
135
- * @property {number} [pageSize] - Determines the items to be displayed in a page
136
- * @property {boolean} [isActive] - Status of Zone (either active or inactive)
137
- * @property {string} [applicationIds] - Zones filtered by applications
138
- * @property {string} [q] - Search with name as a free text
139
- * @property {string} [countryIsoCode] - ISO2 code of the country
140
- * @property {string} [state] - State name
141
- * @property {string} [city] - City name
142
- * @property {string} [pincode] - Pincode value to search zones
143
- * @property {string} [sector] - Sector value to search zones
177
+ * @typedef SampleFileServiceabilityParam
178
+ * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
144
179
  */
145
180
 
146
181
  /**
147
182
  * @typedef UpdateCompanyConfigurationParam
148
- * @property {ServiceabilityPlatformModel.CompanyConfig} body
183
+ * @property {string} fulfillmentOptionSlug - Slug representing the fulfillment option.
184
+ * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
149
185
  */
150
186
 
151
187
  /**
152
188
  * @typedef UpdateCourierPartnerAccountParam
153
189
  * @property {string} accountId - Unique ID of courier account
154
- * @property {ServiceabilityPlatformModel.CourierAccount} body
190
+ * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
191
+ */
192
+
193
+ /**
194
+ * @typedef UpdateCourierPartnerSchemeParam
195
+ * @property {string} schemeId - Unique identifier for the scheme, used to fetch
196
+ * or modify scheme details.
197
+ * @property {ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema} body
155
198
  */
156
199
 
157
200
  /**
@@ -169,17 +212,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
169
212
  */
170
213
 
171
214
  /**
172
- * @typedef UpdateServiceabilityParam
173
- * @property {string} extensionId - Unique Identifier of CP Extension
174
- * @property {string} schemeId - Unique identifier of a scheme
175
- * @property {string} regionId - Unique identifier of a region
176
- * @property {ServiceabilityPlatformModel.ServiceabilityModel} body
177
- */
178
-
179
- /**
180
- * @typedef UpdateZoneByIdParam
181
- * @property {string} zoneId - A `zone_id` is a unique identifier for a particular zone.
182
- * @property {ServiceabilityPlatformModel.UpdateZoneData} body
215
+ * @typedef UpdateSelfShipDetailsParam
216
+ * @property {ServiceabilityPlatformModel.SelfshipSchema} body
183
217
  */
184
218
 
185
219
  class ServiceabilityPlatformValidator {
@@ -188,7 +222,7 @@ class ServiceabilityPlatformValidator {
188
222
  return Joi.object({
189
223
  extensionId: Joi.string().allow("").required(),
190
224
  schemeId: Joi.string().allow("").required(),
191
- body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
225
+ body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
192
226
  }).required();
193
227
  }
194
228
 
@@ -197,20 +231,28 @@ class ServiceabilityPlatformValidator {
197
231
  return Joi.object({
198
232
  extensionId: Joi.string().allow("").required(),
199
233
  schemeId: Joi.string().allow("").required(),
200
- body: ServiceabilityPlatformModel.BulkRegionJobSerializer().required(),
234
+ body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
201
235
  }).required();
202
236
  }
203
237
 
204
238
  /** @returns {CreateCourierPartnerAccountParam} */
205
239
  static createCourierPartnerAccount() {
206
240
  return Joi.object({
207
- body: ServiceabilityPlatformModel.CourierAccountRequestBody().required(),
241
+ body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
242
+ }).required();
243
+ }
244
+
245
+ /** @returns {CreateCourierPartnerSchemeParam} */
246
+ static createCourierPartnerScheme() {
247
+ return Joi.object({
248
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeDetailsModel().required(),
208
249
  }).required();
209
250
  }
210
251
 
211
252
  /** @returns {CreatePackageMaterialParam} */
212
253
  static createPackageMaterial() {
213
254
  return Joi.object({
255
+ pageNo: Joi.number(),
214
256
  body: ServiceabilityPlatformModel.PackageMaterial().required(),
215
257
  }).required();
216
258
  }
@@ -222,18 +264,6 @@ class ServiceabilityPlatformValidator {
222
264
  }).required();
223
265
  }
224
266
 
225
- /** @returns {CreateZoneParam} */
226
- static createZone() {
227
- return Joi.object({
228
- body: ServiceabilityPlatformModel.CreateZoneData().required(),
229
- }).required();
230
- }
231
-
232
- /** @returns {GetAllStoresParam} */
233
- static getAllStores() {
234
- return Joi.object({}).required();
235
- }
236
-
237
267
  /** @returns {GetBulkServiceabilityParam} */
238
268
  static getBulkServiceability() {
239
269
  return Joi.object({
@@ -243,7 +273,7 @@ class ServiceabilityPlatformValidator {
243
273
  pageSize: Joi.number(),
244
274
  batchId: Joi.string().allow(""),
245
275
  action: Joi.string().allow(""),
246
- status: Joi.string().allow(""),
276
+ status: Joi.string().allow("").allow(null),
247
277
  country: Joi.string().allow(""),
248
278
  region: Joi.string().allow(""),
249
279
  startDate: Joi.string().allow(""),
@@ -260,7 +290,7 @@ class ServiceabilityPlatformValidator {
260
290
  pageSize: Joi.number(),
261
291
  batchId: Joi.string().allow(""),
262
292
  action: Joi.string().allow(""),
263
- status: Joi.string().allow(""),
293
+ status: Joi.string().allow("").allow(null),
264
294
  country: Joi.string().allow(""),
265
295
  region: Joi.string().allow(""),
266
296
  startDate: Joi.string().allow(""),
@@ -273,6 +303,24 @@ class ServiceabilityPlatformValidator {
273
303
  return Joi.object({}).required();
274
304
  }
275
305
 
306
+ /** @returns {GetCompanyCourierPartnersListParam} */
307
+ static getCompanyCourierPartnersList() {
308
+ return Joi.object({
309
+ body: ServiceabilityPlatformModel.CourierPartnerDetails().required(),
310
+ }).required();
311
+ }
312
+
313
+ /** @returns {GetCountriesParam} */
314
+ static getCountries() {
315
+ return Joi.object({
316
+ onboard: Joi.boolean(),
317
+ pageNo: Joi.number(),
318
+ pageSize: Joi.number(),
319
+ q: Joi.string().allow(""),
320
+ hierarchy: Joi.string().allow(""),
321
+ }).required();
322
+ }
323
+
276
324
  /** @returns {GetCourierPartnerAccountParam} */
277
325
  static getCourierPartnerAccount() {
278
326
  return Joi.object({
@@ -288,6 +336,38 @@ class ServiceabilityPlatformValidator {
288
336
  stage: Joi.string().allow(""),
289
337
  paymentMode: Joi.string().allow(""),
290
338
  transportType: Joi.string().allow(""),
339
+ accountIds: Joi.array().items(Joi.string().allow("")),
340
+ selfShip: Joi.boolean(),
341
+ ownAccount: Joi.boolean(),
342
+ q: Joi.string().allow(""),
343
+ }).required();
344
+ }
345
+
346
+ /** @returns {GetCourierPartnerSchemeParam} */
347
+ static getCourierPartnerScheme() {
348
+ return Joi.object({
349
+ schemeId: Joi.string().allow("").required(),
350
+ }).required();
351
+ }
352
+
353
+ /** @returns {GetCourierPartnerSchemesParam} */
354
+ static getCourierPartnerSchemes() {
355
+ return Joi.object({
356
+ extensionId: Joi.string().allow(""),
357
+ schemeType: Joi.string().allow(""),
358
+ paymentMode: Joi.string().allow(""),
359
+ capabilities: Joi.array().items(Joi.string().allow("")),
360
+ schemeIds: Joi.array().items(Joi.string().allow("")),
361
+ q: Joi.string().allow(""),
362
+ }).required();
363
+ }
364
+
365
+ /** @returns {GetInstalledCourierPartnerExtensionsParam} */
366
+ static getInstalledCourierPartnerExtensions() {
367
+ return Joi.object({
368
+ pageNo: Joi.number(),
369
+ pageSize: Joi.number(),
370
+ isInstalled: Joi.string().allow(""),
291
371
  }).required();
292
372
  }
293
373
 
@@ -316,15 +396,6 @@ class ServiceabilityPlatformValidator {
316
396
  }).required();
317
397
  }
318
398
 
319
- /** @returns {GetPackageMaterialRulesParam} */
320
- static getPackageMaterialRules() {
321
- return Joi.object({
322
- pageNo: Joi.number(),
323
- pageSize: Joi.number(),
324
- isActive: Joi.string().allow(""),
325
- }).required();
326
- }
327
-
328
399
  /** @returns {GetPackageMaterialsParam} */
329
400
  static getPackageMaterials() {
330
401
  return Joi.object({
@@ -332,42 +403,32 @@ class ServiceabilityPlatformValidator {
332
403
  }).required();
333
404
  }
334
405
 
335
- /** @returns {GetServiceabilityParam} */
336
- static getServiceability() {
406
+ /** @returns {GetSampleFileServiceabilityStatusParam} */
407
+ static getSampleFileServiceabilityStatus() {
337
408
  return Joi.object({
338
- extensionId: Joi.string().allow("").required(),
339
- schemeId: Joi.string().allow("").required(),
340
- regionId: Joi.string().allow("").required(),
409
+ pageNo: Joi.number(),
410
+ pageSize: Joi.number(),
411
+ batchId: Joi.string().allow(""),
341
412
  }).required();
342
413
  }
343
414
 
344
- /** @returns {GetZoneByIdParam} */
345
- static getZoneById() {
346
- return Joi.object({
347
- zoneId: Joi.string().allow("").required(),
348
- }).required();
415
+ /** @returns {GetSelfShipDetailsParam} */
416
+ static getSelfShipDetails() {
417
+ return Joi.object({}).required();
349
418
  }
350
419
 
351
- /** @returns {GetZonesParam} */
352
- static getZones() {
420
+ /** @returns {SampleFileServiceabilityParam} */
421
+ static sampleFileServiceability() {
353
422
  return Joi.object({
354
- pageNo: Joi.number(),
355
- pageSize: Joi.number(),
356
- isActive: Joi.boolean(),
357
- applicationIds: Joi.string().allow(""),
358
- q: Joi.string().allow(""),
359
- countryIsoCode: Joi.string().allow(""),
360
- state: Joi.string().allow(""),
361
- city: Joi.string().allow(""),
362
- pincode: Joi.string().allow(""),
363
- sector: Joi.string().allow(""),
423
+ body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails().required(),
364
424
  }).required();
365
425
  }
366
426
 
367
427
  /** @returns {UpdateCompanyConfigurationParam} */
368
428
  static updateCompanyConfiguration() {
369
429
  return Joi.object({
370
- body: ServiceabilityPlatformModel.CompanyConfig().required(),
430
+ fulfillmentOptionSlug: Joi.string().allow("").required(),
431
+ body: ServiceabilityPlatformModel.CompanyConfigurationSchema().required(),
371
432
  }).required();
372
433
  }
373
434
 
@@ -375,7 +436,15 @@ class ServiceabilityPlatformValidator {
375
436
  static updateCourierPartnerAccount() {
376
437
  return Joi.object({
377
438
  accountId: Joi.string().allow("").required(),
378
- body: ServiceabilityPlatformModel.CourierAccount().required(),
439
+ body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
440
+ }).required();
441
+ }
442
+
443
+ /** @returns {UpdateCourierPartnerSchemeParam} */
444
+ static updateCourierPartnerScheme() {
445
+ return Joi.object({
446
+ schemeId: Joi.string().allow("").required(),
447
+ body: ServiceabilityPlatformModel.CourierPartnerSchemeUpdateDetailsSchema().required(),
379
448
  }).required();
380
449
  }
381
450
 
@@ -395,21 +464,10 @@ class ServiceabilityPlatformValidator {
395
464
  }).required();
396
465
  }
397
466
 
398
- /** @returns {UpdateServiceabilityParam} */
399
- static updateServiceability() {
400
- return Joi.object({
401
- extensionId: Joi.string().allow("").required(),
402
- schemeId: Joi.string().allow("").required(),
403
- regionId: Joi.string().allow("").required(),
404
- body: ServiceabilityPlatformModel.ServiceabilityModel().required(),
405
- }).required();
406
- }
407
-
408
- /** @returns {UpdateZoneByIdParam} */
409
- static updateZoneById() {
467
+ /** @returns {UpdateSelfShipDetailsParam} */
468
+ static updateSelfShipDetails() {
410
469
  return Joi.object({
411
- zoneId: Joi.string().allow("").required(),
412
- body: ServiceabilityPlatformModel.UpdateZoneData().required(),
470
+ body: ServiceabilityPlatformModel.SelfshipSchema().required(),
413
471
  }).required();
414
472
  }
415
473
  }
@@ -10,7 +10,7 @@ declare class Share {
10
10
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
11
11
  * @name createShortLink
12
12
  * @summary: Create short link
13
- * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
13
+ * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/createShortLink/).
14
14
  */
15
15
  createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
16
16
  /**
@@ -20,7 +20,7 @@ declare class Share {
20
20
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
21
21
  * @name getShortLinkByHash
22
22
  * @summary: Get short link by hash
23
- * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
23
+ * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkByHash/).
24
24
  */
25
25
  getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
26
26
  /**
@@ -29,12 +29,12 @@ declare class Share {
29
29
  *
30
30
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
31
31
  * @param {import("../PlatformAPIClient").Options} - Options
32
- * @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
32
+ * @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
33
33
  * @name getShortLinkClickStats
34
34
  * @summary: Get short link click statistics
35
- * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
35
+ * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkClickStats/).
36
36
  */
37
- getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResponse>;
37
+ getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResult>;
38
38
  /**
39
39
  * @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
40
40
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -42,7 +42,7 @@ declare class Share {
42
42
  * @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
43
43
  * @name getShortLinks
44
44
  * @summary: Get short links
45
- * @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
45
+ * @description: Retrieve a list of all generated short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinks/).
46
46
  */
47
47
  getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
48
48
  /**
@@ -54,7 +54,7 @@ declare class Share {
54
54
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
55
55
  * @name updateShortLinkById
56
56
  * @summary: Update short link
57
- * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
57
+ * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/updateShortLinkById/).
58
58
  */
59
59
  updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
60
60
  }
@@ -22,7 +22,7 @@ class Share {
22
22
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
23
23
  * @name createShortLink
24
24
  * @summary: Create short link
25
- * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
25
+ * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/createShortLink/).
26
26
  */
27
27
  async createShortLink(
28
28
  { body, requestHeaders } = { requestHeaders: {} },
@@ -101,7 +101,7 @@ class Share {
101
101
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
102
102
  * @name getShortLinkByHash
103
103
  * @summary: Get short link by hash
104
- * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
104
+ * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkByHash/).
105
105
  */
106
106
  async getShortLinkByHash(
107
107
  { hash, requestHeaders } = { requestHeaders: {} },
@@ -179,10 +179,10 @@ class Share {
179
179
  *
180
180
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
181
181
  * @param {import("../PlatformAPIClient").Options} - Options
182
- * @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
182
+ * @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
183
183
  * @name getShortLinkClickStats
184
184
  * @summary: Get short link click statistics
185
- * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
185
+ * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkClickStats/).
186
186
  */
187
187
  async getShortLinkClickStats(
188
188
  { surlId, requestHeaders } = { requestHeaders: {} },
@@ -232,7 +232,7 @@ class Share {
232
232
 
233
233
  const {
234
234
  error: res_error,
235
- } = SharePlatformModel.ClickStatsResponse().validate(responseData, {
235
+ } = SharePlatformModel.ClickStatsResult().validate(responseData, {
236
236
  abortEarly: false,
237
237
  allowUnknown: true,
238
238
  });
@@ -258,7 +258,7 @@ class Share {
258
258
  * @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
259
259
  * @name getShortLinks
260
260
  * @summary: Get short links
261
- * @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
261
+ * @description: Retrieve a list of all generated short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinks/).
262
262
  */
263
263
  async getShortLinks(
264
264
  {
@@ -367,7 +367,7 @@ class Share {
367
367
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
368
368
  * @name updateShortLinkById
369
369
  * @summary: Update short link
370
- * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
370
+ * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/updateShortLinkById/).
371
371
  */
372
372
  async updateShortLinkById(
373
373
  { id, body, requestHeaders } = { requestHeaders: {} },