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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (298) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
  6. package/sdk/application/Cart/CartApplicationClient.js +270 -139
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +197 -36
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  20. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  26. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  32. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  33. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  34. package/sdk/application/User/UserApplicationClient.js +9 -57
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  37. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  41. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  42. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  43. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  44. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  45. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  46. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  47. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  48. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  56. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  58. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  59. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  63. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  65. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  66. package/sdk/partner/PartnerClient.d.ts +6 -0
  67. package/sdk/partner/PartnerClient.js +9 -0
  68. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  69. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  70. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  71. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  72. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  73. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  74. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  75. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  76. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  77. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  78. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  79. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  80. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  81. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  82. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -612
  83. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -234
  84. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  85. package/sdk/partner/index.d.ts +3 -0
  86. package/sdk/partner/index.js +6 -0
  87. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  88. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  89. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  90. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  95. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  97. package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
  98. package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
  99. package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
  100. package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
  102. package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
  104. package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
  105. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  106. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  107. package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
  108. package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
  111. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
  112. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
  113. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
  114. package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
  115. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
  116. package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
  117. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
  118. package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
  119. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  120. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  121. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  122. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
  125. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  126. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  127. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  128. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
  131. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  132. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  137. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
  138. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  141. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  142. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  143. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  144. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  145. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
  146. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
  147. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  148. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  149. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
  150. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
  151. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  152. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  153. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  154. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  155. package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
  156. package/sdk/platform/Content/ContentPlatformModel.js +893 -582
  157. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  158. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  159. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  160. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  161. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  162. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  163. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  164. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  167. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  168. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  169. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  170. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  171. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  172. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  173. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  174. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  175. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  176. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  177. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  178. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  179. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  180. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  181. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  182. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  183. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  184. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  185. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  186. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  187. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  188. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  189. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  190. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  191. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  192. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  193. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  194. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  195. package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
  196. package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
  197. package/sdk/platform/Order/OrderPlatformModel.d.ts +4111 -9093
  198. package/sdk/platform/Order/OrderPlatformModel.js +3202 -4230
  199. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  200. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  201. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  202. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  203. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  204. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  205. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  206. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  207. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  208. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  209. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  210. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  211. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
  212. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
  213. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  214. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  215. package/sdk/platform/PlatformClient.d.ts +2 -0
  216. package/sdk/platform/PlatformClient.js +4 -0
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  220. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  221. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  222. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
  231. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
  232. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
  233. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  234. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  235. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  236. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  237. package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
  238. package/sdk/platform/Share/SharePlatformModel.js +3 -43
  239. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
  240. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
  241. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
  242. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
  243. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  244. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  245. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  246. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  247. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  248. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  249. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +22 -12
  250. package/sdk/platform/User/UserPlatformApplicationClient.js +91 -12
  251. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -3
  252. package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -2
  253. package/sdk/platform/User/UserPlatformModel.d.ts +223 -59
  254. package/sdk/platform/User/UserPlatformModel.js +204 -65
  255. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  256. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  257. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +434 -758
  258. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -410
  259. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  260. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  261. package/sdk/platform/index.d.ts +1 -0
  262. package/sdk/platform/index.js +2 -0
  263. package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
  264. package/sdk/public/Billing/BillingPublicClient.js +397 -0
  265. package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
  266. package/sdk/public/Billing/BillingPublicModel.js +560 -0
  267. package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
  268. package/sdk/public/Billing/BillingPublicValidator.js +50 -0
  269. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  270. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  271. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  272. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  273. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  274. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  275. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  276. package/sdk/public/Content/ContentPublicClient.js +183 -0
  277. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  278. package/sdk/public/Content/ContentPublicModel.js +47 -1
  279. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  280. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  281. package/sdk/public/PublicClient.d.ts +2 -2
  282. package/sdk/public/PublicClient.js +2 -2
  283. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  284. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  285. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  286. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  287. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  288. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  289. package/sdk/public/index.d.ts +1 -1
  290. package/sdk/public/index.js +1 -1
  291. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  292. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  293. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  294. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  295. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  296. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  297. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  298. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -4,53 +4,29 @@ declare class Communication {
4
4
  config: any;
5
5
  applicationId: any;
6
6
  /**
7
- * @param {CommunicationPlatformApplicationValidator.CreateAudienceParam} arg
7
+ * @param {CommunicationPlatformApplicationValidator.CreateAppPushtokenParam} arg
8
8
  * - Arg object
9
9
  *
10
10
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
11
11
  * @param {import("../PlatformAPIClient").Options} - Options
12
- * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
13
- * @name createAudience
14
- * @summary: Create an audience
15
- * @description: Creates a new email audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
12
+ * @returns {Promise<CommunicationPlatformModel.PushtokenRes>} - Success response
13
+ * @name createAppPushtoken
14
+ * @summary: Create app push token.
15
+ * @description: Create the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAppPushtoken/).
16
16
  */
17
- createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
17
+ createAppPushtoken({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAppPushtokenParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.PushtokenRes>;
18
18
  /**
19
- * @param {CommunicationPlatformApplicationValidator.CreateBigQueryHeadersParam} arg
20
- * - Arg object
21
- *
22
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
23
- * @param {import("../PlatformAPIClient").Options} - Options
24
- * @returns {Promise<Object>} - Success response
25
- * @name createBigQueryHeaders
26
- * @summary: Create BigQuery headers
27
- * @description: Create BigQuery headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
28
- */
29
- createBigQueryHeaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
30
- /**
31
- * @param {CommunicationPlatformApplicationValidator.CreateBigQueryNCountParam} arg
32
- * - Arg object
33
- *
34
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
35
- * @param {import("../PlatformAPIClient").Options} - Options
36
- * @returns {Promise<Object>} - Success response
37
- * @name createBigQueryNCount
38
- * @summary: Create BigQuery N-count
39
- * @description: Creates big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
40
- */
41
- createBigQueryNCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
42
- /**
43
- * @param {CommunicationPlatformApplicationValidator.CreateBigQueryRowCountParam} arg
19
+ * @param {CommunicationPlatformApplicationValidator.CreateAudienceParam} arg
44
20
  * - Arg object
45
21
  *
46
22
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
47
23
  * @param {import("../PlatformAPIClient").Options} - Options
48
- * @returns {Promise<Object>} - Success response
49
- * @name createBigQueryRowCount
50
- * @summary: Create a BigQuery row count
51
- * @description: Creates big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
24
+ * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
25
+ * @name createAudience
26
+ * @summary: Create audience.
27
+ * @description: Add audience which is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
52
28
  */
53
- createBigQueryRowCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
29
+ createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
54
30
  /**
55
31
  * @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
56
32
  * - Arg object
@@ -59,8 +35,8 @@ declare class Communication {
59
35
  * @param {import("../PlatformAPIClient").Options} - Options
60
36
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
61
37
  * @name createCampaign
62
- * @summary: Create a campaign
63
- * @description: Creates a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
38
+ * @summary: Create campaign.
39
+ * @description: Add a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
64
40
  */
65
41
  createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
66
42
  /**
@@ -71,8 +47,8 @@ declare class Communication {
71
47
  * @param {import("../PlatformAPIClient").Options} - Options
72
48
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
73
49
  * @name createEmailProvider
74
- * @summary: Create an email provider
75
- * @description: Creates a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
50
+ * @summary: Create email provider.
51
+ * @description: Generate and add a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
76
52
  */
77
53
  createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
78
54
  /**
@@ -83,8 +59,8 @@ declare class Communication {
83
59
  * @param {import("../PlatformAPIClient").Options} - Options
84
60
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
85
61
  * @name createEmailTemplate
86
- * @summary: Creat an email template
87
- * @description: Creates a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
62
+ * @summary: Create email template.
63
+ * @description: Generate and add a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
88
64
  */
89
65
  createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
90
66
  /**
@@ -93,14 +69,14 @@ declare class Communication {
93
69
  *
94
70
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
95
71
  * @param {import("../PlatformAPIClient").Options} - Options
96
- * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
72
+ * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
97
73
  * - Success response
98
74
  *
99
75
  * @name createEventSubscriptions
100
- * @summary: Create an event subscription
101
- * @description: Creates a new event subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
76
+ * @summary: Create event subscriptions
77
+ * @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
102
78
  */
103
- createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
79
+ createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>;
104
80
  /**
105
81
  * @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg
106
82
  * - Arg object
@@ -108,23 +84,23 @@ declare class Communication {
108
84
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
109
85
  * @param {import("../PlatformAPIClient").Options} - Options
110
86
  * @returns {Promise<
111
- * CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]
87
+ * CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]
112
88
  * >}
113
89
  * - Success response
114
90
  *
115
91
  * @name createEventSubscriptionsByBulk
116
- * @summary: Create event subscriptions in bulk
117
- * @description: Creates a new event subscription in bulk. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
92
+ * @summary: Create event subscriptions by bulk
93
+ * @description: Create event subscriptions by bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
118
94
  */
119
- createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]>;
95
+ createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]>;
120
96
  /**
121
97
  * @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object
122
98
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
123
99
  * @param {import("../PlatformAPIClient").Options} - Options
124
100
  * @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
125
101
  * @name createJobs
126
- * @summary: Create a campaign jobs
127
- * @description: Creates a new campaign job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createJobs/).
102
+ * @summary: Create jobs
103
+ * @description: Create jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createJobs/).
128
104
  */
129
105
  createJobs({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateJobsRes>;
130
106
  /**
@@ -133,12 +109,12 @@ declare class Communication {
133
109
  *
134
110
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
135
111
  * @param {import("../PlatformAPIClient").Options} - Options
136
- * @returns {Promise<Object>} - Success response
112
+ * @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
137
113
  * @name createSmsProvider
138
- * @summary: Create SMS provider
139
- * @description: Creates a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
114
+ * @summary: Create SMS provider.
115
+ * @description: Add a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
140
116
  */
141
- createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
117
+ createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProvider>;
142
118
  /**
143
119
  * @param {CommunicationPlatformApplicationValidator.CreateSmsTemplateParam} arg
144
120
  * - Arg object
@@ -147,8 +123,8 @@ declare class Communication {
147
123
  * @param {import("../PlatformAPIClient").Options} - Options
148
124
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
149
125
  * @name createSmsTemplate
150
- * @summary: Create a SMS template
151
- * @description: Creates a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
126
+ * @summary: Create SMS template.
127
+ * @description: Add a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
152
128
  */
153
129
  createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
154
130
  /**
@@ -157,86 +133,98 @@ declare class Communication {
157
133
  *
158
134
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
159
135
  * @param {import("../PlatformAPIClient").Options} - Options
160
- * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
136
+ * @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
161
137
  * @name deleteAudienceById
162
- * @summary: Delete an audience
163
- * @description: Remove a specific audience permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
138
+ * @summary: Delete audience by ID.
139
+ * @description: Remove a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
164
140
  */
165
- deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
141
+ deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
142
+ /**
143
+ * @param {CommunicationPlatformApplicationValidator.DeleteCampaignByIdParam} arg
144
+ * - Arg object
145
+ *
146
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
147
+ * @param {import("../PlatformAPIClient").Options} - Options
148
+ * @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
149
+ * @name deleteCampaignById
150
+ * @summary: Update campaign by ID.
151
+ * @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteCampaignById/).
152
+ */
153
+ deleteCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
166
154
  /**
167
155
  * @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg
168
156
  * - Arg object
169
157
  *
170
158
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
171
159
  * @param {import("../PlatformAPIClient").Options} - Options
172
- * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
160
+ * @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
173
161
  * @name deleteEmailProviderById
174
- * @summary: Delete an email provider
175
- * @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
162
+ * @summary: Delete email provider by ID.
163
+ * @description: Remove a specific email communication provider from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
176
164
  */
177
- deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
165
+ deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
178
166
  /**
179
167
  * @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg
180
168
  * - Arg object
181
169
  *
182
170
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
183
171
  * @param {import("../PlatformAPIClient").Options} - Options
184
- * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
172
+ * @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
185
173
  * @name deleteEmailTemplateById
186
- * @summary: Delete an email template
187
- * @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
174
+ * @summary: Delete email template by ID.
175
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Remove a specific email communication template by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
188
176
  */
189
- deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
177
+ deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
190
178
  /**
191
179
  * @param {CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam} arg
192
180
  * - Arg object
193
181
  *
194
182
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
195
183
  * @param {import("../PlatformAPIClient").Options} - Options
196
- * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
184
+ * @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
197
185
  * @name deleteEventSubscriptionsById
198
- * @summary: Delete an event subscriptions
199
- * @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEventSubscriptionsById/).
186
+ * @summary: Create event subscriptions
187
+ * @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEventSubscriptionsById/).
200
188
  */
201
- deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
189
+ deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
202
190
  /**
203
191
  * @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
204
192
  * - Arg object
205
193
  *
206
194
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
207
195
  * @param {import("../PlatformAPIClient").Options} - Options
208
- * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
196
+ * @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
209
197
  * @name deleteSmsProviderById
210
- * @summary: Delete an SMS provider
211
- * @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
198
+ * @summary: Delete SMS provider by ID.
199
+ * @description: Remove a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
212
200
  */
213
- deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
201
+ deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
214
202
  /**
215
203
  * @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg
216
204
  * - Arg object
217
205
  *
218
206
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
219
207
  * @param {import("../PlatformAPIClient").Options} - Options
220
- * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
208
+ * @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
221
209
  * @name deleteSmsTemplateById
222
- * @summary: Delete an SMS template
223
- * @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
210
+ * @summary: Delete SMS template by ID.
211
+ * @description: Remove a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
224
212
  */
225
- deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
213
+ deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
226
214
  /**
227
215
  * @param {CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam} arg
228
216
  * - Arg object
229
217
  *
230
218
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
231
219
  * @param {import("../PlatformAPIClient").Options} - Options
232
- * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
220
+ * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
233
221
  * - Success response
234
222
  *
235
223
  * @name editEventSubscriptions
236
- * @summary: Update an event subscriptions
237
- * @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/editEventSubscriptions/).
224
+ * @summary: Create event subscriptions
225
+ * @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/editEventSubscriptions/).
238
226
  */
239
- editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
227
+ editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>;
240
228
  /**
241
229
  * @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
242
230
  * - Arg object
@@ -245,8 +233,8 @@ declare class Communication {
245
233
  * @param {import("../PlatformAPIClient").Options} - Options
246
234
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
247
235
  * @name getAppProviders
248
- * @summary: Get application providers
249
- * @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
236
+ * @summary: Get application providers.
237
+ * @description: Retrieve a list of providers associated with the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
250
238
  */
251
239
  getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
252
240
  /**
@@ -257,8 +245,8 @@ declare class Communication {
257
245
  * @param {import("../PlatformAPIClient").Options} - Options
258
246
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
259
247
  * @name getAudienceById
260
- * @summary: Get an audience
261
- * @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
248
+ * @summary: Get audience by ID.
249
+ * @description: Retrieve detailed information about a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
262
250
  */
263
251
  getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
264
252
  /**
@@ -269,34 +257,28 @@ declare class Communication {
269
257
  * @param {import("../PlatformAPIClient").Options} - Options
270
258
  * @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
271
259
  * @name getAudiences
272
- * @summary: Get all the audiences
273
- * @description: Retrieves a list of all the audiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
260
+ * @summary: Get audiences.
261
+ * @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
274
262
  */
275
263
  getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
276
264
  /**
277
- * @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
278
- * - Arg object
279
- *
280
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
281
- * @param {import("../PlatformAPIClient").Options} - Options
282
- * @returns {Promise<Object>} - Success response
283
- * @name getBigQueryHeadersById
284
- * @summary: Get BigQuery headers
285
- * @description: Retrieves header information from BigQuery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
286
- */
287
- getBigQueryHeadersById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam, { responseHeaders }?: object): Promise<any>;
288
- /**
289
- * @param {CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam} arg
290
- * - Arg object
291
- *
292
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
293
- * @param {import("../PlatformAPIClient").Options} - Options
294
- * @returns {Promise<Object>} - Success response
295
- * @name getBigQueryRowCountById
296
- * @summary: Get BigQuery row count
297
- * @description: Retrieves big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
298
- */
299
- getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
265
+ * @param {Object} arg - Arg object.
266
+ * @param {string} arg.companyId - Company id
267
+ * @param {string} arg.applicationId - Application id
268
+ * @param {number} [arg.pageSize] - Current request items count
269
+ * @param {string} [arg.sort] - To sort based on created_at
270
+ * @param {string} [arg.query] - To search based on plain text
271
+ * @returns {Paginator<CommunicationPlatformModel.Audiences>}
272
+ * @summary: Get audiences.
273
+ * @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign.
274
+ */
275
+ getAudiencesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
276
+ companyId: string;
277
+ applicationId: string;
278
+ pageSize?: number;
279
+ sort?: string;
280
+ query?: string;
281
+ }): Paginator<CommunicationPlatformModel.Audiences>;
300
282
  /**
301
283
  * @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
302
284
  * - Arg object
@@ -305,8 +287,8 @@ declare class Communication {
305
287
  * @param {import("../PlatformAPIClient").Options} - Options
306
288
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
307
289
  * @name getCampaignById
308
- * @summary: Get a campaign
309
- * @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
290
+ * @summary: Get campaign by ID.
291
+ * @description: Retrieve detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
310
292
  */
