@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
@@ -11,8 +11,8 @@ declare class Communication {
11
11
  * @param {import("../PlatformAPIClient").Options} - Options
12
12
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
13
13
  * @name createAudience
14
- * @summary: Create audience
15
- * @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to create audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
14
+ * @summary: Create audience.
15
+ * @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/).
16
16
  */
17
17
  createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
18
18
  /**
@@ -23,7 +23,7 @@ declare class Communication {
23
23
  * @param {import("../PlatformAPIClient").Options} - Options
24
24
  * @returns {Promise<Object>} - Success response
25
25
  * @name createBigQueryHeaders
26
- * @summary: Create big query headers
26
+ * @summary: Create BigQuery headers.
27
27
  * @description: Create big query headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
28
28
  */
29
29
  createBigQueryHeaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
@@ -35,7 +35,7 @@ declare class Communication {
35
35
  * @param {import("../PlatformAPIClient").Options} - Options
36
36
  * @returns {Promise<Object>} - Success response
37
37
  * @name createBigQueryNCount
38
- * @summary: Create big query n count
38
+ * @summary: Create BigQuery N-count.
39
39
  * @description: Create big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
40
40
  */
41
41
  createBigQueryNCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
@@ -47,7 +47,7 @@ declare class Communication {
47
47
  * @param {import("../PlatformAPIClient").Options} - Options
48
48
  * @returns {Promise<Object>} - Success response
49
49
  * @name createBigQueryRowCount
50
- * @summary: Create big query row count
50
+ * @summary: Create BigQuery row count.
51
51
  * @description: Create big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
52
52
  */
53
53
  createBigQueryRowCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
@@ -59,8 +59,8 @@ declare class Communication {
59
59
  * @param {import("../PlatformAPIClient").Options} - Options
60
60
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
61
61
  * @name createCampaign
62
- * @summary: Create campaign
63
- * @description: Create campaign - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
62
+ * @summary: Create campaign.
63
+ * @description: Add a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
64
64
  */
65
65
  createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
66
66
  /**
@@ -71,8 +71,8 @@ declare class Communication {
71
71
  * @param {import("../PlatformAPIClient").Options} - Options
72
72
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
73
73
  * @name createEmailProvider
74
- * @summary: Create email provider
75
- * @description: Create email provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
74
+ * @summary: Create email provider.
75
+ * @description: Generate and add a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
76
76
  */
77
77
  createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
78
78
  /**
@@ -83,8 +83,8 @@ declare class Communication {
83
83
  * @param {import("../PlatformAPIClient").Options} - Options
84
84
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
85
85
  * @name createEmailTemplate
86
- * @summary: Create email template
87
- * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to create an email template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
86
+ * @summary: Create email template.
87
+ * @description: Generate and add a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
88
88
  */
89
89
  createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
90
90
  /**
@@ -135,8 +135,8 @@ declare class Communication {
135
135
  * @param {import("../PlatformAPIClient").Options} - Options
136
136
  * @returns {Promise<Object>} - Success response
137
137
  * @name createSmsProvider
138
- * @summary: Create sms provider
139
- * @description: Create sms provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
138
+ * @summary: Create SMS provider.
139
+ * @description: Add a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
140
140
  */
141
141
  createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
142
142
  /**
@@ -147,8 +147,8 @@ declare class Communication {
147
147
  * @param {import("../PlatformAPIClient").Options} - Options
148
148
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
149
149
  * @name createSmsTemplate
150
- * @summary: Create sms template
151
- * @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/).
150
+ * @summary: Create SMS template.
151
+ * @description: Add a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
152
152
  */
153
153
  createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
154
154
  /**
@@ -159,8 +159,8 @@ declare class Communication {
159
159
  * @param {import("../PlatformAPIClient").Options} - Options
160
160
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
161
161
  * @name deleteAudienceById
162
- * @summary: Delete audience by id
163
- * @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/).
162
+ * @summary: Delete audience by ID.
163
+ * @description: Remove a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
164
164
  */
165
165
  deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
166
166
  /**
@@ -171,8 +171,8 @@ declare class Communication {
171
171
  * @param {import("../PlatformAPIClient").Options} - Options
172
172
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
173
173
  * @name deleteEmailProviderById
174
- * @summary: Delete email provider by id
175
- * @description: Delete email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
174
+ * @summary: Delete email provider by ID.
175
+ * @description: Remove a specific email communication provider from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
176
176
  */
177
177
  deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
178
178
  /**
@@ -183,8 +183,8 @@ declare class Communication {
183
183
  * @param {import("../PlatformAPIClient").Options} - Options
184
184
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
185
185
  * @name deleteEmailTemplateById
186
- * @summary: Delete email template by id
187
- * @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/).
186
+ * @summary: Delete email template by ID.
187
+ * @description: Email templates are predefined formats linked to various events for delivering messages to users. Remove a specific email communication template by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
188
188
  */
189
189
  deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
190
190
  /**
@@ -207,8 +207,8 @@ declare class Communication {
207
207
  * @param {import("../PlatformAPIClient").Options} - Options
208
208
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
209
209
  * @name deleteSmsProviderById
210
- * @summary: Delete sms provider by id
211
- * @description: Delete sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
210
+ * @summary: Delete SMS provider by ID.
211
+ * @description: Remove a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
212
212
  */
213
213
  deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
214
214
  /**
@@ -219,8 +219,8 @@ declare class Communication {
219
219
  * @param {import("../PlatformAPIClient").Options} - Options
220
220
  * @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
221
221
  * @name deleteSmsTemplateById
222
- * @summary: Delete sms template by id
223
- * @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/).
222
+ * @summary: Delete SMS template by ID.
223
+ * @description: Remove a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
224
224
  */
225
225
  deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
226
226
  /**
@@ -245,8 +245,8 @@ declare class Communication {
245
245
  * @param {import("../PlatformAPIClient").Options} - Options
246
246
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
247
247
  * @name getAppProviders
248
- * @summary: Get app providers
249
- * @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/).
248
+ * @summary: Get application providers.
249
+ * @description: Retrieve a list of providers associated with the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
250
250
  */
251
251
  getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
252
252
  /**
@@ -257,8 +257,8 @@ declare class Communication {
257
257
  * @param {import("../PlatformAPIClient").Options} - Options
258
258
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
259
259
  * @name getAudienceById
260
- * @summary: Get audience by id
261
- * @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences by Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
260
+ * @summary: Get audience by ID.
261
+ * @description: Retrieve detailed information about a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
262
262
  */
263
263
  getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
264
264
  /**
@@ -269,28 +269,10 @@ declare class Communication {
269
269
  * @param {import("../PlatformAPIClient").Options} - Options
270
270
  * @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
271
271
  * @name getAudiences
272
- * @summary: Get audiences
273
- * @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
272
+ * @summary: Get audiences.
273
+ * @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
274
274
  */
275
275
  getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
276
- /**
277
- * @param {Object} arg - Arg object.
278
- * @param {string} arg.companyId - Company id
279
- * @param {string} arg.applicationId - Application id
280
- * @param {number} [arg.pageSize] - Current request items count
281
- * @param {Object} [arg.sort] - To sort based on created_at
282
- * @param {Object} [arg.query] - To search based on plain text
283
- * @returns {Paginator<CommunicationPlatformModel.Audiences>}
284
- * @summary: Get audiences
285
- * @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.
286
- */
287
- getAudiencesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
288
- companyId: string;
289
- applicationId: string;
290
- pageSize?: number;
291
- sort?: any;
292
- query?: any;
293
- }): Paginator<CommunicationPlatformModel.Audiences>;
294
276
  /**
295
277
  * @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
296
278
  * - Arg object
@@ -299,8 +281,8 @@ declare class Communication {
299
281
  * @param {import("../PlatformAPIClient").Options} - Options
300
282
  * @returns {Promise<Object>} - Success response
301
283
  * @name getBigQueryHeadersById
302
- * @summary: Get big query headers by id
303
- * @description: Get big query headers by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
284
+ * @summary: Get BigQuery headers by ID.
285
+ * @description: Retrieve header information from BigQuery for a specific campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
304
286
  */
305
287
  getBigQueryHeadersById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam, { responseHeaders }?: object): Promise<any>;
