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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -24,7 +24,7 @@ class Communication {
24
24
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
25
25
  * @name createAudience
26
26
  * @summary: Create an audience
27
- * @description: Creates a new email audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
27
+ * @description: Creates a new email audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createAudience/).
28
28
  */
29
29
  async createAudience(
30
30
  { body, requestHeaders } = { requestHeaders: {} },
@@ -96,231 +96,6 @@ class Communication {
96
96
  return response;
97
97
  }
98
98
 
99
- /**
100
- * @param {CommunicationPlatformApplicationValidator.CreateBigQueryHeadersParam} arg
101
- * - Arg object
102
- *
103
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
104
- * @param {import("../PlatformAPIClient").Options} - Options
105
- * @returns {Promise<Object>} - Success response
106
- * @name createBigQueryHeaders
107
- * @summary: Create BigQuery headers
108
- * @description: Create BigQuery headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
109
- */
110
- async createBigQueryHeaders(
111
- { requestHeaders } = { requestHeaders: {} },
112
- { responseHeaders } = { responseHeaders: false }
113
- ) {
114
- const {
115
- error,
116
- } = CommunicationPlatformApplicationValidator.createBigQueryHeaders().validate(
117
- {},
118
- { abortEarly: false, allowUnknown: true }
119
- );
120
- if (error) {
121
- return Promise.reject(new FDKClientValidationError(error));
122
- }
123
-
124
- // Showing warrnings if extra unknown parameters are found
125
- const {
126
- error: warrning,
127
- } = CommunicationPlatformApplicationValidator.createBigQueryHeaders().validate(
128
- {},
129
- { abortEarly: false, allowUnknown: false }
130
- );
131
- if (warrning) {
132
- Logger({
133
- level: "WARN",
134
- message: `Parameter Validation warrnings for platform > Communication > createBigQueryHeaders \n ${warrning}`,
135
- });
136
- }
137
-
138
- const query_params = {};
139
-
140
- const response = await PlatformAPIClient.execute(
141
- this.config,
142
- "post",
143
- `/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-headers`,
144
- query_params,
145
- undefined,
146
- requestHeaders,
147
- { responseHeaders }
148
- );
149
-
150
- let responseData = response;
151
- if (responseHeaders) {
152
- responseData = response[0];
153
- }
154
-
155
- const { error: res_error } = Joi.any().validate(responseData, {
156
- abortEarly: false,
157
- allowUnknown: true,
158
- });
159
-
160
- if (res_error) {
161
- if (this.config.options.strictResponseCheck === true) {
162
- return Promise.reject(new FDKResponseValidationError(res_error));
163
- } else {
164
- Logger({
165
- level: "WARN",
166
- message: `Response Validation Warnings for platform > Communication > createBigQueryHeaders \n ${res_error}`,
167
- });
168
- }
169
- }
170
-
171
- return response;
172
- }
173
-
174
- /**
175
- * @param {CommunicationPlatformApplicationValidator.CreateBigQueryNCountParam} arg
176
- * - Arg object
177
- *
178
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
179
- * @param {import("../PlatformAPIClient").Options} - Options
180
- * @returns {Promise<Object>} - Success response
181
- * @name createBigQueryNCount
182
- * @summary: Create BigQuery N-count
183
- * @description: Creates big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
184
- */
185
- async createBigQueryNCount(
186
- { requestHeaders } = { requestHeaders: {} },
187
- { responseHeaders } = { responseHeaders: false }
188
- ) {
189
- const {
190
- error,
191
- } = CommunicationPlatformApplicationValidator.createBigQueryNCount().validate(
192
- {},
193
- { abortEarly: false, allowUnknown: true }
194
- );
195
- if (error) {
196
- return Promise.reject(new FDKClientValidationError(error));
197
- }
198
-
199
- // Showing warrnings if extra unknown parameters are found
200
- const {
201
- error: warrning,
202
- } = CommunicationPlatformApplicationValidator.createBigQueryNCount().validate(
203
- {},
204
- { abortEarly: false, allowUnknown: false }
205
- );
206
- if (warrning) {
207
- Logger({
208
- level: "WARN",
209
- message: `Parameter Validation warrnings for platform > Communication > createBigQueryNCount \n ${warrning}`,
210
- });
211
- }
212
-
213
- const query_params = {};
214
-
215
- const response = await PlatformAPIClient.execute(
216
- this.config,
217
- "post",
218
- `/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-n-records`,
219
- query_params,
220
- undefined,
221
- requestHeaders,
222
- { responseHeaders }
223
- );
224
-
225
- let responseData = response;
226
- if (responseHeaders) {
227
- responseData = response[0];
228
- }
229
-
230
- const { error: res_error } = Joi.any().validate(responseData, {
231
- abortEarly: false,
232
- allowUnknown: true,
233
- });
234
-
235
- if (res_error) {
236
- if (this.config.options.strictResponseCheck === true) {
237
- return Promise.reject(new FDKResponseValidationError(res_error));
238
- } else {
239
- Logger({
240
- level: "WARN",
241
- message: `Response Validation Warnings for platform > Communication > createBigQueryNCount \n ${res_error}`,
242
- });
243
- }
244
- }
245
-
246
- return response;
247
- }
248
-
249
- /**
250
- * @param {CommunicationPlatformApplicationValidator.CreateBigQueryRowCountParam} arg
251
- * - Arg object
252
- *
253
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
254
- * @param {import("../PlatformAPIClient").Options} - Options
255
- * @returns {Promise<Object>} - Success response
256
- * @name createBigQueryRowCount
257
- * @summary: Create a BigQuery row count
258
- * @description: Creates big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
259
- */
260
- async createBigQueryRowCount(
261
- { requestHeaders } = { requestHeaders: {} },
262
- { responseHeaders } = { responseHeaders: false }
263
- ) {
264
- const {
265
- error,
266
- } = CommunicationPlatformApplicationValidator.createBigQueryRowCount().validate(
267
- {},
268
- { abortEarly: false, allowUnknown: true }
269
- );
270
- if (error) {
271
- return Promise.reject(new FDKClientValidationError(error));
272
- }
273
-
274
- // Showing warrnings if extra unknown parameters are found
275
- const {
276
- error: warrning,
277
- } = CommunicationPlatformApplicationValidator.createBigQueryRowCount().validate(
278
- {},
279
- { abortEarly: false, allowUnknown: false }
280
- );
281
- if (warrning) {
282
- Logger({
283
- level: "WARN",
284
- message: `Parameter Validation warrnings for platform > Communication > createBigQueryRowCount \n ${warrning}`,
285
- });
286
- }
287
-
288
- const query_params = {};
289
-
290
- const response = await PlatformAPIClient.execute(
291
- this.config,
292
- "post",
293
- `/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-row-count`,
294
- query_params,
295
- undefined,
296
- requestHeaders,
297
- { responseHeaders }
298
- );
299
-
300
- let responseData = response;
301
- if (responseHeaders) {
302
- responseData = response[0];
303
- }
304
-
305
- const { error: res_error } = Joi.any().validate(responseData, {
306
- abortEarly: false,
307
- allowUnknown: true,
308
- });
309
-
310
- if (res_error) {
311
- if (this.config.options.strictResponseCheck === true) {
312
- return Promise.reject(new FDKResponseValidationError(res_error));
313
- } else {
314
- Logger({
315
- level: "WARN",
316
- message: `Response Validation Warnings for platform > Communication > createBigQueryRowCount \n ${res_error}`,
317
- });
318
- }
319
- }
320
-
321
- return response;
322
- }
323
-
324
99
  /**
325
100
  * @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
326
101
  * - Arg object
@@ -330,7 +105,7 @@ class Communication {
330
105
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
331
106
  * @name createCampaign
332
107
  * @summary: Create a campaign
333
- * @description: Creates a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
108
+ * @description: Creates a new communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createCampaign/).
334
109
  */
335
110
  async createCampaign(
336
111
  { body, requestHeaders } = { requestHeaders: {} },
@@ -411,7 +186,7 @@ class Communication {
411
186
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
412
187
  * @name createEmailProvider
413
188
  * @summary: Create an email provider
414
- * @description: Creates a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
189
+ * @description: Creates a new email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailProvider/).
415
190
  */
416
191
  async createEmailProvider(
417
192
  { body, requestHeaders } = { requestHeaders: {} },
@@ -492,7 +267,7 @@ class Communication {
492
267
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
493
268
  * @name createEmailTemplate
494
269
  * @summary: Creat an email template
495
- * @description: Creates a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
270
+ * @description: Creates a new email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailTemplate/).
496
271
  */
497
272
  async createEmailTemplate(
498
273
  { body, requestHeaders } = { requestHeaders: {} },
@@ -570,12 +345,12 @@ class Communication {
570
345
  *
571
346
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
572
347
  * @param {import("../PlatformAPIClient").Options} - Options
573
- * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
348
+ * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
574
349
  * - Success response
575
350
  *
576
351
  * @name createEventSubscriptions
577
352
  * @summary: Create an event subscription
578
- * @description: Creates a new event subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
353
+ * @description: Creates a new event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptions/).
579
354
  */
580
355
  async createEventSubscriptions(
581
356
  { body, requestHeaders } = { requestHeaders: {} },
@@ -628,7 +403,7 @@ class Communication {
628
403
 
629
404
  const {
630
405
  error: res_error,
631
- } = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse().validate(
406
+ } = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult().validate(
632
407
  responseData,
633
408
  { abortEarly: false, allowUnknown: true }
634
409
  );
@@ -654,13 +429,13 @@ class Communication {
654
429
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
655
430
  * @param {import("../PlatformAPIClient").Options} - Options
656
431
  * @returns {Promise<
657
- * CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]
432
+ * CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]
658
433
  * >}
659
434
  * - Success response
660
435
  *
661
436
  * @name createEventSubscriptionsByBulk
662
437
  * @summary: Create event subscriptions in bulk
663
- * @description: Creates a new event subscription in bulk. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
438
+ * @description: Creates a new event subscription in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptionsByBulk/).
664
439
  */
665
440
  async createEventSubscriptionsByBulk(
666
441
  { body, requestHeaders } = { requestHeaders: {} },
@@ -712,7 +487,7 @@ class Communication {
712
487
  }
713
488
 
714
489
  const { error: res_error } = Joi.array()
715
- .items(CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse())
490
+ .items(CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult())
716
491
  .validate(responseData, { abortEarly: false, allowUnknown: true });
717
492
 
718
493
  if (res_error) {
@@ -736,7 +511,7 @@ class Communication {
736
511
  * @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
737
512
  * @name createJobs
738
513
  * @summary: Create a campaign jobs
739
- * @description: Creates a new campaign job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createJobs/).
514
+ * @description: Creates a new campaign job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createJobs/).
740
515
  */
741
516
  async createJobs(
742
517
  { body, requestHeaders } = { requestHeaders: {} },
@@ -817,7 +592,7 @@ class Communication {
817
592
  * @returns {Promise<Object>} - Success response
818
593
  * @name createSmsProvider
819
594
  * @summary: Create SMS provider
820
- * @description: Creates a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
595
+ * @description: Creates a new SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsProvider/).
821
596
  */
822
597
  async createSmsProvider(
823
598
  { body, requestHeaders } = { requestHeaders: {} },
@@ -896,7 +671,7 @@ class Communication {
896
671
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
897
672
  * @name createSmsTemplate
898
673
  * @summary: Create a SMS template
899
- * @description: Creates a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
674
+ * @description: Creates a new SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsTemplate/).
900
675
  */
901
676
  async createSmsTemplate(
902
677
  { body, requestHeaders } = { requestHeaders: {} },
@@ -977,7 +752,7 @@ class Communication {
977
752
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
978
753
  * @name deleteAudienceById
979
754
  * @summary: Delete an audience
980
- * @description: Remove a specific audience permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
755
+ * @description: Remove a specific audience permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteAudienceById/).
981
756
  */
982
757
  async deleteAudienceById(
983
758
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -1060,7 +835,7 @@ class Communication {
1060
835
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1061
836
  * @name deleteEmailProviderById
1062
837
  * @summary: Delete an email provider
1063
- * @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/).
838
+ * @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailProviderById/).
1064
839
  */
1065
840
  async deleteEmailProviderById(
1066
841
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1141,7 +916,7 @@ class Communication {
1141
916
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1142
917
  * @name deleteEmailTemplateById
1143
918
  * @summary: Delete an email template
1144
- * @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/).
919
+ * @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailTemplateById/).
1145
920
  */
1146
921
  async deleteEmailTemplateById(
1147
922
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1222,7 +997,7 @@ class Communication {
1222
997
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1223
998
  * @name deleteEventSubscriptionsById
1224
999
  * @summary: Delete an event subscriptions
1225
- * @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEventSubscriptionsById/).
1000
+ * @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEventSubscriptionsById/).
1226
1001
  */
1227
1002
  async deleteEventSubscriptionsById(
1228
1003
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1303,7 +1078,7 @@ class Communication {
1303
1078
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1304
1079
  * @name deleteSmsProviderById
1305
1080
  * @summary: Delete an SMS provider
1306
- * @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/).
1081
+ * @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsProviderById/).
1307
1082
  */
1308
1083
  async deleteSmsProviderById(
1309
1084
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1384,7 +1159,7 @@ class Communication {
1384
1159
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1385
1160
  * @name deleteSmsTemplateById
1386
1161
  * @summary: Delete an SMS template
1387
- * @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/).
1162
+ * @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsTemplateById/).
1388
1163
  */
1389
1164
  async deleteSmsTemplateById(
1390
1165
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1462,12 +1237,12 @@ class Communication {
1462
1237
  *
1463
1238
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1464
1239
  * @param {import("../PlatformAPIClient").Options} - Options
1465
- * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
1240
+ * @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
1466
1241
  * - Success response
1467
1242
  *
1468
1243
  * @name editEventSubscriptions
1469
1244
  * @summary: Update an event subscriptions
1470
- * @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/).
1245
+ * @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/editEventSubscriptions/).
1471
1246
  */
1472
1247
  async editEventSubscriptions(
1473
1248
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -1522,7 +1297,7 @@ class Communication {
1522
1297
 
1523
1298
  const {
1524
1299
  error: res_error,
1525
- } = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse().validate(
1300
+ } = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult().validate(
1526
1301
  responseData,
1527
1302
  { abortEarly: false, allowUnknown: true }
1528
1303
  );
@@ -1550,7 +1325,7 @@ class Communication {
1550
1325
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
1551
1326
  * @name getAppProviders
1552
1327
  * @summary: Get application providers
1553
- * @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/).
1328
+ * @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAppProviders/).
1554
1329
  */
1555
1330
  async getAppProviders(
1556
1331
  { requestHeaders } = { requestHeaders: {} },
@@ -1627,7 +1402,7 @@ class Communication {
1627
1402
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
1628
1403
  * @name getAudienceById
1629
1404
  * @summary: Get an audience
1630
- * @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
1405
+ * @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudienceById/).
1631
1406
  */
1632
1407
  async getAudienceById(
1633
1408
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1708,7 +1483,7 @@ class Communication {
1708
1483
  * @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
1709
1484
  * @name getAudiences
1710
1485
  * @summary: Get all the audiences
1711
- * @description: Retrieves a list of all the audiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
1486
+ * @description: Retrieves a list of all the audiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudiences/).
1712
1487
  */
1713
1488
  async getAudiences(
1714
1489
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -1790,164 +1565,6 @@ class Communication {
1790
1565
  return response;
1791
1566
  }
1792
1567
 
1793
- /**
1794
- * @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
1795
- * - Arg object
1796
- *
1797
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1798
- * @param {import("../PlatformAPIClient").Options} - Options
1799
- * @returns {Promise<Object>} - Success response
1800
- * @name getBigQueryHeadersById
1801
- * @summary: Get BigQuery headers
1802
- * @description: Retrieves header information from BigQuery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
1803
- */
1804
- async getBigQueryHeadersById(
1805
- { id, requestHeaders } = { requestHeaders: {} },
1806
- { responseHeaders } = { responseHeaders: false }
1807
- ) {
1808
- const {
1809
- error,
1810
- } = CommunicationPlatformApplicationValidator.getBigQueryHeadersById().validate(
1811
- {
1812
- id,
1813
- },
1814
- { abortEarly: false, allowUnknown: true }
1815
- );
1816
- if (error) {
1817
- return Promise.reject(new FDKClientValidationError(error));
1818
- }
1819
-
1820
- // Showing warrnings if extra unknown parameters are found
1821
- const {
1822
- error: warrning,
1823
- } = CommunicationPlatformApplicationValidator.getBigQueryHeadersById().validate(
1824
- {
1825
- id,
1826
- },
1827
- { abortEarly: false, allowUnknown: false }
1828
- );
1829
- if (warrning) {
1830
- Logger({
1831
- level: "WARN",
1832
- message: `Parameter Validation warrnings for platform > Communication > getBigQueryHeadersById \n ${warrning}`,
1833
- });
1834
- }
1835
-
1836
- const query_params = {};
1837
-
1838
- const response = await PlatformAPIClient.execute(
1839
- this.config,
1840
- "get",
1841
- `/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-headers/${id}`,
1842
- query_params,
1843
- undefined,
1844
- requestHeaders,
1845
- { responseHeaders }
1846
- );
1847
-
1848
- let responseData = response;
1849
- if (responseHeaders) {
1850
- responseData = response[0];
1851
- }
1852
-
1853
- const { error: res_error } = Joi.any().validate(responseData, {
1854
- abortEarly: false,
1855
- allowUnknown: true,
1856
- });
1857
-
1858
- if (res_error) {
1859
- if (this.config.options.strictResponseCheck === true) {
1860
- return Promise.reject(new FDKResponseValidationError(res_error));
1861
- } else {
1862
- Logger({
1863
- level: "WARN",
1864
- message: `Response Validation Warnings for platform > Communication > getBigQueryHeadersById \n ${res_error}`,
1865
- });
1866
- }
1867
- }
1868
-
1869
- return response;
1870
- }
1871
-
1872
- /**
1873
- * @param {CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam} arg
1874
- * - Arg object
1875
- *
1876
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1877
- * @param {import("../PlatformAPIClient").Options} - Options
1878
- * @returns {Promise<Object>} - Success response
1879
- * @name getBigQueryRowCountById
1880
- * @summary: Get BigQuery row count
1881
- * @description: Retrieves big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
1882
- */
1883
- async getBigQueryRowCountById(
1884
- { id, requestHeaders } = { requestHeaders: {} },
1885
- { responseHeaders } = { responseHeaders: false }
1886
- ) {
1887
- const {
1888
- error,
1889
- } = CommunicationPlatformApplicationValidator.getBigQueryRowCountById().validate(
1890
- {
1891
- id,
1892
- },
1893
- { abortEarly: false, allowUnknown: true }
1894
- );
1895
- if (error) {
1896
- return Promise.reject(new FDKClientValidationError(error));
1897
- }
1898
-
1899
- // Showing warrnings if extra unknown parameters are found
1900
- const {
1901
- error: warrning,
1902
- } = CommunicationPlatformApplicationValidator.getBigQueryRowCountById().validate(
1903
- {
1904
- id,
1905
- },
1906
- { abortEarly: false, allowUnknown: false }
1907
- );
1908
- if (warrning) {
1909
- Logger({
1910
- level: "WARN",
1911
- message: `Parameter Validation warrnings for platform > Communication > getBigQueryRowCountById \n ${warrning}`,
1912
- });
1913
- }
1914
-
1915
- const query_params = {};
1916
-
1917
- const response = await PlatformAPIClient.execute(
1918
- this.config,
1919
- "get",
1920
- `/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-row-count/${id}`,
1921
- query_params,
1922
- undefined,
1923
- requestHeaders,
1924
- { responseHeaders }
1925
- );
1926
-
1927
- let responseData = response;
1928
- if (responseHeaders) {
1929
- responseData = response[0];
1930
- }
1931
-
1932
- const { error: res_error } = Joi.any().validate(responseData, {
1933
- abortEarly: false,
1934
- allowUnknown: true,
1935
- });
1936
-
1937
- if (res_error) {
1938
- if (this.config.options.strictResponseCheck === true) {
1939
- return Promise.reject(new FDKResponseValidationError(res_error));
1940
- } else {
1941
- Logger({
1942
- level: "WARN",
1943
- message: `Response Validation Warnings for platform > Communication > getBigQueryRowCountById \n ${res_error}`,
1944
- });
1945
- }
1946
- }
1947
-
1948
- return response;
1949
- }
1950
-
1951
1568
  /**
1952
1569
  * @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
1953
1570
  * - Arg object
@@ -1957,7 +1574,7 @@ class Communication {
1957
1574
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
1958
1575
  * @name getCampaignById
1959
1576
  * @summary: Get a campaign
1960
- * @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
1577
+ * @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaignById/).
1961
1578
  */
1962
1579
  async getCampaignById(
1963
1580
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2038,7 +1655,7 @@ class Communication {
2038
1655
  * @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
2039
1656
  * @name getCampaigns
2040
1657
  * @summary: Get all campaigns
2041
- * @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
1658
+ * @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaigns/).
2042
1659
  */
2043
1660
  async getCampaigns(
2044
1661
  { query, pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
@@ -2129,7 +1746,7 @@ class Communication {
2129
1746
  * @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
2130
1747
  * @name getCommunicationLogs
2131
1748
  * @summary: Get communication reports
2132
- * @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/).
1749
+ * @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCommunicationLogs/).
2133
1750
  */
2134
1751
  async getCommunicationLogs(
2135
1752
  { pageId, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2221,7 +1838,7 @@ class Communication {
2221
1838
  * Success response
2222
1839
  * @name getDefaultSmsProviders
2223
1840
  * @summary: Get all default SMS providers
2224
- * @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
1841
+ * @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDefaultSmsProviders/).
2225
1842
  */
2226
1843
  async getDefaultSmsProviders(
2227
1844
  { requestHeaders } = { requestHeaders: {} },
@@ -2296,7 +1913,7 @@ class Communication {
2296
1913
  * Success response
2297
1914
  * @name getDummyDatasources
2298
1915
  * @summary: Get dummy data sources
2299
- * @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
1916
+ * @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasources/).
2300
1917
  */
2301
1918
  async getDummyDatasources(
2302
1919
  { requestHeaders } = { requestHeaders: {} },
@@ -2371,7 +1988,7 @@ class Communication {
2371
1988
  * Success response
2372
1989
  * @name getDummyDatasourcesMeta
2373
1990
  * @summary: Get dummy data sources metadata
2374
- * @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
1991
+ * @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasourcesMeta/).
2375
1992
  */
2376
1993
  async getDummyDatasourcesMeta(
2377
1994
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2452,7 +2069,7 @@ class Communication {
2452
2069
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
2453
2070
  * @name getEmailProviderById
2454
2071
  * @summary: Get a email provider
2455
- * @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
2072
+ * @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviderById/).
2456
2073
  */
2457
2074
  async getEmailProviderById(
2458
2075
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2533,7 +2150,7 @@ class Communication {
2533
2150
  * @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
2534
2151
  * @name getEmailProviders
2535
2152
  * @summary: Get all email providers
2536
- * @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/).
2153
+ * @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviders/).
2537
2154
  */
2538
2155
  async getEmailProviders(
2539
2156
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2624,7 +2241,7 @@ class Communication {
2624
2241
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
2625
2242
  * @name getEmailTemplateById
2626
2243
  * @summary: Get an email template
2627
- * @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
2244
+ * @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplateById/).
2628
2245
  */
2629
2246
  async getEmailTemplateById(
2630
2247
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2705,7 +2322,7 @@ class Communication {
2705
2322
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
2706
2323
  * @name getEmailTemplates
2707
2324
  * @summary: Get all email templates
2708
- * @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
2325
+ * @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplates/).
2709
2326
  */
2710
2327
  async getEmailTemplates(
2711
2328
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2797,10 +2414,18 @@ class Communication {
2797
2414
  * Success response
2798
2415
  * @name getEventSubscriptions
2799
2416
  * @summary: Get all event subscriptions
2800
- * @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
2417
+ * @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptions/).
2801
2418
  */
2802
2419
  async getEventSubscriptions(
2803
- { pageNo, pageSize, populate, requestHeaders } = { requestHeaders: {} },
2420
+ {
2421
+ pageNo,
2422
+ pageSize,
2423
+ populate,
2424
+ group,
2425
+ subGroup,
2426
+ fulfillmentOptionSlug,
2427
+ requestHeaders,
2428
+ } = { requestHeaders: {} },
2804
2429
  { responseHeaders } = { responseHeaders: false }
2805
2430
  ) {
2806
2431
  const {
@@ -2810,6 +2435,9 @@ class Communication {
2810
2435
  pageNo,
2811
2436
  pageSize,
2812
2437
  populate,
2438
+ group,
2439
+ subGroup,
2440
+ fulfillmentOptionSlug,
2813
2441
  },
2814
2442
  { abortEarly: false, allowUnknown: true }
2815
2443
  );
@@ -2825,6 +2453,9 @@ class Communication {
2825
2453
  pageNo,
2826
2454
  pageSize,
2827
2455
  populate,
2456
+ group,
2457
+ subGroup,
2458
+ fulfillmentOptionSlug,
2828
2459
  },
2829
2460
  { abortEarly: false, allowUnknown: false }
2830
2461
  );
@@ -2839,6 +2470,9 @@ class Communication {
2839
2470
  query_params["page_no"] = pageNo;
2840
2471
  query_params["page_size"] = pageSize;
2841
2472
  query_params["populate"] = populate;
2473
+ query_params["group"] = group;
2474
+ query_params["sub_group"] = subGroup;
2475
+ query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
2842
2476
 
2843
2477
  const response = await PlatformAPIClient.execute(
2844
2478
  this.config,
@@ -2885,7 +2519,7 @@ class Communication {
2885
2519
  * @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
2886
2520
  * @name getEventSubscriptionsById
2887
2521
  * @summary: Get an event subscription
2888
- * @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptionsById/).
2522
+ * @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptionsById/).
2889
2523
  */
2890
2524
  async getEventSubscriptionsById(
2891
2525
  { id, populate, requestHeaders } = { requestHeaders: {} },
@@ -2969,7 +2603,7 @@ class Communication {
2969
2603
  * @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
2970
2604
  * @name getGlobalProviders
2971
2605
  * @summary: Get global providers
2972
- * @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/).
2606
+ * @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalProviders/).
2973
2607
  */
2974
2608
  async getGlobalProviders(
2975
2609
  { requestHeaders } = { requestHeaders: {} },
@@ -3043,12 +2677,12 @@ class Communication {
3043
2677
  *
3044
2678
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3045
2679
  * @param {import("../PlatformAPIClient").Options} - Options
3046
- * @returns {Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>}
2680
+ * @returns {Promise<CommunicationPlatformModel.GetGlobalVariablesResult>}
3047
2681
  * - Success response
3048
2682
  *
3049
2683
  * @name getGlobalVariables
3050
2684
  * @summary: Get all global variables
3051
- * @description: Retrieves a list of communication global variables. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
2685
+ * @description: Retrieves a list of communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalVariables/).
3052
2686
  */
3053
2687
  async getGlobalVariables(
3054
2688
  { requestHeaders } = { requestHeaders: {} },
@@ -3097,7 +2731,7 @@ class Communication {
3097
2731
 
3098
2732
  const {
3099
2733
  error: res_error,
3100
- } = CommunicationPlatformModel.GlobalVariablesGetResponse().validate(
2734
+ } = CommunicationPlatformModel.GetGlobalVariablesResult().validate(
3101
2735
  responseData,
3102
2736
  { abortEarly: false, allowUnknown: true }
3103
2737
  );
@@ -3123,7 +2757,7 @@ class Communication {
3123
2757
  * @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
3124
2758
  * @name getJobLogs
3125
2759
  * @summary: Get logs of all campaign job
3126
- * @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
2760
+ * @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobLogs/).
3127
2761
  */
3128
2762
  async getJobLogs(
3129
2763
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3212,7 +2846,7 @@ class Communication {
3212
2846
  * @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
3213
2847
  * @name getJobs
3214
2848
  * @summary: Get all campaign jobs
3215
- * @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
2849
+ * @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobs/).
3216
2850
  */
3217
2851
  async getJobs(
3218
2852
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3303,7 +2937,7 @@ class Communication {
3303
2937
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
3304
2938
  * @name getNSampleRecordsFromCsv
3305
2939
  * @summary: Get N sample records of a CSV
3306
- * @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/).
2940
+ * @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsv/).
3307
2941
  */
3308
2942
  async getNSampleRecordsFromCsv(
3309
2943
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3384,7 +3018,7 @@ class Communication {
3384
3018
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
3385
3019
  * @name getNSampleRecordsFromCsvByGet
3386
3020
  * @summary: Get N sample records of a CSV
3387
- * @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/).
3021
+ * @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
3388
3022
  */
3389
3023
  async getNSampleRecordsFromCsvByGet(
3390
3024
  { requestHeaders } = { requestHeaders: {} },
@@ -3461,7 +3095,7 @@ class Communication {
3461
3095
  * @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
3462
3096
  * @name getOtpConfiguration
3463
3097
  * @summary: Get configuration of otp
3464
- * @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getOtpConfiguration/).
3098
+ * @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getOtpConfiguration/).
3465
3099
  */
3466
3100
  async getOtpConfiguration(
3467
3101
  { requestHeaders } = { requestHeaders: {} },
@@ -3538,7 +3172,7 @@ class Communication {
3538
3172
  * @returns {Promise<Object>} - Success response
3539
3173
  * @name getSmsProviderById
3540
3174
  * @summary: Get a SMS provider
3541
- * @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
3175
+ * @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviderById/).
3542
3176
  */
3543
3177
  async getSmsProviderById(
3544
3178
  { id, requestHeaders } = { requestHeaders: {} },
@@ -3617,7 +3251,7 @@ class Communication {
3617
3251
  * @returns {Promise<Object>} - Success response
3618
3252
  * @name getSmsProviders
3619
3253
  * @summary: Get all SMS providers
3620
- * @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
3254
+ * @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviders/).
3621
3255
  */
3622
3256
  async getSmsProviders(
3623
3257
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3706,7 +3340,7 @@ class Communication {
3706
3340
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
3707
3341
  * @name getSmsTemplateById
3708
3342
  * @summary: Get a SMS template
3709
- * @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
3343
+ * @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplateById/).
3710
3344
  */
3711
3345
  async getSmsTemplateById(
3712
3346
  { id, requestHeaders } = { requestHeaders: {} },
@@ -3787,7 +3421,7 @@ class Communication {
3787
3421
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
3788
3422
  * @name getSmsTemplates
3789
3423
  * @summary: Get all SMS templates
3790
- * @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
3424
+ * @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplates/).
3791
3425
  */
3792
3426
  async getSmsTemplates(
3793
3427
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3878,7 +3512,7 @@ class Communication {
3878
3512
  * @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
3879
3513
  * @name getStatsOfCampaignById
3880
3514
  * @summary: Get campaign statistics
3881
- * @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
3515
+ * @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getStatsOfCampaignById/).
3882
3516
  */
3883
3517
  async getStatsOfCampaignById(
3884
3518
  { id, requestHeaders } = { requestHeaders: {} },
@@ -3959,7 +3593,7 @@ class Communication {
3959
3593
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
3960
3594
  * @name getSubscribedEmailTemplates
3961
3595
  * @summary: Get all subscribed email templates
3962
- * @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/).
3596
+ * @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedEmailTemplates/).
3963
3597
  */
3964
3598
  async getSubscribedEmailTemplates(
3965
3599
  { pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
@@ -4047,7 +3681,7 @@ class Communication {
4047
3681
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
4048
3682
  * @name getSubscribedSmsTemplates
4049
3683
  * @summary: Get all subscribed SMS templates
4050
- * @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/).
3684
+ * @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedSmsTemplates/).
4051
3685
  */
4052
3686
  async getSubscribedSmsTemplates(
4053
3687
  { pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
@@ -4126,81 +3760,6 @@ class Communication {
4126
3760
  return response;
4127
3761
  }
4128
3762
 
4129
- /**
4130
- * @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
4131
- * - Arg object
4132
- *
4133
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4134
- * @param {import("../PlatformAPIClient").Options} - Options
4135
- * @returns {Promise<Object>} - Success response
4136
- * @name getSystemAudiences
4137
- * @summary: Get system audiences
4138
- * @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
4139
- */
4140
- async getSystemAudiences(
4141
- { requestHeaders } = { requestHeaders: {} },
4142
- { responseHeaders } = { responseHeaders: false }
4143
- ) {
4144
- const {
4145
- error,
4146
- } = CommunicationPlatformApplicationValidator.getSystemAudiences().validate(
4147
- {},
4148
- { abortEarly: false, allowUnknown: true }
4149
- );
4150
- if (error) {
4151
- return Promise.reject(new FDKClientValidationError(error));
4152
- }
4153
-
4154
- // Showing warrnings if extra unknown parameters are found
4155
- const {
4156
- error: warrning,
4157
- } = CommunicationPlatformApplicationValidator.getSystemAudiences().validate(
4158
- {},
4159
- { abortEarly: false, allowUnknown: false }
4160
- );
4161
- if (warrning) {
4162
- Logger({
4163
- level: "WARN",
4164
- message: `Parameter Validation warrnings for platform > Communication > getSystemAudiences \n ${warrning}`,
4165
- });
4166
- }
4167
-
4168
- const query_params = {};
4169
-
4170
- const response = await PlatformAPIClient.execute(
4171
- this.config,
4172
- "get",
4173
- `/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/system-datasources`,
4174
- query_params,
4175
- undefined,
4176
- requestHeaders,
4177
- { responseHeaders }
4178
- );
4179
-
4180
- let responseData = response;
4181
- if (responseHeaders) {
4182
- responseData = response[0];
4183
- }
4184
-
4185
- const { error: res_error } = Joi.any().validate(responseData, {
4186
- abortEarly: false,
4187
- allowUnknown: true,
4188
- });
4189
-
4190
- if (res_error) {
4191
- if (this.config.options.strictResponseCheck === true) {
4192
- return Promise.reject(new FDKResponseValidationError(res_error));
4193
- } else {
4194
- Logger({
4195
- level: "WARN",
4196
- message: `Response Validation Warnings for platform > Communication > getSystemAudiences \n ${res_error}`,
4197
- });
4198
- }
4199
- }
4200
-
4201
- return response;
4202
- }
4203
-
4204
3763
  /**
4205
3764
  * @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
4206
3765
  * - Arg object
@@ -4211,7 +3770,7 @@ class Communication {
4211
3770
  * Success response
4212
3771
  * @name getSystemEmailTemplates
4213
3772
  * @summary: Get all system email templates
4214
- * @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
3773
+ * @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemEmailTemplates/).
4215
3774
  */
4216
3775
  async getSystemEmailTemplates(
4217
3776
  { requestHeaders } = { requestHeaders: {} },
@@ -4285,11 +3844,11 @@ class Communication {
4285
3844
  *
4286
3845
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4287
3846
  * @param {import("../PlatformAPIClient").Options} - Options
4288
- * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
3847
+ * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates>} -
4289
3848
  * Success response
4290
3849
  * @name getSystemSmsTemplates
4291
3850
  * @summary: Gets all system SMS templates
4292
- * @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
3851
+ * @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemSmsTemplates/).
4293
3852
  */
4294
3853
  async getSystemSmsTemplates(
4295
3854
  { requestHeaders } = { requestHeaders: {} },
@@ -4336,9 +3895,12 @@ class Communication {
4336
3895
  responseData = response[0];
4337
3896
  }
4338
3897
 
4339
- const { error: res_error } = Joi.array()
4340
- .items(CommunicationPlatformModel.SystemSmsTemplates())
4341
- .validate(responseData, { abortEarly: false, allowUnknown: true });
3898
+ const {
3899
+ error: res_error,
3900
+ } = CommunicationPlatformModel.SystemSmsTemplates().validate(responseData, {
3901
+ abortEarly: false,
3902
+ allowUnknown: true,
3903
+ });
4342
3904
 
4343
3905
  if (res_error) {
4344
3906
  if (this.config.options.strictResponseCheck === true) {
@@ -4360,12 +3922,12 @@ class Communication {
4360
3922
  *
4361
3923
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4362
3924
  * @param {import("../PlatformAPIClient").Options} - Options
4363
- * @returns {Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>}
3925
+ * @returns {Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>}
4364
3926
  * - Success response
4365
3927
  *
4366
3928
  * @name postGlobalVariables
4367
3929
  * @summary: Create global variables
4368
- * @description: Updates and creates communication global variables. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
3930
+ * @description: Updates and creates communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/postGlobalVariables/).
4369
3931
  */
4370
3932
  async postGlobalVariables(
4371
3933
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4418,7 +3980,7 @@ class Communication {
4418
3980
 
4419
3981
  const {
4420
3982
  error: res_error,
4421
- } = CommunicationPlatformModel.GlobalVariablesPostResponse().validate(
3983
+ } = CommunicationPlatformModel.CreateGlobalVariablesResult().validate(
4422
3984
  responseData,
4423
3985
  { abortEarly: false, allowUnknown: true }
4424
3986
  );
@@ -4443,10 +4005,10 @@ class Communication {
4443
4005
  *
4444
4006
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4445
4007
  * @param {import("../PlatformAPIClient").Options} - Options
4446
- * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
4008
+ * @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
4447
4009
  * @name sendCommunicationAsynchronously
4448
4010
  * @summary: Send communication asynchronously
4449
- * @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
4011
+ * @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationAsynchronously/).
4450
4012
  */
4451
4013
  async sendCommunicationAsynchronously(
4452
4014
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4499,7 +4061,7 @@ class Communication {
4499
4061
 
4500
4062
  const {
4501
4063
  error: res_error,
4502
- } = CommunicationPlatformModel.EngineResponse().validate(responseData, {
4064
+ } = CommunicationPlatformModel.EngineResult().validate(responseData, {
4503
4065
  abortEarly: false,
4504
4066
  allowUnknown: true,
4505
4067
  });
@@ -4524,10 +4086,10 @@ class Communication {
4524
4086
  *
4525
4087
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4526
4088
  * @param {import("../PlatformAPIClient").Options} - Options
4527
- * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
4089
+ * @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
4528
4090
  * @name sendCommunicationSynchronously
4529
4091
  * @summary: Send communication synchronously
4530
- * @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
4092
+ * @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationSynchronously/).
4531
4093
  */
4532
4094
  async sendCommunicationSynchronously(
4533
4095
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4580,7 +4142,7 @@ class Communication {
4580
4142
 
4581
4143
  const {
4582
4144
  error: res_error,
4583
- } = CommunicationPlatformModel.EngineResponse().validate(responseData, {
4145
+ } = CommunicationPlatformModel.EngineResult().validate(responseData, {
4584
4146
  abortEarly: false,
4585
4147
  allowUnknown: true,
4586
4148
  });
@@ -4606,7 +4168,7 @@ class Communication {
4606
4168
  * @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
4607
4169
  * @name sendOtp
4608
4170
  * @summary: Send OTP
4609
- * @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/).
4171
+ * @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendOtp/).
4610
4172
  */
4611
4173
  async sendOtp(
4612
4174
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4684,11 +4246,10 @@ class Communication {
4684
4246
  *
4685
4247
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4686
4248
  * @param {import("../PlatformAPIClient").Options} - Options
4687
- * @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
4688
- * Success response
4249
+ * @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
4689
4250
  * @name triggerCampaignJob
4690
4251
  * @summary: Trigger a campaign job
4691
- * @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
4252
+ * @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/triggerCampaignJob/).
4692
4253
  */
4693
4254
  async triggerCampaignJob(
4694
4255
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4741,7 +4302,7 @@ class Communication {
4741
4302
 
4742
4303
  const {
4743
4304
  error: res_error,
4744
- } = CommunicationPlatformModel.TriggerJobResponse().validate(responseData, {
4305
+ } = CommunicationPlatformModel.TriggerJobResult().validate(responseData, {
4745
4306
  abortEarly: false,
4746
4307
  allowUnknown: true,
4747
4308
  });
@@ -4769,7 +4330,7 @@ class Communication {
4769
4330
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
4770
4331
  * @name updateAppProviders
4771
4332
  * @summary: Update application providers
4772
- * @description: Modify provider configuration using provider object id . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
4333
+ * @description: Modify provider configuration using provider object id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAppProviders/).
4773
4334
  */
4774
4335
  async updateAppProviders(
4775
4336
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4850,7 +4411,7 @@ class Communication {
4850
4411
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
4851
4412
  * @name updateAudienceById
4852
4413
  * @summary: Update an audience
4853
- * @description: Modify the configuration of a specific audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
4414
+ * @description: Modify the configuration of a specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAudienceById/).
4854
4415
  */
4855
4416
  async updateAudienceById(
4856
4417
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -4933,7 +4494,7 @@ class Communication {
4933
4494
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
4934
4495
  * @name updateCampaignById
4935
4496
  * @summary: Update a campaign
4936
- * @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
4497
+ * @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateCampaignById/).
4937
4498
  */
4938
4499
  async updateCampaignById(
4939
4500
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5016,7 +4577,7 @@ class Communication {
5016
4577
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
5017
4578
  * @name updateEmailProviderById
5018
4579
  * @summary: Update email provider
5019
- * @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
4580
+ * @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailProviderById/).
5020
4581
  */
5021
4582
  async updateEmailProviderById(
5022
4583
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5099,7 +4660,7 @@ class Communication {
5099
4660
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
5100
4661
  * @name updateEmailTemplateById
5101
4662
  * @summary: Update an email template
5102
- * @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/).
4663
+ * @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailTemplateById/).
5103
4664
  */
5104
4665
  async updateEmailTemplateById(
5105
4666
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5182,7 +4743,7 @@ class Communication {
5182
4743
  * @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
5183
4744
  * @name updateOtpConfiguration
5184
4745
  * @summary: Update configuration of otp
5185
- * @description: Updates all configurations related to OTP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateOtpConfiguration/).
4746
+ * @description: Updates all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateOtpConfiguration/).
5186
4747
  */
5187
4748
  async updateOtpConfiguration(
5188
4749
  { requestHeaders } = { requestHeaders: {} },
@@ -5259,7 +4820,7 @@ class Communication {
5259
4820
  * @returns {Promise<Object>} - Success response
5260
4821
  * @name updateSmsProviderById
5261
4822
  * @summary: Update SMS provider
5262
- * @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
4823
+ * @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsProviderById/).
5263
4824
  */
5264
4825
  async updateSmsProviderById(
5265
4826
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5340,7 +4901,7 @@ class Communication {
5340
4901
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
5341
4902
  * @name updateSmsTemplateById
5342
4903
  * @summary: Update a SMS template
5343
- * @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/).
4904
+ * @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsTemplateById/).
5344
4905
  */
5345
4906
  async updateSmsTemplateById(
5346
4907
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5423,7 +4984,7 @@ class Communication {
5423
4984
  *
5424
4985
  * @name verfiyOtp
5425
4986
  * @summary: Verify OTP
5426
- * @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/).
4987
+ * @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/verfiyOtp/).
5427
4988
  */
5428
4989
  async verfiyOtp(
5429
4990
  { body, requestHeaders } = { requestHeaders: {} },