311
293
  getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
312
294
  /**
@@ -317,8 +299,8 @@ declare class Communication {
317
299
  * @param {import("../PlatformAPIClient").Options} - Options
318
300
  * @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
319
301
  * @name getCampaigns
320
- * @summary: Get all campaigns
321
- * @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
302
+ * @summary: Get campaigns.
303
+ * @description: Retrieve a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
322
304
  */
323
305
  getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
324
306
  /**
@@ -329,10 +311,41 @@ declare class Communication {
329
311
  * @param {import("../PlatformAPIClient").Options} - Options
330
312
  * @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
331
313
  * @name getCommunicationLogs
332
- * @summary: Get communication reports
333
- * @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
314
+ * @summary: Get communication logs.
315
+ * @description: Retrieve logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
316
+ */
317
+ getCommunicationLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
318
+ /**
319
+ * @param {Object} arg - Arg object.
320
+ * @param {string} arg.companyId - Company id
321
+ * @param {string} arg.applicationId - Application id
322
+ * @param {number} [arg.pageSize] - Current request items count
323
+ * @param {string} [arg.sort] - To sort based on created_at
324
+ * @param {Object} [arg.query] -
325
+ * @returns {Paginator<CommunicationPlatformModel.Logs>}
326
+ * @summary: Get communication logs.
327
+ * @description: Retrieve logs and records of communication activities.
334
328
  */
