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