@gofynd/fdk-client-javascript 1.4.3 → 1.4.4

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 (193) hide show
  1. package/README.md +1 -10
  2. package/application.d.ts +3 -3
  3. package/common.d.ts +3 -3
  4. package/index.d.ts +15 -15
  5. package/package.json +1 -1
  6. package/partner.d.ts +3 -3
  7. package/platform.d.ts +3 -3
  8. package/public.d.ts +2 -2
  9. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  10. package/sdk/application/ApplicationClient.d.ts +17 -17
  11. package/sdk/application/ApplicationConfig.d.ts +3 -3
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
  13. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  14. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  15. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  16. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  18. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  19. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  20. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  21. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  22. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  26. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  27. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  28. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  29. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  30. package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
  31. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  32. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  34. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  35. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  36. package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
  37. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  38. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  39. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  40. package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
  41. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  42. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
  43. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
  44. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  45. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
  46. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  47. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  48. package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
  49. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  50. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  51. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  52. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  53. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  54. package/sdk/application/User/UserApplicationClient.js +74 -74
  55. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  56. package/sdk/application/index.d.ts +18 -18
  57. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
  58. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
  60. package/sdk/partner/OAuthClient.d.ts +4 -4
  61. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  62. package/sdk/partner/PartnerClient.d.ts +6 -6
  63. package/sdk/partner/PartnerConfig.d.ts +4 -4
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
  65. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
  66. package/sdk/partner/index.d.ts +7 -7
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  70. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  71. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  72. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  75. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  76. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  79. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
  80. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  81. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  82. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
  83. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  84. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
  85. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  86. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  87. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
  88. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  89. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
  90. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  91. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  92. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
  93. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  94. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  95. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
  96. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  97. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  98. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
  99. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  100. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
  101. package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
  102. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  103. package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
  104. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
  105. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  106. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  107. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
  108. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  110. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  113. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  114. package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
  115. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  116. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  117. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
  118. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  119. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  120. package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
  121. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  122. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  123. package/sdk/platform/OAuthClient.d.ts +3 -3
  124. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  125. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  126. package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
  127. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  128. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  129. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  130. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  131. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  132. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  133. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  134. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  135. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
  136. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  137. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  138. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
  139. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  140. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  141. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  142. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  143. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  144. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  145. package/sdk/platform/PlatformClient.d.ts +19 -21
  146. package/sdk/platform/PlatformClient.js +0 -4
  147. package/sdk/platform/PlatformConfig.d.ts +4 -4
  148. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
  149. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  150. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  151. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  152. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  153. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  154. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
  155. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  156. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
  158. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  159. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  161. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  162. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -106
  163. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  164. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  165. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  166. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  167. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  168. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  169. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  170. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  171. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  172. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
  173. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  174. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  175. package/sdk/platform/index.d.ts +24 -25
  176. package/sdk/platform/index.js +0 -2
  177. package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
  178. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  179. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  180. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  181. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  182. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  183. package/sdk/public/PublicAPIClient.d.ts +1 -1
  184. package/sdk/public/PublicClient.d.ts +7 -7
  185. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  186. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  187. package/sdk/public/index.d.ts +8 -8
  188. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  189. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  190. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  191. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  192. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  193. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -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: 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/).
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/).
28
28
  */