335
- getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
329
+ getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
330
+ companyId: string;
331
+ applicationId: string;
332
+ pageSize?: number;
333
+ sort?: string;
334
+ query?: any;
335
+ }): Paginator<CommunicationPlatformModel.Logs>;
336
+ /**
337
+ * @param {CommunicationPlatformApplicationValidator.GetDefaultEmailProvidersParam} arg
338
+ * - Arg object
339
+ *
340
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
341
+ * @param {import("../PlatformAPIClient").Options} - Options
342
+ * @returns {Promise<CommunicationPlatformModel.DefaultEmailProviders[]>} -
343
+ * Success response
344
+ * @name getDefaultEmailProviders
345
+ * @summary: Get app providers.
346
+ * @description: Retrieve a list of app providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultEmailProviders/).
347
+ */
348
+ getDefaultEmailProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultEmailProviders[]>;
336
349
  /**
337
350
  * @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg
338
351
  * - Arg object
@@ -342,8 +355,8 @@ declare class Communication {
342
355
  * @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
343
356
  * Success response
344
357
  * @name getDefaultSmsProviders
345
- * @summary: Get all default SMS providers
346
- * @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
358
+ * @summary: Get default SMS providers.
359
+ * @description: Retrieve the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
347
360
  */
348
361
  getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
