@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -12,45 +12,9 @@ declare class Communication {
|
|
|
12
12
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
13
13
|
* @name createAudience
|
|
14
14
|
* @summary: Create an audience
|
|
15
|
-
* @description: Creates a new email audience. - Check out [method documentation](https://
|
|
15
|
+
* @description: Creates a new email audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createAudience/).
|
|
16
16
|
*/
|
|
17
17
|
createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
18
|
-
/**
|
|
19
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryHeadersParam} arg
|
|
20
|
-
* - Arg object
|
|
21
|
-
*
|
|
22
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<Object>} - Success response
|
|
25
|
-
* @name createBigQueryHeaders
|
|
26
|
-
* @summary: Create BigQuery headers
|
|
27
|
-
* @description: Create BigQuery headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
|
|
28
|
-
*/
|
|
29
|
-
createBigQueryHeaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
30
|
-
/**
|
|
31
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryNCountParam} arg
|
|
32
|
-
* - Arg object
|
|
33
|
-
*
|
|
34
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
|
-
* @returns {Promise<Object>} - Success response
|
|
37
|
-
* @name createBigQueryNCount
|
|
38
|
-
* @summary: Create BigQuery N-count
|
|
39
|
-
* @description: Creates big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
|
|
40
|
-
*/
|
|
41
|
-
createBigQueryNCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
42
|
-
/**
|
|
43
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryRowCountParam} arg
|
|
44
|
-
* - Arg object
|
|
45
|
-
*
|
|
46
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<Object>} - Success response
|
|
49
|
-
* @name createBigQueryRowCount
|
|
50
|
-
* @summary: Create a BigQuery row count
|
|
51
|
-
* @description: Creates big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
|
|
52
|
-
*/
|
|
53
|
-
createBigQueryRowCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
54
18
|
/**
|
|
55
19
|
* @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
|
|
56
20
|
* - Arg object
|
|
@@ -60,7 +24,7 @@ declare class Communication {
|
|
|
60
24
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
61
25
|
* @name createCampaign
|
|
62
26
|
* @summary: Create a campaign
|
|
63
|
-
* @description: Creates a new communication campaign. - Check out [method documentation](https://
|
|
27
|
+
* @description: Creates a new communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createCampaign/).
|
|
64
28
|
*/
|
|
65
29
|
createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
66
30
|
/**
|
|
@@ -72,7 +36,7 @@ declare class Communication {
|
|
|
72
36
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
73
37
|
* @name createEmailProvider
|
|
74
38
|
* @summary: Create an email provider
|
|
75
|
-
* @description: Creates a new email communication provider. - Check out [method documentation](https://
|
|
39
|
+
* @description: Creates a new email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailProvider/).
|
|
76
40
|
*/
|
|
77
41
|
createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
78
42
|
/**
|
|
@@ -84,7 +48,7 @@ declare class Communication {
|
|
|
84
48
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
85
49
|
* @name createEmailTemplate
|
|
86
50
|
* @summary: Creat an email template
|
|
87
|
-
* @description: Creates a new email communication template. - Check out [method documentation](https://
|
|
51
|
+
* @description: Creates a new email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailTemplate/).
|
|
88
52
|
*/
|
|
89
53
|
createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
90
54
|
/**
|
|
@@ -93,14 +57,14 @@ declare class Communication {
|
|
|
93
57
|
*
|
|
94
58
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
60
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
|
|
97
61
|
* - Success response
|
|
98
62
|
*
|
|
99
63
|
* @name createEventSubscriptions
|
|
100
64
|
* @summary: Create an event subscription
|
|
101
|
-
* @description: Creates a new event subscription. - Check out [method documentation](https://
|
|
65
|
+
* @description: Creates a new event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptions/).
|
|
102
66
|
*/
|
|
103
|
-
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
67
|
+
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
104
68
|
/**
|
|
105
69
|
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg
|
|
106
70
|
* - Arg object
|
|
@@ -108,15 +72,15 @@ declare class Communication {
|
|
|
108
72
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
73
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
74
|
* @returns {Promise<
|
|
111
|
-
* CommunicationPlatformModel.
|
|
75
|
+
* CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]
|
|
112
76
|
* >}
|
|
113
77
|
* - Success response
|
|
114
78
|
*
|
|
115
79
|
* @name createEventSubscriptionsByBulk
|
|
116
80
|
* @summary: Create event subscriptions in bulk
|
|
117
|
-
* @description: Creates a new event subscription in bulk. - Check out [method documentation](https://
|
|
81
|
+
* @description: Creates a new event subscription in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptionsByBulk/).
|
|
118
82
|
*/
|
|
119
|
-
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
83
|
+
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]>;
|
|
120
84
|
/**
|
|
121
85
|
* @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object
|
|
122
86
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -124,7 +88,7 @@ declare class Communication {
|
|
|
124
88
|
* @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
|
|
125
89
|
* @name createJobs
|
|
126
90
|
* @summary: Create a campaign jobs
|
|
127
|
-
* @description: Creates a new campaign job. - Check out [method documentation](https://
|
|
91
|
+
* @description: Creates a new campaign job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createJobs/).
|
|
128
92
|
*/
|
|
129
93
|
createJobs({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateJobsRes>;
|
|
130
94
|
/**
|
|
@@ -136,7 +100,7 @@ declare class Communication {
|
|
|
136
100
|
* @returns {Promise<Object>} - Success response
|
|
137
101
|
* @name createSmsProvider
|
|
138
102
|
* @summary: Create SMS provider
|
|
139
|
-
* @description: Creates a new SMS communication provider. - Check out [method documentation](https://
|
|
103
|
+
* @description: Creates a new SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsProvider/).
|
|
140
104
|
*/
|
|
141
105
|
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
|
|
142
106
|
/**
|
|
@@ -148,7 +112,7 @@ declare class Communication {
|
|
|
148
112
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
149
113
|
* @name createSmsTemplate
|
|
150
114
|
* @summary: Create a SMS template
|
|
151
|
-
* @description: Creates a new SMS communication template. - Check out [method documentation](https://
|
|
115
|
+
* @description: Creates a new SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsTemplate/).
|
|
152
116
|
*/
|
|
153
117
|
createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
154
118
|
/**
|
|
@@ -160,7 +124,7 @@ declare class Communication {
|
|
|
160
124
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
161
125
|
* @name deleteAudienceById
|
|
162
126
|
* @summary: Delete an audience
|
|
163
|
-
* @description: Remove a specific audience permenantly. - Check out [method documentation](https://
|
|
127
|
+
* @description: Remove a specific audience permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteAudienceById/).
|
|
164
128
|
*/
|
|
165
129
|
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
166
130
|
/**
|
|
@@ -172,7 +136,7 @@ declare class Communication {
|
|
|
172
136
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
173
137
|
* @name deleteEmailProviderById
|
|
174
138
|
* @summary: Delete an email provider
|
|
175
|
-
* @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://
|
|
139
|
+
* @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailProviderById/).
|
|
176
140
|
*/
|
|
177
141
|
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
178
142
|
/**
|
|
@@ -184,7 +148,7 @@ declare class Communication {
|
|
|
184
148
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
185
149
|
* @name deleteEmailTemplateById
|
|
186
150
|
* @summary: Delete an email template
|
|
187
|
-
* @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://
|
|
151
|
+
* @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailTemplateById/).
|
|
188
152
|
*/
|
|
189
153
|
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
190
154
|
/**
|
|
@@ -196,7 +160,7 @@ declare class Communication {
|
|
|
196
160
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
197
161
|
* @name deleteEventSubscriptionsById
|
|
198
162
|
* @summary: Delete an event subscriptions
|
|
199
|
-
* @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://
|
|
163
|
+
* @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEventSubscriptionsById/).
|
|
200
164
|
*/
|
|
201
165
|
deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
202
166
|
/**
|
|
@@ -208,7 +172,7 @@ declare class Communication {
|
|
|
208
172
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
209
173
|
* @name deleteSmsProviderById
|
|
210
174
|
* @summary: Delete an SMS provider
|
|
211
|
-
* @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://
|
|
175
|
+
* @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsProviderById/).
|
|
212
176
|
*/
|
|
213
177
|
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
214
178
|
/**
|
|
@@ -220,7 +184,7 @@ declare class Communication {
|
|
|
220
184
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
221
185
|
* @name deleteSmsTemplateById
|
|
222
186
|
* @summary: Delete an SMS template
|
|
223
|
-
* @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://
|
|
187
|
+
* @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsTemplateById/).
|
|
224
188
|
*/
|
|
225
189
|
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
226
190
|
/**
|
|
@@ -229,14 +193,14 @@ declare class Communication {
|
|
|
229
193
|
*
|
|
230
194
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
231
195
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
196
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
|
|
233
197
|
* - Success response
|
|
234
198
|
*
|
|
235
199
|
* @name editEventSubscriptions
|
|
236
200
|
* @summary: Update an event subscriptions
|
|
237
|
-
* @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://
|
|
201
|
+
* @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/editEventSubscriptions/).
|
|
238
202
|
*/
|
|
239
|
-
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
203
|
+
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
240
204
|
/**
|
|
241
205
|
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
242
206
|
* - Arg object
|
|
@@ -246,7 +210,7 @@ declare class Communication {
|
|
|
246
210
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
247
211
|
* @name getAppProviders
|
|
248
212
|
* @summary: Get application providers
|
|
249
|
-
* @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://
|
|
213
|
+
* @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAppProviders/).
|
|
250
214
|
*/
|
|
251
215
|
getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
252
216
|
/**
|
|
@@ -258,7 +222,7 @@ declare class Communication {
|
|
|
258
222
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
259
223
|
* @name getAudienceById
|
|
260
224
|
* @summary: Get an audience
|
|
261
|
-
* @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://
|
|
225
|
+
* @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudienceById/).
|
|
262
226
|
*/
|
|
263
227
|
getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
264
228
|
/**
|
|
@@ -270,33 +234,9 @@ declare class Communication {
|
|
|
270
234
|
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
271
235
|
* @name getAudiences
|
|
272
236
|
* @summary: Get all the audiences
|
|
273
|
-
* @description: Retrieves a list of all the audiences. - Check out [method documentation](https://
|
|
237
|
+
* @description: Retrieves a list of all the audiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudiences/).
|
|
274
238
|
*/
|
|
275
239
|
getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
276
|
-
/**
|
|
277
|
-
* @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
|
|
278
|
-
* - Arg object
|
|
279
|
-
*
|
|
280
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
281
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
282
|
-
* @returns {Promise<Object>} - Success response
|
|
283
|
-
* @name getBigQueryHeadersById
|
|
284
|
-
* @summary: Get BigQuery headers
|
|
285
|
-
* @description: Retrieves header information from BigQuery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
|
|
286
|
-
*/
|
|
287
|
-
getBigQueryHeadersById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
288
|
-
/**
|
|
289
|
-
* @param {CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam} arg
|
|
290
|
-
* - Arg object
|
|
291
|
-
*
|
|
292
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
293
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
294
|
-
* @returns {Promise<Object>} - Success response
|
|
295
|
-
* @name getBigQueryRowCountById
|
|
296
|
-
* @summary: Get BigQuery row count
|
|
297
|
-
* @description: Retrieves big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
|
|
298
|
-
*/
|
|
299
|
-
getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
300
240
|
/**
|
|
301
241
|
* @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
|
|
302
242
|
* - Arg object
|
|
@@ -306,7 +246,7 @@ declare class Communication {
|
|
|
306
246
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
307
247
|
* @name getCampaignById
|
|
308
248
|
* @summary: Get a campaign
|
|
309
|
-
* @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://
|
|
249
|
+
* @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaignById/).
|
|
310
250
|
*/
|
|
311
251
|
getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
312
252
|
/**
|
|
@@ -318,7 +258,7 @@ declare class Communication {
|
|
|
318
258
|
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
319
259
|
* @name getCampaigns
|
|
320
260
|
* @summary: Get all campaigns
|
|
321
|
-
* @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://
|
|
261
|
+
* @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaigns/).
|
|
322
262
|
*/
|
|
323
263
|
getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
324
264
|
/**
|
|
@@ -330,7 +270,7 @@ declare class Communication {
|
|
|
330
270
|
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
331
271
|
* @name getCommunicationLogs
|
|
332
272
|
* @summary: Get communication reports
|
|
333
|
-
* @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://
|
|
273
|
+
* @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCommunicationLogs/).
|
|
334
274
|
*/
|
|
335
275
|
getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
|
|
336
276
|
/**
|
|
@@ -343,7 +283,7 @@ declare class Communication {
|
|
|
343
283
|
* Success response
|
|
344
284
|
* @name getDefaultSmsProviders
|
|
345
285
|
* @summary: Get all default SMS providers
|
|
346
|
-
* @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://
|
|
286
|
+
* @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDefaultSmsProviders/).
|
|
347
287
|
*/
|
|
348
288
|
getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
|
|
349
289
|
/**
|
|
@@ -356,7 +296,7 @@ declare class Communication {
|
|
|
356
296
|
* Success response
|
|
357
297
|
* @name getDummyDatasources
|
|
358
298
|
* @summary: Get dummy data sources
|
|
359
|
-
* @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://
|
|
299
|
+
* @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasources/).
|
|
360
300
|
*/
|
|
361
301
|
getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
|
|
362
302
|
/**
|
|
@@ -369,7 +309,7 @@ declare class Communication {
|
|
|
369
309
|
* Success response
|
|
370
310
|
* @name getDummyDatasourcesMeta
|
|
371
311
|
* @summary: Get dummy data sources metadata
|
|
372
|
-
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://
|
|
312
|
+
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
373
313
|
*/
|
|
374
314
|
getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
|
|
375
315
|
/**
|
|
@@ -381,7 +321,7 @@ declare class Communication {
|
|
|
381
321
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
382
322
|
* @name getEmailProviderById
|
|
383
323
|
* @summary: Get a email provider
|
|
384
|
-
* @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://
|
|
324
|
+
* @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviderById/).
|
|
385
325
|
*/
|
|
386
326
|
getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
387
327
|
/**
|
|
@@ -393,7 +333,7 @@ declare class Communication {
|
|
|
393
333
|
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
394
334
|
* @name getEmailProviders
|
|
395
335
|
* @summary: Get all email providers
|
|
396
|
-
* @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://
|
|
336
|
+
* @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviders/).
|
|
397
337
|
*/
|
|
398
338
|
getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
399
339
|
/**
|
|
@@ -405,7 +345,7 @@ declare class Communication {
|
|
|
405
345
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
406
346
|
* @name getEmailTemplateById
|
|
407
347
|
* @summary: Get an email template
|
|
408
|
-
* @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://
|
|
348
|
+
* @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplateById/).
|
|
409
349
|
*/
|
|
410
350
|
getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
411
351
|
/**
|
|
@@ -417,7 +357,7 @@ declare class Communication {
|
|
|
417
357
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
418
358
|
* @name getEmailTemplates
|
|
419
359
|
* @summary: Get all email templates
|
|
420
|
-
* @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://
|
|
360
|
+
* @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplates/).
|
|
421
361
|
*/
|
|
422
362
|
getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
423
363
|
/**
|
|
@@ -430,9 +370,9 @@ declare class Communication {
|
|
|
430
370
|
* Success response
|
|
431
371
|
* @name getEventSubscriptions
|
|
432
372
|
* @summary: Get all event subscriptions
|
|
433
|
-
* @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://
|
|
373
|
+
* @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptions/).
|
|
434
374
|
*/
|
|
435
|
-
getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
375
|
+
getEventSubscriptions({ pageNo, pageSize, populate, group, subGroup, fulfillmentOptionSlug, requestHeaders, }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
436
376
|
/**
|
|
437
377
|
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
|
|
438
378
|
* - Arg object
|
|
@@ -442,7 +382,7 @@ declare class Communication {
|
|
|
442
382
|
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
443
383
|
* @name getEventSubscriptionsById
|
|
444
384
|
* @summary: Get an event subscription
|
|
445
|
-
* @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://
|
|
385
|
+
* @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptionsById/).
|
|
446
386
|
*/
|
|
447
387
|
getEventSubscriptionsById({ id, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
448
388
|
/**
|
|
@@ -454,7 +394,7 @@ declare class Communication {
|
|
|
454
394
|
* @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
|
|
455
395
|
* @name getGlobalProviders
|
|
456
396
|
* @summary: Get global providers
|
|
457
|
-
* @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://
|
|
397
|
+
* @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalProviders/).
|
|
458
398
|
*/
|
|
459
399
|
getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
|
|
460
400
|
/**
|
|
@@ -463,14 +403,14 @@ declare class Communication {
|
|
|
463
403
|
*
|
|
464
404
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
465
405
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
466
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
406
|
+
* @returns {Promise<CommunicationPlatformModel.GetGlobalVariablesResult>}
|
|
467
407
|
* - Success response
|
|
468
408
|
*
|
|
469
409
|
* @name getGlobalVariables
|
|
470
410
|
* @summary: Get all global variables
|
|
471
|
-
* @description: Retrieves a list of communication global variables. - Check out [method documentation](https://
|
|
411
|
+
* @description: Retrieves a list of communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalVariables/).
|
|
472
412
|
*/
|
|
473
|
-
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
413
|
+
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetGlobalVariablesResult>;
|
|
474
414
|
/**
|
|
475
415
|
* @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
|
|
476
416
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -478,7 +418,7 @@ declare class Communication {
|
|
|
478
418
|
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
479
419
|
* @name getJobLogs
|
|
480
420
|
* @summary: Get logs of all campaign job
|
|
481
|
-
* @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://
|
|
421
|
+
* @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobLogs/).
|
|
482
422
|
*/
|
|
483
423
|
getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
484
424
|
/**
|
|
@@ -488,7 +428,7 @@ declare class Communication {
|
|
|
488
428
|
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
489
429
|
* @name getJobs
|
|
490
430
|
* @summary: Get all campaign jobs
|
|
491
|
-
* @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://
|
|
431
|
+
* @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobs/).
|
|
492
432
|
*/
|
|
493
433
|
getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
494
434
|
/**
|
|
@@ -500,7 +440,7 @@ declare class Communication {
|
|
|
500
440
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
501
441
|
* @name getNSampleRecordsFromCsv
|
|
502
442
|
* @summary: Get N sample records of a CSV
|
|
503
|
-
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://
|
|
443
|
+
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsv/).
|
|
504
444
|
*/
|
|
505
445
|
getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
506
446
|
/**
|
|
@@ -512,7 +452,7 @@ declare class Communication {
|
|
|
512
452
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
513
453
|
* @name getNSampleRecordsFromCsvByGet
|
|
514
454
|
* @summary: Get N sample records of a CSV
|
|
515
|
-
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://
|
|
455
|
+
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
516
456
|
*/
|
|
517
457
|
getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
518
458
|
/**
|
|
@@ -524,7 +464,7 @@ declare class Communication {
|
|
|
524
464
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
525
465
|
* @name getOtpConfiguration
|
|
526
466
|
* @summary: Get configuration of otp
|
|
527
|
-
* @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://
|
|
467
|
+
* @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getOtpConfiguration/).
|
|
528
468
|
*/
|
|
529
469
|
getOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
530
470
|
/**
|
|
@@ -536,7 +476,7 @@ declare class Communication {
|
|
|
536
476
|
* @returns {Promise<Object>} - Success response
|
|
537
477
|
* @name getSmsProviderById
|
|
538
478
|
* @summary: Get a SMS provider
|
|
539
|
-
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://
|
|
479
|
+
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviderById/).
|
|
540
480
|
*/
|
|
541
481
|
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
542
482
|
/**
|
|
@@ -548,7 +488,7 @@ declare class Communication {
|
|
|
548
488
|
* @returns {Promise<Object>} - Success response
|
|
549
489
|
* @name getSmsProviders
|
|
550
490
|
* @summary: Get all SMS providers
|
|
551
|
-
* @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://
|
|
491
|
+
* @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviders/).
|
|
552
492
|
*/
|
|
553
493
|
getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
|
|
554
494
|
/**
|
|
@@ -560,7 +500,7 @@ declare class Communication {
|
|
|
560
500
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
561
501
|
* @name getSmsTemplateById
|
|
562
502
|
* @summary: Get a SMS template
|
|
563
|
-
* @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://
|
|
503
|
+
* @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplateById/).
|
|
564
504
|
*/
|
|
565
505
|
getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
566
506
|
/**
|
|
@@ -572,7 +512,7 @@ declare class Communication {
|
|
|
572
512
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
573
513
|
* @name getSmsTemplates
|
|
574
514
|
* @summary: Get all SMS templates
|
|
575
|
-
* @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://
|
|
515
|
+
* @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplates/).
|
|
576
516
|
*/
|
|
577
517
|
getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
578
518
|
/**
|
|
@@ -584,7 +524,7 @@ declare class Communication {
|
|
|
584
524
|
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
585
525
|
* @name getStatsOfCampaignById
|
|
586
526
|
* @summary: Get campaign statistics
|
|
587
|
-
* @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://
|
|
527
|
+
* @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getStatsOfCampaignById/).
|
|
588
528
|
*/
|
|
589
529
|
getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
|
|
590
530
|
/**
|
|
@@ -596,7 +536,7 @@ declare class Communication {
|
|
|
596
536
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
597
537
|
* @name getSubscribedEmailTemplates
|
|
598
538
|
* @summary: Get all subscribed email templates
|
|
599
|
-
* @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://
|
|
539
|
+
* @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
600
540
|
*/
|
|
601
541
|
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
602
542
|
/**
|
|
@@ -608,21 +548,9 @@ declare class Communication {
|
|
|
608
548
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
609
549
|
* @name getSubscribedSmsTemplates
|
|
610
550
|
* @summary: Get all subscribed SMS templates
|
|
611
|
-
* @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://
|
|
551
|
+
* @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
612
552
|
*/
|
|
613
553
|
getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
614
|
-
/**
|
|
615
|
-
* @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
|
|
616
|
-
* - Arg object
|
|
617
|
-
*
|
|
618
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
619
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
620
|
-
* @returns {Promise<Object>} - Success response
|
|
621
|
-
* @name getSystemAudiences
|
|
622
|
-
* @summary: Get system audiences
|
|
623
|
-
* @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
|
|
624
|
-
*/
|
|
625
|
-
getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
626
554
|
/**
|
|
627
555
|
* @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
|
|
628
556
|
* - Arg object
|
|
@@ -633,7 +561,7 @@ declare class Communication {
|
|
|
633
561
|
* Success response
|
|
634
562
|
* @name getSystemEmailTemplates
|
|
635
563
|
* @summary: Get all system email templates
|
|
636
|
-
* @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://
|
|
564
|
+
* @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemEmailTemplates/).
|
|
637
565
|
*/
|
|
638
566
|
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
|
|
639
567
|
/**
|
|
@@ -642,51 +570,51 @@ declare class Communication {
|
|
|
642
570
|
*
|
|
643
571
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
644
572
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
645
|
-
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates
|
|
573
|
+
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates>} -
|
|
646
574
|
* Success response
|
|
647
575
|
* @name getSystemSmsTemplates
|
|
648
576
|
* @summary: Gets all system SMS templates
|
|
649
|
-
* @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://
|
|
577
|
+
* @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemSmsTemplates/).
|
|
650
578
|
*/
|
|
651
|
-
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates
|
|
579
|
+
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates>;
|
|
652
580
|
/**
|
|
653
581
|
* @param {CommunicationPlatformApplicationValidator.PostGlobalVariablesParam} arg
|
|
654
582
|
* - Arg object
|
|
655
583
|
*
|
|
656
584
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
657
585
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
658
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
586
|
+
* @returns {Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>}
|
|
659
587
|
* - Success response
|
|
660
588
|
*
|
|
661
589
|
* @name postGlobalVariables
|
|
662
590
|
* @summary: Create global variables
|
|
663
|
-
* @description: Updates and creates communication global variables. - Check out [method documentation](https://
|
|
591
|
+
* @description: Updates and creates communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/postGlobalVariables/).
|
|
664
592
|
*/
|
|
665
|
-
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
593
|
+
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>;
|
|
666
594
|
/**
|
|
667
595
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
|
|
668
596
|
* - Arg object
|
|
669
597
|
*
|
|
670
598
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
671
599
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
672
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
600
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
673
601
|
* @name sendCommunicationAsynchronously
|
|
674
602
|
* @summary: Send communication asynchronously
|
|
675
|
-
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://
|
|
603
|
+
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
676
604
|
*/
|
|
677
|
-
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
605
|
+
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
678
606
|
/**
|
|
679
607
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
|
|
680
608
|
* - Arg object
|
|
681
609
|
*
|
|
682
610
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
683
611
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
684
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
612
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
685
613
|
* @name sendCommunicationSynchronously
|
|
686
614
|
* @summary: Send communication synchronously
|
|
687
|
-
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://
|
|
615
|
+
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
688
616
|
*/
|
|
689
|
-
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
617
|
+
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
690
618
|
/**
|
|
691
619
|
* @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
|
|
692
620
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -694,7 +622,7 @@ declare class Communication {
|
|
|
694
622
|
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
695
623
|
* @name sendOtp
|
|
696
624
|
* @summary: Send OTP
|
|
697
|
-
* @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://
|
|
625
|
+
* @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendOtp/).
|
|
698
626
|
*/
|
|
699
627
|
sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
700
628
|
/**
|
|
@@ -703,13 +631,12 @@ declare class Communication {
|
|
|
703
631
|
*
|
|
704
632
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
705
633
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
706
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
707
|
-
* Success response
|
|
634
|
+
* @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
|
|
708
635
|
* @name triggerCampaignJob
|
|
709
636
|
* @summary: Trigger a campaign job
|
|
710
|
-
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://
|
|
637
|
+
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/triggerCampaignJob/).
|
|
711
638
|
*/
|
|
712
|
-
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
639
|
+
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResult>;
|
|
713
640
|
/**
|
|
714
641
|
* @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg
|
|
715
642
|
* - Arg object
|
|
@@ -719,7 +646,7 @@ declare class Communication {
|
|
|
719
646
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
720
647
|
* @name updateAppProviders
|
|
721
648
|
* @summary: Update application providers
|
|
722
|
-
* @description: Modify provider configuration using provider object id
|
|
649
|
+
* @description: Modify provider configuration using provider object id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAppProviders/).
|
|
723
650
|
*/
|
|
724
651
|
updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
725
652
|
/**
|
|
@@ -731,7 +658,7 @@ declare class Communication {
|
|
|
731
658
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
732
659
|
* @name updateAudienceById
|
|
733
660
|
* @summary: Update an audience
|
|
734
|
-
* @description: Modify the configuration of a specific audience. - Check out [method documentation](https://
|
|
661
|
+
* @description: Modify the configuration of a specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAudienceById/).
|
|
735
662
|
*/
|
|
736
663
|
updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
737
664
|
/**
|
|
@@ -743,7 +670,7 @@ declare class Communication {
|
|
|
743
670
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
744
671
|
* @name updateCampaignById
|
|
745
672
|
* @summary: Update a campaign
|
|
746
|
-
* @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://
|
|
673
|
+
* @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateCampaignById/).
|
|
747
674
|
*/
|
|
748
675
|
updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
749
676
|
/**
|
|
@@ -755,7 +682,7 @@ declare class Communication {
|
|
|
755
682
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
756
683
|
* @name updateEmailProviderById
|
|
757
684
|
* @summary: Update email provider
|
|
758
|
-
* @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://
|
|
685
|
+
* @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailProviderById/).
|
|
759
686
|
*/
|
|
760
687
|
updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
761
688
|
/**
|
|
@@ -767,7 +694,7 @@ declare class Communication {
|
|
|
767
694
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
768
695
|
* @name updateEmailTemplateById
|
|
769
696
|
* @summary: Update an email template
|
|
770
|
-
* @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://
|
|
697
|
+
* @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailTemplateById/).
|
|
771
698
|
*/
|
|
772
699
|
updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
773
700
|
/**
|
|
@@ -779,7 +706,7 @@ declare class Communication {
|
|
|
779
706
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
780
707
|
* @name updateOtpConfiguration
|
|
781
708
|
* @summary: Update configuration of otp
|
|
782
|
-
* @description: Updates all configurations related to OTP. - Check out [method documentation](https://
|
|
709
|
+
* @description: Updates all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateOtpConfiguration/).
|
|
783
710
|
*/
|
|
784
711
|
updateOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
785
712
|
/**
|
|
@@ -791,7 +718,7 @@ declare class Communication {
|
|
|
791
718
|
* @returns {Promise<Object>} - Success response
|
|
792
719
|
* @name updateSmsProviderById
|
|
793
720
|
* @summary: Update SMS provider
|
|
794
|
-
* @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://
|
|
721
|
+
* @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsProviderById/).
|
|
795
722
|
*/
|
|
796
723
|
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
797
724
|
/**
|
|
@@ -803,7 +730,7 @@ declare class Communication {
|
|
|
803
730
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
804
731
|
* @name updateSmsTemplateById
|
|
805
732
|
* @summary: Update a SMS template
|
|
806
|
-
* @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://
|
|
733
|
+
* @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsTemplateById/).
|
|
807
734
|
*/
|
|
808
735
|
updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
809
736
|
/**
|
|
@@ -815,7 +742,7 @@ declare class Communication {
|
|
|
815
742
|
*
|
|
816
743
|
* @name verfiyOtp
|
|
817
744
|
* @summary: Verify OTP
|
|
818
|
-
* @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://
|
|
745
|
+
* @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/verfiyOtp/).
|
|
819
746
|
*/
|
|
820
747
|
verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
|
|
821
748
|
}
|