@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +3 -15
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -14
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3641 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +351 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +410 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2011 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1100 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1362 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +247 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +319 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +18 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +20 -18
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -251,6 +251,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
251
251
|
|
|
252
252
|
/** @typedef GetMarketplaceOptinDetailParam */
|
|
253
253
|
|
|
254
|
+
/** @typedef GetMarketplacesParam */
|
|
255
|
+
|
|
254
256
|
/**
|
|
255
257
|
* @typedef GetOptimalLocationsParam
|
|
256
258
|
* @property {CatalogPlatformModel.AssignStore} body
|
|
@@ -363,6 +365,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
363
365
|
* set of results
|
|
364
366
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
365
367
|
* Default is 10.
|
|
368
|
+
* @property {number} [brandId] - Brand id that is to be searched.
|
|
366
369
|
*/
|
|
367
370
|
|
|
368
371
|
/**
|
|
@@ -386,12 +389,13 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
386
389
|
/**
|
|
387
390
|
* @typedef ListCategoriesParam
|
|
388
391
|
* @property {string} [level] - Get category for multiple levels
|
|
389
|
-
* @property {
|
|
392
|
+
* @property {number} [department] - Get category for multiple departments filtered
|
|
390
393
|
* @property {string} [q] - Get multiple categories filtered by search string
|
|
391
394
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
392
395
|
* set of results
|
|
393
396
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
394
397
|
* Default is 10.
|
|
398
|
+
* @property {number[]} [uids] - Get multiple categories filtered by category uids.
|
|
395
399
|
*/
|
|
396
400
|
|
|
397
401
|
/**
|
|
@@ -468,6 +472,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
468
472
|
* @property {CatalogPlatformModel.InventoryRequestSchemaV2} body
|
|
469
473
|
*/
|
|
470
474
|
|
|
475
|
+
/**
|
|
476
|
+
* @typedef UpdateMarketplaceOptinParam
|
|
477
|
+
* @property {string} marketplaceSlug - Slug of the marketplace .
|
|
478
|
+
* @property {CatalogPlatformModel.UpdateMarketplaceOptinRequest} body
|
|
479
|
+
*/
|
|
480
|
+
|
|
471
481
|
/**
|
|
472
482
|
* @typedef UpdateProductBundleParam
|
|
473
483
|
* @property {string} id - A `id` is a unique identifier for a particular
|
|
@@ -832,6 +842,11 @@ class CatalogPlatformValidator {
|
|
|
832
842
|
return Joi.object({}).required();
|
|
833
843
|
}
|
|
834
844
|
|
|
845
|
+
/** @returns {GetMarketplacesParam} */
|
|
846
|
+
static getMarketplaces() {
|
|
847
|
+
return Joi.object({}).required();
|
|
848
|
+
}
|
|
849
|
+
|
|
835
850
|
/** @returns {GetOptimalLocationsParam} */
|
|
836
851
|
static getOptimalLocations() {
|
|
837
852
|
return Joi.object({
|
|
@@ -962,6 +977,7 @@ class CatalogPlatformValidator {
|
|
|
962
977
|
tag: Joi.string().allow(""),
|
|
963
978
|
pageNo: Joi.number(),
|
|
964
979
|
pageSize: Joi.number(),
|
|
980
|
+
brandId: Joi.number(),
|
|
965
981
|
}).required();
|
|
966
982
|
}
|
|
967
983
|
|
|
@@ -988,10 +1004,11 @@ class CatalogPlatformValidator {
|
|
|
988
1004
|
static listCategories() {
|
|
989
1005
|
return Joi.object({
|
|
990
1006
|
level: Joi.string().allow(""),
|
|
991
|
-
|
|
1007
|
+
department: Joi.number(),
|
|
992
1008
|
q: Joi.string().allow(""),
|
|
993
1009
|
pageNo: Joi.number(),
|
|
994
1010
|
pageSize: Joi.number(),
|
|
1011
|
+
uids: Joi.array().items(Joi.number()),
|
|
995
1012
|
}).required();
|
|
996
1013
|
}
|
|
997
1014
|
|
|
@@ -1082,6 +1099,14 @@ class CatalogPlatformValidator {
|
|
|
1082
1099
|
}).required();
|
|
1083
1100
|
}
|
|
1084
1101
|
|
|
1102
|
+
/** @returns {UpdateMarketplaceOptinParam} */
|
|
1103
|
+
static updateMarketplaceOptin() {
|
|
1104
|
+
return Joi.object({
|
|
1105
|
+
marketplaceSlug: Joi.string().allow("").required(),
|
|
1106
|
+
body: CatalogPlatformModel.UpdateMarketplaceOptinRequest().required(),
|
|
1107
|
+
}).required();
|
|
1108
|
+
}
|
|
1109
|
+
|
|
1085
1110
|
/** @returns {UpdateProductBundleParam} */
|
|
1086
1111
|
static updateProductBundle() {
|
|
1087
1112
|
return Joi.object({
|
|
@@ -87,6 +87,46 @@ declare class Communication {
|
|
|
87
87
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to create an email template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
|
|
88
88
|
*/
|
|
89
89
|
createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
90
|
+
/**
|
|
91
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam} arg
|
|
92
|
+
* - Arg object
|
|
93
|
+
*
|
|
94
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
|
|
97
|
+
* - Success response
|
|
98
|
+
*
|
|
99
|
+
* @name createEventSubscriptions
|
|
100
|
+
* @summary: Create event subscriptions
|
|
101
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
|
|
102
|
+
*/
|
|
103
|
+
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>;
|
|
104
|
+
/**
|
|
105
|
+
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg
|
|
106
|
+
* - Arg object
|
|
107
|
+
*
|
|
108
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
|
+
* @returns {Promise<
|
|
111
|
+
* CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]
|
|
112
|
+
* >}
|
|
113
|
+
* - Success response
|
|
114
|
+
*
|
|
115
|
+
* @name createEventSubscriptionsByBulk
|
|
116
|
+
* @summary: Create event subscriptions by bulk
|
|
117
|
+
* @description: Create event subscriptions by bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
|
|
118
|
+
*/
|
|
119
|
+
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse[]>;
|
|
120
|
+
/**
|
|
121
|
+
* @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object
|
|
122
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
|
+
* @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
|
|
125
|
+
* @name createJobs
|
|
126
|
+
* @summary: Create jobs
|
|
127
|
+
* @description: Create jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createJobs/).
|
|
128
|
+
*/
|
|
129
|
+
createJobs({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateJobsRes>;
|
|
90
130
|
/**
|
|
91
131
|
* @param {CommunicationPlatformApplicationValidator.CreateSmsProviderParam} arg
|
|
92
132
|
* - Arg object
|
|
@@ -117,12 +157,12 @@ declare class Communication {
|
|
|
117
157
|
*
|
|
118
158
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
119
159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
160
|
+
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
121
161
|
* @name deleteAudienceById
|
|
122
162
|
* @summary: Delete audience by id
|
|
123
163
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to delete audience by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
|
|
124
164
|
*/
|
|
125
|
-
deleteAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
165
|
+
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
126
166
|
/**
|
|
127
167
|
* @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg
|
|
128
168
|
* - Arg object
|
|
@@ -147,6 +187,18 @@ declare class Communication {
|
|
|
147
187
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to delete an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
|
|
148
188
|
*/
|
|
149
189
|
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
190
|
+
/**
|
|
191
|
+
* @param {CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam} arg
|
|
192
|
+
* - Arg object
|
|
193
|
+
*
|
|
194
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
197
|
+
* @name deleteEventSubscriptionsById
|
|
198
|
+
* @summary: Create event subscriptions
|
|
199
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEventSubscriptionsById/).
|
|
200
|
+
*/
|
|
201
|
+
deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
150
202
|
/**
|
|
151
203
|
* @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
|
|
152
204
|
* - Arg object
|
|
@@ -171,6 +223,20 @@ declare class Communication {
|
|
|
171
223
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to delete an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
|
|
172
224
|
*/
|
|
173
225
|
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
226
|
+
/**
|
|
227
|
+
* @param {CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam} arg
|
|
228
|
+
* - Arg object
|
|
229
|
+
*
|
|
230
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
231
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>}
|
|
233
|
+
* - Success response
|
|
234
|
+
*
|
|
235
|
+
* @name editEventSubscriptions
|
|
236
|
+
* @summary: Create event subscriptions
|
|
237
|
+
* @description: Create event subscriptions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/editEventSubscriptions/).
|
|
238
|
+
*/
|
|
239
|
+
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResponse>;
|
|
174
240
|
/**
|
|
175
241
|
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
176
242
|
* - Arg object
|
|
@@ -206,22 +272,24 @@ declare class Communication {
|
|
|
206
272
|
* @summary: Get audiences
|
|
207
273
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
|
|
208
274
|
*/
|
|
209
|
-
getAudiences({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
275
|
+
getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
210
276
|
/**
|
|
211
277
|
* @param {Object} arg - Arg object.
|
|
212
278
|
* @param {string} arg.companyId - Company id
|
|
213
279
|
* @param {string} arg.applicationId - Application id
|
|
214
280
|
* @param {number} [arg.pageSize] - Current request items count
|
|
215
281
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
282
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
216
283
|
* @returns {Paginator<CommunicationPlatformModel.Audiences>}
|
|
217
284
|
* @summary: Get audiences
|
|
218
285
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences.
|
|
219
286
|
*/
|
|
220
|
-
getAudiencesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
287
|
+
getAudiencesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
221
288
|
companyId: string;
|
|
222
289
|
applicationId: string;
|
|
223
290
|
pageSize?: number;
|
|
224
291
|
sort?: any;
|
|
292
|
+
query?: any;
|
|
225
293
|
}): Paginator<CommunicationPlatformModel.Audiences>;
|
|
226
294
|
/**
|
|
227
295
|
* @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
|
|
@@ -270,23 +338,7 @@ declare class Communication {
|
|
|
270
338
|
* @summary: Get campaigns
|
|
271
339
|
* @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
272
340
|
*/
|
|
273
|
-
getCampaigns({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
274
|
-
/**
|
|
275
|
-
* @param {Object} arg - Arg object.
|
|
276
|
-
* @param {string} arg.companyId - Company id
|
|
277
|
-
* @param {string} arg.applicationId - Application id
|
|
278
|
-
* @param {number} [arg.pageSize] - Current request items count
|
|
279
|
-
* @param {Object} [arg.sort] - To sort based on created_at
|
|
280
|
-
* @returns {Paginator<CommunicationPlatformModel.Campaigns>}
|
|
281
|
-
* @summary: Get campaigns
|
|
282
|
-
* @description: Get campaigns
|
|
283
|
-
*/
|
|
284
|
-
getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
285
|
-
companyId: string;
|
|
286
|
-
applicationId: string;
|
|
287
|
-
pageSize?: number;
|
|
288
|
-
sort?: any;
|
|
289
|
-
}): Paginator<CommunicationPlatformModel.Campaigns>;
|
|
341
|
+
getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
290
342
|
/**
|
|
291
343
|
* @param {CommunicationPlatformApplicationValidator.GetCommunicationLogsParam} arg
|
|
292
344
|
* - Arg object
|
|
@@ -379,22 +431,24 @@ declare class Communication {
|
|
|
379
431
|
* @summary: Get email providers
|
|
380
432
|
* @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
381
433
|
*/
|
|
382
|
-
getEmailProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
434
|
+
getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
383
435
|
/**
|
|
384
436
|
* @param {Object} arg - Arg object.
|
|
385
437
|
* @param {string} arg.companyId - Company id
|
|
386
438
|
* @param {string} arg.applicationId - Application id
|
|
387
439
|
* @param {number} [arg.pageSize] - Current request items count
|
|
388
440
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
441
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
389
442
|
* @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
|
|
390
443
|
* @summary: Get email providers
|
|
391
444
|
* @description: Get email providers
|
|
392
445
|
*/
|
|
393
|
-
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
446
|
+
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
394
447
|
companyId: string;
|
|
395
448
|
applicationId: string;
|
|
396
449
|
pageSize?: number;
|
|
397
450
|
sort?: any;
|
|
451
|
+
query?: any;
|
|
398
452
|
}): Paginator<CommunicationPlatformModel.EmailProviders>;
|
|
399
453
|
/**
|
|
400
454
|
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
|
|
@@ -419,22 +473,24 @@ declare class Communication {
|
|
|
419
473
|
* @summary: Get email templates
|
|
420
474
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
|
|
421
475
|
*/
|
|
422
|
-
getEmailTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
476
|
+
getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
423
477
|
/**
|
|
424
478
|
* @param {Object} arg - Arg object.
|
|
425
479
|
* @param {string} arg.companyId - Company id
|
|
426
480
|
* @param {string} arg.applicationId - Application id
|
|
427
481
|
* @param {number} [arg.pageSize] - Current request items count
|
|
428
482
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
483
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
429
484
|
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
430
485
|
* @summary: Get email templates
|
|
431
486
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.
|
|
432
487
|
*/
|
|
433
|
-
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
488
|
+
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
434
489
|
companyId: string;
|
|
435
490
|
applicationId: string;
|
|
436
491
|
pageSize?: number;
|
|
437
492
|
sort?: any;
|
|
493
|
+
query?: any;
|
|
438
494
|
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
439
495
|
/**
|
|
440
496
|
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
|
|
@@ -454,7 +510,7 @@ declare class Communication {
|
|
|
454
510
|
* @param {string} arg.companyId - Company id
|
|
455
511
|
* @param {string} arg.applicationId - Application id
|
|
456
512
|
* @param {number} [arg.pageSize] - Current request items count
|
|
457
|
-
* @param {string} [arg.populate] - Populate
|
|
513
|
+
* @param {string} [arg.populate] - Populate Fields
|
|
458
514
|
* @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
|
|
459
515
|
* @summary: Get event subscriptions
|
|
460
516
|
* @description: Get event subscriptions
|
|
@@ -465,6 +521,18 @@ declare class Communication {
|
|
|
465
521
|
pageSize?: number;
|
|
466
522
|
populate?: string;
|
|
467
523
|
}): Paginator<CommunicationPlatformModel.EventSubscriptions>;
|
|
524
|
+
/**
|
|
525
|
+
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg
|
|
526
|
+
* - Arg object
|
|
527
|
+
*
|
|
528
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
529
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
530
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
531
|
+
* @name getEventSubscriptionsById
|
|
532
|
+
* @summary: Get event subscriptions by id
|
|
533
|
+
* @description: Get event subscriptions by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptionsById/).
|
|
534
|
+
*/
|
|
535
|
+
getEventSubscriptionsById({ id, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
468
536
|
/**
|
|
469
537
|
* @param {CommunicationPlatformApplicationValidator.GetGlobalProvidersParam} arg
|
|
470
538
|
* - Arg object
|
|
@@ -500,22 +568,24 @@ declare class Communication {
|
|
|
500
568
|
* @summary: Get job logs
|
|
501
569
|
* @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
502
570
|
*/
|
|
503
|
-
getJobLogs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
571
|
+
getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
504
572
|
/**
|
|
505
573
|
* @param {Object} arg - Arg object.
|
|
506
574
|
* @param {string} arg.companyId - Company id
|
|
507
575
|
* @param {string} arg.applicationId - Application id
|
|
508
576
|
* @param {number} [arg.pageSize] - Current request items count
|
|
509
577
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
578
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
510
579
|
* @returns {Paginator<CommunicationPlatformModel.JobLogs>}
|
|
511
580
|
* @summary: Get job logs
|
|
512
581
|
* @description: Get job logs
|
|
513
582
|
*/
|
|
514
|
-
getJobLogsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
583
|
+
getJobLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
515
584
|
companyId: string;
|
|
516
585
|
applicationId: string;
|
|
517
586
|
pageSize?: number;
|
|
518
587
|
sort?: any;
|
|
588
|
+
query?: any;
|
|
519
589
|
}): Paginator<CommunicationPlatformModel.JobLogs>;
|
|
520
590
|
/**
|
|
521
591
|
* @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
|
|
@@ -526,22 +596,24 @@ declare class Communication {
|
|
|
526
596
|
* @summary: Get jobs
|
|
527
597
|
* @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
528
598
|
*/
|
|
529
|
-
getJobs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
599
|
+
getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
530
600
|
/**
|
|
531
601
|
* @param {Object} arg - Arg object.
|
|
532
602
|
* @param {string} arg.companyId - Company id
|
|
533
603
|
* @param {string} arg.applicationId - Application id
|
|
534
604
|
* @param {number} [arg.pageSize] - Current request items count
|
|
535
605
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
606
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
536
607
|
* @returns {Paginator<CommunicationPlatformModel.Jobs>}
|
|
537
608
|
* @summary: Get jobs
|
|
538
609
|
* @description: Get jobs
|
|
539
610
|
*/
|
|
540
|
-
getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
611
|
+
getJobsPaginator({ companyId, applicationId, pageSize, sort, query }?: {
|
|
541
612
|
companyId: string;
|
|
542
613
|
applicationId: string;
|
|
543
614
|
pageSize?: number;
|
|
544
615
|
sort?: any;
|
|
616
|
+
query?: any;
|
|
545
617
|
}): Paginator<CommunicationPlatformModel.Jobs>;
|
|
546
618
|
/**
|
|
547
619
|
* @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
|
|
@@ -567,6 +639,18 @@ declare class Communication {
|
|
|
567
639
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get n sample records from csv. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
568
640
|
*/
|
|
569
641
|
getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
642
|
+
/**
|
|
643
|
+
* @param {CommunicationPlatformApplicationValidator.GetOtpConfigurationParam} arg
|
|
644
|
+
* - Arg object
|
|
645
|
+
*
|
|
646
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
647
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
648
|
+
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
649
|
+
* @name getOtpConfiguration
|
|
650
|
+
* @summary: Get otp-configuration, if not present in db then return default settings
|
|
651
|
+
* @description: Get otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getOtpConfiguration/).
|
|
652
|
+
*/
|
|
653
|
+
getOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
570
654
|
/**
|
|
571
655
|
* @param {CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam} arg
|
|
572
656
|
* - Arg object
|
|
@@ -614,22 +698,24 @@ declare class Communication {
|
|
|
614
698
|
* @summary: Get sms templates
|
|
615
699
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
|
|
616
700
|
*/
|
|
617
|
-
getSmsTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
701
|
+
getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
618
702
|
/**
|
|
619
703
|
* @param {Object} arg - Arg object.
|
|
620
704
|
* @param {string} arg.companyId - Company id
|
|
621
705
|
* @param {string} arg.applicationId - Application id
|
|
622
706
|
* @param {number} [arg.pageSize] - Current request items count
|
|
623
707
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
708
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
624
709
|
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
625
710
|
* @summary: Get sms templates
|
|
626
711
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.
|
|
627
712
|
*/
|
|
628
|
-
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
713
|
+
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
|
|
629
714
|
companyId: string;
|
|
630
715
|
applicationId: string;
|
|
631
716
|
pageSize?: number;
|
|
632
717
|
sort?: any;
|
|
718
|
+
query?: any;
|
|
633
719
|
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
634
720
|
/**
|
|
635
721
|
* @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
|
|
@@ -654,20 +740,22 @@ declare class Communication {
|
|
|
654
740
|
* @summary: Get subscribed email templates
|
|
655
741
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
656
742
|
*/
|
|
657
|
-
getSubscribedEmailTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
743
|
+
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
658
744
|
/**
|
|
659
745
|
* @param {Object} arg - Arg object.
|
|
660
746
|
* @param {string} arg.companyId - Company id
|
|
661
747
|
* @param {string} arg.applicationId - Application id
|
|
662
748
|
* @param {number} [arg.pageSize] - Current request items count
|
|
749
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
663
750
|
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
664
751
|
* @summary: Get subscribed email templates
|
|
665
752
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.
|
|
666
753
|
*/
|
|
667
|
-
getSubscribedEmailTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
|
|
754
|
+
getSubscribedEmailTemplatesPaginator({ companyId, applicationId, pageSize, query, }?: {
|
|
668
755
|
companyId: string;
|
|
669
756
|
applicationId: string;
|
|
670
757
|
pageSize?: number;
|
|
758
|
+
query?: any;
|
|
671
759
|
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
672
760
|
/**
|
|
673
761
|
* @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
|
|
@@ -680,20 +768,22 @@ declare class Communication {
|
|
|
680
768
|
* @summary: Get subscribed sms templates
|
|
681
769
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
682
770
|
*/
|
|
683
|
-
getSubscribedSmsTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
771
|
+
getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
684
772
|
/**
|
|
685
773
|
* @param {Object} arg - Arg object.
|
|
686
774
|
* @param {string} arg.companyId - Company id
|
|
687
775
|
* @param {string} arg.applicationId - Application id
|
|
688
776
|
* @param {number} [arg.pageSize] - Current request items count
|
|
777
|
+
* @param {Object} [arg.query] - To search based on plain text
|
|
689
778
|
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
690
779
|
* @summary: Get subscribed sms templates
|
|
691
780
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates.
|
|
692
781
|
*/
|
|
693
|
-
getSubscribedSmsTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
|
|
782
|
+
getSubscribedSmsTemplatesPaginator({ companyId, applicationId, pageSize, query, }?: {
|
|
694
783
|
companyId: string;
|
|
695
784
|
applicationId: string;
|
|
696
785
|
pageSize?: number;
|
|
786
|
+
query?: any;
|
|
697
787
|
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
698
788
|
/**
|
|
699
789
|
* @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
|
|
@@ -854,6 +944,18 @@ declare class Communication {
|
|
|
854
944
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to update an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
|
|
855
945
|
*/
|
|
856
946
|
updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
947
|
+
/**
|
|
948
|
+
* @param {CommunicationPlatformApplicationValidator.UpdateOtpConfigurationParam} arg
|
|
949
|
+
* - Arg object
|
|
950
|
+
*
|
|
951
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
952
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
953
|
+
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
954
|
+
* @name updateOtpConfiguration
|
|
955
|
+
* @summary: Update/insert otp configurations
|
|
956
|
+
* @description: Update otp-configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateOtpConfiguration/).
|
|
957
|
+
*/
|
|
958
|
+
updateOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
857
959
|
/**
|
|
858
960
|
* @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
|
|
859
961
|
* - Arg object
|