349
362
  /**
@@ -355,8 +368,8 @@ declare class Communication {
355
368
  * @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
356
369
  * Success response
357
370
  * @name getDummyDatasources
358
- * @summary: Get dummy data sources
359
- * @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
371
+ * @summary: Get dummy data sources.
372
+ * @description: Retrieve a list of dummy data sources for testing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
360
373
  */
361
374
  getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
362
375
  /**
@@ -368,7 +381,7 @@ declare class Communication {
368
381
  * @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
369
382
  * Success response
370
383
  * @name getDummyDatasourcesMeta
371
- * @summary: Get dummy data sources metadata
384
+ * @summary: Get dummy data sources metadata.
372
385
  * @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
373
386
  */
374
387
  getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
@@ -380,8 +393,8 @@ declare class Communication {
380
393
  * @param {import("../PlatformAPIClient").Options} - Options
381
394
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
382
395
  * @name getEmailProviderById
383
- * @summary: Get a email provider
384
- * @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
396
+ * @summary: Get email provider by ID.
397
+ * @description: Retrieve detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
385
398
  */
386
399
  getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
387
400
  /**
@@ -392,10 +405,28 @@ declare class Communication {
392
405
  * @param {import("../PlatformAPIClient").Options} - Options
393
406
  * @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
394
407
  * @name getEmailProviders
395
- * @summary: Get all email providers
396
- * @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
408
+ * @summary: Get email providers.
409
+ * @description: Retrieve a list of email communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
397
410
  */
398
411
  getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
412
+ /**
413
+ * @param {Object} arg - Arg object.
414
+ * @param {string} arg.companyId - Company id
415
+ * @param {string} arg.applicationId - Application id
416
+ * @param {number} [arg.pageSize] - Current request items count
417
+ * @param {string} [arg.sort] - To sort based on created_at
418
+ * @param {string} [arg.query] - To search based on plain text
419
+ * @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
420
+ * @summary: Get email providers.
421
+ * @description: Retrieve a list of email communication providers.
422
+ */
423
+ getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
424
+ companyId: string;
425
+ applicationId: string;
426
+ pageSize?: number;
427
+ sort?: string;
428
+ query?: string;
429
+ }): Paginator<CommunicationPlatformModel.EmailProviders>;
399
430
  /**
400
431
  * @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
401
432
  * - Arg object
@@ -404,8 +435,8 @@ declare class Communication {
404
435
  * @param {import("../PlatformAPIClient").Options} - Options
405
436
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
406
437
  * @name getEmailTemplateById
407
- * @summary: Get an email template
408
- * @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
438
+ * @summary: Get email template by ID.
439
+ * @description: Retrieve detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
409
440
  */
