@gofynd/fdk-client-javascript 3.3.3 → 3.3.6
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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +57 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +40 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +62 -3
- package/sdk/platform/Cart/CartPlatformModel.js +33 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +89 -82
- package/sdk/platform/Catalog/CatalogPlatformClient.js +121 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +61 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +46 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +21 -4
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9 -9
- package/sdk/platform/Order/OrderPlatformModel.js +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +85 -3
- package/sdk/platform/Payment/PaymentPlatformModel.js +49 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +28 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +59 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +34 -34
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -24,7 +24,7 @@ class Communication {
|
|
|
24
24
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
25
25
|
* @name createAudience
|
|
26
26
|
* @summary: Create an audience
|
|
27
|
-
* @description: Creates a new email audience. - Check out [method documentation](https://
|
|
27
|
+
* @description: Creates a new email audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createAudience/).
|
|
28
28
|
*/
|
|
29
29
|
async createAudience(
|
|
30
30
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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 BigQuery headers - Check out [method documentation](https://
|
|
108
|
+
* @description: Create BigQuery headers - Check out [method documentation](https://docs.fynd.com/partners/commerce/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: Creates big query n count - Check out [method documentation](https://
|
|
183
|
+
* @description: Creates big query n count - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryNCount/).
|
|
184
184
|
*/
|
|
185
185
|
async createBigQueryNCount(
|
|
186
186
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -255,7 +255,7 @@ class Communication {
|
|
|
255
255
|
* @returns {Promise<Object>} - Success response
|
|
256
256
|
* @name createBigQueryRowCount
|
|
257
257
|
* @summary: Create a BigQuery row count
|
|
258
|
-
* @description: Creates big query row count - Check out [method documentation](https://
|
|
258
|
+
* @description: Creates big query row count - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryRowCount/).
|
|
259
259
|
*/
|
|
260
260
|
async createBigQueryRowCount(
|
|
261
261
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -330,7 +330,7 @@ class Communication {
|
|
|
330
330
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
331
331
|
* @name createCampaign
|
|
332
332
|
* @summary: Create a campaign
|
|
333
|
-
* @description: Creates a new communication campaign. - Check out [method documentation](https://
|
|
333
|
+
* @description: Creates a new communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createCampaign/).
|
|
334
334
|
*/
|
|
335
335
|
async createCampaign(
|
|
336
336
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -411,7 +411,7 @@ class Communication {
|
|
|
411
411
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
412
412
|
* @name createEmailProvider
|
|
413
413
|
* @summary: Create an email provider
|
|
414
|
-
* @description: Creates a new email communication provider. - Check out [method documentation](https://
|
|
414
|
+
* @description: Creates a new email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailProvider/).
|
|
415
415
|
*/
|
|
416
416
|
async createEmailProvider(
|
|
417
417
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -492,7 +492,7 @@ class Communication {
|
|
|
492
492
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
493
493
|
* @name createEmailTemplate
|
|
494
494
|
* @summary: Creat an email template
|
|
495
|
-
* @description: Creates a new email communication template. - Check out [method documentation](https://
|
|
495
|
+
* @description: Creates a new email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailTemplate/).
|
|
496
496
|
*/
|
|
497
497
|
async createEmailTemplate(
|
|
498
498
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -575,7 +575,7 @@ class Communication {
|
|
|
575
575
|
*
|
|
576
576
|
* @name createEventSubscriptions
|
|
577
577
|
* @summary: Create an event subscription
|
|
578
|
-
* @description: Creates a new event subscription. - Check out [method documentation](https://
|
|
578
|
+
* @description: Creates a new event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptions/).
|
|
579
579
|
*/
|
|
580
580
|
async createEventSubscriptions(
|
|
581
581
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -660,7 +660,7 @@ class Communication {
|
|
|
660
660
|
*
|
|
661
661
|
* @name createEventSubscriptionsByBulk
|
|
662
662
|
* @summary: Create event subscriptions in bulk
|
|
663
|
-
* @description: Creates a new event subscription in bulk. - Check out [method documentation](https://
|
|
663
|
+
* @description: Creates a new event subscription in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptionsByBulk/).
|
|
664
664
|
*/
|
|
665
665
|
async createEventSubscriptionsByBulk(
|
|
666
666
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -736,7 +736,7 @@ class Communication {
|
|
|
736
736
|
* @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
|
|
737
737
|
* @name createJobs
|
|
738
738
|
* @summary: Create a campaign jobs
|
|
739
|
-
* @description: Creates a new campaign job. - Check out [method documentation](https://
|
|
739
|
+
* @description: Creates a new campaign job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/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: Creates a new SMS communication provider. - Check out [method documentation](https://
|
|
820
|
+
* @description: Creates a new SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsProvider/).
|
|
821
821
|
*/
|
|
822
822
|
async createSmsProvider(
|
|
823
823
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -896,7 +896,7 @@ class Communication {
|
|
|
896
896
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
897
897
|
* @name createSmsTemplate
|
|
898
898
|
* @summary: Create a SMS template
|
|
899
|
-
* @description: Creates a new SMS communication template. - Check out [method documentation](https://
|
|
899
|
+
* @description: Creates a new SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsTemplate/).
|
|
900
900
|
*/
|
|
901
901
|
async createSmsTemplate(
|
|
902
902
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -977,7 +977,7 @@ class Communication {
|
|
|
977
977
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
978
978
|
* @name deleteAudienceById
|
|
979
979
|
* @summary: Delete an audience
|
|
980
|
-
* @description: Remove a specific audience permenantly. - Check out [method documentation](https://
|
|
980
|
+
* @description: Remove a specific audience permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteAudienceById/).
|
|
981
981
|
*/
|
|
982
982
|
async deleteAudienceById(
|
|
983
983
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1060,7 +1060,7 @@ class Communication {
|
|
|
1060
1060
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1061
1061
|
* @name deleteEmailProviderById
|
|
1062
1062
|
* @summary: Delete an email provider
|
|
1063
|
-
* @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://
|
|
1063
|
+
* @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailProviderById/).
|
|
1064
1064
|
*/
|
|
1065
1065
|
async deleteEmailProviderById(
|
|
1066
1066
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1141,7 +1141,7 @@ class Communication {
|
|
|
1141
1141
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1142
1142
|
* @name deleteEmailTemplateById
|
|
1143
1143
|
* @summary: Delete an email template
|
|
1144
|
-
* @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://
|
|
1144
|
+
* @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailTemplateById/).
|
|
1145
1145
|
*/
|
|
1146
1146
|
async deleteEmailTemplateById(
|
|
1147
1147
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1222,7 +1222,7 @@ class Communication {
|
|
|
1222
1222
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1223
1223
|
* @name deleteEventSubscriptionsById
|
|
1224
1224
|
* @summary: Delete an event subscriptions
|
|
1225
|
-
* @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://
|
|
1225
|
+
* @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEventSubscriptionsById/).
|
|
1226
1226
|
*/
|
|
1227
1227
|
async deleteEventSubscriptionsById(
|
|
1228
1228
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1303,7 +1303,7 @@ class Communication {
|
|
|
1303
1303
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1304
1304
|
* @name deleteSmsProviderById
|
|
1305
1305
|
* @summary: Delete an SMS provider
|
|
1306
|
-
* @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://
|
|
1306
|
+
* @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsProviderById/).
|
|
1307
1307
|
*/
|
|
1308
1308
|
async deleteSmsProviderById(
|
|
1309
1309
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1384,7 +1384,7 @@ class Communication {
|
|
|
1384
1384
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1385
1385
|
* @name deleteSmsTemplateById
|
|
1386
1386
|
* @summary: Delete an SMS template
|
|
1387
|
-
* @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://
|
|
1387
|
+
* @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsTemplateById/).
|
|
1388
1388
|
*/
|
|
1389
1389
|
async deleteSmsTemplateById(
|
|
1390
1390
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1467,7 +1467,7 @@ class Communication {
|
|
|
1467
1467
|
*
|
|
1468
1468
|
* @name editEventSubscriptions
|
|
1469
1469
|
* @summary: Update an event subscriptions
|
|
1470
|
-
* @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://
|
|
1470
|
+
* @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/editEventSubscriptions/).
|
|
1471
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 sales channel. - Check out [method documentation](https://
|
|
1553
|
+
* @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAppProviders/).
|
|
1554
1554
|
*/
|
|
1555
1555
|
async getAppProviders(
|
|
1556
1556
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1627,7 +1627,7 @@ class Communication {
|
|
|
1627
1627
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
1628
1628
|
* @name getAudienceById
|
|
1629
1629
|
* @summary: Get an audience
|
|
1630
|
-
* @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://
|
|
1630
|
+
* @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudienceById/).
|
|
1631
1631
|
*/
|
|
1632
1632
|
async getAudienceById(
|
|
1633
1633
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1708,7 +1708,7 @@ class Communication {
|
|
|
1708
1708
|
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
1709
1709
|
* @name getAudiences
|
|
1710
1710
|
* @summary: Get all the audiences
|
|
1711
|
-
* @description: Retrieves a list of all the audiences. - Check out [method documentation](https://
|
|
1711
|
+
* @description: Retrieves a list of all the audiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudiences/).
|
|
1712
1712
|
*/
|
|
1713
1713
|
async getAudiences(
|
|
1714
1714
|
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1799,7 +1799,7 @@ class Communication {
|
|
|
1799
1799
|
* @returns {Promise<Object>} - Success response
|
|
1800
1800
|
* @name getBigQueryHeadersById
|
|
1801
1801
|
* @summary: Get BigQuery headers
|
|
1802
|
-
* @description: Retrieves header information from BigQuery. - Check out [method documentation](https://
|
|
1802
|
+
* @description: Retrieves header information from BigQuery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getBigQueryHeadersById/).
|
|
1803
1803
|
*/
|
|
1804
1804
|
async getBigQueryHeadersById(
|
|
1805
1805
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1878,7 +1878,7 @@ class Communication {
|
|
|
1878
1878
|
* @returns {Promise<Object>} - Success response
|
|
1879
1879
|
* @name getBigQueryRowCountById
|
|
1880
1880
|
* @summary: Get BigQuery row count
|
|
1881
|
-
* @description: Retrieves big query row count by id - Check out [method documentation](https://
|
|
1881
|
+
* @description: Retrieves big query row count by id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getBigQueryRowCountById/).
|
|
1882
1882
|
*/
|
|
1883
1883
|
async getBigQueryRowCountById(
|
|
1884
1884
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1957,7 +1957,7 @@ class Communication {
|
|
|
1957
1957
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
1958
1958
|
* @name getCampaignById
|
|
1959
1959
|
* @summary: Get a campaign
|
|
1960
|
-
* @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://
|
|
1960
|
+
* @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaignById/).
|
|
1961
1961
|
*/
|
|
1962
1962
|
async getCampaignById(
|
|
1963
1963
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2038,7 +2038,7 @@ class Communication {
|
|
|
2038
2038
|
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
2039
2039
|
* @name getCampaigns
|
|
2040
2040
|
* @summary: Get all campaigns
|
|
2041
|
-
* @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://
|
|
2041
|
+
* @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaigns/).
|
|
2042
2042
|
*/
|
|
2043
2043
|
async getCampaigns(
|
|
2044
2044
|
{ query, pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2129,7 +2129,7 @@ class Communication {
|
|
|
2129
2129
|
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
2130
2130
|
* @name getCommunicationLogs
|
|
2131
2131
|
* @summary: Get communication reports
|
|
2132
|
-
* @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://
|
|
2132
|
+
* @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCommunicationLogs/).
|
|
2133
2133
|
*/
|
|
2134
2134
|
async getCommunicationLogs(
|
|
2135
2135
|
{ pageId, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2221,7 +2221,7 @@ class Communication {
|
|
|
2221
2221
|
* Success response
|
|
2222
2222
|
* @name getDefaultSmsProviders
|
|
2223
2223
|
* @summary: Get all default SMS providers
|
|
2224
|
-
* @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://
|
|
2224
|
+
* @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/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. - Check out [method documentation](https://
|
|
2299
|
+
* @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasources/).
|
|
2300
2300
|
*/
|
|
2301
2301
|
async getDummyDatasources(
|
|
2302
2302
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2371,7 +2371,7 @@ class Communication {
|
|
|
2371
2371
|
* Success response
|
|
2372
2372
|
* @name getDummyDatasourcesMeta
|
|
2373
2373
|
* @summary: Get dummy data sources metadata
|
|
2374
|
-
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://
|
|
2374
|
+
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
2375
2375
|
*/
|
|
2376
2376
|
async getDummyDatasourcesMeta(
|
|
2377
2377
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2452,7 +2452,7 @@ class Communication {
|
|
|
2452
2452
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
2453
2453
|
* @name getEmailProviderById
|
|
2454
2454
|
* @summary: Get a email provider
|
|
2455
|
-
* @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://
|
|
2455
|
+
* @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviderById/).
|
|
2456
2456
|
*/
|
|
2457
2457
|
async getEmailProviderById(
|
|
2458
2458
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2533,7 +2533,7 @@ class Communication {
|
|
|
2533
2533
|
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
2534
2534
|
* @name getEmailProviders
|
|
2535
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://
|
|
2536
|
+
* @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviders/).
|
|
2537
2537
|
*/
|
|
2538
2538
|
async getEmailProviders(
|
|
2539
2539
|
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2624,7 +2624,7 @@ class Communication {
|
|
|
2624
2624
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
2625
2625
|
* @name getEmailTemplateById
|
|
2626
2626
|
* @summary: Get an email template
|
|
2627
|
-
* @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://
|
|
2627
|
+
* @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplateById/).
|
|
2628
2628
|
*/
|
|
2629
2629
|
async getEmailTemplateById(
|
|
2630
2630
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2705,7 +2705,7 @@ class Communication {
|
|
|
2705
2705
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
2706
2706
|
* @name getEmailTemplates
|
|
2707
2707
|
* @summary: Get all email templates
|
|
2708
|
-
* @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://
|
|
2708
|
+
* @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplates/).
|
|
2709
2709
|
*/
|
|
2710
2710
|
async getEmailTemplates(
|
|
2711
2711
|
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2797,7 +2797,7 @@ class Communication {
|
|
|
2797
2797
|
* Success response
|
|
2798
2798
|
* @name getEventSubscriptions
|
|
2799
2799
|
* @summary: Get all event subscriptions
|
|
2800
|
-
* @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://
|
|
2800
|
+
* @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptions/).
|
|
2801
2801
|
*/
|
|
2802
2802
|
async getEventSubscriptions(
|
|
2803
2803
|
{ pageNo, pageSize, populate, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2885,7 +2885,7 @@ class Communication {
|
|
|
2885
2885
|
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
2886
2886
|
* @name getEventSubscriptionsById
|
|
2887
2887
|
* @summary: Get an event subscription
|
|
2888
|
-
* @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://
|
|
2888
|
+
* @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/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 associated with the sales channel.. - Check out [method documentation](https://
|
|
2972
|
+
* @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalProviders/).
|
|
2973
2973
|
*/
|
|
2974
2974
|
async getGlobalProviders(
|
|
2975
2975
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3048,7 +3048,7 @@ class Communication {
|
|
|
3048
3048
|
*
|
|
3049
3049
|
* @name getGlobalVariables
|
|
3050
3050
|
* @summary: Get all global variables
|
|
3051
|
-
* @description: Retrieves a list of communication global variables. - Check out [method documentation](https://
|
|
3051
|
+
* @description: Retrieves a list of communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalVariables/).
|
|
3052
3052
|
*/
|
|
3053
3053
|
async getGlobalVariables(
|
|
3054
3054
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3123,7 +3123,7 @@ class Communication {
|
|
|
3123
3123
|
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
3124
3124
|
* @name getJobLogs
|
|
3125
3125
|
* @summary: Get logs of all campaign job
|
|
3126
|
-
* @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://
|
|
3126
|
+
* @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobLogs/).
|
|
3127
3127
|
*/
|
|
3128
3128
|
async getJobLogs(
|
|
3129
3129
|
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3212,7 +3212,7 @@ class Communication {
|
|
|
3212
3212
|
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
3213
3213
|
* @name getJobs
|
|
3214
3214
|
* @summary: Get all campaign jobs
|
|
3215
|
-
* @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://
|
|
3215
|
+
* @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobs/).
|
|
3216
3216
|
*/
|
|
3217
3217
|
async getJobs(
|
|
3218
3218
|
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3303,7 +3303,7 @@ class Communication {
|
|
|
3303
3303
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
3304
3304
|
* @name getNSampleRecordsFromCsv
|
|
3305
3305
|
* @summary: Get N sample records of a CSV
|
|
3306
|
-
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://
|
|
3306
|
+
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsv/).
|
|
3307
3307
|
*/
|
|
3308
3308
|
async getNSampleRecordsFromCsv(
|
|
3309
3309
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3384,7 +3384,7 @@ class Communication {
|
|
|
3384
3384
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
3385
3385
|
* @name getNSampleRecordsFromCsvByGet
|
|
3386
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://
|
|
3387
|
+
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
3388
3388
|
*/
|
|
3389
3389
|
async getNSampleRecordsFromCsvByGet(
|
|
3390
3390
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3461,7 +3461,7 @@ class Communication {
|
|
|
3461
3461
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
3462
3462
|
* @name getOtpConfiguration
|
|
3463
3463
|
* @summary: Get configuration of otp
|
|
3464
|
-
* @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://
|
|
3464
|
+
* @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getOtpConfiguration/).
|
|
3465
3465
|
*/
|
|
3466
3466
|
async getOtpConfiguration(
|
|
3467
3467
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3538,7 +3538,7 @@ class Communication {
|
|
|
3538
3538
|
* @returns {Promise<Object>} - Success response
|
|
3539
3539
|
* @name getSmsProviderById
|
|
3540
3540
|
* @summary: Get a SMS provider
|
|
3541
|
-
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://
|
|
3541
|
+
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviderById/).
|
|
3542
3542
|
*/
|
|
3543
3543
|
async getSmsProviderById(
|
|
3544
3544
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3617,7 +3617,7 @@ class Communication {
|
|
|
3617
3617
|
* @returns {Promise<Object>} - Success response
|
|
3618
3618
|
* @name getSmsProviders
|
|
3619
3619
|
* @summary: Get all SMS providers
|
|
3620
|
-
* @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://
|
|
3620
|
+
* @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviders/).
|
|
3621
3621
|
*/
|
|
3622
3622
|
async getSmsProviders(
|
|
3623
3623
|
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3706,7 +3706,7 @@ class Communication {
|
|
|
3706
3706
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
3707
3707
|
* @name getSmsTemplateById
|
|
3708
3708
|
* @summary: Get a SMS template
|
|
3709
|
-
* @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://
|
|
3709
|
+
* @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplateById/).
|
|
3710
3710
|
*/
|
|
3711
3711
|
async getSmsTemplateById(
|
|
3712
3712
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3787,7 +3787,7 @@ class Communication {
|
|
|
3787
3787
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
3788
3788
|
* @name getSmsTemplates
|
|
3789
3789
|
* @summary: Get all SMS templates
|
|
3790
|
-
* @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://
|
|
3790
|
+
* @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplates/).
|
|
3791
3791
|
*/
|
|
3792
3792
|
async getSmsTemplates(
|
|
3793
3793
|
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3878,7 +3878,7 @@ class Communication {
|
|
|
3878
3878
|
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
3879
3879
|
* @name getStatsOfCampaignById
|
|
3880
3880
|
* @summary: Get campaign statistics
|
|
3881
|
-
* @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://
|
|
3881
|
+
* @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getStatsOfCampaignById/).
|
|
3882
3882
|
*/
|
|
3883
3883
|
async getStatsOfCampaignById(
|
|
3884
3884
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3959,7 +3959,7 @@ class Communication {
|
|
|
3959
3959
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
3960
3960
|
* @name getSubscribedEmailTemplates
|
|
3961
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://
|
|
3962
|
+
* @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
3963
3963
|
*/
|
|
3964
3964
|
async getSubscribedEmailTemplates(
|
|
3965
3965
|
{ pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4047,7 +4047,7 @@ class Communication {
|
|
|
4047
4047
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
4048
4048
|
* @name getSubscribedSmsTemplates
|
|
4049
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://
|
|
4050
|
+
* @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
4051
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: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://
|
|
4138
|
+
* @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemAudiences/).
|
|
4139
4139
|
*/
|
|
4140
4140
|
async getSystemAudiences(
|
|
4141
4141
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4211,7 +4211,7 @@ class Communication {
|
|
|
4211
4211
|
* Success response
|
|
4212
4212
|
* @name getSystemEmailTemplates
|
|
4213
4213
|
* @summary: Get all system email templates
|
|
4214
|
-
* @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://
|
|
4214
|
+
* @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemEmailTemplates/).
|
|
4215
4215
|
*/
|
|
4216
4216
|
async getSystemEmailTemplates(
|
|
4217
4217
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4289,7 +4289,7 @@ class Communication {
|
|
|
4289
4289
|
* Success response
|
|
4290
4290
|
* @name getSystemSmsTemplates
|
|
4291
4291
|
* @summary: Gets all system SMS templates
|
|
4292
|
-
* @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://
|
|
4292
|
+
* @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemSmsTemplates/).
|
|
4293
4293
|
*/
|
|
4294
4294
|
async getSystemSmsTemplates(
|
|
4295
4295
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4368,7 +4368,7 @@ class Communication {
|
|
|
4368
4368
|
*
|
|
4369
4369
|
* @name postGlobalVariables
|
|
4370
4370
|
* @summary: Create global variables
|
|
4371
|
-
* @description: Updates and creates communication global variables. - Check out [method documentation](https://
|
|
4371
|
+
* @description: Updates and creates communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/postGlobalVariables/).
|
|
4372
4372
|
*/
|
|
4373
4373
|
async postGlobalVariables(
|
|
4374
4374
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4449,7 +4449,7 @@ class Communication {
|
|
|
4449
4449
|
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
4450
4450
|
* @name sendCommunicationAsynchronously
|
|
4451
4451
|
* @summary: Send communication asynchronously
|
|
4452
|
-
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://
|
|
4452
|
+
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
4453
4453
|
*/
|
|
4454
4454
|
async sendCommunicationAsynchronously(
|
|
4455
4455
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4530,7 +4530,7 @@ class Communication {
|
|
|
4530
4530
|
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
4531
4531
|
* @name sendCommunicationSynchronously
|
|
4532
4532
|
* @summary: Send communication synchronously
|
|
4533
|
-
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://
|
|
4533
|
+
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
4534
4534
|
*/
|
|
4535
4535
|
async sendCommunicationSynchronously(
|
|
4536
4536
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4609,7 +4609,7 @@ class Communication {
|
|
|
4609
4609
|
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
4610
4610
|
* @name sendOtp
|
|
4611
4611
|
* @summary: Send OTP
|
|
4612
|
-
* @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://
|
|
4612
|
+
* @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendOtp/).
|
|
4613
4613
|
*/
|
|
4614
4614
|
async sendOtp(
|
|
4615
4615
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4690,7 +4690,7 @@ class Communication {
|
|
|
4690
4690
|
* @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
|
|
4691
4691
|
* @name triggerCampaignJob
|
|
4692
4692
|
* @summary: Trigger a campaign job
|
|
4693
|
-
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://
|
|
4693
|
+
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/triggerCampaignJob/).
|
|
4694
4694
|
*/
|
|
4695
4695
|
async triggerCampaignJob(
|
|
4696
4696
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4771,7 +4771,7 @@ class Communication {
|
|
|
4771
4771
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
4772
4772
|
* @name updateAppProviders
|
|
4773
4773
|
* @summary: Update application providers
|
|
4774
|
-
* @description: Modify provider configuration using provider object id . - Check out [method documentation](https://
|
|
4774
|
+
* @description: Modify provider configuration using provider object id . - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAppProviders/).
|
|
4775
4775
|
*/
|
|
4776
4776
|
async updateAppProviders(
|
|
4777
4777
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4852,7 +4852,7 @@ class Communication {
|
|
|
4852
4852
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
4853
4853
|
* @name updateAudienceById
|
|
4854
4854
|
* @summary: Update an audience
|
|
4855
|
-
* @description: Modify the configuration of a specific audience. - Check out [method documentation](https://
|
|
4855
|
+
* @description: Modify the configuration of a specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAudienceById/).
|
|
4856
4856
|
*/
|
|
4857
4857
|
async updateAudienceById(
|
|
4858
4858
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4935,7 +4935,7 @@ class Communication {
|
|
|
4935
4935
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
4936
4936
|
* @name updateCampaignById
|
|
4937
4937
|
* @summary: Update a campaign
|
|
4938
|
-
* @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://
|
|
4938
|
+
* @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateCampaignById/).
|
|
4939
4939
|
*/
|
|
4940
4940
|
async updateCampaignById(
|
|
4941
4941
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5018,7 +5018,7 @@ class Communication {
|
|
|
5018
5018
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
5019
5019
|
* @name updateEmailProviderById
|
|
5020
5020
|
* @summary: Update email provider
|
|
5021
|
-
* @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://
|
|
5021
|
+
* @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailProviderById/).
|
|
5022
5022
|
*/
|
|
5023
5023
|
async updateEmailProviderById(
|
|
5024
5024
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5101,7 +5101,7 @@ class Communication {
|
|
|
5101
5101
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
5102
5102
|
* @name updateEmailTemplateById
|
|
5103
5103
|
* @summary: Update an email template
|
|
5104
|
-
* @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://
|
|
5104
|
+
* @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailTemplateById/).
|
|
5105
5105
|
*/
|
|
5106
5106
|
async updateEmailTemplateById(
|
|
5107
5107
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5184,7 +5184,7 @@ class Communication {
|
|
|
5184
5184
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
5185
5185
|
* @name updateOtpConfiguration
|
|
5186
5186
|
* @summary: Update configuration of otp
|
|
5187
|
-
* @description: Updates all configurations related to OTP. - Check out [method documentation](https://
|
|
5187
|
+
* @description: Updates all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateOtpConfiguration/).
|
|
5188
5188
|
*/
|
|
5189
5189
|
async updateOtpConfiguration(
|
|
5190
5190
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -5261,7 +5261,7 @@ class Communication {
|
|
|
5261
5261
|
* @returns {Promise<Object>} - Success response
|
|
5262
5262
|
* @name updateSmsProviderById
|
|
5263
5263
|
* @summary: Update SMS provider
|
|
5264
|
-
* @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://
|
|
5264
|
+
* @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsProviderById/).
|
|
5265
5265
|
*/
|
|
5266
5266
|
async updateSmsProviderById(
|
|
5267
5267
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5342,7 +5342,7 @@ class Communication {
|
|
|
5342
5342
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
5343
5343
|
* @name updateSmsTemplateById
|
|
5344
5344
|
* @summary: Update a SMS template
|
|
5345
|
-
* @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://
|
|
5345
|
+
* @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsTemplateById/).
|
|
5346
5346
|
*/
|
|
5347
5347
|
async updateSmsTemplateById(
|
|
5348
5348
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5425,7 +5425,7 @@ class Communication {
|
|
|
5425
5425
|
*
|
|
5426
5426
|
* @name verfiyOtp
|
|
5427
5427
|
* @summary: Verify OTP
|
|
5428
|
-
* @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://
|
|
5428
|
+
* @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/verfiyOtp/).
|
|
5429
5429
|
*/
|
|
5430
5430
|
async verfiyOtp(
|
|
5431
5431
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -12,7 +12,7 @@ declare class Communication {
|
|
|
12
12
|
* Success response
|
|
13
13
|
* @name getSystemNotifications
|
|
14
14
|
* @summary: Get system notifications
|
|
15
|
-
* @description: Retrieves a list of system notifications. - Check out [method documentation](https://
|
|
15
|
+
* @description: Retrieves a list of system notifications. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemNotifications/).
|
|
16
16
|
*/
|
|
17
17
|
getSystemNotifications({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemNotifications>;
|
|
18
18
|
}
|
|
@@ -24,7 +24,7 @@ class Communication {
|
|
|
24
24
|
* Success response
|
|
25
25
|
* @name getSystemNotifications
|
|
26
26
|
* @summary: Get system notifications
|
|
27
|
-
* @description: Retrieves a list of system notifications. - Check out [method documentation](https://
|
|
27
|
+
* @description: Retrieves a list of system notifications. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemNotifications/).
|
|
28
28
|
*/
|
|
29
29
|
async getSystemNotifications(
|
|
30
30
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|