@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -93,14 +93,14 @@ declare class Communication {
|
|
|
93
93
|
*
|
|
94
94
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
96
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
|
|
97
97
|
* - Success response
|
|
98
98
|
*
|
|
99
99
|
* @name createEventSubscriptions
|
|
100
100
|
* @summary: Create an event subscription
|
|
101
101
|
* @description: Creates a new event subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptions/).
|
|
102
102
|
*/
|
|
103
|
-
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
103
|
+
createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
104
104
|
/**
|
|
105
105
|
* @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg
|
|
106
106
|
* - Arg object
|
|
@@ -108,7 +108,7 @@ declare class Communication {
|
|
|
108
108
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
110
|
* @returns {Promise<
|
|
111
|
-
* CommunicationPlatformModel.
|
|
111
|
+
* CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]
|
|
112
112
|
* >}
|
|
113
113
|
* - Success response
|
|
114
114
|
*
|
|
@@ -116,7 +116,7 @@ declare class Communication {
|
|
|
116
116
|
* @summary: Create event subscriptions in bulk
|
|
117
117
|
* @description: Creates a new event subscription in bulk. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/createEventSubscriptionsByBulk/).
|
|
118
118
|
*/
|
|
119
|
-
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
119
|
+
createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]>;
|
|
120
120
|
/**
|
|
121
121
|
* @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object
|
|
122
122
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -229,14 +229,14 @@ declare class Communication {
|
|
|
229
229
|
*
|
|
230
230
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
231
231
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
232
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
|
|
233
233
|
* - Success response
|
|
234
234
|
*
|
|
235
235
|
* @name editEventSubscriptions
|
|
236
236
|
* @summary: Update an event subscriptions
|
|
237
237
|
* @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/editEventSubscriptions/).
|
|
238
238
|
*/
|
|
239
|
-
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
239
|
+
editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>;
|
|
240
240
|
/**
|
|
241
241
|
* @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg
|
|
242
242
|
* - Arg object
|
|
@@ -463,14 +463,14 @@ declare class Communication {
|
|
|
463
463
|
*
|
|
464
464
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
465
465
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
466
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
466
|
+
* @returns {Promise<CommunicationPlatformModel.GetGlobalVariablesResult>}
|
|
467
467
|
* - Success response
|
|
468
468
|
*
|
|
469
469
|
* @name getGlobalVariables
|
|
470
470
|
* @summary: Get all global variables
|
|
471
471
|
* @description: Retrieves a list of communication global variables. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getGlobalVariables/).
|
|
472
472
|
*/
|
|
473
|
-
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
473
|
+
getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationPlatformModel.GetGlobalVariablesResult>;
|
|
474
474
|
/**
|
|
475
475
|
* @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object
|
|
476
476
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -655,38 +655,38 @@ declare class Communication {
|
|
|
655
655
|
*
|
|
656
656
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
657
657
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
658
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
658
|
+
* @returns {Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>}
|
|
659
659
|
* - Success response
|
|
660
660
|
*
|
|
661
661
|
* @name postGlobalVariables
|
|
662
662
|
* @summary: Create global variables
|
|
663
663
|
* @description: Updates and creates communication global variables. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/postGlobalVariables/).
|
|
664
664
|
*/
|
|
665
|
-
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
665
|
+
postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>;
|
|
666
666
|
/**
|
|
667
667
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg
|
|
668
668
|
* - Arg object
|
|
669
669
|
*
|
|
670
670
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
671
671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
672
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
672
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
673
673
|
* @name sendCommunicationAsynchronously
|
|
674
674
|
* @summary: Send communication asynchronously
|
|
675
675
|
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
676
676
|
*/
|
|
677
|
-
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
677
|
+
sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
678
678
|
/**
|
|
679
679
|
* @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg
|
|
680
680
|
* - Arg object
|
|
681
681
|
*
|
|
682
682
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
683
683
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
684
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
684
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
685
685
|
* @name sendCommunicationSynchronously
|
|
686
686
|
* @summary: Send communication synchronously
|
|
687
687
|
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
688
688
|
*/
|
|
689
|
-
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
689
|
+
sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.EngineResult>;
|
|
690
690
|
/**
|
|
691
691
|
* @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object
|
|
692
692
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -703,13 +703,12 @@ declare class Communication {
|
|
|
703
703
|
*
|
|
704
704
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
705
705
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
706
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
707
|
-
* Success response
|
|
706
|
+
* @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
|
|
708
707
|
* @name triggerCampaignJob
|
|
709
708
|
* @summary: Trigger a campaign job
|
|
710
709
|
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
|
|
711
710
|
*/
|
|
712
|
-
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.
|
|
711
|
+
triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.TriggerJobResult>;
|
|
713
712
|
/**
|
|
714
713
|
* @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg
|
|
715
714
|
* - Arg object
|
|
@@ -570,7 +570,7 @@ class Communication {
|
|
|
570
570
|
*
|
|
571
571
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
572
572
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
573
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
573
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
|
|
574
574
|
* - Success response
|
|
575
575
|
*
|
|
576
576
|
* @name createEventSubscriptions
|
|
@@ -628,7 +628,7 @@ class Communication {
|
|
|
628
628
|
|
|
629
629
|
const {
|
|
630
630
|
error: res_error,
|
|
631
|
-
} = CommunicationPlatformModel.
|
|
631
|
+
} = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult().validate(
|
|
632
632
|
responseData,
|
|
633
633
|
{ abortEarly: false, allowUnknown: true }
|
|
634
634
|
);
|
|
@@ -654,7 +654,7 @@ class Communication {
|
|
|
654
654
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
655
655
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
656
656
|
* @returns {Promise<
|
|
657
|
-
* CommunicationPlatformModel.
|
|
657
|
+
* CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[]
|
|
658
658
|
* >}
|
|
659
659
|
* - Success response
|
|
660
660
|
*
|
|
@@ -712,7 +712,7 @@ class Communication {
|
|
|
712
712
|
}
|
|
713
713
|
|
|
714
714
|
const { error: res_error } = Joi.array()
|
|
715
|
-
.items(CommunicationPlatformModel.
|
|
715
|
+
.items(CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult())
|
|
716
716
|
.validate(responseData, { abortEarly: false, allowUnknown: true });
|
|
717
717
|
|
|
718
718
|
if (res_error) {
|
|
@@ -1462,7 +1462,7 @@ class Communication {
|
|
|
1462
1462
|
*
|
|
1463
1463
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1464
1464
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1465
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
1465
|
+
* @returns {Promise<CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult>}
|
|
1466
1466
|
* - Success response
|
|
1467
1467
|
*
|
|
1468
1468
|
* @name editEventSubscriptions
|
|
@@ -1522,7 +1522,7 @@ class Communication {
|
|
|
1522
1522
|
|
|
1523
1523
|
const {
|
|
1524
1524
|
error: res_error,
|
|
1525
|
-
} = CommunicationPlatformModel.
|
|
1525
|
+
} = CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult().validate(
|
|
1526
1526
|
responseData,
|
|
1527
1527
|
{ abortEarly: false, allowUnknown: true }
|
|
1528
1528
|
);
|
|
@@ -3043,7 +3043,7 @@ class Communication {
|
|
|
3043
3043
|
*
|
|
3044
3044
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3045
3045
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3046
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
3046
|
+
* @returns {Promise<CommunicationPlatformModel.GetGlobalVariablesResult>}
|
|
3047
3047
|
* - Success response
|
|
3048
3048
|
*
|
|
3049
3049
|
* @name getGlobalVariables
|
|
@@ -3097,7 +3097,7 @@ class Communication {
|
|
|
3097
3097
|
|
|
3098
3098
|
const {
|
|
3099
3099
|
error: res_error,
|
|
3100
|
-
} = CommunicationPlatformModel.
|
|
3100
|
+
} = CommunicationPlatformModel.GetGlobalVariablesResult().validate(
|
|
3101
3101
|
responseData,
|
|
3102
3102
|
{ abortEarly: false, allowUnknown: true }
|
|
3103
3103
|
);
|
|
@@ -4360,7 +4360,7 @@ class Communication {
|
|
|
4360
4360
|
*
|
|
4361
4361
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4362
4362
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4363
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
4363
|
+
* @returns {Promise<CommunicationPlatformModel.CreateGlobalVariablesResult>}
|
|
4364
4364
|
* - Success response
|
|
4365
4365
|
*
|
|
4366
4366
|
* @name postGlobalVariables
|
|
@@ -4418,7 +4418,7 @@ class Communication {
|
|
|
4418
4418
|
|
|
4419
4419
|
const {
|
|
4420
4420
|
error: res_error,
|
|
4421
|
-
} = CommunicationPlatformModel.
|
|
4421
|
+
} = CommunicationPlatformModel.CreateGlobalVariablesResult().validate(
|
|
4422
4422
|
responseData,
|
|
4423
4423
|
{ abortEarly: false, allowUnknown: true }
|
|
4424
4424
|
);
|
|
@@ -4443,7 +4443,7 @@ class Communication {
|
|
|
4443
4443
|
*
|
|
4444
4444
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4445
4445
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4446
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
4446
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
4447
4447
|
* @name sendCommunicationAsynchronously
|
|
4448
4448
|
* @summary: Send communication asynchronously
|
|
4449
4449
|
* @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationAsynchronously/).
|
|
@@ -4499,7 +4499,7 @@ class Communication {
|
|
|
4499
4499
|
|
|
4500
4500
|
const {
|
|
4501
4501
|
error: res_error,
|
|
4502
|
-
} = CommunicationPlatformModel.
|
|
4502
|
+
} = CommunicationPlatformModel.EngineResult().validate(responseData, {
|
|
4503
4503
|
abortEarly: false,
|
|
4504
4504
|
allowUnknown: true,
|
|
4505
4505
|
});
|
|
@@ -4524,7 +4524,7 @@ class Communication {
|
|
|
4524
4524
|
*
|
|
4525
4525
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4526
4526
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4527
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
4527
|
+
* @returns {Promise<CommunicationPlatformModel.EngineResult>} - Success response
|
|
4528
4528
|
* @name sendCommunicationSynchronously
|
|
4529
4529
|
* @summary: Send communication synchronously
|
|
4530
4530
|
* @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/sendCommunicationSynchronously/).
|
|
@@ -4580,7 +4580,7 @@ class Communication {
|
|
|
4580
4580
|
|
|
4581
4581
|
const {
|
|
4582
4582
|
error: res_error,
|
|
4583
|
-
} = CommunicationPlatformModel.
|
|
4583
|
+
} = CommunicationPlatformModel.EngineResult().validate(responseData, {
|
|
4584
4584
|
abortEarly: false,
|
|
4585
4585
|
allowUnknown: true,
|
|
4586
4586
|
});
|
|
@@ -4684,8 +4684,7 @@ class Communication {
|
|
|
4684
4684
|
*
|
|
4685
4685
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4686
4686
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4687
|
-
* @returns {Promise<CommunicationPlatformModel.
|
|
4688
|
-
* Success response
|
|
4687
|
+
* @returns {Promise<CommunicationPlatformModel.TriggerJobResult>} - Success response
|
|
4689
4688
|
* @name triggerCampaignJob
|
|
4690
4689
|
* @summary: Trigger a campaign job
|
|
4691
4690
|
* @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/triggerCampaignJob/).
|
|
@@ -4741,7 +4740,7 @@ class Communication {
|
|
|
4741
4740
|
|
|
4742
4741
|
const {
|
|
4743
4742
|
error: res_error,
|
|
4744
|
-
} = CommunicationPlatformModel.
|
|
4743
|
+
} = CommunicationPlatformModel.TriggerJobResult().validate(responseData, {
|
|
4745
4744
|
abortEarly: false,
|
|
4746
4745
|
allowUnknown: true,
|
|
4747
4746
|
});
|
|
@@ -24,7 +24,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
24
24
|
*/
|
|
25
25
|
/**
|
|
26
26
|
* @typedef CreateEventSubscriptionsByBulkParam
|
|
27
|
-
* @property {CommunicationPlatformModel.
|
|
27
|
+
* @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload} body
|
|
28
28
|
*/
|
|
29
29
|
/**
|
|
30
30
|
* @typedef CreateJobsParam
|
|
@@ -214,11 +214,11 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
214
214
|
*/
|
|
215
215
|
/**
|
|
216
216
|
* @typedef SendCommunicationAsynchronouslyParam
|
|
217
|
-
* @property {CommunicationPlatformModel.
|
|
217
|
+
* @property {CommunicationPlatformModel.EnginePayload} body
|
|
218
218
|
*/
|
|
219
219
|
/**
|
|
220
220
|
* @typedef SendCommunicationSynchronouslyParam
|
|
221
|
-
* @property {CommunicationPlatformModel.
|
|
221
|
+
* @property {CommunicationPlatformModel.EnginePayload} body
|
|
222
222
|
*/
|
|
223
223
|
/**
|
|
224
224
|
* @typedef SendOtpParam
|
|
@@ -226,7 +226,7 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
226
226
|
*/
|
|
227
227
|
/**
|
|
228
228
|
* @typedef TriggerCampaignJobParam
|
|
229
|
-
* @property {CommunicationPlatformModel.
|
|
229
|
+
* @property {CommunicationPlatformModel.TriggerJobPayload} body
|
|
230
230
|
*/
|
|
231
231
|
/**
|
|
232
232
|
* @typedef UpdateAppProvidersParam
|
|
@@ -422,7 +422,7 @@ type CreateEventSubscriptionsParam = {
|
|
|
422
422
|
body: CommunicationPlatformModel.SubscriptionsObject;
|
|
423
423
|
};
|
|
424
424
|
type CreateEventSubscriptionsByBulkParam = {
|
|
425
|
-
body: CommunicationPlatformModel.
|
|
425
|
+
body: CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload;
|
|
426
426
|
};
|
|
427
427
|
type CreateJobsParam = {
|
|
428
428
|
body: CommunicationPlatformModel.CreateJobsReq;
|
|
@@ -755,16 +755,16 @@ type PostGlobalVariablesParam = {
|
|
|
755
755
|
body: CommunicationPlatformModel.GlobalVariablesReq;
|
|
756
756
|
};
|
|
757
757
|
type SendCommunicationAsynchronouslyParam = {
|
|
758
|
-
body: CommunicationPlatformModel.
|
|
758
|
+
body: CommunicationPlatformModel.EnginePayload;
|
|
759
759
|
};
|
|
760
760
|
type SendCommunicationSynchronouslyParam = {
|
|
761
|
-
body: CommunicationPlatformModel.
|
|
761
|
+
body: CommunicationPlatformModel.EnginePayload;
|
|
762
762
|
};
|
|
763
763
|
type SendOtpParam = {
|
|
764
764
|
body: CommunicationPlatformModel.SendOtpCommsReq;
|
|
765
765
|
};
|
|
766
766
|
type TriggerCampaignJobParam = {
|
|
767
|
-
body: CommunicationPlatformModel.
|
|
767
|
+
body: CommunicationPlatformModel.TriggerJobPayload;
|
|
768
768
|
};
|
|
769
769
|
type UpdateAppProvidersParam = {
|
|
770
770
|
body: CommunicationPlatformModel.AppProviderReq;
|
|
@@ -35,7 +35,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
37
|
* @typedef CreateEventSubscriptionsByBulkParam
|
|
38
|
-
* @property {CommunicationPlatformModel.
|
|
38
|
+
* @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload} body
|
|
39
39
|
*/
|
|
40
40
|
|
|
41
41
|
/**
|
|
@@ -271,12 +271,12 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
271
271
|
|
|
272
272
|
/**
|
|
273
273
|
* @typedef SendCommunicationAsynchronouslyParam
|
|
274
|
-
* @property {CommunicationPlatformModel.
|
|
274
|
+
* @property {CommunicationPlatformModel.EnginePayload} body
|
|
275
275
|
*/
|
|
276
276
|
|
|
277
277
|
/**
|
|
278
278
|
* @typedef SendCommunicationSynchronouslyParam
|
|
279
|
-
* @property {CommunicationPlatformModel.
|
|
279
|
+
* @property {CommunicationPlatformModel.EnginePayload} body
|
|
280
280
|
*/
|
|
281
281
|
|
|
282
282
|
/**
|
|
@@ -286,7 +286,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
|
|
|
286
286
|
|
|
287
287
|
/**
|
|
288
288
|
* @typedef TriggerCampaignJobParam
|
|
289
|
-
* @property {CommunicationPlatformModel.
|
|
289
|
+
* @property {CommunicationPlatformModel.TriggerJobPayload} body
|
|
290
290
|
*/
|
|
291
291
|
|
|
292
292
|
/**
|
|
@@ -391,7 +391,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
391
391
|
/** @returns {CreateEventSubscriptionsByBulkParam} */
|
|
392
392
|
static createEventSubscriptionsByBulk() {
|
|
393
393
|
return Joi.object({
|
|
394
|
-
body: CommunicationPlatformModel.
|
|
394
|
+
body: CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload().required(),
|
|
395
395
|
}).required();
|
|
396
396
|
}
|
|
397
397
|
|
|
@@ -729,14 +729,14 @@ class CommunicationPlatformApplicationValidator {
|
|
|
729
729
|
/** @returns {SendCommunicationAsynchronouslyParam} */
|
|
730
730
|
static sendCommunicationAsynchronously() {
|
|
731
731
|
return Joi.object({
|
|
732
|
-
body: CommunicationPlatformModel.
|
|
732
|
+
body: CommunicationPlatformModel.EnginePayload().required(),
|
|
733
733
|
}).required();
|
|
734
734
|
}
|
|
735
735
|
|
|
736
736
|
/** @returns {SendCommunicationSynchronouslyParam} */
|
|
737
737
|
static sendCommunicationSynchronously() {
|
|
738
738
|
return Joi.object({
|
|
739
|
-
body: CommunicationPlatformModel.
|
|
739
|
+
body: CommunicationPlatformModel.EnginePayload().required(),
|
|
740
740
|
}).required();
|
|
741
741
|
}
|
|
742
742
|
|
|
@@ -750,7 +750,7 @@ class CommunicationPlatformApplicationValidator {
|
|
|
750
750
|
/** @returns {TriggerCampaignJobParam} */
|
|
751
751
|
static triggerCampaignJob() {
|
|
752
752
|
return Joi.object({
|
|
753
|
-
body: CommunicationPlatformModel.
|
|
753
|
+
body: CommunicationPlatformModel.TriggerJobPayload().required(),
|
|
754
754
|
}).required();
|
|
755
755
|
}
|
|
756
756
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export = CommunicationPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef EventSubscriptionsBulkUpdatePayload
|
|
4
4
|
* @property {SubscriptionsObject[]} [subscriptions]
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
7
|
-
* @typedef
|
|
7
|
+
* @typedef EventSubscriptionsBulkUpdateResult
|
|
8
8
|
* @property {EventSubscriptionTemplate} [template]
|
|
9
9
|
* @property {string} [_id]
|
|
10
10
|
* @property {string} [application]
|
|
@@ -414,12 +414,12 @@ export = CommunicationPlatformModel;
|
|
|
414
414
|
* @property {string} [timestamp]
|
|
415
415
|
*/
|
|
416
416
|
/**
|
|
417
|
-
* @typedef
|
|
417
|
+
* @typedef EnginePayload
|
|
418
418
|
* @property {PayloadStructure} [payload]
|
|
419
419
|
* @property {MetaStructure} [meta]
|
|
420
420
|
*/
|
|
421
421
|
/**
|
|
422
|
-
* @typedef
|
|
422
|
+
* @typedef EngineResult
|
|
423
423
|
* @property {boolean} [success]
|
|
424
424
|
*/
|
|
425
425
|
/**
|
|
@@ -455,20 +455,20 @@ export = CommunicationPlatformModel;
|
|
|
455
455
|
* @property {Page} [page]
|
|
456
456
|
*/
|
|
457
457
|
/**
|
|
458
|
-
* @typedef
|
|
458
|
+
* @typedef TriggerJobResult
|
|
459
459
|
* @property {number} [status]
|
|
460
460
|
*/
|
|
461
461
|
/**
|
|
462
|
-
* @typedef
|
|
462
|
+
* @typedef TriggerJobPayload
|
|
463
463
|
* @property {string} [job_id]
|
|
464
464
|
*/
|
|
465
465
|
/**
|
|
466
|
-
* @typedef
|
|
466
|
+
* @typedef GetGlobalVariablesResult
|
|
467
467
|
* @property {Object} [read_only]
|
|
468
468
|
* @property {Object} [editable]
|
|
469
469
|
*/
|
|
470
470
|
/**
|
|
471
|
-
* @typedef
|
|
471
|
+
* @typedef CreateGlobalVariablesResult
|
|
472
472
|
* @property {string} [_id]
|
|
473
473
|
* @property {string} [category]
|
|
474
474
|
* @property {string} [application]
|
|
@@ -671,6 +671,8 @@ export = CommunicationPlatformModel;
|
|
|
671
671
|
* @property {number} [version_id] - The version ID for the test.
|
|
672
672
|
* @property {string} [sender_id] - The sender ID for the test.
|
|
673
673
|
* @property {string} [api_key] - The api_key for the test.
|
|
674
|
+
* @property {string} [tenant_name_1] - First part of jiocx url.
|
|
675
|
+
* @property {string} [tenant_name_2] - Second part of jiocx url.
|
|
674
676
|
*/
|
|
675
677
|
/**
|
|
676
678
|
* @typedef SmsProvider
|
|
@@ -856,16 +858,16 @@ export = CommunicationPlatformModel;
|
|
|
856
858
|
declare class CommunicationPlatformModel {
|
|
857
859
|
}
|
|
858
860
|
declare namespace CommunicationPlatformModel {
|
|
859
|
-
export {
|
|
861
|
+
export { EventSubscriptionsBulkUpdatePayload, EventSubscriptionsBulkUpdateResult, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EnginePayload, EngineResult, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptions, TriggerJobResult, TriggerJobPayload, GetGlobalVariablesResult, CreateGlobalVariablesResult, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
|
|
860
862
|
}
|
|
861
|
-
/** @returns {
|
|
862
|
-
declare function
|
|
863
|
-
type
|
|
863
|
+
/** @returns {EventSubscriptionsBulkUpdatePayload} */
|
|
864
|
+
declare function EventSubscriptionsBulkUpdatePayload(): EventSubscriptionsBulkUpdatePayload;
|
|
865
|
+
type EventSubscriptionsBulkUpdatePayload = {
|
|
864
866
|
subscriptions?: SubscriptionsObject[];
|
|
865
867
|
};
|
|
866
|
-
/** @returns {
|
|
867
|
-
declare function
|
|
868
|
-
type
|
|
868
|
+
/** @returns {EventSubscriptionsBulkUpdateResult} */
|
|
869
|
+
declare function EventSubscriptionsBulkUpdateResult(): EventSubscriptionsBulkUpdateResult;
|
|
870
|
+
type EventSubscriptionsBulkUpdateResult = {
|
|
869
871
|
template?: EventSubscriptionTemplate;
|
|
870
872
|
_id?: string;
|
|
871
873
|
application?: string;
|
|
@@ -1346,15 +1348,15 @@ type MetaStructure = {
|
|
|
1346
1348
|
trace?: string;
|
|
1347
1349
|
timestamp?: string;
|
|
1348
1350
|
};
|
|
1349
|
-
/** @returns {
|
|
1350
|
-
declare function
|
|
1351
|
-
type
|
|
1351
|
+
/** @returns {EnginePayload} */
|
|
1352
|
+
declare function EnginePayload(): EnginePayload;
|
|
1353
|
+
type EnginePayload = {
|
|
1352
1354
|
payload?: PayloadStructure;
|
|
1353
1355
|
meta?: MetaStructure;
|
|
1354
1356
|
};
|
|
1355
|
-
/** @returns {
|
|
1356
|
-
declare function
|
|
1357
|
-
type
|
|
1357
|
+
/** @returns {EngineResult} */
|
|
1358
|
+
declare function EngineResult(): EngineResult;
|
|
1359
|
+
type EngineResult = {
|
|
1358
1360
|
success?: boolean;
|
|
1359
1361
|
};
|
|
1360
1362
|
/** @returns {EventSubscriptionTemplateSms} */
|
|
@@ -1394,25 +1396,25 @@ type EventSubscriptions = {
|
|
|
1394
1396
|
items?: EventSubscription[];
|
|
1395
1397
|
page?: Page;
|
|
1396
1398
|
};
|
|
1397
|
-
/** @returns {
|
|
1398
|
-
declare function
|
|
1399
|
-
type
|
|
1399
|
+
/** @returns {TriggerJobResult} */
|
|
1400
|
+
declare function TriggerJobResult(): TriggerJobResult;
|
|
1401
|
+
type TriggerJobResult = {
|
|
1400
1402
|
status?: number;
|
|
1401
1403
|
};
|
|
1402
|
-
/** @returns {
|
|
1403
|
-
declare function
|
|
1404
|
-
type
|
|
1404
|
+
/** @returns {TriggerJobPayload} */
|
|
1405
|
+
declare function TriggerJobPayload(): TriggerJobPayload;
|
|
1406
|
+
type TriggerJobPayload = {
|
|
1405
1407
|
job_id?: string;
|
|
1406
1408
|
};
|
|
1407
|
-
/** @returns {
|
|
1408
|
-
declare function
|
|
1409
|
-
type
|
|
1409
|
+
/** @returns {GetGlobalVariablesResult} */
|
|
1410
|
+
declare function GetGlobalVariablesResult(): GetGlobalVariablesResult;
|
|
1411
|
+
type GetGlobalVariablesResult = {
|
|
1410
1412
|
read_only?: any;
|
|
1411
1413
|
editable?: any;
|
|
1412
1414
|
};
|
|
1413
|
-
/** @returns {
|
|
1414
|
-
declare function
|
|
1415
|
-
type
|
|
1415
|
+
/** @returns {CreateGlobalVariablesResult} */
|
|
1416
|
+
declare function CreateGlobalVariablesResult(): CreateGlobalVariablesResult;
|
|
1417
|
+
type CreateGlobalVariablesResult = {
|
|
1416
1418
|
_id?: string;
|
|
1417
1419
|
category?: string;
|
|
1418
1420
|
application?: string;
|
|
@@ -1678,6 +1680,14 @@ type SmsProviderReq = {
|
|
|
1678
1680
|
* - The api_key for the test.
|
|
1679
1681
|
*/
|
|
1680
1682
|
api_key?: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* - First part of jiocx url.
|
|
1685
|
+
*/
|
|
1686
|
+
tenant_name_1?: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* - Second part of jiocx url.
|
|
1689
|
+
*/
|
|
1690
|
+
tenant_name_2?: string;
|
|
1681
1691
|
};
|
|
1682
1692
|
/** @returns {SmsProvider} */
|
|
1683
1693
|
declare function SmsProvider(): SmsProvider;
|