@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- 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 +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- 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 +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- 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/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- 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 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,89 +1,144 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {string} [status]
|
|
4
|
+
* @typedef SubscriberUpdate
|
|
5
|
+
* @property {string} [status] - Represents the status of the subscriber update operation.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
10
|
-
* @property {string} [message]
|
|
9
|
+
* @typedef SubscriberUpdateResult
|
|
10
|
+
* @property {string} [message] - Provides a message describing the result of
|
|
11
|
+
* the subscriber update operation.
|
|
11
12
|
*/
|
|
12
13
|
|
|
13
14
|
/**
|
|
14
15
|
* @typedef Association
|
|
15
|
-
* @property {number} [company_id]
|
|
16
|
-
*
|
|
17
|
-
* @property {string} [
|
|
18
|
-
*
|
|
16
|
+
* @property {number} [company_id] - The identifier for the company associated
|
|
17
|
+
* with the configuration.
|
|
18
|
+
* @property {string[]} [application_id] - A list of application identifiers
|
|
19
|
+
* associated with the configuration.
|
|
20
|
+
* @property {string} [extension_id] - The identifier for the extension related
|
|
21
|
+
* to the configuration.
|
|
22
|
+
* @property {string} [criteria] - Defines the criteria for the association,
|
|
23
|
+
* including options for all events, empty criteria, or specific events.
|
|
19
24
|
*/
|
|
20
25
|
|
|
21
26
|
/**
|
|
22
27
|
* @typedef AuthMeta
|
|
23
|
-
* @property {string} [type]
|
|
24
|
-
* @property {string} [secret]
|
|
28
|
+
* @property {string} [type] - Specifies the type of authentication used.
|
|
29
|
+
* @property {string} [secret] - Contains the key or token used for authentication.
|
|
30
|
+
*/
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* @typedef BroadcasterConfig
|
|
34
|
+
* @property {string} [topic] - The topic associated with the broadcaster configuration.
|
|
35
|
+
* @property {string} [queue] - The queue name used by the broadcaster.
|
|
36
|
+
* @property {string} [event_bridge_name] - The name of the event bridge used in
|
|
37
|
+
* the broadcaster configuration.
|
|
38
|
+
* @property {string} [workflow_name] - The name of the workflow related to the
|
|
39
|
+
* broadcaster.
|
|
40
|
+
* @property {string} [account_id] - The account ID associated with the
|
|
41
|
+
* broadcaster configuration.
|
|
42
|
+
* @property {string} [detail_type] - Specifies the type of detail for the
|
|
43
|
+
* broadcaster, allowing for custom or non-enumerated values.
|
|
25
44
|
*/
|
|
26
45
|
|
|
27
46
|
/**
|
|
28
47
|
* @typedef SubscriberEventMapping
|
|
29
|
-
* @property {number} [id]
|
|
30
|
-
* @property {number} [event_id]
|
|
31
|
-
*
|
|
32
|
-
* @property {
|
|
33
|
-
*
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* @property {
|
|
41
|
-
* @property {string} [
|
|
42
|
-
*
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
* @
|
|
47
|
-
* @property {string} [
|
|
48
|
-
*
|
|
48
|
+
* @property {number} [id] - The unique identifier for the subscriber event mapping.
|
|
49
|
+
* @property {number} [event_id] - The identifier for the event associated with
|
|
50
|
+
* the subscriber.
|
|
51
|
+
* @property {number} [subscriber_id] - The identifier for the subscriber
|
|
52
|
+
* involved in the mapping.
|
|
53
|
+
* @property {FilterSchema} [filters]
|
|
54
|
+
* @property {Object} [reducer] - The reducer property allows users to customize
|
|
55
|
+
* the JSON structure of the webhook payload using JSONPath queries. They can
|
|
56
|
+
* also create new properties by mapping existing ones. Note that it overrides
|
|
57
|
+
* the entire JSON structure of the webhook payload sent via the webhook. See
|
|
58
|
+
* the partner documentation's filter and reducer section for details.
|
|
59
|
+
* @property {BroadcasterConfig} [broadcaster_config]
|
|
60
|
+
* @property {string} [created_on] - The timestamp indicating when the
|
|
61
|
+
* subscriber event mapping was created.
|
|
62
|
+
*/
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* @typedef FilterSchema
|
|
66
|
+
* @property {string} [query] - JSONPath expression that specifies the property
|
|
67
|
+
* in the webhook payload to filter on. This enables targeting specific data
|
|
68
|
+
* within the payload.
|
|
69
|
+
* @property {string} [condition] - JavaScript function used to evaluate the
|
|
70
|
+
* specified property in the webhook payload against a condition. This
|
|
71
|
+
* function determines whether the filter passes based on its return value.
|
|
72
|
+
* @property {string} [logic] - Logical operator used to combine multiple
|
|
73
|
+
* conditions in the `conditions` array. Supported values are `AND` and `OR`.
|
|
74
|
+
* @property {Object[]} [conditions] - An array of filter objects to be
|
|
75
|
+
* evaluated using the specified logical operator. This array will contain
|
|
76
|
+
* more filters including a combination of single condition mode and logical
|
|
77
|
+
* group mode filters.
|
|
78
|
+
*/
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* @typedef EventConfigDetails
|
|
82
|
+
* @property {number} [id] - The unique identifier for the event configuration.
|
|
83
|
+
* @property {string} [event_name] - The name assigned to the event configuration.
|
|
84
|
+
* @property {string} [event_type] - Specifies the type of event, allowing for
|
|
85
|
+
* custom or non-enumerated values.
|
|
86
|
+
* @property {string} [event_category] - Defines the category of the event,
|
|
87
|
+
* allowing for custom or non-enumerated values.
|
|
88
|
+
* @property {Object} [event_schema] - Contains the schema details for the
|
|
89
|
+
* event, allowing for flexible or dynamic schemas.
|
|
90
|
+
* @property {string} [version] - The version number of the event configuration.
|
|
91
|
+
* @property {string} [display_name] - The display name for the event configuration.
|
|
92
|
+
* @property {string} [description] - A description of the event configuration,
|
|
93
|
+
* if provided.
|
|
94
|
+
* @property {string} [created_on] - The timestamp indicating when the event
|
|
95
|
+
* configuration was created.
|
|
96
|
+
* @property {string} [updated_on] - The timestamp indicating when the event
|
|
97
|
+
* configuration was last updated.
|
|
98
|
+
* @property {string} [group] - The group to which the event configuration
|
|
99
|
+
* belongs, if applicable.
|
|
49
100
|
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
50
101
|
*/
|
|
51
102
|
|
|
52
103
|
/**
|
|
53
|
-
* @typedef
|
|
54
|
-
* @property {ItemSchema[]} [items]
|
|
104
|
+
* @typedef SubscriberConfigDetails
|
|
105
|
+
* @property {ItemSchema[]} [items] - A list of items representing subscriber
|
|
106
|
+
* configurations.
|
|
55
107
|
* @property {Page} [page]
|
|
56
108
|
*/
|
|
57
109
|
|
|
58
110
|
/**
|
|
59
|
-
* @typedef
|
|
60
|
-
* @property {string} [event_name]
|
|
61
|
-
* @property {string} [version]
|
|
62
|
-
* @property {string} [category]
|
|
63
|
-
* @property {string} [start_date]
|
|
64
|
-
*
|
|
111
|
+
* @typedef InvalidEventsPayload
|
|
112
|
+
* @property {string} [event_name] - The name of the event that is considered invalid.
|
|
113
|
+
* @property {string} [version] - The version of the event that is considered invalid.
|
|
114
|
+
* @property {string} [category] - The category of the event that is considered invalid.
|
|
115
|
+
* @property {string} [start_date] - The start date and time for the period
|
|
116
|
+
* during which events were considered invalid.
|
|
117
|
+
* @property {string} [end_date] - The end date and time for the period during
|
|
118
|
+
* which events were considered invalid.
|
|
65
119
|
*/
|
|
66
120
|
|
|
67
121
|
/**
|
|
68
|
-
* @typedef
|
|
69
|
-
* @property {string} [event_name]
|
|
70
|
-
* @property {string} [event_type]
|
|
71
|
-
*
|
|
72
|
-
* @property {string} [
|
|
73
|
-
* @property {
|
|
122
|
+
* @typedef InvalidEventsResult
|
|
123
|
+
* @property {string} [event_name] - The name of the event that was found to be invalid.
|
|
124
|
+
* @property {string} [event_type] - The type of the invalid event, allowing for
|
|
125
|
+
* custom or non-enumerated values.
|
|
126
|
+
* @property {string} [version] - The version of the invalid event.
|
|
127
|
+
* @property {string} [category] - The category of the invalid event.
|
|
128
|
+
* @property {number} [count] - The number of occurrences of the invalid event.
|
|
74
129
|
*/
|
|
75
130
|
|
|
76
131
|
/**
|
|
77
132
|
* @typedef HistoryFilters
|
|
78
|
-
* @property {string[]} [events]
|
|
79
|
-
* @property {string} [search_text]
|
|
133
|
+
* @property {string[]} [events] - A list of event types to filter the history report.
|
|
134
|
+
* @property {string} [search_text] - Text used for searching within the history report.
|
|
80
135
|
* @property {string} [status] - The status of the history report (e.g., "FAILED").
|
|
81
136
|
* @property {string} [end_date] - The end date and time of the history report.
|
|
82
137
|
* @property {string} [start_date] - The start date and time of the history report.
|
|
83
138
|
* @property {number[]} [subscribers] - An array of subscriber IDs associated
|
|
84
139
|
* with the history report.
|
|
85
|
-
* @property {string[]} [webhook_type] - An array of webhook
|
|
86
|
-
*
|
|
140
|
+
* @property {string[]} [webhook_type] - An array of webhook types to identify
|
|
141
|
+
* the type of subscriber.
|
|
87
142
|
*/
|
|
88
143
|
|
|
89
144
|
/**
|
|
@@ -94,7 +149,8 @@ const Joi = require("joi");
|
|
|
94
149
|
|
|
95
150
|
/**
|
|
96
151
|
* @typedef CdnObject
|
|
97
|
-
* @property {Url[]} [urls]
|
|
152
|
+
* @property {Url[]} [urls] - A list of URLs for CDN objects, including the
|
|
153
|
+
* location of the uploaded report files.
|
|
98
154
|
*/
|
|
99
155
|
|
|
100
156
|
/**
|
|
@@ -104,103 +160,119 @@ const Joi = require("joi");
|
|
|
104
160
|
|
|
105
161
|
/**
|
|
106
162
|
* @typedef HistoryAssociation
|
|
107
|
-
* @property {number} [company_id]
|
|
108
|
-
*
|
|
163
|
+
* @property {number} [company_id] - The identifier for the company associated
|
|
164
|
+
* with the history report.
|
|
165
|
+
* @property {number[]} [subscriber_ids] - A list of subscriber IDs related to
|
|
166
|
+
* the history report.
|
|
109
167
|
*/
|
|
110
168
|
|
|
111
169
|
/**
|
|
112
170
|
* @typedef HistoryItems
|
|
113
|
-
* @property {number} [id] - The
|
|
171
|
+
* @property {number} [id] - The unique identifier for the history report.
|
|
114
172
|
* @property {HistoryAssociation} [association]
|
|
115
173
|
* @property {HistoryFilters} [filters]
|
|
116
|
-
* @property {string} [filename] - The
|
|
117
|
-
* @property {string} [status] - The status of the history report (e.g.,
|
|
174
|
+
* @property {string} [filename] - The name of the file containing the history report.
|
|
175
|
+
* @property {string} [status] - The current status of the history report (e.g.,
|
|
176
|
+
* "COMPLETED").
|
|
118
177
|
* @property {UploadServiceObject} [upload_service_response]
|
|
119
178
|
* @property {string} [created_on] - The date and time when the history report
|
|
120
|
-
* was
|
|
179
|
+
* was generated.
|
|
121
180
|
* @property {string} [updated_on] - The date and time when the history report
|
|
122
181
|
* was last updated.
|
|
123
182
|
* @property {string} [message] - A message related to the history report.
|
|
124
183
|
*/
|
|
125
184
|
|
|
126
185
|
/**
|
|
127
|
-
* @typedef
|
|
128
|
-
* @property {HistoryItems[]} [items]
|
|
186
|
+
* @typedef HistoryResult
|
|
187
|
+
* @property {HistoryItems[]} [items] - A list of history report items.
|
|
129
188
|
* @property {Page} [page]
|
|
130
189
|
*/
|
|
131
190
|
|
|
132
191
|
/**
|
|
133
192
|
* @typedef HistoryPayload
|
|
134
|
-
* @property {number} [company_id]
|
|
135
|
-
*
|
|
136
|
-
* @property {
|
|
137
|
-
*
|
|
193
|
+
* @property {number} [company_id] - The identifier for the company requesting
|
|
194
|
+
* the history report.
|
|
195
|
+
* @property {string} [type] - Specifies the type of history report requested
|
|
196
|
+
* (e.g., "platform").
|
|
197
|
+
* @property {number} [page_no] - The page number of the history report results.
|
|
198
|
+
* @property {number} [page_size] - The number of records to display per page in
|
|
199
|
+
* the history report.
|
|
138
200
|
*/
|
|
139
201
|
|
|
140
202
|
/**
|
|
141
|
-
* @typedef
|
|
142
|
-
* @property {string} [message]
|
|
143
|
-
*
|
|
203
|
+
* @typedef CancelDownloadResult
|
|
204
|
+
* @property {string} [message] - A message indicating the result of the cancel
|
|
205
|
+
* download request.
|
|
206
|
+
* @property {string} [result] - The outcome of the cancel download operation.
|
|
144
207
|
*/
|
|
145
208
|
|
|
146
209
|
/**
|
|
147
|
-
* @typedef
|
|
148
|
-
* @property {string} [filter_name]
|
|
149
|
-
* @property {Object[]} [values]
|
|
210
|
+
* @typedef FilterReportResult
|
|
211
|
+
* @property {string} [filter_name] - The name of the filter applied in the report.
|
|
212
|
+
* @property {Object[]} [values] - A list of values resulting from the applied filter.
|
|
150
213
|
*/
|
|
151
214
|
|
|
152
215
|
/**
|
|
153
|
-
* @typedef
|
|
154
|
-
* @property {DeliveryTsSchema[]} [delivery_ts]
|
|
216
|
+
* @typedef DeliveryTsResult
|
|
217
|
+
* @property {DeliveryTsSchema[]} [delivery_ts] - List of delivery timestamps.
|
|
155
218
|
*/
|
|
156
219
|
|
|
157
220
|
/**
|
|
158
221
|
* @typedef DeliveryTsSchema
|
|
159
|
-
* @property {string} [timestamp]
|
|
160
|
-
* @property {number} [failed]
|
|
161
|
-
* @property {number} [removed_webhooks]
|
|
162
|
-
* @property {number} [success]
|
|
222
|
+
* @property {string} [timestamp] - The timestamp of the delivery event.
|
|
223
|
+
* @property {number} [failed] - The count of failed delivery attempts.
|
|
224
|
+
* @property {number} [removed_webhooks] - The count of removed webhooks during delivery.
|
|
225
|
+
* @property {number} [success] - The count of successful delivery attempts.
|
|
163
226
|
*/
|
|
164
227
|
|
|
165
228
|
/**
|
|
166
|
-
* @typedef
|
|
167
|
-
* @property {string} [company_id]
|
|
168
|
-
*
|
|
169
|
-
* @property {number} [
|
|
170
|
-
* @property {
|
|
171
|
-
* @property {string} [
|
|
172
|
-
*
|
|
173
|
-
* @property {string} [
|
|
229
|
+
* @typedef DeliveryDetailsPayload
|
|
230
|
+
* @property {string} [company_id] - The identifier for the company requesting
|
|
231
|
+
* delivery details.
|
|
232
|
+
* @property {number} [page_no] - The page number for the delivery details results.
|
|
233
|
+
* @property {number} [page_size] - The number of records per page for delivery details.
|
|
234
|
+
* @property {string} [start_date] - The start date and time for filtering
|
|
235
|
+
* delivery details.
|
|
236
|
+
* @property {string} [end_date] - The end date and time for filtering delivery details.
|
|
237
|
+
* @property {EventDeliveryDetailSchema[]} [event] - A list of event delivery details.
|
|
238
|
+
* @property {string} [status] - The status of the delivery details request.
|
|
174
239
|
*/
|
|
175
240
|
|
|
176
241
|
/**
|
|
177
242
|
* @typedef EventDeliveryDetailSchema
|
|
178
|
-
* @property {string} [event_name]
|
|
179
|
-
*
|
|
180
|
-
* @property {string} [
|
|
181
|
-
*
|
|
243
|
+
* @property {string} [event_name] - The name of the event related to the
|
|
244
|
+
* delivery details.
|
|
245
|
+
* @property {string} [event_type] - The type of the event, allowing for custom
|
|
246
|
+
* or non-enumerated values.
|
|
247
|
+
* @property {string} [event_category] - The category of the event, allowing for
|
|
248
|
+
* custom or non-enumerated values.
|
|
249
|
+
* @property {string} [version] - The version of the event related to the
|
|
250
|
+
* delivery details.
|
|
182
251
|
*/
|
|
183
252
|
|
|
184
253
|
/**
|
|
185
|
-
* @typedef
|
|
186
|
-
* @property {EventProcessReportObject[]} [rows]
|
|
254
|
+
* @typedef DeliveryDetailsResult
|
|
255
|
+
* @property {EventProcessReportObject[]} [rows] - A list of processed event
|
|
256
|
+
* reports with delivery details.
|
|
187
257
|
* @property {Page} [page]
|
|
188
258
|
*/
|
|
189
259
|
|
|
190
260
|
/**
|
|
191
261
|
* @typedef EventProcessReportObject
|
|
192
262
|
* @property {string} [event_name] - The name of the processed event.
|
|
193
|
-
* @property {number} [response_code] - The response code
|
|
194
|
-
*
|
|
195
|
-
* @property {string} [
|
|
196
|
-
* @property {
|
|
197
|
-
* @property {number} [
|
|
198
|
-
* @property {
|
|
263
|
+
* @property {number} [response_code] - The response code returned for the
|
|
264
|
+
* event, allowing for custom or non-enumerated values.
|
|
265
|
+
* @property {string} [response_message] - The response message associated with the event.
|
|
266
|
+
* @property {string} [data] - The data payload associated with the event.
|
|
267
|
+
* @property {number} [attempt] - The attempt number for processing the event.
|
|
268
|
+
* @property {number} [last_attempted_on] - The timestamp of the last attempt to
|
|
269
|
+
* process the event.
|
|
270
|
+
* @property {string} [status] - The status of the event processing (e.g., "FAILED").
|
|
199
271
|
* @property {string} [name] - The name of the event.
|
|
200
|
-
* @property {string} [webhook_url] - The webhook
|
|
201
|
-
* @property {number} [response_time] - The
|
|
202
|
-
* @property {string} [message_id]
|
|
203
|
-
* @property {string} [event_trace_id]
|
|
272
|
+
* @property {string} [webhook_url] - The URL of the webhook associated with the event.
|
|
273
|
+
* @property {number} [response_time] - The time taken to respond to the event.
|
|
274
|
+
* @property {string} [message_id] - The identifier for the event message.
|
|
275
|
+
* @property {string} [event_trace_id] - The trace ID associated with the event.
|
|
204
276
|
*/
|
|
205
277
|
|
|
206
278
|
/**
|
|
@@ -212,74 +284,86 @@ const Joi = require("joi");
|
|
|
212
284
|
* @property {number} [current] - The current page number.
|
|
213
285
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
214
286
|
* @property {number} [size] - The number of items per page.
|
|
215
|
-
* @property {number} [
|
|
287
|
+
* @property {number} [page_size] - The number of items per page.
|
|
216
288
|
*/
|
|
217
289
|
|
|
218
290
|
/**
|
|
219
291
|
* @typedef DeliveryEventLevelSchema
|
|
220
|
-
* @property {string} [event]
|
|
221
|
-
* @property {number} [success]
|
|
222
|
-
* @property {number} [failed]
|
|
223
|
-
* @property {number} [failed_percentage]
|
|
224
|
-
*
|
|
225
|
-
* @property {number} [
|
|
226
|
-
*
|
|
292
|
+
* @property {string} [event] - The name or identifier of the event.
|
|
293
|
+
* @property {number} [success] - The count of successful deliveries for the event.
|
|
294
|
+
* @property {number} [failed] - The count of failed deliveries for the event.
|
|
295
|
+
* @property {number} [failed_percentage] - The percentage of failed deliveries
|
|
296
|
+
* relative to the total.
|
|
297
|
+
* @property {number} [removed_webhooks] - The count of webhooks that were
|
|
298
|
+
* removed during the delivery.
|
|
299
|
+
* @property {number} [total] - The total number of delivery attempts for the event.
|
|
300
|
+
* @property {number} [response_time] - The average response time for the event
|
|
301
|
+
* deliveries.
|
|
227
302
|
*/
|
|
228
303
|
|
|
229
304
|
/**
|
|
230
305
|
* @typedef ResponseTimeTs
|
|
231
|
-
* @property {AvgResponseTime[]} [avg_response_time_ts]
|
|
306
|
+
* @property {AvgResponseTime[]} [avg_response_time_ts] - List of average
|
|
307
|
+
* response time timestamps.
|
|
232
308
|
*/
|
|
233
309
|
|
|
234
310
|
/**
|
|
235
311
|
* @typedef AvgResponseTime
|
|
236
|
-
* @property {string} [timestamp
|
|
237
|
-
*
|
|
312
|
+
* @property {string} [last_attempted_on] - The timestamp of the last attempt,
|
|
313
|
+
* formatted as a string.
|
|
314
|
+
* @property {number} [response_code] - The response code returned for the
|
|
315
|
+
* delivery attempt, allowing for custom or non-enumerated values.
|
|
316
|
+
* @property {string} [response_time] - The response time for the delivery
|
|
317
|
+
* attempt, formatted as a string.
|
|
318
|
+
* @property {number} [attempt] - The attempt number for the delivery.
|
|
319
|
+
* @property {number} [total] - The total count of deliveries attempted.
|
|
238
320
|
*/
|
|
239
321
|
|
|
240
322
|
/**
|
|
241
|
-
* @typedef
|
|
242
|
-
* @property {DeliveryEventLevelSchema[]} [delivery_event_level]
|
|
323
|
+
* @typedef DeliverySummaryResult
|
|
324
|
+
* @property {DeliveryEventLevelSchema[]} [delivery_event_level] - List of
|
|
325
|
+
* delivery event levels.
|
|
243
326
|
* @property {DeliverySummarySchema} [delivery_summary]
|
|
244
327
|
*/
|
|
245
328
|
|
|
246
329
|
/**
|
|
247
330
|
* @typedef DeliverySummarySchema
|
|
248
|
-
* @property {number} [success]
|
|
249
|
-
* @property {number} [response_time]
|
|
250
|
-
* @property {number} [failed_percentage]
|
|
251
|
-
* @property {number} [removed_webhooks]
|
|
331
|
+
* @property {number} [success] - The total count of successful deliveries.
|
|
332
|
+
* @property {number} [response_time] - The average response time for deliveries.
|
|
333
|
+
* @property {number} [failed_percentage] - The percentage of failed deliveries.
|
|
334
|
+
* @property {number} [removed_webhooks] - The count of webhooks removed during delivery.
|
|
252
335
|
*/
|
|
253
336
|
|
|
254
337
|
/**
|
|
255
338
|
* @typedef ItemSchema
|
|
256
|
-
* @property {number} [id]
|
|
257
|
-
* @property {string} [modified_by]
|
|
258
|
-
* @property {string} [name]
|
|
259
|
-
* @property {string} [webhook_url]
|
|
260
|
-
* @property {string} [provider]
|
|
339
|
+
* @property {number} [id] - The unique identifier for the item.
|
|
340
|
+
* @property {string} [modified_by] - The user or system that last modified the item.
|
|
341
|
+
* @property {string} [name] - The name of the item.
|
|
342
|
+
* @property {string} [webhook_url] - The URL of the webhook associated with the item.
|
|
343
|
+
* @property {string} [provider] - The provider of the item.
|
|
261
344
|
* @property {Association} [association]
|
|
262
|
-
* @property {Object} [custom_headers]
|
|
263
|
-
* @property {string} [status]
|
|
264
|
-
* @property {string} [email_id]
|
|
265
|
-
* @property {string} [updated_on]
|
|
266
|
-
* @property {string} [created_on]
|
|
267
|
-
* @property {string} [type]
|
|
345
|
+
* @property {Object} [custom_headers] - Custom headers associated with the item, if any.
|
|
346
|
+
* @property {string} [status] - The current status of the item.
|
|
347
|
+
* @property {string} [email_id] - The email ID associated with the item, if applicable.
|
|
348
|
+
* @property {string} [updated_on] - The date and time when the item was last updated.
|
|
349
|
+
* @property {string} [created_on] - The date and time when the item was created.
|
|
350
|
+
* @property {string} [type] - The type of the item, if applicable.
|
|
268
351
|
* @property {AuthMeta} [auth_meta]
|
|
269
|
-
* @property {
|
|
270
|
-
*
|
|
352
|
+
* @property {EventConfigDetails[]} [event_configs] - A list of event
|
|
353
|
+
* configurations associated with the item.
|
|
354
|
+
* @property {number[]} [event_id] - A list of event IDs associated with the item.
|
|
271
355
|
*/
|
|
272
356
|
|
|
273
357
|
class WebhookPartnerModel {
|
|
274
|
-
/** @returns {
|
|
275
|
-
static
|
|
358
|
+
/** @returns {SubscriberUpdate} */
|
|
359
|
+
static SubscriberUpdate() {
|
|
276
360
|
return Joi.object({
|
|
277
361
|
status: Joi.string().allow(""),
|
|
278
362
|
});
|
|
279
363
|
}
|
|
280
364
|
|
|
281
|
-
/** @returns {
|
|
282
|
-
static
|
|
365
|
+
/** @returns {SubscriberUpdateResult} */
|
|
366
|
+
static SubscriberUpdateResult() {
|
|
283
367
|
return Joi.object({
|
|
284
368
|
message: Joi.string().allow(""),
|
|
285
369
|
});
|
|
@@ -303,19 +387,43 @@ class WebhookPartnerModel {
|
|
|
303
387
|
});
|
|
304
388
|
}
|
|
305
389
|
|
|
390
|
+
/** @returns {BroadcasterConfig} */
|
|
391
|
+
static BroadcasterConfig() {
|
|
392
|
+
return Joi.object({
|
|
393
|
+
topic: Joi.string().allow(""),
|
|
394
|
+
queue: Joi.string().allow(""),
|
|
395
|
+
event_bridge_name: Joi.string().allow(""),
|
|
396
|
+
workflow_name: Joi.string().allow(""),
|
|
397
|
+
account_id: Joi.string().allow(""),
|
|
398
|
+
detail_type: Joi.string().allow(""),
|
|
399
|
+
}).allow(null);
|
|
400
|
+
}
|
|
401
|
+
|
|
306
402
|
/** @returns {SubscriberEventMapping} */
|
|
307
403
|
static SubscriberEventMapping() {
|
|
308
404
|
return Joi.object({
|
|
309
405
|
id: Joi.number(),
|
|
310
406
|
event_id: Joi.number(),
|
|
311
407
|
subscriber_id: Joi.number(),
|
|
312
|
-
|
|
408
|
+
filters: WebhookPartnerModel.FilterSchema(),
|
|
409
|
+
reducer: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
410
|
+
broadcaster_config: WebhookPartnerModel.BroadcasterConfig(),
|
|
313
411
|
created_on: Joi.string().allow(""),
|
|
314
412
|
});
|
|
315
413
|
}
|
|
316
414
|
|
|
317
|
-
/** @returns {
|
|
318
|
-
static
|
|
415
|
+
/** @returns {FilterSchema} */
|
|
416
|
+
static FilterSchema() {
|
|
417
|
+
return Joi.object({
|
|
418
|
+
query: Joi.string().allow(""),
|
|
419
|
+
condition: Joi.string().allow(""),
|
|
420
|
+
logic: Joi.string().allow(""),
|
|
421
|
+
conditions: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
422
|
+
}).allow(null);
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
/** @returns {EventConfigDetails} */
|
|
426
|
+
static EventConfigDetails() {
|
|
319
427
|
return Joi.object({
|
|
320
428
|
id: Joi.number(),
|
|
321
429
|
event_name: Joi.string().allow(""),
|
|
@@ -332,16 +440,16 @@ class WebhookPartnerModel {
|
|
|
332
440
|
});
|
|
333
441
|
}
|
|
334
442
|
|
|
335
|
-
/** @returns {
|
|
336
|
-
static
|
|
443
|
+
/** @returns {SubscriberConfigDetails} */
|
|
444
|
+
static SubscriberConfigDetails() {
|
|
337
445
|
return Joi.object({
|
|
338
446
|
items: Joi.array().items(WebhookPartnerModel.ItemSchema()),
|
|
339
447
|
page: WebhookPartnerModel.Page(),
|
|
340
448
|
});
|
|
341
449
|
}
|
|
342
450
|
|
|
343
|
-
/** @returns {
|
|
344
|
-
static
|
|
451
|
+
/** @returns {InvalidEventsPayload} */
|
|
452
|
+
static InvalidEventsPayload() {
|
|
345
453
|
return Joi.object({
|
|
346
454
|
event_name: Joi.string().allow(""),
|
|
347
455
|
version: Joi.string().allow(""),
|
|
@@ -351,8 +459,8 @@ class WebhookPartnerModel {
|
|
|
351
459
|
});
|
|
352
460
|
}
|
|
353
461
|
|
|
354
|
-
/** @returns {
|
|
355
|
-
static
|
|
462
|
+
/** @returns {InvalidEventsResult} */
|
|
463
|
+
static InvalidEventsResult() {
|
|
356
464
|
return Joi.object({
|
|
357
465
|
event_name: Joi.string().allow(""),
|
|
358
466
|
event_type: Joi.string().allow(""),
|
|
@@ -420,8 +528,8 @@ class WebhookPartnerModel {
|
|
|
420
528
|
});
|
|
421
529
|
}
|
|
422
530
|
|
|
423
|
-
/** @returns {
|
|
424
|
-
static
|
|
531
|
+
/** @returns {HistoryResult} */
|
|
532
|
+
static HistoryResult() {
|
|
425
533
|
return Joi.object({
|
|
426
534
|
items: Joi.array().items(WebhookPartnerModel.HistoryItems()),
|
|
427
535
|
page: WebhookPartnerModel.Page(),
|
|
@@ -438,24 +546,24 @@ class WebhookPartnerModel {
|
|
|
438
546
|
});
|
|
439
547
|
}
|
|
440
548
|
|
|
441
|
-
/** @returns {
|
|
442
|
-
static
|
|
549
|
+
/** @returns {CancelDownloadResult} */
|
|
550
|
+
static CancelDownloadResult() {
|
|
443
551
|
return Joi.object({
|
|
444
552
|
message: Joi.string().allow(""),
|
|
445
553
|
result: Joi.string().allow(""),
|
|
446
554
|
});
|
|
447
555
|
}
|
|
448
556
|
|
|
449
|
-
/** @returns {
|
|
450
|
-
static
|
|
557
|
+
/** @returns {FilterReportResult} */
|
|
558
|
+
static FilterReportResult() {
|
|
451
559
|
return Joi.object({
|
|
452
560
|
filter_name: Joi.string().allow(""),
|
|
453
561
|
values: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
454
562
|
});
|
|
455
563
|
}
|
|
456
564
|
|
|
457
|
-
/** @returns {
|
|
458
|
-
static
|
|
565
|
+
/** @returns {DeliveryTsResult} */
|
|
566
|
+
static DeliveryTsResult() {
|
|
459
567
|
return Joi.object({
|
|
460
568
|
delivery_ts: Joi.array().items(WebhookPartnerModel.DeliveryTsSchema()),
|
|
461
569
|
});
|
|
@@ -471,8 +579,8 @@ class WebhookPartnerModel {
|
|
|
471
579
|
});
|
|
472
580
|
}
|
|
473
581
|
|
|
474
|
-
/** @returns {
|
|
475
|
-
static
|
|
582
|
+
/** @returns {DeliveryDetailsPayload} */
|
|
583
|
+
static DeliveryDetailsPayload() {
|
|
476
584
|
return Joi.object({
|
|
477
585
|
company_id: Joi.string().allow(""),
|
|
478
586
|
page_no: Joi.number(),
|
|
@@ -494,8 +602,8 @@ class WebhookPartnerModel {
|
|
|
494
602
|
});
|
|
495
603
|
}
|
|
496
604
|
|
|
497
|
-
/** @returns {
|
|
498
|
-
static
|
|
605
|
+
/** @returns {DeliveryDetailsResult} */
|
|
606
|
+
static DeliveryDetailsResult() {
|
|
499
607
|
return Joi.object({
|
|
500
608
|
rows: Joi.array().items(WebhookPartnerModel.EventProcessReportObject()),
|
|
501
609
|
page: WebhookPartnerModel.Page(),
|
|
@@ -530,7 +638,7 @@ class WebhookPartnerModel {
|
|
|
530
638
|
current: Joi.number(),
|
|
531
639
|
type: Joi.string().allow("").required(),
|
|
532
640
|
size: Joi.number(),
|
|
533
|
-
|
|
641
|
+
page_size: Joi.number(),
|
|
534
642
|
});
|
|
535
643
|
}
|
|
536
644
|
|
|
@@ -559,13 +667,16 @@ class WebhookPartnerModel {
|
|
|
559
667
|
/** @returns {AvgResponseTime} */
|
|
560
668
|
static AvgResponseTime() {
|
|
561
669
|
return Joi.object({
|
|
562
|
-
|
|
563
|
-
|
|
670
|
+
last_attempted_on: Joi.string().allow(""),
|
|
671
|
+
response_code: Joi.number(),
|
|
672
|
+
response_time: Joi.string().allow(""),
|
|
673
|
+
attempt: Joi.number(),
|
|
674
|
+
total: Joi.number(),
|
|
564
675
|
});
|
|
565
676
|
}
|
|
566
677
|
|
|
567
|
-
/** @returns {
|
|
568
|
-
static
|
|
678
|
+
/** @returns {DeliverySummaryResult} */
|
|
679
|
+
static DeliverySummaryResult() {
|
|
569
680
|
return Joi.object({
|
|
570
681
|
delivery_event_level: Joi.array().items(
|
|
571
682
|
WebhookPartnerModel.DeliveryEventLevelSchema()
|
|
@@ -593,7 +704,7 @@ class WebhookPartnerModel {
|
|
|
593
704
|
webhook_url: Joi.string().allow(""),
|
|
594
705
|
provider: Joi.string().allow(""),
|
|
595
706
|
association: WebhookPartnerModel.Association(),
|
|
596
|
-
custom_headers: Joi.any(),
|
|
707
|
+
custom_headers: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
597
708
|
status: Joi.string().allow(""),
|
|
598
709
|
email_id: Joi.string().allow(""),
|
|
599
710
|
updated_on: Joi.string().allow(""),
|
|
@@ -601,7 +712,7 @@ class WebhookPartnerModel {
|
|
|
601
712
|
type: Joi.string().allow("").allow(null),
|
|
602
713
|
auth_meta: WebhookPartnerModel.AuthMeta(),
|
|
603
714
|
event_configs: Joi.array().items(
|
|
604
|
-
WebhookPartnerModel.
|
|
715
|
+
WebhookPartnerModel.EventConfigDetails()
|
|
605
716
|
),
|
|
606
717
|
event_id: Joi.array().items(Joi.number()),
|
|
607
718
|
});
|