@gofynd/fdk-client-javascript 1.4.2-beta.6 → 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 +13 -13
- package/sdk/application/Order/OrderApplicationClient.js +16 -12
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
- package/sdk/application/Order/OrderApplicationValidator.js +3 -0
- 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 +33 -19
- 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/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.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 +43 -43
- package/sdk/platform/Order/OrderPlatformClient.js +55 -44
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
- 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 +5 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
- 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
|
@@ -23,7 +23,7 @@ class Communication {
|
|
|
23
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
24
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
25
25
|
* @name createAudience
|
|
26
|
-
* @summary: Create audience
|
|
26
|
+
* @summary: Create audience
|
|
27
27
|
* @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/).
|
|
28
28
|
*/
|
|
29
29
|
async createAudience(
|
|
@@ -104,7 +104,7 @@ class Communication {
|
|
|
104
104
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
105
105
|
* @returns {Promise<Object>} - Success response
|
|
106
106
|
* @name createBigQueryHeaders
|
|
107
|
-
* @summary: Create BigQuery headers
|
|
107
|
+
* @summary: Create BigQuery headers
|
|
108
108
|
* @description: Create big query headers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryHeaders/).
|
|
109
109
|
*/
|
|
110
110
|
async createBigQueryHeaders(
|
|
@@ -179,7 +179,7 @@ class Communication {
|
|
|
179
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
180
|
* @returns {Promise<Object>} - Success response
|
|
181
181
|
* @name createBigQueryNCount
|
|
182
|
-
* @summary: Create BigQuery N-count
|
|
182
|
+
* @summary: Create BigQuery N-count
|
|
183
183
|
* @description: Create big query n count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryNCount/).
|
|
184
184
|
*/
|
|
185
185
|
async createBigQueryNCount(
|
|
@@ -254,7 +254,7 @@ class Communication {
|
|
|
254
254
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
255
255
|
* @returns {Promise<Object>} - Success response
|
|
256
256
|
* @name createBigQueryRowCount
|
|
257
|
-
* @summary: Create BigQuery row count
|
|
257
|
+
* @summary: Create BigQuery row count
|
|
258
258
|
* @description: Create big query row count - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createBigQueryRowCount/).
|
|
259
259
|
*/
|
|
260
260
|
async createBigQueryRowCount(
|
|
@@ -329,7 +329,7 @@ class Communication {
|
|
|
329
329
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
330
330
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
331
331
|
* @name createCampaign
|
|
332
|
-
* @summary: Create campaign
|
|
332
|
+
* @summary: Create campaign
|
|
333
333
|
* @description: Add a new communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createCampaign/).
|
|
334
334
|
*/
|
|
335
335
|
async createCampaign(
|
|
@@ -410,7 +410,7 @@ class Communication {
|
|
|
410
410
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
411
411
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
412
412
|
* @name createEmailProvider
|
|
413
|
-
* @summary: Create email provider
|
|
413
|
+
* @summary: Create email provider
|
|
414
414
|
* @description: Generate and add a new email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailProvider/).
|
|
415
415
|
*/
|
|
416
416
|
async createEmailProvider(
|
|
@@ -491,7 +491,7 @@ class Communication {
|
|
|
491
491
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
492
492
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
493
493
|
* @name createEmailTemplate
|
|
494
|
-
* @summary: Create email template
|
|
494
|
+
* @summary: Create email template
|
|
495
495
|
* @description: Generate and add a new email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEmailTemplate/).
|
|
496
496
|
*/
|
|
497
497
|
async createEmailTemplate(
|
|
@@ -816,7 +816,7 @@ class Communication {
|
|
|
816
816
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
817
817
|
* @returns {Promise<Object>} - Success response
|
|
818
818
|
* @name createSmsProvider
|
|
819
|
-
* @summary: Create SMS provider
|
|
819
|
+
* @summary: Create SMS provider
|
|
820
820
|
* @description: Add a new SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsProvider/).
|
|
821
821
|
*/
|
|
822
822
|
async createSmsProvider(
|
|
@@ -895,7 +895,7 @@ class Communication {
|
|
|
895
895
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
896
896
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
897
897
|
* @name createSmsTemplate
|
|
898
|
-
* @summary: Create SMS template
|
|
898
|
+
* @summary: Create SMS template
|
|
899
899
|
* @description: Add a new SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createSmsTemplate/).
|
|
900
900
|
*/
|
|
901
901
|
async createSmsTemplate(
|
|
@@ -976,7 +976,7 @@ class Communication {
|
|
|
976
976
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
977
977
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
978
978
|
* @name deleteAudienceById
|
|
979
|
-
* @summary: Delete audience by ID
|
|
979
|
+
* @summary: Delete audience by ID
|
|
980
980
|
* @description: Remove a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteAudienceById/).
|
|
981
981
|
*/
|
|
982
982
|
async deleteAudienceById(
|
|
@@ -1059,7 +1059,7 @@ class Communication {
|
|
|
1059
1059
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1060
1060
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1061
1061
|
* @name deleteEmailProviderById
|
|
1062
|
-
* @summary: Delete email provider by ID
|
|
1062
|
+
* @summary: Delete email provider by ID
|
|
1063
1063
|
* @description: Remove a specific email communication provider from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteEmailProviderById/).
|
|
1064
1064
|
*/
|
|
1065
1065
|
async deleteEmailProviderById(
|
|
@@ -1140,7 +1140,7 @@ class Communication {
|
|
|
1140
1140
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1141
1141
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1142
1142
|
* @name deleteEmailTemplateById
|
|
1143
|
-
* @summary: Delete email template by ID
|
|
1143
|
+
* @summary: Delete email template by ID
|
|
1144
1144
|
* @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/).
|
|
1145
1145
|
*/
|
|
1146
1146
|
async deleteEmailTemplateById(
|
|
@@ -1302,7 +1302,7 @@ class Communication {
|
|
|
1302
1302
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1303
1303
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1304
1304
|
* @name deleteSmsProviderById
|
|
1305
|
-
* @summary: Delete SMS provider by ID
|
|
1305
|
+
* @summary: Delete SMS provider by ID
|
|
1306
1306
|
* @description: Remove a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsProviderById/).
|
|
1307
1307
|
*/
|
|
1308
1308
|
async deleteSmsProviderById(
|
|
@@ -1383,7 +1383,7 @@ class Communication {
|
|
|
1383
1383
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1384
1384
|
* @returns {Promise<CommunicationPlatformModel.GenericDelete>} - Success response
|
|
1385
1385
|
* @name deleteSmsTemplateById
|
|
1386
|
-
* @summary: Delete SMS template by ID
|
|
1386
|
+
* @summary: Delete SMS template by ID
|
|
1387
1387
|
* @description: Remove a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/deleteSmsTemplateById/).
|
|
1388
1388
|
*/
|
|
1389
1389
|
async deleteSmsTemplateById(
|
|
@@ -1549,7 +1549,7 @@ class Communication {
|
|
|
1549
1549
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1550
1550
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
1551
1551
|
* @name getAppProviders
|
|
1552
|
-
* @summary: Get application providers
|
|
1552
|
+
* @summary: Get application providers
|
|
1553
1553
|
* @description: Retrieve a list of providers associated with the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAppProviders/).
|
|
1554
1554
|
*/
|
|
1555
1555
|
async getAppProviders(
|
|
@@ -1626,7 +1626,7 @@ class Communication {
|
|
|
1626
1626
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1627
1627
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
1628
1628
|
* @name getAudienceById
|
|
1629
|
-
* @summary: Get audience by ID
|
|
1629
|
+
* @summary: Get audience by ID
|
|
1630
1630
|
* @description: Retrieve detailed information about a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getAudienceById/).
|
|
1631
1631
|
*/
|
|
1632
1632
|
async getAudienceById(
|
|
@@ -1707,7 +1707,7 @@ class Communication {
|
|
|
1707
1707
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1708
1708
|
* @returns {Promise<CommunicationPlatformModel.Audiences>} - Success response
|
|
1709
1709
|
* @name getAudiences
|
|
1710
|
-
* @summary: Get audiences
|
|
1710
|
+
* @summary: Get audiences
|
|
1711
1711
|
* @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/).
|
|
1712
1712
|
*/
|
|
1713
1713
|
async getAudiences(
|
|
@@ -1798,7 +1798,7 @@ class Communication {
|
|
|
1798
1798
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1799
1799
|
* @returns {Promise<Object>} - Success response
|
|
1800
1800
|
* @name getBigQueryHeadersById
|
|
1801
|
-
* @summary: Get BigQuery headers by ID
|
|
1801
|
+
* @summary: Get BigQuery headers by ID
|
|
1802
1802
|
* @description: Retrieve header information from BigQuery for a specific campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryHeadersById/).
|
|
1803
1803
|
*/
|
|
1804
1804
|
async getBigQueryHeadersById(
|
|
@@ -1877,7 +1877,7 @@ class Communication {
|
|
|
1877
1877
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1878
1878
|
* @returns {Promise<Object>} - Success response
|
|
1879
1879
|
* @name getBigQueryRowCountById
|
|
1880
|
-
* @summary: Get BigQuery row count by ID
|
|
1880
|
+
* @summary: Get BigQuery row count by ID
|
|
1881
1881
|
* @description: Retrieve big query row count by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getBigQueryRowCountById/).
|
|
1882
1882
|
*/
|
|
1883
1883
|
async getBigQueryRowCountById(
|
|
@@ -1956,7 +1956,7 @@ class Communication {
|
|
|
1956
1956
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1957
1957
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
1958
1958
|
* @name getCampaignById
|
|
1959
|
-
* @summary: Get campaign by ID
|
|
1959
|
+
* @summary: Get campaign by ID
|
|
1960
1960
|
* @description: Retrieve detailed information about a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaignById/).
|
|
1961
1961
|
*/
|
|
1962
1962
|
async getCampaignById(
|
|
@@ -2037,7 +2037,7 @@ class Communication {
|
|
|
2037
2037
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2038
2038
|
* @returns {Promise<CommunicationPlatformModel.Campaigns>} - Success response
|
|
2039
2039
|
* @name getCampaigns
|
|
2040
|
-
* @summary: Get campaigns
|
|
2040
|
+
* @summary: Get campaigns
|
|
2041
2041
|
* @description: Retrieve a list of communication campaigns. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCampaigns/).
|
|
2042
2042
|
*/
|
|
2043
2043
|
async getCampaigns(
|
|
@@ -2128,7 +2128,7 @@ class Communication {
|
|
|
2128
2128
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2129
2129
|
* @returns {Promise<CommunicationPlatformModel.Logs>} - Success response
|
|
2130
2130
|
* @name getCommunicationLogs
|
|
2131
|
-
* @summary: Get communication logs
|
|
2131
|
+
* @summary: Get communication logs
|
|
2132
2132
|
* @description: Retrieve logs and records of communication activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getCommunicationLogs/).
|
|
2133
2133
|
*/
|
|
2134
2134
|
async getCommunicationLogs(
|
|
@@ -2220,7 +2220,7 @@ class Communication {
|
|
|
2220
2220
|
* @returns {Promise<CommunicationPlatformModel.DefaultSmsProviders[]>} -
|
|
2221
2221
|
* Success response
|
|
2222
2222
|
* @name getDefaultSmsProviders
|
|
2223
|
-
* @summary: Get default SMS providers
|
|
2223
|
+
* @summary: Get default SMS providers
|
|
2224
2224
|
* @description: Retrieve the default SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDefaultSmsProviders/).
|
|
2225
2225
|
*/
|
|
2226
2226
|
async getDefaultSmsProviders(
|
|
@@ -2295,7 +2295,7 @@ class Communication {
|
|
|
2295
2295
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasources[]>} -
|
|
2296
2296
|
* Success response
|
|
2297
2297
|
* @name getDummyDatasources
|
|
2298
|
-
* @summary: Get dummy data sources
|
|
2298
|
+
* @summary: Get dummy data sources
|
|
2299
2299
|
* @description: Retrieve a list of dummy data sources for testing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasources/).
|
|
2300
2300
|
*/
|
|
2301
2301
|
async getDummyDatasources(
|
|
@@ -2370,7 +2370,7 @@ class Communication {
|
|
|
2370
2370
|
* @returns {Promise<CommunicationPlatformModel.DummyDatasourcesMeta>} -
|
|
2371
2371
|
* Success response
|
|
2372
2372
|
* @name getDummyDatasourcesMeta
|
|
2373
|
-
* @summary: Get dummy data sources metadata
|
|
2373
|
+
* @summary: Get dummy data sources metadata
|
|
2374
2374
|
* @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getDummyDatasourcesMeta/).
|
|
2375
2375
|
*/
|
|
2376
2376
|
async getDummyDatasourcesMeta(
|
|
@@ -2451,7 +2451,7 @@ class Communication {
|
|
|
2451
2451
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2452
2452
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
2453
2453
|
* @name getEmailProviderById
|
|
2454
|
-
* @summary: Get email provider by ID
|
|
2454
|
+
* @summary: Get email provider by ID
|
|
2455
2455
|
* @description: Retrieve detailed information about a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviderById/).
|
|
2456
2456
|
*/
|
|
2457
2457
|
async getEmailProviderById(
|
|
@@ -2532,7 +2532,7 @@ class Communication {
|
|
|
2532
2532
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2533
2533
|
* @returns {Promise<CommunicationPlatformModel.EmailProviders>} - Success response
|
|
2534
2534
|
* @name getEmailProviders
|
|
2535
|
-
* @summary: Get email providers
|
|
2535
|
+
* @summary: Get email providers
|
|
2536
2536
|
* @description: Retrieve a list of email communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailProviders/).
|
|
2537
2537
|
*/
|
|
2538
2538
|
async getEmailProviders(
|
|
@@ -2623,7 +2623,7 @@ class Communication {
|
|
|
2623
2623
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2624
2624
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
2625
2625
|
* @name getEmailTemplateById
|
|
2626
|
-
* @summary: Get email template by ID
|
|
2626
|
+
* @summary: Get email template by ID
|
|
2627
2627
|
* @description: Retrieve detailed information about a specific email communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplateById/).
|
|
2628
2628
|
*/
|
|
2629
2629
|
async getEmailTemplateById(
|
|
@@ -2704,7 +2704,7 @@ class Communication {
|
|
|
2704
2704
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2705
2705
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
2706
2706
|
* @name getEmailTemplates
|
|
2707
|
-
* @summary: Get email templates
|
|
2707
|
+
* @summary: Get email templates
|
|
2708
2708
|
* @description: Retrieve a list of available email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEmailTemplates/).
|
|
2709
2709
|
*/
|
|
2710
2710
|
async getEmailTemplates(
|
|
@@ -2796,7 +2796,7 @@ class Communication {
|
|
|
2796
2796
|
* @returns {Promise<CommunicationPlatformModel.EventSubscriptions>} -
|
|
2797
2797
|
* Success response
|
|
2798
2798
|
* @name getEventSubscriptions
|
|
2799
|
-
* @summary: Get event subscriptions
|
|
2799
|
+
* @summary: Get event subscriptions
|
|
2800
2800
|
* @description: Retrieve a list of event subscriptions related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getEventSubscriptions/).
|
|
2801
2801
|
*/
|
|
2802
2802
|
async getEventSubscriptions(
|
|
@@ -2968,7 +2968,7 @@ class Communication {
|
|
|
2968
2968
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2969
2969
|
* @returns {Promise<CommunicationPlatformModel.GlobalProviders>} - Success response
|
|
2970
2970
|
* @name getGlobalProviders
|
|
2971
|
-
* @summary: Get global providers
|
|
2971
|
+
* @summary: Get global providers
|
|
2972
2972
|
* @description: Retrieve a list of global communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalProviders/).
|
|
2973
2973
|
*/
|
|
2974
2974
|
async getGlobalProviders(
|
|
@@ -3047,7 +3047,7 @@ class Communication {
|
|
|
3047
3047
|
* - Success response
|
|
3048
3048
|
*
|
|
3049
3049
|
* @name getGlobalVariables
|
|
3050
|
-
* @summary: Get global variables
|
|
3050
|
+
* @summary: Get global variables
|
|
3051
3051
|
* @description: Retrieve global variables used in communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
|
|
3052
3052
|
*/
|
|
3053
3053
|
async getGlobalVariables(
|
|
@@ -3122,7 +3122,7 @@ class Communication {
|
|
|
3122
3122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3123
3123
|
* @returns {Promise<CommunicationPlatformModel.JobLogs>} - Success response
|
|
3124
3124
|
* @name getJobLogs
|
|
3125
|
-
* @summary: Get job logs
|
|
3125
|
+
* @summary: Get job logs
|
|
3126
3126
|
* @description: Retrieve logs and details related to communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobLogs/).
|
|
3127
3127
|
*/
|
|
3128
3128
|
async getJobLogs(
|
|
@@ -3211,7 +3211,7 @@ class Communication {
|
|
|
3211
3211
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3212
3212
|
* @returns {Promise<CommunicationPlatformModel.Jobs>} - Success response
|
|
3213
3213
|
* @name getJobs
|
|
3214
|
-
* @summary: Get jobs
|
|
3214
|
+
* @summary: Get jobs
|
|
3215
3215
|
* @description: Retrieve a list of communication jobs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getJobs/).
|
|
3216
3216
|
*/
|
|
3217
3217
|
async getJobs(
|
|
@@ -3302,7 +3302,7 @@ class Communication {
|
|
|
3302
3302
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3303
3303
|
* @returns {Promise<CommunicationPlatformModel.GetNRecordsCsvRes>} - Success response
|
|
3304
3304
|
* @name getNSampleRecordsFromCsv
|
|
3305
|
-
* @summary: Get N sample records from CSV
|
|
3305
|
+
* @summary: Get N sample records from CSV
|
|
3306
3306
|
* @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/).
|
|
3307
3307
|
*/
|
|
3308
3308
|
async getNSampleRecordsFromCsv(
|
|
@@ -3537,7 +3537,7 @@ class Communication {
|
|
|
3537
3537
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3538
3538
|
* @returns {Promise<Object>} - Success response
|
|
3539
3539
|
* @name getSmsProviderById
|
|
3540
|
-
* @summary: Get SMS provider by ID
|
|
3540
|
+
* @summary: Get SMS provider by ID
|
|
3541
3541
|
* @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviderById/).
|
|
3542
3542
|
*/
|
|
3543
3543
|
async getSmsProviderById(
|
|
@@ -3616,7 +3616,7 @@ class Communication {
|
|
|
3616
3616
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3617
3617
|
* @returns {Promise<Object>} - Success response
|
|
3618
3618
|
* @name getSmsProviders
|
|
3619
|
-
* @summary: Get SMS providers
|
|
3619
|
+
* @summary: Get SMS providers
|
|
3620
3620
|
* @description: Retrieve a list of SMS communication providers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsProviders/).
|
|
3621
3621
|
*/
|
|
3622
3622
|
async getSmsProviders(
|
|
@@ -3705,7 +3705,7 @@ class Communication {
|
|
|
3705
3705
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3706
3706
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
3707
3707
|
* @name getSmsTemplateById
|
|
3708
|
-
* @summary: Get SMS template by ID
|
|
3708
|
+
* @summary: Get SMS template by ID
|
|
3709
3709
|
* @description: Retrieve detailed information about a specific SMS communication template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplateById/).
|
|
3710
3710
|
*/
|
|
3711
3711
|
async getSmsTemplateById(
|
|
@@ -3786,7 +3786,7 @@ class Communication {
|
|
|
3786
3786
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3787
3787
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
3788
3788
|
* @name getSmsTemplates
|
|
3789
|
-
* @summary: Get SMS templates
|
|
3789
|
+
* @summary: Get SMS templates
|
|
3790
3790
|
* @description: Retrieve a list of available SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSmsTemplates/).
|
|
3791
3791
|
*/
|
|
3792
3792
|
async getSmsTemplates(
|
|
@@ -3877,7 +3877,7 @@ class Communication {
|
|
|
3877
3877
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3878
3878
|
* @returns {Promise<CommunicationPlatformModel.GetStats>} - Success response
|
|
3879
3879
|
* @name getStatsOfCampaignById
|
|
3880
|
-
* @summary: Get campaign statistics by ID
|
|
3880
|
+
* @summary: Get campaign statistics by ID
|
|
3881
3881
|
* @description: Retrieve statistical data for a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getStatsOfCampaignById/).
|
|
3882
3882
|
*/
|
|
3883
3883
|
async getStatsOfCampaignById(
|
|
@@ -3958,7 +3958,7 @@ class Communication {
|
|
|
3958
3958
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3959
3959
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplates>} - Success response
|
|
3960
3960
|
* @name getSubscribedEmailTemplates
|
|
3961
|
-
* @summary: Get subscribed email templates
|
|
3961
|
+
* @summary: Get subscribed email templates
|
|
3962
3962
|
* @description: Retrieve email communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedEmailTemplates/).
|
|
3963
3963
|
*/
|
|
3964
3964
|
async getSubscribedEmailTemplates(
|
|
@@ -4046,7 +4046,7 @@ class Communication {
|
|
|
4046
4046
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4047
4047
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplates>} - Success response
|
|
4048
4048
|
* @name getSubscribedSmsTemplates
|
|
4049
|
-
* @summary: Get subscribed SMS templates
|
|
4049
|
+
* @summary: Get subscribed SMS templates
|
|
4050
4050
|
* @description: Retrieve SMS communication templates that are subscribed to. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSubscribedSmsTemplates/).
|
|
4051
4051
|
*/
|
|
4052
4052
|
async getSubscribedSmsTemplates(
|
|
@@ -4134,7 +4134,7 @@ class Communication {
|
|
|
4134
4134
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4135
4135
|
* @returns {Promise<Object>} - Success response
|
|
4136
4136
|
* @name getSystemAudiences
|
|
4137
|
-
* @summary: Get system audiences
|
|
4137
|
+
* @summary: Get system audiences
|
|
4138
4138
|
* @description: Retrieve system-defined audiences for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemAudiences/).
|
|
4139
4139
|
*/
|
|
4140
4140
|
async getSystemAudiences(
|
|
@@ -4210,7 +4210,7 @@ class Communication {
|
|
|
4210
4210
|
* @returns {Promise<CommunicationPlatformModel.SystemEmailTemplates>} -
|
|
4211
4211
|
* Success response
|
|
4212
4212
|
* @name getSystemEmailTemplates
|
|
4213
|
-
* @summary: Get system email templates
|
|
4213
|
+
* @summary: Get system email templates
|
|
4214
4214
|
* @description: Retrieve system-defined email communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemEmailTemplates/).
|
|
4215
4215
|
*/
|
|
4216
4216
|
async getSystemEmailTemplates(
|
|
@@ -4288,7 +4288,7 @@ class Communication {
|
|
|
4288
4288
|
* @returns {Promise<CommunicationPlatformModel.SystemSmsTemplates[]>} -
|
|
4289
4289
|
* Success response
|
|
4290
4290
|
* @name getSystemSmsTemplates
|
|
4291
|
-
* @summary: Get system SMS templates
|
|
4291
|
+
* @summary: Get system SMS templates
|
|
4292
4292
|
* @description: Retrieve system-defined SMS communication templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemSmsTemplates/).
|
|
4293
4293
|
*/
|
|
4294
4294
|
async getSystemSmsTemplates(
|
|
@@ -4364,7 +4364,7 @@ class Communication {
|
|
|
4364
4364
|
* - Success response
|
|
4365
4365
|
*
|
|
4366
4366
|
* @name postGlobalVariables
|
|
4367
|
-
* @summary: Post global variables
|
|
4367
|
+
* @summary: Post global variables
|
|
4368
4368
|
* @description: Update and post global variables for communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
|
|
4369
4369
|
*/
|
|
4370
4370
|
async postGlobalVariables(
|
|
@@ -4445,7 +4445,7 @@ class Communication {
|
|
|
4445
4445
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4446
4446
|
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
4447
4447
|
* @name sendCommunicationAsynchronously
|
|
4448
|
-
* @summary: Send communication asynchronously
|
|
4448
|
+
* @summary: Send communication asynchronously
|
|
4449
4449
|
* @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/).
|
|
4450
4450
|
*/
|
|
4451
4451
|
async sendCommunicationAsynchronously(
|
|
@@ -4526,7 +4526,7 @@ class Communication {
|
|
|
4526
4526
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4527
4527
|
* @returns {Promise<CommunicationPlatformModel.EngineResponse>} - Success response
|
|
4528
4528
|
* @name sendCommunicationSynchronously
|
|
4529
|
-
* @summary: Send communication synchronously
|
|
4529
|
+
* @summary: Send communication synchronously
|
|
4530
4530
|
* @description: Initiate and send communication in real-time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
4531
4531
|
*/
|
|
4532
4532
|
async sendCommunicationSynchronously(
|
|
@@ -4605,7 +4605,7 @@ class Communication {
|
|
|
4605
4605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4606
4606
|
* @returns {Promise<CommunicationPlatformModel.SendOtpCommsRes>} - Success response
|
|
4607
4607
|
* @name sendOtp
|
|
4608
|
-
* @summary: Send OTP
|
|
4608
|
+
* @summary: Send OTP
|
|
4609
4609
|
* @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/).
|
|
4610
4610
|
*/
|
|
4611
4611
|
async sendOtp(
|
|
@@ -4687,7 +4687,7 @@ class Communication {
|
|
|
4687
4687
|
* @returns {Promise<CommunicationPlatformModel.TriggerJobResponse>} -
|
|
4688
4688
|
* Success response
|
|
4689
4689
|
* @name triggerCampaignJob
|
|
4690
|
-
* @summary: Trigger campaign job
|
|
4690
|
+
* @summary: Trigger campaign job
|
|
4691
4691
|
* @description: Initiate a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
|
|
4692
4692
|
*/
|
|
4693
4693
|
async triggerCampaignJob(
|
|
@@ -4768,7 +4768,7 @@ class Communication {
|
|
|
4768
4768
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4769
4769
|
* @returns {Promise<CommunicationPlatformModel.AppProvider>} - Success response
|
|
4770
4770
|
* @name updateAppProviders
|
|
4771
|
-
* @summary: Update application providers
|
|
4771
|
+
* @summary: Update application providers
|
|
4772
4772
|
* @description: Modify provider information for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAppProviders/).
|
|
4773
4773
|
*/
|
|
4774
4774
|
async updateAppProviders(
|
|
@@ -4849,7 +4849,7 @@ class Communication {
|
|
|
4849
4849
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4850
4850
|
* @returns {Promise<CommunicationPlatformModel.Audience>} - Success response
|
|
4851
4851
|
* @name updateAudienceById
|
|
4852
|
-
* @summary: Update audience by ID
|
|
4852
|
+
* @summary: Update audience by ID
|
|
4853
4853
|
* @description: Modify the settings of a specific custom communication audience. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateAudienceById/).
|
|
4854
4854
|
*/
|
|
4855
4855
|
async updateAudienceById(
|
|
@@ -4932,7 +4932,7 @@ class Communication {
|
|
|
4932
4932
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4933
4933
|
* @returns {Promise<CommunicationPlatformModel.Campaign>} - Success response
|
|
4934
4934
|
* @name updateCampaignById
|
|
4935
|
-
* @summary: Update campaign by ID
|
|
4935
|
+
* @summary: Update campaign by ID
|
|
4936
4936
|
* @description: Modify the settings of a specific communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateCampaignById/).
|
|
4937
4937
|
*/
|
|
4938
4938
|
async updateCampaignById(
|
|
@@ -5015,7 +5015,7 @@ class Communication {
|
|
|
5015
5015
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5016
5016
|
* @returns {Promise<CommunicationPlatformModel.EmailProvider>} - Success response
|
|
5017
5017
|
* @name updateEmailProviderById
|
|
5018
|
-
* @summary: Update email provider by ID
|
|
5018
|
+
* @summary: Update email provider by ID
|
|
5019
5019
|
* @description: Modify the settings of a specific email communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateEmailProviderById/).
|
|
5020
5020
|
*/
|
|
5021
5021
|
async updateEmailProviderById(
|
|
@@ -5098,7 +5098,7 @@ class Communication {
|
|
|
5098
5098
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5099
5099
|
* @returns {Promise<CommunicationPlatformModel.EmailTemplate>} - Success response
|
|
5100
5100
|
* @name updateEmailTemplateById
|
|
5101
|
-
* @summary: Update email template by ID
|
|
5101
|
+
* @summary: Update email template by ID
|
|
5102
5102
|
* @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/).
|
|
5103
5103
|
*/
|
|
5104
5104
|
async updateEmailTemplateById(
|
|
@@ -5258,7 +5258,7 @@ class Communication {
|
|
|
5258
5258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5259
5259
|
* @returns {Promise<Object>} - Success response
|
|
5260
5260
|
* @name updateSmsProviderById
|
|
5261
|
-
* @summary: Update SMS provider by ID
|
|
5261
|
+
* @summary: Update SMS provider by ID
|
|
5262
5262
|
* @description: Modify specific SMS communication provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/updateSmsProviderById/).
|
|
5263
5263
|
*/
|
|
5264
5264
|
async updateSmsProviderById(
|
|
@@ -5339,7 +5339,7 @@ class Communication {
|
|
|
5339
5339
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5340
5340
|
* @returns {Promise<CommunicationPlatformModel.SmsTemplate>} - Success response
|
|
5341
5341
|
* @name updateSmsTemplateById
|
|
5342
|
-
* @summary: Update SMS template by ID
|
|
5342
|
+
* @summary: Update SMS template by ID
|
|
5343
5343
|
* @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/).
|
|
5344
5344
|
*/
|
|
5345
5345
|
async updateSmsTemplateById(
|
|
@@ -5422,7 +5422,7 @@ class Communication {
|
|
|
5422
5422
|
* - Success response
|
|
5423
5423
|
*
|
|
5424
5424
|
* @name verfiyOtp
|
|
5425
|
-
* @summary: Verify OTP
|
|
5425
|
+
* @summary: Verify OTP
|
|
5426
5426
|
* @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/).
|
|
5427
5427
|
*/
|
|
5428
5428
|
async verfiyOtp(
|
|
@@ -11,7 +11,7 @@ declare class Communication {
|
|
|
11
11
|
* @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
|
|
12
12
|
* Success response
|
|
13
13
|
* @name getSystemNotifications
|
|
14
|
-
* @summary: Get system notifications
|
|
14
|
+
* @summary: Get system notifications
|
|
15
15
|
* @description: Retrieve system notifications related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
|
|
16
16
|
*/
|
|
17
17
|
getSystemNotifications({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemNotifications>;
|
|
@@ -23,7 +23,7 @@ class Communication {
|
|
|
23
23
|
* @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
|
|
24
24
|
* Success response
|
|
25
25
|
* @name getSystemNotifications
|
|
26
|
-
* @summary: Get system notifications
|
|
26
|
+
* @summary: Get system notifications
|
|
27
27
|
* @description: Retrieve system notifications related to communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
|
|
28
28
|
*/
|
|
29
29
|
async getSystemNotifications(
|
|
@@ -642,6 +642,7 @@ export = CommunicationPlatformModel;
|
|
|
642
642
|
* @property {string} [mobile]
|
|
643
643
|
* @property {string} [country_code]
|
|
644
644
|
* @property {string} [message]
|
|
645
|
+
* @property {string} [email]
|
|
645
646
|
*/
|
|
646
647
|
/**
|
|
647
648
|
* @typedef VerifyOtpCommsErrorRes
|
|
@@ -651,6 +652,7 @@ export = CommunicationPlatformModel;
|
|
|
651
652
|
/**
|
|
652
653
|
* @typedef SmsProviderReq
|
|
653
654
|
* @property {string} [name]
|
|
655
|
+
* @property {string} [token]
|
|
654
656
|
* @property {string} [description]
|
|
655
657
|
* @property {string} [sender]
|
|
656
658
|
* @property {string} [username]
|
|
@@ -672,6 +674,10 @@ export = CommunicationPlatformModel;
|
|
|
672
674
|
*/
|
|
673
675
|
/**
|
|
674
676
|
* @typedef SmsProvider
|
|
677
|
+
* @property {string} [token]
|
|
678
|
+
* @property {string} [sender_id]
|
|
679
|
+
* @property {string} [api_key]
|
|
680
|
+
* @property {number} [expiry_date]
|
|
675
681
|
* @property {number} [rpt]
|
|
676
682
|
* @property {string} [type]
|
|
677
683
|
* @property {string} [provider]
|
|
@@ -1605,6 +1611,7 @@ type VerifyOtpCommsSuccessRes = {
|
|
|
1605
1611
|
mobile?: string;
|
|
1606
1612
|
country_code?: string;
|
|
1607
1613
|
message?: string;
|
|
1614
|
+
email?: string;
|
|
1608
1615
|
};
|
|
1609
1616
|
/** @returns {VerifyOtpCommsErrorRes} */
|
|
1610
1617
|
declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
|
|
@@ -1616,6 +1623,7 @@ type VerifyOtpCommsErrorRes = {
|
|
|
1616
1623
|
declare function SmsProviderReq(): SmsProviderReq;
|
|
1617
1624
|
type SmsProviderReq = {
|
|
1618
1625
|
name?: string;
|
|
1626
|
+
token?: string;
|
|
1619
1627
|
description?: string;
|
|
1620
1628
|
sender?: string;
|
|
1621
1629
|
username?: string;
|
|
@@ -1674,6 +1682,10 @@ type SmsProviderReq = {
|
|
|
1674
1682
|
/** @returns {SmsProvider} */
|
|
1675
1683
|
declare function SmsProvider(): SmsProvider;
|
|
1676
1684
|
type SmsProvider = {
|
|
1685
|
+
token?: string;
|
|
1686
|
+
sender_id?: string;
|
|
1687
|
+
api_key?: string;
|
|
1688
|
+
expiry_date?: number;
|
|
1677
1689
|
rpt?: number;
|
|
1678
1690
|
type?: string;
|
|
1679
1691
|
provider?: string;
|
|
@@ -734,6 +734,7 @@ const Joi = require("joi");
|
|
|
734
734
|
* @property {string} [mobile]
|
|
735
735
|
* @property {string} [country_code]
|
|
736
736
|
* @property {string} [message]
|
|
737
|
+
* @property {string} [email]
|
|
737
738
|
*/
|
|
738
739
|
|
|
739
740
|
/**
|
|
@@ -745,6 +746,7 @@ const Joi = require("joi");
|
|
|
745
746
|
/**
|
|
746
747
|
* @typedef SmsProviderReq
|
|
747
748
|
* @property {string} [name]
|
|
749
|
+
* @property {string} [token]
|
|
748
750
|
* @property {string} [description]
|
|
749
751
|
* @property {string} [sender]
|
|
750
752
|
* @property {string} [username]
|
|
@@ -767,6 +769,10 @@ const Joi = require("joi");
|
|
|
767
769
|
|
|
768
770
|
/**
|
|
769
771
|
* @typedef SmsProvider
|
|
772
|
+
* @property {string} [token]
|
|
773
|
+
* @property {string} [sender_id]
|
|
774
|
+
* @property {string} [api_key]
|
|
775
|
+
* @property {number} [expiry_date]
|
|
770
776
|
* @property {number} [rpt]
|
|
771
777
|
* @property {string} [type]
|
|
772
778
|
* @property {string} [provider]
|
|
@@ -1903,6 +1909,7 @@ class CommunicationPlatformModel {
|
|
|
1903
1909
|
mobile: Joi.string().allow(""),
|
|
1904
1910
|
country_code: Joi.string().allow(""),
|
|
1905
1911
|
message: Joi.string().allow(""),
|
|
1912
|
+
email: Joi.string().allow(""),
|
|
1906
1913
|
});
|
|
1907
1914
|
}
|
|
1908
1915
|
|
|
@@ -1918,6 +1925,7 @@ class CommunicationPlatformModel {
|
|
|
1918
1925
|
static SmsProviderReq() {
|
|
1919
1926
|
return Joi.object({
|
|
1920
1927
|
name: Joi.string().allow(""),
|
|
1928
|
+
token: Joi.string().allow(""),
|
|
1921
1929
|
description: Joi.string().allow(""),
|
|
1922
1930
|
sender: Joi.string().allow(""),
|
|
1923
1931
|
username: Joi.string().allow(""),
|
|
@@ -1942,6 +1950,10 @@ class CommunicationPlatformModel {
|
|
|
1942
1950
|
/** @returns {SmsProvider} */
|
|
1943
1951
|
static SmsProvider() {
|
|
1944
1952
|
return Joi.object({
|
|
1953
|
+
token: Joi.string().allow(""),
|
|
1954
|
+
sender_id: Joi.string().allow(""),
|
|
1955
|
+
api_key: Joi.string().allow(""),
|
|
1956
|
+
expiry_date: Joi.number(),
|
|
1945
1957
|
rpt: Joi.number(),
|
|
1946
1958
|
type: Joi.string().allow(""),
|
|
1947
1959
|
provider: Joi.string().allow(""),
|