306
288
  /**
@@ -311,8 +293,8 @@ declare class Communication {
311
293
  * @param {import("../PlatformAPIClient").Options} - Options
312
294
  * @returns {Promise<Object>} - Success response
313
295
  * @name getBigQueryRowCountById
314
- * @summary: Get big query row count by id
315
- * @description: Get big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
296
+ * @summary: Get BigQuery row count by ID.
297
+ * @description: Retrieve big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
316
298
  */
317
299
  getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
318
300
  /**
@@ -323,8 +305,8 @@ declare class Communication {
323
305
  * @param {import("../PlatformAPIClient").Options} - Options
324
306
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
325
307
  * @name getCampaignById
326
- * @summary: Get campaign by id
327
- * @description: Get campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
308
+ * @summary: Get campaign by ID.
309
+ * @description: Retrieve detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
328
310
  */
329
311
  getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
330
312
  /**
@@ -335,8 +317,8 @@ declare class Communication {
335
317
  * @param {import("../PlatformAPIClient").Options} - Options
336
318
  * @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
337
319
  * @name getCampaigns
338
- * @summary: Get campaigns
339
- * @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
320
+ * @summary: Get campaigns.
321
+ * @description: Retrieve a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
340
322
  */
341
323
  getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
342
324
  /**
@@ -347,28 +329,10 @@ declare class Communication {
347
329
  * @param {import("../PlatformAPIClient").Options} - Options
348
330
  * @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
349
331
  * @name getCommunicationLogs
350
- * @summary: Get communication logs
351
- * @description: Get communication logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
332
+ * @summary: Get communication logs.
333
+ * @description: Retrieve logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
352
334
  */
