@gofynd/fdk-client-javascript 1.1.6 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -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 +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -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 +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -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 +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -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 +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -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 +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -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 +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -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 +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -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 +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -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 +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -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 +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -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 +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -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 +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -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 +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -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 +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -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 +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -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 +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- 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 +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -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/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -4,465 +4,643 @@ 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 {import("../PlatformAPIClient").Options} - Options
|
|
11
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
12
|
+
* @name createAudience
|
|
10
13
|
* @summary: Create audience
|
|
11
|
-
* @description: Create audience
|
|
14
|
+
* @description: Create audience - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
|
|
12
15
|
*/
|
|
13
|
-
createAudience({ body }?: {
|
|
14
|
-
body: AudienceReq;
|
|
15
|
-
}): Promise<Audience>;
|
|
16
|
+
createAudience({ body }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audience>;
|
|
16
17
|
/**
|
|
17
|
-
* @param {
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
|
|
19
|
+
* - Arg object
|
|
20
|
+
*
|
|
21
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
+
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
23
|
+
* @name createCampaign
|
|
20
24
|
* @summary: Create campaign
|
|
21
|
-
* @description: Create campaign
|
|
25
|
+
* @description: Create campaign - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
|
|
22
26
|
*/
|
|
23
|
-
createCampaign({ body }?: {
|
|
24
|
-
body: CampaignReq;
|
|
25
|
-
}): Promise<Campaign>;
|
|
27
|
+
createCampaign({ body }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaign>;
|
|
26
28
|
/**
|
|
27
|
-
* @param {
|
|
28
|
-
*
|
|
29
|
-
*
|
|
29
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEmailProviderParam} arg
|
|
30
|
+
* - Arg object
|
|
31
|
+
*
|
|
32
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
33
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
34
|
+
* @name createEmailProvider
|
|
30
35
|
* @summary: Create email provider
|
|
31
|
-
* @description: Create email provider
|
|
36
|
+
* @description: Create email provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
|
|
32
37
|
*/
|
|
33
|
-
createEmailProvider({ body }?: {
|
|
34
|
-
body: EmailProviderReq;
|
|
35
|
-
}): Promise<EmailProvider>;
|
|
38
|
+
createEmailProvider({ body }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
36
39
|
/**
|
|
37
|
-
* @param {
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEmailTemplateParam} arg
|
|
41
|
+
* - Arg object
|
|
42
|
+
*
|
|
43
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
44
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplateRes>} - Success response
|
|
45
|
+
* @name createEmailTemplate
|
|
40
46
|
* @summary: Create email template
|
|
41
|
-
* @description: Create email template
|
|
47
|
+
* @description: Create email template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
|
|
42
48
|
*/
|
|
43
|
-
createEmailTemplate({ body }?: {
|
|
44
|
-
body: EmailTemplateReq;
|
|
45
|
-
}): Promise<EmailTemplateRes>;
|
|
49
|
+
createEmailTemplate({ body }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplateRes>;
|
|
46
50
|
/**
|
|
47
|
-
* @param {
|
|
48
|
-
*
|
|
49
|
-
*
|
|
51
|
+
* @param {CommunicationPlatformApplicationValidator.CreateSmsProviderParam} arg
|
|
52
|
+
* - Arg object
|
|
53
|
+
*
|
|
54
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
55
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
|
|
56
|
+
* @name createSmsProvider
|
|
50
57
|
* @summary: Create sms provider
|
|
51
|
-
* @description: Create sms provider
|
|
58
|
+
* @description: Create sms provider - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
|
|
52
59
|
*/
|
|
53
|
-
createSmsProvider({ body }?: {
|
|
54
|
-
body: SmsProviderReq;
|
|
55
|
-
}): Promise<SmsProvider>;
|
|
60
|
+
createSmsProvider({ body }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProvider>;
|
|
56
61
|
/**
|
|
57
|
-
* @param {
|
|
58
|
-
*
|
|
59
|
-
*
|
|
62
|
+
* @param {CommunicationPlatformApplicationValidator.CreateSmsTemplateParam} arg
|
|
63
|
+
* - Arg object
|
|
64
|
+
*
|
|
65
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
66
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplateRes>} - Success response
|
|
67
|
+
* @name createSmsTemplate
|
|
60
68
|
* @summary: Create sms template
|
|
61
|
-
* @description: Create sms template
|
|
62
|
-
*/
|
|
63
|
-
createSmsTemplate({ body }?: {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
*
|
|
68
|
-
* @param {
|
|
69
|
-
* @returns {Promise<EmailTemplateDeleteSuccessRes>}
|
|
69
|
+
* @description: Create sms template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
|
|
70
|
+
*/
|
|
71
|
+
createSmsTemplate({ body }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplateRes>;
|
|
72
|
+
/**
|
|
73
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg
|
|
74
|
+
* - Arg object
|
|
75
|
+
*
|
|
76
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
77
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplateDeleteSuccessRes>}
|
|
78
|
+
* - Success response
|
|
79
|
+
*
|
|
80
|
+
* @name deleteEmailTemplateById
|
|
70
81
|
* @summary: Delete email template by id
|
|
71
|
-
* @description: Delete email template by id
|
|
72
|
-
*/
|
|
73
|
-
deleteEmailTemplateById({ id }?: {
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
*
|
|
78
|
-
* @param {
|
|
79
|
-
* @returns {Promise<SmsTemplateDeleteSuccessRes>}
|
|
82
|
+
* @description: Delete email template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
|
|
83
|
+
*/
|
|
84
|
+
deleteEmailTemplateById({ id }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplateDeleteSuccessRes>;
|
|
85
|
+
/**
|
|
86
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg
|
|
87
|
+
* - Arg object
|
|
88
|
+
*
|
|
89
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplateDeleteSuccessRes>}
|
|
91
|
+
* - Success response
|
|
92
|
+
*
|
|
93
|
+
* @name deleteSmsTemplateById
|
|
80
94
|
* @summary: Delete sms template by id
|
|
81
|
-
* @description: Delete sms template by id
|
|
95
|
+
* @description: Delete sms template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
|
|
82
96
|
*/
|
|
83
|
-
deleteSmsTemplateById({ id }?: {
|
|
84
|
-
id: string;
|
|
85
|
-
}): Promise<SmsTemplateDeleteSuccessRes>;
|
|
97
|
+
deleteSmsTemplateById({ id }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplateDeleteSuccessRes>;
|
|
86
98
|
/**
|
|
87
|
-
* @param {
|
|
88
|
-
*
|
|
89
|
-
*
|
|
99
|
+
* @param {CommunicationPlatformApplicationValidator.GetAudienceByIdParam} arg
|
|
100
|
+
* - Arg object
|
|
101
|
+
*
|
|
102
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
104
|
+
* @name getAudienceById
|
|
90
105
|
* @summary: Get audience by id
|
|
91
|
-
* @description: Get audience by id
|
|
106
|
+
* @description: Get audience by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
|
|
92
107
|
*/
|
|
93
|
-
getAudienceById({ id }?: {
|
|
94
|
-
|
|
95
|
-
|
|
108
|
+
getAudienceById({ id }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audience>;
|
|
109
|
+
/**
|
|
110
|
+
* @param {CommunicationPlatformApplicationValidator.GetAudiencesParam} arg
|
|
111
|
+
* - Arg object
|
|
112
|
+
*
|
|
113
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
114
|
+
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
115
|
+
* @name getAudiences
|
|
116
|
+
* @summary: Get audiences
|
|
117
|
+
* @description: Get audiences - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
|
|
118
|
+
*/
|
|
119
|
+
getAudiences({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audiences>;
|
|
96
120
|
/**
|
|
97
121
|
* @param {Object} arg - Arg object.
|
|
98
|
-
* @param {
|
|
122
|
+
* @param {string} arg.companyId - Company id
|
|
123
|
+
* @param {string} arg.applicationId - Application id
|
|
99
124
|
* @param {number} [arg.pageSize] - Current request items count
|
|
100
125
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
101
|
-
* @returns {
|
|
126
|
+
* @returns {Paginator<CommunicationPlatformModel.Audiences>}
|
|
102
127
|
* @summary: Get audiences
|
|
103
128
|
* @description: Get audiences
|
|
104
129
|
*/
|
|
105
|
-
|
|
106
|
-
|
|
130
|
+
getAudiencesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
131
|
+
companyId: string;
|
|
132
|
+
applicationId: string;
|
|
107
133
|
pageSize?: number;
|
|
108
134
|
sort?: any;
|
|
109
|
-
}):
|
|
110
|
-
/**
|
|
111
|
-
* @param {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
135
|
+
}): Paginator<CommunicationPlatformModel.Audiences>;
|
|
136
|
+
/**
|
|
137
|
+
* @param {CommunicationPlatformApplicationValidator.GetBigqueryHeadersParam} arg
|
|
138
|
+
* - Arg object
|
|
139
|
+
*
|
|
140
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
141
|
+
* @returns {Promise<CommunicationPlatformModel.BigqueryHeadersRes>} -
|
|
142
|
+
* Success response
|
|
143
|
+
* @name getBigqueryHeaders
|
|
114
144
|
* @summary: Get bigquery headers
|
|
115
|
-
* @description: Get bigquery headers
|
|
145
|
+
* @description: Get bigquery headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigqueryHeaders/).
|
|
116
146
|
*/
|
|
117
|
-
getBigqueryHeaders({ body }?: {
|
|
118
|
-
body: BigqueryHeadersReq;
|
|
119
|
-
}): Promise<BigqueryHeadersRes>;
|
|
147
|
+
getBigqueryHeaders({ body }?: CommunicationPlatformApplicationValidator.GetBigqueryHeadersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.BigqueryHeadersRes>;
|
|
120
148
|
/**
|
|
121
|
-
* @param {
|
|
122
|
-
*
|
|
123
|
-
*
|
|
149
|
+
* @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
|
|
150
|
+
* - Arg object
|
|
151
|
+
*
|
|
152
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
153
|
+
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
154
|
+
* @name getCampaignById
|
|
124
155
|
* @summary: Get campaign by id
|
|
125
|
-
* @description: Get campaign by id
|
|
156
|
+
* @description: Get campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
|
|
126
157
|
*/
|
|
127
|
-
getCampaignById({ id }?: {
|
|
128
|
-
|
|
129
|
-
|
|
158
|
+
getCampaignById({ id }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaign>;
|
|
159
|
+
/**
|
|
160
|
+
* @param {CommunicationPlatformApplicationValidator.GetCampaignsParam} arg
|
|
161
|
+
* - Arg object
|
|
162
|
+
*
|
|
163
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
164
|
+
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
165
|
+
* @name getCampaigns
|
|
166
|
+
* @summary: Get campaigns
|
|
167
|
+
* @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
168
|
+
*/
|
|
169
|
+
getCampaigns({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaigns>;
|
|
130
170
|
/**
|
|
131
171
|
* @param {Object} arg - Arg object.
|
|
132
|
-
* @param {
|
|
172
|
+
* @param {string} arg.companyId - Company id
|
|
173
|
+
* @param {string} arg.applicationId - Application id
|
|
133
174
|
* @param {number} [arg.pageSize] - Current request items count
|
|
134
175
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
135
|
-
* @returns {
|
|
176
|
+
* @returns {Paginator<CommunicationPlatformModel.Campaigns>}
|
|
136
177
|
* @summary: Get campaigns
|
|
137
178
|
* @description: Get campaigns
|
|
138
179
|
*/
|
|
139
|
-
|
|
140
|
-
|
|
180
|
+
getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
181
|
+
companyId: string;
|
|
182
|
+
applicationId: string;
|
|
141
183
|
pageSize?: number;
|
|
142
184
|
sort?: any;
|
|
143
|
-
}):
|
|
185
|
+
}): Paginator<CommunicationPlatformModel.Campaigns>;
|
|
186
|
+
/**
|
|
187
|
+
* @param {CommunicationPlatformApplicationValidator.GetCommunicationLogsParam} arg
|
|
188
|
+
* - Arg object
|
|
189
|
+
*
|
|
190
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
191
|
+
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
192
|
+
* @name getCommunicationLogs
|
|
193
|
+
* @summary: Get communication logs
|
|
194
|
+
* @description: Get communication logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
|
|
195
|
+
*/
|
|
196
|
+
getCommunicationLogs({ pageId, pageSize, sort, query }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Logs>;
|
|
144
197
|
/**
|
|
145
198
|
* @param {Object} arg - Arg object.
|
|
146
|
-
* @param {string}
|
|
199
|
+
* @param {string} arg.companyId - Company id
|
|
200
|
+
* @param {string} arg.applicationId - Application id
|
|
147
201
|
* @param {number} [arg.pageSize] - Current request items count
|
|
148
202
|
* @param {Object} [arg.sort] - To sort based on _id
|
|
149
203
|
* @param {Object} [arg.query] -
|
|
150
|
-
* @returns {
|
|
204
|
+
* @returns {Paginator<CommunicationPlatformModel.Logs>}
|
|
151
205
|
* @summary: Get communication logs
|
|
152
206
|
* @description: Get communication logs
|
|
153
207
|
*/
|
|
154
|
-
|
|
155
|
-
|
|
208
|
+
getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
209
|
+
companyId: string;
|
|
210
|
+
applicationId: string;
|
|
156
211
|
pageSize?: number;
|
|
157
212
|
sort?: any;
|
|
158
213
|
query?: any;
|
|
159
|
-
}):
|
|
160
|
-
/**
|
|
161
|
-
* @param {
|
|
162
|
-
*
|
|
163
|
-
*
|
|
214
|
+
}): Paginator<CommunicationPlatformModel.Logs>;
|
|
215
|
+
/**
|
|
216
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam} arg
|
|
217
|
+
* - Arg object
|
|
218
|
+
*
|
|
219
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
221
|
+
* @name getEmailProviderById
|
|
164
222
|
* @summary: Get email provider by id
|
|
165
|
-
* @description: Get email provider by id
|
|
223
|
+
* @description: Get email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
|
|
224
|
+
*/
|
|
225
|
+
getEmailProviderById({ id }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
226
|
+
/**
|
|
227
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailProvidersParam} arg
|
|
228
|
+
* - Arg object
|
|
229
|
+
*
|
|
230
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
231
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
232
|
+
* @name getEmailProviders
|
|
233
|
+
* @summary: Get email providers
|
|
234
|
+
* @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
166
235
|
*/
|
|
167
|
-
|
|
168
|
-
id: string;
|
|
169
|
-
}): Promise<EmailProvider>;
|
|
236
|
+
getEmailProviders({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
170
237
|
/**
|
|
171
238
|
* @param {Object} arg - Arg object.
|
|
172
|
-
* @param {
|
|
239
|
+
* @param {string} arg.companyId - Company id
|
|
240
|
+
* @param {string} arg.applicationId - Application id
|
|
173
241
|
* @param {number} [arg.pageSize] - Current request items count
|
|
174
242
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
175
|
-
* @returns {
|
|
243
|
+
* @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
|
|
176
244
|
* @summary: Get email providers
|
|
177
245
|
* @description: Get email providers
|
|
178
246
|
*/
|
|
179
|
-
|
|
180
|
-
|
|
247
|
+
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
248
|
+
companyId: string;
|
|
249
|
+
applicationId: string;
|
|
181
250
|
pageSize?: number;
|
|
182
251
|
sort?: any;
|
|
183
|
-
}):
|
|
184
|
-
/**
|
|
185
|
-
* @param {
|
|
186
|
-
*
|
|
187
|
-
*
|
|
252
|
+
}): Paginator<CommunicationPlatformModel.EmailProviders>;
|
|
253
|
+
/**
|
|
254
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
|
|
255
|
+
* - Arg object
|
|
256
|
+
*
|
|
257
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
259
|
+
* @name getEmailTemplateById
|
|
188
260
|
* @summary: Get email template by id
|
|
189
|
-
* @description: Get email template by id
|
|
261
|
+
* @description: Get email template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
|
|
190
262
|
*/
|
|
191
|
-
getEmailTemplateById({ id }?: {
|
|
192
|
-
|
|
193
|
-
|
|
263
|
+
getEmailTemplateById({ id }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
264
|
+
/**
|
|
265
|
+
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplatesParam} arg
|
|
266
|
+
* - Arg object
|
|
267
|
+
*
|
|
268
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
269
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
270
|
+
* @name getEmailTemplates
|
|
271
|
+
* @summary: Get email templates
|
|
272
|
+
* @description: Get email templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
|
|
273
|
+
*/
|
|
274
|
+
getEmailTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
194
275
|
/**
|
|
195
276
|
* @param {Object} arg - Arg object.
|
|
196
|
-
* @param {
|
|
277
|
+
* @param {string} arg.companyId - Company id
|
|
278
|
+
* @param {string} arg.applicationId - Application id
|
|
197
279
|
* @param {number} [arg.pageSize] - Current request items count
|
|
198
280
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
199
|
-
* @returns {
|
|
281
|
+
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
200
282
|
* @summary: Get email templates
|
|
201
283
|
* @description: Get email templates
|
|
202
284
|
*/
|
|
203
|
-
|
|
204
|
-
|
|
285
|
+
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
286
|
+
companyId: string;
|
|
287
|
+
applicationId: string;
|
|
205
288
|
pageSize?: number;
|
|
206
289
|
sort?: any;
|
|
207
|
-
}):
|
|
290
|
+
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
291
|
+
/**
|
|
292
|
+
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
|
|
293
|
+
* - Arg object
|
|
294
|
+
*
|
|
295
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
296
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
|
|
297
|
+
* Success response
|
|
298
|
+
* @name getEventSubscriptions
|
|
299
|
+
* @summary: Get event subscriptions
|
|
300
|
+
* @description: Get event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
|
|
301
|
+
*/
|
|
302
|
+
getEventSubscriptions({ pageNo, pageSize, populate }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
208
303
|
/**
|
|
209
304
|
* @param {Object} arg - Arg object.
|
|
210
|
-
* @param {
|
|
305
|
+
* @param {string} arg.companyId - Company id
|
|
306
|
+
* @param {string} arg.applicationId - Application id
|
|
211
307
|
* @param {number} [arg.pageSize] - Current request items count
|
|
212
308
|
* @param {string} [arg.populate] - Populate fields
|
|
213
|
-
* @returns {
|
|
309
|
+
* @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
|
|
214
310
|
* @summary: Get event subscriptions
|
|
215
311
|
* @description: Get event subscriptions
|
|
216
312
|
*/
|
|
217
|
-
|
|
218
|
-
|
|
313
|
+
getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
|
|
314
|
+
companyId: string;
|
|
315
|
+
applicationId: string;
|
|
219
316
|
pageSize?: number;
|
|
220
317
|
populate?: string;
|
|
221
|
-
}):
|
|
318
|
+
}): Paginator<CommunicationPlatformModel.EventSubscriptions>;
|
|
319
|
+
/**
|
|
320
|
+
* @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
|
|
321
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
322
|
+
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
323
|
+
* @name getJobLogs
|
|
324
|
+
* @summary: Get job logs
|
|
325
|
+
* @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
326
|
+
*/
|
|
327
|
+
getJobLogs({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.JobLogs>;
|
|
222
328
|
/**
|
|
223
329
|
* @param {Object} arg - Arg object.
|
|
224
|
-
* @param {
|
|
330
|
+
* @param {string} arg.companyId - Company id
|
|
331
|
+
* @param {string} arg.applicationId - Application id
|
|
225
332
|
* @param {number} [arg.pageSize] - Current request items count
|
|
226
333
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
227
|
-
* @returns {
|
|
334
|
+
* @returns {Paginator<CommunicationPlatformModel.JobLogs>}
|
|
228
335
|
* @summary: Get job logs
|
|
229
336
|
* @description: Get job logs
|
|
230
337
|
*/
|
|
231
|
-
|
|
232
|
-
|
|
338
|
+
getJobLogsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
339
|
+
companyId: string;
|
|
340
|
+
applicationId: string;
|
|
233
341
|
pageSize?: number;
|
|
234
342
|
sort?: any;
|
|
235
|
-
}):
|
|
343
|
+
}): Paginator<CommunicationPlatformModel.JobLogs>;
|
|
344
|
+
/**
|
|
345
|
+
* @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
|
|
346
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
347
|
+
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
348
|
+
* @name getJobs
|
|
349
|
+
* @summary: Get jobs
|
|
350
|
+
* @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
351
|
+
*/
|
|
352
|
+
getJobs({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetJobsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Jobs>;
|
|
236
353
|
/**
|
|
237
354
|
* @param {Object} arg - Arg object.
|
|
238
|
-
* @param {
|
|
355
|
+
* @param {string} arg.companyId - Company id
|
|
356
|
+
* @param {string} arg.applicationId - Application id
|
|
239
357
|
* @param {number} [arg.pageSize] - Current request items count
|
|
240
358
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
241
|
-
* @returns {
|
|
359
|
+
* @returns {Paginator<CommunicationPlatformModel.Jobs>}
|
|
242
360
|
* @summary: Get jobs
|
|
243
361
|
* @description: Get jobs
|
|
244
362
|
*/
|
|
245
|
-
|
|
246
|
-
|
|
363
|
+
getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
364
|
+
companyId: string;
|
|
365
|
+
applicationId: string;
|
|
247
366
|
pageSize?: number;
|
|
248
367
|
sort?: any;
|
|
249
|
-
}):
|
|
250
|
-
/**
|
|
251
|
-
* @param {
|
|
252
|
-
*
|
|
253
|
-
*
|
|
368
|
+
}): Paginator<CommunicationPlatformModel.Jobs>;
|
|
369
|
+
/**
|
|
370
|
+
* @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
|
|
371
|
+
* - Arg object
|
|
372
|
+
*
|
|
373
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
374
|
+
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
375
|
+
* @name getNSampleRecordsFromCsv
|
|
254
376
|
* @summary: Get n sample records from csv
|
|
255
|
-
* @description: Get n sample records from csv
|
|
377
|
+
* @description: Get n sample records from csv - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsv/).
|
|
256
378
|
*/
|
|
257
|
-
getNSampleRecordsFromCsv({ body }?: {
|
|
258
|
-
body: GetNRecordsCsvReq;
|
|
259
|
-
}): Promise<GetNRecordsCsvRes>;
|
|
379
|
+
getNSampleRecordsFromCsv({ body }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
260
380
|
/**
|
|
261
|
-
* @param {
|
|
262
|
-
*
|
|
263
|
-
*
|
|
381
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam} arg
|
|
382
|
+
* - Arg object
|
|
383
|
+
*
|
|
384
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
385
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
|
|
386
|
+
* @name getSmsProviderById
|
|
264
387
|
* @summary: Get sms provider by id
|
|
265
|
-
* @description: Get sms provider by id
|
|
388
|
+
* @description: Get sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
|
|
266
389
|
*/
|
|
267
|
-
getSmsProviderById({ id }?: {
|
|
268
|
-
|
|
269
|
-
|
|
390
|
+
getSmsProviderById({ id }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProvider>;
|
|
391
|
+
/**
|
|
392
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsProvidersParam} arg
|
|
393
|
+
* - Arg object
|
|
394
|
+
*
|
|
395
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
396
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProviders>} - Success response
|
|
397
|
+
* @name getSmsProviders
|
|
398
|
+
* @summary: Get sms providers
|
|
399
|
+
* @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
|
|
400
|
+
*/
|
|
401
|
+
getSmsProviders({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProviders>;
|
|
270
402
|
/**
|
|
271
403
|
* @param {Object} arg - Arg object.
|
|
272
|
-
* @param {
|
|
404
|
+
* @param {string} arg.companyId - Company id
|
|
405
|
+
* @param {string} arg.applicationId - Application id
|
|
273
406
|
* @param {number} [arg.pageSize] - Current request items count
|
|
274
407
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
275
|
-
* @returns {
|
|
408
|
+
* @returns {Paginator<CommunicationPlatformModel.SmsProviders>}
|
|
276
409
|
* @summary: Get sms providers
|
|
277
410
|
* @description: Get sms providers
|
|
278
411
|
*/
|
|
279
|
-
|
|
280
|
-
|
|
412
|
+
getSmsProvidersPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
413
|
+
companyId: string;
|
|
414
|
+
applicationId: string;
|
|
281
415
|
pageSize?: number;
|
|
282
416
|
sort?: any;
|
|
283
|
-
}):
|
|
284
|
-
/**
|
|
285
|
-
* @param {
|
|
286
|
-
*
|
|
287
|
-
*
|
|
417
|
+
}): Paginator<CommunicationPlatformModel.SmsProviders>;
|
|
418
|
+
/**
|
|
419
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
|
|
420
|
+
* - Arg object
|
|
421
|
+
*
|
|
422
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
423
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
424
|
+
* @name getSmsTemplateById
|
|
288
425
|
* @summary: Get sms template by id
|
|
289
|
-
* @description: Get sms template by id
|
|
426
|
+
* @description: Get sms template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
|
|
290
427
|
*/
|
|
291
|
-
getSmsTemplateById({ id }?: {
|
|
292
|
-
|
|
293
|
-
|
|
428
|
+
getSmsTemplateById({ id }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
429
|
+
/**
|
|
430
|
+
* @param {CommunicationPlatformApplicationValidator.GetSmsTemplatesParam} arg
|
|
431
|
+
* - Arg object
|
|
432
|
+
*
|
|
433
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
434
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
435
|
+
* @name getSmsTemplates
|
|
436
|
+
* @summary: Get sms templates
|
|
437
|
+
* @description: Get sms templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
|
|
438
|
+
*/
|
|
439
|
+
getSmsTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
294
440
|
/**
|
|
295
441
|
* @param {Object} arg - Arg object.
|
|
296
|
-
* @param {
|
|
442
|
+
* @param {string} arg.companyId - Company id
|
|
443
|
+
* @param {string} arg.applicationId - Application id
|
|
297
444
|
* @param {number} [arg.pageSize] - Current request items count
|
|
298
445
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
299
|
-
* @returns {
|
|
446
|
+
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
300
447
|
* @summary: Get sms templates
|
|
301
448
|
* @description: Get sms templates
|
|
302
449
|
*/
|
|
303
|
-
|
|
304
|
-
|
|
450
|
+
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
451
|
+
companyId: string;
|
|
452
|
+
applicationId: string;
|
|
305
453
|
pageSize?: number;
|
|
306
454
|
sort?: any;
|
|
307
|
-
}):
|
|
308
|
-
/**
|
|
309
|
-
* @param {
|
|
310
|
-
*
|
|
311
|
-
*
|
|
455
|
+
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
456
|
+
/**
|
|
457
|
+
* @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
|
|
458
|
+
* - Arg object
|
|
459
|
+
*
|
|
460
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
461
|
+
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
462
|
+
* @name getStatsOfCampaignById
|
|
312
463
|
* @summary: Get stats of campaign by id
|
|
313
|
-
* @description: Get stats of campaign by id
|
|
464
|
+
* @description: Get stats of campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
|
|
314
465
|
*/
|
|
315
|
-
getStatsOfCampaignById({ id }?: {
|
|
316
|
-
|
|
317
|
-
|
|
466
|
+
getStatsOfCampaignById({ id }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.GetStats>;
|
|
467
|
+
/**
|
|
468
|
+
* @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
|
|
469
|
+
* - Arg object
|
|
470
|
+
*
|
|
471
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
|
+
* @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
|
|
473
|
+
* Success response
|
|
474
|
+
* @name getSystemEmailTemplates
|
|
475
|
+
* @summary: Get system email templates
|
|
476
|
+
* @description: Get system email templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
|
|
477
|
+
*/
|
|
478
|
+
getSystemEmailTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
|
|
318
479
|
/**
|
|
319
480
|
* @param {Object} arg - Arg object.
|
|
320
|
-
* @param {
|
|
481
|
+
* @param {string} arg.companyId - Company id
|
|
482
|
+
* @param {string} arg.applicationId - Application id
|
|
321
483
|
* @param {number} [arg.pageSize] - Current request items count
|
|
322
484
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
323
|
-
* @returns {
|
|
485
|
+
* @returns {Paginator<CommunicationPlatformModel.SystemEmailTemplates>}
|
|
324
486
|
* @summary: Get system email templates
|
|
325
487
|
* @description: Get system email templates
|
|
326
488
|
*/
|
|
327
|
-
|
|
328
|
-
|
|
489
|
+
getSystemEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
490
|
+
companyId: string;
|
|
491
|
+
applicationId: string;
|
|
329
492
|
pageSize?: number;
|
|
330
493
|
sort?: any;
|
|
331
|
-
}):
|
|
494
|
+
}): Paginator<CommunicationPlatformModel.SystemEmailTemplates>;
|
|
495
|
+
/**
|
|
496
|
+
* @param {CommunicationPlatformApplicationValidator.GetSystemSystemTemplatesParam} arg
|
|
497
|
+
* - Arg object
|
|
498
|
+
*
|
|
499
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
500
|
+
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates>} -
|
|
501
|
+
* Success response
|
|
502
|
+
* @name getSystemSystemTemplates
|
|
503
|
+
* @summary: Get system sms templates
|
|
504
|
+
* @description: Get system sms templates - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSystemTemplates/).
|
|
505
|
+
*/
|
|
506
|
+
getSystemSystemTemplates({ pageNo, pageSize, sort }?: CommunicationPlatformApplicationValidator.GetSystemSystemTemplatesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SystemSmsTemplates>;
|
|
332
507
|
/**
|
|
333
508
|
* @param {Object} arg - Arg object.
|
|
334
|
-
* @param {
|
|
509
|
+
* @param {string} arg.companyId - Company id
|
|
510
|
+
* @param {string} arg.applicationId - Application id
|
|
335
511
|
* @param {number} [arg.pageSize] - Current request items count
|
|
336
512
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
337
|
-
* @returns {
|
|
513
|
+
* @returns {Paginator<CommunicationPlatformModel.SystemSmsTemplates>}
|
|
338
514
|
* @summary: Get system sms templates
|
|
339
515
|
* @description: Get system sms templates
|
|
340
516
|
*/
|
|
341
|
-
|
|
342
|
-
|
|
517
|
+
getSystemSystemTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
518
|
+
companyId: string;
|
|
519
|
+
applicationId: string;
|
|
343
520
|
pageSize?: number;
|
|
344
521
|
sort?: any;
|
|
345
|
-
}):
|
|
346
|
-
/**
|
|
347
|
-
* @param {
|
|
348
|
-
*
|
|
349
|
-
*
|
|
522
|
+
}): Paginator<CommunicationPlatformModel.SystemSmsTemplates>;
|
|
523
|
+
/**
|
|
524
|
+
* @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
|
|
525
|
+
* - Arg object
|
|
526
|
+
*
|
|
527
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
528
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
529
|
+
* @name sendCommunicationAsynchronously
|
|
350
530
|
* @summary: Send email or sms asynchronously
|
|
351
|
-
* @description: Send email or sms asynchronously
|
|
531
|
+
* @description: Send email or sms asynchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
352
532
|
*/
|
|
353
|
-
sendCommunicationAsynchronously({ body }?: {
|
|
354
|
-
body: EngineRequest;
|
|
355
|
-
}): Promise<EngineResponse>;
|
|
533
|
+
sendCommunicationAsynchronously({ body }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EngineResponse>;
|
|
356
534
|
/**
|
|
357
|
-
* @param {
|
|
358
|
-
*
|
|
359
|
-
*
|
|
535
|
+
* @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
|
|
536
|
+
* - Arg object
|
|
537
|
+
*
|
|
538
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
539
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
540
|
+
* @name sendCommunicationSynchronously
|
|
360
541
|
* @summary: Send email or sms synchronously
|
|
361
|
-
* @description: Send email or sms synchronously
|
|
542
|
+
* @description: Send email or sms synchronously - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
362
543
|
*/
|
|
363
|
-
sendCommunicationSynchronously({ body }?: {
|
|
364
|
-
body: EngineRequest;
|
|
365
|
-
}): Promise<EngineResponse>;
|
|
544
|
+
sendCommunicationSynchronously({ body }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EngineResponse>;
|
|
366
545
|
/**
|
|
367
|
-
* @param {
|
|
368
|
-
* @param {
|
|
369
|
-
* @returns {Promise<SendOtpCommsRes>} - Success response
|
|
546
|
+
* @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
|
|
547
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
548
|
+
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
549
|
+
* @name sendOtp
|
|
370
550
|
* @summary: Send OTP using email and sms
|
|
371
|
-
* @description: Send OTP Comms via email and sms
|
|
551
|
+
* @description: Send OTP Comms via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
|
|
372
552
|
*/
|
|
373
|
-
sendOtp({ body }?: {
|
|
374
|
-
body: SendOtpCommsReq;
|
|
375
|
-
}): Promise<SendOtpCommsRes>;
|
|
553
|
+
sendOtp({ body }?: CommunicationPlatformApplicationValidator.SendOtpParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
376
554
|
/**
|
|
377
|
-
* @param {
|
|
378
|
-
*
|
|
379
|
-
*
|
|
555
|
+
* @param {CommunicationPlatformApplicationValidator.TriggerCampaignJobParam} arg
|
|
556
|
+
* - Arg object
|
|
557
|
+
*
|
|
558
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
|
+
* @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
|
|
560
|
+
* Success response
|
|
561
|
+
* @name triggerCampaignJob
|
|
380
562
|
* @summary: Trigger campaign job
|
|
381
|
-
* @description: Trigger campaign job
|
|
563
|
+
* @description: Trigger campaign job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
|
|
382
564
|
*/
|
|
383
|
-
triggerCampaignJob({ body }?: {
|
|
384
|
-
body: TriggerJobRequest;
|
|
385
|
-
}): Promise<TriggerJobResponse>;
|
|
565
|
+
triggerCampaignJob({ body }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.TriggerJobResponse>;
|
|
386
566
|
/**
|
|
387
|
-
* @param {
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
* @
|
|
567
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam} arg
|
|
568
|
+
* - Arg object
|
|
569
|
+
*
|
|
570
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
571
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
572
|
+
* @name updateAudienceById
|
|
391
573
|
* @summary: Update audience by id
|
|
392
|
-
* @description: Update audience by id
|
|
574
|
+
* @description: Update audience by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
|
|
393
575
|
*/
|
|
394
|
-
updateAudienceById({ id, body }?: {
|
|
395
|
-
id: string;
|
|
396
|
-
body: AudienceReq;
|
|
397
|
-
}): Promise<Audience>;
|
|
576
|
+
updateAudienceById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Audience>;
|
|
398
577
|
/**
|
|
399
|
-
* @param {
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
* @
|
|
578
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam} arg
|
|
579
|
+
* - Arg object
|
|
580
|
+
*
|
|
581
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
582
|
+
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
583
|
+
* @name updateCampaignById
|
|
403
584
|
* @summary: Update campaign by id
|
|
404
|
-
* @description: Update campaign by id
|
|
585
|
+
* @description: Update campaign by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
|
|
405
586
|
*/
|
|
406
|
-
updateCampaignById({ id, body }?: {
|
|
407
|
-
id: string;
|
|
408
|
-
body: CampaignReq;
|
|
409
|
-
}): Promise<Campaign>;
|
|
587
|
+
updateCampaignById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.Campaign>;
|
|
410
588
|
/**
|
|
411
|
-
* @param {
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
* @
|
|
589
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam} arg
|
|
590
|
+
* - Arg object
|
|
591
|
+
*
|
|
592
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
593
|
+
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
594
|
+
* @name updateEmailProviderById
|
|
415
595
|
* @summary: Update email provider by id
|
|
416
|
-
* @description: Update email provider by id
|
|
596
|
+
* @description: Update email provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
|
|
417
597
|
*/
|
|
418
|
-
updateEmailProviderById({ id, body }?: {
|
|
419
|
-
id: string;
|
|
420
|
-
body: EmailProviderReq;
|
|
421
|
-
}): Promise<EmailProvider>;
|
|
598
|
+
updateEmailProviderById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
422
599
|
/**
|
|
423
|
-
* @param {
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
* @
|
|
600
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam} arg
|
|
601
|
+
* - Arg object
|
|
602
|
+
*
|
|
603
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
604
|
+
* @returns {Promise<CommunicationPlatformModel.EmailTemplateRes>} - Success response
|
|
605
|
+
* @name updateEmailTemplateById
|
|
427
606
|
* @summary: Update email template by id
|
|
428
|
-
* @description: Update email template by id
|
|
607
|
+
* @description: Update email template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
|
|
429
608
|
*/
|
|
430
|
-
updateEmailTemplateById({ id, body }?: {
|
|
431
|
-
id: string;
|
|
432
|
-
body: EmailTemplateReq;
|
|
433
|
-
}): Promise<EmailTemplateRes>;
|
|
609
|
+
updateEmailTemplateById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.EmailTemplateRes>;
|
|
434
610
|
/**
|
|
435
|
-
* @param {
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
* @
|
|
611
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
|
|
612
|
+
* - Arg object
|
|
613
|
+
*
|
|
614
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
615
|
+
* @returns {Promise<CommunicationPlatformModel.SmsProvider>} - Success response
|
|
616
|
+
* @name updateSmsProviderById
|
|
439
617
|
* @summary: Update sms provider by id
|
|
440
|
-
* @description: Update sms provider by id
|
|
618
|
+
* @description: Update sms provider by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
|
|
441
619
|
*/
|
|
442
|
-
updateSmsProviderById({ id, body }?: {
|
|
443
|
-
id: string;
|
|
444
|
-
body: SmsProviderReq;
|
|
445
|
-
}): Promise<SmsProvider>;
|
|
620
|
+
updateSmsProviderById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsProvider>;
|
|
446
621
|
/**
|
|
447
|
-
* @param {
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
* @
|
|
622
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam} arg
|
|
623
|
+
* - Arg object
|
|
624
|
+
*
|
|
625
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
626
|
+
* @returns {Promise<CommunicationPlatformModel.SmsTemplateRes>} - Success response
|
|
627
|
+
* @name updateSmsTemplateById
|
|
451
628
|
* @summary: Update sms template by id
|
|
452
|
-
* @description: Update sms template by id
|
|
629
|
+
* @description: Update sms template by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
|
|
453
630
|
*/
|
|
454
|
-
updateSmsTemplateById({ id, body }?: {
|
|
455
|
-
id: string;
|
|
456
|
-
body: SmsTemplateReq;
|
|
457
|
-
}): Promise<SmsTemplateRes>;
|
|
631
|
+
updateSmsTemplateById({ id, body }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SmsTemplateRes>;
|
|
458
632
|
/**
|
|
459
|
-
* @param {
|
|
460
|
-
* @param {
|
|
461
|
-
* @returns {Promise<VerifyOtpCommsSuccessRes>}
|
|
633
|
+
* @param {CommunicationPlatformApplicationValidator.VerfiyOtpParam} arg - Arg object
|
|
634
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
635
|
+
* @returns {Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>}
|
|
636
|
+
* - Success response
|
|
637
|
+
*
|
|
638
|
+
* @name verfiyOtp
|
|
462
639
|
* @summary: Verify OTP sent via email and sms
|
|
463
|
-
* @description: Verify OTP sent via email and sms
|
|
640
|
+
* @description: Verify OTP sent via email and sms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
|
|
464
641
|
*/
|
|
465
|
-
verfiyOtp({ body }?: {
|
|
466
|
-
body: VerifyOtpCommsReq;
|
|
467
|
-
}): Promise<VerifyOtpCommsSuccessRes>;
|
|
642
|
+
verfiyOtp({ body }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
|
|
468
643
|
}
|
|
644
|
+
import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator");
|
|
645
|
+
import CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
646
|
+
import Paginator = require("../../common/Paginator");
|