29
29
  async createAudience(
30
30
  { body, requestHeaders } = { requestHeaders: {} },
@@ -105,7 +105,7 @@ class Communication {
105
105
  * @returns {Promise<Object>} - Success response
106
106
  * @name createBigQueryHeaders
107
107
  * @summary: Create BigQuery headers
108
- * @description: Create big query headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
108
+ * @description: Create BigQuery headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
109
109
  */
110
110
  async createBigQueryHeaders(
111
111
  { requestHeaders } = { requestHeaders: {} },
@@ -180,7 +180,7 @@ class Communication {
180
180
  * @returns {Promise<Object>} - Success response
181
181
  * @name createBigQueryNCount
182
182
  * @summary: Create BigQuery N-count
183
- * @description: Create big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
183
+ * @description: Creates big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
184
184
  */
185
185
  async createBigQueryNCount(
186
186
  { requestHeaders } = { requestHeaders: {} },
@@ -254,8 +254,8 @@ class Communication {
254
254
  * @param {import("../PlatformAPIClient").Options} - Options
255
255
  * @returns {Promise<Object>} - Success response
256
256
  * @name createBigQueryRowCount
257
- * @summary: Create BigQuery row count
258
- * @description: Create big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/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
259
  */
260
260
  async createBigQueryRowCount(
261
261
  { requestHeaders } = { requestHeaders: {} },
@@ -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: Add a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
332
+ * @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/).
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: Generate and add a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
413
+ * @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/).
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: Generate and add a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
494
+ * @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/).
496
496
  */
497
497
  async createEmailTemplate(
498
498
  { body, requestHeaders } = { requestHeaders: {} },
@@ -574,8 +574,8 @@ class Communication {
574
574
  * - Success response
575
575
  *
576
576
  * @name createEventSubscriptions
577
- * @summary: Create event subscriptions
578
- * @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
577
+ * @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/).
579
579
  */
580
580
  async createEventSubscriptions(
581
581
  { body, requestHeaders } = { requestHeaders: {} },
@@ -659,8 +659,8 @@ class Communication {
659
659
  * - Success response
660
660
  *
661
661
  * @name createEventSubscriptionsByBulk
662
- * @summary: Create event subscriptions by bulk
663
- * @description: Create event subscriptions by bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
662
+ * @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/).
664
664
  */
665
665
  async createEventSubscriptionsByBulk(
666
666
  { body, requestHeaders } = { requestHeaders: {} },
@@ -735,8 +735,8 @@ class Communication {
735
735
  * @param {import("../PlatformAPIClient").Options} - Options
736
736
  * @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
737
737
  * @name createJobs
738
- * @summary: Create jobs
739
- * @description: Create jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createJobs/).
738
+ * @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/).
740
740
  */
741
741
  async createJobs(
742
742
  { body, requestHeaders } = { requestHeaders: {} },
@@ -817,7 +817,7 @@ class Communication {
817
817
  * @returns {Promise<Object>} - Success response
818
818
  * @name createSmsProvider
819
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/).
820
+ * @description: Creates 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: Add a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
898
+ * @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/).
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: Remove a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
979
+ * @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/).
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: Remove a specific email communication provider from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
1062
+ * @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/).
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. Remove a specific email communication template by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
1143
+ * @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/).
1145
1145
  */
1146
1146
  async deleteEmailTemplateById(
1147
1147
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1221,8 +1221,8 @@ class Communication {
1221
1221
  * @param {import("../PlatformAPIClient").Options} - Options
1222
1222
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
1223
1223
  * @name deleteEventSubscriptionsById
1224
- * @summary: Create event subscriptions
1225
- * @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEventSubscriptionsById/).
1224
+ * @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/).
1226
1226
  */
1227
1227
  async deleteEventSubscriptionsById(
1228
1228
  { 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: Remove a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
1305
+ * @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/).
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: Remove a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
1386
+ * @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/).
1388
1388
  */
1389
1389
  async deleteSmsTemplateById(
1390
1390
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1466,8 +1466,8 @@ class Communication {
1466
1466
  * - Success response
1467
1467
  *
1468
1468
  * @name editEventSubscriptions
1469
- * @summary: Create event subscriptions
1470
- * @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/editEventSubscriptions/).
1469
+ * @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/).
1471
1471
  */
1472
1472
  async editEventSubscriptions(
1473
1473
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -1550,7 +1550,7 @@ class Communication {
1550
1550
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
1551
1551
  * @name getAppProviders
1552
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/).
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/).
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: Retrieve detailed information about a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
1629
+ * @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/).
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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
1710
+ * @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/).
1712
1712
  */
1713
1713
  async getAudiences(
1714
1714
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -1798,8 +1798,8 @@ class Communication {
1798
1798
  * @param {import("../PlatformAPIClient").Options} - Options
1799
1799
  * @returns {Promise<Object>} - Success response
1800
1800
  * @name 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/).
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
1803
  */
1804
1804
  async getBigQueryHeadersById(
1805
1805
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1877,8 +1877,8 @@ class Communication {
1877
1877
  * @param {import("../PlatformAPIClient").Options} - Options
1878
1878
  * @returns {Promise<Object>} - Success response
1879
1879
  * @name 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/).
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
1882
  */
1883
1883
  async getBigQueryRowCountById(
1884
1884
  { id, requestHeaders } = { requestHeaders: {} },
@@ -1956,8 +1956,8 @@ class Communication {
1956
1956
  * @param {import("../PlatformAPIClient").Options} - Options
1957
1957
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
1958
1958
  * @name 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/).
1959
+ * @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/).
1961
1961
  */
1962
1962
  async getCampaignById(
1963
1963
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2037,8 +2037,8 @@ class Communication {
2037
2037
  * @param {import("../PlatformAPIClient").Options} - Options
2038
2038
  * @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
2039
2039
  * @name 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/).
2040
+ * @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/).
2042
2042
  */
2043
2043
  async getCampaigns(
2044
2044
  { query, pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
@@ -2128,8 +2128,8 @@ class Communication {
2128
2128
  * @param {import("../PlatformAPIClient").Options} - Options
2129
2129
  * @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
2130
2130
  * @name 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/).
2131
+ * @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/).
2133
2133
  */
2134
2134
  async getCommunicationLogs(
2135
2135
  { pageId, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2220,8 +2220,8 @@ class Communication {
2220
2220
  * @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
2221
2221
  * Success response
2222
2222
  * @name 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/).
2223
+ * @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/).
2225
2225
  */
2226
2226
  async getDefaultSmsProviders(
2227
2227
  { requestHeaders } = { requestHeaders: {} },
@@ -2296,7 +2296,7 @@ class Communication {
2296
2296
  * Success response
2297
2297
  * @name getDummyDatasources
2298
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/).
2299
+ * @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
2300
2300
  */
2301
2301
  async getDummyDatasources(
2302
2302
  { requestHeaders } = { requestHeaders: {} },
@@ -2451,8 +2451,8 @@ class Communication {
2451
2451
  * @param {import("../PlatformAPIClient").Options} - Options
2452
2452
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
2453
2453
  * @name 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/).
2454
+ * @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/).
2456
2456
  */
2457
2457
  async getEmailProviderById(
2458
2458
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2532,8 +2532,8 @@ class Communication {
2532
2532
  * @param {import("../PlatformAPIClient").Options} - Options
2533
2533
  * @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
2534
2534
  * @name 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/).
2535
+ * @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/).
2537
2537
  */
2538
2538
  async getEmailProviders(
2539
2539
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2623,8 +2623,8 @@ class Communication {
2623
2623
  * @param {import("../PlatformAPIClient").Options} - Options
2624
2624
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
2625
2625
  * @name 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/).
2626
+ * @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/).
2628
2628
  */
2629
2629
  async getEmailTemplateById(
2630
2630
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2704,8 +2704,8 @@ class Communication {
2704
2704
  * @param {import("../PlatformAPIClient").Options} - Options
2705
2705
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
2706
2706
  * @name 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/).
2707
+ * @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/).
2709
2709
  */
2710
2710
  async getEmailTemplates(
2711
2711
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -2796,8 +2796,8 @@ class Communication {
2796
2796
  * @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
2797
2797
  * Success response
2798
2798
  * @name 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/).
2799
+ * @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/).
2801
2801
  */
2802
2802
  async getEventSubscriptions(
2803
2803
  { pageNo, pageSize, populate, requestHeaders } = { requestHeaders: {} },
@@ -2884,8 +2884,8 @@ class Communication {
2884
2884
  * @param {import("../PlatformAPIClient").Options} - Options
2885
2885
  * @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
2886
2886
  * @name getEventSubscriptionsById
2887
- * @summary: Get event subscriptions by id
2888
- * @description: Get event subscriptions by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptionsById/).
2887
+ * @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/).
2889
2889
  */
2890
2890
  async getEventSubscriptionsById(
2891
2891
  { id, populate, requestHeaders } = { requestHeaders: {} },
@@ -2969,7 +2969,7 @@ class Communication {
2969
2969
  * @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
2970
2970
  * @name getGlobalProviders
2971
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/).
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/).
2973
2973
  */
2974
2974
  async getGlobalProviders(
2975
2975
  { requestHeaders } = { requestHeaders: {} },
@@ -3047,8 +3047,8 @@ class Communication {
3047
3047
  * - Success response
3048
3048
  *
3049
3049
  * @name 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/).
3050
+ * @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/).
3052
3052
  */
3053
3053
  async getGlobalVariables(
3054
3054
  { requestHeaders } = { requestHeaders: {} },
@@ -3122,8 +3122,8 @@ class Communication {
3122
3122
  * @param {import("../PlatformAPIClient").Options} - Options
3123
3123
  * @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
3124
3124
  * @name 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/).
3125
+ * @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/).
3127
3127
  */
3128
3128
  async getJobLogs(
3129
3129
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3211,8 +3211,8 @@ class Communication {
3211
3211
  * @param {import("../PlatformAPIClient").Options} - Options
3212
3212
  * @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
3213
3213
  * @name 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/).
3214
+ * @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/).
3216
3216
  */
3217
3217
  async getJobs(
3218
3218
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3302,7 +3302,7 @@ class Communication {
3302
3302
  * @param {import("../PlatformAPIClient").Options} - Options
3303
3303
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
3304
3304
  * @name getNSampleRecordsFromCsv
3305
- * @summary: Get N sample records from CSV
3305
+ * @summary: Get N sample records of a CSV
3306
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/).
3307
3307
  */
3308
3308
  async getNSampleRecordsFromCsv(
@@ -3383,8 +3383,8 @@ class Communication {
3383
3383
  * @param {import("../PlatformAPIClient").Options} - Options
3384
3384
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
3385
3385
  * @name 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/).
3386
+ * @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/).
3388
3388
  */
3389
3389
  async getNSampleRecordsFromCsvByGet(
3390
3390
  { requestHeaders } = { requestHeaders: {} },
@@ -3460,8 +3460,8 @@ class Communication {
3460
3460
  * @param {import("../PlatformAPIClient").Options} - Options
3461
3461
  * @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
3462
3462
  * @name getOtpConfiguration
3463
- * @summary: Get otp-configuration, if not present in db then return default settings
3464
- * @description: Get otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getOtpConfiguration/).
3463
+ * @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/).
3465
3465
  */
3466
3466
  async getOtpConfiguration(
3467
3467
  { requestHeaders } = { requestHeaders: {} },
@@ -3537,7 +3537,7 @@ class Communication {
3537
3537
  * @param {import("../PlatformAPIClient").Options} - Options
3538
3538
  * @returns {Promise<Object>} - Success response
3539
3539
  * @name getSmsProviderById
3540
- * @summary: Get SMS provider by ID
3540
+ * @summary: Get a SMS provider
3541
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/).
3542
3542
  */
3543
3543
  async getSmsProviderById(
@@ -3616,8 +3616,8 @@ class Communication {
3616
3616
  * @param {import("../PlatformAPIClient").Options} - Options
3617
3617
  * @returns {Promise<Object>} - Success response
3618
3618
  * @name 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/).
3619
+ * @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/).
3621
3621
  */
3622
3622
  async getSmsProviders(
3623
3623
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3705,8 +3705,8 @@ class Communication {
3705
3705
  * @param {import("../PlatformAPIClient").Options} - Options
3706
3706
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
3707
3707
  * @name 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/).
3708
+ * @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/).
3710
3710
  */
3711
3711
  async getSmsTemplateById(
3712
3712
  { id, requestHeaders } = { requestHeaders: {} },
@@ -3786,8 +3786,8 @@ class Communication {
3786
3786
  * @param {import("../PlatformAPIClient").Options} - Options
3787
3787
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
3788
3788
  * @name 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/).
3789
+ * @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/).
3791
3791
  */
3792
3792
  async getSmsTemplates(
3793
3793
  { pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
@@ -3877,8 +3877,8 @@ class Communication {
3877
3877
  * @param {import("../PlatformAPIClient").Options} - Options
3878
3878
  * @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
3879
3879
  * @name 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/).
3880
+ * @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/).
3882
3882
  */
3883
3883
  async getStatsOfCampaignById(
3884
3884
  { id, requestHeaders } = { requestHeaders: {} },
@@ -3958,8 +3958,8 @@ class Communication {
3958
3958
  * @param {import("../PlatformAPIClient").Options} - Options
3959
3959
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
3960
3960
  * @name 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/).
3961
+ * @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/).
3963
3963
  */
3964
3964
  async getSubscribedEmailTemplates(
3965
3965
  { pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
@@ -4046,8 +4046,8 @@ class Communication {
4046
4046
  * @param {import("../PlatformAPIClient").Options} - Options
4047
4047
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
4048
4048
  * @name 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/).
4049
+ * @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/).
4051
4051
  */
4052
4052
  async getSubscribedSmsTemplates(
4053
4053
  { pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
@@ -4135,7 +4135,7 @@ class Communication {
4135
4135
  * @returns {Promise<Object>} - Success response
4136
4136
  * @name getSystemAudiences
4137
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/).
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
4139
  */
4140
4140
  async getSystemAudiences(
4141
4141
  { requestHeaders } = { requestHeaders: {} },
@@ -4210,8 +4210,8 @@ class Communication {
4210
4210
  * @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
4211
4211
  * Success response
4212
4212
  * @name 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/).
4213
+ * @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/).
4215
4215
  */
4216
4216
  async getSystemEmailTemplates(
4217
4217
  { requestHeaders } = { requestHeaders: {} },
@@ -4288,8 +4288,8 @@ class Communication {
4288
4288
  * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
4289
4289
  * Success response
4290
4290
  * @name 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/).
4291
+ * @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/).
4293
4293
  */
4294
4294
  async getSystemSmsTemplates(
4295
4295
  { requestHeaders } = { requestHeaders: {} },
@@ -4364,8 +4364,8 @@ class Communication {
4364
4364
  * - Success response
4365
4365
  *
4366
4366
  * @name 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/).
4367
+ * @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/).
4369
4369
  */
4370
4370
  async postGlobalVariables(
4371
4371
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4446,7 +4446,7 @@ class Communication {
4446
4446
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
4447
4447
  * @name sendCommunicationAsynchronously
4448
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/).
4449
+ * @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
4450
4450
  */
4451
4451
  async sendCommunicationAsynchronously(
4452
4452
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4527,7 +4527,7 @@ class Communication {
4527
4527
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
4528
4528
  * @name sendCommunicationSynchronously
4529
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/).
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/).
4531
4531
  */
4532
4532
  async sendCommunicationSynchronously(
4533
4533
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4606,7 +4606,7 @@ class Communication {
4606
4606
  * @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
4607
4607
  * @name sendOtp
4608
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/).
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/).
4610
4610
  */
4611
4611
  async sendOtp(
4612
4612
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4687,8 +4687,8 @@ class Communication {
4687
4687
  * @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
4688
4688
  * Success response
4689
4689
  * @name 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/).
4690
+ * @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/).
4692
4692
  */
4693
4693
  async triggerCampaignJob(
4694
4694
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4769,7 +4769,7 @@ class Communication {
4769
4769
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
4770
4770
  * @name updateAppProviders
4771
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/).
4772
+ * @description: Modify provider configuration using provider object id . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
4773
4773
  */
4774
4774
  async updateAppProviders(
4775
4775
  { body, requestHeaders } = { requestHeaders: {} },
@@ -4849,8 +4849,8 @@ class Communication {
4849
4849
  * @param {import("../PlatformAPIClient").Options} - Options
4850
4850
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
4851
4851
  * @name 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/).
4852
+ * @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/).
4854
4854
  */
4855
4855
  async updateAudienceById(
4856
4856
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -4932,8 +4932,8 @@ class Communication {
4932
4932
  * @param {import("../PlatformAPIClient").Options} - Options
4933
4933
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
4934
4934
  * @name 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/).
4935
+ * @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/).
4937
4937
  */
4938
4938
  async updateCampaignById(
4939
4939
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5015,8 +5015,8 @@ class Communication {
5015
5015
  * @param {import("../PlatformAPIClient").Options} - Options
5016
5016
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
5017
5017
  * @name 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/).
5018
+ * @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/).
5020
5020
  */
5021
5021
  async updateEmailProviderById(
5022
5022
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5098,8 +5098,8 @@ class Communication {
5098
5098
  * @param {import("../PlatformAPIClient").Options} - Options
5099
5099
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
5100
5100
  * @name 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/).
5101
+ * @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/).
5103
5103
  */
5104
5104
  async updateEmailTemplateById(
5105
5105
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5181,8 +5181,8 @@ class Communication {
5181
5181
  * @param {import("../PlatformAPIClient").Options} - Options
5182
5182
  * @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
5183
5183
  * @name updateOtpConfiguration
5184
- * @summary: Update/insert otp configurations
5185
- * @description: Update otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateOtpConfiguration/).
5184
+ * @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/).
5186
5186
  */
5187
5187
  async updateOtpConfiguration(
5188
5188
  { requestHeaders } = { requestHeaders: {} },
@@ -5258,8 +5258,8 @@ class Communication {
5258
5258
  * @param {import("../PlatformAPIClient").Options} - Options
5259
5259
  * @returns {Promise<Object>} - Success response
5260
5260
  * @name 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/).
5261
+ * @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/).
5263
5263
  */
5264
5264
  async updateSmsProviderById(
5265
5265
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5339,8 +5339,8 @@ class Communication {
5339
5339
  * @param {import("../PlatformAPIClient").Options} - Options
5340
5340
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
5341
5341
  * @name 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/).
5342
+ * @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/).
5344
5344
  */
5345
5345
  async updateSmsTemplateById(
5346
5346
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5423,7 +5423,7 @@ class Communication {
5423
5423
  *
5424
5424
  * @name verfiyOtp
5425
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/).
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/).
5427
5427
  */
5428
5428
  async verfiyOtp(
5429
5429
  { body, requestHeaders } = { requestHeaders: {} },