@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (262) hide show
  1. package/README.md +44 -7
  2. package/package.json +1 -2
  3. package/sdk/application/ApplicationAPIClient.d.ts +3 -3
  4. package/sdk/application/ApplicationAPIClient.js +6 -4
  5. package/sdk/application/ApplicationClient.d.ts +2 -3
  6. package/sdk/application/ApplicationClient.js +1 -45
  7. package/sdk/application/ApplicationConfig.d.ts +46 -6
  8. package/sdk/application/ApplicationConfig.js +15 -16
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
  10. package/sdk/application/Cart/CartApplicationClient.js +225 -134
  11. package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
  12. package/sdk/application/Cart/CartApplicationModel.js +4 -4
  13. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
  14. package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
  15. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
  16. package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
  18. package/sdk/application/Common/CommonApplicationClient.js +13 -11
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
  20. package/sdk/application/Common/CommonApplicationModel.js +2 -58
  21. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
  22. package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
  23. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
  24. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
  25. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
  26. package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
  27. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
  28. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
  29. package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
  30. package/sdk/application/Content/ContentApplicationClient.js +159 -80
  31. package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
  32. package/sdk/application/Content/ContentApplicationModel.js +11 -763
  33. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
  34. package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
  35. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
  36. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
  37. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
  38. package/sdk/application/Lead/LeadApplicationClient.js +50 -31
  39. package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
  40. package/sdk/application/Lead/LeadApplicationModel.js +21 -481
  41. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
  42. package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
  44. package/sdk/application/Order/OrderApplicationClient.js +88 -56
  45. package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
  46. package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
  47. package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
  48. package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
  49. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
  50. package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
  51. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
  52. package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
  53. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
  54. package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
  55. package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
  56. package/sdk/application/Share/ShareApplicationClient.js +51 -31
  57. package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
  58. package/sdk/application/Share/ShareApplicationModel.js +0 -38
  59. package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
  60. package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
  61. package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
  62. package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
  63. package/sdk/application/User/UserApplicationClient.d.ts +74 -35
  64. package/sdk/application/User/UserApplicationClient.js +252 -161
  65. package/sdk/application/User/UserApplicationModel.d.ts +3 -401
  66. package/sdk/application/User/UserApplicationModel.js +2 -490
  67. package/sdk/common/AxiosHelper.js +1 -2
  68. package/sdk/common/FDKError.d.ts +3 -0
  69. package/sdk/common/FDKError.js +8 -0
  70. package/sdk/common/utils.d.ts +3 -0
  71. package/sdk/common/utils.js +29 -0
  72. package/sdk/partner/PartnerAPIClient.d.ts +5 -4
  73. package/sdk/partner/PartnerAPIClient.js +7 -4
  74. package/sdk/partner/PartnerClient.d.ts +2 -0
  75. package/sdk/partner/PartnerClient.js +3 -0
  76. package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
  77. package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
  78. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
  79. package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
  80. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
  81. package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
  82. package/sdk/partner/index.d.ts +3 -1
  83. package/sdk/partner/index.js +3 -1
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
  87. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
  88. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
  89. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
  90. package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
  91. package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
  92. package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
  93. package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
  94. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
  95. package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
  96. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
  97. package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
  98. package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
  99. package/sdk/platform/Cart/CartPlatformModel.js +104 -54
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
  108. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
  109. package/sdk/platform/Common/CommonPlatformClient.js +13 -11
  110. package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
  111. package/sdk/platform/Common/CommonPlatformModel.js +23 -57
  112. package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
  113. package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
  117. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
  118. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  119. package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
  120. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
  121. package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
  130. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
  131. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
  132. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
  134. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
  137. package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
  139. package/sdk/platform/Content/ContentPlatformModel.js +8 -231
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
  144. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
  145. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
  148. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
  149. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
  150. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
  151. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
  152. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
  153. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
  154. package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
  155. package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
  156. package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
  157. package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
  158. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
  159. package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
  160. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
  161. package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
  162. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
  163. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
  164. package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
  165. package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
  166. package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
  167. package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
  168. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
  169. package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
  170. package/sdk/platform/OAuthClient.js +6 -2
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
  173. package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
  174. package/sdk/platform/Order/OrderPlatformClient.js +738 -205
  175. package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
  176. package/sdk/platform/Order/OrderPlatformModel.js +225 -2
  177. package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
  178. package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
  179. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
  180. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
  181. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
  182. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
  193. package/sdk/platform/PlatformAPIClient.d.ts +3 -3
  194. package/sdk/platform/PlatformAPIClient.js +2 -2
  195. package/sdk/platform/PlatformClient.d.ts +2 -2
  196. package/sdk/platform/PlatformClient.js +4 -4
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
  199. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
  200. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
  209. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
  210. package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
  211. package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
  212. package/sdk/platform/Share/SharePlatformModel.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
  214. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
  215. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
  216. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
  217. package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
  218. package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
  219. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
  220. package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
  221. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
  222. package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
  227. package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
  228. package/sdk/platform/User/UserPlatformModel.js +3 -899
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
  239. package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
  240. package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
  241. package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
  242. package/sdk/public/Partner/PartnerPublicClient.js +110 -0
  243. package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
  244. package/sdk/public/Partner/PartnerPublicModel.js +280 -0
  245. package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
  246. package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
  247. package/sdk/public/PublicAPIClient.d.ts +14 -1
  248. package/sdk/public/PublicAPIClient.js +7 -1
  249. package/sdk/public/PublicClient.d.ts +2 -0
  250. package/sdk/public/PublicClient.js +4 -0
  251. package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
  252. package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
  253. package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
  254. package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
  255. package/sdk/public/index.d.ts +1 -0
  256. package/sdk/public/index.js +2 -0
  257. package/sdk/application/ApplicationModels.d.ts +0 -48
  258. package/sdk/application/ApplicationModels.js +0 -38
  259. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
  260. package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
  261. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
  262. package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
