@gofynd/fdk-client-javascript 1.6.4 → 3.1.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/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -4,53 +4,29 @@ declare class Communication {
|
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
|
-
* @param {CommunicationPlatformApplicationValidator.
|
|
8
|
-
* - Arg object
|
|
9
|
-
*
|
|
10
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
-
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
13
|
-
* @name createAudience
|
|
14
|
-
* @summary: Create an audience
|
|
15
|
-
* @description: Creates a new email audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
|
|
16
|
-
*/
|
|
17
|
-
createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
18
|
-
/**
|
|
19
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryHeadersParam} arg
|
|
20
|
-
* - Arg object
|
|
21
|
-
*
|
|
22
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<Object>} - Success response
|
|
25
|
-
* @name createBigQueryHeaders
|
|
26
|
-
* @summary: Create BigQuery headers
|
|
27
|
-
* @description: Create BigQuery headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
|
|
28
|
-
*/
|
|
29
|
-
createBigQueryHeaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
30
|
-
/**
|
|
31
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryNCountParam} arg
|
|
7
|
+
* @param {CommunicationPlatformApplicationValidator.CreateAppPushtokenParam} arg
|
|
32
8
|
* - Arg object
|
|
33
9
|
*
|
|
34
10
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
|
-
* @returns {Promise<
|
|
37
|
-
* @name
|
|
38
|
-
* @summary: Create
|
|
39
|
-
* @description:
|
|
12
|
+
* @returns {Promise<CommunicationPlatformModel.PushtokenRes>} - Success response
|
|
13
|
+
* @name createAppPushtoken
|
|
14
|
+
* @summary: Create app push token.
|
|
15
|
+
* @description: Create the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAppPushtoken/).
|
|
40
16
|
*/
|
|
41
|
-
|
|
17
|
+
createAppPushtoken({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAppPushtokenParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.PushtokenRes>;
|
|
42
18
|
/**
|
|
43
|
-
* @param {CommunicationPlatformApplicationValidator.
|
|
19
|
+
* @param {CommunicationPlatformApplicationValidator.CreateAudienceParam} arg
|
|
44
20
|
* - Arg object
|
|
45
21
|
*
|
|
46
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<
|
|
49
|
-
* @name
|
|
50
|
-
* @summary: Create
|
|
51
|
-
* @description:
|
|
24
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
25
|
+
* @name createAudience
|
|
26
|
+
* @summary: Create audience.
|
|
27
|
+
* @description: Add audience which is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
|
|
52
28
|
*/
|
|
53
|
-
|
|
29
|
+
createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
54
30
|
/**
|
|
55
31
|
* @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
|
|
56
32
|
* - Arg object
|
|
@@ -59,8 +35,8 @@ declare class Communication {
|
|
|
59
35
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
36
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
61
37
|
* @name createCampaign
|
|
62
|
-
* @summary: Create
|
|
63
|
-
* @description:
|
|
38
|
+
* @summary: Create campaign.
|
|
39
|
+
* @description: Add a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
|
|
64
40
|
*/
|
|
65
41
|
createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
66
42
|
/**
|
|
@@ -71,8 +47,8 @@ declare class Communication {
|
|
|
71
47
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
48
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
73
49
|
* @name createEmailProvider
|
|
74
|
-
* @summary: Create
|
|
75
|
-
* @description:
|
|
50
|
+
* @summary: Create email provider.
|
|
51
|
+
* @description: Generate and add a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
|
|
76
52
|
*/
|
|
77
53
|
createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
78
54
|
/**
|
|
@@ -83,8 +59,8 @@ declare class Communication {
|
|
|
83
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
84
60
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
85
61
|
* @name createEmailTemplate
|
|
86
|
-
* @summary:
|
|
87
|
-
* @description:
|
|
62
|
+
* @summary: Create email template.
|
|
63
|
+
* @description: Generate and add a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
|
|
88
64
|
*/
|
|
89
65
|
createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
90
66
|
/**
|
|
@@ -93,14 +69,12 @@ declare class Communication {
|
|
|
93
69
|
*
|
|
94
70
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
71
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
97
|
-
* - Success response
|
|
98
|
-
*
|
|
72
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
99
73
|
* @name createEventSubscriptions
|
|
100
|
-
* @summary: Create
|
|
101
|
-
* @description:
|
|
74
|
+
* @summary: Create event subscriptions
|
|
75
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
|
|
102
76
|
*/
|
|
103
|
-
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
77
|
+
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
104
78
|
/**
|
|
105
79
|
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg
|
|
106
80
|
* - Arg object
|
|
@@ -108,23 +82,23 @@ declare class Communication {
|
|
|
108
82
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
83
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
84
|
* @returns {Promise<
|
|
111
|
-
* CommunicationPlatformModel.
|
|
85
|
+
* CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]
|
|
112
86
|
* >}
|
|
113
87
|
* - Success response
|
|
114
88
|
*
|
|
115
89
|
* @name createEventSubscriptionsByBulk
|
|
116
|
-
* @summary: Create event subscriptions
|
|
117
|
-
* @description:
|
|
90
|
+
* @summary: Create event subscriptions by bulk
|
|
91
|
+
* @description: Create event subscriptions by bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
|
|
118
92
|
*/
|
|
119
|
-
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
93
|
+
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]>;
|
|
120
94
|
/**
|
|
121
95
|
* @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object
|
|
122
96
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
97
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
98
|
* @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
|
|
125
99
|
* @name createJobs
|
|
126
|
-
* @summary: Create
|
|
127
|
-
* @description:
|
|
100
|
+
* @summary: Create jobs
|
|
101
|
+
* @description: Create jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createJobs/).
|
|
128
102
|
*/
|
|
129
103
|
createJobs({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateJobsRes>;
|
|
130
104
|
/**
|
|
@@ -133,12 +107,12 @@ declare class Communication {
|
|
|
133
107
|
*
|
|
134
108
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
135
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
136
|
-
* @returns {Promise<
|
|
110
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
|
|
137
111
|
* @name createSmsProvider
|
|
138
|
-
* @summary: Create SMS provider
|
|
139
|
-
* @description:
|
|
112
|
+
* @summary: Create SMS provider.
|
|
113
|
+
* @description: Add a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
|
|
140
114
|
*/
|
|
141
|
-
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<
|
|
115
|
+
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProvider>;
|
|
142
116
|
/**
|
|
143
117
|
* @param {CommunicationPlatformApplicationValidator.CreateSmsTemplateParam} arg
|
|
144
118
|
* - Arg object
|
|
@@ -147,8 +121,8 @@ declare class Communication {
|
|
|
147
121
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
148
122
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
149
123
|
* @name createSmsTemplate
|
|
150
|
-
* @summary: Create
|
|
151
|
-
* @description:
|
|
124
|
+
* @summary: Create SMS template.
|
|
125
|
+
* @description: Add a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
|
|
152
126
|
*/
|
|
153
127
|
createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
154
128
|
/**
|
|
@@ -157,86 +131,96 @@ declare class Communication {
|
|
|
157
131
|
*
|
|
158
132
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
159
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
134
|
+
* @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
|
|
161
135
|
* @name deleteAudienceById
|
|
162
|
-
* @summary: Delete
|
|
163
|
-
* @description: Remove a specific audience
|
|
136
|
+
* @summary: Delete audience by ID.
|
|
137
|
+
* @description: Remove a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
|
|
164
138
|
*/
|
|
165
|
-
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
139
|
+
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
|
|
140
|
+
/**
|
|
141
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteCampaignByIdParam} arg
|
|
142
|
+
* - Arg object
|
|
143
|
+
*
|
|
144
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
145
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
146
|
+
* @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
|
|
147
|
+
* @name deleteCampaignById
|
|
148
|
+
* @summary: Update campaign by ID.
|
|
149
|
+
* @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteCampaignById/).
|
|
150
|
+
*/
|
|
151
|
+
deleteCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
|
|
166
152
|
/**
|
|
167
153
|
* @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg
|
|
168
154
|
* - Arg object
|
|
169
155
|
*
|
|
170
156
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
171
157
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
172
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
158
|
+
* @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
|
|
173
159
|
* @name deleteEmailProviderById
|
|
174
|
-
* @summary: Delete
|
|
175
|
-
* @description:
|
|
160
|
+
* @summary: Delete email provider by ID.
|
|
161
|
+
* @description: Remove a specific email communication provider from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
|
|
176
162
|
*/
|
|
177
|
-
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
163
|
+
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
|
|
178
164
|
/**
|
|
179
165
|
* @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg
|
|
180
166
|
* - Arg object
|
|
181
167
|
*
|
|
182
168
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
169
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
170
|
+
* @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
|
|
185
171
|
* @name deleteEmailTemplateById
|
|
186
|
-
* @summary: Delete
|
|
187
|
-
* @description:
|
|
172
|
+
* @summary: Delete email template by ID.
|
|
173
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Remove a specific email communication template by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
|
|
188
174
|
*/
|
|
189
|
-
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
175
|
+
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
|
|
190
176
|
/**
|
|
191
177
|
* @param {CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam} arg
|
|
192
178
|
* - Arg object
|
|
193
179
|
*
|
|
194
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
182
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
197
183
|
* @name deleteEventSubscriptionsById
|
|
198
|
-
* @summary:
|
|
199
|
-
* @description:
|
|
184
|
+
* @summary: Create event subscriptions
|
|
185
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEventSubscriptionsById/).
|
|
200
186
|
*/
|
|
201
|
-
deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
187
|
+
deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
202
188
|
/**
|
|
203
189
|
* @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
|
|
204
190
|
* - Arg object
|
|
205
191
|
*
|
|
206
192
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
193
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
194
|
+
* @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
|
|
209
195
|
* @name deleteSmsProviderById
|
|
210
|
-
* @summary: Delete
|
|
211
|
-
* @description:
|
|
196
|
+
* @summary: Delete SMS provider by ID.
|
|
197
|
+
* @description: Remove a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
|
|
212
198
|
*/
|
|
213
|
-
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
199
|
+
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
|
|
214
200
|
/**
|
|
215
201
|
* @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg
|
|
216
202
|
* - Arg object
|
|
217
203
|
*
|
|
218
204
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
219
205
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
206
|
+
* @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
|
|
221
207
|
* @name deleteSmsTemplateById
|
|
222
|
-
* @summary: Delete
|
|
223
|
-
* @description:
|
|
208
|
+
* @summary: Delete SMS template by ID.
|
|
209
|
+
* @description: Remove a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
|
|
224
210
|
*/
|
|
225
|
-
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
211
|
+
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
|
|
226
212
|
/**
|
|
227
213
|
* @param {CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam} arg
|
|
228
214
|
* - Arg object
|
|
229
215
|
*
|
|
230
216
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
231
217
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
233
|
-
* - Success response
|
|
234
|
-
*
|
|
218
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
235
219
|
* @name editEventSubscriptions
|
|
236
|
-
* @summary:
|
|
237
|
-
* @description:
|
|
220
|
+
* @summary: Create event subscriptions
|
|
221
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/editEventSubscriptions/).
|
|
238
222
|
*/
|
|
239
|
-
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
223
|
+
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
240
224
|
/**
|
|
241
225
|
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
242
226
|
* - Arg object
|
|
@@ -245,8 +229,8 @@ declare class Communication {
|
|
|
245
229
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
230
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
247
231
|
* @name getAppProviders
|
|
248
|
-
* @summary: Get application providers
|
|
249
|
-
* @description: Retrieve a list of providers associated with the
|
|
232
|
+
* @summary: Get application providers.
|
|
233
|
+
* @description: Retrieve a list of providers associated with the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
|
|
250
234
|
*/
|
|
251
235
|
getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
252
236
|
/**
|
|
@@ -257,8 +241,8 @@ declare class Communication {
|
|
|
257
241
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
242
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
259
243
|
* @name getAudienceById
|
|
260
|
-
* @summary: Get
|
|
261
|
-
* @description:
|
|
244
|
+
* @summary: Get audience by ID.
|
|
245
|
+
* @description: Retrieve detailed information about a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
|
|
262
246
|
*/
|
|
263
247
|
getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
264
248
|
/**
|
|
@@ -269,34 +253,28 @@ declare class Communication {
|
|
|
269
253
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
254
|
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
271
255
|
* @name getAudiences
|
|
272
|
-
* @summary: Get
|
|
273
|
-
* @description:
|
|
256
|
+
* @summary: Get audiences.
|
|
257
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
|
|
274
258
|
*/
|
|
275
259
|
getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
276
260
|
/**
|
|
277
|
-
* @param {
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
* @param {
|
|
281
|
-
* @param {
|
|
282
|
-
* @
|
|
283
|
-
* @
|
|
284
|
-
* @summary: Get
|
|
285
|
-
* @description:
|
|
286
|
-
*/
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
* @returns {Promise<Object>} - Success response
|
|
295
|
-
* @name getBigQueryRowCountById
|
|
296
|
-
* @summary: Get BigQuery row count
|
|
297
|
-
* @description: Retrieves big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
|
|
298
|
-
*/
|
|
299
|
-
getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
261
|
+
* @param {Object} arg - Arg object.
|
|
262
|
+
* @param {string} arg.companyId - Company id
|
|
263
|
+
* @param {string} arg.applicationId - Application id
|
|
264
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
265
|
+
* @param {string} [arg.sort] - To sort based on created_at
|
|
266
|
+
* @param {string} [arg.query] - To search based on plain text
|
|
267
|
+
* @returns {Paginator<CommunicationPlatformModel.Audiences>}
|
|
268
|
+
* @summary: Get audiences.
|
|
269
|
+
* @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.
|
|
270
|
+
*/
|
|
271
|
+
getAudiencesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
272
|
+
companyId: string;
|
|
273
|
+
applicationId: string;
|
|
274
|
+
pageSize?: number;
|
|
275
|
+
sort?: string;
|
|
276
|
+
query?: string;
|
|
277
|
+
}): Paginator<CommunicationPlatformModel.Audiences>;
|
|
300
278
|
/**
|
|
301
279
|
* @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
|
|
302
280
|
* - Arg object
|
|
@@ -305,8 +283,8 @@ declare class Communication {
|
|
|
305
283
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
306
284
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
307
285
|
* @name getCampaignById
|
|
308
|
-
* @summary: Get
|
|
309
|
-
* @description:
|
|
286
|
+
* @summary: Get campaign by ID.
|
|
287
|
+
* @description: Retrieve detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
|
|
310
288
|
*/
|
|
311
289
|
getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
312
290
|
/**
|
|
@@ -317,8 +295,8 @@ declare class Communication {
|
|
|
317
295
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
318
296
|
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
319
297
|
* @name getCampaigns
|
|
320
|
-
* @summary: Get
|
|
321
|
-
* @description:
|
|
298
|
+
* @summary: Get campaigns.
|
|
299
|
+
* @description: Retrieve a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
322
300
|
*/
|
|
323
301
|
getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
324
302
|
/**
|
|
@@ -329,10 +307,41 @@ declare class Communication {
|
|
|
329
307
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
330
308
|
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
331
309
|
* @name getCommunicationLogs
|
|
332
|
-
* @summary: Get communication
|
|
333
|
-
* @description: Retrieve
|
|
310
|
+
* @summary: Get communication logs.
|
|
311
|
+
* @description: Retrieve logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
|
|
312
|
+
*/
|
|
313
|
+
getCommunicationLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
|
|
314
|
+
/**
|
|
315
|
+
* @param {Object} arg - Arg object.
|
|
316
|
+
* @param {string} arg.companyId - Company id
|
|
317
|
+
* @param {string} arg.applicationId - Application id
|
|
318
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
319
|
+
* @param {string} [arg.sort] - To sort based on created_at
|
|
320
|
+
* @param {Object} [arg.query] -
|
|
321
|
+
* @returns {Paginator<CommunicationPlatformModel.Logs>}
|
|
322
|
+
* @summary: Get communication logs.
|
|
323
|
+
* @description: Retrieve logs and records of communication activities.
|
|
334
324
|
*/
|
|
335
|
-
|
|
325
|
+
getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
326
|
+
companyId: string;
|
|
327
|
+
applicationId: string;
|
|
328
|
+
pageSize?: number;
|
|
329
|
+
sort?: string;
|
|
330
|
+
query?: any;
|
|
331
|
+
}): Paginator<CommunicationPlatformModel.Logs>;
|
|
332
|
+
/**
|
|
333
|
+
* @param {CommunicationPlatformApplicationValidator.GetDefaultEmailProvidersParam} arg
|
|
334
|
+
* - Arg object
|
|
335
|
+
*
|
|
336
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
337
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
338
|
+
* @returns {Promise<CommunicationPlatformModel.DefaultEmailProviders[]>} -
|
|
339
|
+
* Success response
|
|
340
|
+
* @name getDefaultEmailProviders
|
|
341
|
+
* @summary: Get app providers.
|
|
342
|
+
* @description: Retrieve a list of app providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultEmailProviders/).
|
|
343
|
+
*/
|
|
344
|
+
getDefaultEmailProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultEmailProviders[]>;
|
|
336
345
|
/**
|
|
337
346
|
* @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg
|
|
338
347
|
* - Arg object
|
|
@@ -342,8 +351,8 @@ declare class Communication {
|
|
|
342
351
|
* @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
|
|
343
352
|
* Success response
|
|
344
353
|
* @name getDefaultSmsProviders
|
|
345
|
-
* @summary: Get
|
|
346
|
-
* @description: Retrieve
|
|
354
|
+
* @summary: Get default SMS providers.
|
|
355
|
+
* @description: Retrieve the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
|
|
347
356
|
*/
|
|
348
357
|
getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
|
|
349
358
|
/**
|
|
@@ -355,8 +364,8 @@ declare class Communication {
|
|
|
355
364
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
|
|
356
365
|
* Success response
|
|
357
366
|
* @name getDummyDatasources
|
|
358
|
-
* @summary: Get dummy data sources
|
|
359
|
-
* @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
|
|
367
|
+
* @summary: Get dummy data sources.
|
|
368
|
+
* @description: Retrieve a list of dummy data sources for testing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
|
|
360
369
|
*/
|
|
361
370
|
getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
|
|
362
371
|
/**
|
|
@@ -368,7 +377,7 @@ declare class Communication {
|
|
|
368
377
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
|
|
369
378
|
* Success response
|
|
370
379
|
* @name getDummyDatasourcesMeta
|
|
371
|
-
* @summary: Get dummy data sources metadata
|
|
380
|
+
* @summary: Get dummy data sources metadata.
|
|
372
381
|
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
373
382
|
*/
|
|
374
383
|
getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
|
|
@@ -380,8 +389,8 @@ declare class Communication {
|
|
|
380
389
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
381
390
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
382
391
|
* @name getEmailProviderById
|
|
383
|
-
* @summary: Get
|
|
384
|
-
* @description:
|
|
392
|
+
* @summary: Get email provider by ID.
|
|
393
|
+
* @description: Retrieve detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
|
|
385
394
|
*/
|
|
386
395
|
getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
387
396
|
/**
|
|
@@ -392,10 +401,28 @@ declare class Communication {
|
|
|
392
401
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
393
402
|
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
394
403
|
* @name getEmailProviders
|
|
395
|
-
* @summary: Get
|
|
396
|
-
* @description:
|
|
404
|
+
* @summary: Get email providers.
|
|
405
|
+
* @description: Retrieve a list of email communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
397
406
|
*/
|
|
398
407
|
getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
408
|
+
/**
|
|
409
|
+
* @param {Object} arg - Arg object.
|
|
410
|
+
* @param {string} arg.companyId - Company id
|
|
411
|
+
* @param {string} arg.applicationId - Application id
|
|
412
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
413
|
+
* @param {string} [arg.sort] - To sort based on created_at
|
|
414
|
+
* @param {string} [arg.query] - To search based on plain text
|
|
415
|
+
* @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
|
|
416
|
+
* @summary: Get email providers.
|
|
417
|
+
* @description: Retrieve a list of email communication providers.
|
|
418
|
+
*/
|
|
419
|
+
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
420
|
+
companyId: string;
|
|
421
|
+
applicationId: string;
|
|
422
|
+
pageSize?: number;
|
|
423
|
+
sort?: string;
|
|
424
|
+
query?: string;
|
|
425
|
+
}): Paginator<CommunicationPlatformModel.EmailProviders>;
|
|
399
426
|
/**
|
|
400
427
|
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
|
|
401
428
|
* - Arg object
|
|
@@ -404,8 +431,8 @@ declare class Communication {
|
|
|
404
431
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
405
432
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
406
433
|
* @name getEmailTemplateById
|
|
407
|
-
* @summary: Get
|
|
408
|
-
* @description:
|
|
434
|
+
* @summary: Get email template by ID.
|
|
435
|
+
* @description: Retrieve detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
|
|
409
436
|
*/
|
|
410
437
|
getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
411
438
|
/**
|
|
@@ -416,10 +443,28 @@ declare class Communication {
|
|
|
416
443
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
417
444
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
418
445
|
* @name getEmailTemplates
|
|
419
|
-
* @summary: Get
|
|
420
|
-
* @description:
|
|
446
|
+
* @summary: Get email templates.
|
|
447
|
+
* @description: Retrieve a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
|
|
421
448
|
*/
|
|
422
449
|
getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
450
|
+
/**
|
|
451
|
+
* @param {Object} arg - Arg object.
|
|
452
|
+
* @param {string} arg.companyId - Company id
|
|
453
|
+
* @param {string} arg.applicationId - Application id
|
|
454
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
455
|
+
* @param {string} [arg.sort] - To sort based on created_at
|
|
456
|
+
* @param {string} [arg.query] - To search based on plain text
|
|
457
|
+
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
458
|
+
* @summary: Get email templates.
|
|
459
|
+
* @description: Retrieve a list of available email communication templates.
|
|
460
|
+
*/
|
|
461
|
+
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
462
|
+
companyId: string;
|
|
463
|
+
applicationId: string;
|
|
464
|
+
pageSize?: number;
|
|
465
|
+
sort?: string;
|
|
466
|
+
query?: string;
|
|
467
|
+
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
423
468
|
/**
|
|
424
469
|
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
|
|
425
470
|
* - Arg object
|
|
@@ -429,10 +474,26 @@ declare class Communication {
|
|
|
429
474
|
* @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
|
|
430
475
|
* Success response
|
|
431
476
|
* @name getEventSubscriptions
|
|
432
|
-
* @summary: Get
|
|
433
|
-
* @description:
|
|
477
|
+
* @summary: Get event subscriptions.
|
|
478
|
+
* @description: Retrieve a list of event subscriptions related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
|
|
434
479
|
*/
|
|
435
480
|
getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
481
|
+
/**
|
|
482
|
+
* @param {Object} arg - Arg object.
|
|
483
|
+
* @param {string} arg.companyId - Company id
|
|
484
|
+
* @param {string} arg.applicationId - Application id
|
|
485
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
486
|
+
* @param {string} [arg.populate] - Populate Fields
|
|
487
|
+
* @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
|
|
488
|
+
* @summary: Get event subscriptions.
|
|
489
|
+
* @description: Retrieve a list of event subscriptions related to communication.
|
|
490
|
+
*/
|
|
491
|
+
getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
|
|
492
|
+
companyId: string;
|
|
493
|
+
applicationId: string;
|
|
494
|
+
pageSize?: number;
|
|
495
|
+
populate?: string;
|
|
496
|
+
}): Paginator<CommunicationPlatformModel.EventSubscriptions>;
|
|
436
497
|
/**
|
|
437
498
|
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
|
|
438
499
|
* - Arg object
|
|
@@ -441,8 +502,8 @@ declare class Communication {
|
|
|
441
502
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
442
503
|
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
443
504
|
* @name getEventSubscriptionsById
|
|
444
|
-
* @summary: Get
|
|
445
|
-
* @description:
|
|
505
|
+
* @summary: Get event subscriptions by id
|
|
506
|
+
* @description: Get event subscriptions by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptionsById/).
|
|
446
507
|
*/
|
|
447
508
|
getEventSubscriptionsById({ id, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
448
509
|
/**
|
|
@@ -453,8 +514,8 @@ declare class Communication {
|
|
|
453
514
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
454
515
|
* @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
|
|
455
516
|
* @name getGlobalProviders
|
|
456
|
-
* @summary: Get global providers
|
|
457
|
-
* @description: Retrieve a list of global communication providers
|
|
517
|
+
* @summary: Get global providers.
|
|
518
|
+
* @description: Retrieve a list of global communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
|
|
458
519
|
*/
|
|
459
520
|
getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
|
|
460
521
|
/**
|
|
@@ -463,34 +524,70 @@ declare class Communication {
|
|
|
463
524
|
*
|
|
464
525
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
465
526
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
466
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
527
|
+
* @returns {Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>}
|
|
467
528
|
* - Success response
|
|
468
529
|
*
|
|
469
530
|
* @name getGlobalVariables
|
|
470
|
-
* @summary: Get
|
|
471
|
-
* @description:
|
|
531
|
+
* @summary: Get global variables.
|
|
532
|
+
* @description: Retrieve global variables used in communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
|
|
472
533
|
*/
|
|
473
|
-
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
534
|
+
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>;
|
|
474
535
|
/**
|
|
475
536
|
* @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
|
|
476
537
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
477
538
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
478
539
|
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
479
540
|
* @name getJobLogs
|
|
480
|
-
* @summary: Get logs
|
|
481
|
-
* @description: Retrieve logs and details related to
|
|
541
|
+
* @summary: Get job logs.
|
|
542
|
+
* @description: Retrieve logs and details related to communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
482
543
|
*/
|
|
483
544
|
getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
545
|
+
/**
|
|
546
|
+
* @param {Object} arg - Arg object.
|
|
547
|
+
* @param {string} arg.companyId - Company id
|
|
548
|
+
* @param {string} arg.applicationId - Application id
|
|
549
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
550
|
+
* @param {string} [arg.sort] - To sort based on created_at
|
|
551
|
+
* @param {string} [arg.query] - To search based on plain text
|
|
552
|
+
* @returns {Paginator<CommunicationPlatformModel.JobLogs>}
|
|
553
|
+
* @summary: Get job logs.
|
|
554
|
+
* @description: Retrieve logs and details related to communication jobs.
|
|
555
|
+
*/
|
|
556
|
+
getJobLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
557
|
+
companyId: string;
|
|
558
|
+
applicationId: string;
|
|
559
|
+
pageSize?: number;
|
|
560
|
+
sort?: string;
|
|
561
|
+
query?: string;
|
|
562
|
+
}): Paginator<CommunicationPlatformModel.JobLogs>;
|
|
484
563
|
/**
|
|
485
564
|
* @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
|
|
486
565
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
487
566
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
488
567
|
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
489
568
|
* @name getJobs
|
|
490
|
-
* @summary: Get
|
|
491
|
-
* @description:
|
|
569
|
+
* @summary: Get jobs.
|
|
570
|
+
* @description: Retrieve a list of communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
492
571
|
*/
|
|
493
572
|
getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
573
|
+
/**
|
|
574
|
+
* @param {Object} arg - Arg object.
|
|
575
|
+
* @param {string} arg.companyId - Company id
|
|
576
|
+
* @param {string} arg.applicationId - Application id
|
|
577
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
578
|
+
* @param {string} [arg.sort] - To sort based on created_at
|
|
579
|
+
* @param {string} [arg.query] - To search based on plain text
|
|
580
|
+
* @returns {Paginator<CommunicationPlatformModel.Jobs>}
|
|
581
|
+
* @summary: Get jobs.
|
|
582
|
+
* @description: Retrieve a list of communication jobs.
|
|
583
|
+
*/
|
|
584
|
+
getJobsPaginator({ companyId, applicationId, pageSize, sort, query }?: {
|
|
585
|
+
companyId: string;
|
|
586
|
+
applicationId: string;
|
|
587
|
+
pageSize?: number;
|
|
588
|
+
sort?: string;
|
|
589
|
+
query?: string;
|
|
590
|
+
}): Paginator<CommunicationPlatformModel.Jobs>;
|
|
494
591
|
/**
|
|
495
592
|
* @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
|
|
496
593
|
* - Arg object
|
|
@@ -499,7 +596,7 @@ declare class Communication {
|
|
|
499
596
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
500
597
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
501
598
|
* @name getNSampleRecordsFromCsv
|
|
502
|
-
* @summary: Get N sample records
|
|
599
|
+
* @summary: Get N sample records from CSV.
|
|
503
600
|
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsv/).
|
|
504
601
|
*/
|
|
505
602
|
getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
@@ -511,10 +608,10 @@ declare class Communication {
|
|
|
511
608
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
512
609
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
513
610
|
* @name getNSampleRecordsFromCsvByGet
|
|
514
|
-
* @summary: Get N sample records
|
|
515
|
-
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
611
|
+
* @summary: Get N sample records in CSV
|
|
612
|
+
* @description: Retrieve a specified number of sample records from a CSV data source using a GET request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
516
613
|
*/
|
|
517
|
-
getNSampleRecordsFromCsvByGet({ requestHeaders }?:
|
|
614
|
+
getNSampleRecordsFromCsvByGet({ count, header, url, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvByGetParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
518
615
|
/**
|
|
519
616
|
* @param {CommunicationPlatformApplicationValidator.GetOtpConfigurationParam} arg
|
|
520
617
|
* - Arg object
|
|
@@ -523,8 +620,8 @@ declare class Communication {
|
|
|
523
620
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
524
621
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
525
622
|
* @name getOtpConfiguration
|
|
526
|
-
* @summary: Get configuration
|
|
527
|
-
* @description:
|
|
623
|
+
* @summary: Get otp-configuration, if not present in db then return default settings
|
|
624
|
+
* @description: Get otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getOtpConfiguration/).
|
|
528
625
|
*/
|
|
529
626
|
getOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
530
627
|
/**
|
|
@@ -533,24 +630,24 @@ declare class Communication {
|
|
|
533
630
|
*
|
|
534
631
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
535
632
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
536
|
-
* @returns {Promise<
|
|
633
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
|
|
537
634
|
* @name getSmsProviderById
|
|
538
|
-
* @summary: Get
|
|
635
|
+
* @summary: Get SMS provider by ID.
|
|
539
636
|
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
|
|
540
637
|
*/
|
|
541
|
-
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<
|
|
638
|
+
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProvider>;
|
|
542
639
|
/**
|
|
543
640
|
* @param {CommunicationPlatformApplicationValidator.GetSmsProvidersParam} arg
|
|
544
641
|
* - Arg object
|
|
545
642
|
*
|
|
546
643
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
547
644
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
548
|
-
* @returns {Promise<
|
|
645
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProviders>} - Success response
|
|
549
646
|
* @name getSmsProviders
|
|
550
|
-
* @summary: Get
|
|
551
|
-
* @description:
|
|
647
|
+
* @summary: Get SMS providers.
|
|
648
|
+
* @description: Retrieve a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
|
|
552
649
|
*/
|
|
553
|
-
getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<
|
|
650
|
+
getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProviders>;
|
|
554
651
|
/**
|
|
555
652
|
* @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
|
|
556
653
|
* - Arg object
|
|
@@ -559,8 +656,8 @@ declare class Communication {
|
|
|
559
656
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
560
657
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
561
658
|
* @name getSmsTemplateById
|
|
562
|
-
* @summary: Get
|
|
563
|
-
* @description:
|
|
659
|
+
* @summary: Get SMS template by ID.
|
|
660
|
+
* @description: Retrieve detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
|
|
564
661
|
*/
|
|
565
662
|
getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
566
663
|
/**
|
|
@@ -571,10 +668,28 @@ declare class Communication {
|
|
|
571
668
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
572
669
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
573
670
|
* @name getSmsTemplates
|
|
574
|
-
* @summary: Get
|
|
575
|
-
* @description: Retrieve a list of
|
|
671
|
+
* @summary: Get SMS templates.
|
|
672
|
+
* @description: Retrieve a list of available SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
|
|
576
673
|
*/
|
|
577
674
|
getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
675
|
+
/**
|
|
676
|
+
* @param {Object} arg - Arg object.
|
|
677
|
+
* @param {string} arg.companyId - Company id
|
|
678
|
+
* @param {string} arg.applicationId - Application id
|
|
679
|
+
* @param {number} [arg.pageSize] - Current request items count
|
|
680
|
+
* @param {string} [arg.sort] - To sort based on created_at
|
|
681
|
+
* @param {string} [arg.query] - To search based on plain text
|
|
682
|
+
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
683
|
+
* @summary: Get SMS templates.
|
|
684
|
+
* @description: Retrieve a list of available SMS communication templates.
|
|
685
|
+
*/
|
|
686
|
+
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
687
|
+
companyId: string;
|
|
688
|
+
applicationId: string;
|
|
689
|
+
pageSize?: number;
|
|
690
|
+
sort?: string;
|
|
691
|
+
query?: string;
|
|
692
|
+
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
578
693
|
/**
|
|
579
694
|
* @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
|
|
580
695
|
* - Arg object
|
|
@@ -583,8 +698,8 @@ declare class Communication {
|
|
|
583
698
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
584
699
|
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
585
700
|
* @name getStatsOfCampaignById
|
|
586
|
-
* @summary: Get campaign statistics
|
|
587
|
-
* @description:
|
|
701
|
+
* @summary: Get campaign statistics by ID.
|
|
702
|
+
* @description: Retrieve statistical data for a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
|
|
588
703
|
*/
|
|
589
704
|
getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
|
|
590
705
|
/**
|
|
@@ -593,49 +708,40 @@ declare class Communication {
|
|
|
593
708
|
*
|
|
594
709
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
595
710
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
596
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
711
|
+
* @returns {Promise<CommunicationPlatformModel.SubscribedEmailTemplates>}
|
|
712
|
+
* - Success response
|
|
713
|
+
*
|
|
597
714
|
* @name getSubscribedEmailTemplates
|
|
598
|
-
* @summary: Get
|
|
599
|
-
* @description:
|
|
715
|
+
* @summary: Get subscribed email templates.
|
|
716
|
+
* @description: Retrieve email communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
600
717
|
*/
|
|
601
|
-
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
718
|
+
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SubscribedEmailTemplates>;
|
|
602
719
|
/**
|
|
603
720
|
* @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
|
|
604
721
|
* - Arg object
|
|
605
722
|
*
|
|
606
723
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
607
724
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
608
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
725
|
+
* @returns {Promise<CommunicationPlatformModel.SubscribedSmsTemplates>} -
|
|
726
|
+
* Success response
|
|
609
727
|
* @name getSubscribedSmsTemplates
|
|
610
|
-
* @summary: Get
|
|
611
|
-
* @description: Retrieve
|
|
612
|
-
*/
|
|
613
|
-
getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
614
|
-
/**
|
|
615
|
-
* @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
|
|
616
|
-
* - Arg object
|
|
617
|
-
*
|
|
618
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
619
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
620
|
-
* @returns {Promise<Object>} - Success response
|
|
621
|
-
* @name getSystemAudiences
|
|
622
|
-
* @summary: Get system audiences
|
|
623
|
-
* @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
|
|
728
|
+
* @summary: Get subscribed SMS templates.
|
|
729
|
+
* @description: Retrieve SMS communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
624
730
|
*/
|
|
625
|
-
|
|
731
|
+
getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SubscribedSmsTemplates>;
|
|
626
732
|
/**
|
|
627
733
|
* @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
|
|
628
734
|
* - Arg object
|
|
629
735
|
*
|
|
630
736
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
631
737
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
632
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
738
|
+
* @returns {Promise<CommunicationPlatformModel.SystemEmailTemplate[]>} -
|
|
633
739
|
* Success response
|
|
634
740
|
* @name getSystemEmailTemplates
|
|
635
|
-
* @summary: Get
|
|
636
|
-
* @description:
|
|
741
|
+
* @summary: Get system email templates.
|
|
742
|
+
* @description: Retrieve system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
|
|
637
743
|
*/
|
|
638
|
-
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
744
|
+
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplate[]>;
|
|
639
745
|
/**
|
|
640
746
|
* @param {CommunicationPlatformApplicationValidator.GetSystemSmsTemplatesParam} arg
|
|
641
747
|
* - Arg object
|
|
@@ -645,8 +751,8 @@ declare class Communication {
|
|
|
645
751
|
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
|
|
646
752
|
* Success response
|
|
647
753
|
* @name getSystemSmsTemplates
|
|
648
|
-
* @summary:
|
|
649
|
-
* @description:
|
|
754
|
+
* @summary: Get system SMS templates.
|
|
755
|
+
* @description: Retrieve system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
|
|
650
756
|
*/
|
|
651
757
|
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates[]>;
|
|
652
758
|
/**
|
|
@@ -655,60 +761,75 @@ declare class Communication {
|
|
|
655
761
|
*
|
|
656
762
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
657
763
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
658
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
764
|
+
* @returns {Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>}
|
|
659
765
|
* - Success response
|
|
660
766
|
*
|
|
661
767
|
* @name postGlobalVariables
|
|
662
|
-
* @summary:
|
|
663
|
-
* @description:
|
|
768
|
+
* @summary: Post global variables.
|
|
769
|
+
* @description: Update and post global variables for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
|
|
664
770
|
*/
|
|
665
|
-
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
771
|
+
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>;
|
|
666
772
|
/**
|
|
667
773
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
|
|
668
774
|
* - Arg object
|
|
669
775
|
*
|
|
670
776
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
671
777
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
672
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
778
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
673
779
|
* @name sendCommunicationAsynchronously
|
|
674
|
-
* @summary: Send communication asynchronously
|
|
675
|
-
* @description:
|
|
780
|
+
* @summary: Send communication asynchronously.
|
|
781
|
+
* @description: Initiate and send communication with the option for asynchronous processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
676
782
|
*/
|
|
677
|
-
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
783
|
+
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
|
|
678
784
|
/**
|
|
679
785
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
|
|
680
786
|
* - Arg object
|
|
681
787
|
*
|
|
682
788
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
683
789
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
684
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
790
|
+
* @returns {Promise<CommunicationPlatformModel.SendInstantResponse>} -
|
|
791
|
+
* Success response
|
|
685
792
|
* @name sendCommunicationSynchronously
|
|
686
|
-
* @summary: Send communication synchronously
|
|
687
|
-
* @description:
|
|
793
|
+
* @summary: Send communication synchronously.
|
|
794
|
+
* @description: Initiate and send communication in real-time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
795
|
+
*/
|
|
796
|
+
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendInstantResponse>;
|
|
797
|
+
/**
|
|
798
|
+
* @param {CommunicationPlatformApplicationValidator.SendEngineCommunicationSynchronouslyParam} arg
|
|
799
|
+
* - Arg object
|
|
800
|
+
*
|
|
801
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
802
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
803
|
+
* @returns {Promise<CommunicationPlatformModel.SendInstantResponse>} -
|
|
804
|
+
* Success response
|
|
805
|
+
* @name sendEngineCommunicationSynchronously
|
|
806
|
+
* @summary: Send communication asynchronously.
|
|
807
|
+
* @description: Initiate and send communication with the option for asynchronous processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendEngineCommunicationSynchronously/).
|
|
688
808
|
*/
|
|
689
|
-
|
|
809
|
+
sendEngineCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendEngineCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendInstantResponse>;
|
|
690
810
|
/**
|
|
691
811
|
* @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
|
|
692
812
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
693
813
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
694
814
|
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
695
815
|
* @name sendOtp
|
|
696
|
-
* @summary: Send OTP
|
|
697
|
-
* @description:
|
|
816
|
+
* @summary: Send OTP.
|
|
817
|
+
* @description: Send a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
|
|
698
818
|
*/
|
|
699
|
-
sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
819
|
+
sendOtp({ body, ci, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
700
820
|
/**
|
|
701
821
|
* @param {CommunicationPlatformApplicationValidator.TriggerCampaignJobParam} arg
|
|
702
822
|
* - Arg object
|
|
703
823
|
*
|
|
704
824
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
705
825
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
706
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
826
|
+
* @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
|
|
827
|
+
* Success response
|
|
707
828
|
* @name triggerCampaignJob
|
|
708
|
-
* @summary: Trigger
|
|
709
|
-
* @description:
|
|
829
|
+
* @summary: Trigger campaign job.
|
|
830
|
+
* @description: Initiate a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
|
|
710
831
|
*/
|
|
711
|
-
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
832
|
+
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResponse>;
|
|
712
833
|
/**
|
|
713
834
|
* @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg
|
|
714
835
|
* - Arg object
|
|
@@ -717,10 +838,24 @@ declare class Communication {
|
|
|
717
838
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
718
839
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
719
840
|
* @name updateAppProviders
|
|
720
|
-
* @summary: Update application providers
|
|
721
|
-
* @description: Modify provider
|
|
841
|
+
* @summary: Update application providers.
|
|
842
|
+
* @description: Modify provider information for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
|
|
722
843
|
*/
|
|
723
844
|
updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
845
|
+
/**
|
|
846
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersGlobalProviderParam} arg
|
|
847
|
+
* - Arg object
|
|
848
|
+
*
|
|
849
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
850
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
851
|
+
* @returns {Promise<CommunicationPlatformModel.UpdateAppProvidersGlobalProviderResponse>}
|
|
852
|
+
* - Success response
|
|
853
|
+
*
|
|
854
|
+
* @name updateAppProvidersGlobalProvider
|
|
855
|
+
* @summary: Get global app providers.
|
|
856
|
+
* @description: Retrieve a list of global app providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProvidersGlobalProvider/).
|
|
857
|
+
*/
|
|
858
|
+
updateAppProvidersGlobalProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersGlobalProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.UpdateAppProvidersGlobalProviderResponse>;
|
|
724
859
|
/**
|
|
725
860
|
* @param {CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam} arg
|
|
726
861
|
* - Arg object
|
|
@@ -729,8 +864,8 @@ declare class Communication {
|
|
|
729
864
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
730
865
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
731
866
|
* @name updateAudienceById
|
|
732
|
-
* @summary: Update
|
|
733
|
-
* @description: Modify the
|
|
867
|
+
* @summary: Update audience by ID.
|
|
868
|
+
* @description: Modify the settings of a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
|
|
734
869
|
*/
|
|
735
870
|
updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
736
871
|
/**
|
|
@@ -741,8 +876,8 @@ declare class Communication {
|
|
|
741
876
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
742
877
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
743
878
|
* @name updateCampaignById
|
|
744
|
-
* @summary: Update
|
|
745
|
-
* @description: Modify the
|
|
879
|
+
* @summary: Update campaign by ID.
|
|
880
|
+
* @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
|
|
746
881
|
*/
|
|
747
882
|
updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
748
883
|
/**
|
|
@@ -753,8 +888,8 @@ declare class Communication {
|
|
|
753
888
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
754
889
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
755
890
|
* @name updateEmailProviderById
|
|
756
|
-
* @summary: Update email provider
|
|
757
|
-
* @description:
|
|
891
|
+
* @summary: Update email provider by ID.
|
|
892
|
+
* @description: Modify the settings of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
|
|
758
893
|
*/
|
|
759
894
|
updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
760
895
|
/**
|
|
@@ -765,8 +900,8 @@ declare class Communication {
|
|
|
765
900
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
766
901
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
767
902
|
* @name updateEmailTemplateById
|
|
768
|
-
* @summary: Update
|
|
769
|
-
* @description:
|
|
903
|
+
* @summary: Update email template by ID.
|
|
904
|
+
* @description: Modify the content and settings of a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
|
|
770
905
|
*/
|
|
771
906
|
updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
772
907
|
/**
|
|
@@ -777,22 +912,22 @@ declare class Communication {
|
|
|
777
912
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
778
913
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
779
914
|
* @name updateOtpConfiguration
|
|
780
|
-
* @summary: Update
|
|
781
|
-
* @description:
|
|
915
|
+
* @summary: Update/insert otp configurations
|
|
916
|
+
* @description: Update otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateOtpConfiguration/).
|
|
782
917
|
*/
|
|
783
|
-
updateOtpConfiguration({ requestHeaders }?:
|
|
918
|
+
updateOtpConfiguration({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateOtpConfigurationParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
784
919
|
/**
|
|
785
920
|
* @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
|
|
786
921
|
* - Arg object
|
|
787
922
|
*
|
|
788
923
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
789
924
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
790
|
-
* @returns {Promise<
|
|
925
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
|
|
791
926
|
* @name updateSmsProviderById
|
|
792
|
-
* @summary: Update SMS provider
|
|
793
|
-
* @description:
|
|
927
|
+
* @summary: Update SMS provider by ID.
|
|
928
|
+
* @description: Modify specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
|
|
794
929
|
*/
|
|
795
|
-
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<
|
|
930
|
+
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsProvider>;
|
|
796
931
|
/**
|
|
797
932
|
* @param {CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam} arg
|
|
798
933
|
* - Arg object
|
|
@@ -801,8 +936,8 @@ declare class Communication {
|
|
|
801
936
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
802
937
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
803
938
|
* @name updateSmsTemplateById
|
|
804
|
-
* @summary: Update
|
|
805
|
-
* @description:
|
|
939
|
+
* @summary: Update SMS template by ID.
|
|
940
|
+
* @description: Modify the content and settings of a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
|
|
806
941
|
*/
|
|
807
942
|
updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
808
943
|
/**
|
|
@@ -813,10 +948,11 @@ declare class Communication {
|
|
|
813
948
|
* - Success response
|
|
814
949
|
*
|
|
815
950
|
* @name verfiyOtp
|
|
816
|
-
* @summary: Verify OTP
|
|
817
|
-
* @description:
|
|
951
|
+
* @summary: Verify OTP.
|
|
952
|
+
* @description: Verify the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
|
|
818
953
|
*/
|
|
819
954
|
verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
|
|
820
955
|
}
|
|
821
956
|
import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator");
|
|
822
957
|
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
958
|
+
import Paginator = require("../../common/Paginator");
|