353
335
  getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
354
- /**
355
- * @param {Object} arg - Arg object.
356
- * @param {string} arg.companyId - Company id
357
- * @param {string} arg.applicationId - Application id
358
- * @param {number} [arg.pageSize] - Current request items count
359
- * @param {Object} [arg.sort] - To sort based on _id
360
- * @param {Object} [arg.query] -
361
- * @returns {Paginator<CommunicationPlatformModel.Logs>}
362
- * @summary: Get communication logs
363
- * @description: Get communication logs
364
- */
365
- getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
366
- companyId: string;
367
- applicationId: string;
368
- pageSize?: number;
369
- sort?: any;
370
- query?: any;
371
- }): Paginator<CommunicationPlatformModel.Logs>;
372
336
  /**
373
337
  * @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg
374
338
  * - Arg object
@@ -378,8 +342,8 @@ declare class Communication {
378
342
  * @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
379
343
  * Success response
380
344
  * @name getDefaultSmsProviders
381
- * @summary: Get default sms providers
382
- * @description: Get default sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
345
+ * @summary: Get default SMS providers.
346
+ * @description: Retrieve the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
383
347
  */
384
348
  getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
385
349
  /**
@@ -391,8 +355,8 @@ declare class Communication {
391
355
  * @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
392
356
  * Success response
393
357
  * @name getDummyDatasources
394
- * @summary: Get dummy data sources
395
- * @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/).
358
+ * @summary: Get dummy data sources.
359
+ * @description: Retrieve a list of dummy data sources for testing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
396
360
  */
397
361
  getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
398
362
  /**
@@ -404,8 +368,8 @@ declare class Communication {
404
368
  * @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
405
369
  * Success response
406
370
  * @name getDummyDatasourcesMeta
407
- * @summary: Get dummy data sources meta
408
- * @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/).
371
+ * @summary: Get dummy data sources metadata.
372
+ * @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
409
373
  */
410
374
  getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
