@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.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 +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
- package/sdk/application/Cart/CartApplicationClient.js +157 -530
- 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 +65 -55
- package/sdk/application/Content/ContentApplicationClient.js +211 -341
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
- 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 +32 -87
- package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
- 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 +18 -62
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
- 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 +15 -406
- package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
- package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
- package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
- package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
- 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 +236 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
- 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 +314 -422
- package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
- 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 -68
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
- 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 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
- 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 +565 -1282
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
- 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 -246
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
- 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 +2374 -877
- package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
- 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 +421 -418
- package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
- package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
- 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 +934 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -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 +1327 -3529
- package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
- 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 -513
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
- 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 -4
- package/sdk/platform/Share/SharePlatformModel.js +45 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
- 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 -2
- package/sdk/public/PublicClient.js +2 -2
- 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 -1
- package/sdk/public/index.js +1 -1
- 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
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -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,14 +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>}
|
|
73
97
|
* - Success response
|
|
74
98
|
*
|
|
75
99
|
* @name createEventSubscriptions
|
|
76
|
-
* @summary: Create event
|
|
77
|
-
* @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/).
|
|
78
102
|
*/
|
|
79
|
-
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
103
|
+
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
80
104
|
/**
|
|
81
105
|
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg
|
|
82
106
|
* - Arg object
|
|
@@ -84,23 +108,23 @@ declare class Communication {
|
|
|
84
108
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
110
|
* @returns {Promise<
|
|
87
|
-
* CommunicationPlatformModel.
|
|
111
|
+
* CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]
|
|
88
112
|
* >}
|
|
89
113
|
* - Success response
|
|
90
114
|
*
|
|
91
115
|
* @name createEventSubscriptionsByBulk
|
|
92
|
-
* @summary: Create event subscriptions
|
|
93
|
-
* @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/).
|
|
94
118
|
*/
|
|
95
|
-
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
119
|
+
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]>;
|
|
96
120
|
/**
|
|
97
121
|
* @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object
|
|
98
122
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
123
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
124
|
* @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
|
|
101
125
|
* @name createJobs
|
|
102
|
-
* @summary: Create jobs
|
|
103
|
-
* @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/).
|
|
104
128
|
*/
|
|
105
129
|
createJobs({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateJobsRes>;
|
|
106
130
|
/**
|
|
@@ -109,12 +133,12 @@ declare class Communication {
|
|
|
109
133
|
*
|
|
110
134
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
111
135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
112
|
-
* @returns {Promise<
|
|
136
|
+
* @returns {Promise<Object>} - Success response
|
|
113
137
|
* @name createSmsProvider
|
|
114
|
-
* @summary: Create SMS provider
|
|
115
|
-
* @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/).
|
|
116
140
|
*/
|
|
117
|
-
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<
|
|
141
|
+
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
|
|
118
142
|
/**
|
|
119
143
|
* @param {CommunicationPlatformApplicationValidator.CreateSmsTemplateParam} arg
|
|
120
144
|
* - Arg object
|
|
@@ -123,8 +147,8 @@ declare class Communication {
|
|
|
123
147
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
148
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
125
149
|
* @name createSmsTemplate
|
|
126
|
-
* @summary: Create SMS template
|
|
127
|
-
* @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/).
|
|
128
152
|
*/
|
|
129
153
|
createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
130
154
|
/**
|
|
@@ -133,98 +157,86 @@ declare class Communication {
|
|
|
133
157
|
*
|
|
134
158
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
135
159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
136
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
160
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
137
161
|
* @name deleteAudienceById
|
|
138
|
-
* @summary: Delete audience
|
|
139
|
-
* @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/).
|
|
140
164
|
*/
|
|
141
|
-
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
142
|
-
/**
|
|
143
|
-
* @param {CommunicationPlatformApplicationValidator.DeleteCampaignByIdParam} arg
|
|
144
|
-
* - Arg object
|
|
145
|
-
*
|
|
146
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
147
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
148
|
-
* @returns {Promise<CommunicationPlatformModel.BasicDelete>} - Success response
|
|
149
|
-
* @name deleteCampaignById
|
|
150
|
-
* @summary: Update campaign by ID.
|
|
151
|
-
* @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteCampaignById/).
|
|
152
|
-
*/
|
|
153
|
-
deleteCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.BasicDelete>;
|
|
165
|
+
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
154
166
|
/**
|
|
155
167
|
* @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg
|
|
156
168
|
* - Arg object
|
|
157
169
|
*
|
|
158
170
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
159
171
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
172
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
161
173
|
* @name deleteEmailProviderById
|
|
162
|
-
* @summary: Delete email provider
|
|
163
|
-
* @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/).
|
|
164
176
|
*/
|
|
165
|
-
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
177
|
+
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
166
178
|
/**
|
|
167
179
|
* @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg
|
|
168
180
|
* - Arg object
|
|
169
181
|
*
|
|
170
182
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
171
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
172
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
184
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
173
185
|
* @name deleteEmailTemplateById
|
|
174
|
-
* @summary: Delete email template
|
|
175
|
-
* @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/).
|
|
176
188
|
*/
|
|
177
|
-
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
189
|
+
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
178
190
|
/**
|
|
179
191
|
* @param {CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam} arg
|
|
180
192
|
* - Arg object
|
|
181
193
|
*
|
|
182
194
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
195
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
196
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
185
197
|
* @name deleteEventSubscriptionsById
|
|
186
|
-
* @summary:
|
|
187
|
-
* @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/).
|
|
188
200
|
*/
|
|
189
|
-
deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
201
|
+
deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
190
202
|
/**
|
|
191
203
|
* @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
|
|
192
204
|
* - Arg object
|
|
193
205
|
*
|
|
194
206
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
207
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
208
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
197
209
|
* @name deleteSmsProviderById
|
|
198
|
-
* @summary: Delete SMS provider
|
|
199
|
-
* @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/).
|
|
200
212
|
*/
|
|
201
|
-
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
213
|
+
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
202
214
|
/**
|
|
203
215
|
* @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg
|
|
204
216
|
* - Arg object
|
|
205
217
|
*
|
|
206
218
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
219
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
220
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
209
221
|
* @name deleteSmsTemplateById
|
|
210
|
-
* @summary: Delete SMS template
|
|
211
|
-
* @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/).
|
|
212
224
|
*/
|
|
213
|
-
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
225
|
+
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
214
226
|
/**
|
|
215
227
|
* @param {CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam} arg
|
|
216
228
|
* - Arg object
|
|
217
229
|
*
|
|
218
230
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
219
231
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
232
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
|
|
221
233
|
* - Success response
|
|
222
234
|
*
|
|
223
235
|
* @name editEventSubscriptions
|
|
224
|
-
* @summary:
|
|
225
|
-
* @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/).
|
|
226
238
|
*/
|
|
227
|
-
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
239
|
+
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
228
240
|
/**
|
|
229
241
|
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
230
242
|
* - Arg object
|
|
@@ -233,8 +245,8 @@ declare class Communication {
|
|
|
233
245
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
234
246
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
235
247
|
* @name getAppProviders
|
|
236
|
-
* @summary: Get application providers
|
|
237
|
-
* @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/).
|
|
238
250
|
*/
|
|
239
251
|
getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
240
252
|
/**
|
|
@@ -245,8 +257,8 @@ declare class Communication {
|
|
|
245
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
258
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
247
259
|
* @name getAudienceById
|
|
248
|
-
* @summary: Get audience
|
|
249
|
-
* @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/).
|
|
250
262
|
*/
|
|
251
263
|
getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
252
264
|
/**
|
|
@@ -257,28 +269,34 @@ declare class Communication {
|
|
|
257
269
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
270
|
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
259
271
|
* @name getAudiences
|
|
260
|
-
* @summary: Get audiences
|
|
261
|
-
* @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/).
|
|
262
274
|
*/
|
|
263
275
|
getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
264
276
|
/**
|
|
265
|
-
* @param {
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
* @param {
|
|
269
|
-
* @param {
|
|
270
|
-
* @
|
|
271
|
-
* @
|
|
272
|
-
* @summary: Get
|
|
273
|
-
* @description:
|
|
274
|
-
*/
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
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>;
|
|
282
300
|
/**
|
|
283
301
|
* @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
|
|
284
302
|
* - Arg object
|
|
@@ -287,8 +305,8 @@ declare class Communication {
|
|
|
287
305
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
288
306
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
289
307
|
* @name getCampaignById
|
|
290
|
-
* @summary: Get campaign
|
|
291
|
-
* @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/).
|
|
292
310
|
*/
|
|
293
311
|
getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
294
312
|
/**
|
|
@@ -299,8 +317,8 @@ declare class Communication {
|
|
|
299
317
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
300
318
|
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
301
319
|
* @name getCampaigns
|
|
302
|
-
* @summary: Get campaigns
|
|
303
|
-
* @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/).
|
|
304
322
|
*/
|
|
305
323
|
getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
306
324
|
/**
|
|
@@ -311,41 +329,10 @@ declare class Communication {
|
|
|
311
329
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
312
330
|
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
313
331
|
* @name getCommunicationLogs
|
|
314
|
-
* @summary: Get communication
|
|
315
|
-
* @description: Retrieve logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
|
|
316
|
-
*/
|
|
317
|
-
getCommunicationLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
|
|
318
|
-
/**
|
|
319
|
-
* @param {Object} arg - Arg object.
|
|
320
|
-
* @param {string} arg.companyId - Company id
|
|
321
|
-
* @param {string} arg.applicationId - Application id
|
|
322
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
323
|
-
* @param {string} [arg.sort] - To sort based on created_at
|
|
324
|
-
* @param {Object} [arg.query] -
|
|
325
|
-
* @returns {Paginator<CommunicationPlatformModel.Logs>}
|
|
326
|
-
* @summary: Get communication logs.
|
|
327
|
-
* @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/).
|
|
328
334
|
*/
|
|
329
|
-
|
|
330
|
-
companyId: string;
|
|
331
|
-
applicationId: string;
|
|
332
|
-
pageSize?: number;
|
|
333
|
-
sort?: string;
|
|
334
|
-
query?: any;
|
|
335
|
-
}): Paginator<CommunicationPlatformModel.Logs>;
|
|
336
|
-
/**
|
|
337
|
-
* @param {CommunicationPlatformApplicationValidator.GetDefaultEmailProvidersParam} arg
|
|
338
|
-
* - Arg object
|
|
339
|
-
*
|
|
340
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
341
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
342
|
-
* @returns {Promise<CommunicationPlatformModel.DefaultEmailProviders[]>} -
|
|
343
|
-
* Success response
|
|
344
|
-
* @name getDefaultEmailProviders
|
|
345
|
-
* @summary: Get app providers.
|
|
346
|
-
* @description: Retrieve a list of app providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultEmailProviders/).
|
|
347
|
-
*/
|
|
348
|
-
getDefaultEmailProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultEmailProviders[]>;
|
|
335
|
+
getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
|
|
349
336
|
/**
|
|
350
337
|
* @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg
|
|
351
338
|
* - Arg object
|
|
@@ -355,8 +342,8 @@ declare class Communication {
|
|
|
355
342
|
* @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
|
|
356
343
|
* Success response
|
|
357
344
|
* @name getDefaultSmsProviders
|
|
358
|
-
* @summary: Get default SMS providers
|
|
359
|
-
* @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/).
|
|
360
347
|
*/
|
|
361
348
|
getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
|
|
362
349
|
/**
|
|
@@ -368,8 +355,8 @@ declare class Communication {
|
|
|
368
355
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
|
|
369
356
|
* Success response
|
|
370
357
|
* @name getDummyDatasources
|
|
371
|
-
* @summary: Get dummy data sources
|
|
372
|
-
* @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/).
|
|
373
360
|
*/
|
|
374
361
|
getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
|
|
375
362
|
/**
|
|
@@ -381,7 +368,7 @@ declare class Communication {
|
|
|
381
368
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
|
|
382
369
|
* Success response
|
|
383
370
|
* @name getDummyDatasourcesMeta
|
|
384
|
-
* @summary: Get dummy data sources metadata
|
|
371
|
+
* @summary: Get dummy data sources metadata
|
|
385
372
|
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
386
373
|
*/
|
|
387
374
|
getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
|
|
@@ -393,8 +380,8 @@ declare class Communication {
|
|
|
393
380
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
394
381
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
395
382
|
* @name getEmailProviderById
|
|
396
|
-
* @summary: Get email provider
|
|
397
|
-
* @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/).
|
|
398
385
|
*/
|
|
399
386
|
getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
400
387
|
/**
|
|
@@ -405,28 +392,10 @@ declare class Communication {
|
|
|
405
392
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
406
393
|
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
407
394
|
* @name getEmailProviders
|
|
408
|
-
* @summary: Get email providers
|
|
409
|
-
* @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/).
|
|
410
397
|
*/
|
|
411
398
|
getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
412
|
-
/**
|
|
413
|
-
* @param {Object} arg - Arg object.
|
|
414
|
-
* @param {string} arg.companyId - Company id
|
|
415
|
-
* @param {string} arg.applicationId - Application id
|
|
416
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
417
|
-
* @param {string} [arg.sort] - To sort based on created_at
|
|
418
|
-
* @param {string} [arg.query] - To search based on plain text
|
|
419
|
-
* @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
|
|
420
|
-
* @summary: Get email providers.
|
|
421
|
-
* @description: Retrieve a list of email communication providers.
|
|
422
|
-
*/
|
|
423
|
-
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
424
|
-
companyId: string;
|
|
425
|
-
applicationId: string;
|
|
426
|
-
pageSize?: number;
|
|
427
|
-
sort?: string;
|
|
428
|
-
query?: string;
|
|
429
|
-
}): Paginator<CommunicationPlatformModel.EmailProviders>;
|
|
430
399
|
/**
|
|
431
400
|
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
|
|
432
401
|
* - Arg object
|
|
@@ -435,8 +404,8 @@ declare class Communication {
|
|
|
435
404
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
436
405
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
437
406
|
* @name getEmailTemplateById
|
|
438
|
-
* @summary: Get email template
|
|
439
|
-
* @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/).
|
|
440
409
|
*/
|
|
441
410
|
getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
442
411
|
/**
|
|
@@ -447,28 +416,10 @@ declare class Communication {
|
|
|
447
416
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
417
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
449
418
|
* @name getEmailTemplates
|
|
450
|
-
* @summary: Get email templates
|
|
451
|
-
* @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/).
|
|
452
421
|
*/
|
|
453
422
|
getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
454
|
-
/**
|
|
455
|
-
* @param {Object} arg - Arg object.
|
|
456
|
-
* @param {string} arg.companyId - Company id
|
|
457
|
-
* @param {string} arg.applicationId - Application id
|
|
458
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
459
|
-
* @param {string} [arg.sort] - To sort based on created_at
|
|
460
|
-
* @param {string} [arg.query] - To search based on plain text
|
|
461
|
-
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
462
|
-
* @summary: Get email templates.
|
|
463
|
-
* @description: Retrieve a list of available email communication templates.
|
|
464
|
-
*/
|
|
465
|
-
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
466
|
-
companyId: string;
|
|
467
|
-
applicationId: string;
|
|
468
|
-
pageSize?: number;
|
|
469
|
-
sort?: string;
|
|
470
|
-
query?: string;
|
|
471
|
-
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
472
423
|
/**
|
|
473
424
|
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
|
|
474
425
|
* - Arg object
|
|
@@ -478,26 +429,10 @@ declare class Communication {
|
|
|
478
429
|
* @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
|
|
479
430
|
* Success response
|
|
480
431
|
* @name getEventSubscriptions
|
|
481
|
-
* @summary: Get event subscriptions
|
|
482
|
-
* @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/).
|
|
483
434
|
*/
|
|
484
435
|
getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
485
|
-
/**
|
|
486
|
-
* @param {Object} arg - Arg object.
|
|
487
|
-
* @param {string} arg.companyId - Company id
|
|
488
|
-
* @param {string} arg.applicationId - Application id
|
|
489
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
490
|
-
* @param {string} [arg.populate] - Populate Fields
|
|
491
|
-
* @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
|
|
492
|
-
* @summary: Get event subscriptions.
|
|
493
|
-
* @description: Retrieve a list of event subscriptions related to communication.
|
|
494
|
-
*/
|
|
495
|
-
getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
|
|
496
|
-
companyId: string;
|
|
497
|
-
applicationId: string;
|
|
498
|
-
pageSize?: number;
|
|
499
|
-
populate?: string;
|
|
500
|
-
}): Paginator<CommunicationPlatformModel.EventSubscriptions>;
|
|
501
436
|
/**
|
|
502
437
|
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
|
|
503
438
|
* - Arg object
|
|
@@ -506,8 +441,8 @@ declare class Communication {
|
|
|
506
441
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
507
442
|
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
508
443
|
* @name getEventSubscriptionsById
|
|
509
|
-
* @summary: Get event
|
|
510
|
-
* @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/).
|
|
511
446
|
*/
|
|
512
447
|
getEventSubscriptionsById({ id, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
513
448
|
/**
|
|
@@ -518,8 +453,8 @@ declare class Communication {
|
|
|
518
453
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
519
454
|
* @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
|
|
520
455
|
* @name getGlobalProviders
|
|
521
|
-
* @summary: Get global providers
|
|
522
|
-
* @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/).
|
|
523
458
|
*/
|
|
524
459
|
getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
|
|
525
460
|
/**
|
|
@@ -528,70 +463,34 @@ declare class Communication {
|
|
|
528
463
|
*
|
|
529
464
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
530
465
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
531
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
466
|
+
* @returns {Promise<CommunicationPlatformModel.GetGlobalVariablesResult>}
|
|
532
467
|
* - Success response
|
|
533
468
|
*
|
|
534
469
|
* @name getGlobalVariables
|
|
535
|
-
* @summary: Get global variables
|
|
536
|
-
* @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/).
|
|
537
472
|
*/
|
|
538
|
-
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
473
|
+
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetGlobalVariablesResult>;
|
|
539
474
|
/**
|
|
540
475
|
* @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
|
|
541
476
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
542
477
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
543
478
|
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
544
479
|
* @name getJobLogs
|
|
545
|
-
* @summary: Get job
|
|
546
|
-
* @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/).
|
|
547
482
|
*/
|
|
548
483
|
getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
549
|
-
/**
|
|
550
|
-
* @param {Object} arg - Arg object.
|
|
551
|
-
* @param {string} arg.companyId - Company id
|
|
552
|
-
* @param {string} arg.applicationId - Application id
|
|
553
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
554
|
-
* @param {string} [arg.sort] - To sort based on created_at
|
|
555
|
-
* @param {string} [arg.query] - To search based on plain text
|
|
556
|
-
* @returns {Paginator<CommunicationPlatformModel.JobLogs>}
|
|
557
|
-
* @summary: Get job logs.
|
|
558
|
-
* @description: Retrieve logs and details related to communication jobs.
|
|
559
|
-
*/
|
|
560
|
-
getJobLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
561
|
-
companyId: string;
|
|
562
|
-
applicationId: string;
|
|
563
|
-
pageSize?: number;
|
|
564
|
-
sort?: string;
|
|
565
|
-
query?: string;
|
|
566
|
-
}): Paginator<CommunicationPlatformModel.JobLogs>;
|
|
567
484
|
/**
|
|
568
485
|
* @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
|
|
569
486
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
570
487
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
571
488
|
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
572
489
|
* @name getJobs
|
|
573
|
-
* @summary: Get jobs
|
|
574
|
-
* @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/).
|
|
575
492
|
*/
|
|
576
493
|
getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
577
|
-
/**
|
|
578
|
-
* @param {Object} arg - Arg object.
|
|
579
|
-
* @param {string} arg.companyId - Company id
|
|
580
|
-
* @param {string} arg.applicationId - Application id
|
|
581
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
582
|
-
* @param {string} [arg.sort] - To sort based on created_at
|
|
583
|
-
* @param {string} [arg.query] - To search based on plain text
|
|
584
|
-
* @returns {Paginator<CommunicationPlatformModel.Jobs>}
|
|
585
|
-
* @summary: Get jobs.
|
|
586
|
-
* @description: Retrieve a list of communication jobs.
|
|
587
|
-
*/
|
|
588
|
-
getJobsPaginator({ companyId, applicationId, pageSize, sort, query }?: {
|
|
589
|
-
companyId: string;
|
|
590
|
-
applicationId: string;
|
|
591
|
-
pageSize?: number;
|
|
592
|
-
sort?: string;
|
|
593
|
-
query?: string;
|
|
594
|
-
}): Paginator<CommunicationPlatformModel.Jobs>;
|
|
595
494
|
/**
|
|
596
495
|
* @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
|
|
597
496
|
* - Arg object
|
|
@@ -600,7 +499,7 @@ declare class Communication {
|
|
|
600
499
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
601
500
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
602
501
|
* @name getNSampleRecordsFromCsv
|
|
603
|
-
* @summary: Get N sample records
|
|
502
|
+
* @summary: Get N sample records of a CSV
|
|
604
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/).
|
|
605
504
|
*/
|
|
606
505
|
getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
@@ -612,10 +511,10 @@ declare class Communication {
|
|
|
612
511
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
613
512
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
614
513
|
* @name getNSampleRecordsFromCsvByGet
|
|
615
|
-
* @summary: Get N sample records
|
|
616
|
-
* @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/).
|
|
617
516
|
*/
|
|
618
|
-
getNSampleRecordsFromCsvByGet({
|
|
517
|
+
getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
619
518
|
/**
|
|
620
519
|
* @param {CommunicationPlatformApplicationValidator.GetOtpConfigurationParam} arg
|
|
621
520
|
* - Arg object
|
|
@@ -624,8 +523,8 @@ declare class Communication {
|
|
|
624
523
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
625
524
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
626
525
|
* @name getOtpConfiguration
|
|
627
|
-
* @summary: Get
|
|
628
|
-
* @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/).
|
|
629
528
|
*/
|
|
630
529
|
getOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
631
530
|
/**
|
|
@@ -634,24 +533,24 @@ declare class Communication {
|
|
|
634
533
|
*
|
|
635
534
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
636
535
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
637
|
-
* @returns {Promise<
|
|
536
|
+
* @returns {Promise<Object>} - Success response
|
|
638
537
|
* @name getSmsProviderById
|
|
639
|
-
* @summary: Get SMS provider
|
|
538
|
+
* @summary: Get a SMS provider
|
|
640
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/).
|
|
641
540
|
*/
|
|
642
|
-
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<
|
|
541
|
+
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
643
542
|
/**
|
|
644
543
|
* @param {CommunicationPlatformApplicationValidator.GetSmsProvidersParam} arg
|
|
645
544
|
* - Arg object
|
|
646
545
|
*
|
|
647
546
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
648
547
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
649
|
-
* @returns {Promise<
|
|
548
|
+
* @returns {Promise<Object>} - Success response
|
|
650
549
|
* @name getSmsProviders
|
|
651
|
-
* @summary: Get SMS providers
|
|
652
|
-
* @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/).
|
|
653
552
|
*/
|
|
654
|
-
getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<
|
|
553
|
+
getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
|
|
655
554
|
/**
|
|
656
555
|
* @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
|
|
657
556
|
* - Arg object
|
|
@@ -660,8 +559,8 @@ declare class Communication {
|
|
|
660
559
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
661
560
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
662
561
|
* @name getSmsTemplateById
|
|
663
|
-
* @summary: Get SMS template
|
|
664
|
-
* @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/).
|
|
665
564
|
*/
|
|
666
565
|
getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
667
566
|
/**
|
|
@@ -672,28 +571,10 @@ declare class Communication {
|
|
|
672
571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
673
572
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
674
573
|
* @name getSmsTemplates
|
|
675
|
-
* @summary: Get SMS templates
|
|
676
|
-
* @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/).
|
|
677
576
|
*/
|
|
678
577
|
getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
679
|
-
/**
|
|
680
|
-
* @param {Object} arg - Arg object.
|
|
681
|
-
* @param {string} arg.companyId - Company id
|
|
682
|
-
* @param {string} arg.applicationId - Application id
|
|
683
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
684
|
-
* @param {string} [arg.sort] - To sort based on created_at
|
|
685
|
-
* @param {string} [arg.query] - To search based on plain text
|
|
686
|
-
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
687
|
-
* @summary: Get SMS templates.
|
|
688
|
-
* @description: Retrieve a list of available SMS communication templates.
|
|
689
|
-
*/
|
|
690
|
-
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
691
|
-
companyId: string;
|
|
692
|
-
applicationId: string;
|
|
693
|
-
pageSize?: number;
|
|
694
|
-
sort?: string;
|
|
695
|
-
query?: string;
|
|
696
|
-
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
697
578
|
/**
|
|
698
579
|
* @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
|
|
699
580
|
* - Arg object
|
|
@@ -702,8 +583,8 @@ declare class Communication {
|
|
|
702
583
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
703
584
|
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
704
585
|
* @name getStatsOfCampaignById
|
|
705
|
-
* @summary: Get campaign statistics
|
|
706
|
-
* @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/).
|
|
707
588
|
*/
|
|
708
589
|
getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
|
|
709
590
|
/**
|
|
@@ -712,128 +593,122 @@ declare class Communication {
|
|
|
712
593
|
*
|
|
713
594
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
714
595
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
715
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
716
|
-
* - Success response
|
|
717
|
-
*
|
|
596
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
718
597
|
* @name getSubscribedEmailTemplates
|
|
719
|
-
* @summary: Get subscribed email templates
|
|
720
|
-
* @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/).
|
|
721
600
|
*/
|
|
722
|
-
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
601
|
+
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
723
602
|
/**
|
|
724
603
|
* @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
|
|
725
604
|
* - Arg object
|
|
726
605
|
*
|
|
727
606
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
728
607
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
729
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
730
|
-
* Success response
|
|
608
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
731
609
|
* @name getSubscribedSmsTemplates
|
|
732
|
-
* @summary: Get subscribed SMS templates
|
|
733
|
-
* @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/).
|
|
734
612
|
*/
|
|
735
|
-
getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
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/).
|
|
624
|
+
*/
|
|
625
|
+
getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
736
626
|
/**
|
|
737
627
|
* @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
|
|
738
628
|
* - Arg object
|
|
739
629
|
*
|
|
740
630
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
741
631
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
742
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
632
|
+
* @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
|
|
743
633
|
* Success response
|
|
744
634
|
* @name getSystemEmailTemplates
|
|
745
|
-
* @summary: Get system email templates
|
|
746
|
-
* @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/).
|
|
747
637
|
*/
|
|
748
|
-
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
638
|
+
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
|
|
749
639
|
/**
|
|
750
640
|
* @param {CommunicationPlatformApplicationValidator.GetSystemSmsTemplatesParam} arg
|
|
751
641
|
* - Arg object
|
|
752
642
|
*
|
|
753
643
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
754
644
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
755
|
-
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates
|
|
645
|
+
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates>} -
|
|
756
646
|
* Success response
|
|
757
647
|
* @name getSystemSmsTemplates
|
|
758
|
-
* @summary:
|
|
759
|
-
* @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/).
|
|
760
650
|
*/
|
|
761
|
-
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates
|
|
651
|
+
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates>;
|
|
762
652
|
/**
|
|
763
653
|
* @param {CommunicationPlatformApplicationValidator.PostGlobalVariablesParam} arg
|
|
764
654
|
* - Arg object
|
|
765
655
|
*
|
|
766
656
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
767
657
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
768
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
658
|
+
* @returns {Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>}
|
|
769
659
|
* - Success response
|
|
770
660
|
*
|
|
771
661
|
* @name postGlobalVariables
|
|
772
|
-
* @summary:
|
|
773
|
-
* @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/).
|
|
774
664
|
*/
|
|
775
|
-
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
665
|
+
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>;
|
|
776
666
|
/**
|
|
777
667
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
|
|
778
668
|
* - Arg object
|
|
779
669
|
*
|
|
780
670
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
781
671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
782
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
672
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
783
673
|
* @name sendCommunicationAsynchronously
|
|
784
|
-
* @summary: Send communication asynchronously
|
|
785
|
-
* @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/).
|
|
786
676
|
*/
|
|
787
|
-
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
677
|
+
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
788
678
|
/**
|
|
789
679
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
|
|
790
680
|
* - Arg object
|
|
791
681
|
*
|
|
792
682
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
793
683
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
794
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
795
|
-
* Success response
|
|
684
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
796
685
|
* @name sendCommunicationSynchronously
|
|
797
|
-
* @summary: Send communication synchronously
|
|
798
|
-
* @description:
|
|
799
|
-
*/
|
|
800
|
-
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendInstantResponse>;
|
|
801
|
-
/**
|
|
802
|
-
* @param {CommunicationPlatformApplicationValidator.SendEngineCommunicationSynchronouslyParam} arg
|
|
803
|
-
* - Arg object
|
|
804
|
-
*
|
|
805
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
806
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
807
|
-
* @returns {Promise<CommunicationPlatformModel.SendInstantResponse>} -
|
|
808
|
-
* Success response
|
|
809
|
-
* @name sendEngineCommunicationSynchronously
|
|
810
|
-
* @summary: Send communication asynchronously.
|
|
811
|
-
* @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/).
|
|
812
688
|
*/
|
|
813
|
-
|
|
689
|
+
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
814
690
|
/**
|
|
815
691
|
* @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
|
|
816
692
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
817
693
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
818
694
|
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
819
695
|
* @name sendOtp
|
|
820
|
-
* @summary: Send OTP
|
|
821
|
-
* @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/).
|
|
822
698
|
*/
|
|
823
|
-
sendOtp({ body,
|
|
699
|
+
sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
824
700
|
/**
|
|
825
701
|
* @param {CommunicationPlatformApplicationValidator.TriggerCampaignJobParam} arg
|
|
826
702
|
* - Arg object
|
|
827
703
|
*
|
|
828
704
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
829
705
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
830
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
831
|
-
* Success response
|
|
706
|
+
* @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
|
|
832
707
|
* @name triggerCampaignJob
|
|
833
|
-
* @summary: Trigger campaign job
|
|
834
|
-
* @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/).
|
|
835
710
|
*/
|
|
836
|
-
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
711
|
+
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResult>;
|
|
837
712
|
/**
|
|
838
713
|
* @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg
|
|
839
714
|
* - Arg object
|
|
@@ -842,24 +717,10 @@ declare class Communication {
|
|
|
842
717
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
843
718
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
844
719
|
* @name updateAppProviders
|
|
845
|
-
* @summary: Update application providers
|
|
846
|
-
* @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/).
|
|
847
722
|
*/
|
|
848
723
|
updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
849
|
-
/**
|
|
850
|
-
* @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersGlobalProviderParam} arg
|
|
851
|
-
* - Arg object
|
|
852
|
-
*
|
|
853
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
854
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
855
|
-
* @returns {Promise<CommunicationPlatformModel.UpdateAppProvidersGlobalProviderResponse>}
|
|
856
|
-
* - Success response
|
|
857
|
-
*
|
|
858
|
-
* @name updateAppProvidersGlobalProvider
|
|
859
|
-
* @summary: Get global app providers.
|
|
860
|
-
* @description: Retrieve a list of global app providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProvidersGlobalProvider/).
|
|
861
|
-
*/
|
|
862
|
-
updateAppProvidersGlobalProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersGlobalProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.UpdateAppProvidersGlobalProviderResponse>;
|
|
863
724
|
/**
|
|
864
725
|
* @param {CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam} arg
|
|
865
726
|
* - Arg object
|
|
@@ -868,8 +729,8 @@ declare class Communication {
|
|
|
868
729
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
869
730
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
870
731
|
* @name updateAudienceById
|
|
871
|
-
* @summary: Update audience
|
|
872
|
-
* @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/).
|
|
873
734
|
*/
|
|
874
735
|
updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
875
736
|
/**
|
|
@@ -880,8 +741,8 @@ declare class Communication {
|
|
|
880
741
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
881
742
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
882
743
|
* @name updateCampaignById
|
|
883
|
-
* @summary: Update campaign
|
|
884
|
-
* @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/).
|
|
885
746
|
*/
|
|
886
747
|
updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
887
748
|
/**
|
|
@@ -892,8 +753,8 @@ declare class Communication {
|
|
|
892
753
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
893
754
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
894
755
|
* @name updateEmailProviderById
|
|
895
|
-
* @summary: Update email provider
|
|
896
|
-
* @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/).
|
|
897
758
|
*/
|
|
898
759
|
updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
899
760
|
/**
|
|
@@ -904,8 +765,8 @@ declare class Communication {
|
|
|
904
765
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
905
766
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
906
767
|
* @name updateEmailTemplateById
|
|
907
|
-
* @summary: Update email template
|
|
908
|
-
* @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/).
|
|
909
770
|
*/
|
|
910
771
|
updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
911
772
|
/**
|
|
@@ -916,22 +777,22 @@ declare class Communication {
|
|
|
916
777
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
917
778
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
918
779
|
* @name updateOtpConfiguration
|
|
919
|
-
* @summary: Update
|
|
920
|
-
* @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/).
|
|
921
782
|
*/
|
|
922
|
-
updateOtpConfiguration({
|
|
783
|
+
updateOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
923
784
|
/**
|
|
924
785
|
* @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
|
|
925
786
|
* - Arg object
|
|
926
787
|
*
|
|
927
788
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
928
789
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
929
|
-
* @returns {Promise<
|
|
790
|
+
* @returns {Promise<Object>} - Success response
|
|
930
791
|
* @name updateSmsProviderById
|
|
931
|
-
* @summary: Update SMS provider
|
|
932
|
-
* @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/).
|
|
933
794
|
*/
|
|
934
|
-
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<
|
|
795
|
+
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
935
796
|
/**
|
|
936
797
|
* @param {CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam} arg
|
|
937
798
|
* - Arg object
|
|
@@ -940,8 +801,8 @@ declare class Communication {
|
|
|
940
801
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
941
802
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
942
803
|
* @name updateSmsTemplateById
|
|
943
|
-
* @summary: Update SMS template
|
|
944
|
-
* @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/).
|
|
945
806
|
*/
|
|
946
807
|
updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
947
808
|
/**
|
|
@@ -952,11 +813,10 @@ declare class Communication {
|
|
|
952
813
|
* - Success response
|
|
953
814
|
*
|
|
954
815
|
* @name verfiyOtp
|
|
955
|
-
* @summary: Verify OTP
|
|
956
|
-
* @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/).
|
|
957
818
|
*/
|
|
958
819
|
verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
|
|
959
820
|
}
|
|
960
821
|
import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator");
|
|
961
822
|
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
962
|
-
import Paginator = require("../../common/Paginator");
|