@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

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 (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -3,287 +3,275 @@ declare class Configuration {
3
3
  constructor(config: any);
4
4
  config: any;
5
5
  /**
6
- * @param {Object} arg - Arg object.
7
- * @param {CreateApplicationRequest} arg.body
8
- * @returns {Promise<CreateAppResponse>} - Success response
6
+ * @param {ConfigurationPlatformValidator.CreateApplicationParam} arg - Arg object
7
+ * @param {import("../PlatformAPIClient").Options} - Options
8
+ * @returns {Promise<ConfigurationPlatformModel.CreateAppResponse>} - Success response
9
+ * @name createApplication
9
10
  * @summary: Create a new sales channel
10
- * @description: Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company.
11
+ * @description: Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
11
12
  */
12
- createApplication({ body }?: {
13
- body: CreateApplicationRequest;
14
- }): Promise<CreateAppResponse>;
13
+ createApplication({ body }?: ConfigurationPlatformValidator.CreateApplicationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.CreateAppResponse>;
15
14
  /**
16
- * @param {Object} arg - Arg object.
17
- * @param {number} [arg.pageNo] -
18
- * @param {number} [arg.pageSize] -
19
- * @param {string} [arg.q] - Search param by name or domain
20
- * @returns {Promise<ApplicationsResponse>} - Success response
15
+ * @param {ConfigurationPlatformValidator.GetApplicationsParam} arg - Arg object
16
+ * @param {import("../PlatformAPIClient").Options} - Options
17
+ * @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
18
+ * Success response
19
+ * @name getApplications
21
20
  * @summary: Get list of registered sales channels under company
22
- * @description: Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company.
21
+ * @description: Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
23
22
  */
24
- getApplications({ pageNo, pageSize, q }?: {
25
- pageNo?: number;
26
- pageSize?: number;
27
- q?: string;
28
- }): Promise<ApplicationsResponse>;
23
+ getApplications({ pageNo, pageSize, q }?: ConfigurationPlatformValidator.GetApplicationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.ApplicationsResponse>;
29
24
  /**
30
25
  * @param {Object} arg - Arg object.
31
26
  * @param {number} [arg.pageSize] -
32
27
  * @param {string} [arg.q] - Search param by name or domain
28
+ * @returns {Paginator<ConfigurationPlatformModel.ApplicationsResponse>}
33
29
  * @summary: Get list of registered sales channels under company
34
30
  * @description: Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company.
35
31
  */
36
32
  getApplicationsPaginator({ pageSize, q }?: {
37
33
  pageSize?: number;
38
34
  q?: string;
39
- }): Paginator;
35
+ }): Paginator<ConfigurationPlatformModel.ApplicationsResponse>;
36
+ /**
37
+ * @param {ConfigurationPlatformValidator.GetAvailableOptInsParam} arg - Arg object
38
+ * @param {import("../PlatformAPIClient").Options} - Options
39
+ * @returns {Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
40
+ * - Success response
41
+ *
42
+ * @name getAvailableOptIns
43
+ * @summary: Get all available integration opt-ins
44
+ * @description: Use this API to get a list of all available integrations in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
45
+ */
46
+ getAvailableOptIns({ pageNo, pageSize }?: ConfigurationPlatformValidator.GetAvailableOptInsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
40
47
  /**
41
48
  * @param {Object} arg - Arg object.
42
- * @param {number} [arg.pageNo] - The page number to navigate through the
43
- * given set of results. Default value is 1.
44
49
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
45
50
  * page. Default value is 10.
46
- * @returns {Promise<GetIntegrationsOptInsResponse>} - Success response
51
+ * @returns {Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
47
52
  * @summary: Get all available integration opt-ins
48
53
  * @description: Use this API to get a list of all available integrations in a company
49
54
  */
50
- getAvailableOptIns({ pageNo, pageSize }?: {
51
- pageNo?: number;
55
+ getAvailableOptInsPaginator({ pageSize }?: {
52
56
  pageSize?: number;
53
- }): Promise<GetIntegrationsOptInsResponse>;
57
+ }): Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
54
58
  /**
55
- * @param {Object} arg - Arg object.
56
- * @param {string} [arg.q] - Search text for brand name
57
- * @returns {Promise<BrandsByCompanyResponse>} - Success response
59
+ * @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
60
+ * @param {import("../PlatformAPIClient").Options} - Options
61
+ * @returns {Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>} -
62
+ * Success response
63
+ * @name getBrandsByCompany
58
64
  * @summary: Get brands by company.
59
- * @description: Use this API to get all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image.
65
+ * @description: Use this API to get all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
60
66
  */
61
- getBrandsByCompany({ q }?: {
62
- q?: string;
63
- }): Promise<BrandsByCompanyResponse>;
67
+ getBrandsByCompany({ q }?: ConfigurationPlatformValidator.GetBrandsByCompanyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>;
64
68
  /**
65
- * @param {Object} arg - Arg object.
66
- * @param {number} [arg.pageNo] - The page number to navigate through the
67
- * given set of results. Default value is 1.
68
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
69
- * page. Default value is 10.
70
- * @param {CompanyByBrandsRequest} arg.body
71
- * @returns {Promise<CompanyByBrandsResponse>} - Success response
69
+ * @param {ConfigurationPlatformValidator.GetCompanyByBrandsParam} arg - Arg object
70
+ * @param {import("../PlatformAPIClient").Options} - Options
71
+ * @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
72
+ * Success response
73
+ * @name getCompanyByBrands
72
74
  * @summary: Get company by brand uids
73
- * @description: Use this API to get a list of companies by the brands they deal
75
+ * @description: Use this API to get a list of companies by the brands they deal - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
74
76
  */
75
- getCompanyByBrands({ body, pageNo, pageSize }?: {
76
- pageNo?: number;
77
- pageSize?: number;
78
- body: CompanyByBrandsRequest;
79
- }): Promise<CompanyByBrandsResponse>;
77
+ getCompanyByBrands({ body, pageNo, pageSize }?: ConfigurationPlatformValidator.GetCompanyByBrandsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>;
80
78
  /**
81
79
  * @param {Object} arg - Arg object.
82
80
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
83
81
  * page. Default value is 10.
84
- * @param {CompanyByBrandsRequest} arg.body
82
+ * @param {ConfigurationPlatformModel.CompanyByBrandsRequest} arg.body
83
+ * @returns {Paginator<ConfigurationPlatformModel.CompanyByBrandsResponse>}
85
84
  * @summary: Get company by brand uids
86
85
  * @description: Use this API to get a list of companies by the brands they deal
87
86
  */
88
87
  getCompanyByBrandsPaginator({ pageSize, body }?: {
89
88
  pageSize?: number;
90
- body: CompanyByBrandsRequest;
91
- }): Paginator;
89
+ body: ConfigurationPlatformModel.CompanyByBrandsRequest;
90
+ }): Paginator<ConfigurationPlatformModel.CompanyByBrandsResponse>;
92
91
  /**
93
- * @param {Object} arg - Arg object.
94
- * @returns {Promise<CurrenciesResponse>} - Success response
92
+ * @param {ConfigurationPlatformValidator.GetCurrenciesParam} arg - Arg object
93
+ * @param {import("../PlatformAPIClient").Options} - Options
94
+ * @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
95
+ * Success response
96
+ * @name getCurrencies
95
97
  * @summary: Get all currencies
96
- * @description: Use this API to get a list of currencies allowed in the company. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
98
+ * @description: Use this API to get a list of currencies allowed in the company. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
97
99
  */
98
- getCurrencies({}?: any): Promise<CurrenciesResponse>;
100
+ getCurrencies({ headers }?: any): Promise<ConfigurationPlatformModel.CurrenciesResponse>;
99
101
  /**
100
- * @param {Object} arg - Arg object.
101
- * @param {DomainSuggestionsRequest} arg.body
102
- * @returns {Promise<DomainSuggestionsResponse>} - Success response
102
+ * @param {ConfigurationPlatformValidator.GetDomainAvailibilityParam} arg - Arg object
103
+ * @param {import("../PlatformAPIClient").Options} - Options
104
+ * @returns {Promise<ConfigurationPlatformModel.DomainSuggestionsResponse>}
105
+ * - Success response
106
+ *
107
+ * @name getDomainAvailibility
103
108
  * @summary: Check domain availability before linking to application
104
- * @description: Use this API to check the domain availability before linking it to application. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider.
109
+ * @description: Use this API to check the domain availability before linking it to application. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
105
110
  */
106
- getDomainAvailibility({ body }?: {
107
- body: DomainSuggestionsRequest;
108
- }): Promise<DomainSuggestionsResponse>;
111
+ getDomainAvailibility({ body }?: ConfigurationPlatformValidator.GetDomainAvailibilityParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.DomainSuggestionsResponse>;
109
112
  /**
110
- * @param {Object} arg - Arg object.
111
- * @param {number} arg.id - Integration id
112
- * @returns {Promise<Integration>} - Success response
113
+ * @param {ConfigurationPlatformValidator.GetIntegrationByIdParam} arg - Arg object
114
+ * @param {import("../PlatformAPIClient").Options} - Options
115
+ * @returns {Promise<ConfigurationPlatformModel.Integration>} - Success response
116
+ * @name getIntegrationById
113
117
  * @summary: Get integration data by its ID
114
- * @description: Use this API to fetch the details of an integration (such as Ginesys, SAP, etc.) using its ID
118
+ * @description: Use this API to fetch the details of an integration (such as Ginesys, SAP, etc.) using its ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
115
119
  */
116
- getIntegrationById({ id }?: {
117
- id: number;
118
- }): Promise<Integration>;
120
+ getIntegrationById({ id }?: ConfigurationPlatformValidator.GetIntegrationByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.Integration>;
119
121
  /**
120
- * @param {Object} arg - Arg object.
121
- * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
122
- * @param {string} arg.level - Integration level, `store` or `company`
123
- * @param {number} arg.uid - Unique identifier of integration level (store/company)
124
- * @returns {Promise<IntegrationLevel>} - Success response
122
+ * @param {ConfigurationPlatformValidator.GetIntegrationByLevelIdParam} arg
123
+ * - Arg object
124
+ *
125
+ * @param {import("../PlatformAPIClient").Options} - Options
126
+ * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
127
+ * @name getIntegrationByLevelId
125
128
  * @summary: Get integration config at a particular level (store/company)
126
- * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).
129
+ * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
127
130
  */
128
- getIntegrationByLevelId({ id, level, uid }?: {
129
- id: string;
130
- level: string;
131
- uid: number;
132
- }): Promise<IntegrationLevel>;
131
+ getIntegrationByLevelId({ id, level, uid }?: ConfigurationPlatformValidator.GetIntegrationByLevelIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.IntegrationLevel>;
133
132
  /**
134
- * @param {Object} arg - Arg object.
135
- * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
136
- * @param {string} arg.level - Store or company
137
- * @param {boolean} [arg.opted] - True means get the opted stores. False
138
- * means get the stores that aren't opted.
139
- * @param {boolean} [arg.checkPermission] - Filter on if permissions (for
140
- * inventory/order) are present
141
- * @returns {Promise<IntegrationConfigResponse>} - Success response
133
+ * @param {ConfigurationPlatformValidator.GetIntegrationLevelConfigParam} arg
134
+ * - Arg object
135
+ *
136
+ * @param {import("../PlatformAPIClient").Options} - Options
137
+ * @returns {Promise<ConfigurationPlatformModel.IntegrationConfigResponse>}
138
+ * - Success response
139
+ *
140
+ * @name getIntegrationLevelConfig
142
141
  * @summary: Get integration level config
143
- * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc.
142
+ * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
144
143
  */
145
- getIntegrationLevelConfig({ id, level, opted, checkPermission }?: {
146
- id: string;
147
- level: string;
148
- opted?: boolean;
149
- checkPermission?: boolean;
150
- }): Promise<IntegrationConfigResponse>;
144
+ getIntegrationLevelConfig({ id, level, opted, checkPermission }?: ConfigurationPlatformValidator.GetIntegrationLevelConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.IntegrationConfigResponse>;
151
145
  /**
152
- * @param {Object} arg - Arg object.
153
- * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
154
- * @param {string} arg.level - Integration level, `store` or `company`
155
- * @param {number} arg.uid - Unique identifier of integration level (store/company)
156
- * @returns {Promise<OptedStoreIntegration>} - Success response
146
+ * @param {ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam} arg
147
+ * - Arg object
148
+ *
149
+ * @param {import("../PlatformAPIClient").Options} - Options
150
+ * @returns {Promise<ConfigurationPlatformModel.OptedStoreIntegration>} -
151
+ * Success response
152
+ * @name getLevelActiveIntegrations
157
153
  * @summary: Check active integration at store
158
- * @description: Use this API to check if a store is already opted-in for any integration
154
+ * @description: Use this API to check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
159
155
  */
160
- getLevelActiveIntegrations({ id, level, uid }?: {
161
- id: string;
162
- level: string;
163
- uid: number;
164
- }): Promise<OptedStoreIntegration>;
156
+ getLevelActiveIntegrations({ id, level, uid }?: ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.OptedStoreIntegration>;
165
157
  /**
166
- * @param {Object} arg - Arg object.
167
- * @param {string} arg.id - Application Id
168
- * @returns {Promise<OptedApplicationResponse>} - Success response
158
+ * @param {ConfigurationPlatformValidator.GetOtherSellerApplicationByIdParam} arg
159
+ * - Arg object
160
+ *
161
+ * @param {import("../PlatformAPIClient").Options} - Options
162
+ * @returns {Promise<ConfigurationPlatformModel.OptedApplicationResponse>}
163
+ * - Success response
164
+ *
165
+ * @name getOtherSellerApplicationById
169
166
  * @summary: Get other seller's sales channel by ID
170
- * @description: Use application ID to fetch details of a seller application that was not created within the current company. but has opted for the current company's inventory
167
+ * @description: Use application ID to fetch details of a seller application that was not created within the current company. but has opted for the current company's inventory - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
171
168
  */
172
- getOtherSellerApplicationById({ id }?: {
173
- id: string;
174
- }): Promise<OptedApplicationResponse>;
169
+ getOtherSellerApplicationById({ id }?: ConfigurationPlatformValidator.GetOtherSellerApplicationByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.OptedApplicationResponse>;
175
170
  /**
176
- * @param {Object} arg - Arg object.
177
- * @param {number} [arg.pageNo] - The page number to navigate through the
178
- * given set of results. Default value is 1.
179
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
180
- * page. Default value is 10.
181
- * @returns {Promise<OtherSellerApplications>} - Success response
171
+ * @param {ConfigurationPlatformValidator.GetOtherSellerApplicationsParam} arg
172
+ * - Arg object
173
+ *
174
+ * @param {import("../PlatformAPIClient").Options} - Options
175
+ * @returns {Promise<ConfigurationPlatformModel.OtherSellerApplications>} -
176
+ * Success response
177
+ * @name getOtherSellerApplications
182
178
  * @summary: Get other seller sales channels
183
- * @description: Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory
179
+ * @description: Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
184
180
  */
185
- getOtherSellerApplications({ pageNo, pageSize }?: {
186
- pageNo?: number;
187
- pageSize?: number;
188
- }): Promise<OtherSellerApplications>;
181
+ getOtherSellerApplications({ pageNo, pageSize }?: ConfigurationPlatformValidator.GetOtherSellerApplicationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.OtherSellerApplications>;
189
182
  /**
190
183
  * @param {Object} arg - Arg object.
191
184
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
192
185
  * page. Default value is 10.
186
+ * @returns {Paginator<ConfigurationPlatformModel.OtherSellerApplications>}
193
187
  * @summary: Get other seller sales channels
194
188
  * @description: Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory
195
189
  */
196
190
  getOtherSellerApplicationsPaginator({ pageSize }?: {
197
191
  pageSize?: number;
198
- }): Paginator;
192
+ }): Paginator<ConfigurationPlatformModel.OtherSellerApplications>;
193
+ /**
194
+ * @param {ConfigurationPlatformValidator.GetSelectedOptInsParam} arg - Arg object
195
+ * @param {import("../PlatformAPIClient").Options} - Options
196
+ * @returns {Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
197
+ * - Success response
198
+ *
199
+ * @name getSelectedOptIns
200
+ * @summary: Get company/store level integration opt-ins
201
+ * @description: Use this API to get the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
202
+ */
203
+ getSelectedOptIns({ level, uid, pageNo, pageSize }?: ConfigurationPlatformValidator.GetSelectedOptInsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
199
204
  /**
200
205
  * @param {Object} arg - Arg object.
201
206
  * @param {string} arg.level - Store or company
202
207
  * @param {number} arg.uid - Unique identifier of the selected integration level.
203
- * @param {number} [arg.pageNo] - The page number to navigate through the
204
- * given set of results. Default value is 1.
205
208
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
206
209
  * page. Default value is 10.
207
- * @returns {Promise<GetIntegrationsOptInsResponse>} - Success response
210
+ * @returns {Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
208
211
  * @summary: Get company/store level integration opt-ins
209
212
  * @description: Use this API to get the store-level/company-level integrations configured in a company
210
213
  */
211
- getSelectedOptIns({ level, uid, pageNo, pageSize }?: {
214
+ getSelectedOptInsPaginator({ level, uid, pageSize }?: {
212
215
  level: string;
213
216
  uid: number;
214
- pageNo?: number;
215
217
  pageSize?: number;
216
- }): Promise<GetIntegrationsOptInsResponse>;
218
+ }): Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
217
219
  /**
218
- * @param {Object} arg - Arg object.
219
- * @param {number} [arg.pageNo] - The page number to navigate through the
220
- * given set of results. Default value is 1.
221
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
222
- * page. Default value is 10.
223
- * @param {StoreByBrandsRequest} arg.body
224
- * @returns {Promise<StoreByBrandsResponse>} - Success response
220
+ * @param {ConfigurationPlatformValidator.GetStoreByBrandsParam} arg - Arg object
221
+ * @param {import("../PlatformAPIClient").Options} - Options
222
+ * @returns {Promise<ConfigurationPlatformModel.StoreByBrandsResponse>} -
223
+ * Success response
224
+ * @name getStoreByBrands
225
225
  * @summary: Get stores by brand uids for the current company
226
- * @description: Use this API to get a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail.
226
+ * @description: Use this API to get a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
227
227
  */
228
- getStoreByBrands({ body, pageNo, pageSize }?: {
229
- pageNo?: number;
230
- pageSize?: number;
231
- body: StoreByBrandsRequest;
232
- }): Promise<StoreByBrandsResponse>;
228
+ getStoreByBrands({ body, pageNo, pageSize }?: ConfigurationPlatformValidator.GetStoreByBrandsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.StoreByBrandsResponse>;
233
229
  /**
234
230
  * @param {Object} arg - Arg object.
235
231
  * @param {number} [arg.pageSize] - The number of items to retrieve in each
236
232
  * page. Default value is 10.
237
- * @param {StoreByBrandsRequest} arg.body
233
+ * @param {ConfigurationPlatformModel.StoreByBrandsRequest} arg.body
234
+ * @returns {Paginator<ConfigurationPlatformModel.StoreByBrandsResponse>}
238
235
  * @summary: Get stores by brand uids for the current company
239
236
  * @description: Use this API to get a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail.
240
237
  */
241
238
  getStoreByBrandsPaginator({ pageSize, body }?: {
242
239
  pageSize?: number;
243
- body: StoreByBrandsRequest;
244
- }): Paginator;
240
+ body: ConfigurationPlatformModel.StoreByBrandsRequest;
241
+ }): Paginator<ConfigurationPlatformModel.StoreByBrandsResponse>;
245
242
  /**
246
- * @param {Object} arg - Arg object.
247
- * @param {string} arg.id - Alphanumeric ID allotted to an application
248
- * (sales channel website) created within a business account.
249
- * @param {OptOutInventory} arg.body
250
- * @returns {Promise<SuccessMessageResponse>} - Success response
243
+ * @param {ConfigurationPlatformValidator.OptOutFromApplicationParam} arg - Arg object
244
+ * @param {import("../PlatformAPIClient").Options} - Options
245
+ * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
246
+ * Success response
247
+ * @name optOutFromApplication
251
248
  * @summary: Opt-out company or store from other seller application
252
- * @description: Use this API to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store.
249
+ * @description: Use this API to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
253
250
  */
254
- optOutFromApplication({ id, body }?: {
255
- id: string;
256
- body: OptOutInventory;
257
- }): Promise<SuccessMessageResponse>;
251
+ optOutFromApplication({ id, body }?: ConfigurationPlatformValidator.OptOutFromApplicationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
258
252
  /**
259
- * @param {Object} arg - Arg object.
260
- * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
261
- * @param {string} arg.level - Integration level, `store` or `company`
262
- * @param {UpdateIntegrationLevelRequest} arg.body
263
- * @returns {Promise<IntegrationLevel>} - Success response
253
+ * @param {ConfigurationPlatformValidator.UpdateLevelIntegrationParam} arg
254
+ * - Arg object
255
+ *
256
+ * @param {import("../PlatformAPIClient").Options} - Options
257
+ * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
258
+ * @name updateLevelIntegration
264
259
  * @summary: Update a store level integration you opted
265
- * @description: Use this API to update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).
260
+ * @description: Use this API to update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelIntegration/).
266
261
  */
267
- updateLevelIntegration({ id, level, body }?: {
268
- id: string;
269
- level: string;
270
- body: UpdateIntegrationLevelRequest;
271
- }): Promise<IntegrationLevel>;
262
+ updateLevelIntegration({ id, level, body }?: ConfigurationPlatformValidator.UpdateLevelIntegrationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.IntegrationLevel>;
272
263
  /**
273
- * @param {Object} arg - Arg object.
274
- * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
275
- * @param {string} arg.level - Integration level, `store` or `company`
276
- * @param {number} arg.uid - Unique identifier of integration level (store/company)
277
- * @param {IntegrationLevel} arg.body
278
- * @returns {Promise<IntegrationLevel>} - Success response
264
+ * @param {ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam} arg
265
+ * - Arg object
266
+ *
267
+ * @param {import("../PlatformAPIClient").Options} - Options
268
+ * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
269
+ * @name updateLevelUidIntegration
279
270
  * @summary: Update integration level by store UID
280
- * @description: Update the level of integration by store UID
271
+ * @description: Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
281
272
  */
282
- updateLevelUidIntegration({ id, level, uid, body }?: {
283
- id: string;
284
- level: string;
285
- uid: number;
286
- body: IntegrationLevel;
287
- }): Promise<IntegrationLevel>;
273
+ updateLevelUidIntegration({ id, level, uid, body }?: ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<ConfigurationPlatformModel.IntegrationLevel>;
288
274
  }
275
+ import ConfigurationPlatformValidator = require("./ConfigurationPlatformValidator");
276
+ import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
289
277
  import Paginator = require("../../common/Paginator");