411
375
  /**
@@ -416,8 +380,8 @@ declare class Communication {
416
380
  * @param {import("../PlatformAPIClient").Options} - Options
417
381
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
418
382
  * @name getEmailProviderById
419
- * @summary: Get email provider by id
420
- * @description: Get email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
383
+ * @summary: Get email provider by ID.
384
+ * @description: Retrieve detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
421
385
  */
422
386
  getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
423
387
  /**
@@ -428,28 +392,10 @@ declare class Communication {
428
392
  * @param {import("../PlatformAPIClient").Options} - Options
429
393
  * @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
430
394
  * @name getEmailProviders
431
- * @summary: Get email providers
432
- * @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
395
+ * @summary: Get email providers.
396
+ * @description: Retrieve a list of email communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
433
397
  */
434
398
  getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
435
- /**
436
- * @param {Object} arg - Arg object.
437
- * @param {string} arg.companyId - Company id
438
- * @param {string} arg.applicationId - Application id
439
- * @param {number} [arg.pageSize] - Current request items count
440
- * @param {Object} [arg.sort] - To sort based on created_at
441
- * @param {Object} [arg.query] - To search based on plain text
442
- * @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
443
- * @summary: Get email providers
444
- * @description: Get email providers
445
- */
446
- getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
447
- companyId: string;
448
- applicationId: string;
449
- pageSize?: number;
450
- sort?: any;
451
- query?: any;
452
- }): Paginator<CommunicationPlatformModel.EmailProviders>;
453
399
  /**
454
400
  * @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
455
401
  * - Arg object
@@ -458,8 +404,8 @@ declare class Communication {
458
404
  * @param {import("../PlatformAPIClient").Options} - Options
459
405
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
460
406
  * @name getEmailTemplateById
461
- * @summary: Get email template by id
462
- * @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/).
407
+ * @summary: Get email template by ID.
408
+ * @description: Retrieve detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
463
409
  */
464
410
  getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
465
411
  /**
@@ -470,28 +416,10 @@ declare class Communication {
470
416
  * @param {import("../PlatformAPIClient").Options} - Options
471
417
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
472
418
  * @name getEmailTemplates
473
- * @summary: Get email templates
474
- * @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/).
419
+ * @summary: Get email templates.
420
+ * @description: Retrieve a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
475
421
  */
476
422
  getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
477
- /**
478
- * @param {Object} arg - Arg object.
479
- * @param {string} arg.companyId - Company id
480
- * @param {string} arg.applicationId - Application id
481
- * @param {number} [arg.pageSize] - Current request items count
482
- * @param {Object} [arg.sort] - To sort based on created_at
483
- * @param {Object} [arg.query] - To search based on plain text
484
- * @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
485
- * @summary: Get email templates
486
- * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.
487
- */
488
- getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
489
- companyId: string;
490
- applicationId: string;
491
- pageSize?: number;
492
- sort?: any;
493
- query?: any;
494
- }): Paginator<CommunicationPlatformModel.EmailTemplates>;
495
423
  /**
496
424
  * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
497
425
  * - Arg object
@@ -501,26 +429,10 @@ declare class Communication {
501
429
  * @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
502
430
  * Success response
503
431
  * @name getEventSubscriptions
504
- * @summary: Get event subscriptions
505
- * @description: Get event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
432
+ * @summary: Get event subscriptions.
433
+ * @description: Retrieve a list of event subscriptions related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
506
434
  */
507
435
  getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
508
- /**
509
- * @param {Object} arg - Arg object.
510
- * @param {string} arg.companyId - Company id
511
- * @param {string} arg.applicationId - Application id
512
- * @param {number} [arg.pageSize] - Current request items count
513
- * @param {string} [arg.populate] - Populate Fields
514
- * @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
515
- * @summary: Get event subscriptions
516
- * @description: Get event subscriptions
517
- */
518
- getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
519
- companyId: string;
520
- applicationId: string;
521
- pageSize?: number;
522
- populate?: string;
523
- }): Paginator<CommunicationPlatformModel.EventSubscriptions>;
524
436
  /**
525
437
  * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
526
438
  * - Arg object
@@ -541,8 +453,8 @@ declare class Communication {
541
453
  * @param {import("../PlatformAPIClient").Options} - Options
542
454
  * @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
543
455
  * @name getGlobalProviders
544
- * @summary: Get global providers
545
- * @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/).
456
+ * @summary: Get global providers.
457
+ * @description: Retrieve a list of global communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
546
458
  */