410
441
  getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
411
442
  /**
@@ -416,10 +447,28 @@ declare class Communication {
416
447
  * @param {import("../PlatformAPIClient").Options} - Options
417
448
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
418
449
  * @name getEmailTemplates
419
- * @summary: Get all email templates
420
- * @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
450
+ * @summary: Get email templates.
451
+ * @description: Retrieve a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
421
452
  */
422
453
  getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
454
+ /**
455
+ * @param {Object} arg - Arg object.
456
+ * @param {string} arg.companyId - Company id
457
+ * @param {string} arg.applicationId - Application id
458
+ * @param {number} [arg.pageSize] - Current request items count
459
+ * @param {string} [arg.sort] - To sort based on created_at
460
+ * @param {string} [arg.query] - To search based on plain text
461
+ * @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
462
+ * @summary: Get email templates.
463
+ * @description: Retrieve a list of available email communication templates.
464
+ */
465
+ getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
466
+ companyId: string;
467
+ applicationId: string;
468
+ pageSize?: number;
469
+ sort?: string;
470
+ query?: string;
471
+ }): Paginator<CommunicationPlatformModel.EmailTemplates>;
423
472
  /**
424
473
  * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
425
474
  * - Arg object
@@ -429,10 +478,26 @@ declare class Communication {
429
478
  * @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
430
479
  * Success response
431
480
  * @name getEventSubscriptions
432
- * @summary: Get all event subscriptions
433
- * @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
481
+ * @summary: Get event subscriptions.
482
+ * @description: Retrieve a list of event subscriptions related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
434
483
  */
435
484
  getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
485
+ /**
486
+ * @param {Object} arg - Arg object.
487
+ * @param {string} arg.companyId - Company id
488
+ * @param {string} arg.applicationId - Application id
489
+ * @param {number} [arg.pageSize] - Current request items count
490
+ * @param {string} [arg.populate] - Populate Fields
491
+ * @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
492
+ * @summary: Get event subscriptions.
493
+ * @description: Retrieve a list of event subscriptions related to communication.
494
+ */
495
+ getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
496
+ companyId: string;
497
+ applicationId: string;
498
+ pageSize?: number;
499
+ populate?: string;
500
+ }): Paginator<CommunicationPlatformModel.EventSubscriptions>;
436
501
  /**
437
502
  * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
438
503
  * - Arg object
@@ -441,8 +506,8 @@ declare class Communication {
441
506
  * @param {import("../PlatformAPIClient").Options} - Options
442
507
  * @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
443
508
  * @name getEventSubscriptionsById
444
- * @summary: Get an event subscription
445
- * @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptionsById/).
509
+ * @summary: Get event subscriptions by id
510
+ * @description: Get event subscriptions by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptionsById/).
446
511
  */
447
512
  getEventSubscriptionsById({ id, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
448
513
  /**
@@ -453,8 +518,8 @@ declare class Communication {
453
518
  * @param {import("../PlatformAPIClient").Options} - Options
454
519
  * @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
455
520
  * @name getGlobalProviders
456
- * @summary: Get global providers
457
- * @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
521
+ * @summary: Get global providers.
522
+ * @description: Retrieve a list of global communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
458
523
  */
459
524
  getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
460
525
  /**
@@ -463,34 +528,70 @@ declare class Communication {
463
528
  *
464
529
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
465
530
  * @param {import("../PlatformAPIClient").Options} - Options
466
- * @returns {Promise<CommunicationPlatformModel.GetGlobalVariablesResult>}
531
+ * @returns {Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>}
467
532
  * - Success response
468
533
  *
469
534
  * @name getGlobalVariables
470
- * @summary: Get all global variables
471
- * @description: Retrieves a list of communication global variables. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
535
+ * @summary: Get global variables.
536
+ * @description: Retrieve global variables used in communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
472
537
  */
473
- getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetGlobalVariablesResult>;
538
+ getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>;
474
539
  /**
475
540
  * @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
476
541
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
477
542
  * @param {import("../PlatformAPIClient").Options} - Options
478
543
  * @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
479
544
  * @name getJobLogs
480
- * @summary: Get logs of all campaign job
481
- * @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
545
+ * @summary: Get job logs.
546
+ * @description: Retrieve logs and details related to communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
482
547
  */
483
548
  getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
549
+ /**
550
+ * @param {Object} arg - Arg object.
551
+ * @param {string} arg.companyId - Company id
552
+ * @param {string} arg.applicationId - Application id
553
+ * @param {number} [arg.pageSize] - Current request items count
554
+ * @param {string} [arg.sort] - To sort based on created_at
555
+ * @param {string} [arg.query] - To search based on plain text
556
+ * @returns {Paginator<CommunicationPlatformModel.JobLogs>}
557
+ * @summary: Get job logs.
558
+ * @description: Retrieve logs and details related to communication jobs.
559
+ */
560
+ getJobLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
561
+ companyId: string;
562
+ applicationId: string;
563
+ pageSize?: number;
564
+ sort?: string;
565
+ query?: string;
566
+ }): Paginator<CommunicationPlatformModel.JobLogs>;
484
567
  /**
485
568
  * @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
486
569
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
487
570
  * @param {import("../PlatformAPIClient").Options} - Options
488
571
  * @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
489
572
  * @name getJobs
490
- * @summary: Get all campaign jobs
491
- * @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
573
+ * @summary: Get jobs.
574
+ * @description: Retrieve a list of communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
492
575
  */