@@ -7,116 +7,206 @@ declare class Communication {
7
7
  * @param {CommunicationPlatformApplicationValidator.CreateAudienceParam} arg
8
8
  * - Arg object
9
9
  *
10
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
10
11
  * @param {import("../PlatformAPIClient").Options} - Options
11
12
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
12
13
  * @name createAudience
13
14
  * @summary: Create audience
14
- * @description: Create audience - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
15
+ * @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. Use this API to create audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
15
16
  */
16
- createAudience({ body }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audience>;
17
+ createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
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 big query headers
27
+ * @description: Create big query 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 big query n count
39
+ * @description: Create 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
44
+ * - Arg object
45
+ *
46
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
47
+ * @param {import("../PlatformAPIClient").Options} - Options
48
+ * @returns {Promise<Object>} - Success response
49
+ * @name createBigQueryRowCount
50
+ * @summary: Create big query row count
51
+ * @description: Create big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
52
+ */
53
+ createBigQueryRowCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
17
54
  /**
18
55
  * @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
19
56
  * - Arg object
20
57
  *
58
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
21
59
  * @param {import("../PlatformAPIClient").Options} - Options
22
60
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
23
61
  * @name createCampaign
24
62
  * @summary: Create campaign
25
63
  * @description: Create campaign - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
26
64
  */
27
- createCampaign({ body }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaign>;
65
+ createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
28
66
  /**
29
67
  * @param {CommunicationPlatformApplicationValidator.CreateEmailProviderParam} arg
30
68
  * - Arg object
31
69
  *
70
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
32
71
  * @param {import("../PlatformAPIClient").Options} - Options
33
72
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
34
73
  * @name createEmailProvider
35
74
  * @summary: Create email provider
36
75
  * @description: Create email provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
37
76
  */
38
- createEmailProvider({ body }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProvider>;
77
+ createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
39
78
  /**
40
79
  * @param {CommunicationPlatformApplicationValidator.CreateEmailTemplateParam} arg
41
80
  * - Arg object
42
81
  *
82
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
43
83
  * @param {import("../PlatformAPIClient").Options} - Options
44
- * @returns {Promise<CommunicationPlatformModel.EmailTemplateRes>} - Success response
84
+ * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
45
85
  * @name createEmailTemplate
46
86
  * @summary: Create email template
47
- * @description: Create email template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
87
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to create an email template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
48
88
  */
49
- createEmailTemplate({ body }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplateRes>;
89
+ createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
50
90
  /**
51
91
  * @param {CommunicationPlatformApplicationValidator.CreateSmsProviderParam} arg
52
92
  * - Arg object
53
93
  *
94
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
54
95
  * @param {import("../PlatformAPIClient").Options} - Options
55
- * @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
96
+ * @returns {Promise<Object>} - Success response
56
97
  * @name createSmsProvider
57
98
  * @summary: Create sms provider
58
99
  * @description: Create sms provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
59
100
  */
60
- createSmsProvider({ body }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProvider>;
101
+ createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
61
102
  /**
62
103
  * @param {CommunicationPlatformApplicationValidator.CreateSmsTemplateParam} arg
63
104
  * - Arg object
64
105
  *
106
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
65
107
  * @param {import("../PlatformAPIClient").Options} - Options
66
- * @returns {Promise<CommunicationPlatformModel.SmsTemplateRes>} - Success response
108
+ * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
67
109
  * @name createSmsTemplate
68
110
  * @summary: Create sms template
69
- * @description: Create sms template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
111
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to create an sms template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
70
112
  */
71
- createSmsTemplate({ body }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplateRes>;
113
+ createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
72
114
  /**
73
- * @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg
115
+ * @param {CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam} arg
74
116
  * - Arg object
75
117
  *
118
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
76
119
  * @param {import("../PlatformAPIClient").Options} - Options
77
- * @returns {Promise<CommunicationPlatformModel.EmailTemplateDeleteSuccessRes>}
78
- * - Success response
120
+ * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
121
+ * @name deleteAudienceById
122
+ * @summary: Delete audience by id
123
+ * @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. Use this API to delete audience by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
124
+ */
125
+ deleteAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
126
+ /**
127
+ * @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg
128
+ * - Arg object
129
+ *
130
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
131
+ * @param {import("../PlatformAPIClient").Options} - Options
132
+ * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
133
+ * @name deleteEmailProviderById
134
+ * @summary: Delete email provider by id
135
+ * @description: Delete email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
136
+ */
137
+ deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
138
+ /**
139
+ * @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg
140
+ * - Arg object
79
141
  *
142
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
143
+ * @param {import("../PlatformAPIClient").Options} - Options
144
+ * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
80
145
  * @name deleteEmailTemplateById
81
146
  * @summary: Delete email template by id
82
- * @description: Delete email template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
147
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to delete an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
83
148
  */
84
- deleteEmailTemplateById({ id }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplateDeleteSuccessRes>;
149
+ deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
85
150
  /**
86
- * @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg
151
+ * @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
87
152
  * - Arg object
88
153
  *
154
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
89
155
  * @param {import("../PlatformAPIClient").Options} - Options
90
- * @returns {Promise<CommunicationPlatformModel.SmsTemplateDeleteSuccessRes>}
91
- * - Success response
156
+ * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
157
+ * @name deleteSmsProviderById
158
+ * @summary: Delete sms provider by id
159
+ * @description: Delete sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
160
+ */
161
+ deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
162
+ /**
163
+ * @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg
164
+ * - Arg object
92
165
  *
166
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
167
+ * @param {import("../PlatformAPIClient").Options} - Options
168
+ * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
93
169
  * @name deleteSmsTemplateById
94
170
  * @summary: Delete sms template by id
95
- * @description: Delete sms template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
171
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to delete an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
172
+ */
173
+ deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
174
+ /**
175
+ * @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
176
+ * - Arg object
177
+ *
178
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
179
+ * @param {import("../PlatformAPIClient").Options} - Options
180
+ * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
181
+ * @name getAppProviders
182
+ * @summary: Get app providers
183
+ * @description: Using this API will return a list of application providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
96
184
  */
97
- deleteSmsTemplateById({ id }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplateDeleteSuccessRes>;
185
+ getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
98
186
  /**
99
187
  * @param {CommunicationPlatformApplicationValidator.GetAudienceByIdParam} arg
100
188
  * - Arg object
101
189
  *
190
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
102
191
  * @param {import("../PlatformAPIClient").Options} - Options
103
192
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
104
193
  * @name getAudienceById
105
194
  * @summary: Get audience by id
106
- * @description: Get audience by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
195
+ * @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. Use this API to get audiences by Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
107
196
  */
108
- getAudienceById({ id }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audience>;
197
+ getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
109
198
  /**
110
199
  * @param {CommunicationPlatformApplicationValidator.GetAudiencesParam} arg
111
200
  * - Arg object
112
201
  *
202
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
113
203
  * @param {import("../PlatformAPIClient").Options} - Options
114
204
  * @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
115
205
  * @name getAudiences
116
206
  * @summary: Get audiences
117
- * @description: Get audiences - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
207
+ * @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. Use this API to get audiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
118
208
  */
119
- getAudiences({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audiences>;
209
+ getAudiences({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
120
210
  /**
121
211
  * @param {Object} arg - Arg object.
122
212
  * @param {string} arg.companyId - Company id
@@ -125,7 +215,7 @@ declare class Communication {
125
215
  * @param {Object} [arg.sort] - To sort based on created_at
126
216
  * @returns {Paginator<CommunicationPlatformModel.Audiences>}
127
217
  * @summary: Get audiences
128
- * @description: Get audiences
218
+ * @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. Use this API to get audiences.
129
219
  */
130
220
  getAudiencesPaginator({ companyId, applicationId, pageSize, sort }?: {
131
221
  companyId: string;
@@ -134,39 +224,53 @@ declare class Communication {
134
224
  sort?: any;
135
225
  }): Paginator<CommunicationPlatformModel.Audiences>;
136
226
  /**
137
- * @param {CommunicationPlatformApplicationValidator.GetBigqueryHeadersParam} arg
227
+ * @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
138
228
  * - Arg object
139
229
  *
230
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
140
231
  * @param {import("../PlatformAPIClient").Options} - Options
141
- * @returns {Promise<CommunicationPlatformModel.BigqueryHeadersRes>} -
142
- * Success response
143
- * @name getBigqueryHeaders
144
- * @summary: Get bigquery headers
145
- * @description: Get bigquery headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigqueryHeaders/).
232
+ * @returns {Promise<Object>} - Success response
233
+ * @name getBigQueryHeadersById
234
+ * @summary: Get big query headers by id
235
+ * @description: Get big query headers by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
236
+ */
237
+ getBigQueryHeadersById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam, { responseHeaders }?: object): Promise<any>;
238
+ /**
239
+ * @param {CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam} arg
240
+ * - Arg object
241
+ *
242
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
243
+ * @param {import("../PlatformAPIClient").Options} - Options
244
+ * @returns {Promise<Object>} - Success response
245
+ * @name getBigQueryRowCountById
246
+ * @summary: Get big query row count by id
247
+ * @description: Get big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
146
248
  */
147
- getBigqueryHeaders({ body }?: CommunicationPlatformApplicationValidator.GetBigqueryHeadersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.BigqueryHeadersRes>;
249
+ getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
148
250
  /**
149
251
  * @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
150
252
  * - Arg object
151
253
  *
254
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
152
255
  * @param {import("../PlatformAPIClient").Options} - Options
153
256
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
154
257
  * @name getCampaignById
155
258
  * @summary: Get campaign by id
156
259
  * @description: Get campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
157
260
  */
158
- getCampaignById({ id }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaign>;
261
+ getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
159
262
  /**
160
263
  * @param {CommunicationPlatformApplicationValidator.GetCampaignsParam} arg
161
264
  * - Arg object
162
265
  *
266
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
163
267
  * @param {import("../PlatformAPIClient").Options} - Options
164
268
  * @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
165
269
  * @name getCampaigns
166
270
  * @summary: Get campaigns
167
271
  * @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
168
272
  */
169
- getCampaigns({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaigns>;
273
+ getCampaigns({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
170
274
  /**
171
275
  * @param {Object} arg - Arg object.
172
276
  * @param {string} arg.companyId - Company id
@@ -187,13 +291,14 @@ declare class Communication {
187
291
  * @param {CommunicationPlatformApplicationValidator.GetCommunicationLogsParam} arg
188
292
  * - Arg object
189
293
  *
294
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
190
295
  * @param {import("../PlatformAPIClient").Options} - Options
191
296
  * @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
192
297
  * @name getCommunicationLogs
193
298
  * @summary: Get communication logs
194
299
  * @description: Get communication logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
195
300
  */
196
- getCommunicationLogs({ pageId, pageSize, sort, query }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Logs>;
301
+ getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
197
302
  /**
198
303
  * @param {Object} arg - Arg object.
199
304
  * @param {string} arg.companyId - Company id
@@ -212,28 +317,69 @@ declare class Communication {
212
317
  sort?: any;
213
318
  query?: any;
214
319
  }): Paginator<CommunicationPlatformModel.Logs>;
320
+ /**
321
+ * @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg
322
+ * - Arg object
323
+ *
324
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
325
+ * @param {import("../PlatformAPIClient").Options} - Options
326
+ * @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
327
+ * Success response
328
+ * @name getDefaultSmsProviders
329
+ * @summary: Get default sms providers
330
+ * @description: Get default sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
331
+ */
332
+ getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
333
+ /**
334
+ * @param {CommunicationPlatformApplicationValidator.GetDummyDatasourcesParam} arg
335
+ * - Arg object
336
+ *
337
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
338
+ * @param {import("../PlatformAPIClient").Options} - Options
339
+ * @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
340
+ * Success response
341
+ * @name getDummyDatasources
342
+ * @summary: Get dummy data sources
343
+ * @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. Use this API to get dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
344
+ */
345
+ getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
346
+ /**
347
+ * @param {CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam} arg
348
+ * - Arg object
349
+ *
350
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
351
+ * @param {import("../PlatformAPIClient").Options} - Options
352
+ * @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
353
+ * Success response
354
+ * @name getDummyDatasourcesMeta
355
+ * @summary: Get dummy data sources meta
356
+ * @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. Use this API to get dummy data sources meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
357
+ */
358
+ getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
215
359
  /**
216
360
  * @param {CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam} arg
217
361
  * - Arg object
218
362
  *
363
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
219
364
  * @param {import("../PlatformAPIClient").Options} - Options
220
365
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
221
366
  * @name getEmailProviderById
222
367
  * @summary: Get email provider by id
223
368
  * @description: Get email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
224
369
  */
225
- getEmailProviderById({ id }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProvider>;
370
+ getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
226
371
  /**
227
372
  * @param {CommunicationPlatformApplicationValidator.GetEmailProvidersParam} arg
228
373
  * - Arg object
229
374
  *
375
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
230
376
  * @param {import("../PlatformAPIClient").Options} - Options
231
377
  * @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
232
378
  * @name getEmailProviders
233
379
  * @summary: Get email providers
234
380
  * @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
235
381
  */
236
- getEmailProviders({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProviders>;
382
+ getEmailProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
237
383
  /**
238
384
  * @param {Object} arg - Arg object.
239
385
  * @param {string} arg.companyId - Company id
@@ -254,24 +400,26 @@ declare class Communication {
254
400
  * @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
255
401
  * - Arg object
256
402
  *
403
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
257
404
  * @param {import("../PlatformAPIClient").Options} - Options
258
405
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
259
406
  * @name getEmailTemplateById
260
407
  * @summary: Get email template by id
261
- * @description: Get email template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
408
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
262
409
  */
263
- getEmailTemplateById({ id }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplate>;
410
+ getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
264
411
  /**
265
412
  * @param {CommunicationPlatformApplicationValidator.GetEmailTemplatesParam} arg
266
413
  * - Arg object
267
414
  *
415
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
268
416
  * @param {import("../PlatformAPIClient").Options} - Options
269
417
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
270
418
  * @name getEmailTemplates
271
419
  * @summary: Get email templates
272
- * @description: Get email templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
420
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
273
421
  */
274
- getEmailTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplates>;
422
+ getEmailTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
275
423
  /**
276
424
  * @param {Object} arg - Arg object.
277
425
  * @param {string} arg.companyId - Company id
@@ -280,7 +428,7 @@ declare class Communication {
280
428
  * @param {Object} [arg.sort] - To sort based on created_at
281
429
  * @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
282
430
  * @summary: Get email templates
283
- * @description: Get email templates
431
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.
284
432
  */
285
433
  getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
286
434
  companyId: string;
@@ -292,6 +440,7 @@ declare class Communication {
292
440
  * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
293
441
  * - Arg object
294
442
  *
443
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
295
444
  * @param {import("../PlatformAPIClient").Options} - Options
296
445
  * @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
297
446
  * Success response
@@ -299,7 +448,7 @@ declare class Communication {
299
448
  * @summary: Get event subscriptions
300
449
  * @description: Get event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
301
450
  */
302
- getEventSubscriptions({ pageNo, pageSize, populate }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EventSubscriptions>;
451
+ getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
303
452
  /**
304
453
  * @param {Object} arg - Arg object.
305
454
  * @param {string} arg.companyId - Company id
@@ -316,15 +465,42 @@ declare class Communication {
316
465
  pageSize?: number;
317
466
  populate?: string;
318
467
  }): Paginator<CommunicationPlatformModel.EventSubscriptions>;
468
+ /**
469
+ * @param {CommunicationPlatformApplicationValidator.GetGlobalProvidersParam} arg
470
+ * - Arg object
471
+ *
472
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
473
+ * @param {import("../PlatformAPIClient").Options} - Options
474
+ * @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
475
+ * @name getGlobalProviders
476
+ * @summary: Get global providers
477
+ * @description: Using this API, will retrieve a list of global providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
478
+ */
479
+ getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
480
+ /**
481
+ * @param {CommunicationPlatformApplicationValidator.GetGlobalVariablesParam} arg
482
+ * - Arg object
483
+ *
484
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
485
+ * @param {import("../PlatformAPIClient").Options} - Options
486
+ * @returns {Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>}
487
+ * - Success response
488
+ *
489
+ * @name getGlobalVariables
490
+ * @summary: get global variables
491
+ * @description: get global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
492
+ */
493
+ getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>;
319
494
  /**
320
495
  * @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
496
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
321
497
  * @param {import("../PlatformAPIClient").Options} - Options
322
498
  * @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
323
499
  * @name getJobLogs
324
500
  * @summary: Get job logs
325
501
  * @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
326
502
  */
327
- getJobLogs({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.JobLogs>;
503
+ getJobLogs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
328
504
  /**
329
505
  * @param {Object} arg - Arg object.
330
506
  * @param {string} arg.companyId - Company id
@@ -343,13 +519,14 @@ declare class Communication {
343
519
  }): Paginator<CommunicationPlatformModel.JobLogs>;
344
520
  /**
345
521
  * @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
522
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
346
523
  * @param {import("../PlatformAPIClient").Options} - Options
347
524
  * @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
348
525
  * @name getJobs
349
526
  * @summary: Get jobs
350
527
  * @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
351
528
  */
352
- getJobs({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetJobsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Jobs>;
529
+ getJobs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
353
530
  /**
354
531
  * @param {Object} arg - Arg object.
355
532
  * @param {string} arg.companyId - Company id
@@ -370,73 +547,74 @@ declare class Communication {
370
547
  * @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
371
548
  * - Arg object
372
549
  *
550
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
373
551
  * @param {import("../PlatformAPIClient").Options} - Options
374
552
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
375
553
  * @name getNSampleRecordsFromCsv
376
554
  * @summary: Get n sample records from csv
377
- * @description: Get n sample records from csv - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsv/).
555
+ * @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. Use this API to get n sample records from csv - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsv/).
556
+ */
557
+ getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
558
+ /**
559
+ * @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvByGetParam} arg
560
+ * - Arg object
561
+ *
562
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
563
+ * @param {import("../PlatformAPIClient").Options} - Options
564
+ * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
565
+ * @name getNSampleRecordsFromCsvByGet
566
+ * @summary: Get n sample records from csv
567
+ * @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. Use this API to get n sample records from csv. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
378
568
  */
379
- getNSampleRecordsFromCsv({ body }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
569
+ getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
380
570
  /**
381
571
  * @param {CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam} arg
382
572
  * - Arg object
383
573
  *
574
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
384
575
  * @param {import("../PlatformAPIClient").Options} - Options
385
- * @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
576
+ * @returns {Promise<Object>} - Success response
386
577
  * @name getSmsProviderById
387
578
  * @summary: Get sms provider by id
388
579
  * @description: Get sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
389
580
  */
390
- getSmsProviderById({ id }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProvider>;
581
+ getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
391
582
  /**
392
583
  * @param {CommunicationPlatformApplicationValidator.GetSmsProvidersParam} arg
393
584
  * - Arg object
394
585
  *
586
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
395
587
  * @param {import("../PlatformAPIClient").Options} - Options
396
- * @returns {Promise<CommunicationPlatformModel.SmsProviders>} - Success response
588
+ * @returns {Promise<Object>} - Success response
397
589
  * @name getSmsProviders
398
590
  * @summary: Get sms providers
399
591
  * @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
400
592
  */
401
- getSmsProviders({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProviders>;
402
- /**
403
- * @param {Object} arg - Arg object.
404
- * @param {string} arg.companyId - Company id
405
- * @param {string} arg.applicationId - Application id
406
- * @param {number} [arg.pageSize] - Current request items count
407
- * @param {Object} [arg.sort] - To sort based on created_at
408
- * @returns {Paginator<CommunicationPlatformModel.SmsProviders>}
409
- * @summary: Get sms providers
410
- * @description: Get sms providers
411
- */
412
- getSmsProvidersPaginator({ companyId, applicationId, pageSize, sort }?: {
413
- companyId: string;
414
- applicationId: string;
415
- pageSize?: number;
416
- sort?: any;
417
- }): Paginator<CommunicationPlatformModel.SmsProviders>;
593
+ getSmsProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
418
594
  /**
419
595
  * @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
420
596
  * - Arg object
421
597
  *
598
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
422
599
  * @param {import("../PlatformAPIClient").Options} - Options
423
600
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
424
601
  * @name getSmsTemplateById
425
602
  * @summary: Get sms template by id
426
- * @description: Get sms template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
603
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
427
604
  */
428
- getSmsTemplateById({ id }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplate>;
605
+ getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
429
606
  /**
430
607
  * @param {CommunicationPlatformApplicationValidator.GetSmsTemplatesParam} arg
431
608
  * - Arg object
432
609
  *
610
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
433
611
  * @param {import("../PlatformAPIClient").Options} - Options
434
612
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
435
613
  * @name getSmsTemplates
436
614
  * @summary: Get sms templates
437
- * @description: Get sms templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
615
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
438
616
  */
439
- getSmsTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplates>;
617
+ getSmsTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
440
618
  /**
441
619
  * @param {Object} arg - Arg object.
442
620
  * @param {string} arg.companyId - Company id
@@ -445,7 +623,7 @@ declare class Communication {
445
623
  * @param {Object} [arg.sort] - To sort based on created_at
446
624
  * @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
447
625
  * @summary: Get sms templates
448
- * @description: Get sms templates
626
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.
449
627
  */
450
628
  getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort }?: {
451
629
  companyId: string;
@@ -457,104 +635,157 @@ declare class Communication {
457
635
  * @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
458
636
  * - Arg object
459
637
  *
638
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
460
639
  * @param {import("../PlatformAPIClient").Options} - Options
461
640
  * @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
462
641
  * @name getStatsOfCampaignById
463
642
  * @summary: Get stats of campaign by id
464
643
  * @description: Get stats of campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
465
644
  */
466
- getStatsOfCampaignById({ id }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.GetStats>;
645
+ getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
467
646
  /**
468
- * @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
647
+ * @param {CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam} arg
469
648
  * - Arg object
470
649
  *
650
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
471
651
  * @param {import("../PlatformAPIClient").Options} - Options
472
- * @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
473
- * Success response
474
- * @name getSystemEmailTemplates
475
- * @summary: Get system email templates
476
- * @description: Get system email templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
652
+ * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
653
+ * @name getSubscribedEmailTemplates
654
+ * @summary: Get subscribed email templates
655
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
477
656
  */
478
- getSystemEmailTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
657
+ getSubscribedEmailTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
479
658
  /**
480
659
  * @param {Object} arg - Arg object.
481
660
  * @param {string} arg.companyId - Company id
482
661
  * @param {string} arg.applicationId - Application id
483
662
  * @param {number} [arg.pageSize] - Current request items count
484
- * @param {Object} [arg.sort] - To sort based on created_at
485
- * @returns {Paginator<CommunicationPlatformModel.SystemEmailTemplates>}
486
- * @summary: Get system email templates
487
- * @description: Get system email templates
663
+ * @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
664
+ * @summary: Get subscribed email templates
665
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.
488
666
  */
489
- getSystemEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
667
+ getSubscribedEmailTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
490
668
  companyId: string;
491
669
  applicationId: string;
492
670
  pageSize?: number;
493
- sort?: any;
494
- }): Paginator<CommunicationPlatformModel.SystemEmailTemplates>;
671
+ }): Paginator<CommunicationPlatformModel.EmailTemplates>;
495
672
  /**
496
- * @param {CommunicationPlatformApplicationValidator.GetSystemSystemTemplatesParam} arg
673
+ * @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
497
674
  * - Arg object
498
675
  *
676
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
499
677
  * @param {import("../PlatformAPIClient").Options} - Options
500
- * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates>} -
501
- * Success response
502
- * @name getSystemSystemTemplates
503
- * @summary: Get system sms templates
504
- * @description: Get system sms templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSystemTemplates/).
678
+ * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
679
+ * @name getSubscribedSmsTemplates
680
+ * @summary: Get subscribed sms templates
681
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
505
682
  */
506
- getSystemSystemTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSystemSystemTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SystemSmsTemplates>;
683
+ getSubscribedSmsTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
507
684
  /**
508
685
  * @param {Object} arg - Arg object.
509
686
  * @param {string} arg.companyId - Company id
510
687
  * @param {string} arg.applicationId - Application id
511
688
  * @param {number} [arg.pageSize] - Current request items count
512
- * @param {Object} [arg.sort] - To sort based on created_at
513
- * @returns {Paginator<CommunicationPlatformModel.SystemSmsTemplates>}
514
- * @summary: Get system sms templates
515
- * @description: Get system sms templates
689
+ * @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
690
+ * @summary: Get subscribed sms templates
691
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates.
516
692
  */
517
- getSystemSystemTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
693
+ getSubscribedSmsTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
518
694
  companyId: string;
519
695
  applicationId: string;
520
696
  pageSize?: number;
521
- sort?: any;
522
- }): Paginator<CommunicationPlatformModel.SystemSmsTemplates>;
697
+ }): Paginator<CommunicationPlatformModel.SmsTemplates>;
698
+ /**
699
+ * @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
700
+ * - Arg object
701
+ *
702
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
703
+ * @param {import("../PlatformAPIClient").Options} - Options
704
+ * @returns {Promise<Object>} - Success response
705
+ * @name getSystemAudiences
706
+ * @summary: Get system audiences
707
+ * @description: Get system audiences - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
708
+ */
709
+ getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
710
+ /**
711
+ * @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
712
+ * - Arg object
713
+ *
714
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
715
+ * @param {import("../PlatformAPIClient").Options} - Options
716
+ * @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
717
+ * Success response
718
+ * @name getSystemEmailTemplates
719
+ * @summary: Get system email templates
720
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all system email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
721
+ */
722
+ getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
723
+ /**
724
+ * @param {CommunicationPlatformApplicationValidator.GetSystemSmsTemplatesParam} arg
725
+ * - Arg object
726
+ *
727
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
728
+ * @param {import("../PlatformAPIClient").Options} - Options
729
+ * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
730
+ * Success response
731
+ * @name getSystemSmsTemplates
732
+ * @summary: Get system sms templates
733
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all system sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
734
+ */
735
+ getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates[]>;
736
+ /**
737
+ * @param {CommunicationPlatformApplicationValidator.PostGlobalVariablesParam} arg
738
+ * - Arg object
739
+ *
740
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
741
+ * @param {import("../PlatformAPIClient").Options} - Options
742
+ * @returns {Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>}
743
+ * - Success response
744
+ *
745
+ * @name postGlobalVariables
746
+ * @summary: post global variables
747
+ * @description: psot global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
748
+ */
749
+ postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>;
523
750
  /**
524
751
  * @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
525
752
  * - Arg object
526
753
  *
754
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
527
755
  * @param {import("../PlatformAPIClient").Options} - Options
528
756
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
529
757
  * @name sendCommunicationAsynchronously
530
758
  * @summary: Send email or sms asynchronously
531
759
  * @description: Send email or sms asynchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
532
760
  */
533
- sendCommunicationAsynchronously({ body }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EngineResponse>;
761
+ sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
534
762
  /**
535
763
  * @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
536
764
  * - Arg object
537
765
  *
766
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
538
767
  * @param {import("../PlatformAPIClient").Options} - Options
539
768
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
540
769
  * @name sendCommunicationSynchronously
541
770
  * @summary: Send email or sms synchronously
542
771
  * @description: Send email or sms synchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
543
772
  */
544
- sendCommunicationSynchronously({ body }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EngineResponse>;
773
+ sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
545
774
  /**
546
775
  * @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
776
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
547
777
  * @param {import("../PlatformAPIClient").Options} - Options
548
778
  * @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
549
779
  * @name sendOtp
550
780
  * @summary: Send OTP using email and sms
551
781
  * @description: Send OTP Comms via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
552
782
  */
553
- sendOtp({ body }?: CommunicationPlatformApplicationValidator.SendOtpParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
783
+ sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
554
784
  /**
555
785
  * @param {CommunicationPlatformApplicationValidator.TriggerCampaignJobParam} arg
556
786
  * - Arg object
557
787
  *
788
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
558
789
  * @param {import("../PlatformAPIClient").Options} - Options
559
790
  * @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
560
791
  * Success response
@@ -562,75 +793,94 @@ declare class Communication {
562
793
  * @summary: Trigger campaign job
563
794
  * @description: Trigger campaign job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
564
795
  */
565
- triggerCampaignJob({ body }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.TriggerJobResponse>;
796
+ triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResponse>;
797
+ /**
798
+ * @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg
799
+ * - Arg object
800
+ *
801
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
802
+ * @param {import("../PlatformAPIClient").Options} - Options
803
+ * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
804
+ * @name updateAppProviders
805
+ * @summary: update app providers
806
+ * @description: Using this API will update the application providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
807
+ */
808
+ updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
566
809
  /**
567
810
  * @param {CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam} arg
568
811
  * - Arg object
569
812
  *
813
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
570
814
  * @param {import("../PlatformAPIClient").Options} - Options
571
815
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
572
816
  * @name updateAudienceById
573
817
  * @summary: Update audience by id
574
- * @description: Update audience by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
818
+ * @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. Use this API to update audience by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
575
819
  */
576
- updateAudienceById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audience>;
820
+ updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
577
821
  /**
578
822
  * @param {CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam} arg
579
823
  * - Arg object
580
824
  *
825
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
581
826
  * @param {import("../PlatformAPIClient").Options} - Options
582
827
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
583
828
  * @name updateCampaignById
584
829
  * @summary: Update campaign by id
585
830
  * @description: Update campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
586
831
  */
587
- updateCampaignById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaign>;
832
+ updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
588
833
  /**
589
834
  * @param {CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam} arg
590
835
  * - Arg object
591
836
  *
837
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
592
838
  * @param {import("../PlatformAPIClient").Options} - Options
593
839
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
594
840
  * @name updateEmailProviderById
595
841
  * @summary: Update email provider by id
596
842
  * @description: Update email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
597
843
  */
598
- updateEmailProviderById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProvider>;
844
+ updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
599
845
  /**
600
846
  * @param {CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam} arg
601
847
  * - Arg object
602
848
  *
849
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
603
850
  * @param {import("../PlatformAPIClient").Options} - Options
604
- * @returns {Promise<CommunicationPlatformModel.EmailTemplateRes>} - Success response
851
+ * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
605
852
  * @name updateEmailTemplateById
606
853
  * @summary: Update email template by id
607
- * @description: Update email template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
854
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to update an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
608
855
  */
609
- updateEmailTemplateById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplateRes>;
856
+ updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
610
857
  /**
611
858
  * @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
612
859
  * - Arg object
613
860
  *
861
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
614
862
  * @param {import("../PlatformAPIClient").Options} - Options
615
- * @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
863
+ * @returns {Promise<Object>} - Success response
616
864
  * @name updateSmsProviderById
617
865
  * @summary: Update sms provider by id
618
866
  * @description: Update sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
619
867
  */
620
- updateSmsProviderById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProvider>;
868
+ updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
621
869
  /**
622
870
  * @param {CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam} arg
623
871
  * - Arg object
624
872
  *
873
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
625
874
  * @param {import("../PlatformAPIClient").Options} - Options
626
- * @returns {Promise<CommunicationPlatformModel.SmsTemplateRes>} - Success response
875
+ * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
627
876
  * @name updateSmsTemplateById
628
877
  * @summary: Update sms template by id
629
- * @description: Update sms template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
878
+ * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to update an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
630
879
  */
631
- updateSmsTemplateById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplateRes>;
880
+ updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
632
881
  /**
633
882
  * @param {CommunicationPlatformApplicationValidator.VerfiyOtpParam} arg - Arg object
883
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
634
884
  * @param {import("../PlatformAPIClient").Options} - Options
635
885
  * @returns {Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>}
636
886
  * - Success response
@@ -639,7 +889,7 @@ declare class Communication {
639
889
  * @summary: Verify OTP sent via email and sms
640
890
  * @description: Verify OTP sent via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
641
891
  */
642
- verfiyOtp({ body }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
892
+ verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
643
893
  }
644
894
  import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator");
645
895
  import CommunicationPlatformModel = require("./CommunicationPlatformModel");