547
459
  getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
548
460
  /**
@@ -555,8 +467,8 @@ declare class Communication {
555
467
  * - Success response
556
468
  *
557
469
  * @name getGlobalVariables
558
- * @summary: get global variables
559
- * @description: get global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
470
+ * @summary: Get global variables.
471
+ * @description: Retrieve global variables used in communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
560
472
  */
561
473
  getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>;
562
474
  /**
@@ -565,56 +477,20 @@ declare class Communication {
565
477
  * @param {import("../PlatformAPIClient").Options} - Options
566
478
  * @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
567
479
  * @name getJobLogs
568
- * @summary: Get job logs
569
- * @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
480
+ * @summary: Get job logs.
481
+ * @description: Retrieve logs and details related to communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
570
482
  */
571
483
  getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
572
- /**
573
- * @param {Object} arg - Arg object.
574
- * @param {string} arg.companyId - Company id
575
- * @param {string} arg.applicationId - Application id
576
- * @param {number} [arg.pageSize] - Current request items count
577
- * @param {Object} [arg.sort] - To sort based on created_at
578
- * @param {Object} [arg.query] - To search based on plain text
579
- * @returns {Paginator<CommunicationPlatformModel.JobLogs>}
580
- * @summary: Get job logs
581
- * @description: Get job logs
582
- */
583
- getJobLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
584
- companyId: string;
585
- applicationId: string;
586
- pageSize?: number;
587
- sort?: any;
588
- query?: any;
589
- }): Paginator<CommunicationPlatformModel.JobLogs>;
590
484
  /**
591
485
  * @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
592
486
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
593
487
  * @param {import("../PlatformAPIClient").Options} - Options
594
488
  * @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
595
489
  * @name getJobs
596
- * @summary: Get jobs
597
- * @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
490
+ * @summary: Get jobs.
491
+ * @description: Retrieve a list of communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
598
492
  */
599
493
  getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
600
- /**
601
- * @param {Object} arg - Arg object.
602
- * @param {string} arg.companyId - Company id
603
- * @param {string} arg.applicationId - Application id
604
- * @param {number} [arg.pageSize] - Current request items count
605
- * @param {Object} [arg.sort] - To sort based on created_at
606
- * @param {Object} [arg.query] - To search based on plain text
607
- * @returns {Paginator<CommunicationPlatformModel.Jobs>}
608
- * @summary: Get jobs
609
- * @description: Get jobs
610
- */
611
- getJobsPaginator({ companyId, applicationId, pageSize, sort, query }?: {
612
- companyId: string;
613
- applicationId: string;
614
- pageSize?: number;
615
- sort?: any;
616
- query?: any;
617
- }): Paginator<CommunicationPlatformModel.Jobs>;
618
494
  /**
619
495
  * @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
620
496
  * - Arg object
@@ -623,8 +499,8 @@ declare class Communication {
623
499
  * @param {import("../PlatformAPIClient").Options} - Options
624
500
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
625
501
  * @name getNSampleRecordsFromCsv
626
- * @summary: Get n sample records from csv
627
- * @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/).
502
+ * @summary: Get N sample records from CSV.
503
+ * @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/).
628
504
  */
629
505
  getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
630
506
  /**
@@ -635,8 +511,8 @@ declare class Communication {
635
511
  * @param {import("../PlatformAPIClient").Options} - Options
636
512
  * @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
637
513
  * @name getNSampleRecordsFromCsvByGet
638
- * @summary: Get n sample records from csv
639
- * @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/).
514
+ * @summary: Get N sample records in CSV
515
+ * @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/).
640
516
  */
