@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +41 -41
- package/sdk/platform/Order/OrderPlatformClient.js +41 -41
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -11,7 +11,7 @@ declare class Communication {
|
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
12
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
13
13
|
* @name createAudience
|
|
14
|
-
* @summary: Create audience
|
|
14
|
+
* @summary: Create audience
|
|
15
15
|
* @description: Add audience which 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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createAudience/).
|
|
16
16
|
*/
|
|
17
17
|
createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
@@ -23,7 +23,7 @@ declare class Communication {
|
|
|
23
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
24
|
* @returns {Promise<Object>} - Success response
|
|
25
25
|
* @name createBigQueryHeaders
|
|
26
|
-
* @summary: Create BigQuery headers
|
|
26
|
+
* @summary: Create BigQuery headers
|
|
27
27
|
* @description: Create big query headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
|
|
28
28
|
*/
|
|
29
29
|
createBigQueryHeaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
@@ -35,7 +35,7 @@ declare class Communication {
|
|
|
35
35
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
36
|
* @returns {Promise<Object>} - Success response
|
|
37
37
|
* @name createBigQueryNCount
|
|
38
|
-
* @summary: Create BigQuery N-count
|
|
38
|
+
* @summary: Create BigQuery N-count
|
|
39
39
|
* @description: Create big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
|
|
40
40
|
*/
|
|
41
41
|
createBigQueryNCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
@@ -47,7 +47,7 @@ declare class Communication {
|
|
|
47
47
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
48
|
* @returns {Promise<Object>} - Success response
|
|
49
49
|
* @name createBigQueryRowCount
|
|
50
|
-
* @summary: Create BigQuery row count
|
|
50
|
+
* @summary: Create BigQuery row count
|
|
51
51
|
* @description: Create big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
|
|
52
52
|
*/
|
|
53
53
|
createBigQueryRowCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
@@ -59,7 +59,7 @@ declare class Communication {
|
|
|
59
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
60
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
61
61
|
* @name createCampaign
|
|
62
|
-
* @summary: Create campaign
|
|
62
|
+
* @summary: Create campaign
|
|
63
63
|
* @description: Add a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
|
|
64
64
|
*/
|
|
65
65
|
createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
@@ -71,7 +71,7 @@ declare class Communication {
|
|
|
71
71
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
72
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
73
73
|
* @name createEmailProvider
|
|
74
|
-
* @summary: Create email provider
|
|
74
|
+
* @summary: Create email provider
|
|
75
75
|
* @description: Generate and add a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
|
|
76
76
|
*/
|
|
77
77
|
createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
@@ -83,7 +83,7 @@ declare class Communication {
|
|
|
83
83
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
84
84
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
85
85
|
* @name createEmailTemplate
|
|
86
|
-
* @summary: Create email template
|
|
86
|
+
* @summary: Create email template
|
|
87
87
|
* @description: Generate and add a new email communication 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>;
|
|
@@ -135,7 +135,7 @@ declare class Communication {
|
|
|
135
135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
136
136
|
* @returns {Promise<Object>} - Success response
|
|
137
137
|
* @name createSmsProvider
|
|
138
|
-
* @summary: Create SMS provider
|
|
138
|
+
* @summary: Create SMS provider
|
|
139
139
|
* @description: Add a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
|
|
140
140
|
*/
|
|
141
141
|
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -147,7 +147,7 @@ declare class Communication {
|
|
|
147
147
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
148
148
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
149
149
|
* @name createSmsTemplate
|
|
150
|
-
* @summary: Create SMS template
|
|
150
|
+
* @summary: Create SMS template
|
|
151
151
|
* @description: Add a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
|
|
152
152
|
*/
|
|
153
153
|
createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
@@ -159,7 +159,7 @@ declare class Communication {
|
|
|
159
159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
160
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
161
161
|
* @name deleteAudienceById
|
|
162
|
-
* @summary: Delete audience by ID
|
|
162
|
+
* @summary: Delete audience by ID
|
|
163
163
|
* @description: Remove a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
|
|
164
164
|
*/
|
|
165
165
|
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
@@ -171,7 +171,7 @@ declare class Communication {
|
|
|
171
171
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
172
172
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
173
173
|
* @name deleteEmailProviderById
|
|
174
|
-
* @summary: Delete email provider by ID
|
|
174
|
+
* @summary: Delete email provider by ID
|
|
175
175
|
* @description: Remove a specific email communication provider from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
|
|
176
176
|
*/
|
|
177
177
|
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
@@ -183,7 +183,7 @@ declare class Communication {
|
|
|
183
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
184
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
185
185
|
* @name deleteEmailTemplateById
|
|
186
|
-
* @summary: Delete email template by ID
|
|
186
|
+
* @summary: Delete email template by ID
|
|
187
187
|
* @description: Email templates are predefined formats linked to various events for delivering messages to users. Remove a specific email communication template by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailTemplateById/).
|
|
188
188
|
*/
|
|
189
189
|
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
@@ -207,7 +207,7 @@ declare class Communication {
|
|
|
207
207
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
208
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
209
209
|
* @name deleteSmsProviderById
|
|
210
|
-
* @summary: Delete SMS provider by ID
|
|
210
|
+
* @summary: Delete SMS provider by ID
|
|
211
211
|
* @description: Remove a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
|
|
212
212
|
*/
|
|
213
213
|
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
@@ -219,7 +219,7 @@ declare class Communication {
|
|
|
219
219
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
220
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
221
221
|
* @name deleteSmsTemplateById
|
|
222
|
-
* @summary: Delete SMS template by ID
|
|
222
|
+
* @summary: Delete SMS template by ID
|
|
223
223
|
* @description: Remove a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
|
|
224
224
|
*/
|
|
225
225
|
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
@@ -245,7 +245,7 @@ declare class Communication {
|
|
|
245
245
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
246
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
247
247
|
* @name getAppProviders
|
|
248
|
-
* @summary: Get application providers
|
|
248
|
+
* @summary: Get application providers
|
|
249
249
|
* @description: Retrieve a list of providers associated with the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
|
|
250
250
|
*/
|
|
251
251
|
getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
@@ -257,7 +257,7 @@ declare class Communication {
|
|
|
257
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
259
259
|
* @name getAudienceById
|
|
260
|
-
* @summary: Get audience by ID
|
|
260
|
+
* @summary: Get audience by ID
|
|
261
261
|
* @description: Retrieve detailed information about a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
|
|
262
262
|
*/
|
|
263
263
|
getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
@@ -269,7 +269,7 @@ declare class Communication {
|
|
|
269
269
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
270
|
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
271
271
|
* @name getAudiences
|
|
272
|
-
* @summary: Get audiences
|
|
272
|
+
* @summary: Get audiences
|
|
273
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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudiences/).
|
|
274
274
|
*/
|
|
275
275
|
getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
@@ -281,7 +281,7 @@ declare class Communication {
|
|
|
281
281
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
282
282
|
* @returns {Promise<Object>} - Success response
|
|
283
283
|
* @name getBigQueryHeadersById
|
|
284
|
-
* @summary: Get BigQuery headers by ID
|
|
284
|
+
* @summary: Get BigQuery headers by ID
|
|
285
285
|
* @description: Retrieve header information from BigQuery for a specific campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
|
|
286
286
|
*/
|
|
287
287
|
getBigQueryHeadersById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -293,7 +293,7 @@ declare class Communication {
|
|
|
293
293
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
294
294
|
* @returns {Promise<Object>} - Success response
|
|
295
295
|
* @name getBigQueryRowCountById
|
|
296
|
-
* @summary: Get BigQuery row count by ID
|
|
296
|
+
* @summary: Get BigQuery row count by ID
|
|
297
297
|
* @description: Retrieve big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
|
|
298
298
|
*/
|
|
299
299
|
getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -305,7 +305,7 @@ declare class Communication {
|
|
|
305
305
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
306
306
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
307
307
|
* @name getCampaignById
|
|
308
|
-
* @summary: Get campaign by ID
|
|
308
|
+
* @summary: Get campaign by ID
|
|
309
309
|
* @description: Retrieve detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
|
|
310
310
|
*/
|
|
311
311
|
getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
@@ -317,7 +317,7 @@ declare class Communication {
|
|
|
317
317
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
318
318
|
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
319
319
|
* @name getCampaigns
|
|
320
|
-
* @summary: Get campaigns
|
|
320
|
+
* @summary: Get campaigns
|
|
321
321
|
* @description: Retrieve a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
322
322
|
*/
|
|
323
323
|
getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
@@ -329,7 +329,7 @@ declare class Communication {
|
|
|
329
329
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
330
330
|
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
331
331
|
* @name getCommunicationLogs
|
|
332
|
-
* @summary: Get communication logs
|
|
332
|
+
* @summary: Get communication logs
|
|
333
333
|
* @description: Retrieve logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
|
|
334
334
|
*/
|
|
335
335
|
getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
|
|
@@ -342,7 +342,7 @@ declare class Communication {
|
|
|
342
342
|
* @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
|
|
343
343
|
* Success response
|
|
344
344
|
* @name getDefaultSmsProviders
|
|
345
|
-
* @summary: Get default SMS providers
|
|
345
|
+
* @summary: Get default SMS providers
|
|
346
346
|
* @description: Retrieve the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
|
|
347
347
|
*/
|
|
348
348
|
getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
|
|
@@ -355,7 +355,7 @@ declare class Communication {
|
|
|
355
355
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
|
|
356
356
|
* Success response
|
|
357
357
|
* @name getDummyDatasources
|
|
358
|
-
* @summary: Get dummy data sources
|
|
358
|
+
* @summary: Get dummy data sources
|
|
359
359
|
* @description: Retrieve a list of dummy data sources for testing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
|
|
360
360
|
*/
|
|
361
361
|
getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
|
|
@@ -368,7 +368,7 @@ declare class Communication {
|
|
|
368
368
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
|
|
369
369
|
* Success response
|
|
370
370
|
* @name getDummyDatasourcesMeta
|
|
371
|
-
* @summary: Get dummy data sources metadata
|
|
371
|
+
* @summary: Get dummy data sources metadata
|
|
372
372
|
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
373
373
|
*/
|
|
374
374
|
getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
|
|
@@ -380,7 +380,7 @@ declare class Communication {
|
|
|
380
380
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
381
381
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
382
382
|
* @name getEmailProviderById
|
|
383
|
-
* @summary: Get email provider by ID
|
|
383
|
+
* @summary: Get email provider by ID
|
|
384
384
|
* @description: Retrieve detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
|
|
385
385
|
*/
|
|
386
386
|
getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
@@ -392,7 +392,7 @@ declare class Communication {
|
|
|
392
392
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
393
393
|
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
394
394
|
* @name getEmailProviders
|
|
395
|
-
* @summary: Get email providers
|
|
395
|
+
* @summary: Get email providers
|
|
396
396
|
* @description: Retrieve a list of email communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
397
397
|
*/
|
|
398
398
|
getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
@@ -404,7 +404,7 @@ declare class Communication {
|
|
|
404
404
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
405
405
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
406
406
|
* @name getEmailTemplateById
|
|
407
|
-
* @summary: Get email template by ID
|
|
407
|
+
* @summary: Get email template by ID
|
|
408
408
|
* @description: Retrieve detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
|
|
409
409
|
*/
|
|
410
410
|
getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
@@ -416,7 +416,7 @@ declare class Communication {
|
|
|
416
416
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
417
417
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
418
418
|
* @name getEmailTemplates
|
|
419
|
-
* @summary: Get email templates
|
|
419
|
+
* @summary: Get email templates
|
|
420
420
|
* @description: Retrieve a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
|
|
421
421
|
*/
|
|
422
422
|
getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
@@ -429,7 +429,7 @@ declare class Communication {
|
|
|
429
429
|
* @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
|
|
430
430
|
* Success response
|
|
431
431
|
* @name getEventSubscriptions
|
|
432
|
-
* @summary: Get event subscriptions
|
|
432
|
+
* @summary: Get event subscriptions
|
|
433
433
|
* @description: Retrieve a list of event subscriptions related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
|
|
434
434
|
*/
|
|
435
435
|
getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
@@ -453,7 +453,7 @@ declare class Communication {
|
|
|
453
453
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
454
454
|
* @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
|
|
455
455
|
* @name getGlobalProviders
|
|
456
|
-
* @summary: Get global providers
|
|
456
|
+
* @summary: Get global providers
|
|
457
457
|
* @description: Retrieve a list of global communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
|
|
458
458
|
*/
|
|
459
459
|
getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
|
|
@@ -467,7 +467,7 @@ declare class Communication {
|
|
|
467
467
|
* - Success response
|
|
468
468
|
*
|
|
469
469
|
* @name getGlobalVariables
|
|
470
|
-
* @summary: Get global variables
|
|
470
|
+
* @summary: Get global variables
|
|
471
471
|
* @description: Retrieve global variables used in communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
|
|
472
472
|
*/
|
|
473
473
|
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesGetResponse>;
|
|
@@ -477,7 +477,7 @@ declare class Communication {
|
|
|
477
477
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
478
478
|
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
479
479
|
* @name getJobLogs
|
|
480
|
-
* @summary: Get job logs
|
|
480
|
+
* @summary: Get job logs
|
|
481
481
|
* @description: Retrieve logs and details related to communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
482
482
|
*/
|
|
483
483
|
getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
@@ -487,7 +487,7 @@ declare class Communication {
|
|
|
487
487
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
488
488
|
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
489
489
|
* @name getJobs
|
|
490
|
-
* @summary: Get jobs
|
|
490
|
+
* @summary: Get jobs
|
|
491
491
|
* @description: Retrieve a list of communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
492
492
|
*/
|
|
493
493
|
getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
@@ -499,7 +499,7 @@ declare class Communication {
|
|
|
499
499
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
500
500
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
501
501
|
* @name getNSampleRecordsFromCsv
|
|
502
|
-
* @summary: Get N sample records from CSV
|
|
502
|
+
* @summary: Get N sample records from CSV
|
|
503
503
|
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getNSampleRecordsFromCsv/).
|
|
504
504
|
*/
|
|
505
505
|
getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
@@ -535,7 +535,7 @@ declare class Communication {
|
|
|
535
535
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
536
536
|
* @returns {Promise<Object>} - Success response
|
|
537
537
|
* @name getSmsProviderById
|
|
538
|
-
* @summary: Get SMS provider by ID
|
|
538
|
+
* @summary: Get SMS provider by ID
|
|
539
539
|
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
|
|
540
540
|
*/
|
|
541
541
|
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -547,7 +547,7 @@ declare class Communication {
|
|
|
547
547
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
548
548
|
* @returns {Promise<Object>} - Success response
|
|
549
549
|
* @name getSmsProviders
|
|
550
|
-
* @summary: Get SMS providers
|
|
550
|
+
* @summary: Get SMS providers
|
|
551
551
|
* @description: Retrieve a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
|
|
552
552
|
*/
|
|
553
553
|
getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -559,7 +559,7 @@ declare class Communication {
|
|
|
559
559
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
560
560
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
561
561
|
* @name getSmsTemplateById
|
|
562
|
-
* @summary: Get SMS template by ID
|
|
562
|
+
* @summary: Get SMS template by ID
|
|
563
563
|
* @description: Retrieve detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
|
|
564
564
|
*/
|
|
565
565
|
getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
@@ -571,7 +571,7 @@ declare class Communication {
|
|
|
571
571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
572
572
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
573
573
|
* @name getSmsTemplates
|
|
574
|
-
* @summary: Get SMS templates
|
|
574
|
+
* @summary: Get SMS templates
|
|
575
575
|
* @description: Retrieve a list of available SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
|
|
576
576
|
*/
|
|
577
577
|
getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
@@ -583,7 +583,7 @@ declare class Communication {
|
|
|
583
583
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
584
584
|
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
585
585
|
* @name getStatsOfCampaignById
|
|
586
|
-
* @summary: Get campaign statistics by ID
|
|
586
|
+
* @summary: Get campaign statistics by ID
|
|
587
587
|
* @description: Retrieve statistical data for a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
|
|
588
588
|
*/
|
|
589
589
|
getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
|
|
@@ -595,7 +595,7 @@ declare class Communication {
|
|
|
595
595
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
596
596
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
597
597
|
* @name getSubscribedEmailTemplates
|
|
598
|
-
* @summary: Get subscribed email templates
|
|
598
|
+
* @summary: Get subscribed email templates
|
|
599
599
|
* @description: Retrieve email communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
600
600
|
*/
|
|
601
601
|
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
@@ -607,7 +607,7 @@ declare class Communication {
|
|
|
607
607
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
608
608
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
609
609
|
* @name getSubscribedSmsTemplates
|
|
610
|
-
* @summary: Get subscribed SMS templates
|
|
610
|
+
* @summary: Get subscribed SMS templates
|
|
611
611
|
* @description: Retrieve SMS communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
612
612
|
*/
|
|
613
613
|
getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
@@ -619,7 +619,7 @@ declare class Communication {
|
|
|
619
619
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
620
620
|
* @returns {Promise<Object>} - Success response
|
|
621
621
|
* @name getSystemAudiences
|
|
622
|
-
* @summary: Get system audiences
|
|
622
|
+
* @summary: Get system audiences
|
|
623
623
|
* @description: Retrieve system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
|
|
624
624
|
*/
|
|
625
625
|
getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
@@ -632,7 +632,7 @@ declare class Communication {
|
|
|
632
632
|
* @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
|
|
633
633
|
* Success response
|
|
634
634
|
* @name getSystemEmailTemplates
|
|
635
|
-
* @summary: Get system email templates
|
|
635
|
+
* @summary: Get system email templates
|
|
636
636
|
* @description: Retrieve system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
|
|
637
637
|
*/
|
|
638
638
|
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
|
|
@@ -645,7 +645,7 @@ declare class Communication {
|
|
|
645
645
|
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
|
|
646
646
|
* Success response
|
|
647
647
|
* @name getSystemSmsTemplates
|
|
648
|
-
* @summary: Get system SMS templates
|
|
648
|
+
* @summary: Get system SMS templates
|
|
649
649
|
* @description: Retrieve system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
|
|
650
650
|
*/
|
|
651
651
|
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates[]>;
|
|
@@ -659,7 +659,7 @@ declare class Communication {
|
|
|
659
659
|
* - Success response
|
|
660
660
|
*
|
|
661
661
|
* @name postGlobalVariables
|
|
662
|
-
* @summary: Post global variables
|
|
662
|
+
* @summary: Post global variables
|
|
663
663
|
* @description: Update and post global variables for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
|
|
664
664
|
*/
|
|
665
665
|
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalVariablesPostResponse>;
|
|
@@ -671,7 +671,7 @@ declare class Communication {
|
|
|
671
671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
672
672
|
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
673
673
|
* @name sendCommunicationAsynchronously
|
|
674
|
-
* @summary: Send communication asynchronously
|
|
674
|
+
* @summary: Send communication asynchronously
|
|
675
675
|
* @description: Initiate and send communication with the option for asynchronous processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
676
676
|
*/
|
|
677
677
|
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
|
|
@@ -683,7 +683,7 @@ declare class Communication {
|
|
|
683
683
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
684
684
|
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
685
685
|
* @name sendCommunicationSynchronously
|
|
686
|
-
* @summary: Send communication synchronously
|
|
686
|
+
* @summary: Send communication synchronously
|
|
687
687
|
* @description: Initiate and send communication in real-time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
688
688
|
*/
|
|
689
689
|
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResponse>;
|
|
@@ -693,7 +693,7 @@ declare class Communication {
|
|
|
693
693
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
694
694
|
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
695
695
|
* @name sendOtp
|
|
696
|
-
* @summary: Send OTP
|
|
696
|
+
* @summary: Send OTP
|
|
697
697
|
* @description: Send a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendOtp/).
|
|
698
698
|
*/
|
|
699
699
|
sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
@@ -706,7 +706,7 @@ declare class Communication {
|
|
|
706
706
|
* @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
|
|
707
707
|
* Success response
|
|
708
708
|
* @name triggerCampaignJob
|
|
709
|
-
* @summary: Trigger campaign job
|
|
709
|
+
* @summary: Trigger campaign job
|
|
710
710
|
* @description: Initiate a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
|
|
711
711
|
*/
|
|
712
712
|
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResponse>;
|
|
@@ -718,7 +718,7 @@ declare class Communication {
|
|
|
718
718
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
719
719
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
720
720
|
* @name updateAppProviders
|
|
721
|
-
* @summary: Update application providers
|
|
721
|
+
* @summary: Update application providers
|
|
722
722
|
* @description: Modify provider information for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
|
|
723
723
|
*/
|
|
724
724
|
updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
@@ -730,7 +730,7 @@ declare class Communication {
|
|
|
730
730
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
731
731
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
732
732
|
* @name updateAudienceById
|
|
733
|
-
* @summary: Update audience by ID
|
|
733
|
+
* @summary: Update audience by ID
|
|
734
734
|
* @description: Modify the settings of a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
|
|
735
735
|
*/
|
|
736
736
|
updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
@@ -742,7 +742,7 @@ declare class Communication {
|
|
|
742
742
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
743
743
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
744
744
|
* @name updateCampaignById
|
|
745
|
-
* @summary: Update campaign by ID
|
|
745
|
+
* @summary: Update campaign by ID
|
|
746
746
|
* @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
|
|
747
747
|
*/
|
|
748
748
|
updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
@@ -754,7 +754,7 @@ declare class Communication {
|
|
|
754
754
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
755
755
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
756
756
|
* @name updateEmailProviderById
|
|
757
|
-
* @summary: Update email provider by ID
|
|
757
|
+
* @summary: Update email provider by ID
|
|
758
758
|
* @description: Modify the settings of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
|
|
759
759
|
*/
|
|
760
760
|
updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
@@ -766,7 +766,7 @@ declare class Communication {
|
|
|
766
766
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
767
767
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
768
768
|
* @name updateEmailTemplateById
|
|
769
|
-
* @summary: Update email template by ID
|
|
769
|
+
* @summary: Update email template by ID
|
|
770
770
|
* @description: Modify the content and settings of a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailTemplateById/).
|
|
771
771
|
*/
|
|
772
772
|
updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
@@ -790,7 +790,7 @@ declare class Communication {
|
|
|
790
790
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
791
791
|
* @returns {Promise<Object>} - Success response
|
|
792
792
|
* @name updateSmsProviderById
|
|
793
|
-
* @summary: Update SMS provider by ID
|
|
793
|
+
* @summary: Update SMS provider by ID
|
|
794
794
|
* @description: Modify specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
|
|
795
795
|
*/
|
|
796
796
|
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -802,7 +802,7 @@ declare class Communication {
|
|
|
802
802
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
803
803
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
804
804
|
* @name updateSmsTemplateById
|
|
805
|
-
* @summary: Update SMS template by ID
|
|
805
|
+
* @summary: Update SMS template by ID
|
|
806
806
|
* @description: Modify the content and settings of a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsTemplateById/).
|
|
807
807
|
*/
|
|
808
808
|
updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
@@ -814,7 +814,7 @@ declare class Communication {
|
|
|
814
814
|
* - Success response
|
|
815
815
|
*
|
|
816
816
|
* @name verfiyOtp
|
|
817
|
-
* @summary: Verify OTP
|
|
817
|
+
* @summary: Verify OTP
|
|
818
818
|
* @description: Verify the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/verfiyOtp/).
|
|
819
819
|
*/
|
|
820
820
|
verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
|