@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- 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 +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -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 +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- 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 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -12,7 +12,7 @@ declare class Communication {
|
|
|
12
12
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
13
13
|
* @name createAudience
|
|
14
14
|
* @summary: Create an audience
|
|
15
|
-
* @description: Creates a new email audience. - Check out [method documentation](https://
|
|
15
|
+
* @description: Creates a new email audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createAudience/).
|
|
16
16
|
*/
|
|
17
17
|
createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
18
18
|
/**
|
|
@@ -24,7 +24,7 @@ declare class Communication {
|
|
|
24
24
|
* @returns {Promise<Object>} - Success response
|
|
25
25
|
* @name createBigQueryHeaders
|
|
26
26
|
* @summary: Create BigQuery headers
|
|
27
|
-
* @description: Create BigQuery headers - Check out [method documentation](https://
|
|
27
|
+
* @description: Create BigQuery headers - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryHeaders/).
|
|
28
28
|
*/
|
|
29
29
|
createBigQueryHeaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
30
30
|
/**
|
|
@@ -36,7 +36,7 @@ declare class Communication {
|
|
|
36
36
|
* @returns {Promise<Object>} - Success response
|
|
37
37
|
* @name createBigQueryNCount
|
|
38
38
|
* @summary: Create BigQuery N-count
|
|
39
|
-
* @description: Creates big query n count - Check out [method documentation](https://
|
|
39
|
+
* @description: Creates big query n count - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryNCount/).
|
|
40
40
|
*/
|
|
41
41
|
createBigQueryNCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
42
42
|
/**
|
|
@@ -48,7 +48,7 @@ declare class Communication {
|
|
|
48
48
|
* @returns {Promise<Object>} - Success response
|
|
49
49
|
* @name createBigQueryRowCount
|
|
50
50
|
* @summary: Create a BigQuery row count
|
|
51
|
-
* @description: Creates big query row count - Check out [method documentation](https://
|
|
51
|
+
* @description: Creates big query row count - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryRowCount/).
|
|
52
52
|
*/
|
|
53
53
|
createBigQueryRowCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
54
54
|
/**
|
|
@@ -60,7 +60,7 @@ declare class Communication {
|
|
|
60
60
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
61
61
|
* @name createCampaign
|
|
62
62
|
* @summary: Create a campaign
|
|
63
|
-
* @description: Creates a new communication campaign. - Check out [method documentation](https://
|
|
63
|
+
* @description: Creates a new communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createCampaign/).
|
|
64
64
|
*/
|
|
65
65
|
createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
66
66
|
/**
|
|
@@ -72,7 +72,7 @@ declare class Communication {
|
|
|
72
72
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
73
73
|
* @name createEmailProvider
|
|
74
74
|
* @summary: Create an email provider
|
|
75
|
-
* @description: Creates a new email communication provider. - Check out [method documentation](https://
|
|
75
|
+
* @description: Creates a new email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailProvider/).
|
|
76
76
|
*/
|
|
77
77
|
createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
78
78
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Communication {
|
|
|
84
84
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
85
85
|
* @name createEmailTemplate
|
|
86
86
|
* @summary: Creat an email template
|
|
87
|
-
* @description: Creates a new email communication template. - Check out [method documentation](https://
|
|
87
|
+
* @description: Creates a new email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailTemplate/).
|
|
88
88
|
*/
|
|
89
89
|
createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
90
90
|
/**
|
|
@@ -98,7 +98,7 @@ declare class Communication {
|
|
|
98
98
|
*
|
|
99
99
|
* @name createEventSubscriptions
|
|
100
100
|
* @summary: Create an event subscription
|
|
101
|
-
* @description: Creates a new event subscription. - Check out [method documentation](https://
|
|
101
|
+
* @description: Creates a new event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptions/).
|
|
102
102
|
*/
|
|
103
103
|
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
104
104
|
/**
|
|
@@ -114,7 +114,7 @@ declare class Communication {
|
|
|
114
114
|
*
|
|
115
115
|
* @name createEventSubscriptionsByBulk
|
|
116
116
|
* @summary: Create event subscriptions in bulk
|
|
117
|
-
* @description: Creates a new event subscription in bulk. - Check out [method documentation](https://
|
|
117
|
+
* @description: Creates a new event subscription in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptionsByBulk/).
|
|
118
118
|
*/
|
|
119
119
|
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]>;
|
|
120
120
|
/**
|
|
@@ -124,7 +124,7 @@ declare class Communication {
|
|
|
124
124
|
* @returns {Promise<CommunicationPlatformModel.CreateJobsRes>} - Success response
|
|
125
125
|
* @name createJobs
|
|
126
126
|
* @summary: Create a campaign jobs
|
|
127
|
-
* @description: Creates a new campaign job. - Check out [method documentation](https://
|
|
127
|
+
* @description: Creates a new campaign job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createJobs/).
|
|
128
128
|
*/
|
|
129
129
|
createJobs({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateJobsRes>;
|
|
130
130
|
/**
|
|
@@ -136,7 +136,7 @@ declare class Communication {
|
|
|
136
136
|
* @returns {Promise<Object>} - Success response
|
|
137
137
|
* @name createSmsProvider
|
|
138
138
|
* @summary: Create SMS provider
|
|
139
|
-
* @description: Creates a new SMS communication provider. - Check out [method documentation](https://
|
|
139
|
+
* @description: Creates a new SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsProvider/).
|
|
140
140
|
*/
|
|
141
141
|
createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise<any>;
|
|
142
142
|
/**
|
|
@@ -148,7 +148,7 @@ declare class Communication {
|
|
|
148
148
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
149
149
|
* @name createSmsTemplate
|
|
150
150
|
* @summary: Create a SMS template
|
|
151
|
-
* @description: Creates a new SMS communication template. - Check out [method documentation](https://
|
|
151
|
+
* @description: Creates a new SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsTemplate/).
|
|
152
152
|
*/
|
|
153
153
|
createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
154
154
|
/**
|
|
@@ -160,7 +160,7 @@ declare class Communication {
|
|
|
160
160
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
161
161
|
* @name deleteAudienceById
|
|
162
162
|
* @summary: Delete an audience
|
|
163
|
-
* @description: Remove a specific audience permenantly. - Check out [method documentation](https://
|
|
163
|
+
* @description: Remove a specific audience permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteAudienceById/).
|
|
164
164
|
*/
|
|
165
165
|
deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
166
166
|
/**
|
|
@@ -172,7 +172,7 @@ declare class Communication {
|
|
|
172
172
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
173
173
|
* @name deleteEmailProviderById
|
|
174
174
|
* @summary: Delete an email provider
|
|
175
|
-
* @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://
|
|
175
|
+
* @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailProviderById/).
|
|
176
176
|
*/
|
|
177
177
|
deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
178
178
|
/**
|
|
@@ -184,7 +184,7 @@ declare class Communication {
|
|
|
184
184
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
185
185
|
* @name deleteEmailTemplateById
|
|
186
186
|
* @summary: Delete an email template
|
|
187
|
-
* @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://
|
|
187
|
+
* @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailTemplateById/).
|
|
188
188
|
*/
|
|
189
189
|
deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
190
190
|
/**
|
|
@@ -196,7 +196,7 @@ declare class Communication {
|
|
|
196
196
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
197
197
|
* @name deleteEventSubscriptionsById
|
|
198
198
|
* @summary: Delete an event subscriptions
|
|
199
|
-
* @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://
|
|
199
|
+
* @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEventSubscriptionsById/).
|
|
200
200
|
*/
|
|
201
201
|
deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
202
202
|
/**
|
|
@@ -208,7 +208,7 @@ declare class Communication {
|
|
|
208
208
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
209
209
|
* @name deleteSmsProviderById
|
|
210
210
|
* @summary: Delete an SMS provider
|
|
211
|
-
* @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://
|
|
211
|
+
* @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsProviderById/).
|
|
212
212
|
*/
|
|
213
213
|
deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
214
214
|
/**
|
|
@@ -220,7 +220,7 @@ declare class Communication {
|
|
|
220
220
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
221
221
|
* @name deleteSmsTemplateById
|
|
222
222
|
* @summary: Delete an SMS template
|
|
223
|
-
* @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://
|
|
223
|
+
* @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsTemplateById/).
|
|
224
224
|
*/
|
|
225
225
|
deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GenericDelete>;
|
|
226
226
|
/**
|
|
@@ -234,7 +234,7 @@ declare class Communication {
|
|
|
234
234
|
*
|
|
235
235
|
* @name editEventSubscriptions
|
|
236
236
|
* @summary: Update an event subscriptions
|
|
237
|
-
* @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://
|
|
237
|
+
* @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/editEventSubscriptions/).
|
|
238
238
|
*/
|
|
239
239
|
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
240
240
|
/**
|
|
@@ -246,7 +246,7 @@ declare class Communication {
|
|
|
246
246
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
247
247
|
* @name getAppProviders
|
|
248
248
|
* @summary: Get application providers
|
|
249
|
-
* @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://
|
|
249
|
+
* @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAppProviders/).
|
|
250
250
|
*/
|
|
251
251
|
getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
252
252
|
/**
|
|
@@ -258,7 +258,7 @@ declare class Communication {
|
|
|
258
258
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
259
259
|
* @name getAudienceById
|
|
260
260
|
* @summary: Get an audience
|
|
261
|
-
* @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://
|
|
261
|
+
* @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudienceById/).
|
|
262
262
|
*/
|
|
263
263
|
getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
264
264
|
/**
|
|
@@ -270,7 +270,7 @@ declare class Communication {
|
|
|
270
270
|
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
271
271
|
* @name getAudiences
|
|
272
272
|
* @summary: Get all the audiences
|
|
273
|
-
* @description: Retrieves a list of all the audiences. - Check out [method documentation](https://
|
|
273
|
+
* @description: Retrieves a list of all the audiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudiences/).
|
|
274
274
|
*/
|
|
275
275
|
getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audiences>;
|
|
276
276
|
/**
|
|
@@ -282,7 +282,7 @@ declare class Communication {
|
|
|
282
282
|
* @returns {Promise<Object>} - Success response
|
|
283
283
|
* @name getBigQueryHeadersById
|
|
284
284
|
* @summary: Get BigQuery headers
|
|
285
|
-
* @description: Retrieves header information from BigQuery. - Check out [method documentation](https://
|
|
285
|
+
* @description: Retrieves header information from BigQuery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getBigQueryHeadersById/).
|
|
286
286
|
*/
|
|
287
287
|
getBigQueryHeadersById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
288
288
|
/**
|
|
@@ -294,7 +294,7 @@ declare class Communication {
|
|
|
294
294
|
* @returns {Promise<Object>} - Success response
|
|
295
295
|
* @name getBigQueryRowCountById
|
|
296
296
|
* @summary: Get BigQuery row count
|
|
297
|
-
* @description: Retrieves big query row count by id - Check out [method documentation](https://
|
|
297
|
+
* @description: Retrieves big query row count by id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getBigQueryRowCountById/).
|
|
298
298
|
*/
|
|
299
299
|
getBigQueryRowCountById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
300
300
|
/**
|
|
@@ -306,7 +306,7 @@ declare class Communication {
|
|
|
306
306
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
307
307
|
* @name getCampaignById
|
|
308
308
|
* @summary: Get a campaign
|
|
309
|
-
* @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://
|
|
309
|
+
* @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaignById/).
|
|
310
310
|
*/
|
|
311
311
|
getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
312
312
|
/**
|
|
@@ -318,7 +318,7 @@ declare class Communication {
|
|
|
318
318
|
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
319
319
|
* @name getCampaigns
|
|
320
320
|
* @summary: Get all campaigns
|
|
321
|
-
* @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://
|
|
321
|
+
* @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaigns/).
|
|
322
322
|
*/
|
|
323
323
|
getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaigns>;
|
|
324
324
|
/**
|
|
@@ -330,7 +330,7 @@ declare class Communication {
|
|
|
330
330
|
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
331
331
|
* @name getCommunicationLogs
|
|
332
332
|
* @summary: Get communication reports
|
|
333
|
-
* @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://
|
|
333
|
+
* @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCommunicationLogs/).
|
|
334
334
|
*/
|
|
335
335
|
getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Logs>;
|
|
336
336
|
/**
|
|
@@ -343,7 +343,7 @@ declare class Communication {
|
|
|
343
343
|
* Success response
|
|
344
344
|
* @name getDefaultSmsProviders
|
|
345
345
|
* @summary: Get all default SMS providers
|
|
346
|
-
* @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://
|
|
346
|
+
* @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDefaultSmsProviders/).
|
|
347
347
|
*/
|
|
348
348
|
getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DefaultSmsProviders[]>;
|
|
349
349
|
/**
|
|
@@ -356,7 +356,7 @@ declare class Communication {
|
|
|
356
356
|
* Success response
|
|
357
357
|
* @name getDummyDatasources
|
|
358
358
|
* @summary: Get dummy data sources
|
|
359
|
-
* @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://
|
|
359
|
+
* @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasources/).
|
|
360
360
|
*/
|
|
361
361
|
getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasources[]>;
|
|
362
362
|
/**
|
|
@@ -369,7 +369,7 @@ declare class Communication {
|
|
|
369
369
|
* Success response
|
|
370
370
|
* @name getDummyDatasourcesMeta
|
|
371
371
|
* @summary: Get dummy data sources metadata
|
|
372
|
-
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://
|
|
372
|
+
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
373
373
|
*/
|
|
374
374
|
getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.DummyDatasourcesMeta>;
|
|
375
375
|
/**
|
|
@@ -381,7 +381,7 @@ declare class Communication {
|
|
|
381
381
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
382
382
|
* @name getEmailProviderById
|
|
383
383
|
* @summary: Get a email provider
|
|
384
|
-
* @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://
|
|
384
|
+
* @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviderById/).
|
|
385
385
|
*/
|
|
386
386
|
getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
387
387
|
/**
|
|
@@ -393,7 +393,7 @@ declare class Communication {
|
|
|
393
393
|
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
394
394
|
* @name getEmailProviders
|
|
395
395
|
* @summary: Get all email providers
|
|
396
|
-
* @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://
|
|
396
|
+
* @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviders/).
|
|
397
397
|
*/
|
|
398
398
|
getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProviders>;
|
|
399
399
|
/**
|
|
@@ -405,7 +405,7 @@ declare class Communication {
|
|
|
405
405
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
406
406
|
* @name getEmailTemplateById
|
|
407
407
|
* @summary: Get an email template
|
|
408
|
-
* @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://
|
|
408
|
+
* @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplateById/).
|
|
409
409
|
*/
|
|
410
410
|
getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
411
411
|
/**
|
|
@@ -417,7 +417,7 @@ declare class Communication {
|
|
|
417
417
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
418
418
|
* @name getEmailTemplates
|
|
419
419
|
* @summary: Get all email templates
|
|
420
|
-
* @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://
|
|
420
|
+
* @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplates/).
|
|
421
421
|
*/
|
|
422
422
|
getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
423
423
|
/**
|
|
@@ -430,7 +430,7 @@ declare class Communication {
|
|
|
430
430
|
* Success response
|
|
431
431
|
* @name getEventSubscriptions
|
|
432
432
|
* @summary: Get all event subscriptions
|
|
433
|
-
* @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://
|
|
433
|
+
* @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptions/).
|
|
434
434
|
*/
|
|
435
435
|
getEventSubscriptions({ pageNo, pageSize, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptions>;
|
|
436
436
|
/**
|
|
@@ -442,7 +442,7 @@ declare class Communication {
|
|
|
442
442
|
* @returns {Promise<CommunicationPlatformModel.EventSubscription>} - Success response
|
|
443
443
|
* @name getEventSubscriptionsById
|
|
444
444
|
* @summary: Get an event subscription
|
|
445
|
-
* @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://
|
|
445
|
+
* @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptionsById/).
|
|
446
446
|
*/
|
|
447
447
|
getEventSubscriptionsById({ id, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscription>;
|
|
448
448
|
/**
|
|
@@ -454,7 +454,7 @@ declare class Communication {
|
|
|
454
454
|
* @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
|
|
455
455
|
* @name getGlobalProviders
|
|
456
456
|
* @summary: Get global providers
|
|
457
|
-
* @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://
|
|
457
|
+
* @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalProviders/).
|
|
458
458
|
*/
|
|
459
459
|
getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GlobalProviders>;
|
|
460
460
|
/**
|
|
@@ -468,7 +468,7 @@ declare class Communication {
|
|
|
468
468
|
*
|
|
469
469
|
* @name getGlobalVariables
|
|
470
470
|
* @summary: Get all global variables
|
|
471
|
-
* @description: Retrieves a list of communication global variables. - Check out [method documentation](https://
|
|
471
|
+
* @description: Retrieves a list of communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalVariables/).
|
|
472
472
|
*/
|
|
473
473
|
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetGlobalVariablesResult>;
|
|
474
474
|
/**
|
|
@@ -478,7 +478,7 @@ declare class Communication {
|
|
|
478
478
|
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
479
479
|
* @name getJobLogs
|
|
480
480
|
* @summary: Get logs of all campaign job
|
|
481
|
-
* @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://
|
|
481
|
+
* @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobLogs/).
|
|
482
482
|
*/
|
|
483
483
|
getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.JobLogs>;
|
|
484
484
|
/**
|
|
@@ -488,7 +488,7 @@ declare class Communication {
|
|
|
488
488
|
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
489
489
|
* @name getJobs
|
|
490
490
|
* @summary: Get all campaign jobs
|
|
491
|
-
* @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://
|
|
491
|
+
* @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobs/).
|
|
492
492
|
*/
|
|
493
493
|
getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Jobs>;
|
|
494
494
|
/**
|
|
@@ -500,7 +500,7 @@ declare class Communication {
|
|
|
500
500
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
501
501
|
* @name getNSampleRecordsFromCsv
|
|
502
502
|
* @summary: Get N sample records of a CSV
|
|
503
|
-
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://
|
|
503
|
+
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsv/).
|
|
504
504
|
*/
|
|
505
505
|
getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
506
506
|
/**
|
|
@@ -512,7 +512,7 @@ declare class Communication {
|
|
|
512
512
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
513
513
|
* @name getNSampleRecordsFromCsvByGet
|
|
514
514
|
* @summary: Get N sample records of a CSV
|
|
515
|
-
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://
|
|
515
|
+
* @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsvByGet/).
|
|
516
516
|
*/
|
|
517
517
|
getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetNRecordsCsvRes>;
|
|
518
518
|
/**
|
|
@@ -524,7 +524,7 @@ declare class Communication {
|
|
|
524
524
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
525
525
|
* @name getOtpConfiguration
|
|
526
526
|
* @summary: Get configuration of otp
|
|
527
|
-
* @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://
|
|
527
|
+
* @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getOtpConfiguration/).
|
|
528
528
|
*/
|
|
529
529
|
getOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
530
530
|
/**
|
|
@@ -536,7 +536,7 @@ declare class Communication {
|
|
|
536
536
|
* @returns {Promise<Object>} - Success response
|
|
537
537
|
* @name getSmsProviderById
|
|
538
538
|
* @summary: Get a SMS provider
|
|
539
|
-
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://
|
|
539
|
+
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviderById/).
|
|
540
540
|
*/
|
|
541
541
|
getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
542
542
|
/**
|
|
@@ -548,7 +548,7 @@ declare class Communication {
|
|
|
548
548
|
* @returns {Promise<Object>} - Success response
|
|
549
549
|
* @name getSmsProviders
|
|
550
550
|
* @summary: Get all SMS providers
|
|
551
|
-
* @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://
|
|
551
|
+
* @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviders/).
|
|
552
552
|
*/
|
|
553
553
|
getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise<any>;
|
|
554
554
|
/**
|
|
@@ -560,7 +560,7 @@ declare class Communication {
|
|
|
560
560
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
561
561
|
* @name getSmsTemplateById
|
|
562
562
|
* @summary: Get a SMS template
|
|
563
|
-
* @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://
|
|
563
|
+
* @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplateById/).
|
|
564
564
|
*/
|
|
565
565
|
getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
566
566
|
/**
|
|
@@ -572,7 +572,7 @@ declare class Communication {
|
|
|
572
572
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
573
573
|
* @name getSmsTemplates
|
|
574
574
|
* @summary: Get all SMS templates
|
|
575
|
-
* @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://
|
|
575
|
+
* @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplates/).
|
|
576
576
|
*/
|
|
577
577
|
getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
578
578
|
/**
|
|
@@ -584,7 +584,7 @@ declare class Communication {
|
|
|
584
584
|
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
585
585
|
* @name getStatsOfCampaignById
|
|
586
586
|
* @summary: Get campaign statistics
|
|
587
|
-
* @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://
|
|
587
|
+
* @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getStatsOfCampaignById/).
|
|
588
588
|
*/
|
|
589
589
|
getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetStats>;
|
|
590
590
|
/**
|
|
@@ -596,7 +596,7 @@ declare class Communication {
|
|
|
596
596
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
597
597
|
* @name getSubscribedEmailTemplates
|
|
598
598
|
* @summary: Get all subscribed email templates
|
|
599
|
-
* @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://
|
|
599
|
+
* @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
600
600
|
*/
|
|
601
601
|
getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplates>;
|
|
602
602
|
/**
|
|
@@ -608,7 +608,7 @@ declare class Communication {
|
|
|
608
608
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
609
609
|
* @name getSubscribedSmsTemplates
|
|
610
610
|
* @summary: Get all subscribed SMS templates
|
|
611
|
-
* @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://
|
|
611
|
+
* @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
612
612
|
*/
|
|
613
613
|
getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplates>;
|
|
614
614
|
/**
|
|
@@ -620,7 +620,7 @@ declare class Communication {
|
|
|
620
620
|
* @returns {Promise<Object>} - Success response
|
|
621
621
|
* @name getSystemAudiences
|
|
622
622
|
* @summary: Get system audiences
|
|
623
|
-
* @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://
|
|
623
|
+
* @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemAudiences/).
|
|
624
624
|
*/
|
|
625
625
|
getSystemAudiences({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
626
626
|
/**
|
|
@@ -633,7 +633,7 @@ declare class Communication {
|
|
|
633
633
|
* Success response
|
|
634
634
|
* @name getSystemEmailTemplates
|
|
635
635
|
* @summary: Get all system email templates
|
|
636
|
-
* @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://
|
|
636
|
+
* @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemEmailTemplates/).
|
|
637
637
|
*/
|
|
638
638
|
getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemEmailTemplates>;
|
|
639
639
|
/**
|
|
@@ -646,7 +646,7 @@ declare class Communication {
|
|
|
646
646
|
* Success response
|
|
647
647
|
* @name getSystemSmsTemplates
|
|
648
648
|
* @summary: Gets all system SMS templates
|
|
649
|
-
* @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://
|
|
649
|
+
* @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemSmsTemplates/).
|
|
650
650
|
*/
|
|
651
651
|
getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemSmsTemplates>;
|
|
652
652
|
/**
|
|
@@ -660,7 +660,7 @@ declare class Communication {
|
|
|
660
660
|
*
|
|
661
661
|
* @name postGlobalVariables
|
|
662
662
|
* @summary: Create global variables
|
|
663
|
-
* @description: Updates and creates communication global variables. - Check out [method documentation](https://
|
|
663
|
+
* @description: Updates and creates communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/postGlobalVariables/).
|
|
664
664
|
*/
|
|
665
665
|
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>;
|
|
666
666
|
/**
|
|
@@ -672,7 +672,7 @@ declare class Communication {
|
|
|
672
672
|
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
673
673
|
* @name sendCommunicationAsynchronously
|
|
674
674
|
* @summary: Send communication asynchronously
|
|
675
|
-
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://
|
|
675
|
+
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
676
676
|
*/
|
|
677
677
|
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
678
678
|
/**
|
|
@@ -684,7 +684,7 @@ declare class Communication {
|
|
|
684
684
|
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
685
685
|
* @name sendCommunicationSynchronously
|
|
686
686
|
* @summary: Send communication synchronously
|
|
687
|
-
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://
|
|
687
|
+
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
688
688
|
*/
|
|
689
689
|
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
690
690
|
/**
|
|
@@ -694,7 +694,7 @@ declare class Communication {
|
|
|
694
694
|
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
695
695
|
* @name sendOtp
|
|
696
696
|
* @summary: Send OTP
|
|
697
|
-
* @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://
|
|
697
|
+
* @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendOtp/).
|
|
698
698
|
*/
|
|
699
699
|
sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SendOtpCommsRes>;
|
|
700
700
|
/**
|
|
@@ -706,7 +706,7 @@ declare class Communication {
|
|
|
706
706
|
* @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
|
|
707
707
|
* @name triggerCampaignJob
|
|
708
708
|
* @summary: Trigger a campaign job
|
|
709
|
-
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://
|
|
709
|
+
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/triggerCampaignJob/).
|
|
710
710
|
*/
|
|
711
711
|
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResult>;
|
|
712
712
|
/**
|
|
@@ -718,7 +718,7 @@ declare class Communication {
|
|
|
718
718
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
719
719
|
* @name updateAppProviders
|
|
720
720
|
* @summary: Update application providers
|
|
721
|
-
* @description: Modify provider configuration using provider object id . - Check out [method documentation](https://
|
|
721
|
+
* @description: Modify provider configuration using provider object id . - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAppProviders/).
|
|
722
722
|
*/
|
|
723
723
|
updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.AppProvider>;
|
|
724
724
|
/**
|
|
@@ -730,7 +730,7 @@ declare class Communication {
|
|
|
730
730
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
731
731
|
* @name updateAudienceById
|
|
732
732
|
* @summary: Update an audience
|
|
733
|
-
* @description: Modify the configuration of a specific audience. - Check out [method documentation](https://
|
|
733
|
+
* @description: Modify the configuration of a specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAudienceById/).
|
|
734
734
|
*/
|
|
735
735
|
updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Audience>;
|
|
736
736
|
/**
|
|
@@ -742,7 +742,7 @@ declare class Communication {
|
|
|
742
742
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
743
743
|
* @name updateCampaignById
|
|
744
744
|
* @summary: Update a campaign
|
|
745
|
-
* @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://
|
|
745
|
+
* @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateCampaignById/).
|
|
746
746
|
*/
|
|
747
747
|
updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.Campaign>;
|
|
748
748
|
/**
|
|
@@ -754,7 +754,7 @@ declare class Communication {
|
|
|
754
754
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
755
755
|
* @name updateEmailProviderById
|
|
756
756
|
* @summary: Update email provider
|
|
757
|
-
* @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://
|
|
757
|
+
* @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailProviderById/).
|
|
758
758
|
*/
|
|
759
759
|
updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailProvider>;
|
|
760
760
|
/**
|
|
@@ -766,7 +766,7 @@ declare class Communication {
|
|
|
766
766
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
767
767
|
* @name updateEmailTemplateById
|
|
768
768
|
* @summary: Update an email template
|
|
769
|
-
* @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://
|
|
769
|
+
* @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailTemplateById/).
|
|
770
770
|
*/
|
|
771
771
|
updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EmailTemplate>;
|
|
772
772
|
/**
|
|
@@ -778,7 +778,7 @@ declare class Communication {
|
|
|
778
778
|
* @returns {Promise<CommunicationPlatformModel.OtpConfiguration>} - Success response
|
|
779
779
|
* @name updateOtpConfiguration
|
|
780
780
|
* @summary: Update configuration of otp
|
|
781
|
-
* @description: Updates all configurations related to OTP. - Check out [method documentation](https://
|
|
781
|
+
* @description: Updates all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateOtpConfiguration/).
|
|
782
782
|
*/
|
|
783
783
|
updateOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.OtpConfiguration>;
|
|
784
784
|
/**
|
|
@@ -790,7 +790,7 @@ declare class Communication {
|
|
|
790
790
|
* @returns {Promise<Object>} - Success response
|
|
791
791
|
* @name updateSmsProviderById
|
|
792
792
|
* @summary: Update SMS provider
|
|
793
|
-
* @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://
|
|
793
|
+
* @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsProviderById/).
|
|
794
794
|
*/
|
|
795
795
|
updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
796
796
|
/**
|
|
@@ -802,7 +802,7 @@ declare class Communication {
|
|
|
802
802
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
803
803
|
* @name updateSmsTemplateById
|
|
804
804
|
* @summary: Update a SMS template
|
|
805
|
-
* @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://
|
|
805
|
+
* @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsTemplateById/).
|
|
806
806
|
*/
|
|
807
807
|
updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SmsTemplate>;
|
|
808
808
|
/**
|
|
@@ -814,7 +814,7 @@ declare class Communication {
|
|
|
814
814
|
*
|
|
815
815
|
* @name verfiyOtp
|
|
816
816
|
* @summary: Verify OTP
|
|
817
|
-
* @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://
|
|
817
|
+
* @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/verfiyOtp/).
|
|
818
818
|
*/
|
|
819
819
|
verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.VerifyOtpCommsSuccessRes>;
|
|
820
820
|
}
|