@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5

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 (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  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 +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  42. package/sdk/application/User/UserApplicationClient.js +64 -64
  43. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  44. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  45. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  46. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  47. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  48. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  49. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  50. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  51. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  52. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  54. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  59. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  60. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  61. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  62. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  63. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  64. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  66. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  67. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  68. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  70. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  71. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  72. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  73. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  74. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  75. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  77. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  78. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  79. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  81. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  82. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  83. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  84. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  85. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  86. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
  89. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  90. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
  93. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  94. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  95. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  97. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  98. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  99. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  100. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  101. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  102. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  103. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  104. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  105. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  108. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  109. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  110. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  111. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  112. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  121. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  122. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  123. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  124. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  125. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  126. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  127. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  128. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  129. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  130. package/sdk/platform/User/UserPlatformModel.js +2 -2
  131. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  132. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  133. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  134. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  135. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  136. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  137. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  138. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  140. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -23,8 +23,8 @@ class Communication {
23
23
  * @param {import("../PlatformAPIClient").Options} - Options
24
24
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
25
25
  * @name createAudience
26
- * @summary: Create audience
27
- * @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/).
26
+ * @summary: Create audience.
27
+ * @description: Add audience which is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
28
28
  */
29
29
  async createAudience(
30
30
  { body, requestHeaders } = { requestHeaders: {} },
@@ -104,7 +104,7 @@ class Communication {
104
104
  * @param {import("../PlatformAPIClient").Options} - Options
105
105
  * @returns {Promise<Object>} - Success response
106
106
  * @name createBigQueryHeaders
107
- * @summary: Create big query headers
107
+ * @summary: Create BigQuery headers.
108
108
  * @description: Create big query headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
109
109
  */
110
110
  async createBigQueryHeaders(
@@ -179,7 +179,7 @@ class Communication {
179
179
  * @param {import("../PlatformAPIClient").Options} - Options
180
180
  * @returns {Promise<Object>} - Success response
181
181
  * @name createBigQueryNCount
182
- * @summary: Create big query n count
182
+ * @summary: Create BigQuery N-count.
183
183
  * @description: Create big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
184
184
  */
185
185
  async createBigQueryNCount(
@@ -254,7 +254,7 @@ class Communication {
254
254
  * @param {import("../PlatformAPIClient").Options} - Options
255
255
  * @returns {Promise<Object>} - Success response
256
256
  * @name createBigQueryRowCount
257
- * @summary: Create big query row count
257
+ * @summary: Create BigQuery row count.
258
258
  * @description: Create big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
259
259
  */
260
260
  async createBigQueryRowCount(
@@ -329,8 +329,8 @@ class Communication {
329
329
  * @param {import("../PlatformAPIClient").Options} - Options
330
330
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
331
331
  * @name createCampaign
332
- * @summary: Create campaign
333
- * @description: Create campaign - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
332
+ * @summary: Create campaign.
333
+ * @description: Add a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
334
334
  */
335
335
  async createCampaign(
336
336
  { body, requestHeaders } = { requestHeaders: {} },
@@ -410,8 +410,8 @@ class Communication {
410
410
  * @param {import("../PlatformAPIClient").Options} - Options
411
411
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
412
412
  * @name createEmailProvider
413
- * @summary: Create email provider
414
- * @description: Create email provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
413
+ * @summary: Create email provider.
414
+ * @description: Generate and add a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
415
415
  */
416
416
  async createEmailProvider(
417
417
  { body, requestHeaders } = { requestHeaders: {} },
@@ -491,8 +491,8 @@ class Communication {
491
491
  * @param {import("../PlatformAPIClient").Options} - Options
492
492
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
493
493
  * @name createEmailTemplate
494
- * @summary: Create email template
495
- * @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/).
494
+ * @summary: Create email template.
495
+ * @description: Generate and add a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
496
496
  */
497
497
  async createEmailTemplate(
498
498
  { body, requestHeaders } = { requestHeaders: {} },
@@ -816,8 +816,8 @@ class Communication {
816
816
  * @param {import("../PlatformAPIClient").Options} - Options
817
817
  * @returns {Promise<Object>} - Success response
818
818
  * @name createSmsProvider
819
- * @summary: Create sms provider
820
- * @description: Create sms provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
819
+ * @summary: Create SMS provider.
820
+ * @description: Add a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
821
821
  */
822
822
  async createSmsProvider(
823
823
  { body, requestHeaders } = { requestHeaders: {} },
@@ -895,8 +895,8 @@ class Communication {
895
895
  * @param {import("../PlatformAPIClient").Options} - Options
896
896
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
897
897
  * @name createSmsTemplate
898
- * @summary: Create sms template
899
- * @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/).
898
+ * @summary: Create SMS template.
899
+ * @description: Add a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
900
900
  */
901
901
  async createSmsTemplate(
902
902
  { body, requestHeaders } = { requestHeaders: {} },
@@ -976,8 +976,8 @@ class Communication {
976
976
  * @param {import("../PlatformAPIClient").Options} - Options
977
977
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
978
978
  * @name deleteAudienceById
979
- * @summary: Delete audience by id
980
- * @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/).
979
+ * @summary: Delete audience by ID.
980
+ * @description: Remove a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
981
981
  */
982
982
  async deleteAudienceById(
983
983
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -1059,8 +1059,8 @@ class Communication {
1059
1059
  * @param {import("../PlatformAPIClient").Options} - Options
1060
1060
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1061
1061
  * @name deleteEmailProviderById
1062
- * @summary: Delete email provider by id
1063
- * @description: Delete email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
1062
+ * @summary: Delete email provider by ID.
1063
+ * @description: Remove a specific email communication provider from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
1064
1064
  */
1065
1065
  async deleteEmailProviderById(
1066
1066
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1140,8 +1140,8 @@ class Communication {
1140
1140
  * @param {import("../PlatformAPIClient").Options} - Options
1141
1141
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1142
1142
  * @name deleteEmailTemplateById
1143
- * @summary: Delete email template by id
1144
- * @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/).
1143
+ * @summary: Delete email template by ID.
1144
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Remove a specific email communication template by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
1145
1145
  */
1146
1146
  async deleteEmailTemplateById(
1147
1147
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1302,8 +1302,8 @@ class Communication {
1302
1302
  * @param {import("../PlatformAPIClient").Options} - Options
1303
1303
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1304
1304
  * @name deleteSmsProviderById
1305
- * @summary: Delete sms provider by id
1306
- * @description: Delete sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
1305
+ * @summary: Delete SMS provider by ID.
1306
+ * @description: Remove a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
1307
1307
  */
1308
1308
  async deleteSmsProviderById(
1309
1309
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1383,8 +1383,8 @@ class Communication {
1383
1383
  * @param {import("../PlatformAPIClient").Options} - Options
1384
1384
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1385
1385
  * @name deleteSmsTemplateById
1386
- * @summary: Delete sms template by id
1387
- * @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/).
1386
+ * @summary: Delete SMS template by ID.
1387
+ * @description: Remove a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
1388
1388
  */
1389
1389
  async deleteSmsTemplateById(
1390
1390
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1549,8 +1549,8 @@ class Communication {
1549
1549
  * @param {import("../PlatformAPIClient").Options} - Options
1550
1550
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
1551
1551
  * @name getAppProviders
1552
- * @summary: Get app providers
1553
- * @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/).
1552
+ * @summary: Get application providers.
1553
+ * @description: Retrieve a list of providers associated with the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
1554
1554
  */
1555
1555
  async getAppProviders(
1556
1556
  { requestHeaders } = { requestHeaders: {} },
@@ -1626,8 +1626,8 @@ class Communication {
1626
1626
  * @param {import("../PlatformAPIClient").Options} - Options
1627
1627
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
1628
1628
  * @name getAudienceById
1629
- * @summary: Get audience by id
1630
- * @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/).
1629
+ * @summary: Get audience by ID.
1630
+ * @description: Retrieve detailed information about a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
1631
1631
  */
1632
1632
  async getAudienceById(
1633
1633
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1707,8 +1707,8 @@ class Communication {
1707
1707
  * @param {import("../PlatformAPIClient").Options} - Options
1708
1708
  * @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
1709
1709
  * @name getAudiences
1710
- * @summary: Get audiences
1711
- * @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/).
1710
+ * @summary: Get audiences.
1711
+ * @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
1712
1712
  */
1713
1713
  async getAudiences(
1714
1714
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -1790,47 +1790,6 @@ class Communication {
1790
1790
  return response;
1791
1791
  }
1792
1792
 
1793
- /**
1794
- * @param {Object} arg - Arg object.
1795
- * @param {string} arg.companyId - Company id
1796
- * @param {string} arg.applicationId - Application id
1797
- * @param {number} [arg.pageSize] - Current request items count
1798
- * @param {Object} [arg.sort] - To sort based on created_at
1799
- * @param {Object} [arg.query] - To search based on plain text
1800
- * @returns {Paginator<CommunicationPlatformModel.Audiences>}
1801
- * @summary: Get audiences
1802
- * @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.
1803
- */
1804
- getAudiencesPaginator({
1805
- companyId,
1806
- applicationId,
1807
- pageSize,
1808
- sort,
1809
- query,
1810
- } = {}) {
1811
- const paginator = new Paginator();
1812
- const callback = async () => {
1813
- const pageId = paginator.nextId;
1814
- const pageNo = paginator.pageNo;
1815
- const pageType = "number";
1816
- const data = await this.getAudiences({
1817
- companyId: companyId,
1818
- applicationId: applicationId,
1819
- pageNo: pageNo,
1820
- pageSize: pageSize,
1821
- sort: sort,
1822
- query: query,
1823
- });
1824
- paginator.setPaginator({
1825
- hasNext: data.page.has_next ? true : false,
1826
- nextId: data.page.next_id,
1827
- });
1828
- return data;
1829
- };
1830
- paginator.setCallback(callback.bind(this));
1831
- return paginator;
1832
- }
1833
-
1834
1793
  /**
1835
1794
  * @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
1836
1795
  * - Arg object
@@ -1839,8 +1798,8 @@ class Communication {
1839
1798
  * @param {import("../PlatformAPIClient").Options} - Options
1840
1799
  * @returns {Promise<Object>} - Success response
1841
1800
  * @name getBigQueryHeadersById
1842
- * @summary: Get big query headers by id
1843
- * @description: Get big query headers by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
1801
+ * @summary: Get BigQuery headers by ID.
1802
+ * @description: Retrieve header information from BigQuery for a specific campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
1844
1803
  */
1845
1804
  async getBigQueryHeadersById(
1846
1805
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1918,8 +1877,8 @@ class Communication {
1918
1877
  * @param {import("../PlatformAPIClient").Options} - Options
1919
1878
  * @returns {Promise<Object>} - Success response
1920
1879
  * @name getBigQueryRowCountById
1921
- * @summary: Get big query row count by id
1922
- * @description: Get big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
1880
+ * @summary: Get BigQuery row count by ID.
1881
+ * @description: Retrieve big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
1923
1882
  */
1924
1883
  async getBigQueryRowCountById(
1925
1884
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1997,8 +1956,8 @@ class Communication {
1997
1956
  * @param {import("../PlatformAPIClient").Options} - Options
1998
1957
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
1999
1958
  * @name getCampaignById
2000
- * @summary: Get campaign by id
2001
- * @description: Get campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
1959
+ * @summary: Get campaign by ID.
1960
+ * @description: Retrieve detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
2002
1961
  */
2003
1962
  async getCampaignById(
2004
1963
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2078,8 +2037,8 @@ class Communication {
2078
2037
  * @param {import("../PlatformAPIClient").Options} - Options
2079
2038
  * @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
2080
2039
  * @name getCampaigns
2081
- * @summary: Get campaigns
2082
- * @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
2040
+ * @summary: Get campaigns.
2041
+ * @description: Retrieve a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
2083
2042
  */
2084
2043
  async getCampaigns(
2085
2044
  { query, pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
@@ -2169,8 +2128,8 @@ class Communication {
2169
2128
  * @param {import("../PlatformAPIClient").Options} - Options
2170
2129
  * @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
2171
2130
  * @name getCommunicationLogs
2172
- * @summary: Get communication logs
2173
- * @description: Get communication logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
2131
+ * @summary: Get communication logs.
2132
+ * @description: Retrieve logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
2174
2133
  */
2175
2134
  async getCommunicationLogs(
2176
2135
  { pageId, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2252,47 +2211,6 @@ class Communication {
2252
2211
  return response;
2253
2212
  }
2254
2213
 
2255
- /**
2256
- * @param {Object} arg - Arg object.
2257
- * @param {string} arg.companyId - Company id
2258
- * @param {string} arg.applicationId - Application id
2259
- * @param {number} [arg.pageSize] - Current request items count
2260
- * @param {Object} [arg.sort] - To sort based on _id
2261
- * @param {Object} [arg.query] -
2262
- * @returns {Paginator<CommunicationPlatformModel.Logs>}
2263
- * @summary: Get communication logs
2264
- * @description: Get communication logs
2265
- */
2266
- getCommunicationLogsPaginator({
2267
- companyId,
2268
- applicationId,
2269
- pageSize,
2270
- sort,
2271
- query,
2272
- } = {}) {
2273
- const paginator = new Paginator();
2274
- const callback = async () => {
2275
- const pageId = paginator.nextId;
2276
- const pageNo = paginator.pageNo;
2277
- const pageType = "cursor";
2278
- const data = await this.getCommunicationLogs({
2279
- companyId: companyId,
2280
- applicationId: applicationId,
2281
- pageId: pageId,
2282
- pageSize: pageSize,
2283
- sort: sort,
2284
- query: query,
2285
- });
2286
- paginator.setPaginator({
2287
- hasNext: data.page.has_next ? true : false,
2288
- nextId: data.page.next_id,
2289
- });
2290
- return data;
2291
- };
2292
- paginator.setCallback(callback.bind(this));
2293
- return paginator;
2294
- }
2295
-
2296
2214
  /**
2297
2215
  * @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg
2298
2216
  * - Arg object
@@ -2302,8 +2220,8 @@ class Communication {
2302
2220
  * @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
2303
2221
  * Success response
2304
2222
  * @name getDefaultSmsProviders
2305
- * @summary: Get default sms providers
2306
- * @description: Get default sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
2223
+ * @summary: Get default SMS providers.
2224
+ * @description: Retrieve the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
2307
2225
  */
2308
2226
  async getDefaultSmsProviders(
2309
2227
  { requestHeaders } = { requestHeaders: {} },
@@ -2377,8 +2295,8 @@ class Communication {
2377
2295
  * @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
2378
2296
  * Success response
2379
2297
  * @name getDummyDatasources
2380
- * @summary: Get dummy data sources
2381
- * @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/).
2298
+ * @summary: Get dummy data sources.
2299
+ * @description: Retrieve a list of dummy data sources for testing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
2382
2300
  */
2383
2301
  async getDummyDatasources(
2384
2302
  { requestHeaders } = { requestHeaders: {} },
@@ -2452,8 +2370,8 @@ class Communication {
2452
2370
  * @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
2453
2371
  * Success response
2454
2372
  * @name getDummyDatasourcesMeta
2455
- * @summary: Get dummy data sources meta
2456
- * @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/).
2373
+ * @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/).
2457
2375
  */
2458
2376
  async getDummyDatasourcesMeta(
2459
2377
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2533,8 +2451,8 @@ class Communication {
2533
2451
  * @param {import("../PlatformAPIClient").Options} - Options
2534
2452
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
2535
2453
  * @name getEmailProviderById
2536
- * @summary: Get email provider by id
2537
- * @description: Get email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
2454
+ * @summary: Get email provider by ID.
2455
+ * @description: Retrieve detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
2538
2456
  */
2539
2457
  async getEmailProviderById(
2540
2458
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2614,8 +2532,8 @@ class Communication {
2614
2532
  * @param {import("../PlatformAPIClient").Options} - Options
2615
2533
  * @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
2616
2534
  * @name getEmailProviders
2617
- * @summary: Get email providers
2618
- * @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
2535
+ * @summary: Get email providers.
2536
+ * @description: Retrieve a list of email communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
2619
2537
  */
2620
2538
  async getEmailProviders(
2621
2539
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2697,47 +2615,6 @@ class Communication {
2697
2615
  return response;
2698
2616
  }
2699
2617
 
2700
- /**
2701
- * @param {Object} arg - Arg object.
2702
- * @param {string} arg.companyId - Company id
2703
- * @param {string} arg.applicationId - Application id
2704
- * @param {number} [arg.pageSize] - Current request items count
2705
- * @param {Object} [arg.sort] - To sort based on created_at
2706
- * @param {Object} [arg.query] - To search based on plain text
2707
- * @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
2708
- * @summary: Get email providers
2709
- * @description: Get email providers
2710
- */
2711
- getEmailProvidersPaginator({
2712
- companyId,
2713
- applicationId,
2714
- pageSize,
2715
- sort,
2716
- query,
2717
- } = {}) {
2718
- const paginator = new Paginator();
2719
- const callback = async () => {
2720
- const pageId = paginator.nextId;
2721
- const pageNo = paginator.pageNo;
2722
- const pageType = "number";
2723
- const data = await this.getEmailProviders({
2724
- companyId: companyId,
2725
- applicationId: applicationId,
2726
- pageNo: pageNo,
2727
- pageSize: pageSize,
2728
- sort: sort,
2729
- query: query,
2730
- });
2731
- paginator.setPaginator({
2732
- hasNext: data.page.has_next ? true : false,
2733
- nextId: data.page.next_id,
2734
- });
2735
- return data;
2736
- };
2737
- paginator.setCallback(callback.bind(this));
2738
- return paginator;
2739
- }
2740
-
2741
2618
  /**
2742
2619
  * @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
2743
2620
  * - Arg object
@@ -2746,8 +2623,8 @@ class Communication {
2746
2623
  * @param {import("../PlatformAPIClient").Options} - Options
2747
2624
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
2748
2625
  * @name getEmailTemplateById
2749
- * @summary: Get email template by id
2750
- * @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/).
2626
+ * @summary: Get email template by ID.
2627
+ * @description: Retrieve detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
2751
2628
  */
2752
2629
  async getEmailTemplateById(
2753
2630
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2827,8 +2704,8 @@ class Communication {
2827
2704
  * @param {import("../PlatformAPIClient").Options} - Options
2828
2705
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
2829
2706
  * @name getEmailTemplates
2830
- * @summary: Get email templates
2831
- * @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/).
2707
+ * @summary: Get email templates.
2708
+ * @description: Retrieve a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
2832
2709
  */
2833
2710
  async getEmailTemplates(
2834
2711
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2910,47 +2787,6 @@ class Communication {
2910
2787
  return response;
2911
2788
  }
2912
2789
 
2913
- /**
2914
- * @param {Object} arg - Arg object.
2915
- * @param {string} arg.companyId - Company id
2916
- * @param {string} arg.applicationId - Application id
2917
- * @param {number} [arg.pageSize] - Current request items count
2918
- * @param {Object} [arg.sort] - To sort based on created_at
2919
- * @param {Object} [arg.query] - To search based on plain text
2920
- * @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
2921
- * @summary: Get email templates
2922
- * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.
2923
- */
2924
- getEmailTemplatesPaginator({
2925
- companyId,
2926
- applicationId,
2927
- pageSize,
2928
- sort,
2929
- query,
2930
- } = {}) {
2931
- const paginator = new Paginator();
2932
- const callback = async () => {
2933
- const pageId = paginator.nextId;
2934
- const pageNo = paginator.pageNo;
2935
- const pageType = "number";
2936
- const data = await this.getEmailTemplates({
2937
- companyId: companyId,
2938
- applicationId: applicationId,
2939
- pageNo: pageNo,
2940
- pageSize: pageSize,
2941
- sort: sort,
2942
- query: query,
2943
- });
2944
- paginator.setPaginator({
2945
- hasNext: data.page.has_next ? true : false,
2946
- nextId: data.page.next_id,
2947
- });
2948
- return data;
2949
- };
2950
- paginator.setCallback(callback.bind(this));
2951
- return paginator;
2952
- }
2953
-
2954
2790
  /**
2955
2791
  * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
2956
2792
  * - Arg object
@@ -2960,8 +2796,8 @@ class Communication {
2960
2796
  * @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
2961
2797
  * Success response
2962
2798
  * @name getEventSubscriptions
2963
- * @summary: Get event subscriptions
2964
- * @description: Get event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
2799
+ * @summary: Get event subscriptions.
2800
+ * @description: Retrieve a list of event subscriptions related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
2965
2801
  */
2966
2802
  async getEventSubscriptions(
2967
2803
  { pageNo, pageSize, populate, requestHeaders } = { requestHeaders: {} },
@@ -3040,44 +2876,6 @@ class Communication {
3040
2876
  return response;
3041
2877
  }
3042
2878
 
3043
- /**
3044
- * @param {Object} arg - Arg object.
3045
- * @param {string} arg.companyId - Company id
3046
- * @param {string} arg.applicationId - Application id
3047
- * @param {number} [arg.pageSize] - Current request items count
3048
- * @param {string} [arg.populate] - Populate Fields
3049
- * @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
3050
- * @summary: Get event subscriptions
3051
- * @description: Get event subscriptions
3052
- */
3053
- getEventSubscriptionsPaginator({
3054
- companyId,
3055
- applicationId,
3056
- pageSize,
3057
- populate,
3058
- } = {}) {
3059
- const paginator = new Paginator();
3060
- const callback = async () => {
3061
- const pageId = paginator.nextId;
3062
- const pageNo = paginator.pageNo;
3063
- const pageType = "number";
3064
- const data = await this.getEventSubscriptions({
3065
- companyId: companyId,
3066
- applicationId: applicationId,
3067
- pageNo: pageNo,
3068
- pageSize: pageSize,
3069
- populate: populate,
3070
- });
3071
- paginator.setPaginator({
3072
- hasNext: data.page.has_next ? true : false,
3073
- nextId: data.page.next_id,
3074
- });
3075
- return data;
3076
- };
3077
- paginator.setCallback(callback.bind(this));
3078
- return paginator;
3079
- }
3080
-
3081
2879
  /**
3082
2880
  * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
3083
2881
  * - Arg object
@@ -3170,8 +2968,8 @@ class Communication {
3170
2968
  * @param {import("../PlatformAPIClient").Options} - Options
3171
2969
  * @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
3172
2970
  * @name getGlobalProviders
3173
- * @summary: Get global providers
3174
- * @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/).
2971
+ * @summary: Get global providers.
2972
+ * @description: Retrieve a list of global communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
3175
2973
  */
3176
2974
  async getGlobalProviders(
3177
2975
  { requestHeaders } = { requestHeaders: {} },
@@ -3249,8 +3047,8 @@ class Communication {
3249
3047
  * - Success response
3250
3048
  *
3251
3049
  * @name getGlobalVariables
3252
- * @summary: get global variables
3253
- * @description: get global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
3050
+ * @summary: Get global variables.
3051
+ * @description: Retrieve global variables used in communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
3254
3052
  */
3255
3053
  async getGlobalVariables(
3256
3054
  { requestHeaders } = { requestHeaders: {} },
@@ -3324,8 +3122,8 @@ class Communication {
3324
3122
  * @param {import("../PlatformAPIClient").Options} - Options
3325
3123
  * @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
3326
3124
  * @name getJobLogs
3327
- * @summary: Get job logs
3328
- * @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
3125
+ * @summary: Get job logs.
3126
+ * @description: Retrieve logs and details related to communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
3329
3127
  */
3330
3128
  async getJobLogs(
3331
3129
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3407,55 +3205,14 @@ class Communication {
3407
3205
  return response;
3408
3206
  }
3409
3207
 
3410
- /**
3411
- * @param {Object} arg - Arg object.
3412
- * @param {string} arg.companyId - Company id
3413
- * @param {string} arg.applicationId - Application id
3414
- * @param {number} [arg.pageSize] - Current request items count
3415
- * @param {Object} [arg.sort] - To sort based on created_at
3416
- * @param {Object} [arg.query] - To search based on plain text
3417
- * @returns {Paginator<CommunicationPlatformModel.JobLogs>}
3418
- * @summary: Get job logs
3419
- * @description: Get job logs
3420
- */
3421
- getJobLogsPaginator({
3422
- companyId,
3423
- applicationId,
3424
- pageSize,
3425
- sort,
3426
- query,
3427
- } = {}) {
3428
- const paginator = new Paginator();
3429
- const callback = async () => {
3430
- const pageId = paginator.nextId;
3431
- const pageNo = paginator.pageNo;
3432
- const pageType = "number";
3433
- const data = await this.getJobLogs({
3434
- companyId: companyId,
3435
- applicationId: applicationId,
3436
- pageNo: pageNo,
3437
- pageSize: pageSize,
3438
- sort: sort,
3439
- query: query,
3440
- });
3441
- paginator.setPaginator({
3442
- hasNext: data.page.has_next ? true : false,
3443
- nextId: data.page.next_id,
3444
- });
3445
- return data;
3446
- };
3447
- paginator.setCallback(callback.bind(this));
3448
- return paginator;
3449
- }
3450
-
3451
3208
  /**
3452
3209
  * @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
3453
3210
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3454
3211
  * @param {import("../PlatformAPIClient").Options} - Options
3455
3212
  * @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
3456
3213
  * @name getJobs
3457
- * @summary: Get jobs
3458
- * @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
3214
+ * @summary: Get jobs.
3215
+ * @description: Retrieve a list of communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
3459
3216
  */
3460
3217
  async getJobs(
3461
3218
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3537,41 +3294,6 @@ class Communication {
3537
3294
  return response;
3538
3295
  }
3539
3296
 
3540
- /**
3541
- * @param {Object} arg - Arg object.
3542
- * @param {string} arg.companyId - Company id
3543
- * @param {string} arg.applicationId - Application id
3544
- * @param {number} [arg.pageSize] - Current request items count
3545
- * @param {Object} [arg.sort] - To sort based on created_at
3546
- * @param {Object} [arg.query] - To search based on plain text
3547
- * @returns {Paginator<CommunicationPlatformModel.Jobs>}
3548
- * @summary: Get jobs
3549
- * @description: Get jobs
3550
- */
3551
- getJobsPaginator({ companyId, applicationId, pageSize, sort, query } = {}) {
3552
- const paginator = new Paginator();
3553
- const callback = async () => {
3554
- const pageId = paginator.nextId;
3555
- const pageNo = paginator.pageNo;
3556
- const pageType = "number";
3557
- const data = await this.getJobs({
3558
- companyId: companyId,
3559
- applicationId: applicationId,
3560
- pageNo: pageNo,
3561
- pageSize: pageSize,
3562
- sort: sort,
3563
- query: query,
3564
- });
3565
- paginator.setPaginator({
3566
- hasNext: data.page.has_next ? true : false,
3567
- nextId: data.page.next_id,
3568
- });
3569
- return data;
3570
- };
3571
- paginator.setCallback(callback.bind(this));
3572
- return paginator;
3573
- }
3574
-
3575
3297
  /**
3576
3298
  * @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
3577
3299
  * - Arg object
@@ -3580,8 +3302,8 @@ class Communication {
3580
3302
  * @param {import("../PlatformAPIClient").Options} - Options
3581
3303
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
3582
3304
  * @name getNSampleRecordsFromCsv
3583
- * @summary: Get n sample records from csv
3584
- * @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/).
3305
+ * @summary: Get N sample records from 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/).
3585
3307
  */
3586
3308
  async getNSampleRecordsFromCsv(
3587
3309
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3661,8 +3383,8 @@ class Communication {
3661
3383
  * @param {import("../PlatformAPIClient").Options} - Options
3662
3384
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
3663
3385
  * @name getNSampleRecordsFromCsvByGet
3664
- * @summary: Get n sample records from csv
3665
- * @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/).
3386
+ * @summary: Get N sample records in CSV
3387
+ * @description: Retrieve a specified number of sample records from a CSV data source using a GET request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
3666
3388
  */
3667
3389
  async getNSampleRecordsFromCsvByGet(
3668
3390
  { requestHeaders } = { requestHeaders: {} },
@@ -3815,8 +3537,8 @@ class Communication {
3815
3537
  * @param {import("../PlatformAPIClient").Options} - Options
3816
3538
  * @returns {Promise<Object>} - Success response
3817
3539
  * @name getSmsProviderById
3818
- * @summary: Get sms provider by id
3819
- * @description: Get sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
3540
+ * @summary: Get SMS provider by ID.
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/).
3820
3542
  */
3821
3543
  async getSmsProviderById(
3822
3544
  { id, requestHeaders } = { requestHeaders: {} },
@@ -3894,8 +3616,8 @@ class Communication {
3894
3616
  * @param {import("../PlatformAPIClient").Options} - Options
3895
3617
  * @returns {Promise<Object>} - Success response
3896
3618
  * @name getSmsProviders
3897
- * @summary: Get sms providers
3898
- * @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
3619
+ * @summary: Get SMS providers.
3620
+ * @description: Retrieve a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
3899
3621
  */
3900
3622
  async getSmsProviders(
3901
3623
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3983,8 +3705,8 @@ class Communication {
3983
3705
  * @param {import("../PlatformAPIClient").Options} - Options
3984
3706
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
3985
3707
  * @name getSmsTemplateById
3986
- * @summary: Get sms template by id
3987
- * @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/).
3708
+ * @summary: Get SMS template by ID.
3709
+ * @description: Retrieve detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
3988
3710
  */
3989
3711
  async getSmsTemplateById(
3990
3712
  { id, requestHeaders } = { requestHeaders: {} },
@@ -4064,8 +3786,8 @@ class Communication {
4064
3786
  * @param {import("../PlatformAPIClient").Options} - Options
4065
3787
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
4066
3788
  * @name getSmsTemplates
4067
- * @summary: Get sms templates
4068
- * @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/).
3789
+ * @summary: Get SMS templates.
3790
+ * @description: Retrieve a list of available SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
4069
3791
  */
4070
3792
  async getSmsTemplates(
4071
3793
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -4147,47 +3869,6 @@ class Communication {
4147
3869
  return response;
4148
3870
  }
4149
3871
 
4150
- /**
4151
- * @param {Object} arg - Arg object.
4152
- * @param {string} arg.companyId - Company id
4153
- * @param {string} arg.applicationId - Application id
4154
- * @param {number} [arg.pageSize] - Current request items count
4155
- * @param {Object} [arg.sort] - To sort based on created_at
4156
- * @param {Object} [arg.query] - To search based on plain text
4157
- * @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
4158
- * @summary: Get sms templates
4159
- * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.
4160
- */
4161
- getSmsTemplatesPaginator({
4162
- companyId,
4163
- applicationId,
4164
- pageSize,
4165
- sort,
4166
- query,
4167
- } = {}) {
4168
- const paginator = new Paginator();
4169
- const callback = async () => {
4170
- const pageId = paginator.nextId;
4171
- const pageNo = paginator.pageNo;
4172
- const pageType = "number";
4173
- const data = await this.getSmsTemplates({
4174
- companyId: companyId,
4175
- applicationId: applicationId,
4176
- pageNo: pageNo,
4177
- pageSize: pageSize,
4178
- sort: sort,
4179
- query: query,
4180
- });
4181
- paginator.setPaginator({
4182
- hasNext: data.page.has_next ? true : false,
4183
- nextId: data.page.next_id,
4184
- });
4185
- return data;
4186
- };
4187
- paginator.setCallback(callback.bind(this));
4188
- return paginator;
4189
- }
4190
-
4191
3872
  /**
4192
3873
  * @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
4193
3874
  * - Arg object
@@ -4196,8 +3877,8 @@ class Communication {
4196
3877
  * @param {import("../PlatformAPIClient").Options} - Options
4197
3878
  * @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
4198
3879
  * @name getStatsOfCampaignById
4199
- * @summary: Get stats of campaign by id
4200
- * @description: Get stats of campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
3880
+ * @summary: Get campaign statistics by ID.
3881
+ * @description: Retrieve statistical data for a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
4201
3882
  */
4202
3883
  async getStatsOfCampaignById(
4203
3884
  { id, requestHeaders } = { requestHeaders: {} },
@@ -4277,8 +3958,8 @@ class Communication {
4277
3958
  * @param {import("../PlatformAPIClient").Options} - Options
4278
3959
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
4279
3960
  * @name getSubscribedEmailTemplates
4280
- * @summary: Get subscribed email templates
4281
- * @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/).
3961
+ * @summary: Get subscribed email templates.
3962
+ * @description: Retrieve email communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
4282
3963
  */
4283
3964
  async getSubscribedEmailTemplates(
4284
3965
  { pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
@@ -4357,44 +4038,6 @@ class Communication {
4357
4038
  return response;
4358
4039
  }
4359
4040
 
4360
- /**
4361
- * @param {Object} arg - Arg object.
4362
- * @param {string} arg.companyId - Company id
4363
- * @param {string} arg.applicationId - Application id
4364
- * @param {number} [arg.pageSize] - Current request items count
4365
- * @param {Object} [arg.query] - To search based on plain text
4366
- * @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
4367
- * @summary: Get subscribed email templates
4368
- * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.
4369
- */
4370
- getSubscribedEmailTemplatesPaginator({
4371
- companyId,
4372
- applicationId,
4373
- pageSize,
4374
- query,
4375
- } = {}) {
4376
- const paginator = new Paginator();
4377
- const callback = async () => {
4378
- const pageId = paginator.nextId;
4379
- const pageNo = paginator.pageNo;
4380
- const pageType = "number";
4381
- const data = await this.getSubscribedEmailTemplates({
4382
- companyId: companyId,
4383
- applicationId: applicationId,
4384
- pageNo: pageNo,
4385
- pageSize: pageSize,
4386
- query: query,
4387
- });
4388
- paginator.setPaginator({
4389
- hasNext: data.page.has_next ? true : false,
4390
- nextId: data.page.next_id,
4391
- });
4392
- return data;
4393
- };
4394
- paginator.setCallback(callback.bind(this));
4395
- return paginator;
4396
- }
4397
-
4398
4041
  /**
4399
4042
  * @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
4400
4043
  * - Arg object
@@ -4403,8 +4046,8 @@ class Communication {
4403
4046
  * @param {import("../PlatformAPIClient").Options} - Options
4404
4047
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
4405
4048
  * @name getSubscribedSmsTemplates
4406
- * @summary: Get subscribed sms templates
4407
- * @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/).
4049
+ * @summary: Get subscribed SMS templates.
4050
+ * @description: Retrieve SMS communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
4408
4051
  */
4409
4052
  async getSubscribedSmsTemplates(
4410
4053
  { pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
@@ -4483,44 +4126,6 @@ class Communication {
4483
4126
  return response;
4484
4127
  }
4485
4128
 
4486
- /**
4487
- * @param {Object} arg - Arg object.
4488
- * @param {string} arg.companyId - Company id
4489
- * @param {string} arg.applicationId - Application id
4490
- * @param {number} [arg.pageSize] - Current request items count
4491
- * @param {Object} [arg.query] - To search based on plain text
4492
- * @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
4493
- * @summary: Get subscribed sms templates
4494
- * @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.
4495
- */
4496
- getSubscribedSmsTemplatesPaginator({
4497
- companyId,
4498
- applicationId,
4499
- pageSize,
4500
- query,
4501
- } = {}) {
4502
- const paginator = new Paginator();
4503
- const callback = async () => {
4504
- const pageId = paginator.nextId;
4505
- const pageNo = paginator.pageNo;
4506
- const pageType = "number";
4507
- const data = await this.getSubscribedSmsTemplates({
4508
- companyId: companyId,
4509
- applicationId: applicationId,
4510
- pageNo: pageNo,
4511
- pageSize: pageSize,
4512
- query: query,
4513
- });
4514
- paginator.setPaginator({
4515
- hasNext: data.page.has_next ? true : false,
4516
- nextId: data.page.next_id,
4517
- });
4518
- return data;
4519
- };
4520
- paginator.setCallback(callback.bind(this));
4521
- return paginator;
4522
- }
4523
-
4524
4129
  /**
4525
4130
  * @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
4526
4131
  * - Arg object
@@ -4529,8 +4134,8 @@ class Communication {
4529
4134
  * @param {import("../PlatformAPIClient").Options} - Options
4530
4135
  * @returns {Promise<Object>} - Success response
4531
4136
  * @name getSystemAudiences
4532
- * @summary: Get system audiences
4533
- * @description: Get system audiences - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
4137
+ * @summary: Get system audiences.
4138
+ * @description: Retrieve system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
4534
4139
  */
4535
4140
  async getSystemAudiences(
4536
4141
  { requestHeaders } = { requestHeaders: {} },
@@ -4605,8 +4210,8 @@ class Communication {
4605
4210
  * @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
4606
4211
  * Success response
4607
4212
  * @name getSystemEmailTemplates
4608
- * @summary: Get system email templates
4609
- * @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/).
4213
+ * @summary: Get system email templates.
4214
+ * @description: Retrieve system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
4610
4215
  */
4611
4216
  async getSystemEmailTemplates(
4612
4217
  { requestHeaders } = { requestHeaders: {} },
@@ -4683,8 +4288,8 @@ class Communication {
4683
4288
  * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
4684
4289
  * Success response
4685
4290
  * @name getSystemSmsTemplates
4686
- * @summary: Get system sms templates
4687
- * @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/).
4291
+ * @summary: Get system SMS templates.
4292
+ * @description: Retrieve system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
4688
4293
  */
4689
4294
  async getSystemSmsTemplates(
4690
4295
  { requestHeaders } = { requestHeaders: {} },
@@ -4759,8 +4364,8 @@ class Communication {
4759
4364
  * - Success response
4760
4365
  *
4761
4366
  * @name postGlobalVariables
4762
- * @summary: post global variables
4763
- * @description: psot global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
4367
+ * @summary: Post global variables.
4368
+ * @description: Update and post global variables for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
4764
4369
  */
4765
4370
  async postGlobalVariables(
4766
4371
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4840,8 +4445,8 @@ class Communication {
4840
4445
  * @param {import("../PlatformAPIClient").Options} - Options
4841
4446
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
4842
4447
  * @name sendCommunicationAsynchronously
4843
- * @summary: Send email or sms asynchronously
4844
- * @description: Send email or sms asynchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
4448
+ * @summary: Send communication asynchronously.
4449
+ * @description: Initiate and send communication with the option for asynchronous processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
4845
4450
  */
4846
4451
  async sendCommunicationAsynchronously(
4847
4452
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4921,8 +4526,8 @@ class Communication {
4921
4526
  * @param {import("../PlatformAPIClient").Options} - Options
4922
4527
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
4923
4528
  * @name sendCommunicationSynchronously
4924
- * @summary: Send email or sms synchronously
4925
- * @description: Send email or sms synchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
4529
+ * @summary: Send communication synchronously.
4530
+ * @description: Initiate and send communication in real-time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
4926
4531
  */
4927
4532
  async sendCommunicationSynchronously(
4928
4533
  { body, requestHeaders } = { requestHeaders: {} },
@@ -5000,8 +4605,8 @@ class Communication {
5000
4605
  * @param {import("../PlatformAPIClient").Options} - Options
5001
4606
  * @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
5002
4607
  * @name sendOtp
5003
- * @summary: Send OTP using email and sms
5004
- * @description: Send OTP Comms via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
4608
+ * @summary: Send OTP.
4609
+ * @description: Send a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
5005
4610
  */
5006
4611
  async sendOtp(
5007
4612
  { body, requestHeaders } = { requestHeaders: {} },
@@ -5082,8 +4687,8 @@ class Communication {
5082
4687
  * @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
5083
4688
  * Success response
5084
4689
  * @name triggerCampaignJob
5085
- * @summary: Trigger campaign job
5086
- * @description: Trigger campaign job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
4690
+ * @summary: Trigger campaign job.
4691
+ * @description: Initiate a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
5087
4692
  */
5088
4693
  async triggerCampaignJob(
5089
4694
  { body, requestHeaders } = { requestHeaders: {} },
@@ -5163,8 +4768,8 @@ class Communication {
5163
4768
  * @param {import("../PlatformAPIClient").Options} - Options
5164
4769
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
5165
4770
  * @name updateAppProviders
5166
- * @summary: update app providers
5167
- * @description: Using this API will update the application providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
4771
+ * @summary: Update application providers.
4772
+ * @description: Modify provider information for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
5168
4773
  */
5169
4774
  async updateAppProviders(
5170
4775
  { body, requestHeaders } = { requestHeaders: {} },
@@ -5244,8 +4849,8 @@ class Communication {
5244
4849
  * @param {import("../PlatformAPIClient").Options} - Options
5245
4850
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
5246
4851
  * @name updateAudienceById
5247
- * @summary: Update audience by id
5248
- * @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/).
4852
+ * @summary: Update audience by ID.
4853
+ * @description: Modify the settings of a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
5249
4854
  */
5250
4855
  async updateAudienceById(
5251
4856
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5327,8 +4932,8 @@ class Communication {
5327
4932
  * @param {import("../PlatformAPIClient").Options} - Options
5328
4933
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
5329
4934
  * @name updateCampaignById
5330
- * @summary: Update campaign by id
5331
- * @description: Update campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
4935
+ * @summary: Update campaign by ID.
4936
+ * @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
5332
4937
  */
5333
4938
  async updateCampaignById(
5334
4939
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5410,8 +5015,8 @@ class Communication {
5410
5015
  * @param {import("../PlatformAPIClient").Options} - Options
5411
5016
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
5412
5017
  * @name updateEmailProviderById
5413
- * @summary: Update email provider by id
5414
- * @description: Update email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
5018
+ * @summary: Update email provider by ID.
5019
+ * @description: Modify the settings of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
5415
5020
  */
5416
5021
  async updateEmailProviderById(
5417
5022
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5493,8 +5098,8 @@ class Communication {
5493
5098
  * @param {import("../PlatformAPIClient").Options} - Options
5494
5099
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
5495
5100
  * @name updateEmailTemplateById
5496
- * @summary: Update email template by id
5497
- * @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/).
5101
+ * @summary: Update email template by ID.
5102
+ * @description: Modify the content and settings of a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
5498
5103
  */
5499
5104
  async updateEmailTemplateById(
5500
5105
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5653,8 +5258,8 @@ class Communication {
5653
5258
  * @param {import("../PlatformAPIClient").Options} - Options
5654
5259
  * @returns {Promise<Object>} - Success response
5655
5260
  * @name updateSmsProviderById
5656
- * @summary: Update sms provider by id
5657
- * @description: Update sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
5261
+ * @summary: Update SMS provider by ID.
5262
+ * @description: Modify specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
5658
5263
  */
5659
5264
  async updateSmsProviderById(
5660
5265
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5734,8 +5339,8 @@ class Communication {
5734
5339
  * @param {import("../PlatformAPIClient").Options} - Options
5735
5340
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
5736
5341
  * @name updateSmsTemplateById
5737
- * @summary: Update sms template by id
5738
- * @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/).
5342
+ * @summary: Update SMS template by ID.
5343
+ * @description: Modify the content and settings of a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
5739
5344
  */
5740
5345
  async updateSmsTemplateById(
5741
5346
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5817,8 +5422,8 @@ class Communication {
5817
5422
  * - Success response
5818
5423
  *
5819
5424
  * @name verfiyOtp
5820
- * @summary: Verify OTP sent via email and sms
5821
- * @description: Verify OTP sent via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
5425
+ * @summary: Verify OTP.
5426
+ * @description: Verify the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
5822
5427
  */
5823
5428
  async verfiyOtp(
5824
5429
  { body, requestHeaders } = { requestHeaders: {} },