@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1
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 +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +3 -15
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -14
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3641 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +351 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +410 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2011 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1100 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1362 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +247 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +319 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +18 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +20 -18
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -561,6 +561,250 @@ class Communication {
|
|
|
561
561
|
return response;
|
|
562
562
|
}
|
|
563
563
|
|
|
564
|
+
/**
|
|
565
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam} arg
|
|
566
|
+
* - Arg object
|
|
567
|
+
*
|
|
568
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
569
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
570
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
|
|
571
|
+
* - Success response
|
|
572
|
+
*
|
|
573
|
+
* @name createEventSubscriptions
|
|
574
|
+
* @summary: Create event subscriptions
|
|
575
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
|
|
576
|
+
*/
|
|
577
|
+
async createEventSubscriptions(
|
|
578
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
579
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
580
|
+
) {
|
|
581
|
+
const {
|
|
582
|
+
error,
|
|
583
|
+
} = CommunicationPlatformApplicationValidator.createEventSubscriptions().validate(
|
|
584
|
+
{
|
|
585
|
+
body,
|
|
586
|
+
},
|
|
587
|
+
{ abortEarly: false, allowUnknown: true }
|
|
588
|
+
);
|
|
589
|
+
if (error) {
|
|
590
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
591
|
+
}
|
|
592
|
+
|
|
593
|
+
// Showing warrnings if extra unknown parameters are found
|
|
594
|
+
const {
|
|
595
|
+
error: warrning,
|
|
596
|
+
} = CommunicationPlatformApplicationValidator.createEventSubscriptions().validate(
|
|
597
|
+
{
|
|
598
|
+
body,
|
|
599
|
+
},
|
|
600
|
+
{ abortEarly: false, allowUnknown: false }
|
|
601
|
+
);
|
|
602
|
+
if (warrning) {
|
|
603
|
+
Logger({
|
|
604
|
+
level: "WARN",
|
|
605
|
+
message: `Parameter Validation warrnings for platform > Communication > createEventSubscriptions \n ${warrning}`,
|
|
606
|
+
});
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
const query_params = {};
|
|
610
|
+
|
|
611
|
+
const response = await PlatformAPIClient.execute(
|
|
612
|
+
this.config,
|
|
613
|
+
"post",
|
|
614
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/event/event-subscriptions`,
|
|
615
|
+
query_params,
|
|
616
|
+
body,
|
|
617
|
+
requestHeaders,
|
|
618
|
+
{ responseHeaders }
|
|
619
|
+
);
|
|
620
|
+
|
|
621
|
+
let responseData = response;
|
|
622
|
+
if (responseHeaders) {
|
|
623
|
+
responseData = response[0];
|
|
624
|
+
}
|
|
625
|
+
|
|
626
|
+
const {
|
|
627
|
+
error: res_error,
|
|
628
|
+
} = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse().validate(
|
|
629
|
+
responseData,
|
|
630
|
+
{ abortEarly: false, allowUnknown: true }
|
|
631
|
+
);
|
|
632
|
+
|
|
633
|
+
if (res_error) {
|
|
634
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
635
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
636
|
+
} else {
|
|
637
|
+
Logger({
|
|
638
|
+
level: "WARN",
|
|
639
|
+
message: `Response Validation Warnings for platform > Communication > createEventSubscriptions \n ${res_error}`,
|
|
640
|
+
});
|
|
641
|
+
}
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
return response;
|
|
645
|
+
}
|
|
646
|
+
|
|
647
|
+
/**
|
|
648
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg
|
|
649
|
+
* - Arg object
|
|
650
|
+
*
|
|
651
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
652
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
653
|
+
* @returns {Promise<
|
|
654
|
+
* CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]
|
|
655
|
+
* >}
|
|
656
|
+
* - Success response
|
|
657
|
+
*
|
|
658
|
+
* @name createEventSubscriptionsByBulk
|
|
659
|
+
* @summary: Create event subscriptions by bulk
|
|
660
|
+
* @description: Create event subscriptions by bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
|
|
661
|
+
*/
|
|
662
|
+
async createEventSubscriptionsByBulk(
|
|
663
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
664
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
665
|
+
) {
|
|
666
|
+
const {
|
|
667
|
+
error,
|
|
668
|
+
} = CommunicationPlatformApplicationValidator.createEventSubscriptionsByBulk().validate(
|
|
669
|
+
{
|
|
670
|
+
body,
|
|
671
|
+
},
|
|
672
|
+
{ abortEarly: false, allowUnknown: true }
|
|
673
|
+
);
|
|
674
|
+
if (error) {
|
|
675
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
676
|
+
}
|
|
677
|
+
|
|
678
|
+
// Showing warrnings if extra unknown parameters are found
|
|
679
|
+
const {
|
|
680
|
+
error: warrning,
|
|
681
|
+
} = CommunicationPlatformApplicationValidator.createEventSubscriptionsByBulk().validate(
|
|
682
|
+
{
|
|
683
|
+
body,
|
|
684
|
+
},
|
|
685
|
+
{ abortEarly: false, allowUnknown: false }
|
|
686
|
+
);
|
|
687
|
+
if (warrning) {
|
|
688
|
+
Logger({
|
|
689
|
+
level: "WARN",
|
|
690
|
+
message: `Parameter Validation warrnings for platform > Communication > createEventSubscriptionsByBulk \n ${warrning}`,
|
|
691
|
+
});
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
const query_params = {};
|
|
695
|
+
|
|
696
|
+
const response = await PlatformAPIClient.execute(
|
|
697
|
+
this.config,
|
|
698
|
+
"post",
|
|
699
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/event/event-subscriptions/bulkUpdate`,
|
|
700
|
+
query_params,
|
|
701
|
+
body,
|
|
702
|
+
requestHeaders,
|
|
703
|
+
{ responseHeaders }
|
|
704
|
+
);
|
|
705
|
+
|
|
706
|
+
let responseData = response;
|
|
707
|
+
if (responseHeaders) {
|
|
708
|
+
responseData = response[0];
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
const { error: res_error } = Joi.array()
|
|
712
|
+
.items(CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse())
|
|
713
|
+
.validate(responseData, { abortEarly: false, allowUnknown: true });
|
|
714
|
+
|
|
715
|
+
if (res_error) {
|
|
716
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
717
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
718
|
+
} else {
|
|
719
|
+
Logger({
|
|
720
|
+
level: "WARN",
|
|
721
|
+
message: `Response Validation Warnings for platform > Communication > createEventSubscriptionsByBulk \n ${res_error}`,
|
|
722
|
+
});
|
|
723
|
+
}
|
|
724
|
+
}
|
|
725
|
+
|
|
726
|
+
return response;
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
/**
|
|
730
|
+
* @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object
|
|
731
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
732
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
733
|
+
* @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
|
|
734
|
+
* @name createJobs
|
|
735
|
+
* @summary: Create jobs
|
|
736
|
+
* @description: Create jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createJobs/).
|
|
737
|
+
*/
|
|
738
|
+
async createJobs(
|
|
739
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
740
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
741
|
+
) {
|
|
742
|
+
const {
|
|
743
|
+
error,
|
|
744
|
+
} = CommunicationPlatformApplicationValidator.createJobs().validate(
|
|
745
|
+
{
|
|
746
|
+
body,
|
|
747
|
+
},
|
|
748
|
+
{ abortEarly: false, allowUnknown: true }
|
|
749
|
+
);
|
|
750
|
+
if (error) {
|
|
751
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
// Showing warrnings if extra unknown parameters are found
|
|
755
|
+
const {
|
|
756
|
+
error: warrning,
|
|
757
|
+
} = CommunicationPlatformApplicationValidator.createJobs().validate(
|
|
758
|
+
{
|
|
759
|
+
body,
|
|
760
|
+
},
|
|
761
|
+
{ abortEarly: false, allowUnknown: false }
|
|
762
|
+
);
|
|
763
|
+
if (warrning) {
|
|
764
|
+
Logger({
|
|
765
|
+
level: "WARN",
|
|
766
|
+
message: `Parameter Validation warrnings for platform > Communication > createJobs \n ${warrning}`,
|
|
767
|
+
});
|
|
768
|
+
}
|
|
769
|
+
|
|
770
|
+
const query_params = {};
|
|
771
|
+
|
|
772
|
+
const response = await PlatformAPIClient.execute(
|
|
773
|
+
this.config,
|
|
774
|
+
"post",
|
|
775
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/jobs/jobs`,
|
|
776
|
+
query_params,
|
|
777
|
+
body,
|
|
778
|
+
requestHeaders,
|
|
779
|
+
{ responseHeaders }
|
|
780
|
+
);
|
|
781
|
+
|
|
782
|
+
let responseData = response;
|
|
783
|
+
if (responseHeaders) {
|
|
784
|
+
responseData = response[0];
|
|
785
|
+
}
|
|
786
|
+
|
|
787
|
+
const {
|
|
788
|
+
error: res_error,
|
|
789
|
+
} = CommunicationPlatformModel.CreateJobsRes().validate(responseData, {
|
|
790
|
+
abortEarly: false,
|
|
791
|
+
allowUnknown: true,
|
|
792
|
+
});
|
|
793
|
+
|
|
794
|
+
if (res_error) {
|
|
795
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
796
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
797
|
+
} else {
|
|
798
|
+
Logger({
|
|
799
|
+
level: "WARN",
|
|
800
|
+
message: `Response Validation Warnings for platform > Communication > createJobs \n ${res_error}`,
|
|
801
|
+
});
|
|
802
|
+
}
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
return response;
|
|
806
|
+
}
|
|
807
|
+
|
|
564
808
|
/**
|
|
565
809
|
* @param {CommunicationPlatformApplicationValidator.CreateSmsProviderParam} arg
|
|
566
810
|
* - Arg object
|
|
@@ -727,13 +971,13 @@ class Communication {
|
|
|
727
971
|
*
|
|
728
972
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
729
973
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
730
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
974
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
731
975
|
* @name deleteAudienceById
|
|
732
976
|
* @summary: Delete audience by id
|
|
733
977
|
* @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/).
|
|
734
978
|
*/
|
|
735
979
|
async deleteAudienceById(
|
|
736
|
-
{ id, requestHeaders } = { requestHeaders: {} },
|
|
980
|
+
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
737
981
|
{ responseHeaders } = { responseHeaders: false }
|
|
738
982
|
) {
|
|
739
983
|
const {
|
|
@@ -741,6 +985,7 @@ class Communication {
|
|
|
741
985
|
} = CommunicationPlatformApplicationValidator.deleteAudienceById().validate(
|
|
742
986
|
{
|
|
743
987
|
id,
|
|
988
|
+
body,
|
|
744
989
|
},
|
|
745
990
|
{ abortEarly: false, allowUnknown: true }
|
|
746
991
|
);
|
|
@@ -754,6 +999,7 @@ class Communication {
|
|
|
754
999
|
} = CommunicationPlatformApplicationValidator.deleteAudienceById().validate(
|
|
755
1000
|
{
|
|
756
1001
|
id,
|
|
1002
|
+
body,
|
|
757
1003
|
},
|
|
758
1004
|
{ abortEarly: false, allowUnknown: false }
|
|
759
1005
|
);
|
|
@@ -771,7 +1017,7 @@ class Communication {
|
|
|
771
1017
|
"delete",
|
|
772
1018
|
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/datasources/${id}`,
|
|
773
1019
|
query_params,
|
|
774
|
-
|
|
1020
|
+
body,
|
|
775
1021
|
requestHeaders,
|
|
776
1022
|
{ responseHeaders }
|
|
777
1023
|
);
|
|
@@ -783,7 +1029,7 @@ class Communication {
|
|
|
783
1029
|
|
|
784
1030
|
const {
|
|
785
1031
|
error: res_error,
|
|
786
|
-
} = CommunicationPlatformModel.
|
|
1032
|
+
} = CommunicationPlatformModel.Audience().validate(responseData, {
|
|
787
1033
|
abortEarly: false,
|
|
788
1034
|
allowUnknown: true,
|
|
789
1035
|
});
|
|
@@ -964,6 +1210,87 @@ class Communication {
|
|
|
964
1210
|
return response;
|
|
965
1211
|
}
|
|
966
1212
|
|
|
1213
|
+
/**
|
|
1214
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam} arg
|
|
1215
|
+
* - Arg object
|
|
1216
|
+
*
|
|
1217
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1218
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1219
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1220
|
+
* @name deleteEventSubscriptionsById
|
|
1221
|
+
* @summary: Create event subscriptions
|
|
1222
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEventSubscriptionsById/).
|
|
1223
|
+
*/
|
|
1224
|
+
async deleteEventSubscriptionsById(
|
|
1225
|
+
{ id, requestHeaders } = { requestHeaders: {} },
|
|
1226
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1227
|
+
) {
|
|
1228
|
+
const {
|
|
1229
|
+
error,
|
|
1230
|
+
} = CommunicationPlatformApplicationValidator.deleteEventSubscriptionsById().validate(
|
|
1231
|
+
{
|
|
1232
|
+
id,
|
|
1233
|
+
},
|
|
1234
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1235
|
+
);
|
|
1236
|
+
if (error) {
|
|
1237
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1238
|
+
}
|
|
1239
|
+
|
|
1240
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1241
|
+
const {
|
|
1242
|
+
error: warrning,
|
|
1243
|
+
} = CommunicationPlatformApplicationValidator.deleteEventSubscriptionsById().validate(
|
|
1244
|
+
{
|
|
1245
|
+
id,
|
|
1246
|
+
},
|
|
1247
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1248
|
+
);
|
|
1249
|
+
if (warrning) {
|
|
1250
|
+
Logger({
|
|
1251
|
+
level: "WARN",
|
|
1252
|
+
message: `Parameter Validation warrnings for platform > Communication > deleteEventSubscriptionsById \n ${warrning}`,
|
|
1253
|
+
});
|
|
1254
|
+
}
|
|
1255
|
+
|
|
1256
|
+
const query_params = {};
|
|
1257
|
+
|
|
1258
|
+
const response = await PlatformAPIClient.execute(
|
|
1259
|
+
this.config,
|
|
1260
|
+
"delete",
|
|
1261
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/event/event-subscriptions/${id}`,
|
|
1262
|
+
query_params,
|
|
1263
|
+
undefined,
|
|
1264
|
+
requestHeaders,
|
|
1265
|
+
{ responseHeaders }
|
|
1266
|
+
);
|
|
1267
|
+
|
|
1268
|
+
let responseData = response;
|
|
1269
|
+
if (responseHeaders) {
|
|
1270
|
+
responseData = response[0];
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
const {
|
|
1274
|
+
error: res_error,
|
|
1275
|
+
} = CommunicationPlatformModel.GenericDelete().validate(responseData, {
|
|
1276
|
+
abortEarly: false,
|
|
1277
|
+
allowUnknown: true,
|
|
1278
|
+
});
|
|
1279
|
+
|
|
1280
|
+
if (res_error) {
|
|
1281
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1282
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1283
|
+
} else {
|
|
1284
|
+
Logger({
|
|
1285
|
+
level: "WARN",
|
|
1286
|
+
message: `Response Validation Warnings for platform > Communication > deleteEventSubscriptionsById \n ${res_error}`,
|
|
1287
|
+
});
|
|
1288
|
+
}
|
|
1289
|
+
}
|
|
1290
|
+
|
|
1291
|
+
return response;
|
|
1292
|
+
}
|
|
1293
|
+
|
|
967
1294
|
/**
|
|
968
1295
|
* @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
|
|
969
1296
|
* - Arg object
|
|
@@ -1126,6 +1453,91 @@ class Communication {
|
|
|
1126
1453
|
return response;
|
|
1127
1454
|
}
|
|
1128
1455
|
|
|
1456
|
+
/**
|
|
1457
|
+
* @param {CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam} arg
|
|
1458
|
+
* - Arg object
|
|
1459
|
+
*
|
|
1460
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1461
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1462
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
|
|
1463
|
+
* - Success response
|
|
1464
|
+
*
|
|
1465
|
+
* @name editEventSubscriptions
|
|
1466
|
+
* @summary: Create event subscriptions
|
|
1467
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/editEventSubscriptions/).
|
|
1468
|
+
*/
|
|
1469
|
+
async editEventSubscriptions(
|
|
1470
|
+
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
1471
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1472
|
+
) {
|
|
1473
|
+
const {
|
|
1474
|
+
error,
|
|
1475
|
+
} = CommunicationPlatformApplicationValidator.editEventSubscriptions().validate(
|
|
1476
|
+
{
|
|
1477
|
+
id,
|
|
1478
|
+
body,
|
|
1479
|
+
},
|
|
1480
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1481
|
+
);
|
|
1482
|
+
if (error) {
|
|
1483
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1484
|
+
}
|
|
1485
|
+
|
|
1486
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1487
|
+
const {
|
|
1488
|
+
error: warrning,
|
|
1489
|
+
} = CommunicationPlatformApplicationValidator.editEventSubscriptions().validate(
|
|
1490
|
+
{
|
|
1491
|
+
id,
|
|
1492
|
+
body,
|
|
1493
|
+
},
|
|
1494
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1495
|
+
);
|
|
1496
|
+
if (warrning) {
|
|
1497
|
+
Logger({
|
|
1498
|
+
level: "WARN",
|
|
1499
|
+
message: `Parameter Validation warrnings for platform > Communication > editEventSubscriptions \n ${warrning}`,
|
|
1500
|
+
});
|
|
1501
|
+
}
|
|
1502
|
+
|
|
1503
|
+
const query_params = {};
|
|
1504
|
+
|
|
1505
|
+
const response = await PlatformAPIClient.execute(
|
|
1506
|
+
this.config,
|
|
1507
|
+
"put",
|
|
1508
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/event/event-subscriptions/${id}`,
|
|
1509
|
+
query_params,
|
|
1510
|
+
body,
|
|
1511
|
+
requestHeaders,
|
|
1512
|
+
{ responseHeaders }
|
|
1513
|
+
);
|
|
1514
|
+
|
|
1515
|
+
let responseData = response;
|
|
1516
|
+
if (responseHeaders) {
|
|
1517
|
+
responseData = response[0];
|
|
1518
|
+
}
|
|
1519
|
+
|
|
1520
|
+
const {
|
|
1521
|
+
error: res_error,
|
|
1522
|
+
} = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse().validate(
|
|
1523
|
+
responseData,
|
|
1524
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1525
|
+
);
|
|
1526
|
+
|
|
1527
|
+
if (res_error) {
|
|
1528
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1529
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1530
|
+
} else {
|
|
1531
|
+
Logger({
|
|
1532
|
+
level: "WARN",
|
|
1533
|
+
message: `Response Validation Warnings for platform > Communication > editEventSubscriptions \n ${res_error}`,
|
|
1534
|
+
});
|
|
1535
|
+
}
|
|
1536
|
+
}
|
|
1537
|
+
|
|
1538
|
+
return response;
|
|
1539
|
+
}
|
|
1540
|
+
|
|
1129
1541
|
/**
|
|
1130
1542
|
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
1131
1543
|
* - Arg object
|
|
@@ -1296,7 +1708,7 @@ class Communication {
|
|
|
1296
1708
|
* @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/).
|
|
1297
1709
|
*/
|
|
1298
1710
|
async getAudiences(
|
|
1299
|
-
{ pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
1711
|
+
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
1300
1712
|
{ responseHeaders } = { responseHeaders: false }
|
|
1301
1713
|
) {
|
|
1302
1714
|
const {
|
|
@@ -1306,6 +1718,7 @@ class Communication {
|
|
|
1306
1718
|
pageNo,
|
|
1307
1719
|
pageSize,
|
|
1308
1720
|
sort,
|
|
1721
|
+
query,
|
|
1309
1722
|
},
|
|
1310
1723
|
{ abortEarly: false, allowUnknown: true }
|
|
1311
1724
|
);
|
|
@@ -1321,6 +1734,7 @@ class Communication {
|
|
|
1321
1734
|
pageNo,
|
|
1322
1735
|
pageSize,
|
|
1323
1736
|
sort,
|
|
1737
|
+
query,
|
|
1324
1738
|
},
|
|
1325
1739
|
{ abortEarly: false, allowUnknown: false }
|
|
1326
1740
|
);
|
|
@@ -1335,6 +1749,7 @@ class Communication {
|
|
|
1335
1749
|
query_params["page_no"] = pageNo;
|
|
1336
1750
|
query_params["page_size"] = pageSize;
|
|
1337
1751
|
query_params["sort"] = sort;
|
|
1752
|
+
query_params["query"] = query;
|
|
1338
1753
|
|
|
1339
1754
|
const response = await PlatformAPIClient.execute(
|
|
1340
1755
|
this.config,
|
|
@@ -1378,11 +1793,18 @@ class Communication {
|
|
|
1378
1793
|
* @param {string} arg.applicationId - Application id
|
|
1379
1794
|
* @param {number} [arg.pageSize] - Current request items count
|
|
1380
1795
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
1796
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
1381
1797
|
* @returns {Paginator<CommunicationPlatformModel.Audiences>}
|
|
1382
1798
|
* @summary: Get audiences
|
|
1383
1799
|
* @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.
|
|
1384
1800
|
*/
|
|
1385
|
-
getAudiencesPaginator({
|
|
1801
|
+
getAudiencesPaginator({
|
|
1802
|
+
companyId,
|
|
1803
|
+
applicationId,
|
|
1804
|
+
pageSize,
|
|
1805
|
+
sort,
|
|
1806
|
+
query,
|
|
1807
|
+
} = {}) {
|
|
1386
1808
|
const paginator = new Paginator();
|
|
1387
1809
|
const callback = async () => {
|
|
1388
1810
|
const pageId = paginator.nextId;
|
|
@@ -1394,6 +1816,7 @@ class Communication {
|
|
|
1394
1816
|
pageNo: pageNo,
|
|
1395
1817
|
pageSize: pageSize,
|
|
1396
1818
|
sort: sort,
|
|
1819
|
+
query: query,
|
|
1397
1820
|
});
|
|
1398
1821
|
paginator.setPaginator({
|
|
1399
1822
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -1656,13 +2079,14 @@ class Communication {
|
|
|
1656
2079
|
* @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
1657
2080
|
*/
|
|
1658
2081
|
async getCampaigns(
|
|
1659
|
-
{ pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
2082
|
+
{ query, pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
1660
2083
|
{ responseHeaders } = { responseHeaders: false }
|
|
1661
2084
|
) {
|
|
1662
2085
|
const {
|
|
1663
2086
|
error,
|
|
1664
2087
|
} = CommunicationPlatformApplicationValidator.getCampaigns().validate(
|
|
1665
2088
|
{
|
|
2089
|
+
query,
|
|
1666
2090
|
pageNo,
|
|
1667
2091
|
pageSize,
|
|
1668
2092
|
sort,
|
|
@@ -1678,6 +2102,7 @@ class Communication {
|
|
|
1678
2102
|
error: warrning,
|
|
1679
2103
|
} = CommunicationPlatformApplicationValidator.getCampaigns().validate(
|
|
1680
2104
|
{
|
|
2105
|
+
query,
|
|
1681
2106
|
pageNo,
|
|
1682
2107
|
pageSize,
|
|
1683
2108
|
sort,
|
|
@@ -1692,6 +2117,7 @@ class Communication {
|
|
|
1692
2117
|
}
|
|
1693
2118
|
|
|
1694
2119
|
const query_params = {};
|
|
2120
|
+
query_params["query"] = query;
|
|
1695
2121
|
query_params["page_no"] = pageNo;
|
|
1696
2122
|
query_params["page_size"] = pageSize;
|
|
1697
2123
|
query_params["sort"] = sort;
|
|
@@ -1724,45 +2150,12 @@ class Communication {
|
|
|
1724
2150
|
} else {
|
|
1725
2151
|
Logger({
|
|
1726
2152
|
level: "WARN",
|
|
1727
|
-
message: `Response Validation Warnings for platform > Communication > getCampaigns \n ${res_error}`,
|
|
1728
|
-
});
|
|
1729
|
-
}
|
|
1730
|
-
}
|
|
1731
|
-
|
|
1732
|
-
return response;
|
|
1733
|
-
}
|
|
1734
|
-
|
|
1735
|
-
/**
|
|
1736
|
-
* @param {Object} arg - Arg object.
|
|
1737
|
-
* @param {string} arg.companyId - Company id
|
|
1738
|
-
* @param {string} arg.applicationId - Application id
|
|
1739
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
1740
|
-
* @param {Object} [arg.sort] - To sort based on created_at
|
|
1741
|
-
* @returns {Paginator<CommunicationPlatformModel.Campaigns>}
|
|
1742
|
-
* @summary: Get campaigns
|
|
1743
|
-
* @description: Get campaigns
|
|
1744
|
-
*/
|
|
1745
|
-
getCampaignsPaginator({ companyId, applicationId, pageSize, sort } = {}) {
|
|
1746
|
-
const paginator = new Paginator();
|
|
1747
|
-
const callback = async () => {
|
|
1748
|
-
const pageId = paginator.nextId;
|
|
1749
|
-
const pageNo = paginator.pageNo;
|
|
1750
|
-
const pageType = "number";
|
|
1751
|
-
const data = await this.getCampaigns({
|
|
1752
|
-
companyId: companyId,
|
|
1753
|
-
applicationId: applicationId,
|
|
1754
|
-
pageNo: pageNo,
|
|
1755
|
-
pageSize: pageSize,
|
|
1756
|
-
sort: sort,
|
|
1757
|
-
});
|
|
1758
|
-
paginator.setPaginator({
|
|
1759
|
-
hasNext: data.page.has_next ? true : false,
|
|
1760
|
-
nextId: data.page.next_id,
|
|
1761
|
-
});
|
|
1762
|
-
return data;
|
|
1763
|
-
};
|
|
1764
|
-
paginator.setCallback(callback.bind(this));
|
|
1765
|
-
return paginator;
|
|
2153
|
+
message: `Response Validation Warnings for platform > Communication > getCampaigns \n ${res_error}`,
|
|
2154
|
+
});
|
|
2155
|
+
}
|
|
2156
|
+
}
|
|
2157
|
+
|
|
2158
|
+
return response;
|
|
1766
2159
|
}
|
|
1767
2160
|
|
|
1768
2161
|
/**
|
|
@@ -2222,7 +2615,7 @@ class Communication {
|
|
|
2222
2615
|
* @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
2223
2616
|
*/
|
|
2224
2617
|
async getEmailProviders(
|
|
2225
|
-
{ pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
2618
|
+
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
2226
2619
|
{ responseHeaders } = { responseHeaders: false }
|
|
2227
2620
|
) {
|
|
2228
2621
|
const {
|
|
@@ -2232,6 +2625,7 @@ class Communication {
|
|
|
2232
2625
|
pageNo,
|
|
2233
2626
|
pageSize,
|
|
2234
2627
|
sort,
|
|
2628
|
+
query,
|
|
2235
2629
|
},
|
|
2236
2630
|
{ abortEarly: false, allowUnknown: true }
|
|
2237
2631
|
);
|
|
@@ -2247,6 +2641,7 @@ class Communication {
|
|
|
2247
2641
|
pageNo,
|
|
2248
2642
|
pageSize,
|
|
2249
2643
|
sort,
|
|
2644
|
+
query,
|
|
2250
2645
|
},
|
|
2251
2646
|
{ abortEarly: false, allowUnknown: false }
|
|
2252
2647
|
);
|
|
@@ -2261,6 +2656,7 @@ class Communication {
|
|
|
2261
2656
|
query_params["page_no"] = pageNo;
|
|
2262
2657
|
query_params["page_size"] = pageSize;
|
|
2263
2658
|
query_params["sort"] = sort;
|
|
2659
|
+
query_params["query"] = query;
|
|
2264
2660
|
|
|
2265
2661
|
const response = await PlatformAPIClient.execute(
|
|
2266
2662
|
this.config,
|
|
@@ -2304,6 +2700,7 @@ class Communication {
|
|
|
2304
2700
|
* @param {string} arg.applicationId - Application id
|
|
2305
2701
|
* @param {number} [arg.pageSize] - Current request items count
|
|
2306
2702
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
2703
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
2307
2704
|
* @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
|
|
2308
2705
|
* @summary: Get email providers
|
|
2309
2706
|
* @description: Get email providers
|
|
@@ -2313,6 +2710,7 @@ class Communication {
|
|
|
2313
2710
|
applicationId,
|
|
2314
2711
|
pageSize,
|
|
2315
2712
|
sort,
|
|
2713
|
+
query,
|
|
2316
2714
|
} = {}) {
|
|
2317
2715
|
const paginator = new Paginator();
|
|
2318
2716
|
const callback = async () => {
|
|
@@ -2325,6 +2723,7 @@ class Communication {
|
|
|
2325
2723
|
pageNo: pageNo,
|
|
2326
2724
|
pageSize: pageSize,
|
|
2327
2725
|
sort: sort,
|
|
2726
|
+
query: query,
|
|
2328
2727
|
});
|
|
2329
2728
|
paginator.setPaginator({
|
|
2330
2729
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -2429,7 +2828,7 @@ class Communication {
|
|
|
2429
2828
|
* @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/).
|
|
2430
2829
|
*/
|
|
2431
2830
|
async getEmailTemplates(
|
|
2432
|
-
{ pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
2831
|
+
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
2433
2832
|
{ responseHeaders } = { responseHeaders: false }
|
|
2434
2833
|
) {
|
|
2435
2834
|
const {
|
|
@@ -2439,6 +2838,7 @@ class Communication {
|
|
|
2439
2838
|
pageNo,
|
|
2440
2839
|
pageSize,
|
|
2441
2840
|
sort,
|
|
2841
|
+
query,
|
|
2442
2842
|
},
|
|
2443
2843
|
{ abortEarly: false, allowUnknown: true }
|
|
2444
2844
|
);
|
|
@@ -2454,6 +2854,7 @@ class Communication {
|
|
|
2454
2854
|
pageNo,
|
|
2455
2855
|
pageSize,
|
|
2456
2856
|
sort,
|
|
2857
|
+
query,
|
|
2457
2858
|
},
|
|
2458
2859
|
{ abortEarly: false, allowUnknown: false }
|
|
2459
2860
|
);
|
|
@@ -2468,6 +2869,7 @@ class Communication {
|
|
|
2468
2869
|
query_params["page_no"] = pageNo;
|
|
2469
2870
|
query_params["page_size"] = pageSize;
|
|
2470
2871
|
query_params["sort"] = sort;
|
|
2872
|
+
query_params["query"] = query;
|
|
2471
2873
|
|
|
2472
2874
|
const response = await PlatformAPIClient.execute(
|
|
2473
2875
|
this.config,
|
|
@@ -2511,6 +2913,7 @@ class Communication {
|
|
|
2511
2913
|
* @param {string} arg.applicationId - Application id
|
|
2512
2914
|
* @param {number} [arg.pageSize] - Current request items count
|
|
2513
2915
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
2916
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
2514
2917
|
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
2515
2918
|
* @summary: Get email templates
|
|
2516
2919
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.
|
|
@@ -2520,6 +2923,7 @@ class Communication {
|
|
|
2520
2923
|
applicationId,
|
|
2521
2924
|
pageSize,
|
|
2522
2925
|
sort,
|
|
2926
|
+
query,
|
|
2523
2927
|
} = {}) {
|
|
2524
2928
|
const paginator = new Paginator();
|
|
2525
2929
|
const callback = async () => {
|
|
@@ -2532,6 +2936,7 @@ class Communication {
|
|
|
2532
2936
|
pageNo: pageNo,
|
|
2533
2937
|
pageSize: pageSize,
|
|
2534
2938
|
sort: sort,
|
|
2939
|
+
query: query,
|
|
2535
2940
|
});
|
|
2536
2941
|
paginator.setPaginator({
|
|
2537
2942
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -2637,7 +3042,7 @@ class Communication {
|
|
|
2637
3042
|
* @param {string} arg.companyId - Company id
|
|
2638
3043
|
* @param {string} arg.applicationId - Application id
|
|
2639
3044
|
* @param {number} [arg.pageSize] - Current request items count
|
|
2640
|
-
* @param {string} [arg.populate] - Populate
|
|
3045
|
+
* @param {string} [arg.populate] - Populate Fields
|
|
2641
3046
|
* @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
|
|
2642
3047
|
* @summary: Get event subscriptions
|
|
2643
3048
|
* @description: Get event subscriptions
|
|
@@ -2670,6 +3075,90 @@ class Communication {
|
|
|
2670
3075
|
return paginator;
|
|
2671
3076
|
}
|
|
2672
3077
|
|
|
3078
|
+
/**
|
|
3079
|
+
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
|
|
3080
|
+
* - Arg object
|
|
3081
|
+
*
|
|
3082
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3083
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3084
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
3085
|
+
* @name getEventSubscriptionsById
|
|
3086
|
+
* @summary: Get event subscriptions by id
|
|
3087
|
+
* @description: Get event subscriptions by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptionsById/).
|
|
3088
|
+
*/
|
|
3089
|
+
async getEventSubscriptionsById(
|
|
3090
|
+
{ id, populate, requestHeaders } = { requestHeaders: {} },
|
|
3091
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3092
|
+
) {
|
|
3093
|
+
const {
|
|
3094
|
+
error,
|
|
3095
|
+
} = CommunicationPlatformApplicationValidator.getEventSubscriptionsById().validate(
|
|
3096
|
+
{
|
|
3097
|
+
id,
|
|
3098
|
+
populate,
|
|
3099
|
+
},
|
|
3100
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3101
|
+
);
|
|
3102
|
+
if (error) {
|
|
3103
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3104
|
+
}
|
|
3105
|
+
|
|
3106
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3107
|
+
const {
|
|
3108
|
+
error: warrning,
|
|
3109
|
+
} = CommunicationPlatformApplicationValidator.getEventSubscriptionsById().validate(
|
|
3110
|
+
{
|
|
3111
|
+
id,
|
|
3112
|
+
populate,
|
|
3113
|
+
},
|
|
3114
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3115
|
+
);
|
|
3116
|
+
if (warrning) {
|
|
3117
|
+
Logger({
|
|
3118
|
+
level: "WARN",
|
|
3119
|
+
message: `Parameter Validation warrnings for platform > Communication > getEventSubscriptionsById \n ${warrning}`,
|
|
3120
|
+
});
|
|
3121
|
+
}
|
|
3122
|
+
|
|
3123
|
+
const query_params = {};
|
|
3124
|
+
query_params["populate"] = populate;
|
|
3125
|
+
|
|
3126
|
+
const response = await PlatformAPIClient.execute(
|
|
3127
|
+
this.config,
|
|
3128
|
+
"get",
|
|
3129
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/event/event-subscriptions/${id}`,
|
|
3130
|
+
query_params,
|
|
3131
|
+
undefined,
|
|
3132
|
+
requestHeaders,
|
|
3133
|
+
{ responseHeaders }
|
|
3134
|
+
);
|
|
3135
|
+
|
|
3136
|
+
let responseData = response;
|
|
3137
|
+
if (responseHeaders) {
|
|
3138
|
+
responseData = response[0];
|
|
3139
|
+
}
|
|
3140
|
+
|
|
3141
|
+
const {
|
|
3142
|
+
error: res_error,
|
|
3143
|
+
} = CommunicationPlatformModel.EventSubscription().validate(responseData, {
|
|
3144
|
+
abortEarly: false,
|
|
3145
|
+
allowUnknown: true,
|
|
3146
|
+
});
|
|
3147
|
+
|
|
3148
|
+
if (res_error) {
|
|
3149
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3150
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3151
|
+
} else {
|
|
3152
|
+
Logger({
|
|
3153
|
+
level: "WARN",
|
|
3154
|
+
message: `Response Validation Warnings for platform > Communication > getEventSubscriptionsById \n ${res_error}`,
|
|
3155
|
+
});
|
|
3156
|
+
}
|
|
3157
|
+
}
|
|
3158
|
+
|
|
3159
|
+
return response;
|
|
3160
|
+
}
|
|
3161
|
+
|
|
2673
3162
|
/**
|
|
2674
3163
|
* @param {CommunicationPlatformApplicationValidator.GetGlobalProvidersParam} arg
|
|
2675
3164
|
* - Arg object
|
|
@@ -2836,7 +3325,7 @@ class Communication {
|
|
|
2836
3325
|
* @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
2837
3326
|
*/
|
|
2838
3327
|
async getJobLogs(
|
|
2839
|
-
{ pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
3328
|
+
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
2840
3329
|
{ responseHeaders } = { responseHeaders: false }
|
|
2841
3330
|
) {
|
|
2842
3331
|
const {
|
|
@@ -2846,6 +3335,7 @@ class Communication {
|
|
|
2846
3335
|
pageNo,
|
|
2847
3336
|
pageSize,
|
|
2848
3337
|
sort,
|
|
3338
|
+
query,
|
|
2849
3339
|
},
|
|
2850
3340
|
{ abortEarly: false, allowUnknown: true }
|
|
2851
3341
|
);
|
|
@@ -2861,6 +3351,7 @@ class Communication {
|
|
|
2861
3351
|
pageNo,
|
|
2862
3352
|
pageSize,
|
|
2863
3353
|
sort,
|
|
3354
|
+
query,
|
|
2864
3355
|
},
|
|
2865
3356
|
{ abortEarly: false, allowUnknown: false }
|
|
2866
3357
|
);
|
|
@@ -2875,6 +3366,7 @@ class Communication {
|
|
|
2875
3366
|
query_params["page_no"] = pageNo;
|
|
2876
3367
|
query_params["page_size"] = pageSize;
|
|
2877
3368
|
query_params["sort"] = sort;
|
|
3369
|
+
query_params["query"] = query;
|
|
2878
3370
|
|
|
2879
3371
|
const response = await PlatformAPIClient.execute(
|
|
2880
3372
|
this.config,
|
|
@@ -2918,11 +3410,18 @@ class Communication {
|
|
|
2918
3410
|
* @param {string} arg.applicationId - Application id
|
|
2919
3411
|
* @param {number} [arg.pageSize] - Current request items count
|
|
2920
3412
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
3413
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
2921
3414
|
* @returns {Paginator<CommunicationPlatformModel.JobLogs>}
|
|
2922
3415
|
* @summary: Get job logs
|
|
2923
3416
|
* @description: Get job logs
|
|
2924
3417
|
*/
|
|
2925
|
-
getJobLogsPaginator({
|
|
3418
|
+
getJobLogsPaginator({
|
|
3419
|
+
companyId,
|
|
3420
|
+
applicationId,
|
|
3421
|
+
pageSize,
|
|
3422
|
+
sort,
|
|
3423
|
+
query,
|
|
3424
|
+
} = {}) {
|
|
2926
3425
|
const paginator = new Paginator();
|
|
2927
3426
|
const callback = async () => {
|
|
2928
3427
|
const pageId = paginator.nextId;
|
|
@@ -2934,6 +3433,7 @@ class Communication {
|
|
|
2934
3433
|
pageNo: pageNo,
|
|
2935
3434
|
pageSize: pageSize,
|
|
2936
3435
|
sort: sort,
|
|
3436
|
+
query: query,
|
|
2937
3437
|
});
|
|
2938
3438
|
paginator.setPaginator({
|
|
2939
3439
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -2955,7 +3455,7 @@ class Communication {
|
|
|
2955
3455
|
* @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
2956
3456
|
*/
|
|
2957
3457
|
async getJobs(
|
|
2958
|
-
{ pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
3458
|
+
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
2959
3459
|
{ responseHeaders } = { responseHeaders: false }
|
|
2960
3460
|
) {
|
|
2961
3461
|
const {
|
|
@@ -2965,6 +3465,7 @@ class Communication {
|
|
|
2965
3465
|
pageNo,
|
|
2966
3466
|
pageSize,
|
|
2967
3467
|
sort,
|
|
3468
|
+
query,
|
|
2968
3469
|
},
|
|
2969
3470
|
{ abortEarly: false, allowUnknown: true }
|
|
2970
3471
|
);
|
|
@@ -2980,6 +3481,7 @@ class Communication {
|
|
|
2980
3481
|
pageNo,
|
|
2981
3482
|
pageSize,
|
|
2982
3483
|
sort,
|
|
3484
|
+
query,
|
|
2983
3485
|
},
|
|
2984
3486
|
{ abortEarly: false, allowUnknown: false }
|
|
2985
3487
|
);
|
|
@@ -2994,6 +3496,7 @@ class Communication {
|
|
|
2994
3496
|
query_params["page_no"] = pageNo;
|
|
2995
3497
|
query_params["page_size"] = pageSize;
|
|
2996
3498
|
query_params["sort"] = sort;
|
|
3499
|
+
query_params["query"] = query;
|
|
2997
3500
|
|
|
2998
3501
|
const response = await PlatformAPIClient.execute(
|
|
2999
3502
|
this.config,
|
|
@@ -3037,11 +3540,12 @@ class Communication {
|
|
|
3037
3540
|
* @param {string} arg.applicationId - Application id
|
|
3038
3541
|
* @param {number} [arg.pageSize] - Current request items count
|
|
3039
3542
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
3543
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
3040
3544
|
* @returns {Paginator<CommunicationPlatformModel.Jobs>}
|
|
3041
3545
|
* @summary: Get jobs
|
|
3042
3546
|
* @description: Get jobs
|
|
3043
3547
|
*/
|
|
3044
|
-
getJobsPaginator({ companyId, applicationId, pageSize, sort } = {}) {
|
|
3548
|
+
getJobsPaginator({ companyId, applicationId, pageSize, sort, query } = {}) {
|
|
3045
3549
|
const paginator = new Paginator();
|
|
3046
3550
|
const callback = async () => {
|
|
3047
3551
|
const pageId = paginator.nextId;
|
|
@@ -3053,6 +3557,7 @@ class Communication {
|
|
|
3053
3557
|
pageNo: pageNo,
|
|
3054
3558
|
pageSize: pageSize,
|
|
3055
3559
|
sort: sort,
|
|
3560
|
+
query: query,
|
|
3056
3561
|
});
|
|
3057
3562
|
paginator.setPaginator({
|
|
3058
3563
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -3222,6 +3727,83 @@ class Communication {
|
|
|
3222
3727
|
return response;
|
|
3223
3728
|
}
|
|
3224
3729
|
|
|
3730
|
+
/**
|
|
3731
|
+
* @param {CommunicationPlatformApplicationValidator.GetOtpConfigurationParam} arg
|
|
3732
|
+
* - Arg object
|
|
3733
|
+
*
|
|
3734
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3735
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3736
|
+
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
3737
|
+
* @name getOtpConfiguration
|
|
3738
|
+
* @summary: Get otp-configuration, if not present in db then return default settings
|
|
3739
|
+
* @description: Get otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getOtpConfiguration/).
|
|
3740
|
+
*/
|
|
3741
|
+
async getOtpConfiguration(
|
|
3742
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
3743
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3744
|
+
) {
|
|
3745
|
+
const {
|
|
3746
|
+
error,
|
|
3747
|
+
} = CommunicationPlatformApplicationValidator.getOtpConfiguration().validate(
|
|
3748
|
+
{},
|
|
3749
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3750
|
+
);
|
|
3751
|
+
if (error) {
|
|
3752
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3753
|
+
}
|
|
3754
|
+
|
|
3755
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3756
|
+
const {
|
|
3757
|
+
error: warrning,
|
|
3758
|
+
} = CommunicationPlatformApplicationValidator.getOtpConfiguration().validate(
|
|
3759
|
+
{},
|
|
3760
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3761
|
+
);
|
|
3762
|
+
if (warrning) {
|
|
3763
|
+
Logger({
|
|
3764
|
+
level: "WARN",
|
|
3765
|
+
message: `Parameter Validation warrnings for platform > Communication > getOtpConfiguration \n ${warrning}`,
|
|
3766
|
+
});
|
|
3767
|
+
}
|
|
3768
|
+
|
|
3769
|
+
const query_params = {};
|
|
3770
|
+
|
|
3771
|
+
const response = await PlatformAPIClient.execute(
|
|
3772
|
+
this.config,
|
|
3773
|
+
"get",
|
|
3774
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/otp/otp-configuration`,
|
|
3775
|
+
query_params,
|
|
3776
|
+
undefined,
|
|
3777
|
+
requestHeaders,
|
|
3778
|
+
{ responseHeaders }
|
|
3779
|
+
);
|
|
3780
|
+
|
|
3781
|
+
let responseData = response;
|
|
3782
|
+
if (responseHeaders) {
|
|
3783
|
+
responseData = response[0];
|
|
3784
|
+
}
|
|
3785
|
+
|
|
3786
|
+
const {
|
|
3787
|
+
error: res_error,
|
|
3788
|
+
} = CommunicationPlatformModel.OtpConfiguration().validate(responseData, {
|
|
3789
|
+
abortEarly: false,
|
|
3790
|
+
allowUnknown: true,
|
|
3791
|
+
});
|
|
3792
|
+
|
|
3793
|
+
if (res_error) {
|
|
3794
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3795
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3796
|
+
} else {
|
|
3797
|
+
Logger({
|
|
3798
|
+
level: "WARN",
|
|
3799
|
+
message: `Response Validation Warnings for platform > Communication > getOtpConfiguration \n ${res_error}`,
|
|
3800
|
+
});
|
|
3801
|
+
}
|
|
3802
|
+
}
|
|
3803
|
+
|
|
3804
|
+
return response;
|
|
3805
|
+
}
|
|
3806
|
+
|
|
3225
3807
|
/**
|
|
3226
3808
|
* @param {CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam} arg
|
|
3227
3809
|
* - Arg object
|
|
@@ -3480,7 +4062,7 @@ class Communication {
|
|
|
3480
4062
|
* @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/).
|
|
3481
4063
|
*/
|
|
3482
4064
|
async getSmsTemplates(
|
|
3483
|
-
{ pageNo, pageSize, sort, requestHeaders } = { requestHeaders: {} },
|
|
4065
|
+
{ pageNo, pageSize, sort, query, requestHeaders } = { requestHeaders: {} },
|
|
3484
4066
|
{ responseHeaders } = { responseHeaders: false }
|
|
3485
4067
|
) {
|
|
3486
4068
|
const {
|
|
@@ -3490,6 +4072,7 @@ class Communication {
|
|
|
3490
4072
|
pageNo,
|
|
3491
4073
|
pageSize,
|
|
3492
4074
|
sort,
|
|
4075
|
+
query,
|
|
3493
4076
|
},
|
|
3494
4077
|
{ abortEarly: false, allowUnknown: true }
|
|
3495
4078
|
);
|
|
@@ -3505,6 +4088,7 @@ class Communication {
|
|
|
3505
4088
|
pageNo,
|
|
3506
4089
|
pageSize,
|
|
3507
4090
|
sort,
|
|
4091
|
+
query,
|
|
3508
4092
|
},
|
|
3509
4093
|
{ abortEarly: false, allowUnknown: false }
|
|
3510
4094
|
);
|
|
@@ -3519,6 +4103,7 @@ class Communication {
|
|
|
3519
4103
|
query_params["page_no"] = pageNo;
|
|
3520
4104
|
query_params["page_size"] = pageSize;
|
|
3521
4105
|
query_params["sort"] = sort;
|
|
4106
|
+
query_params["query"] = query;
|
|
3522
4107
|
|
|
3523
4108
|
const response = await PlatformAPIClient.execute(
|
|
3524
4109
|
this.config,
|
|
@@ -3562,11 +4147,18 @@ class Communication {
|
|
|
3562
4147
|
* @param {string} arg.applicationId - Application id
|
|
3563
4148
|
* @param {number} [arg.pageSize] - Current request items count
|
|
3564
4149
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
4150
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
3565
4151
|
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
3566
4152
|
* @summary: Get sms templates
|
|
3567
4153
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.
|
|
3568
4154
|
*/
|
|
3569
|
-
getSmsTemplatesPaginator({
|
|
4155
|
+
getSmsTemplatesPaginator({
|
|
4156
|
+
companyId,
|
|
4157
|
+
applicationId,
|
|
4158
|
+
pageSize,
|
|
4159
|
+
sort,
|
|
4160
|
+
query,
|
|
4161
|
+
} = {}) {
|
|
3570
4162
|
const paginator = new Paginator();
|
|
3571
4163
|
const callback = async () => {
|
|
3572
4164
|
const pageId = paginator.nextId;
|
|
@@ -3578,6 +4170,7 @@ class Communication {
|
|
|
3578
4170
|
pageNo: pageNo,
|
|
3579
4171
|
pageSize: pageSize,
|
|
3580
4172
|
sort: sort,
|
|
4173
|
+
query: query,
|
|
3581
4174
|
});
|
|
3582
4175
|
paginator.setPaginator({
|
|
3583
4176
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -3682,7 +4275,7 @@ class Communication {
|
|
|
3682
4275
|
* @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/).
|
|
3683
4276
|
*/
|
|
3684
4277
|
async getSubscribedEmailTemplates(
|
|
3685
|
-
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
4278
|
+
{ pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
|
|
3686
4279
|
{ responseHeaders } = { responseHeaders: false }
|
|
3687
4280
|
) {
|
|
3688
4281
|
const {
|
|
@@ -3691,6 +4284,7 @@ class Communication {
|
|
|
3691
4284
|
{
|
|
3692
4285
|
pageNo,
|
|
3693
4286
|
pageSize,
|
|
4287
|
+
query,
|
|
3694
4288
|
},
|
|
3695
4289
|
{ abortEarly: false, allowUnknown: true }
|
|
3696
4290
|
);
|
|
@@ -3705,6 +4299,7 @@ class Communication {
|
|
|
3705
4299
|
{
|
|
3706
4300
|
pageNo,
|
|
3707
4301
|
pageSize,
|
|
4302
|
+
query,
|
|
3708
4303
|
},
|
|
3709
4304
|
{ abortEarly: false, allowUnknown: false }
|
|
3710
4305
|
);
|
|
@@ -3718,6 +4313,7 @@ class Communication {
|
|
|
3718
4313
|
const query_params = {};
|
|
3719
4314
|
query_params["page_no"] = pageNo;
|
|
3720
4315
|
query_params["page_size"] = pageSize;
|
|
4316
|
+
query_params["query"] = query;
|
|
3721
4317
|
|
|
3722
4318
|
const response = await PlatformAPIClient.execute(
|
|
3723
4319
|
this.config,
|
|
@@ -3760,6 +4356,7 @@ class Communication {
|
|
|
3760
4356
|
* @param {string} arg.companyId - Company id
|
|
3761
4357
|
* @param {string} arg.applicationId - Application id
|
|
3762
4358
|
* @param {number} [arg.pageSize] - Current request items count
|
|
4359
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
3763
4360
|
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
3764
4361
|
* @summary: Get subscribed email templates
|
|
3765
4362
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.
|
|
@@ -3768,6 +4365,7 @@ class Communication {
|
|
|
3768
4365
|
companyId,
|
|
3769
4366
|
applicationId,
|
|
3770
4367
|
pageSize,
|
|
4368
|
+
query,
|
|
3771
4369
|
} = {}) {
|
|
3772
4370
|
const paginator = new Paginator();
|
|
3773
4371
|
const callback = async () => {
|
|
@@ -3779,6 +4377,7 @@ class Communication {
|
|
|
3779
4377
|
applicationId: applicationId,
|
|
3780
4378
|
pageNo: pageNo,
|
|
3781
4379
|
pageSize: pageSize,
|
|
4380
|
+
query: query,
|
|
3782
4381
|
});
|
|
3783
4382
|
paginator.setPaginator({
|
|
3784
4383
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -3802,7 +4401,7 @@ class Communication {
|
|
|
3802
4401
|
* @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/).
|
|
3803
4402
|
*/
|
|
3804
4403
|
async getSubscribedSmsTemplates(
|
|
3805
|
-
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
4404
|
+
{ pageNo, pageSize, query, requestHeaders } = { requestHeaders: {} },
|
|
3806
4405
|
{ responseHeaders } = { responseHeaders: false }
|
|
3807
4406
|
) {
|
|
3808
4407
|
const {
|
|
@@ -3811,6 +4410,7 @@ class Communication {
|
|
|
3811
4410
|
{
|
|
3812
4411
|
pageNo,
|
|
3813
4412
|
pageSize,
|
|
4413
|
+
query,
|
|
3814
4414
|
},
|
|
3815
4415
|
{ abortEarly: false, allowUnknown: true }
|
|
3816
4416
|
);
|
|
@@ -3825,6 +4425,7 @@ class Communication {
|
|
|
3825
4425
|
{
|
|
3826
4426
|
pageNo,
|
|
3827
4427
|
pageSize,
|
|
4428
|
+
query,
|
|
3828
4429
|
},
|
|
3829
4430
|
{ abortEarly: false, allowUnknown: false }
|
|
3830
4431
|
);
|
|
@@ -3838,6 +4439,7 @@ class Communication {
|
|
|
3838
4439
|
const query_params = {};
|
|
3839
4440
|
query_params["page_no"] = pageNo;
|
|
3840
4441
|
query_params["page_size"] = pageSize;
|
|
4442
|
+
query_params["query"] = query;
|
|
3841
4443
|
|
|
3842
4444
|
const response = await PlatformAPIClient.execute(
|
|
3843
4445
|
this.config,
|
|
@@ -3880,6 +4482,7 @@ class Communication {
|
|
|
3880
4482
|
* @param {string} arg.companyId - Company id
|
|
3881
4483
|
* @param {string} arg.applicationId - Application id
|
|
3882
4484
|
* @param {number} [arg.pageSize] - Current request items count
|
|
4485
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
3883
4486
|
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
3884
4487
|
* @summary: Get subscribed sms templates
|
|
3885
4488
|
* @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.
|
|
@@ -3888,6 +4491,7 @@ class Communication {
|
|
|
3888
4491
|
companyId,
|
|
3889
4492
|
applicationId,
|
|
3890
4493
|
pageSize,
|
|
4494
|
+
query,
|
|
3891
4495
|
} = {}) {
|
|
3892
4496
|
const paginator = new Paginator();
|
|
3893
4497
|
const callback = async () => {
|
|
@@ -3899,6 +4503,7 @@ class Communication {
|
|
|
3899
4503
|
applicationId: applicationId,
|
|
3900
4504
|
pageNo: pageNo,
|
|
3901
4505
|
pageSize: pageSize,
|
|
4506
|
+
query: query,
|
|
3902
4507
|
});
|
|
3903
4508
|
paginator.setPaginator({
|
|
3904
4509
|
hasNext: data.page.has_next ? true : false,
|
|
@@ -4957,6 +5562,83 @@ class Communication {
|
|
|
4957
5562
|
return response;
|
|
4958
5563
|
}
|
|
4959
5564
|
|
|
5565
|
+
/**
|
|
5566
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateOtpConfigurationParam} arg
|
|
5567
|
+
* - Arg object
|
|
5568
|
+
*
|
|
5569
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
5570
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5571
|
+
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
5572
|
+
* @name updateOtpConfiguration
|
|
5573
|
+
* @summary: Update/insert otp configurations
|
|
5574
|
+
* @description: Update otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateOtpConfiguration/).
|
|
5575
|
+
*/
|
|
5576
|
+
async updateOtpConfiguration(
|
|
5577
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
5578
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
5579
|
+
) {
|
|
5580
|
+
const {
|
|
5581
|
+
error,
|
|
5582
|
+
} = CommunicationPlatformApplicationValidator.updateOtpConfiguration().validate(
|
|
5583
|
+
{},
|
|
5584
|
+
{ abortEarly: false, allowUnknown: true }
|
|
5585
|
+
);
|
|
5586
|
+
if (error) {
|
|
5587
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
5588
|
+
}
|
|
5589
|
+
|
|
5590
|
+
// Showing warrnings if extra unknown parameters are found
|
|
5591
|
+
const {
|
|
5592
|
+
error: warrning,
|
|
5593
|
+
} = CommunicationPlatformApplicationValidator.updateOtpConfiguration().validate(
|
|
5594
|
+
{},
|
|
5595
|
+
{ abortEarly: false, allowUnknown: false }
|
|
5596
|
+
);
|
|
5597
|
+
if (warrning) {
|
|
5598
|
+
Logger({
|
|
5599
|
+
level: "WARN",
|
|
5600
|
+
message: `Parameter Validation warrnings for platform > Communication > updateOtpConfiguration \n ${warrning}`,
|
|
5601
|
+
});
|
|
5602
|
+
}
|
|
5603
|
+
|
|
5604
|
+
const query_params = {};
|
|
5605
|
+
|
|
5606
|
+
const response = await PlatformAPIClient.execute(
|
|
5607
|
+
this.config,
|
|
5608
|
+
"put",
|
|
5609
|
+
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/otp/otp-configuration`,
|
|
5610
|
+
query_params,
|
|
5611
|
+
undefined,
|
|
5612
|
+
requestHeaders,
|
|
5613
|
+
{ responseHeaders }
|
|
5614
|
+
);
|
|
5615
|
+
|
|
5616
|
+
let responseData = response;
|
|
5617
|
+
if (responseHeaders) {
|
|
5618
|
+
responseData = response[0];
|
|
5619
|
+
}
|
|
5620
|
+
|
|
5621
|
+
const {
|
|
5622
|
+
error: res_error,
|
|
5623
|
+
} = CommunicationPlatformModel.OtpConfiguration().validate(responseData, {
|
|
5624
|
+
abortEarly: false,
|
|
5625
|
+
allowUnknown: true,
|
|
5626
|
+
});
|
|
5627
|
+
|
|
5628
|
+
if (res_error) {
|
|
5629
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
5630
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
5631
|
+
} else {
|
|
5632
|
+
Logger({
|
|
5633
|
+
level: "WARN",
|
|
5634
|
+
message: `Response Validation Warnings for platform > Communication > updateOtpConfiguration \n ${res_error}`,
|
|
5635
|
+
});
|
|
5636
|
+
}
|
|
5637
|
+
}
|
|
5638
|
+
|
|
5639
|
+
return response;
|
|
5640
|
+
}
|
|
5641
|
+
|
|
4960
5642
|
/**
|
|
4961
5643
|
* @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
|
|
4962
5644
|
* - Arg object
|