@gofynd/fdk-client-javascript 1.1.6 → 1.3.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 +52 -3
- package/index.js +0 -3
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +12 -3
- package/sdk/application/ApplicationClient.d.ts +36 -6
- package/sdk/application/ApplicationClient.js +30 -43
- package/sdk/application/ApplicationConfig.d.ts +92 -12
- package/sdk/application/ApplicationConfig.js +48 -14
- package/sdk/application/Cart/CartApplicationClient.d.ts +200 -357
- package/sdk/application/Cart/CartApplicationClient.js +711 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +274 -422
- package/sdk/application/Catalog/CatalogApplicationClient.js +865 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2320 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1566 -172
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +16 -21
- package/sdk/application/Common/CommonApplicationClient.js +52 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +368 -19
- package/sdk/application/Common/CommonApplicationModel.js +192 -40
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +31 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +86 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +157 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +104 -23
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +149 -118
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +457 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2235 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1113 -193
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +149 -139
- package/sdk/application/Content/ContentApplicationClient.js +489 -278
- package/sdk/application/Content/ContentApplicationModel.d.ts +1010 -105
- package/sdk/application/Content/ContentApplicationModel.js +737 -396
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +23 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +148 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +100 -87
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +57 -53
- package/sdk/application/Lead/LeadApplicationClient.js +188 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +686 -54
- package/sdk/application/Lead/LeadApplicationModel.js +330 -244
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +40 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +131 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +93 -133
- package/sdk/application/Order/OrderApplicationClient.js +329 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +400 -366
- package/sdk/application/Payment/PaymentApplicationClient.js +1176 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +205 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +720 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +58 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +187 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +52 -50
- package/sdk/application/Share/ShareApplicationClient.js +185 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +198 -15
- package/sdk/application/Share/ShareApplicationModel.js +131 -31
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +30 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +102 -56
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +1291 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +895 -134
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +260 -305
- package/sdk/application/User/UserApplicationClient.js +910 -522
- package/sdk/application/User/UserApplicationModel.d.ts +992 -101
- package/sdk/application/User/UserApplicationModel.js +699 -248
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +7 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +16 -1
- package/sdk/partner/PartnerAPIClient.js +12 -2
- package/sdk/partner/PartnerClient.d.ts +22 -3
- package/sdk/partner/PartnerClient.js +20 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +30 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +104 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +190 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +132 -15
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +52 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +30 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +133 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +561 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1071 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +762 -151
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +175 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +118 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +454 -635
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1646 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3839 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2423 -217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +528 -638
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1600 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +652 -826
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1979 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6869 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -351
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1361 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +624 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +16 -21
- package/sdk/platform/Common/CommonPlatformClient.js +50 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +423 -19
- package/sdk/platform/Common/CommonPlatformModel.js +214 -40
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +37 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +20 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +731 -303
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3095 -785
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +699 -41
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +463 -27
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +19 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +59 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1708 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1360 -235
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +127 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +435 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +882 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +666 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +184 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +105 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +327 -240
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +922 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +297 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +191 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +184 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +555 -311
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4337 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2178 -248
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +605 -578
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1996 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1472 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1085 -204
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +85 -82
- package/sdk/platform/Discount/DiscountPlatformClient.js +333 -175
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +281 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +189 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +109 -52
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +570 -105
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +141 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +118 -7
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +43 -63
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +153 -135
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +426 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +379 -40
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +106 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +60 -8
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +260 -129
- package/sdk/platform/Finance/FinancePlatformClient.js +1182 -194
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1267 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +1252 -38
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +233 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +229 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +111 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +330 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +100 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +372 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +89 -104
- package/sdk/platform/Lead/LeadPlatformClient.js +305 -180
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1045 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +504 -142
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +92 -15
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +20 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +58 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +437 -556
- package/sdk/platform/Order/OrderPlatformClient.js +1500 -760
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5225 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3473 -260
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +859 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +435 -23
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +16 -42
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +37 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +19 -17
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +78 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +43 -369
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +418 -288
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +1509 -505
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +438 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +312 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +83 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +259 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3200 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1334 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +31 -12581
- package/sdk/platform/PlatformClient.js +30 -15089
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +96 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +344 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +360 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +238 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +159 -92
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +473 -208
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +138 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +100 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +166 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +518 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1408 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1034 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +41 -66
- package/sdk/platform/Share/SharePlatformApplicationClient.js +149 -116
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +167 -19
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +229 -193
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +976 -352
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +345 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +206 -14
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1527 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +1099 -118
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +138 -152
- package/sdk/platform/User/UserPlatformApplicationClient.js +470 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +242 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +129 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +653 -101
- package/sdk/platform/User/UserPlatformModel.js +467 -424
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +153 -49
- package/sdk/platform/Webhook/WebhookPlatformClient.js +896 -88
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +632 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +502 -54
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +170 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +157 -7
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +16 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +48 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +370 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +191 -40
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +54 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +161 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +21 -3
- package/sdk/public/PublicClient.js +20 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +16 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +52 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +33 -113
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -3
- package/sdk/application/ApplicationModels.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -145
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -799
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -14
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -87
|
@@ -4,465 +4,893 @@ declare class Communication {
|
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
|
-
* @param {
|
|
8
|
-
*
|
|
9
|
-
*
|
|
7
|
+
* @param {CommunicationPlatformApplicationValidator.CreateAudienceParam} arg
|
|
8
|
+
* - Arg object
|
|
9
|
+
*
|
|
10
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
13
|
+
* @name createAudience
|
|
10
14
|
* @summary: Create audience
|
|
11
|
-
* @description:
|
|
12
|
-
*/
|
|
13
|
-
createAudience({ body }?: {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
*
|
|
18
|
-
* @param {
|
|
19
|
-
* @
|
|
15
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to create audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
|
|
16
|
+
*/
|
|
17
|
+
createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
18
|
+
/**
|
|
19
|
+
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryHeadersParam} arg
|
|
20
|
+
* - Arg object
|
|
21
|
+
*
|
|
22
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
+
* @returns {Promise<Object>} - Success response
|
|
25
|
+
* @name createBigQueryHeaders
|
|
26
|
+
* @summary: Create big query headers
|
|
27
|
+
* @description: Create big query headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
|
|
28
|
+
*/
|
|
29
|
+
createBigQueryHeaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
30
|
+
/**
|
|
31
|
+
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryNCountParam} arg
|
|
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 big query n count
|
|
39
|
+
* @description: Create 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 big query row count
|
|
51
|
+
* @description: Create 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>;
|
|
54
|
+
/**
|
|
55
|
+
* @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
|
|
56
|
+
* - Arg object
|
|
57
|
+
*
|
|
58
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
|
+
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
61
|
+
* @name createCampaign
|
|
20
62
|
* @summary: Create campaign
|
|
21
|
-
* @description: Create campaign
|
|
63
|
+
* @description: Create campaign - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
|
|
22
64
|
*/
|
|
23
|
-
createCampaign({ body }?: {
|
|
24
|
-
body: CampaignReq;
|
|
25
|
-
}): Promise<Campaign>;
|
|
65
|
+
createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
26
66
|
/**
|
|
27
|
-
* @param {
|
|
28
|
-
*
|
|
29
|
-
*
|
|
67
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEmailProviderParam} arg
|
|
68
|
+
* - Arg object
|
|
69
|
+
*
|
|
70
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
71
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
73
|
+
* @name createEmailProvider
|
|
30
74
|
* @summary: Create email provider
|
|
31
|
-
* @description: Create email provider
|
|
75
|
+
* @description: Create email provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
|
|
32
76
|
*/
|
|
33
|
-
createEmailProvider({ body }?: {
|
|
34
|
-
body: EmailProviderReq;
|
|
35
|
-
}): Promise<EmailProvider>;
|
|
77
|
+
createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
36
78
|
/**
|
|
37
|
-
* @param {
|
|
38
|
-
*
|
|
39
|
-
*
|
|
79
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEmailTemplateParam} arg
|
|
80
|
+
* - Arg object
|
|
81
|
+
*
|
|
82
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
83
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
84
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
85
|
+
* @name createEmailTemplate
|
|
40
86
|
* @summary: Create email template
|
|
41
|
-
* @description:
|
|
87
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to create an email template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
|
|
42
88
|
*/
|
|
43
|
-
createEmailTemplate({ body }?: {
|
|
44
|
-
body: EmailTemplateReq;
|
|
45
|
-
}): Promise<EmailTemplateRes>;
|
|
89
|
+
createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
46
90
|
/**
|
|
47
|
-
* @param {
|
|
48
|
-
*
|
|
49
|
-
*
|
|
91
|
+
* @param {CommunicationPlatformApplicationValidator.CreateSmsProviderParam} arg
|
|
92
|
+
* - Arg object
|
|
93
|
+
*
|
|
94
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
+
* @returns {Promise<Object>} - Success response
|
|
97
|
+
* @name createSmsProvider
|
|
50
98
|
* @summary: Create sms provider
|
|
51
|
-
* @description: Create sms provider
|
|
99
|
+
* @description: Create sms provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
|
|
52
100
|
*/
|
|
53
|
-
createSmsProvider({ body }?: {
|
|
54
|
-
body: SmsProviderReq;
|
|
55
|
-
}): Promise<SmsProvider>;
|
|
101
|
+
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
|
|
56
102
|
/**
|
|
57
|
-
* @param {
|
|
58
|
-
*
|
|
59
|
-
*
|
|
103
|
+
* @param {CommunicationPlatformApplicationValidator.CreateSmsTemplateParam} arg
|
|
104
|
+
* - Arg object
|
|
105
|
+
*
|
|
106
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
107
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
108
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
109
|
+
* @name createSmsTemplate
|
|
60
110
|
* @summary: Create sms template
|
|
61
|
-
* @description:
|
|
62
|
-
*/
|
|
63
|
-
createSmsTemplate({ body }?: {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
*
|
|
68
|
-
* @param {
|
|
69
|
-
* @
|
|
111
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to create an sms template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
|
|
112
|
+
*/
|
|
113
|
+
createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
114
|
+
/**
|
|
115
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam} arg
|
|
116
|
+
* - Arg object
|
|
117
|
+
*
|
|
118
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
119
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
121
|
+
* @name deleteAudienceById
|
|
122
|
+
* @summary: Delete audience by id
|
|
123
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to delete audience by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
|
|
124
|
+
*/
|
|
125
|
+
deleteAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
126
|
+
/**
|
|
127
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg
|
|
128
|
+
* - Arg object
|
|
129
|
+
*
|
|
130
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
131
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
133
|
+
* @name deleteEmailProviderById
|
|
134
|
+
* @summary: Delete email provider by id
|
|
135
|
+
* @description: Delete email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
|
|
136
|
+
*/
|
|
137
|
+
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
138
|
+
/**
|
|
139
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg
|
|
140
|
+
* - Arg object
|
|
141
|
+
*
|
|
142
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
143
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
145
|
+
* @name deleteEmailTemplateById
|
|
70
146
|
* @summary: Delete email template by id
|
|
71
|
-
* @description:
|
|
72
|
-
*/
|
|
73
|
-
deleteEmailTemplateById({ id }?: {
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
*
|
|
78
|
-
* @param {
|
|
79
|
-
* @
|
|
147
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to delete an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
|
|
148
|
+
*/
|
|
149
|
+
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
150
|
+
/**
|
|
151
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
|
|
152
|
+
* - Arg object
|
|
153
|
+
*
|
|
154
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
157
|
+
* @name deleteSmsProviderById
|
|
158
|
+
* @summary: Delete sms provider by id
|
|
159
|
+
* @description: Delete sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
|
|
160
|
+
*/
|
|
161
|
+
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
162
|
+
/**
|
|
163
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg
|
|
164
|
+
* - Arg object
|
|
165
|
+
*
|
|
166
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
167
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
168
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
169
|
+
* @name deleteSmsTemplateById
|
|
80
170
|
* @summary: Delete sms template by id
|
|
81
|
-
* @description:
|
|
171
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to delete an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
|
|
172
|
+
*/
|
|
173
|
+
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
174
|
+
/**
|
|
175
|
+
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
176
|
+
* - Arg object
|
|
177
|
+
*
|
|
178
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
+
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
181
|
+
* @name getAppProviders
|
|
182
|
+
* @summary: Get app providers
|
|
183
|
+
* @description: Using this API will return a list of application providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
|
|
184
|
+
*/
|
|
185
|
+
getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
186
|
+
/**
|
|
187
|
+
* @param {CommunicationPlatformApplicationValidator.GetAudienceByIdParam} arg
|
|
188
|
+
* - Arg object
|
|
189
|
+
*
|
|
190
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
191
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
192
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
193
|
+
* @name getAudienceById
|
|
194
|
+
* @summary: Get audience by id
|
|
195
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences by Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
|
|
82
196
|
*/
|
|
83
|
-
|
|
84
|
-
id: string;
|
|
85
|
-
}): Promise<SmsTemplateDeleteSuccessRes>;
|
|
197
|
+
getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
86
198
|
/**
|
|
87
|
-
* @param {
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* @
|
|
91
|
-
* @
|
|
199
|
+
* @param {CommunicationPlatformApplicationValidator.GetAudiencesParam} arg
|
|
200
|
+
* - Arg object
|
|
201
|
+
*
|
|
202
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
204
|
+
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
205
|
+
* @name getAudiences
|
|
206
|
+
* @summary: Get audiences
|
|
207
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
|
|
92
208
|
*/
|
|
93
|
-
|
|
94
|
-
id: string;
|
|
95
|
-
}): Promise<Audience>;
|
|
209
|
+
getAudiences({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
96
210
|
/**
|
|
97
211
|
* @param {Object} arg - Arg object.
|
|
98
|
-
* @param {
|
|
212
|
+
* @param {string} arg.companyId - Company id
|
|
213
|
+
* @param {string} arg.applicationId - Application id
|
|
99
214
|
* @param {number} [arg.pageSize] - Current request items count
|
|
100
215
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
101
|
-
* @returns {
|
|
216
|
+
* @returns {Paginator<CommunicationPlatformModel.Audiences>}
|
|
102
217
|
* @summary: Get audiences
|
|
103
|
-
* @description:
|
|
218
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences.
|
|
104
219
|
*/
|
|
105
|
-
|
|
106
|
-
|
|
220
|
+
getAudiencesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
221
|
+
companyId: string;
|
|
222
|
+
applicationId: string;
|
|
107
223
|
pageSize?: number;
|
|
108
224
|
sort?: any;
|
|
109
|
-
}):
|
|
110
|
-
/**
|
|
111
|
-
* @param {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* @
|
|
115
|
-
* @
|
|
225
|
+
}): Paginator<CommunicationPlatformModel.Audiences>;
|
|
226
|
+
/**
|
|
227
|
+
* @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
|
|
228
|
+
* - Arg object
|
|
229
|
+
*
|
|
230
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
231
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
+
* @returns {Promise<Object>} - Success response
|
|
233
|
+
* @name getBigQueryHeadersById
|
|
234
|
+
* @summary: Get big query headers by id
|
|
235
|
+
* @description: Get big query headers by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
|
|
236
|
+
*/
|
|
237
|
+
getBigQueryHeadersById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
238
|
+
/**
|
|
239
|
+
* @param {CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam} arg
|
|
240
|
+
* - Arg object
|
|
241
|
+
*
|
|
242
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
243
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
244
|
+
* @returns {Promise<Object>} - Success response
|
|
245
|
+
* @name getBigQueryRowCountById
|
|
246
|
+
* @summary: Get big query row count by id
|
|
247
|
+
* @description: Get big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
|
|
248
|
+
*/
|
|
249
|
+
getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
250
|
+
/**
|
|
251
|
+
* @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
|
|
252
|
+
* - Arg object
|
|
253
|
+
*
|
|
254
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
255
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
256
|
+
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
257
|
+
* @name getCampaignById
|
|
258
|
+
* @summary: Get campaign by id
|
|
259
|
+
* @description: Get campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
|
|
116
260
|
*/
|
|
117
|
-
|
|
118
|
-
body: BigqueryHeadersReq;
|
|
119
|
-
}): Promise<BigqueryHeadersRes>;
|
|
261
|
+
getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
120
262
|
/**
|
|
121
|
-
* @param {
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
* @
|
|
125
|
-
* @
|
|
263
|
+
* @param {CommunicationPlatformApplicationValidator.GetCampaignsParam} arg
|
|
264
|
+
* - Arg object
|
|
265
|
+
*
|
|
266
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
267
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
268
|
+
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
269
|
+
* @name getCampaigns
|
|
270
|
+
* @summary: Get campaigns
|
|
271
|
+
* @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
126
272
|
*/
|
|
127
|
-
|
|
128
|
-
id: string;
|
|
129
|
-
}): Promise<Campaign>;
|
|
273
|
+
getCampaigns({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
130
274
|
/**
|
|
131
275
|
* @param {Object} arg - Arg object.
|
|
132
|
-
* @param {
|
|
276
|
+
* @param {string} arg.companyId - Company id
|
|
277
|
+
* @param {string} arg.applicationId - Application id
|
|
133
278
|
* @param {number} [arg.pageSize] - Current request items count
|
|
134
279
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
135
|
-
* @returns {
|
|
280
|
+
* @returns {Paginator<CommunicationPlatformModel.Campaigns>}
|
|
136
281
|
* @summary: Get campaigns
|
|
137
282
|
* @description: Get campaigns
|
|
138
283
|
*/
|
|
139
|
-
|
|
140
|
-
|
|
284
|
+
getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
285
|
+
companyId: string;
|
|
286
|
+
applicationId: string;
|
|
141
287
|
pageSize?: number;
|
|
142
288
|
sort?: any;
|
|
143
|
-
}):
|
|
289
|
+
}): Paginator<CommunicationPlatformModel.Campaigns>;
|
|
290
|
+
/**
|
|
291
|
+
* @param {CommunicationPlatformApplicationValidator.GetCommunicationLogsParam} arg
|
|
292
|
+
* - Arg object
|
|
293
|
+
*
|
|
294
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
295
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
296
|
+
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
297
|
+
* @name getCommunicationLogs
|
|
298
|
+
* @summary: Get communication logs
|
|
299
|
+
* @description: Get communication logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
|
|
300
|
+
*/
|
|
301
|
+
getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
|
|
144
302
|
/**
|
|
145
303
|
* @param {Object} arg - Arg object.
|
|
146
|
-
* @param {string}
|
|
304
|
+
* @param {string} arg.companyId - Company id
|
|
305
|
+
* @param {string} arg.applicationId - Application id
|
|
147
306
|
* @param {number} [arg.pageSize] - Current request items count
|
|
148
307
|
* @param {Object} [arg.sort] - To sort based on _id
|
|
149
308
|
* @param {Object} [arg.query] -
|
|
150
|
-
* @returns {
|
|
309
|
+
* @returns {Paginator<CommunicationPlatformModel.Logs>}
|
|
151
310
|
* @summary: Get communication logs
|
|
152
311
|
* @description: Get communication logs
|
|
153
312
|
*/
|
|
154
|
-
|
|
155
|
-
|
|
313
|
+
getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
314
|
+
companyId: string;
|
|
315
|
+
applicationId: string;
|
|
156
316
|
pageSize?: number;
|
|
157
317
|
sort?: any;
|
|
158
318
|
query?: any;
|
|
159
|
-
}):
|
|
160
|
-
/**
|
|
161
|
-
* @param {
|
|
162
|
-
*
|
|
163
|
-
*
|
|
319
|
+
}): Paginator<CommunicationPlatformModel.Logs>;
|
|
320
|
+
/**
|
|
321
|
+
* @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg
|
|
322
|
+
* - Arg object
|
|
323
|
+
*
|
|
324
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
326
|
+
* @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
|
|
327
|
+
* Success response
|
|
328
|
+
* @name getDefaultSmsProviders
|
|
329
|
+
* @summary: Get default sms providers
|
|
330
|
+
* @description: Get default sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
|
|
331
|
+
*/
|
|
332
|
+
getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
|
|
333
|
+
/**
|
|
334
|
+
* @param {CommunicationPlatformApplicationValidator.GetDummyDatasourcesParam} arg
|
|
335
|
+
* - Arg object
|
|
336
|
+
*
|
|
337
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
338
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
|
+
* @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
|
|
340
|
+
* Success response
|
|
341
|
+
* @name getDummyDatasources
|
|
342
|
+
* @summary: Get dummy data sources
|
|
343
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
|
|
344
|
+
*/
|
|
345
|
+
getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
|
|
346
|
+
/**
|
|
347
|
+
* @param {CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam} arg
|
|
348
|
+
* - Arg object
|
|
349
|
+
*
|
|
350
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
351
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
352
|
+
* @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
|
|
353
|
+
* Success response
|
|
354
|
+
* @name getDummyDatasourcesMeta
|
|
355
|
+
* @summary: Get dummy data sources meta
|
|
356
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get dummy data sources meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
357
|
+
*/
|
|
358
|
+
getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
|
|
359
|
+
/**
|
|
360
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam} arg
|
|
361
|
+
* - Arg object
|
|
362
|
+
*
|
|
363
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
364
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
365
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
366
|
+
* @name getEmailProviderById
|
|
164
367
|
* @summary: Get email provider by id
|
|
165
|
-
* @description: Get email provider by id
|
|
368
|
+
* @description: Get email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
|
|
166
369
|
*/
|
|
167
|
-
getEmailProviderById({ id }?: {
|
|
168
|
-
|
|
169
|
-
|
|
370
|
+
getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
371
|
+
/**
|
|
372
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailProvidersParam} arg
|
|
373
|
+
* - Arg object
|
|
374
|
+
*
|
|
375
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
376
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
377
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
378
|
+
* @name getEmailProviders
|
|
379
|
+
* @summary: Get email providers
|
|
380
|
+
* @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
381
|
+
*/
|
|
382
|
+
getEmailProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
170
383
|
/**
|
|
171
384
|
* @param {Object} arg - Arg object.
|
|
172
|
-
* @param {
|
|
385
|
+
* @param {string} arg.companyId - Company id
|
|
386
|
+
* @param {string} arg.applicationId - Application id
|
|
173
387
|
* @param {number} [arg.pageSize] - Current request items count
|
|
174
388
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
175
|
-
* @returns {
|
|
389
|
+
* @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
|
|
176
390
|
* @summary: Get email providers
|
|
177
391
|
* @description: Get email providers
|
|
178
392
|
*/
|
|
179
|
-
|
|
180
|
-
|
|
393
|
+
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
394
|
+
companyId: string;
|
|
395
|
+
applicationId: string;
|
|
181
396
|
pageSize?: number;
|
|
182
397
|
sort?: any;
|
|
183
|
-
}):
|
|
184
|
-
/**
|
|
185
|
-
* @param {
|
|
186
|
-
*
|
|
187
|
-
*
|
|
398
|
+
}): Paginator<CommunicationPlatformModel.EmailProviders>;
|
|
399
|
+
/**
|
|
400
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
|
|
401
|
+
* - Arg object
|
|
402
|
+
*
|
|
403
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
404
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
405
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
406
|
+
* @name getEmailTemplateById
|
|
188
407
|
* @summary: Get email template by id
|
|
189
|
-
* @description:
|
|
408
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
|
|
190
409
|
*/
|
|
191
|
-
getEmailTemplateById({ id }?: {
|
|
192
|
-
|
|
193
|
-
|
|
410
|
+
getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
411
|
+
/**
|
|
412
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplatesParam} arg
|
|
413
|
+
* - Arg object
|
|
414
|
+
*
|
|
415
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
416
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
417
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
418
|
+
* @name getEmailTemplates
|
|
419
|
+
* @summary: Get email templates
|
|
420
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
|
|
421
|
+
*/
|
|
422
|
+
getEmailTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
194
423
|
/**
|
|
195
424
|
* @param {Object} arg - Arg object.
|
|
196
|
-
* @param {
|
|
425
|
+
* @param {string} arg.companyId - Company id
|
|
426
|
+
* @param {string} arg.applicationId - Application id
|
|
197
427
|
* @param {number} [arg.pageSize] - Current request items count
|
|
198
428
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
199
|
-
* @returns {
|
|
429
|
+
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
200
430
|
* @summary: Get email templates
|
|
201
|
-
* @description:
|
|
431
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.
|
|
202
432
|
*/
|
|
203
|
-
|
|
204
|
-
|
|
433
|
+
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
434
|
+
companyId: string;
|
|
435
|
+
applicationId: string;
|
|
205
436
|
pageSize?: number;
|
|
206
437
|
sort?: any;
|
|
207
|
-
}):
|
|
438
|
+
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
439
|
+
/**
|
|
440
|
+
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
|
|
441
|
+
* - Arg object
|
|
442
|
+
*
|
|
443
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
444
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
445
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
|
|
446
|
+
* Success response
|
|
447
|
+
* @name getEventSubscriptions
|
|
448
|
+
* @summary: Get event subscriptions
|
|
449
|
+
* @description: Get event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
|
|
450
|
+
*/
|
|
451
|
+
getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
208
452
|
/**
|
|
209
453
|
* @param {Object} arg - Arg object.
|
|
210
|
-
* @param {
|
|
454
|
+
* @param {string} arg.companyId - Company id
|
|
455
|
+
* @param {string} arg.applicationId - Application id
|
|
211
456
|
* @param {number} [arg.pageSize] - Current request items count
|
|
212
457
|
* @param {string} [arg.populate] - Populate fields
|
|
213
|
-
* @returns {
|
|
458
|
+
* @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
|
|
214
459
|
* @summary: Get event subscriptions
|
|
215
460
|
* @description: Get event subscriptions
|
|
216
461
|
*/
|
|
217
|
-
|
|
218
|
-
|
|
462
|
+
getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
|
|
463
|
+
companyId: string;
|
|
464
|
+
applicationId: string;
|
|
219
465
|
pageSize?: number;
|
|
220
466
|
populate?: string;
|
|
221
|
-
}):
|
|
467
|
+
}): Paginator<CommunicationPlatformModel.EventSubscriptions>;
|
|
468
|
+
/**
|
|
469
|
+
* @param {CommunicationPlatformApplicationValidator.GetGlobalProvidersParam} arg
|
|
470
|
+
* - Arg object
|
|
471
|
+
*
|
|
472
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
473
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
474
|
+
* @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
|
|
475
|
+
* @name getGlobalProviders
|
|
476
|
+
* @summary: Get global providers
|
|
477
|
+
* @description: Using this API, will retrieve a list of global providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
|
|
478
|
+
*/
|
|
479
|
+
getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
|
|
480
|
+
/**
|
|
481
|
+
* @param {CommunicationPlatformApplicationValidator.GetGlobalVariablesParam} arg
|
|
482
|
+
* - Arg object
|
|
483
|
+
*
|
|
484
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
485
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
486
|
+
* @returns {Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>}
|
|
487
|
+
* - Success response
|
|
488
|
+
*
|
|
489
|
+
* @name getGlobalVariables
|
|
490
|
+
* @summary: get global variables
|
|
491
|
+
* @description: get global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
|
|
492
|
+
*/
|
|
493
|
+
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>;
|
|
494
|
+
/**
|
|
495
|
+
* @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
|
|
496
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
497
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
498
|
+
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
499
|
+
* @name getJobLogs
|
|
500
|
+
* @summary: Get job logs
|
|
501
|
+
* @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
502
|
+
*/
|
|
503
|
+
getJobLogs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
222
504
|
/**
|
|
223
505
|
* @param {Object} arg - Arg object.
|
|
224
|
-
* @param {
|
|
506
|
+
* @param {string} arg.companyId - Company id
|
|
507
|
+
* @param {string} arg.applicationId - Application id
|
|
225
508
|
* @param {number} [arg.pageSize] - Current request items count
|
|
226
509
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
227
|
-
* @returns {
|
|
510
|
+
* @returns {Paginator<CommunicationPlatformModel.JobLogs>}
|
|
228
511
|
* @summary: Get job logs
|
|
229
512
|
* @description: Get job logs
|
|
230
513
|
*/
|
|
231
|
-
|
|
232
|
-
|
|
514
|
+
getJobLogsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
515
|
+
companyId: string;
|
|
516
|
+
applicationId: string;
|
|
233
517
|
pageSize?: number;
|
|
234
518
|
sort?: any;
|
|
235
|
-
}):
|
|
519
|
+
}): Paginator<CommunicationPlatformModel.JobLogs>;
|
|
520
|
+
/**
|
|
521
|
+
* @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
|
|
522
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
523
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
524
|
+
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
525
|
+
* @name getJobs
|
|
526
|
+
* @summary: Get jobs
|
|
527
|
+
* @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
528
|
+
*/
|
|
529
|
+
getJobs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
236
530
|
/**
|
|
237
531
|
* @param {Object} arg - Arg object.
|
|
238
|
-
* @param {
|
|
532
|
+
* @param {string} arg.companyId - Company id
|
|
533
|
+
* @param {string} arg.applicationId - Application id
|
|
239
534
|
* @param {number} [arg.pageSize] - Current request items count
|
|
240
535
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
241
|
-
* @returns {
|
|
536
|
+
* @returns {Paginator<CommunicationPlatformModel.Jobs>}
|
|
242
537
|
* @summary: Get jobs
|
|
243
538
|
* @description: Get jobs
|
|
244
539
|
*/
|
|
245
|
-
|
|
246
|
-
|
|
540
|
+
getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
541
|
+
companyId: string;
|
|
542
|
+
applicationId: string;
|
|
247
543
|
pageSize?: number;
|
|
248
544
|
sort?: any;
|
|
249
|
-
}):
|
|
545
|
+
}): Paginator<CommunicationPlatformModel.Jobs>;
|
|
546
|
+
/**
|
|
547
|
+
* @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
|
|
548
|
+
* - Arg object
|
|
549
|
+
*
|
|
550
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
551
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
552
|
+
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
553
|
+
* @name getNSampleRecordsFromCsv
|
|
554
|
+
* @summary: Get n sample records from csv
|
|
555
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get n sample records from csv - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsv/).
|
|
556
|
+
*/
|
|
557
|
+
getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
250
558
|
/**
|
|
251
|
-
* @param {
|
|
252
|
-
*
|
|
253
|
-
*
|
|
559
|
+
* @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvByGetParam} arg
|
|
560
|
+
* - Arg object
|
|
561
|
+
*
|
|
562
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
563
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
564
|
+
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
565
|
+
* @name getNSampleRecordsFromCsvByGet
|
|
254
566
|
* @summary: Get n sample records from csv
|
|
255
|
-
* @description:
|
|
567
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get n sample records from csv. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
256
568
|
*/
|
|
257
|
-
|
|
258
|
-
body: GetNRecordsCsvReq;
|
|
259
|
-
}): Promise<GetNRecordsCsvRes>;
|
|
569
|
+
getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
260
570
|
/**
|
|
261
|
-
* @param {
|
|
262
|
-
*
|
|
263
|
-
*
|
|
571
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam} arg
|
|
572
|
+
* - Arg object
|
|
573
|
+
*
|
|
574
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
575
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
576
|
+
* @returns {Promise<Object>} - Success response
|
|
577
|
+
* @name getSmsProviderById
|
|
264
578
|
* @summary: Get sms provider by id
|
|
265
|
-
* @description: Get sms provider by id
|
|
579
|
+
* @description: Get sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
|
|
266
580
|
*/
|
|
267
|
-
getSmsProviderById({ id }?: {
|
|
268
|
-
id: string;
|
|
269
|
-
}): Promise<SmsProvider>;
|
|
581
|
+
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
270
582
|
/**
|
|
271
|
-
* @param {
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
* @param {
|
|
275
|
-
* @
|
|
583
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsProvidersParam} arg
|
|
584
|
+
* - Arg object
|
|
585
|
+
*
|
|
586
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
587
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
588
|
+
* @returns {Promise<Object>} - Success response
|
|
589
|
+
* @name getSmsProviders
|
|
276
590
|
* @summary: Get sms providers
|
|
277
|
-
* @description: Get sms providers
|
|
591
|
+
* @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
|
|
278
592
|
*/
|
|
279
|
-
getSmsProviders({ pageNo, pageSize, sort }?: {
|
|
280
|
-
pageNo?: number;
|
|
281
|
-
pageSize?: number;
|
|
282
|
-
sort?: any;
|
|
283
|
-
}): Promise<SmsProviders>;
|
|
593
|
+
getSmsProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
|
|
284
594
|
/**
|
|
285
|
-
* @param {
|
|
286
|
-
*
|
|
287
|
-
*
|
|
595
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
|
|
596
|
+
* - Arg object
|
|
597
|
+
*
|
|
598
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
599
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
600
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
601
|
+
* @name getSmsTemplateById
|
|
288
602
|
* @summary: Get sms template by id
|
|
289
|
-
* @description:
|
|
603
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
|
|
604
|
+
*/
|
|
605
|
+
getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
606
|
+
/**
|
|
607
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsTemplatesParam} arg
|
|
608
|
+
* - Arg object
|
|
609
|
+
*
|
|
610
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
611
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
612
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
613
|
+
* @name getSmsTemplates
|
|
614
|
+
* @summary: Get sms templates
|
|
615
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
|
|
290
616
|
*/
|
|
291
|
-
|
|
292
|
-
id: string;
|
|
293
|
-
}): Promise<SmsTemplate>;
|
|
617
|
+
getSmsTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
294
618
|
/**
|
|
295
619
|
* @param {Object} arg - Arg object.
|
|
296
|
-
* @param {
|
|
620
|
+
* @param {string} arg.companyId - Company id
|
|
621
|
+
* @param {string} arg.applicationId - Application id
|
|
297
622
|
* @param {number} [arg.pageSize] - Current request items count
|
|
298
623
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
299
|
-
* @returns {
|
|
624
|
+
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
300
625
|
* @summary: Get sms templates
|
|
301
|
-
* @description:
|
|
626
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.
|
|
302
627
|
*/
|
|
303
|
-
|
|
304
|
-
|
|
628
|
+
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
629
|
+
companyId: string;
|
|
630
|
+
applicationId: string;
|
|
305
631
|
pageSize?: number;
|
|
306
632
|
sort?: any;
|
|
307
|
-
}):
|
|
308
|
-
/**
|
|
309
|
-
* @param {
|
|
310
|
-
*
|
|
311
|
-
*
|
|
633
|
+
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
634
|
+
/**
|
|
635
|
+
* @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
|
|
636
|
+
* - Arg object
|
|
637
|
+
*
|
|
638
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
639
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
640
|
+
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
641
|
+
* @name getStatsOfCampaignById
|
|
312
642
|
* @summary: Get stats of campaign by id
|
|
313
|
-
* @description: Get stats of campaign by id
|
|
643
|
+
* @description: Get stats of campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
|
|
644
|
+
*/
|
|
645
|
+
getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
|
|
646
|
+
/**
|
|
647
|
+
* @param {CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam} arg
|
|
648
|
+
* - Arg object
|
|
649
|
+
*
|
|
650
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
651
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
652
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
653
|
+
* @name getSubscribedEmailTemplates
|
|
654
|
+
* @summary: Get subscribed email templates
|
|
655
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
314
656
|
*/
|
|
315
|
-
|
|
316
|
-
id: string;
|
|
317
|
-
}): Promise<GetStats>;
|
|
657
|
+
getSubscribedEmailTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
318
658
|
/**
|
|
319
659
|
* @param {Object} arg - Arg object.
|
|
320
|
-
* @param {
|
|
660
|
+
* @param {string} arg.companyId - Company id
|
|
661
|
+
* @param {string} arg.applicationId - Application id
|
|
321
662
|
* @param {number} [arg.pageSize] - Current request items count
|
|
322
|
-
* @
|
|
323
|
-
* @
|
|
324
|
-
* @
|
|
325
|
-
* @description: Get system email templates
|
|
663
|
+
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
664
|
+
* @summary: Get subscribed email templates
|
|
665
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.
|
|
326
666
|
*/
|
|
327
|
-
|
|
328
|
-
|
|
667
|
+
getSubscribedEmailTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
|
|
668
|
+
companyId: string;
|
|
669
|
+
applicationId: string;
|
|
329
670
|
pageSize?: number;
|
|
330
|
-
|
|
331
|
-
|
|
671
|
+
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
672
|
+
/**
|
|
673
|
+
* @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
|
|
674
|
+
* - Arg object
|
|
675
|
+
*
|
|
676
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
677
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
678
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
679
|
+
* @name getSubscribedSmsTemplates
|
|
680
|
+
* @summary: Get subscribed sms templates
|
|
681
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
682
|
+
*/
|
|
683
|
+
getSubscribedSmsTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
332
684
|
/**
|
|
333
685
|
* @param {Object} arg - Arg object.
|
|
334
|
-
* @param {
|
|
686
|
+
* @param {string} arg.companyId - Company id
|
|
687
|
+
* @param {string} arg.applicationId - Application id
|
|
335
688
|
* @param {number} [arg.pageSize] - Current request items count
|
|
336
|
-
* @
|
|
337
|
-
* @
|
|
338
|
-
* @
|
|
339
|
-
* @description: Get system sms templates
|
|
689
|
+
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
690
|
+
* @summary: Get subscribed sms templates
|
|
691
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates.
|
|
340
692
|
*/
|
|
341
|
-
|
|
342
|
-
|
|
693
|
+
getSubscribedSmsTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
|
|
694
|
+
companyId: string;
|
|
695
|
+
applicationId: string;
|
|
343
696
|
pageSize?: number;
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
* @
|
|
697
|
+
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
698
|
+
/**
|
|
699
|
+
* @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
|
|
700
|
+
* - Arg object
|
|
701
|
+
*
|
|
702
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
703
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
704
|
+
* @returns {Promise<Object>} - Success response
|
|
705
|
+
* @name getSystemAudiences
|
|
706
|
+
* @summary: Get system audiences
|
|
707
|
+
* @description: Get system audiences - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
|
|
708
|
+
*/
|
|
709
|
+
getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
710
|
+
/**
|
|
711
|
+
* @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
|
|
712
|
+
* - Arg object
|
|
713
|
+
*
|
|
714
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
715
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
716
|
+
* @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
|
|
717
|
+
* Success response
|
|
718
|
+
* @name getSystemEmailTemplates
|
|
719
|
+
* @summary: Get system email templates
|
|
720
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all system email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
|
|
721
|
+
*/
|
|
722
|
+
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
|
|
723
|
+
/**
|
|
724
|
+
* @param {CommunicationPlatformApplicationValidator.GetSystemSmsTemplatesParam} arg
|
|
725
|
+
* - Arg object
|
|
726
|
+
*
|
|
727
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
728
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
729
|
+
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
|
|
730
|
+
* Success response
|
|
731
|
+
* @name getSystemSmsTemplates
|
|
732
|
+
* @summary: Get system sms templates
|
|
733
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all system sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
|
|
734
|
+
*/
|
|
735
|
+
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates[]>;
|
|
736
|
+
/**
|
|
737
|
+
* @param {CommunicationPlatformApplicationValidator.PostGlobalVariablesParam} arg
|
|
738
|
+
* - Arg object
|
|
739
|
+
*
|
|
740
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
741
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
742
|
+
* @returns {Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>}
|
|
743
|
+
* - Success response
|
|
744
|
+
*
|
|
745
|
+
* @name postGlobalVariables
|
|
746
|
+
* @summary: post global variables
|
|
747
|
+
* @description: psot global variables - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
|
|
748
|
+
*/
|
|
749
|
+
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>;
|
|
750
|
+
/**
|
|
751
|
+
* @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
|
|
752
|
+
* - Arg object
|
|
753
|
+
*
|
|
754
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
755
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
756
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
757
|
+
* @name sendCommunicationAsynchronously
|
|
350
758
|
* @summary: Send email or sms asynchronously
|
|
351
|
-
* @description: Send email or sms asynchronously
|
|
759
|
+
* @description: Send email or sms asynchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
352
760
|
*/
|
|
353
|
-
sendCommunicationAsynchronously({ body }?: {
|
|
354
|
-
body: EngineRequest;
|
|
355
|
-
}): Promise<EngineResponse>;
|
|
761
|
+
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
|
|
356
762
|
/**
|
|
357
|
-
* @param {
|
|
358
|
-
*
|
|
359
|
-
*
|
|
763
|
+
* @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
|
|
764
|
+
* - Arg object
|
|
765
|
+
*
|
|
766
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
767
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
768
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
769
|
+
* @name sendCommunicationSynchronously
|
|
360
770
|
* @summary: Send email or sms synchronously
|
|
361
|
-
* @description: Send email or sms synchronously
|
|
771
|
+
* @description: Send email or sms synchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
362
772
|
*/
|
|
363
|
-
sendCommunicationSynchronously({ body }?: {
|
|
364
|
-
body: EngineRequest;
|
|
365
|
-
}): Promise<EngineResponse>;
|
|
773
|
+
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
|
|
366
774
|
/**
|
|
367
|
-
* @param {
|
|
368
|
-
* @param {
|
|
369
|
-
* @
|
|
775
|
+
* @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
|
|
776
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
777
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
778
|
+
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
779
|
+
* @name sendOtp
|
|
370
780
|
* @summary: Send OTP using email and sms
|
|
371
|
-
* @description: Send OTP Comms via email and sms
|
|
372
|
-
*/
|
|
373
|
-
sendOtp({ body }?: {
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
*
|
|
378
|
-
* @param {
|
|
379
|
-
* @
|
|
781
|
+
* @description: Send OTP Comms via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
|
|
782
|
+
*/
|
|
783
|
+
sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
784
|
+
/**
|
|
785
|
+
* @param {CommunicationPlatformApplicationValidator.TriggerCampaignJobParam} arg
|
|
786
|
+
* - Arg object
|
|
787
|
+
*
|
|
788
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
789
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
790
|
+
* @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
|
|
791
|
+
* Success response
|
|
792
|
+
* @name triggerCampaignJob
|
|
380
793
|
* @summary: Trigger campaign job
|
|
381
|
-
* @description: Trigger campaign job
|
|
382
|
-
*/
|
|
383
|
-
triggerCampaignJob({ body }?: {
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
*
|
|
388
|
-
* @param {
|
|
389
|
-
* @param {
|
|
390
|
-
* @returns {Promise<
|
|
794
|
+
* @description: Trigger campaign job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
|
|
795
|
+
*/
|
|
796
|
+
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResponse>;
|
|
797
|
+
/**
|
|
798
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg
|
|
799
|
+
* - Arg object
|
|
800
|
+
*
|
|
801
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
802
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
803
|
+
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
804
|
+
* @name updateAppProviders
|
|
805
|
+
* @summary: update app providers
|
|
806
|
+
* @description: Using this API will update the application providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
|
|
807
|
+
*/
|
|
808
|
+
updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
809
|
+
/**
|
|
810
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam} arg
|
|
811
|
+
* - Arg object
|
|
812
|
+
*
|
|
813
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
814
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
815
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
816
|
+
* @name updateAudienceById
|
|
391
817
|
* @summary: Update audience by id
|
|
392
|
-
* @description:
|
|
818
|
+
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to update audience by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
|
|
393
819
|
*/
|
|
394
|
-
updateAudienceById({ id, body }?: {
|
|
395
|
-
id: string;
|
|
396
|
-
body: AudienceReq;
|
|
397
|
-
}): Promise<Audience>;
|
|
820
|
+
updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
398
821
|
/**
|
|
399
|
-
* @param {
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
* @
|
|
822
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam} arg
|
|
823
|
+
* - Arg object
|
|
824
|
+
*
|
|
825
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
826
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
827
|
+
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
828
|
+
* @name updateCampaignById
|
|
403
829
|
* @summary: Update campaign by id
|
|
404
|
-
* @description: Update campaign by id
|
|
830
|
+
* @description: Update campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
|
|
405
831
|
*/
|
|
406
|
-
updateCampaignById({ id, body }?: {
|
|
407
|
-
id: string;
|
|
408
|
-
body: CampaignReq;
|
|
409
|
-
}): Promise<Campaign>;
|
|
832
|
+
updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
410
833
|
/**
|
|
411
|
-
* @param {
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
* @
|
|
834
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam} arg
|
|
835
|
+
* - Arg object
|
|
836
|
+
*
|
|
837
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
838
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
839
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
840
|
+
* @name updateEmailProviderById
|
|
415
841
|
* @summary: Update email provider by id
|
|
416
|
-
* @description: Update email provider by id
|
|
842
|
+
* @description: Update email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
|
|
417
843
|
*/
|
|
418
|
-
updateEmailProviderById({ id, body }?: {
|
|
419
|
-
id: string;
|
|
420
|
-
body: EmailProviderReq;
|
|
421
|
-
}): Promise<EmailProvider>;
|
|
844
|
+
updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
422
845
|
/**
|
|
423
|
-
* @param {
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
* @
|
|
846
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam} arg
|
|
847
|
+
* - Arg object
|
|
848
|
+
*
|
|
849
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
850
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
851
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
852
|
+
* @name updateEmailTemplateById
|
|
427
853
|
* @summary: Update email template by id
|
|
428
|
-
* @description:
|
|
854
|
+
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to update an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
|
|
429
855
|
*/
|
|
430
|
-
updateEmailTemplateById({ id, body }?: {
|
|
431
|
-
id: string;
|
|
432
|
-
body: EmailTemplateReq;
|
|
433
|
-
}): Promise<EmailTemplateRes>;
|
|
856
|
+
updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
434
857
|
/**
|
|
435
|
-
* @param {
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
* @
|
|
858
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
|
|
859
|
+
* - Arg object
|
|
860
|
+
*
|
|
861
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
862
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
863
|
+
* @returns {Promise<Object>} - Success response
|
|
864
|
+
* @name updateSmsProviderById
|
|
439
865
|
* @summary: Update sms provider by id
|
|
440
|
-
* @description: Update sms provider by id
|
|
866
|
+
* @description: Update sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
|
|
441
867
|
*/
|
|
442
|
-
updateSmsProviderById({ id, body }?: {
|
|
443
|
-
id: string;
|
|
444
|
-
body: SmsProviderReq;
|
|
445
|
-
}): Promise<SmsProvider>;
|
|
868
|
+
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
446
869
|
/**
|
|
447
|
-
* @param {
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
* @
|
|
870
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam} arg
|
|
871
|
+
* - Arg object
|
|
872
|
+
*
|
|
873
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
874
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
875
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
876
|
+
* @name updateSmsTemplateById
|
|
451
877
|
* @summary: Update sms template by id
|
|
452
|
-
* @description:
|
|
878
|
+
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to update an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
|
|
453
879
|
*/
|
|
454
|
-
updateSmsTemplateById({ id, body }?: {
|
|
455
|
-
id: string;
|
|
456
|
-
body: SmsTemplateReq;
|
|
457
|
-
}): Promise<SmsTemplateRes>;
|
|
880
|
+
updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
458
881
|
/**
|
|
459
|
-
* @param {
|
|
460
|
-
* @param {
|
|
461
|
-
* @
|
|
882
|
+
* @param {CommunicationPlatformApplicationValidator.VerfiyOtpParam} arg - Arg object
|
|
883
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
884
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
885
|
+
* @returns {Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>}
|
|
886
|
+
* - Success response
|
|
887
|
+
*
|
|
888
|
+
* @name verfiyOtp
|
|
462
889
|
* @summary: Verify OTP sent via email and sms
|
|
463
|
-
* @description: Verify OTP sent via email and sms
|
|
890
|
+
* @description: Verify OTP sent via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
|
|
464
891
|
*/
|
|
465
|
-
verfiyOtp({ body }?: {
|
|
466
|
-
body: VerifyOtpCommsReq;
|
|
467
|
-
}): Promise<VerifyOtpCommsSuccessRes>;
|
|
892
|
+
verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
|
|
468
893
|
}
|
|
894
|
+
import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator");
|
|
895
|
+
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
896
|
+
import Paginator = require("../../common/Paginator");
|