641
517
  getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
642
518
  /**
@@ -659,8 +535,8 @@ declare class Communication {
659
535
  * @param {import("../PlatformAPIClient").Options} - Options
660
536
  * @returns {Promise<Object>} - Success response
661
537
  * @name getSmsProviderById
662
- * @summary: Get sms provider by id
663
- * @description: Get sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
538
+ * @summary: Get SMS provider by ID.
539
+ * @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
664
540
  */
665
541
  getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
666
542
  /**
@@ -671,8 +547,8 @@ declare class Communication {
671
547
  * @param {import("../PlatformAPIClient").Options} - Options
672
548
  * @returns {Promise<Object>} - Success response
673
549
  * @name getSmsProviders
674
- * @summary: Get sms providers
675
- * @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
550
+ * @summary: Get SMS providers.
551
+ * @description: Retrieve a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
676
552
  */
677
553
  getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
678
554
  /**
@@ -683,8 +559,8 @@ declare class Communication {
683
559
  * @param {import("../PlatformAPIClient").Options} - Options
684
560
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
685
561
  * @name getSmsTemplateById
686
- * @summary: Get sms template by id
687
- * @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/).
562
+ * @summary: Get SMS template by ID.
563
+ * @description: Retrieve detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
688
564
  */
689
565
  getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
690
566
  /**
@@ -695,28 +571,10 @@ declare class Communication {
695
571
  * @param {import("../PlatformAPIClient").Options} - Options
696
572
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
697
573
  * @name getSmsTemplates
698
- * @summary: Get sms templates
699
- * @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/).
574
+ * @summary: Get SMS templates.
575
+ * @description: Retrieve a list of available SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
700
576
  */
701
577
  getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
702
- /**
703
- * @param {Object} arg - Arg object.
704
- * @param {string} arg.companyId - Company id
705
- * @param {string} arg.applicationId - Application id
706
- * @param {number} [arg.pageSize] - Current request items count
707
- * @param {Object} [arg.sort] - To sort based on created_at
708
- * @param {Object} [arg.query] - To search based on plain text
709
- * @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
710
- * @summary: Get sms templates
711
- * @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.
712
- */
713
- getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
714
- companyId: string;
715
- applicationId: string;
716
- pageSize?: number;
717
- sort?: any;
718
- query?: any;
719
- }): Paginator<CommunicationPlatformModel.SmsTemplates>;
720
578
  /**
721
579
  * @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
722
580
  * - Arg object
@@ -725,8 +583,8 @@ declare class Communication {
725
583
  * @param {import("../PlatformAPIClient").Options} - Options
726
584
  * @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
727
585
  * @name getStatsOfCampaignById
728
- * @summary: Get stats of campaign by id
729
- * @description: Get stats of campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
586
+ * @summary: Get campaign statistics by ID.
587
+ * @description: Retrieve statistical data for a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
730
588
  */
731
589
  getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
732
590
  /**
@@ -737,26 +595,10 @@ declare class Communication {
737
595
  * @param {import("../PlatformAPIClient").Options} - Options
738
596
  * @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
739
597
  * @name getSubscribedEmailTemplates
740
- * @summary: Get subscribed email templates
741
- * @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/).
598
+ * @summary: Get subscribed email templates.
599
+ * @description: Retrieve email communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
742
600
  */
743
601
  getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
744
- /**
745
- * @param {Object} arg - Arg object.
746
- * @param {string} arg.companyId - Company id
747
- * @param {string} arg.applicationId - Application id
748
- * @param {number} [arg.pageSize] - Current request items count
749
- * @param {Object} [arg.query] - To search based on plain text
750
- * @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
751
- * @summary: Get subscribed email templates
752
- * @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.
753
- */
754
- getSubscribedEmailTemplatesPaginator({ companyId, applicationId, pageSize, query, }?: {
755
- companyId: string;
756
- applicationId: string;
757
- pageSize?: number;
758
- query?: any;
759
- }): Paginator<CommunicationPlatformModel.EmailTemplates>;
760
602
  /**
761
603
  * @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
762
604
  * - Arg object
@@ -765,26 +607,10 @@ declare class Communication {
765
607
  * @param {import("../PlatformAPIClient").Options} - Options
766
608
  * @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
767
609
  * @name getSubscribedSmsTemplates
768
- * @summary: Get subscribed sms templates
769
- * @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/).
610
+ * @summary: Get subscribed SMS templates.
611
+ * @description: Retrieve SMS communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
770
612
  */