493
576
  getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
577
+ /**
578
+ * @param {Object} arg - Arg object.
579
+ * @param {string} arg.companyId - Company id
580
+ * @param {string} arg.applicationId - Application id
581
+ * @param {number} [arg.pageSize] - Current request items count
582
+ * @param {string} [arg.sort] - To sort based on created_at
583
+ * @param {string} [arg.query] - To search based on plain text
584
+ * @returns {Paginator<CommunicationPlatformModel.Jobs>}
585
+ * @summary: Get jobs.
586
+ * @description: Retrieve a list of communication jobs.
587
+ */
588
+ getJobsPaginator({ companyId, applicationId, pageSize, sort, query }?: {
589
+ companyId: string;
590
+ applicationId: string;
591
+ pageSize?: number;
592
+ sort?: string;
593
+ query?: string;
594
+ }): Paginator<CommunicationPlatformModel.Jobs>;
494
595
  /**
495
596
  * @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
496
597
  * - Arg object
@@ -499,7 +600,7 @@ declare class Communication {
499
600
  * @param {import("../PlatformAPIClient").Options} - Options
500
601
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
501
602
  * @name getNSampleRecordsFromCsv
502
- * @summary: Get N sample records of a CSV
603
+ * @summary: Get N sample records from CSV.
503
604
  * @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsv/).
504
605
  */
505
606
  getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
