@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +3 -5
- package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
- package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
- package/sdk/application/Cart/CartApplicationValidator.js +0 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
- package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
- package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
- package/sdk/application/Content/ContentApplicationClient.js +0 -246
- package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
- package/sdk/application/Content/ContentApplicationModel.js +565 -817
- package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
- package/sdk/application/Content/ContentApplicationValidator.js +0 -41
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
- package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
- package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +8 -32
- package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
- package/sdk/application/Order/OrderApplicationModel.js +816 -824
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
- package/sdk/application/Order/OrderApplicationValidator.js +0 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
- package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
- package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
- package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
- package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
- package/sdk/application/User/UserApplicationClient.d.ts +0 -33
- package/sdk/application/User/UserApplicationClient.js +0 -239
- package/sdk/application/User/UserApplicationModel.d.ts +753 -768
- package/sdk/application/User/UserApplicationModel.js +731 -755
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
- package/sdk/application/User/UserApplicationValidator.js +0 -36
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +254 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
- package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
- package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
- package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
- package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
- package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
- package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
- package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
- package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
- package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
- package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
- package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
- package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
- package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
- package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
- package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +2 -4
- package/sdk/platform/PlatformClient.js +4 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +990 -1589
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +986 -1702
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
- package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
- package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
- package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
- package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
- package/sdk/platform/User/UserPlatformModel.js +428 -679
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
- package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
- 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/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/PublicClient.d.ts +0 -4
- package/sdk/public/PublicClient.js +0 -8
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
- package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
- package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
- package/sdk/public/index.d.ts +0 -2
- package/sdk/public/index.js +0 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
- package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
- package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
- package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
- package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
- package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
- package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
- package/sdk/public/Billing/BillingPublicClient.js +0 -116
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
- package/sdk/public/Billing/BillingPublicModel.js +0 -96
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
- package/sdk/public/Billing/BillingPublicValidator.js +0 -19
- package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
- package/sdk/public/Content/ContentPublicClient.js +0 -114
- package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
- package/sdk/public/Content/ContentPublicModel.js +0 -60
- package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
- package/sdk/public/Content/ContentPublicValidator.js +0 -19
|
@@ -87,46 +87,6 @@ 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>;
|
|
130
90
|
/**
|
|
131
91
|
* @param {CommunicationPlatformApplicationValidator.CreateSmsProviderParam} arg
|
|
132
92
|
* - Arg object
|
|
@@ -157,12 +117,12 @@ declare class Communication {
|
|
|
157
117
|
*
|
|
158
118
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
159
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
120
|
+
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
161
121
|
* @name deleteAudienceById
|
|
162
122
|
* @summary: Delete audience by id
|
|
163
123
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to delete audience by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
|
|
164
124
|
*/
|
|
165
|
-
deleteAudienceById({ id,
|
|
125
|
+
deleteAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
166
126
|
/**
|
|
167
127
|
* @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg
|
|
168
128
|
* - Arg object
|
|
@@ -187,18 +147,6 @@ declare class Communication {
|
|
|
187
147
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to delete an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
|
|
188
148
|
*/
|
|
189
149
|
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>;
|
|
202
150
|
/**
|
|
203
151
|
* @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg
|
|
204
152
|
* - Arg object
|
|
@@ -223,20 +171,6 @@ declare class Communication {
|
|
|
223
171
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to delete an sms template by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
|
|
224
172
|
*/
|
|
225
173
|
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>;
|
|
240
174
|
/**
|
|
241
175
|
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
242
176
|
* - Arg object
|
|
@@ -272,24 +206,22 @@ declare class Communication {
|
|
|
272
206
|
* @summary: Get audiences
|
|
273
207
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
|
|
274
208
|
*/
|
|
275
|
-
getAudiences({ pageNo, pageSize, sort,
|
|
209
|
+
getAudiences({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
276
210
|
/**
|
|
277
211
|
* @param {Object} arg - Arg object.
|
|
278
212
|
* @param {string} arg.companyId - Company id
|
|
279
213
|
* @param {string} arg.applicationId - Application id
|
|
280
214
|
* @param {number} [arg.pageSize] - Current request items count
|
|
281
215
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
282
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
283
216
|
* @returns {Paginator<CommunicationPlatformModel.Audiences>}
|
|
284
217
|
* @summary: Get audiences
|
|
285
218
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get audiences.
|
|
286
219
|
*/
|
|
287
|
-
getAudiencesPaginator({ companyId, applicationId, pageSize, sort
|
|
220
|
+
getAudiencesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
288
221
|
companyId: string;
|
|
289
222
|
applicationId: string;
|
|
290
223
|
pageSize?: number;
|
|
291
224
|
sort?: any;
|
|
292
|
-
query?: any;
|
|
293
225
|
}): Paginator<CommunicationPlatformModel.Audiences>;
|
|
294
226
|
/**
|
|
295
227
|
* @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
|
|
@@ -338,7 +270,23 @@ declare class Communication {
|
|
|
338
270
|
* @summary: Get campaigns
|
|
339
271
|
* @description: Get campaigns - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
340
272
|
*/
|
|
341
|
-
getCampaigns({
|
|
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>;
|
|
342
290
|
/**
|
|
343
291
|
* @param {CommunicationPlatformApplicationValidator.GetCommunicationLogsParam} arg
|
|
344
292
|
* - Arg object
|
|
@@ -431,24 +379,22 @@ declare class Communication {
|
|
|
431
379
|
* @summary: Get email providers
|
|
432
380
|
* @description: Get email providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
433
381
|
*/
|
|
434
|
-
getEmailProviders({ pageNo, pageSize, sort,
|
|
382
|
+
getEmailProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
435
383
|
/**
|
|
436
384
|
* @param {Object} arg - Arg object.
|
|
437
385
|
* @param {string} arg.companyId - Company id
|
|
438
386
|
* @param {string} arg.applicationId - Application id
|
|
439
387
|
* @param {number} [arg.pageSize] - Current request items count
|
|
440
388
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
441
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
442
389
|
* @returns {Paginator<CommunicationPlatformModel.EmailProviders>}
|
|
443
390
|
* @summary: Get email providers
|
|
444
391
|
* @description: Get email providers
|
|
445
392
|
*/
|
|
446
|
-
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort,
|
|
393
|
+
getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
447
394
|
companyId: string;
|
|
448
395
|
applicationId: string;
|
|
449
396
|
pageSize?: number;
|
|
450
397
|
sort?: any;
|
|
451
|
-
query?: any;
|
|
452
398
|
}): Paginator<CommunicationPlatformModel.EmailProviders>;
|
|
453
399
|
/**
|
|
454
400
|
* @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg
|
|
@@ -473,24 +419,22 @@ declare class Communication {
|
|
|
473
419
|
* @summary: Get email templates
|
|
474
420
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
|
|
475
421
|
*/
|
|
476
|
-
getEmailTemplates({ pageNo, pageSize, sort,
|
|
422
|
+
getEmailTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
477
423
|
/**
|
|
478
424
|
* @param {Object} arg - Arg object.
|
|
479
425
|
* @param {string} arg.companyId - Company id
|
|
480
426
|
* @param {string} arg.applicationId - Application id
|
|
481
427
|
* @param {number} [arg.pageSize] - Current request items count
|
|
482
428
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
483
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
484
429
|
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
485
430
|
* @summary: Get email templates
|
|
486
431
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all email templates.
|
|
487
432
|
*/
|
|
488
|
-
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort,
|
|
433
|
+
getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
|
|
489
434
|
companyId: string;
|
|
490
435
|
applicationId: string;
|
|
491
436
|
pageSize?: number;
|
|
492
437
|
sort?: any;
|
|
493
|
-
query?: any;
|
|
494
438
|
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
495
439
|
/**
|
|
496
440
|
* @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg
|
|
@@ -510,7 +454,7 @@ declare class Communication {
|
|
|
510
454
|
* @param {string} arg.companyId - Company id
|
|
511
455
|
* @param {string} arg.applicationId - Application id
|
|
512
456
|
* @param {number} [arg.pageSize] - Current request items count
|
|
513
|
-
* @param {string} [arg.populate] - Populate
|
|
457
|
+
* @param {string} [arg.populate] - Populate fields
|
|
514
458
|
* @returns {Paginator<CommunicationPlatformModel.EventSubscriptions>}
|
|
515
459
|
* @summary: Get event subscriptions
|
|
516
460
|
* @description: Get event subscriptions
|
|
@@ -521,18 +465,6 @@ declare class Communication {
|
|
|
521
465
|
pageSize?: number;
|
|
522
466
|
populate?: string;
|
|
523
467
|
}): 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>;
|
|
536
468
|
/**
|
|
537
469
|
* @param {CommunicationPlatformApplicationValidator.GetGlobalProvidersParam} arg
|
|
538
470
|
* - Arg object
|
|
@@ -568,24 +500,22 @@ declare class Communication {
|
|
|
568
500
|
* @summary: Get job logs
|
|
569
501
|
* @description: Get job logs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
570
502
|
*/
|
|
571
|
-
getJobLogs({ pageNo, pageSize, sort,
|
|
503
|
+
getJobLogs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
572
504
|
/**
|
|
573
505
|
* @param {Object} arg - Arg object.
|
|
574
506
|
* @param {string} arg.companyId - Company id
|
|
575
507
|
* @param {string} arg.applicationId - Application id
|
|
576
508
|
* @param {number} [arg.pageSize] - Current request items count
|
|
577
509
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
578
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
579
510
|
* @returns {Paginator<CommunicationPlatformModel.JobLogs>}
|
|
580
511
|
* @summary: Get job logs
|
|
581
512
|
* @description: Get job logs
|
|
582
513
|
*/
|
|
583
|
-
getJobLogsPaginator({ companyId, applicationId, pageSize, sort
|
|
514
|
+
getJobLogsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
584
515
|
companyId: string;
|
|
585
516
|
applicationId: string;
|
|
586
517
|
pageSize?: number;
|
|
587
518
|
sort?: any;
|
|
588
|
-
query?: any;
|
|
589
519
|
}): Paginator<CommunicationPlatformModel.JobLogs>;
|
|
590
520
|
/**
|
|
591
521
|
* @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object
|
|
@@ -596,24 +526,22 @@ declare class Communication {
|
|
|
596
526
|
* @summary: Get jobs
|
|
597
527
|
* @description: Get jobs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
598
528
|
*/
|
|
599
|
-
getJobs({ pageNo, pageSize, sort,
|
|
529
|
+
getJobs({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
600
530
|
/**
|
|
601
531
|
* @param {Object} arg - Arg object.
|
|
602
532
|
* @param {string} arg.companyId - Company id
|
|
603
533
|
* @param {string} arg.applicationId - Application id
|
|
604
534
|
* @param {number} [arg.pageSize] - Current request items count
|
|
605
535
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
606
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
607
536
|
* @returns {Paginator<CommunicationPlatformModel.Jobs>}
|
|
608
537
|
* @summary: Get jobs
|
|
609
538
|
* @description: Get jobs
|
|
610
539
|
*/
|
|
611
|
-
getJobsPaginator({ companyId, applicationId, pageSize, sort
|
|
540
|
+
getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
612
541
|
companyId: string;
|
|
613
542
|
applicationId: string;
|
|
614
543
|
pageSize?: number;
|
|
615
544
|
sort?: any;
|
|
616
|
-
query?: any;
|
|
617
545
|
}): Paginator<CommunicationPlatformModel.Jobs>;
|
|
618
546
|
/**
|
|
619
547
|
* @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg
|
|
@@ -639,18 +567,6 @@ declare class Communication {
|
|
|
639
567
|
* @description: Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign. Use this API to get n sample records from csv. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
640
568
|
*/
|
|
641
569
|
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>;
|
|
654
570
|
/**
|
|
655
571
|
* @param {CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam} arg
|
|
656
572
|
* - Arg object
|
|
@@ -674,7 +590,7 @@ declare class Communication {
|
|
|
674
590
|
* @summary: Get sms providers
|
|
675
591
|
* @description: Get sms providers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
|
|
676
592
|
*/
|
|
677
|
-
getSmsProviders({ pageNo, pageSize, sort,
|
|
593
|
+
getSmsProviders({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
|
|
678
594
|
/**
|
|
679
595
|
* @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg
|
|
680
596
|
* - Arg object
|
|
@@ -698,24 +614,22 @@ declare class Communication {
|
|
|
698
614
|
* @summary: Get sms templates
|
|
699
615
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
|
|
700
616
|
*/
|
|
701
|
-
getSmsTemplates({ pageNo, pageSize, sort,
|
|
617
|
+
getSmsTemplates({ pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
702
618
|
/**
|
|
703
619
|
* @param {Object} arg - Arg object.
|
|
704
620
|
* @param {string} arg.companyId - Company id
|
|
705
621
|
* @param {string} arg.applicationId - Application id
|
|
706
622
|
* @param {number} [arg.pageSize] - Current request items count
|
|
707
623
|
* @param {Object} [arg.sort] - To sort based on created_at
|
|
708
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
709
624
|
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
710
625
|
* @summary: Get sms templates
|
|
711
626
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all sms templates.
|
|
712
627
|
*/
|
|
713
|
-
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort
|
|
628
|
+
getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort }?: {
|
|
714
629
|
companyId: string;
|
|
715
630
|
applicationId: string;
|
|
716
631
|
pageSize?: number;
|
|
717
632
|
sort?: any;
|
|
718
|
-
query?: any;
|
|
719
633
|
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
720
634
|
/**
|
|
721
635
|
* @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg
|
|
@@ -740,22 +654,20 @@ declare class Communication {
|
|
|
740
654
|
* @summary: Get subscribed email templates
|
|
741
655
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
742
656
|
*/
|
|
743
|
-
getSubscribedEmailTemplates({ pageNo, pageSize,
|
|
657
|
+
getSubscribedEmailTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
744
658
|
/**
|
|
745
659
|
* @param {Object} arg - Arg object.
|
|
746
660
|
* @param {string} arg.companyId - Company id
|
|
747
661
|
* @param {string} arg.applicationId - Application id
|
|
748
662
|
* @param {number} [arg.pageSize] - Current request items count
|
|
749
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
750
663
|
* @returns {Paginator<CommunicationPlatformModel.EmailTemplates>}
|
|
751
664
|
* @summary: Get subscribed email templates
|
|
752
665
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to get all subscribed email templates.
|
|
753
666
|
*/
|
|
754
|
-
getSubscribedEmailTemplatesPaginator({ companyId, applicationId, pageSize,
|
|
667
|
+
getSubscribedEmailTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
|
|
755
668
|
companyId: string;
|
|
756
669
|
applicationId: string;
|
|
757
670
|
pageSize?: number;
|
|
758
|
-
query?: any;
|
|
759
671
|
}): Paginator<CommunicationPlatformModel.EmailTemplates>;
|
|
760
672
|
/**
|
|
761
673
|
* @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg
|
|
@@ -768,22 +680,20 @@ declare class Communication {
|
|
|
768
680
|
* @summary: Get subscribed sms templates
|
|
769
681
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
770
682
|
*/
|
|
771
|
-
getSubscribedSmsTemplates({ pageNo, pageSize,
|
|
683
|
+
getSubscribedSmsTemplates({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
772
684
|
/**
|
|
773
685
|
* @param {Object} arg - Arg object.
|
|
774
686
|
* @param {string} arg.companyId - Company id
|
|
775
687
|
* @param {string} arg.applicationId - Application id
|
|
776
688
|
* @param {number} [arg.pageSize] - Current request items count
|
|
777
|
-
* @param {Object} [arg.query] - To search based on plain text
|
|
778
689
|
* @returns {Paginator<CommunicationPlatformModel.SmsTemplates>}
|
|
779
690
|
* @summary: Get subscribed sms templates
|
|
780
691
|
* @description: SMS templates are predefined message formats linked to various events for delivering messages to users. Use this API to get all subscribed sms templates.
|
|
781
692
|
*/
|
|
782
|
-
getSubscribedSmsTemplatesPaginator({ companyId, applicationId, pageSize,
|
|
693
|
+
getSubscribedSmsTemplatesPaginator({ companyId, applicationId, pageSize, }?: {
|
|
783
694
|
companyId: string;
|
|
784
695
|
applicationId: string;
|
|
785
696
|
pageSize?: number;
|
|
786
|
-
query?: any;
|
|
787
697
|
}): Paginator<CommunicationPlatformModel.SmsTemplates>;
|
|
788
698
|
/**
|
|
789
699
|
* @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
|
|
@@ -944,18 +854,6 @@ declare class Communication {
|
|
|
944
854
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Use this API to update an email template by id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
|
|
945
855
|
*/
|
|
946
856
|
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>;
|
|
959
857
|
/**
|
|
960
858
|
* @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg
|
|
961
859
|
* - Arg object
|