771
613
  getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
772
- /**
773
- * @param {Object} arg - Arg object.
774
- * @param {string} arg.companyId - Company id
775
- * @param {string} arg.applicationId - Application id
776
- * @param {number} [arg.pageSize] - Current request items count
777
- * @param {Object} [arg.query] - To search based on plain text
778
- * @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
779
- * @summary: Get subscribed sms templates
780
- * @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.
781
- */
782
- getSubscribedSmsTemplatesPaginator({ companyId, applicationId, pageSize, query, }?: {
783
- companyId: string;
784
- applicationId: string;
785
- pageSize?: number;
786
- query?: any;
787
- }): Paginator<CommunicationPlatformModel.SmsTemplates>;
788
614
  /**
789
615
  * @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
790
616
  * - Arg object
@@ -793,8 +619,8 @@ declare class Communication {
793
619
  * @param {import("../PlatformAPIClient").Options} - Options
794
620
  * @returns {Promise<Object>} - Success response
795
621
  * @name getSystemAudiences
796
- * @summary: Get system audiences
797
- * @description: Get system audiences - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
622
+ * @summary: Get system audiences.
623
+ * @description: Retrieve system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
798
624
  */
799
625
  getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
800
626
  /**
@@ -806,8 +632,8 @@ declare class Communication {
806
632
  * @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
807
633
  * Success response
808
634
  * @name getSystemEmailTemplates
809
- * @summary: Get system email templates
810
- * @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/).
635
+ * @summary: Get system email templates.
636
+ * @description: Retrieve system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
811
637
  */
812
638
  getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
813
639
  /**
@@ -819,8 +645,8 @@ declare class Communication {
819
645
  * @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
820
646
  * Success response
821
647
  * @name getSystemSmsTemplates
822
- * @summary: Get system sms templates
823
- * @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/).
648
+ * @summary: Get system SMS templates.
649
+ * @description: Retrieve system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
824
650
  */
825
651
  getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates[]>;
826
652
  /**
@@ -833,8 +659,8 @@ declare class Communication {
833
659
  * - Success response
834
660
  *
835
661
  * @name postGlobalVariables
836
- * @summary: post global variables
837
- * @description: psot global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
662
+ * @summary: Post global variables.
663
+ * @description: Update and post global variables for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
838
664
  */
839
665
  postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>;
840
666
  /**
@@ -845,8 +671,8 @@ declare class Communication {
845
671
  * @param {import("../PlatformAPIClient").Options} - Options
846
672
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
847
673
  * @name sendCommunicationAsynchronously
848
- * @summary: Send email or sms asynchronously
849
- * @description: Send email or sms asynchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
674
+ * @summary: Send communication asynchronously.
675
+ * @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/).
850
676
  */
851
677
  sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
852
678
  /**
@@ -857,8 +683,8 @@ declare class Communication {
857
683
  * @param {import("../PlatformAPIClient").Options} - Options
858
684
  * @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
859
685
  * @name sendCommunicationSynchronously
860
- * @summary: Send email or sms synchronously
861
- * @description: Send email or sms synchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
686
+ * @summary: Send communication synchronously.
687
+ * @description: Initiate and send communication in real-time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
862
688
  */
863
689
  sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
864
690
  /**
@@ -867,8 +693,8 @@ declare class Communication {
867
693
  * @param {import("../PlatformAPIClient").Options} - Options
868
694
  * @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
869
695
  * @name sendOtp
870
- * @summary: Send OTP using email and sms
871
- * @description: Send OTP Comms via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
696
+ * @summary: Send OTP.
697
+ * @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/).
872
698
  */