@@ -511,10 +612,10 @@ declare class Communication {
511
612
  * @param {import("../PlatformAPIClient").Options} - Options
512
613
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
513
614
  * @name getNSampleRecordsFromCsvByGet
514
- * @summary: Get N sample records of a CSV
515
- * @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
615
+ * @summary: Get N sample records in CSV
616
+ * @description: Retrieve a specified number of sample records from a CSV data source using a GET request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
516
617
  */
517
- getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
618
+ getNSampleRecordsFromCsvByGet({ count, header, url, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvByGetParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
518
619
  /**
519
620
  * @param {CommunicationPlatformApplicationValidator.GetOtpConfigurationParam} arg
520
621
  * - Arg object
@@ -523,8 +624,8 @@ declare class Communication {
523
624
  * @param {import("../PlatformAPIClient").Options} - Options
524
625
  * @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
525
626
  * @name getOtpConfiguration
526
- * @summary: Get configuration of otp
527
- * @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getOtpConfiguration/).
627
+ * @summary: Get otp-configuration, if not present in db then return default settings
628
+ * @description: Get otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getOtpConfiguration/).
528
629
  */
529
630
  getOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
530
631
  /**
@@ -533,24 +634,24 @@ declare class Communication {
533
634
  *
534
635
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
535
636
  * @param {import("../PlatformAPIClient").Options} - Options
536
- * @returns {Promise<Object>} - Success response
637
+ * @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
537
638
  * @name getSmsProviderById
538
- * @summary: Get a SMS provider
639
+ * @summary: Get SMS provider by ID.
539
640
  * @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
540
641
  */
541
- getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
642
+ getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProvider>;
542
643
  /**
543
644
  * @param {CommunicationPlatformApplicationValidator.GetSmsProvidersParam} arg
544
645
  * - Arg object
545
646
  *
546
647
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
547
648
  * @param {import("../PlatformAPIClient").Options} - Options
548
- * @returns {Promise<Object>} - Success response
649
+ * @returns {Promise<CommunicationPlatformModel.SmsProviders>} - Success response
549
650
  * @name getSmsProviders
550
- * @summary: Get all SMS providers
551
- * @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
651
+ * @summary: Get SMS providers.
652
+ * @description: Retrieve a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
552
653
  */
553
- getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
654
+ getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProviders>;
554
655
  /**
555
656
  * @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
556
657
  * - Arg object
@@ -559,8 +660,8 @@ declare class Communication {
559
660
  * @param {import("../PlatformAPIClient").Options} - Options
560
661
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
561
662
  * @name getSmsTemplateById
562
- * @summary: Get a SMS template
563
- * @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
663
+ * @summary: Get SMS template by ID.
664
+ * @description: Retrieve detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
564
665
  */
565
666
  getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
566
667
  /**
@@ -571,10 +672,28 @@ declare class Communication {
571
672
  * @param {import("../PlatformAPIClient").Options} - Options
572
673
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
573
674
  * @name getSmsTemplates
574
- * @summary: Get all SMS templates
575
- * @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
675
+ * @summary: Get SMS templates.
676
+ * @description: Retrieve a list of available SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
576
677
  */
577
678
  getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
679
+ /**
680
+ * @param {Object} arg - Arg object.
681
+ * @param {string} arg.companyId - Company id
682
+ * @param {string} arg.applicationId - Application id
683
+ * @param {number} [arg.pageSize] - Current request items count
684
+ * @param {string} [arg.sort] - To sort based on created_at
685
+ * @param {string} [arg.query] - To search based on plain text
686
+ * @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
687
+ * @summary: Get SMS templates.
688
+ * @description: Retrieve a list of available SMS communication templates.
689
+ */
690
+ getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
691
+ companyId: string;
692
+ applicationId: string;
693
+ pageSize?: number;
694
+ sort?: string;
695
+ query?: string;
696
+ }): Paginator<CommunicationPlatformModel.SmsTemplates>;
578
697
  /**
579
698
  * @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
580
699
  * - Arg object
@@ -583,8 +702,8 @@ declare class Communication {
583
702
  * @param {import("../PlatformAPIClient").Options} - Options
584
703
  * @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
585
704
  * @name getStatsOfCampaignById
586
- * @summary: Get campaign statistics
587
- * @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
705
+ * @summary: Get campaign statistics by ID.
706
+ * @description: Retrieve statistical data for a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
588
707
  */
589
708
  getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
590
709
  /**
@@ -593,49 +712,40 @@ declare class Communication {
593
712
  *
594
713
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
595
714
  * @param {import("../PlatformAPIClient").Options} - Options
596
- * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
715
+ * @returns {Promise<CommunicationPlatformModel.SubscribedEmailTemplates>}
716
+ * - Success response
717
+ *
597
718
  * @name getSubscribedEmailTemplates
598
- * @summary: Get all subscribed email templates
599
- * @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
719
+ * @summary: Get subscribed email templates.
720
+ * @description: Retrieve email communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
600
721
  */
601
- getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
722
+ getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SubscribedEmailTemplates>;
602
723
  /**
603
724
  * @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
604
725
  * - Arg object
605
726
  *
606
727
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
607
728
  * @param {import("../PlatformAPIClient").Options} - Options
608
- * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
729
+ * @returns {Promise<CommunicationPlatformModel.SubscribedSmsTemplates>} -
730
+ * Success response
609
731
  * @name getSubscribedSmsTemplates
610
- * @summary: Get all subscribed SMS templates
611
- * @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
732
+ * @summary: Get subscribed SMS templates.
733
+ * @description: Retrieve SMS communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
612
734
  */
613
- getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
614
- /**
615
- * @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
616
- * - Arg object
617
- *
618
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
619
- * @param {import("../PlatformAPIClient").Options} - Options
620
- * @returns {Promise<Object>} - Success response
621
- * @name getSystemAudiences
622
- * @summary: Get system audiences
623
- * @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
624
- */
625
- getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
735
+ getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SubscribedSmsTemplates>;
626
736
  /**
627
737
  * @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
628
738
  * - Arg object
629
739
  *
630
740
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
631
741
  * @param {import("../PlatformAPIClient").Options} - Options
632
- * @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
742
+ * @returns {Promise<CommunicationPlatformModel.SystemEmailTemplate[]>} -
633
743
  * Success response
634
744
  * @name getSystemEmailTemplates
635
- * @summary: Get all system email templates
636
- * @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
745
+ * @summary: Get system email templates.
746
+ * @description: Retrieve system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
637
747
  */
638
- getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
748
+ getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplate[]>;
639
749
  /**
640
750
  * @param {CommunicationPlatformApplicationValidator.GetSystemSmsTemplatesParam} arg
641
751
  * - Arg object
@@ -645,8 +755,8 @@ declare class Communication {
645
755
  * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
646
756
  * Success response
647
757
  * @name getSystemSmsTemplates
648
- * @summary: Gets all system SMS templates
649
- * @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
758
+ * @summary: Get system SMS templates.
759
+ * @description: Retrieve system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
650
760
  */
651
761
  getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates[]>;
652
762
  /**
@@ -655,60 +765,75 @@ declare class Communication {
655
765
  *
656
766
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
657
767
  * @param {import("../PlatformAPIClient").Options} - Options
658
- * @returns {Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>}
768
+ * @returns {Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>}
659
769
  * - Success response
660
770
  *
661
771
  * @name postGlobalVariables
662
- * @summary: Create global variables
663
- * @description: Updates and creates communication global variables. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
772
+ * @summary: Post global variables.
773
+ * @description: Update and post global variables for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
664
774
  */
665
- postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>;
775
+ postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>;
666
776
  /**
667
777
  * @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
668
778
  * - Arg object
669
779
  *
670
780
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
671
781
  * @param {import("../PlatformAPIClient").Options} - Options
672
- * @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
782
+ * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
673
783
  * @name sendCommunicationAsynchronously
674
- * @summary: Send communication asynchronously
675
- * @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
784
+ * @summary: Send communication asynchronously.
785
+ * @description: Initiate and send communication with the option for asynchronous processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
676
786
  */
677
- sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
787
+ sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
678
788
  /**
679
789
  * @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
680
790
  * - Arg object
681
791
  *
682
792
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
683
793
  * @param {import("../PlatformAPIClient").Options} - Options
684
- * @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
794
+ * @returns {Promise<CommunicationPlatformModel.SendInstantResponse>} -
795
+ * Success response
685
796
  * @name sendCommunicationSynchronously
686
- * @summary: Send communication synchronously
687
- * @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
797
+ * @summary: Send communication synchronously.
798
+ * @description: Initiate and send communication in real-time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
799
+ */
800
+ sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendInstantResponse>;
801
+ /**
802
+ * @param {CommunicationPlatformApplicationValidator.SendEngineCommunicationSynchronouslyParam} arg
803
+ * - Arg object
804
+ *
805
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
806
+ * @param {import("../PlatformAPIClient").Options} - Options
807
+ * @returns {Promise<CommunicationPlatformModel.SendInstantResponse>} -
808
+ * Success response
809
+ * @name sendEngineCommunicationSynchronously
810
+ * @summary: Send communication asynchronously.
811
+ * @description: Initiate and send communication with the option for asynchronous processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendEngineCommunicationSynchronously/).
688
812
  */
689
- sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
813
+ sendEngineCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendEngineCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendInstantResponse>;
690
814
  /**
691
815
  * @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
692
816
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
693
817
  * @param {import("../PlatformAPIClient").Options} - Options
694
818
  * @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
695
819
  * @name sendOtp
696
- * @summary: Send OTP
697
- * @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
820
+ * @summary: Send OTP.
821
+ * @description: Send a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
698
822
  */
699
- sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
823
+ sendOtp({ body, ci, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
700
824
  /**
701
825
  * @param {CommunicationPlatformApplicationValidator.TriggerCampaignJobParam} arg
702
826
  * - Arg object
703
827
  *
704
828
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
705
829
  * @param {import("../PlatformAPIClient").Options} - Options
706
- * @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
830
+ * @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
831
+ * Success response
707
832
  * @name triggerCampaignJob
708
- * @summary: Trigger a campaign job
709
- * @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
833
+ * @summary: Trigger campaign job.
834
+ * @description: Initiate a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
710
835
  */
711
- triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResult>;
836
+ triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResponse>;
712
837
  /**
713
838
  * @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg
714
839
  * - Arg object
@@ -717,10 +842,24 @@ declare class Communication {
717
842
  * @param {import("../PlatformAPIClient").Options} - Options
718
843
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
719
844
  * @name updateAppProviders
720
- * @summary: Update application providers
721
- * @description: Modify provider configuration using provider object id . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
845
+ * @summary: Update application providers.
846
+ * @description: Modify provider information for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
722
847
  */
723
848
  updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
849
+ /**
850
+ * @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersGlobalProviderParam} arg
851
+ * - Arg object
852
+ *
853
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
854
+ * @param {import("../PlatformAPIClient").Options} - Options
855
+ * @returns {Promise<CommunicationPlatformModel.UpdateAppProvidersGlobalProviderResponse>}
856
+ * - Success response
857
+ *
858
+ * @name updateAppProvidersGlobalProvider
859
+ * @summary: Get global app providers.
860
+ * @description: Retrieve a list of global app providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProvidersGlobalProvider/).
861
+ */
862
+ updateAppProvidersGlobalProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersGlobalProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.UpdateAppProvidersGlobalProviderResponse>;
724
863
  /**
725
864
  * @param {CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam} arg
726
865
  * - Arg object
@@ -729,8 +868,8 @@ declare class Communication {
729
868
  * @param {import("../PlatformAPIClient").Options} - Options
730
869
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
731
870
  * @name updateAudienceById
732
- * @summary: Update an audience
733
- * @description: Modify the configuration of a specific audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
871
+ * @summary: Update audience by ID.
872
+ * @description: Modify the settings of a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
734
873
  */
735
874
  updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
736
875
  /**
@@ -741,8 +880,8 @@ declare class Communication {
741
880
  * @param {import("../PlatformAPIClient").Options} - Options
742
881
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
743
882
  * @name updateCampaignById
744
- * @summary: Update a campaign
745
- * @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
883
+ * @summary: Update campaign by ID.
884
+ * @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
746
885
  */
747
886
  updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
748
887
  /**
@@ -753,8 +892,8 @@ declare class Communication {
753
892
  * @param {import("../PlatformAPIClient").Options} - Options
754
893
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
755
894
  * @name updateEmailProviderById
756
- * @summary: Update email provider
757
- * @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
895
+ * @summary: Update email provider by ID.
896
+ * @description: Modify the settings of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
758
897
  */
759
898
  updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
760
899
  /**
@@ -765,8 +904,8 @@ declare class Communication {
765
904
  * @param {import("../PlatformAPIClient").Options} - Options
766
905
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
767
906
  * @name updateEmailTemplateById
768
- * @summary: Update an email template
769
- * @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
907
+ * @summary: Update email template by ID.
908
+ * @description: Modify the content and settings of a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
770
909
  */
771
910
  updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
772
911
  /**
@@ -777,22 +916,22 @@ declare class Communication {
777
916
  * @param {import("../PlatformAPIClient").Options} - Options
778
917
  * @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
779
918
  * @name updateOtpConfiguration
780
- * @summary: Update configuration of otp
781
- * @description: Updates all configurations related to OTP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateOtpConfiguration/).
919
+ * @summary: Update/insert otp configurations
920
+ * @description: Update otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateOtpConfiguration/).
782
921
  */
783
- updateOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
922
+ updateOtpConfiguration({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateOtpConfigurationParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
784
923
  /**
785
924
  * @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
786
925
  * - Arg object
787
926
  *
788
927
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
789
928
  * @param {import("../PlatformAPIClient").Options} - Options
790
- * @returns {Promise<Object>} - Success response
929
+ * @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
791
930
  * @name updateSmsProviderById
792
- * @summary: Update SMS provider
793
- * @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
931
+ * @summary: Update SMS provider by ID.
932
+ * @description: Modify specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
794
933
  */
795
- updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
934
+ updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProvider>;
796
935
  /**
797
936
  * @param {CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam} arg
798
937
  * - Arg object
@@ -801,8 +940,8 @@ declare class Communication {
801
940
  * @param {import("../PlatformAPIClient").Options} - Options
802
941
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
803
942
  * @name updateSmsTemplateById
804
- * @summary: Update a SMS template
805
- * @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
943
+ * @summary: Update SMS template by ID.
944
+ * @description: Modify the content and settings of a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
806
945
  */
807
946
  updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
808
947
  /**
@@ -813,10 +952,11 @@ declare class Communication {
813
952
  * - Success response
814
953
  *
815
954
  * @name verfiyOtp
816
- * @summary: Verify OTP
817
- * @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
955
+ * @summary: Verify OTP.
956
+ * @description: Verify the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
818
957
  */
819
958
  verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
820
959
  }
821
960
  import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator");
822
961
  import CommunicationPlatformModel = require("./CommunicationPlatformModel");
962
+ import Paginator = require("../../common/Paginator");