873
699
  sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
874
700
  /**
@@ -880,8 +706,8 @@ declare class Communication {
880
706
  * @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
881
707
  * Success response
882
708
  * @name triggerCampaignJob
883
- * @summary: Trigger campaign job
884
- * @description: Trigger campaign job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
709
+ * @summary: Trigger campaign job.
710
+ * @description: Initiate a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
885
711
  */
886
712
  triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResponse>;
887
713
  /**
@@ -892,8 +718,8 @@ declare class Communication {
892
718
  * @param {import("../PlatformAPIClient").Options} - Options
893
719
  * @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
894
720
  * @name updateAppProviders
895
- * @summary: update app providers
896
- * @description: Using this API will update the application providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
721
+ * @summary: Update application providers.
722
+ * @description: Modify provider information for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
897
723
  */
898
724
  updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
899
725
  /**
@@ -904,8 +730,8 @@ declare class Communication {
904
730
  * @param {import("../PlatformAPIClient").Options} - Options
905
731
  * @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
906
732
  * @name updateAudienceById
907
- * @summary: Update audience by id
908
- * @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/).
733
+ * @summary: Update audience by ID.
734
+ * @description: Modify the settings of a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
909
735
  */
910
736
  updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
911
737
  /**
@@ -916,8 +742,8 @@ declare class Communication {
916
742
  * @param {import("../PlatformAPIClient").Options} - Options
917
743
  * @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
918
744
  * @name updateCampaignById
919
- * @summary: Update campaign by id
920
- * @description: Update campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
745
+ * @summary: Update campaign by ID.
746
+ * @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
921
747
  */
922
748
  updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
923
749
  /**
@@ -928,8 +754,8 @@ declare class Communication {
928
754
  * @param {import("../PlatformAPIClient").Options} - Options
929
755
  * @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
930
756
  * @name updateEmailProviderById
931
- * @summary: Update email provider by id
932
- * @description: Update email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
757
+ * @summary: Update email provider by ID.
758
+ * @description: Modify the settings of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
933
759
  */
934
760
  updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
935
761
  /**
@@ -940,8 +766,8 @@ declare class Communication {
940
766
  * @param {import("../PlatformAPIClient").Options} - Options
941
767
  * @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
942
768
  * @name updateEmailTemplateById
943
- * @summary: Update email template by id
944
- * @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/).
769
+ * @summary: Update email template by ID.
770
+ * @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/).
945
771
  */
946
772
  updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
947
773
  /**
@@ -964,8 +790,8 @@ declare class Communication {
964
790
  * @param {import("../PlatformAPIClient").Options} - Options
965
791
  * @returns {Promise<Object>} - Success response
966
792
  * @name updateSmsProviderById
967
- * @summary: Update sms provider by id
968
- * @description: Update sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
793
+ * @summary: Update SMS provider by ID.
794
+ * @description: Modify specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
969
795
  */
970
796
  updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
971
797
  /**
@@ -976,8 +802,8 @@ declare class Communication {
976
802
  * @param {import("../PlatformAPIClient").Options} - Options
977
803
  * @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
978
804
  * @name updateSmsTemplateById
979
- * @summary: Update sms template by id
980
- * @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/).
805
+ * @summary: Update SMS template by ID.
806
+ * @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/).
981
807
  */
982
808
  updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
983
809
  /**
@@ -988,11 +814,10 @@ declare class Communication {
988
814
  * - Success response
989
815
  *
990
816
  * @name verfiyOtp
991
- * @summary: Verify OTP sent via email and sms
992
- * @description: Verify OTP sent via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
817
+ * @summary: Verify OTP.
818
+ * @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/).
993
819
  */
994
820
  verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
995
821
  }
996
822
  import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator");
997
823
  import CommunicationPlatformModel = require("./CommunicationPlatformModel");
998
- import Paginator = require("../../common/Paginator");