@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
- package/sdk/application/Cart/CartApplicationClient.js +157 -530
- 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 +65 -55
- package/sdk/application/Content/ContentApplicationClient.js +211 -341
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
- 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 +32 -87
- package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
- 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 +18 -62
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
- 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 +15 -406
- package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
- package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
- package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
- package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
- 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 +236 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
- 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 +314 -422
- package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
- 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 -68
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
- 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 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
- 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 +565 -1282
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
- 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 -246
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
- 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 +2374 -877
- package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
- 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 +421 -418
- package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
- package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
- 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 +934 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -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 +1327 -3529
- package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
- 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 -513
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
- 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 -4
- package/sdk/platform/Share/SharePlatformModel.js +45 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
- 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 -2
- package/sdk/public/PublicClient.js +2 -2
- 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 -1
- package/sdk/public/index.js +1 -1
- 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
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @typedef ValidationError
|
|
5
|
+
* @property {string} message - A brief description of the error encountered.
|
|
6
|
+
* @property {string} field - The field in the request that caused the error.
|
|
7
|
+
*/
|
|
8
|
+
|
|
3
9
|
/**
|
|
4
10
|
* @typedef GenerateSEOContent
|
|
5
11
|
* @property {string} [text]
|
|
@@ -25,7 +31,6 @@ const Joi = require("joi");
|
|
|
25
31
|
* @property {string} [_id]
|
|
26
32
|
* @property {string} [updated_at]
|
|
27
33
|
* @property {string} [created_at]
|
|
28
|
-
* @property {number} [__v]
|
|
29
34
|
*/
|
|
30
35
|
|
|
31
36
|
/**
|
|
@@ -42,7 +47,7 @@ const Joi = require("joi");
|
|
|
42
47
|
* @property {string} [redirect_to]
|
|
43
48
|
* @property {string} [updated_at]
|
|
44
49
|
* @property {string} [created_at]
|
|
45
|
-
* @property {
|
|
50
|
+
* @property {PathSourceSchema} [__source]
|
|
46
51
|
*/
|
|
47
52
|
|
|
48
53
|
/**
|
|
@@ -58,8 +63,8 @@ const Joi = require("joi");
|
|
|
58
63
|
|
|
59
64
|
/**
|
|
60
65
|
* @typedef SeoSchema
|
|
61
|
-
* @property {string} [_id]
|
|
62
66
|
* @property {string} [app]
|
|
67
|
+
* @property {string} [_id]
|
|
63
68
|
* @property {string} [robots_txt]
|
|
64
69
|
* @property {boolean} [sitemap_enabled]
|
|
65
70
|
* @property {string} [additional_sitemap]
|
|
@@ -68,8 +73,6 @@ const Joi = require("joi");
|
|
|
68
73
|
* @property {Detail} [details]
|
|
69
74
|
* @property {string} [created_at]
|
|
70
75
|
* @property {string} [updated_at]
|
|
71
|
-
* @property {number} [__v]
|
|
72
|
-
* @property {SEOSitemap} [sitemap]
|
|
73
76
|
*/
|
|
74
77
|
|
|
75
78
|
/**
|
|
@@ -94,55 +97,28 @@ const Joi = require("joi");
|
|
|
94
97
|
|
|
95
98
|
/**
|
|
96
99
|
* @typedef SEOSchemaMarkupTemplate
|
|
97
|
-
* @property {string} [
|
|
100
|
+
* @property {string} [id]
|
|
98
101
|
* @property {string} [title]
|
|
99
102
|
* @property {string} [page_type]
|
|
100
103
|
* @property {string} [schema]
|
|
101
104
|
* @property {string} [description]
|
|
102
105
|
* @property {boolean} [active]
|
|
103
|
-
* @property {string} [application]
|
|
104
106
|
* @property {string} [created_at]
|
|
105
107
|
* @property {string} [updated_at]
|
|
108
|
+
* @property {string} [application]
|
|
106
109
|
* @property {Object} [target_json]
|
|
107
|
-
* @property {number} [__v]
|
|
108
110
|
*/
|
|
109
111
|
|
|
110
112
|
/**
|
|
111
113
|
* @typedef SEOSchemaMarkupTemplateRequestBody
|
|
112
114
|
* @property {string} [title]
|
|
113
115
|
* @property {string} [page_type]
|
|
114
|
-
* @property {string} [description]
|
|
115
116
|
* @property {string} [schema]
|
|
117
|
+
* @property {string} [description]
|
|
116
118
|
* @property {Object} [target_json]
|
|
117
119
|
* @property {boolean} [active]
|
|
118
120
|
* @property {string} [created_at]
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
/**
|
|
122
|
-
* @typedef DeletPathMappingSchema
|
|
123
|
-
* @property {string} [message]
|
|
124
|
-
* @property {PathMappingSchema} [data]
|
|
125
|
-
*/
|
|
126
|
-
|
|
127
|
-
/**
|
|
128
|
-
* @typedef CreatePathMappingSchema
|
|
129
|
-
* @property {string} [message]
|
|
130
|
-
* @property {PathMappingSchema} [data]
|
|
131
|
-
*/
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* @typedef GetAllPathMappingSchema
|
|
135
|
-
* @property {string} [message]
|
|
136
|
-
* @property {GetPathSchema} [data]
|
|
137
|
-
*/
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
* @typedef GetPathSchema
|
|
141
|
-
* @property {PathMappingSchema[]} [docs]
|
|
142
|
-
* @property {number} [page]
|
|
143
|
-
* @property {number} [limit]
|
|
144
|
-
* @property {number} [pages]
|
|
145
|
-
* @property {number} [total]
|
|
121
|
+
* @property {string} [updated_at]
|
|
146
122
|
*/
|
|
147
123
|
|
|
148
124
|
/**
|
|
@@ -189,11 +165,11 @@ const Joi = require("joi");
|
|
|
189
165
|
* @typedef DefaultSEOSchemaMarkupTemplate
|
|
190
166
|
* @property {string} [page_type]
|
|
191
167
|
* @property {string} [schema]
|
|
168
|
+
* @property {Object} [target_json]
|
|
192
169
|
*/
|
|
193
170
|
|
|
194
171
|
/**
|
|
195
172
|
* @typedef ScheduleSchema
|
|
196
|
-
* @property {boolean} [published]
|
|
197
173
|
* @property {string} [cron]
|
|
198
174
|
* @property {string} [start]
|
|
199
175
|
* @property {string} [end]
|
|
@@ -208,7 +184,7 @@ const Joi = require("joi");
|
|
|
208
184
|
*/
|
|
209
185
|
|
|
210
186
|
/**
|
|
211
|
-
* @typedef
|
|
187
|
+
* @typedef BlogGetDetails
|
|
212
188
|
* @property {BlogSchema[]} [items]
|
|
213
189
|
* @property {Page} [page]
|
|
214
190
|
* @property {BlogFilters} [filters]
|
|
@@ -236,7 +212,7 @@ const Joi = require("joi");
|
|
|
236
212
|
* @typedef Author
|
|
237
213
|
* @property {string} [designation]
|
|
238
214
|
* @property {string} [id]
|
|
239
|
-
* @property {string} [name]
|
|
215
|
+
* @property {string} [name] - Name of the author
|
|
240
216
|
*/
|
|
241
217
|
|
|
242
218
|
/**
|
|
@@ -257,7 +233,6 @@ const Joi = require("joi");
|
|
|
257
233
|
* @property {string} [title]
|
|
258
234
|
* @property {DateMeta} [date_meta]
|
|
259
235
|
* @property {string} [summary]
|
|
260
|
-
* @property {string} [status]
|
|
261
236
|
*/
|
|
262
237
|
|
|
263
238
|
/**
|
|
@@ -267,7 +242,7 @@ const Joi = require("joi");
|
|
|
267
242
|
* @property {string} [title]
|
|
268
243
|
* @property {SEOMetaItem[]} [meta_tags]
|
|
269
244
|
* @property {SEOSitemap} [sitemap]
|
|
270
|
-
* @property {SEObreadcrumb[]} [
|
|
245
|
+
* @property {SEObreadcrumb[]} [breadcrumb]
|
|
271
246
|
* @property {string} [canonical_url]
|
|
272
247
|
*/
|
|
273
248
|
|
|
@@ -307,7 +282,7 @@ const Joi = require("joi");
|
|
|
307
282
|
*/
|
|
308
283
|
|
|
309
284
|
/**
|
|
310
|
-
* @typedef
|
|
285
|
+
* @typedef BlogPayload
|
|
311
286
|
* @property {string} [application]
|
|
312
287
|
* @property {Object} [_custom_json]
|
|
313
288
|
* @property {Author} [author]
|
|
@@ -318,7 +293,6 @@ const Joi = require("joi");
|
|
|
318
293
|
* @property {string} [slug]
|
|
319
294
|
* @property {string[]} [tags]
|
|
320
295
|
* @property {string} [title]
|
|
321
|
-
* @property {string} [publish_date]
|
|
322
296
|
* @property {SEO} [seo]
|
|
323
297
|
* @property {string} [summary]
|
|
324
298
|
*/
|
|
@@ -335,11 +309,6 @@ const Joi = require("joi");
|
|
|
335
309
|
* @property {AdminAnnouncementSchema} [data]
|
|
336
310
|
*/
|
|
337
311
|
|
|
338
|
-
/**
|
|
339
|
-
* @typedef DataLoaderItemsResponseSchema
|
|
340
|
-
* @property {DataLoaderResponseSchema[]} [items]
|
|
341
|
-
*/
|
|
342
|
-
|
|
343
312
|
/**
|
|
344
313
|
* @typedef DataLoaderResponseSchema
|
|
345
314
|
* @property {string} [application]
|
|
@@ -351,16 +320,12 @@ const Joi = require("joi");
|
|
|
351
320
|
* @property {string} [type]
|
|
352
321
|
* @property {string} [url]
|
|
353
322
|
* @property {string} [content]
|
|
354
|
-
* @property {string} [created_at]
|
|
355
|
-
* @property {string} [modified_at]
|
|
356
|
-
* @property {number} [__v]
|
|
357
|
-
* @property {boolean} [is_selected]
|
|
358
323
|
* @property {DataLoaderSourceSchema} [__source]
|
|
359
324
|
*/
|
|
360
325
|
|
|
361
326
|
/**
|
|
362
327
|
* @typedef DataLoaderResetResponseSchema
|
|
363
|
-
* @property {boolean} [
|
|
328
|
+
* @property {boolean} [reset]
|
|
364
329
|
*/
|
|
365
330
|
|
|
366
331
|
/**
|
|
@@ -389,6 +354,7 @@ const Joi = require("joi");
|
|
|
389
354
|
* @property {LocaleLanguage} [_locale_language]
|
|
390
355
|
* @property {string} [image]
|
|
391
356
|
* @property {string} [type]
|
|
357
|
+
* @property {Action} [action]
|
|
392
358
|
* @property {boolean} [active]
|
|
393
359
|
* @property {string} [display]
|
|
394
360
|
* @property {number} [sort_order]
|
|
@@ -396,13 +362,6 @@ const Joi = require("joi");
|
|
|
396
362
|
* @property {NavigationReference[]} [sub_navigation]
|
|
397
363
|
*/
|
|
398
364
|
|
|
399
|
-
/**
|
|
400
|
-
* @typedef AssignmentReference
|
|
401
|
-
* @property {string} [platform]
|
|
402
|
-
* @property {string} [orientation]
|
|
403
|
-
* @property {string} [position]
|
|
404
|
-
*/
|
|
405
|
-
|
|
406
365
|
/**
|
|
407
366
|
* @typedef CronBasedScheduleSchema
|
|
408
367
|
* @property {boolean} [enabled]
|
|
@@ -418,52 +377,82 @@ const Joi = require("joi");
|
|
|
418
377
|
|
|
419
378
|
/**
|
|
420
379
|
* @typedef HandpickedTagSchema
|
|
421
|
-
* @property {string} [position]
|
|
422
|
-
*
|
|
423
|
-
* @property {
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
*
|
|
380
|
+
* @property {string} [position] - The location in the page where the tag should
|
|
381
|
+
* be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
382
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
383
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
384
|
+
* tag type for example:
|
|
385
|
+
*
|
|
386
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
387
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
388
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
389
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
390
|
+
*
|
|
391
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
392
|
+
* third-party tag can be injected or supported.
|
|
393
|
+
* @property {string} [name] - The name of the tag used to identify it in the
|
|
394
|
+
* system. Example: 'Google External Script' or 'Bootstrap CSS'.
|
|
395
|
+
* @property {string} [url] - The URL where the external tag resource (such as a
|
|
396
|
+
* script or stylesheet) is hosted.
|
|
397
|
+
* @property {string} [type] - The type of the tag, such as 'script' (for
|
|
398
|
+
* JavaScript) or 'link' (for CSS).
|
|
399
|
+
* @property {string} [sub_type] - Defines whether the tag is embedded within
|
|
400
|
+
* the HTML (inline) or linked externally (external).
|
|
401
|
+
* @property {string} [content] - The actual content of the inline tag, such as
|
|
402
|
+
* JavaScript or CSS code if the tag is inline.
|
|
428
403
|
*/
|
|
429
404
|
|
|
430
405
|
/**
|
|
431
406
|
* @typedef RemoveHandpickedSchema
|
|
432
|
-
* @property {string[]} [tags]
|
|
407
|
+
* @property {string[]} [tags] - A list of tag IDs to remove from the system.
|
|
433
408
|
*/
|
|
434
409
|
|
|
435
410
|
/**
|
|
436
411
|
* @typedef CreateTagSchema
|
|
437
|
-
* @property {string} [name]
|
|
438
|
-
*
|
|
439
|
-
* @property {string} [
|
|
440
|
-
*
|
|
441
|
-
* @property {string} [
|
|
442
|
-
* @property {string} [
|
|
443
|
-
*
|
|
444
|
-
* @property {
|
|
445
|
-
*
|
|
412
|
+
* @property {string} [name] - The name of the tag to be created, used for
|
|
413
|
+
* identification purposes.
|
|
414
|
+
* @property {string} [sub_type] - Indicates if the tag is external (linked) or
|
|
415
|
+
* inline (embedded within the page).
|
|
416
|
+
* @property {string} [_id] - The unique identifier for the tag.
|
|
417
|
+
* @property {string} [type] - The type of the tag, either JavaScript ('js') or
|
|
418
|
+
* CSS ('css').
|
|
419
|
+
* @property {string} [url] - The external URL pointing to the script or
|
|
420
|
+
* stylesheet resource.
|
|
421
|
+
* @property {string} [position] - The position on the webpage where the tag
|
|
422
|
+
* will be injected, such as 'head', 'body-top', or 'body-bottom'.
|
|
423
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
424
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
425
|
+
* tag type for example:
|
|
426
|
+
*
|
|
427
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
428
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
429
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
430
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
431
|
+
*
|
|
432
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
433
|
+
* third-party tag can be injected or supported.
|
|
434
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be
|
|
435
|
+
* injected or active.
|
|
436
|
+
* @property {string} [content] - The inline content for tags of type 'inline'
|
|
437
|
+
* (e.g., JavaScript or CSS code).
|
|
446
438
|
*/
|
|
447
439
|
|
|
448
440
|
/**
|
|
449
441
|
* @typedef CreateTagRequestSchema
|
|
450
|
-
* @property {CreateTagSchema[]} [tags]
|
|
442
|
+
* @property {CreateTagSchema[]} [tags] - A list of tags to be created or
|
|
443
|
+
* updated, each containing details such as name, type, and attributes.
|
|
451
444
|
*/
|
|
452
445
|
|
|
453
446
|
/**
|
|
454
447
|
* @typedef DataLoaderSchema
|
|
455
|
-
* @property {string} [_id]
|
|
456
|
-
* @property {string} [url]
|
|
457
|
-
* @property {string} [created_at]
|
|
458
|
-
* @property {string} [modified_at]
|
|
459
|
-
* @property {string} [application]
|
|
460
|
-
* @property {string} [company]
|
|
461
448
|
* @property {string} [name]
|
|
462
449
|
* @property {string} [service]
|
|
463
450
|
* @property {string} [operation_id]
|
|
464
|
-
* @property {boolean} [is_selected]
|
|
465
451
|
* @property {string} [type]
|
|
452
|
+
* @property {string} [url]
|
|
453
|
+
* @property {string} [content]
|
|
466
454
|
* @property {DataLoaderSourceSchema} [__source]
|
|
455
|
+
* @property {string} [_id]
|
|
467
456
|
*/
|
|
468
457
|
|
|
469
458
|
/**
|
|
@@ -472,34 +461,15 @@ const Joi = require("joi");
|
|
|
472
461
|
* @property {string} [id]
|
|
473
462
|
*/
|
|
474
463
|
|
|
475
|
-
/**
|
|
476
|
-
* @typedef TagSpecSchema
|
|
477
|
-
* @property {string} [name]
|
|
478
|
-
* @property {string} [description]
|
|
479
|
-
*/
|
|
480
|
-
|
|
481
|
-
/**
|
|
482
|
-
* @typedef ServerSchema
|
|
483
|
-
* @property {string} [url]
|
|
484
|
-
*/
|
|
485
|
-
|
|
486
|
-
/**
|
|
487
|
-
* @typedef DataLoadersApiSpecSchema
|
|
488
|
-
* @property {Object} [info]
|
|
489
|
-
* @property {ServerSchema[]} [servers]
|
|
490
|
-
* @property {TagSpecSchema[]} [tags]
|
|
491
|
-
* @property {string} [openapi]
|
|
492
|
-
* @property {Object} [paths]
|
|
493
|
-
*/
|
|
494
|
-
|
|
495
464
|
/**
|
|
496
465
|
* @typedef DataLoadersSchema
|
|
497
466
|
* @property {DataLoaderSchema[]} [items]
|
|
498
467
|
*/
|
|
499
468
|
|
|
500
469
|
/**
|
|
501
|
-
* @typedef
|
|
502
|
-
* @property {boolean} [success]
|
|
470
|
+
* @typedef TagDeleteSuccessDetails
|
|
471
|
+
* @property {boolean} [success] - Indicates whether the tag removal operation
|
|
472
|
+
* was successful.
|
|
503
473
|
*/
|
|
504
474
|
|
|
505
475
|
/**
|
|
@@ -508,6 +478,7 @@ const Joi = require("joi");
|
|
|
508
478
|
* @property {number} [status]
|
|
509
479
|
* @property {string} [code]
|
|
510
480
|
* @property {string} [exception]
|
|
481
|
+
* @property {string} [info]
|
|
511
482
|
* @property {string} [request_id]
|
|
512
483
|
* @property {string} [stack_trace]
|
|
513
484
|
* @property {Object} [meta]
|
|
@@ -529,7 +500,6 @@ const Joi = require("joi");
|
|
|
529
500
|
* @property {string} [application]
|
|
530
501
|
* @property {string} [icon_url]
|
|
531
502
|
* @property {Object} [_custom_json]
|
|
532
|
-
* @property {number} [__v]
|
|
533
503
|
*/
|
|
534
504
|
|
|
535
505
|
/**
|
|
@@ -549,15 +519,15 @@ const Joi = require("joi");
|
|
|
549
519
|
|
|
550
520
|
/**
|
|
551
521
|
* @typedef FAQCategorySchema
|
|
552
|
-
* @property {
|
|
553
|
-
* @property {string} [application]
|
|
522
|
+
* @property {number} [index]
|
|
554
523
|
* @property {string} [title]
|
|
555
524
|
* @property {string} [description]
|
|
556
|
-
* @property {number} [index]
|
|
557
|
-
* @property {string} [slug]
|
|
558
525
|
* @property {ChildrenSchema[]} [children]
|
|
526
|
+
* @property {string} [_id]
|
|
527
|
+
* @property {string} [slug]
|
|
528
|
+
* @property {string} [application]
|
|
559
529
|
* @property {string} [icon_url]
|
|
560
|
-
* @property {
|
|
530
|
+
* @property {Object} [_custom_json]
|
|
561
531
|
*/
|
|
562
532
|
|
|
563
533
|
/**
|
|
@@ -568,7 +538,6 @@ const Joi = require("joi");
|
|
|
568
538
|
* @property {string} [question]
|
|
569
539
|
* @property {string} [answer]
|
|
570
540
|
* @property {string[]} [tags]
|
|
571
|
-
* @property {number} [__v]
|
|
572
541
|
*/
|
|
573
542
|
|
|
574
543
|
/**
|
|
@@ -627,11 +596,11 @@ const Joi = require("joi");
|
|
|
627
596
|
* @property {number} [current] - The current page number.
|
|
628
597
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
629
598
|
* @property {number} [size] - The number of items per page.
|
|
630
|
-
* @property {number} [
|
|
599
|
+
* @property {number} [page_size] - The number of items per page.
|
|
631
600
|
*/
|
|
632
601
|
|
|
633
602
|
/**
|
|
634
|
-
* @typedef
|
|
603
|
+
* @typedef LandingPageGetDetails
|
|
635
604
|
* @property {LandingPageSchema[]} [items]
|
|
636
605
|
* @property {Page} [page]
|
|
637
606
|
*/
|
|
@@ -639,6 +608,7 @@ const Joi = require("joi");
|
|
|
639
608
|
/**
|
|
640
609
|
* @typedef LandingPageSchema
|
|
641
610
|
* @property {string} [slug]
|
|
611
|
+
* @property {Action} [action]
|
|
642
612
|
* @property {string[]} [platform]
|
|
643
613
|
* @property {CreatedBySchema} [created_by]
|
|
644
614
|
* @property {DateMeta} [date_meta]
|
|
@@ -646,16 +616,15 @@ const Joi = require("joi");
|
|
|
646
616
|
* @property {string} [application]
|
|
647
617
|
* @property {boolean} [archived]
|
|
648
618
|
* @property {Object} [_custom_json]
|
|
649
|
-
* @property {number} [__v]
|
|
650
619
|
*/
|
|
651
620
|
|
|
652
621
|
/**
|
|
653
|
-
* @typedef
|
|
622
|
+
* @typedef DefaultNavigationDetails
|
|
654
623
|
* @property {NavigationSchema[]} [items]
|
|
655
624
|
*/
|
|
656
625
|
|
|
657
626
|
/**
|
|
658
|
-
* @typedef
|
|
627
|
+
* @typedef NavigationGetDetails
|
|
659
628
|
* @property {NavigationSchema[]} [items]
|
|
660
629
|
* @property {Page} [page]
|
|
661
630
|
*/
|
|
@@ -679,29 +648,19 @@ const Joi = require("joi");
|
|
|
679
648
|
* @property {Orientation} [orientation]
|
|
680
649
|
* @property {number} [version]
|
|
681
650
|
* @property {NavigationReference[]} [navigation]
|
|
682
|
-
* @property {AssignmentReference[]} [assignments]
|
|
683
|
-
* @property {number} [__v]
|
|
684
651
|
*/
|
|
685
652
|
|
|
686
653
|
/**
|
|
687
|
-
* @typedef
|
|
654
|
+
* @typedef NavigationPayload
|
|
688
655
|
* @property {string} [name]
|
|
689
656
|
* @property {string} [slug]
|
|
690
657
|
* @property {string[]} [platform]
|
|
691
658
|
* @property {Orientation} [orientation]
|
|
692
|
-
* @property {NavigationAssignment[]} [assignments]
|
|
693
659
|
* @property {NavigationReference[]} [navigation]
|
|
694
660
|
*/
|
|
695
661
|
|
|
696
662
|
/**
|
|
697
|
-
* @typedef
|
|
698
|
-
* @property {string} [platform]
|
|
699
|
-
* @property {string} [orientation]
|
|
700
|
-
* @property {string} [position]
|
|
701
|
-
*/
|
|
702
|
-
|
|
703
|
-
/**
|
|
704
|
-
* @typedef PageGetResponse
|
|
663
|
+
* @typedef PageGetDetails
|
|
705
664
|
* @property {PageSchema[]} [items]
|
|
706
665
|
* @property {Page} [page]
|
|
707
666
|
*/
|
|
@@ -725,52 +684,31 @@ const Joi = require("joi");
|
|
|
725
684
|
* @property {PageSpecParam[]} [query]
|
|
726
685
|
*/
|
|
727
686
|
|
|
728
|
-
/**
|
|
729
|
-
* @typedef PageResponseError
|
|
730
|
-
* @property {string} [errors]
|
|
731
|
-
*/
|
|
732
|
-
|
|
733
687
|
/**
|
|
734
688
|
* @typedef PageSchema
|
|
735
689
|
* @property {string} [_id]
|
|
736
690
|
* @property {string} [application]
|
|
737
|
-
* @property {string} [
|
|
738
|
-
*
|
|
739
|
-
* @property {
|
|
740
|
-
* @property {string} [type]
|
|
741
|
-
* @property {string[]} [tags]
|
|
691
|
+
* @property {string[]} [component_ids] - Components can be used to store
|
|
692
|
+
* multiple components
|
|
693
|
+
* @property {Object[]} [content]
|
|
742
694
|
* @property {string} [content_path]
|
|
743
|
-
* @property {string} [orientation]
|
|
744
|
-
* @property {string} [description]
|
|
745
|
-
* @property {boolean} [published]
|
|
746
695
|
* @property {CreatedBySchema} [created_by]
|
|
747
696
|
* @property {DateMeta} [date_meta]
|
|
697
|
+
* @property {string} [description]
|
|
748
698
|
* @property {Asset} [feature_image]
|
|
699
|
+
* @property {Object[]} [page_meta]
|
|
749
700
|
* @property {ScheduleSchema} [_schedule]
|
|
750
|
-
* @property {
|
|
701
|
+
* @property {Object} [_custom_json]
|
|
702
|
+
* @property {string} [orientation]
|
|
703
|
+
* @property {string} [platform]
|
|
704
|
+
* @property {boolean} [published]
|
|
705
|
+
* @property {string} [slug]
|
|
706
|
+
* @property {string[]} [tags]
|
|
707
|
+
* @property {string} [title]
|
|
708
|
+
* @property {string} [type]
|
|
751
709
|
* @property {SEO} [seo]
|
|
752
|
-
* @property {
|
|
710
|
+
* @property {Object} [visibility]
|
|
753
711
|
* @property {boolean} [archived]
|
|
754
|
-
* @property {number} [__v]
|
|
755
|
-
* @property {PageContent[]} [content]
|
|
756
|
-
* @property {SanitizedContent[]} [sanitized_content]
|
|
757
|
-
*/
|
|
758
|
-
|
|
759
|
-
/**
|
|
760
|
-
* @typedef SanitizedContent
|
|
761
|
-
* @property {string} [type]
|
|
762
|
-
* @property {string} [value]
|
|
763
|
-
*/
|
|
764
|
-
|
|
765
|
-
/**
|
|
766
|
-
* @typedef PageMeta
|
|
767
|
-
* @property {string} [key]
|
|
768
|
-
*/
|
|
769
|
-
|
|
770
|
-
/**
|
|
771
|
-
* @typedef PageContent
|
|
772
|
-
* @property {string} [type]
|
|
773
|
-
* @property {string} [value]
|
|
774
712
|
*/
|
|
775
713
|
|
|
776
714
|
/**
|
|
@@ -779,18 +717,13 @@ const Joi = require("joi");
|
|
|
779
717
|
*/
|
|
780
718
|
|
|
781
719
|
/**
|
|
782
|
-
* @typedef
|
|
783
|
-
* @property {boolean} [test]
|
|
784
|
-
*/
|
|
785
|
-
|
|
786
|
-
/**
|
|
787
|
-
* @typedef PageRequest
|
|
720
|
+
* @typedef PagePayload
|
|
788
721
|
* @property {CronSchedule} [_schedule]
|
|
789
722
|
* @property {string} [application]
|
|
790
723
|
* @property {Author} [author]
|
|
791
724
|
* @property {Object} [_custom_json]
|
|
792
725
|
* @property {string} [orientation]
|
|
793
|
-
* @property {
|
|
726
|
+
* @property {Object[]} [content]
|
|
794
727
|
* @property {Asset} [feature_image]
|
|
795
728
|
* @property {boolean} [published]
|
|
796
729
|
* @property {string} [reading_time]
|
|
@@ -798,10 +731,6 @@ const Joi = require("joi");
|
|
|
798
731
|
* @property {string[]} [tags]
|
|
799
732
|
* @property {SEO} [seo]
|
|
800
733
|
* @property {string} [title]
|
|
801
|
-
* @property {string} [platform]
|
|
802
|
-
* @property {string} [type]
|
|
803
|
-
* @property {string} [description]
|
|
804
|
-
* @property {Object} [visibility] - Visibility of Page.
|
|
805
734
|
*/
|
|
806
735
|
|
|
807
736
|
/**
|
|
@@ -810,45 +739,20 @@ const Joi = require("joi");
|
|
|
810
739
|
* @property {string} [start]
|
|
811
740
|
* @property {string} [end]
|
|
812
741
|
* @property {number} [duration]
|
|
813
|
-
* @property {NextSchedule[]} [next_schedule]
|
|
814
742
|
*/
|
|
815
743
|
|
|
816
744
|
/**
|
|
817
|
-
* @typedef
|
|
745
|
+
* @typedef PagePublishPayload
|
|
818
746
|
* @property {boolean} [publish]
|
|
819
747
|
*/
|
|
820
748
|
|
|
821
749
|
/**
|
|
822
750
|
* @typedef PageMetaSchema
|
|
823
|
-
* @property {
|
|
824
|
-
* @property {
|
|
751
|
+
* @property {NavigationSchema[]} [system_pages]
|
|
752
|
+
* @property {PageSchema[]} [custom_pages]
|
|
825
753
|
* @property {string} [application_id]
|
|
826
754
|
*/
|
|
827
755
|
|
|
828
|
-
/**
|
|
829
|
-
* @typedef CustomePages
|
|
830
|
-
* @property {string} [display]
|
|
831
|
-
* @property {string} [slug]
|
|
832
|
-
*/
|
|
833
|
-
|
|
834
|
-
/**
|
|
835
|
-
* @typedef SystemPagesActionPage
|
|
836
|
-
* @property {string} [type]
|
|
837
|
-
*/
|
|
838
|
-
|
|
839
|
-
/**
|
|
840
|
-
* @typedef SystemPagesAction
|
|
841
|
-
* @property {SystemPagesActionPage} [page]
|
|
842
|
-
* @property {string} [type]
|
|
843
|
-
*/
|
|
844
|
-
|
|
845
|
-
/**
|
|
846
|
-
* @typedef SystemPages
|
|
847
|
-
* @property {string} [display]
|
|
848
|
-
* @property {SystemPagesAction} [action]
|
|
849
|
-
* @property {string} [page_type]
|
|
850
|
-
*/
|
|
851
|
-
|
|
852
756
|
/**
|
|
853
757
|
* @typedef Support
|
|
854
758
|
* @property {boolean} [created]
|
|
@@ -893,32 +797,46 @@ const Joi = require("joi");
|
|
|
893
797
|
|
|
894
798
|
/**
|
|
895
799
|
* @typedef TagsSchema
|
|
896
|
-
* @property {string} [application]
|
|
897
|
-
* @property {string} [_id]
|
|
898
|
-
* @property {
|
|
899
|
-
*
|
|
900
|
-
* @property {TagSchema[]} [tags]
|
|
800
|
+
* @property {string} [application] - The ID of the application that owns the tags.
|
|
801
|
+
* @property {string} [_id] - The unique identifier for the tag set.
|
|
802
|
+
* @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
|
|
803
|
+
* or stylesheets) that are configured for the application.
|
|
901
804
|
*/
|
|
902
805
|
|
|
903
806
|
/**
|
|
904
807
|
* @typedef TagSchema
|
|
905
|
-
* @property {string} [name]
|
|
906
|
-
* @property {string} [url]
|
|
907
|
-
*
|
|
908
|
-
* @property {string} [
|
|
909
|
-
*
|
|
910
|
-
* @property {string} [
|
|
911
|
-
*
|
|
912
|
-
* @property {string} [
|
|
913
|
-
* @property {
|
|
914
|
-
*
|
|
808
|
+
* @property {string} [name] - The name of the tag used to identify it.
|
|
809
|
+
* @property {string} [url] - The URL where the external tag resource (such as a
|
|
810
|
+
* script or stylesheet) is located.
|
|
811
|
+
* @property {string} [type] - Specifies whether the tag is a JavaScript ('js')
|
|
812
|
+
* or CSS ('css') tag.
|
|
813
|
+
* @property {string} [sub_type] - Indicates whether the tag is an external
|
|
814
|
+
* resource (external) or inline content (inline).
|
|
815
|
+
* @property {string} [_id] - The unique identifier for the tag in the system.
|
|
816
|
+
* @property {string} [position] - The position within the page where the tag
|
|
817
|
+
* should be injected.
|
|
818
|
+
* @property {Object} [attributes] - Additional attributes for the tag to define
|
|
819
|
+
* its behavior or compatibility. Supported attributes may vary based on the
|
|
820
|
+
* tag type for example:
|
|
821
|
+
*
|
|
822
|
+
* - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
|
|
823
|
+
* - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
|
|
824
|
+
* - For `style` tags: `media`, `type`, `scoped`.
|
|
825
|
+
* - Custom data attributes like `data-*` can also be added.
|
|
826
|
+
*
|
|
827
|
+
* @property {string} [content] - Content of the tag if it is inline, such as
|
|
828
|
+
* JavaScript or CSS code.
|
|
829
|
+
* @property {string[]} [compatible_engines] - List of UI frameworks where this
|
|
830
|
+
* third-party tag can be injected or supported.
|
|
831
|
+
* @property {Object[]} [pages] - Pages or environments where the tag should be active.
|
|
915
832
|
* @property {TagSourceSchema} [__source]
|
|
916
833
|
*/
|
|
917
834
|
|
|
918
835
|
/**
|
|
919
836
|
* @typedef TagSourceSchema
|
|
920
|
-
* @property {string} [type]
|
|
921
|
-
* @property {string} [id]
|
|
837
|
+
* @property {string} [type] - The type of source, such as 'extension'
|
|
838
|
+
* @property {string} [id] - The identifier of the source that created or
|
|
839
|
+
* provided the tag.
|
|
922
840
|
*/
|
|
923
841
|
|
|
924
842
|
/**
|
|
@@ -935,150 +853,139 @@ const Joi = require("joi");
|
|
|
935
853
|
|
|
936
854
|
/**
|
|
937
855
|
* @typedef FieldValidations
|
|
938
|
-
* @property {string} [name]
|
|
939
|
-
* @property {string} [type]
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
/**
|
|
943
|
-
* @typedef ApplicationFieldDefinitionSchema
|
|
944
|
-
* @property {string} [_id]
|
|
945
|
-
* @property {string} [creator]
|
|
946
|
-
* @property {string} [resource]
|
|
947
|
-
* @property {string} [name]
|
|
948
|
-
* @property {string} [namespace]
|
|
949
|
-
* @property {string} [key]
|
|
950
|
-
* @property {string} [description]
|
|
951
|
-
* @property {string} [type]
|
|
952
|
-
* @property {boolean} [multi_value]
|
|
953
|
-
* @property {FieldValidations[]} [validations]
|
|
954
|
-
* @property {string} [company_id]
|
|
955
|
-
* @property {string} [created_by]
|
|
956
|
-
* @property {string} [updated_by]
|
|
957
|
-
* @property {boolean} [required]
|
|
958
|
-
* @property {boolean} [is_deleted]
|
|
959
|
-
* @property {string} [created_at]
|
|
960
|
-
* @property {string} [updated_at]
|
|
961
|
-
* @property {string} [type_name]
|
|
962
|
-
* @property {number} [invalid_fields_count]
|
|
963
|
-
* @property {string} [application_id]
|
|
856
|
+
* @property {string} [name] - Name of validation
|
|
857
|
+
* @property {string} [type] - Type of validation
|
|
858
|
+
* @property {Object} [value]
|
|
964
859
|
*/
|
|
965
860
|
|
|
966
861
|
/**
|
|
967
862
|
* @typedef FieldDefinitionSchema
|
|
968
|
-
* @property {string} [
|
|
969
|
-
* @property {string} [
|
|
970
|
-
* @property {string} [
|
|
971
|
-
* @property {string} [
|
|
972
|
-
* @property {string} [
|
|
973
|
-
* @property {string} [
|
|
974
|
-
* @property {string} [
|
|
975
|
-
* @property {
|
|
976
|
-
*
|
|
977
|
-
* @property {FieldValidations[]} [validations]
|
|
978
|
-
* @property {string} [company_id]
|
|
979
|
-
* @property {
|
|
980
|
-
* @property {
|
|
981
|
-
* @property {
|
|
982
|
-
* @property {
|
|
983
|
-
* @property {string} [created_at]
|
|
984
|
-
* @property {string} [updated_at]
|
|
985
|
-
* @property {string} [type_name]
|
|
986
|
-
* @property {number} [invalid_fields_count]
|
|
987
|
-
*/
|
|
988
|
-
|
|
989
|
-
/**
|
|
990
|
-
* @typedef ApplicationCustomFieldDefinitionsSchema
|
|
991
|
-
* @property {ApplicationFieldDefinitionSchema[]} [items]
|
|
992
|
-
* @property {Page} [page]
|
|
863
|
+
* @property {string} [id] - Unique system generated id
|
|
864
|
+
* @property {string} [resource] - Resource type to which custom field belongs
|
|
865
|
+
* @property {string} [name] - Name of custom field
|
|
866
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
867
|
+
* @property {string} [slug] - Slug of custom field
|
|
868
|
+
* @property {string} [description] - Description of custom field definition
|
|
869
|
+
* @property {string} [type] - Data type of custom field
|
|
870
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
871
|
+
* multivalued or not
|
|
872
|
+
* @property {FieldValidations[]} [validations] - List of validations applied
|
|
873
|
+
* @property {string} [company_id] - Id of company
|
|
874
|
+
* @property {boolean} [required] - Whether the custom field is required or not
|
|
875
|
+
* @property {boolean} [is_deleted] - Whether the custom field is deleted or not
|
|
876
|
+
* @property {string} [type_name] - Type of type field
|
|
877
|
+
* @property {number} [invalid_fields_count] - Count of invalid fields after validation
|
|
993
878
|
*/
|
|
994
879
|
|
|
995
880
|
/**
|
|
996
881
|
* @typedef CustomFieldDefinitionsSchema
|
|
997
|
-
* @property {FieldDefinitionSchema[]} [items]
|
|
882
|
+
* @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
|
|
998
883
|
* @property {Page} [page]
|
|
999
884
|
*/
|
|
1000
885
|
|
|
1001
886
|
/**
|
|
1002
887
|
* @typedef CustomFieldDefinitionRequestSchema
|
|
1003
|
-
* @property {string} [
|
|
1004
|
-
* @property {string} [
|
|
1005
|
-
* @property {string} [
|
|
1006
|
-
* @property {
|
|
1007
|
-
*
|
|
1008
|
-
* @property {string} [name]
|
|
1009
|
-
* @property {string} [description]
|
|
1010
|
-
* @property {
|
|
1011
|
-
* @property {FieldValidations[]} [validations]
|
|
888
|
+
* @property {string} [type] - Data type of custom field
|
|
889
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
890
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
891
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
892
|
+
* multi valued or not
|
|
893
|
+
* @property {string} [name] - Name of custom field definition
|
|
894
|
+
* @property {string} [description] - Description of a custom field definition
|
|
895
|
+
* @property {FieldValidations[]} [validations] - Validations for a custom field
|
|
1012
896
|
*/
|
|
1013
897
|
|
|
1014
898
|
/**
|
|
1015
899
|
* @typedef CustomObjectCustomFieldDefinitions
|
|
1016
|
-
* @property {string} [
|
|
1017
|
-
* @property {string} type
|
|
1018
|
-
* @property {string} [description]
|
|
1019
|
-
* @property {string} [name]
|
|
1020
|
-
* @property {boolean} [multi_value]
|
|
1021
|
-
*
|
|
1022
|
-
* @property {
|
|
1023
|
-
* @property {
|
|
900
|
+
* @property {string} [id] - Unique identifer for a custom field
|
|
901
|
+
* @property {string} [type] - Data type of custom field
|
|
902
|
+
* @property {string} [description] - Description of custom field
|
|
903
|
+
* @property {string} [name] - Name of custom field
|
|
904
|
+
* @property {boolean} [multi_value] - Flag to denote if cusom field is multi
|
|
905
|
+
* valued or not
|
|
906
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
907
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
908
|
+
* @property {FieldValidations[]} [validations] - Validations added against the
|
|
909
|
+
* custom field
|
|
1024
910
|
* @property {string} [action]
|
|
1025
911
|
*/
|
|
1026
912
|
|
|
1027
913
|
/**
|
|
1028
914
|
* @typedef CustomObjectDefinitionUpdateRequestSchema
|
|
1029
|
-
* @property {string} [
|
|
1030
|
-
* @property {string} [
|
|
1031
|
-
* @property {string} [
|
|
1032
|
-
*
|
|
1033
|
-
* @property {
|
|
915
|
+
* @property {string} [description] - Description of custom object definiton
|
|
916
|
+
* @property {string} [name] - Name of custom object definition
|
|
917
|
+
* @property {string} [display_name_key] - Custom field slug which is used as a
|
|
918
|
+
* display key in
|
|
919
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
|
|
1034
920
|
*/
|
|
1035
921
|
|
|
1036
922
|
/**
|
|
1037
923
|
* @typedef CustomFieldDefinitionDetailResSchema
|
|
1038
|
-
* @property {string} [
|
|
1039
|
-
* @property {string} [
|
|
1040
|
-
* @property {string} [
|
|
1041
|
-
* @property {string} [
|
|
1042
|
-
* @property {string} [
|
|
1043
|
-
* @property {string} [
|
|
1044
|
-
* @property {
|
|
1045
|
-
*
|
|
1046
|
-
* @property {string} [company_id]
|
|
1047
|
-
* @property {string} [application_id]
|
|
1048
|
-
* @property {
|
|
1049
|
-
* @property {
|
|
1050
|
-
* @property {
|
|
1051
|
-
* @property {boolean} [is_deleted]
|
|
1052
|
-
* @property {string} [_id]
|
|
924
|
+
* @property {string} [resource] - Resource to which custom field is associated
|
|
925
|
+
* @property {string} [name] - Name of custom field
|
|
926
|
+
* @property {string} [namespace] - Namespace of custom field
|
|
927
|
+
* @property {string} [slug] - Slug of custom field
|
|
928
|
+
* @property {string} [description] - Description regarding custom field
|
|
929
|
+
* @property {string} [type] - Data type of custom field
|
|
930
|
+
* @property {boolean} [multi_value] - Flag to denote whether custom field is
|
|
931
|
+
* multi valued or not
|
|
932
|
+
* @property {string} [company_id] - Company Identifer
|
|
933
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
934
|
+
* @property {boolean} [required] - Whether the customfield is required or not
|
|
935
|
+
* @property {boolean} [is_deleted] - Is custom field deleted
|
|
936
|
+
* @property {string} [id] - Unique system generated id
|
|
1053
937
|
* @property {Object[]} [validations]
|
|
1054
|
-
* @property {string} [created_at]
|
|
1055
|
-
* @property {string} [updated_at]
|
|
938
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
939
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
940
|
+
*/
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* @typedef MetaFieldDefinitionDetailResSchema
|
|
944
|
+
* @property {string} [resource] - Resource to which meta field is associated
|
|
945
|
+
* @property {string} [name] - Name of meta field
|
|
946
|
+
* @property {string} [namespace] - Namespace of meta field
|
|
947
|
+
* @property {string} [slug] - Slug of meta field
|
|
948
|
+
* @property {string} [description] - Description regarding meta field
|
|
949
|
+
* @property {string} [type] - Data type of meta field
|
|
950
|
+
* @property {boolean} [multi_value] - Flag to denote whether meta field is
|
|
951
|
+
* multi valued or not
|
|
952
|
+
* @property {string} [company_id] - Company Identifer
|
|
953
|
+
* @property {string} [application_id] - Sales channel identifier
|
|
954
|
+
* @property {boolean} [required] - Whether the field is required or not
|
|
955
|
+
* @property {boolean} [is_deleted] - Is meta field deleted
|
|
956
|
+
* @property {string} [id] - Unique system generated id
|
|
957
|
+
* @property {Object[]} [validations]
|
|
958
|
+
* @property {string} [created_at] - Date time at which field was created
|
|
959
|
+
* @property {string} [updated_at] - Date time at for a field's last modification
|
|
1056
960
|
*/
|
|
1057
961
|
|
|
1058
962
|
/**
|
|
1059
963
|
* @typedef CustomDataDeleteSchema
|
|
1060
|
-
* @property {boolean} [success]
|
|
1061
|
-
* @property {string} [message]
|
|
964
|
+
* @property {boolean} [success] - Denotes the success of the delete operation
|
|
965
|
+
* @property {string} [message] - Denotes the message of delete operation
|
|
966
|
+
*/
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
* @typedef CustomFieldValue
|
|
970
|
+
* @property {Object} [value]
|
|
1062
971
|
*/
|
|
1063
972
|
|
|
1064
973
|
/**
|
|
1065
974
|
* @typedef CustomFieldSchema
|
|
1066
|
-
* @property {string} [
|
|
1067
|
-
* @property {string} [namespace]
|
|
1068
|
-
* @property {string} [
|
|
1069
|
-
* @property {string} [resource]
|
|
1070
|
-
* @property {
|
|
1071
|
-
* @property {string} [
|
|
1072
|
-
* @property {string} type
|
|
1073
|
-
* @property {boolean} [multi_value]
|
|
1074
|
-
* @property {string} [company_id]
|
|
1075
|
-
* @property {string} [definition_id]
|
|
975
|
+
* @property {string} [id] - Unique system generated id
|
|
976
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
977
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
978
|
+
* @property {string} [resource] - The resource for which custom field is being created
|
|
979
|
+
* @property {CustomFieldValue[]} [value]
|
|
980
|
+
* @property {string} [resource_slug] - Unique identifier of the resource
|
|
981
|
+
* @property {string} [type] - Data type of custom field
|
|
982
|
+
* @property {boolean} [multi_value] - Whether custom field is multi valued
|
|
983
|
+
* @property {string} [company_id] - Identifer for a company
|
|
1076
984
|
* @property {boolean} [has_invalid_values]
|
|
1077
985
|
* @property {Object[]} [invalid_value_errors]
|
|
1078
|
-
* @property {
|
|
1079
|
-
* @property {
|
|
1080
|
-
* @property {string} [
|
|
1081
|
-
* @property {string} [updated_at]
|
|
986
|
+
* @property {boolean} [is_deleted] - Indicates whether custom field is deleted
|
|
987
|
+
* @property {string} [created_at] - Time at which customer field was created
|
|
988
|
+
* @property {string} [updated_at] - Time at which custom field was updated
|
|
1082
989
|
*/
|
|
1083
990
|
|
|
1084
991
|
/**
|
|
@@ -1100,7 +1007,10 @@ const Joi = require("joi");
|
|
|
1100
1007
|
|
|
1101
1008
|
/**
|
|
1102
1009
|
* @typedef CustomField
|
|
1103
|
-
* @property {
|
|
1010
|
+
* @property {Object[]} [value]
|
|
1011
|
+
* @property {string} [namespace] - This is the namespace to which custom field belongs
|
|
1012
|
+
* @property {string} [slug] - This is the slug of custom field used while
|
|
1013
|
+
* creating a custom field definition
|
|
1104
1014
|
*/
|
|
1105
1015
|
|
|
1106
1016
|
/**
|
|
@@ -1110,169 +1020,137 @@ const Joi = require("joi");
|
|
|
1110
1020
|
|
|
1111
1021
|
/**
|
|
1112
1022
|
* @typedef CustomObjectSchema
|
|
1113
|
-
* @property {string} [
|
|
1114
|
-
* @property {string} [
|
|
1115
|
-
* @property {string} [
|
|
1116
|
-
* @property {string} [
|
|
1117
|
-
* @property {string} [
|
|
1118
|
-
* @property {string} [
|
|
1119
|
-
* @property {string} [
|
|
1120
|
-
*
|
|
1121
|
-
* @property {
|
|
1122
|
-
* @property {string} [display_name]
|
|
1123
|
-
* @property {string} [definition_id]
|
|
1124
|
-
* @property {boolean} [is_deleted]
|
|
1125
|
-
* @property {string} [created_at]
|
|
1126
|
-
* @property {string} [updated_at]
|
|
1127
|
-
* @property {CustomFieldSchema[]} [fields]
|
|
1023
|
+
* @property {string} [id] - Unique system generated id
|
|
1024
|
+
* @property {string} [company_id] - Identifer for a company
|
|
1025
|
+
* @property {string} [application_id] - Identifer for a sales channel
|
|
1026
|
+
* @property {string} [status] - Status of custom object
|
|
1027
|
+
* @property {string} [type] - Slug of custom object definition
|
|
1028
|
+
* @property {string} [definition_slug] - Slug for custom object definition
|
|
1029
|
+
* @property {string} [display_name] - Value of custom field used for displaying
|
|
1030
|
+
* custom object
|
|
1031
|
+
* @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
|
|
1128
1032
|
*/
|
|
1129
1033
|
|
|
1130
1034
|
/**
|
|
1131
1035
|
* @typedef CustomObjectDefinitionRequestSchema
|
|
1132
|
-
* @property {string} [type]
|
|
1133
|
-
* @property {string} [
|
|
1134
|
-
* @property {string} [
|
|
1135
|
-
* @property {string} [
|
|
1136
|
-
* @property {
|
|
1036
|
+
* @property {string} [type] - Namespace/Slug of Custom object definition
|
|
1037
|
+
* @property {string} [definition_slug] - Unique slug for a custom object definition
|
|
1038
|
+
* @property {string} [description] - Description of custom object definition
|
|
1039
|
+
* @property {string} [name] - Name of custom object
|
|
1040
|
+
* @property {string} [display_name_key] - Denotes which custom field to be used
|
|
1041
|
+
* for displaying custom object
|
|
1042
|
+
* @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
|
|
1043
|
+
* of custom field definitions belonging to this custom object definition
|
|
1137
1044
|
*/
|
|
1138
1045
|
|
|
1139
1046
|
/**
|
|
1140
|
-
* @typedef
|
|
1141
|
-
* @property {string} [
|
|
1142
|
-
* @property {string} [
|
|
1143
|
-
* @property {string} [
|
|
1144
|
-
* @property {string} [
|
|
1145
|
-
* @property {string} [
|
|
1146
|
-
* @property {string} [description]
|
|
1147
|
-
* @property {
|
|
1148
|
-
*
|
|
1149
|
-
* @property {FieldValidations[]} [validations]
|
|
1150
|
-
* @property {string} [company_id]
|
|
1151
|
-
* @property {string} [created_by]
|
|
1152
|
-
* @property {string} [metaobject_definition_id]
|
|
1153
|
-
* @property {boolean} [required]
|
|
1154
|
-
* @property {boolean} [is_deleted]
|
|
1155
|
-
* @property {string} [_id]
|
|
1156
|
-
* @property {string} [created_at]
|
|
1157
|
-
* @property {string} [updated_at]
|
|
1158
|
-
* @property {string} [application_id]
|
|
1047
|
+
* @typedef CustomObjectDefinitionSlugSchema
|
|
1048
|
+
* @property {string} [id] - Unique system generated custom object definition id
|
|
1049
|
+
* @property {string} [name] - Display name of custom object definition
|
|
1050
|
+
* @property {string} [type] - Type of custom object definiton
|
|
1051
|
+
* @property {string} [definition_slug] - Slug of custom object definiton
|
|
1052
|
+
* @property {string} [display_name_key] - Display name of custom object definition
|
|
1053
|
+
* @property {string} [description] - Description of custom object definition
|
|
1054
|
+
* @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
|
|
1055
|
+
* Custom fields inside custom objects
|
|
1159
1056
|
*/
|
|
1160
1057
|
|
|
1161
1058
|
/**
|
|
1162
|
-
* @typedef
|
|
1163
|
-
* @property {
|
|
1164
|
-
* @property {string} [
|
|
1165
|
-
*
|
|
1166
|
-
* @property {string} [display_name_key]
|
|
1167
|
-
* @property {string} [description]
|
|
1168
|
-
* @property {string} [creator]
|
|
1169
|
-
* @property {string} [created_by]
|
|
1170
|
-
* @property {string} [updated_by]
|
|
1171
|
-
* @property {string} [application_id]
|
|
1172
|
-
* @property {string} [company_id]
|
|
1173
|
-
* @property {string} [created_at]
|
|
1174
|
-
* @property {string} [updated_at]
|
|
1175
|
-
* @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
|
|
1059
|
+
* @typedef CustomObjectDefinitionDeleteResponseSchema
|
|
1060
|
+
* @property {boolean} [success] - Success status of delete custom object definition.
|
|
1061
|
+
* @property {string} [message] - Response message when custom object definition
|
|
1062
|
+
* is deleted.
|
|
1176
1063
|
*/
|
|
1177
1064
|
|
|
1178
1065
|
/**
|
|
1179
|
-
* @typedef
|
|
1180
|
-
* @property {
|
|
1181
|
-
* @property {
|
|
1066
|
+
* @typedef CustomObjectEntryBulkUploadDetails
|
|
1067
|
+
* @property {string} [url] - Signed url of csv
|
|
1068
|
+
* @property {number} [total_records] - Total no of records in csv file
|
|
1182
1069
|
*/
|
|
1183
1070
|
|
|
1184
1071
|
/**
|
|
1185
|
-
* @typedef
|
|
1186
|
-
* @property {string} [
|
|
1187
|
-
* @property {string} [
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
/**
|
|
1191
|
-
* @typedef CustomObjectListItemDefinationSchema
|
|
1192
|
-
* @property {string} [_id]
|
|
1193
|
-
* @property {string} [name]
|
|
1194
|
-
* @property {string} [type]
|
|
1195
|
-
* @property {string} [display_name_key]
|
|
1072
|
+
* @typedef CustomObjectListItemDefinitionModel
|
|
1073
|
+
* @property {string} [id] - Unique system generated id
|
|
1074
|
+
* @property {string} [name] - Name of custom object
|
|
1075
|
+
* @property {string} [type] - Type of custom object entry
|
|
1196
1076
|
*/
|
|
1197
1077
|
|
|
1198
1078
|
/**
|
|
1199
1079
|
* @typedef CustomObjectListItemSchema
|
|
1200
|
-
* @property {string} [
|
|
1201
|
-
* @property {string} [
|
|
1202
|
-
* @property {string} [
|
|
1203
|
-
* @property {string} [
|
|
1204
|
-
* @property {string} [
|
|
1205
|
-
* @property {
|
|
1206
|
-
* @property {
|
|
1207
|
-
* @property {number} [references]
|
|
1080
|
+
* @property {string} [id] - Unique system generated id
|
|
1081
|
+
* @property {string} [status] - Status of custom object
|
|
1082
|
+
* @property {string} [created_at] - Creation time of custom object document
|
|
1083
|
+
* @property {string} [updated_at] - Updation time of custom object document
|
|
1084
|
+
* @property {string} [display_name] - Display name of custom object
|
|
1085
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1086
|
+
* @property {number} [references] - References of the custom object entry
|
|
1208
1087
|
*/
|
|
1209
1088
|
|
|
1210
1089
|
/**
|
|
1211
1090
|
* @typedef CustomObjectsSchema
|
|
1212
|
-
* @property {CustomObjectListItemSchema[]} [items]
|
|
1091
|
+
* @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
|
|
1092
|
+
* object entries
|
|
1213
1093
|
* @property {Page} [page]
|
|
1214
1094
|
*/
|
|
1215
1095
|
|
|
1216
1096
|
/**
|
|
1217
|
-
* @typedef
|
|
1218
|
-
* @property {string} [
|
|
1219
|
-
* @property {string} [
|
|
1220
|
-
* @property {string} [
|
|
1221
|
-
* @property {
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
/**
|
|
1225
|
-
* @typedef MetafieldTypesSchema
|
|
1226
|
-
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1097
|
+
* @typedef CustomObjectFieldDefinition
|
|
1098
|
+
* @property {string} [id] - Unique system generate id
|
|
1099
|
+
* @property {string} [slug] - Slug of custom field definition
|
|
1100
|
+
* @property {string} [namespace] - Namespace of custom field definition
|
|
1101
|
+
* @property {Object[]} [value] - Value of custom field
|
|
1102
|
+
* @property {string} [type] - Data type of the custom field
|
|
1227
1103
|
*/
|
|
1228
1104
|
|
|
1229
1105
|
/**
|
|
1230
|
-
* @typedef
|
|
1231
|
-
* @property {string} [
|
|
1232
|
-
* @property {string} [status]
|
|
1233
|
-
* @property {string} [
|
|
1234
|
-
* @property {
|
|
1235
|
-
* @property {
|
|
1236
|
-
*
|
|
1237
|
-
* @property {
|
|
1106
|
+
* @typedef CustomObjectBySlugSchema
|
|
1107
|
+
* @property {string} [id] - Unique system generated identifer for a Custom Object
|
|
1108
|
+
* @property {string} [status] - Status of Custom Object
|
|
1109
|
+
* @property {string} [display_name] - Display name for the Custom Object
|
|
1110
|
+
* @property {CustomObjectListItemDefinitionModel} [definition]
|
|
1111
|
+
* @property {Object[]} [references] - Places where the custom object has been
|
|
1112
|
+
* used as a custom field
|
|
1113
|
+
* @property {string} [slug] - Slug of custom object entry
|
|
1114
|
+
* @property {string} [definition_slug] - Slug of custom object definition
|
|
1115
|
+
* @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
|
|
1116
|
+
* inside the custom object
|
|
1238
1117
|
*/
|
|
1239
1118
|
|
|
1240
1119
|
/**
|
|
1241
1120
|
* @typedef CustomObjectBulkEntryInitiateDownload
|
|
1242
|
-
* @property {string} [message]
|
|
1243
|
-
* @property {string} [task_id]
|
|
1121
|
+
* @property {string} [message] - Message for the user
|
|
1122
|
+
* @property {string} [task_id] - Identifer for a task
|
|
1244
1123
|
*/
|
|
1245
1124
|
|
|
1246
1125
|
/**
|
|
1247
1126
|
* @typedef CustomObjectMetaSchema
|
|
1248
|
-
* @property {number} [mo_total_count]
|
|
1249
|
-
* @property {number} [mo_success_count]
|
|
1250
|
-
* @property {number} [mo_error_count]
|
|
1251
|
-
* @property {string} [mo_defintion_type]
|
|
1127
|
+
* @property {number} [mo_total_count] - Total number of entries in the bulk entry
|
|
1128
|
+
* @property {number} [mo_success_count] - Number of entries which were successful
|
|
1129
|
+
* @property {number} [mo_error_count] - Number of entries which were failed
|
|
1130
|
+
* @property {string} [mo_defintion_type] - Type of object
|
|
1252
1131
|
*/
|
|
1253
1132
|
|
|
1254
1133
|
/**
|
|
1255
1134
|
* @typedef JobSchema
|
|
1256
|
-
* @property {string} [
|
|
1257
|
-
* @property {string[]} [jobs]
|
|
1258
|
-
* @property {string[]} [finished_jobs]
|
|
1259
|
-
* @property {string[]} [error_jobs]
|
|
1260
|
-
* @property {string[]} [errors_occured]
|
|
1261
|
-
* @property {string} [company_id]
|
|
1262
|
-
* @property {string} [
|
|
1263
|
-
* @property {string} [
|
|
1264
|
-
* @property {string} [
|
|
1265
|
-
* @property {string} [
|
|
1266
|
-
* @property {
|
|
1267
|
-
* @property {number} [
|
|
1268
|
-
* @property {number} [
|
|
1269
|
-
* @property {number} [
|
|
1270
|
-
* @property {number} [total_jobs]
|
|
1135
|
+
* @property {string} [id] - Unique system generated id
|
|
1136
|
+
* @property {string[]} [jobs] - List of total jobs
|
|
1137
|
+
* @property {string[]} [finished_jobs] - List of finished jobs
|
|
1138
|
+
* @property {string[]} [error_jobs] - List of jobs which resulted in an error
|
|
1139
|
+
* @property {string[]} [errors_occured] - List of errors occurred in the job
|
|
1140
|
+
* @property {string} [company_id] - Company Identifer
|
|
1141
|
+
* @property {string} [status] - Status of job
|
|
1142
|
+
* @property {string} [action_type] - Type of job
|
|
1143
|
+
* @property {string} [entity] - Entity against which job is running
|
|
1144
|
+
* @property {string} [error_url] - URL which contains the file with errors
|
|
1145
|
+
* @property {number} [finished_count] - Number of items successfully finished
|
|
1146
|
+
* @property {number} [error_count] - Number of items in error
|
|
1147
|
+
* @property {number} [success_count] - Number of successful items
|
|
1148
|
+
* @property {number} [total_jobs] - Total number of jobs
|
|
1271
1149
|
* @property {CustomObjectMetaSchema} [meta]
|
|
1272
|
-
* @property {string} [created_by]
|
|
1273
|
-
* @property {string} [created_at]
|
|
1274
|
-
* @property {string} [updated_at]
|
|
1275
|
-
* @property {string} [application_id]
|
|
1150
|
+
* @property {string} [created_by] - Source from where the bulk job is created
|
|
1151
|
+
* @property {string} [created_at] - Date/Time when the job was created
|
|
1152
|
+
* @property {string} [updated_at] - Date/Time when the job was updated
|
|
1153
|
+
* @property {string} [application_id] - Sales Channel Identifier
|
|
1276
1154
|
*/
|
|
1277
1155
|
|
|
1278
1156
|
/**
|
|
@@ -1287,6 +1165,11 @@ const Joi = require("joi");
|
|
|
1287
1165
|
* @property {Page} [page]
|
|
1288
1166
|
*/
|
|
1289
1167
|
|
|
1168
|
+
/**
|
|
1169
|
+
* @typedef MetafieldTypesSchema
|
|
1170
|
+
* @property {CustomFieldTypeSchema} [metafield_types]
|
|
1171
|
+
*/
|
|
1172
|
+
|
|
1290
1173
|
/**
|
|
1291
1174
|
* @typedef CustomFieldTypeSchema
|
|
1292
1175
|
* @property {StringSingleLine} [string_single_line]
|
|
@@ -1306,156 +1189,184 @@ const Joi = require("joi");
|
|
|
1306
1189
|
* @property {Duration} [duration]
|
|
1307
1190
|
*/
|
|
1308
1191
|
|
|
1192
|
+
/**
|
|
1193
|
+
* @typedef SupportedValidationsMetaExampleSchema
|
|
1194
|
+
* @property {string} [name]
|
|
1195
|
+
* @property {string} [value]
|
|
1196
|
+
*/
|
|
1197
|
+
|
|
1198
|
+
/**
|
|
1199
|
+
* @typedef SupportedValidationsMetaSchema
|
|
1200
|
+
* @property {SupportedValidationsMetaExampleSchema[]} [examples]
|
|
1201
|
+
*/
|
|
1202
|
+
|
|
1309
1203
|
/**
|
|
1310
1204
|
* @typedef SupportedValidationsSchema
|
|
1311
1205
|
* @property {string} [name]
|
|
1312
1206
|
* @property {string} [type]
|
|
1313
1207
|
* @property {string} [display]
|
|
1314
1208
|
* @property {boolean} [required]
|
|
1209
|
+
* @property {SupportedValidationsMetaSchema} [meta]
|
|
1315
1210
|
*/
|
|
1316
1211
|
|
|
1317
1212
|
/**
|
|
1318
1213
|
* @typedef Duration
|
|
1319
|
-
* @property {string} [name]
|
|
1320
|
-
* @property {boolean} [list_enabled]
|
|
1321
|
-
* @property {string} [type]
|
|
1322
|
-
* @property {string} [category]
|
|
1323
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1214
|
+
* @property {string} [name] - Name data type of custom field
|
|
1215
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1216
|
+
* @property {string} [type] - Type of custom field
|
|
1217
|
+
* @property {string} [category] - Category of custom field
|
|
1218
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1219
|
+
* validations available for the field
|
|
1324
1220
|
*/
|
|
1325
1221
|
|
|
1326
1222
|
/**
|
|
1327
1223
|
* @typedef HTML
|
|
1328
|
-
* @property {string} [name]
|
|
1329
|
-
* @property {boolean} [list_enabled]
|
|
1330
|
-
* @property {string} [type]
|
|
1331
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1224
|
+
* @property {string} [name] - Name data type of custom field
|
|
1225
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1226
|
+
* @property {string} [type] - Type of custom field
|
|
1227
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1228
|
+
* validations available for the field
|
|
1332
1229
|
*/
|
|
1333
1230
|
|
|
1334
1231
|
/**
|
|
1335
1232
|
* @typedef StringSingleLine
|
|
1336
|
-
* @property {string} [name]
|
|
1337
|
-
* @property {boolean} [list_enabled]
|
|
1338
|
-
* @property {string} [category]
|
|
1339
|
-
* @property {string} [type]
|
|
1340
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1233
|
+
* @property {string} [name] - Name data type of custom field
|
|
1234
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1235
|
+
* @property {string} [category] - Category of custom field
|
|
1236
|
+
* @property {string} [type] - Type of custom field
|
|
1237
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1238
|
+
* validations available for the field
|
|
1341
1239
|
*/
|
|
1342
1240
|
|
|
1343
1241
|
/**
|
|
1344
1242
|
* @typedef StringMultiLine
|
|
1345
|
-
* @property {string} [name]
|
|
1346
|
-
* @property {boolean} [list_enabled]
|
|
1347
|
-
* @property {string} [category]
|
|
1348
|
-
* @property {string} [type]
|
|
1349
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1243
|
+
* @property {string} [name] - Name data type of custom field
|
|
1244
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1245
|
+
* @property {string} [category] - Category of custom field
|
|
1246
|
+
* @property {string} [type] - Type of custom field
|
|
1247
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1248
|
+
* validations available for the field
|
|
1350
1249
|
*/
|
|
1351
1250
|
|
|
1352
1251
|
/**
|
|
1353
1252
|
* @typedef Dropdown
|
|
1354
|
-
* @property {string} [name]
|
|
1355
|
-
* @property {boolean} [list_enabled]
|
|
1356
|
-
* @property {string} [category]
|
|
1357
|
-
* @property {string} [type]
|
|
1358
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1253
|
+
* @property {string} [name] - Name data type of custom field
|
|
1254
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1255
|
+
* @property {string} [category] - Category of custom field
|
|
1256
|
+
* @property {string} [type] - Category of custom field
|
|
1257
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1258
|
+
* validations available for the field
|
|
1359
1259
|
*/
|
|
1360
1260
|
|
|
1361
1261
|
/**
|
|
1362
1262
|
* @typedef Integer
|
|
1363
|
-
* @property {string} [name]
|
|
1364
|
-
* @property {boolean} [list_enabled]
|
|
1365
|
-
* @property {string} [type]
|
|
1366
|
-
* @property {string} [category]
|
|
1367
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1263
|
+
* @property {string} [name] - Name data type of custom field
|
|
1264
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1265
|
+
* @property {string} [type] - Type of custom field
|
|
1266
|
+
* @property {string} [category] - Category of custom field
|
|
1267
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1268
|
+
* validations available for the field
|
|
1368
1269
|
*/
|
|
1369
1270
|
|
|
1370
1271
|
/**
|
|
1371
1272
|
* @typedef FloatType
|
|
1372
|
-
* @property {string} [name]
|
|
1373
|
-
* @property {boolean} [list_enabled]
|
|
1374
|
-
* @property {string} [type]
|
|
1375
|
-
* @property {string} [category]
|
|
1376
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1273
|
+
* @property {string} [name] - Name data type of custom field
|
|
1274
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1275
|
+
* @property {string} [type] - Type of custom field
|
|
1276
|
+
* @property {string} [category] - Category of custom field
|
|
1277
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1278
|
+
* validations available for the field
|
|
1377
1279
|
*/
|
|
1378
1280
|
|
|
1379
1281
|
/**
|
|
1380
1282
|
* @typedef BooleanType
|
|
1381
|
-
* @property {string} [name]
|
|
1382
|
-
* @property {string} [category]
|
|
1383
|
-
* @property {boolean} [list_enabled]
|
|
1384
|
-
* @property {string} [type]
|
|
1385
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1283
|
+
* @property {string} [name] - Name data type of custom field
|
|
1284
|
+
* @property {string} [category] - Category of custom field
|
|
1285
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1286
|
+
* @property {string} [type] - Category of custom field
|
|
1287
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1288
|
+
* validations available for the field
|
|
1386
1289
|
*/
|
|
1387
1290
|
|
|
1388
1291
|
/**
|
|
1389
1292
|
* @typedef Date
|
|
1390
|
-
* @property {string} [name]
|
|
1391
|
-
* @property {boolean} [list_enabled]
|
|
1392
|
-
* @property {string} [category]
|
|
1393
|
-
* @property {string} [type]
|
|
1394
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1293
|
+
* @property {string} [name] - Name data type of custom field
|
|
1294
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1295
|
+
* @property {string} [category] - Category of custom field
|
|
1296
|
+
* @property {string} [type] - Type of custom field
|
|
1297
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1298
|
+
* validations available for the field
|
|
1395
1299
|
*/
|
|
1396
1300
|
|
|
1397
1301
|
/**
|
|
1398
1302
|
* @typedef Datetime
|
|
1399
|
-
* @property {string} [name]
|
|
1400
|
-
* @property {string} [category]
|
|
1401
|
-
* @property {boolean} [list_enabled]
|
|
1402
|
-
* @property {string} [type]
|
|
1403
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1303
|
+
* @property {string} [name] - Name data type of custom field
|
|
1304
|
+
* @property {string} [category] - Category of custom field
|
|
1305
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1306
|
+
* @property {string} [type] - Type of custom field
|
|
1307
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1308
|
+
* validations available for the field
|
|
1404
1309
|
*/
|
|
1405
1310
|
|
|
1406
1311
|
/**
|
|
1407
1312
|
* @typedef Json
|
|
1408
|
-
* @property {string} [name]
|
|
1409
|
-
* @property {boolean} [list_enabled]
|
|
1410
|
-
* @property {string} [category]
|
|
1411
|
-
* @property {string} [type]
|
|
1412
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1313
|
+
* @property {string} [name] - Name data type of custom field
|
|
1314
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1315
|
+
* @property {string} [category] - Category of custom field
|
|
1316
|
+
* @property {string} [type] - Type of custom field
|
|
1317
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1318
|
+
* validations available for the field
|
|
1413
1319
|
*/
|
|
1414
1320
|
|
|
1415
1321
|
/**
|
|
1416
1322
|
* @typedef File
|
|
1417
|
-
* @property {string} [name]
|
|
1418
|
-
* @property {string} [category]
|
|
1419
|
-
* @property {boolean} [list_enabled]
|
|
1420
|
-
* @property {string} [type]
|
|
1323
|
+
* @property {string} [name] - Name data type of custom field
|
|
1324
|
+
* @property {string} [category] - Category of custom field
|
|
1325
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1326
|
+
* @property {string} [type] - Type of custom field
|
|
1421
1327
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1422
1328
|
*/
|
|
1423
1329
|
|
|
1424
1330
|
/**
|
|
1425
1331
|
* @typedef Url
|
|
1426
|
-
* @property {string} [name]
|
|
1427
|
-
* @property {boolean} [list_enabled]
|
|
1428
|
-
* @property {string} [type]
|
|
1429
|
-
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1332
|
+
* @property {string} [name] - Name data type of custom field
|
|
1333
|
+
* @property {boolean} [list_enabled] - Flag for listing enabled or not
|
|
1334
|
+
* @property {string} [type] - Type of custom field
|
|
1335
|
+
* @property {SupportedValidationsSchema[]} [supported_validations] - List of
|
|
1336
|
+
* validations available for the field
|
|
1430
1337
|
*/
|
|
1431
1338
|
|
|
1432
1339
|
/**
|
|
1433
1340
|
* @typedef Metaobject
|
|
1434
|
-
* @property {string} [name]
|
|
1435
|
-
* @property {boolean} [list_enabled]
|
|
1436
|
-
*
|
|
1437
|
-
* @property {string} [
|
|
1341
|
+
* @property {string} [name] - Name of Custom Object
|
|
1342
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1343
|
+
* multiple list items
|
|
1344
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1345
|
+
* Custom Object belongs to
|
|
1346
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1438
1347
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1439
1348
|
*/
|
|
1440
1349
|
|
|
1441
1350
|
/**
|
|
1442
1351
|
* @typedef Product
|
|
1443
|
-
* @property {string} [name]
|
|
1444
|
-
* @property {boolean} [list_enabled]
|
|
1445
|
-
*
|
|
1446
|
-
* @property {string} [
|
|
1352
|
+
* @property {string} [name] - Name of Product
|
|
1353
|
+
* @property {boolean} [list_enabled] - Whether the field is allowed to have
|
|
1354
|
+
* multiple list items
|
|
1355
|
+
* @property {string} [category] - Category of Custom Object Definition that
|
|
1356
|
+
* Product is associated with
|
|
1357
|
+
* @property {string} [type] - Custom Object Definition that Product is associated with
|
|
1447
1358
|
* @property {SupportedValidationsSchema[]} [supported_validations]
|
|
1448
|
-
* @property {string[]} [scope]
|
|
1449
1359
|
*/
|
|
1450
1360
|
|
|
1451
1361
|
/**
|
|
1452
1362
|
* @typedef CustomObjectEntry
|
|
1453
|
-
* @property {string} [
|
|
1454
|
-
* @property {string} [name]
|
|
1455
|
-
* @property {string} [type]
|
|
1456
|
-
* @property {string} [updated_at]
|
|
1457
|
-
* @property {number} [entries_count]
|
|
1458
|
-
*
|
|
1363
|
+
* @property {string} [id] - Unique system generated id
|
|
1364
|
+
* @property {string} [name] - Name of Custom Object definition
|
|
1365
|
+
* @property {string} [type] - Type of Custom Object Definition
|
|
1366
|
+
* @property {string} [updated_at] - Updation time of a Custom Object
|
|
1367
|
+
* @property {number} [entries_count] - Number of entries against the Custom
|
|
1368
|
+
* Object definition
|
|
1369
|
+
* @property {number} [fields_count] - Number of fields against a Custom Object definition
|
|
1459
1370
|
*/
|
|
1460
1371
|
|
|
1461
1372
|
/**
|
|
@@ -1466,21 +1377,33 @@ const Joi = require("joi");
|
|
|
1466
1377
|
|
|
1467
1378
|
/**
|
|
1468
1379
|
* @typedef CustomObjectEntryFieldSchema
|
|
1469
|
-
* @property {string} [
|
|
1380
|
+
* @property {string} [namespace] - This is namespace for a custom field definition
|
|
1381
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1382
|
+
*/
|
|
1383
|
+
|
|
1384
|
+
/**
|
|
1385
|
+
* @typedef CustomObjectEntryFieldSchemaWithoutID
|
|
1386
|
+
* @property {string} [slug] - Custom fields belonging to a custom object
|
|
1387
|
+
* @property {Object} [value] - Value of custom field inside a custom object
|
|
1470
1388
|
*/
|
|
1471
1389
|
|
|
1472
1390
|
/**
|
|
1473
1391
|
* @typedef CustomObjectRequestSchema
|
|
1474
|
-
* @property {string} [status]
|
|
1475
|
-
* @property {string} [slug]
|
|
1476
|
-
* @property {
|
|
1477
|
-
|
|
1392
|
+
* @property {string} [status] - Flag to denote status of Custom Object
|
|
1393
|
+
* @property {string} [slug] - This is slug for a custom field definition
|
|
1394
|
+
* @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
|
|
1395
|
+
*/
|
|
1396
|
+
|
|
1397
|
+
/**
|
|
1398
|
+
* @typedef CustomObjectRequestSchemaWithoutId
|
|
1399
|
+
* @property {string} [status] - Status of the custom object entry.
|
|
1400
|
+
* @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
|
|
1478
1401
|
*/
|
|
1479
1402
|
|
|
1480
1403
|
/**
|
|
1481
1404
|
* @typedef CustomObjectBulkSchema
|
|
1482
|
-
* @property {string} [url]
|
|
1483
|
-
* @property {number} [total_records]
|
|
1405
|
+
* @property {string} [url] - Full URL for the bulk operations data
|
|
1406
|
+
* @property {number} [total_records] - Total records in the upload.
|
|
1484
1407
|
*/
|
|
1485
1408
|
|
|
1486
1409
|
/**
|
|
@@ -1491,6 +1414,297 @@ const Joi = require("joi");
|
|
|
1491
1414
|
* @property {PageType} type
|
|
1492
1415
|
*/
|
|
1493
1416
|
|
|
1417
|
+
/**
|
|
1418
|
+
* @typedef TranslateUiLabels
|
|
1419
|
+
* @property {string} [_id] - Unique identifier assigned to the Translate Ui Labels entry
|
|
1420
|
+
* @property {string} [company_id] - Identifier linking the resource to a
|
|
1421
|
+
* specific company within the platform
|
|
1422
|
+
* @property {string} [application_id] - Reference to the application where this
|
|
1423
|
+
* Translate Ui Labels is utilized
|
|
1424
|
+
* @property {string} [template_theme_id] - Links the resource to a specific
|
|
1425
|
+
* template theme configuration
|
|
1426
|
+
* @property {string} [theme_id] - Associates the resource with a particular
|
|
1427
|
+
* theme implementation
|
|
1428
|
+
* @property {string} [locale] - Specifies the language and region format for
|
|
1429
|
+
* the resource content
|
|
1430
|
+
* @property {Object} [resource] - Contains the actual resource data and
|
|
1431
|
+
* configuration settings
|
|
1432
|
+
* @property {string} [type] - Categorizes the resource type for proper handling
|
|
1433
|
+
* and processing
|
|
1434
|
+
*/
|
|
1435
|
+
|
|
1436
|
+
/**
|
|
1437
|
+
* @typedef TranslateUiLabelsCreate
|
|
1438
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1439
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1440
|
+
* @property {string} [locale] - Locale
|
|
1441
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1442
|
+
* @property {string} [type] - Resource type
|
|
1443
|
+
*/
|
|
1444
|
+
|
|
1445
|
+
/**
|
|
1446
|
+
* @typedef StaticResourceUpdate
|
|
1447
|
+
* @property {string} [template_theme_id] - Unique identifier for the template theme
|
|
1448
|
+
* @property {string} [theme_id] - Unique identifier for the theme
|
|
1449
|
+
* @property {string} [locale] - Locale
|
|
1450
|
+
* @property {Object} [resource] - Translate Ui Labels json object
|
|
1451
|
+
* @property {string} [type] - Resource type
|
|
1452
|
+
*/
|
|
1453
|
+
|
|
1454
|
+
/**
|
|
1455
|
+
* @typedef TranslateUiLabelsPage
|
|
1456
|
+
* @property {TranslateUiLabels[]} [items] - List of items containing all the
|
|
1457
|
+
* static info data.
|
|
1458
|
+
* @property {Page} [page]
|
|
1459
|
+
*/
|
|
1460
|
+
|
|
1461
|
+
/**
|
|
1462
|
+
* @typedef Error
|
|
1463
|
+
* @property {string} [error] - Detailed message explaining the error that occurred
|
|
1464
|
+
*/
|
|
1465
|
+
|
|
1466
|
+
/**
|
|
1467
|
+
* @typedef Meta
|
|
1468
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1469
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1470
|
+
* this resource
|
|
1471
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1472
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1473
|
+
*/
|
|
1474
|
+
|
|
1475
|
+
/**
|
|
1476
|
+
* @typedef CompanyLanguage
|
|
1477
|
+
* @property {string} [_id] - Unique identifier for the company language setting
|
|
1478
|
+
* @property {string} company_id - Identifier of the company this language
|
|
1479
|
+
* configuration belongs to
|
|
1480
|
+
* @property {string} [locale] - Language code following ISO standards for this
|
|
1481
|
+
* company setting
|
|
1482
|
+
* @property {string} [name] - Display name of the language for company usage
|
|
1483
|
+
* @property {string} [direction] - Text direction setting for company content
|
|
1484
|
+
* in this language
|
|
1485
|
+
* @property {boolean} [is_default] - Indicates if this is the default language
|
|
1486
|
+
* for the company
|
|
1487
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1488
|
+
* English for easy reference and display at the website.
|
|
1489
|
+
*/
|
|
1490
|
+
|
|
1491
|
+
/**
|
|
1492
|
+
* @typedef CompanyLanguageCreate
|
|
1493
|
+
* @property {string[]} locales - List of language codes to be added to company
|
|
1494
|
+
* configuration
|
|
1495
|
+
*/
|
|
1496
|
+
|
|
1497
|
+
/**
|
|
1498
|
+
* @typedef CompanyLanguageUpdate
|
|
1499
|
+
* @property {boolean} is_default - Sets the specified language as the company default
|
|
1500
|
+
*/
|
|
1501
|
+
|
|
1502
|
+
/**
|
|
1503
|
+
* @typedef ApplicationLanguage
|
|
1504
|
+
* @property {string} [_id] - Unique identifier for the application language setting
|
|
1505
|
+
* @property {string} company_id - Identifier of the company this application belongs to
|
|
1506
|
+
* @property {string} application_id - Unique identifier of the application
|
|
1507
|
+
* using this language
|
|
1508
|
+
* @property {string} locale - Language code following ISO standards for this application
|
|
1509
|
+
* @property {string} name - Display name of the language for application usage
|
|
1510
|
+
* @property {string} direction - Specifies the text direction for displaying
|
|
1511
|
+
* application content, either left-to-right (ltr) or right-to-left (rtl)
|
|
1512
|
+
* @property {boolean} is_default - Indicates if this is the default language
|
|
1513
|
+
* for the application
|
|
1514
|
+
* @property {boolean} published - Indicates whether this language is currently
|
|
1515
|
+
* active and visible within the storefront.
|
|
1516
|
+
* @property {string} [display_name] - Translated name of the language in
|
|
1517
|
+
* English for easy reference and display at the website.
|
|
1518
|
+
*/
|
|
1519
|
+
|
|
1520
|
+
/**
|
|
1521
|
+
* @typedef unPublishApplicationLanguage
|
|
1522
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1523
|
+
*/
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* @typedef ApplicationLanguageCreate
|
|
1527
|
+
* @property {string[]} locales - List of language codes to be added to
|
|
1528
|
+
* application configuration
|
|
1529
|
+
*/
|
|
1530
|
+
|
|
1531
|
+
/**
|
|
1532
|
+
* @typedef ApplicationLanguageUpdate
|
|
1533
|
+
* @property {boolean} is_default - Sets the specified language as the application default
|
|
1534
|
+
* @property {boolean} published - Updates the publication status of the language
|
|
1535
|
+
*/
|
|
1536
|
+
|
|
1537
|
+
/**
|
|
1538
|
+
* @typedef TranslatableResource
|
|
1539
|
+
* @property {string} [_id] - Unique identifier for the translatable resource
|
|
1540
|
+
* @property {string} type - Categorizes the type of content that can be translated
|
|
1541
|
+
* @property {string} name - Display name of the translatable resource
|
|
1542
|
+
* @property {string} description - Detailed explanation of the translatable resource
|
|
1543
|
+
* @property {string} schema_type - Defines the processing type for the
|
|
1544
|
+
* translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
|
|
1545
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1546
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1547
|
+
* this resource
|
|
1548
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1549
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1550
|
+
* @property {TranslatableSection} [section_id]
|
|
1551
|
+
*/
|
|
1552
|
+
|
|
1553
|
+
/**
|
|
1554
|
+
* @typedef ResourceDefinition
|
|
1555
|
+
* @property {string} [_id] - Unique identifier for the resource definition
|
|
1556
|
+
* @property {string} translatable_resource_id - Reference to the associated
|
|
1557
|
+
* translatable resource
|
|
1558
|
+
* @property {ResourceJsonSchema} [json_schema]
|
|
1559
|
+
* @property {ResourceUISchema} [ui_schema]
|
|
1560
|
+
* @property {ResourceBulkDetails} [bulk_details]
|
|
1561
|
+
*/
|
|
1562
|
+
|
|
1563
|
+
/**
|
|
1564
|
+
* @typedef ResourceJsonSchema
|
|
1565
|
+
* @property {string} [schema]
|
|
1566
|
+
* @property {ResourceJsonSchemaType} [type]
|
|
1567
|
+
*/
|
|
1568
|
+
|
|
1569
|
+
/**
|
|
1570
|
+
* @typedef ResourceJsonSchemaType
|
|
1571
|
+
* @property {Author} [author]
|
|
1572
|
+
* @property {Title} [title]
|
|
1573
|
+
* @property {FeatureImage} [feature_image]
|
|
1574
|
+
*/
|
|
1575
|
+
|
|
1576
|
+
/**
|
|
1577
|
+
* @typedef ResourceUISchema
|
|
1578
|
+
* @property {Author} [author]
|
|
1579
|
+
* @property {Title} [title]
|
|
1580
|
+
* @property {FeatureImage} [feature_image]
|
|
1581
|
+
* @property {Seo} [seo]
|
|
1582
|
+
*/
|
|
1583
|
+
|
|
1584
|
+
/**
|
|
1585
|
+
* @typedef ResourceBulkDetails
|
|
1586
|
+
* @property {string[]} [fields]
|
|
1587
|
+
*/
|
|
1588
|
+
|
|
1589
|
+
/**
|
|
1590
|
+
* @typedef Title
|
|
1591
|
+
* @property {string} [ui_widget]
|
|
1592
|
+
* @property {boolean} [ui_description]
|
|
1593
|
+
*/
|
|
1594
|
+
|
|
1595
|
+
/**
|
|
1596
|
+
* @typedef FeatureImage
|
|
1597
|
+
* @property {string} [secure_url] - URL of the secure image
|
|
1598
|
+
*/
|
|
1599
|
+
|
|
1600
|
+
/**
|
|
1601
|
+
* @typedef Seo
|
|
1602
|
+
* @property {Title} [title]
|
|
1603
|
+
* @property {string} [description]
|
|
1604
|
+
* @property {string} [canonical_url]
|
|
1605
|
+
* @property {MetaTag[]} [meta_tags]
|
|
1606
|
+
*/
|
|
1607
|
+
|
|
1608
|
+
/**
|
|
1609
|
+
* @typedef MetaTag
|
|
1610
|
+
* @property {string} [title] - Title of the meta tag
|
|
1611
|
+
* @property {MetaTagItem[]} [items]
|
|
1612
|
+
*/
|
|
1613
|
+
|
|
1614
|
+
/**
|
|
1615
|
+
* @typedef MetaTagItem
|
|
1616
|
+
* @property {string} [key] - Key of the meta tag item
|
|
1617
|
+
* @property {string} [value] - Value of the meta tag item
|
|
1618
|
+
*/
|
|
1619
|
+
|
|
1620
|
+
/**
|
|
1621
|
+
* @typedef ResourceTranslation
|
|
1622
|
+
* @property {string} [_id] - Unique identifier for the translation entry
|
|
1623
|
+
* @property {string} [locale] - Language code for this translation
|
|
1624
|
+
* @property {TranslationValue} [value]
|
|
1625
|
+
*/
|
|
1626
|
+
|
|
1627
|
+
/**
|
|
1628
|
+
* @typedef TranslationValue
|
|
1629
|
+
* @property {string} [name] - Translated name
|
|
1630
|
+
* @property {TranslationSeo} [seo]
|
|
1631
|
+
*/
|
|
1632
|
+
|
|
1633
|
+
/**
|
|
1634
|
+
* @typedef TranslationSeo
|
|
1635
|
+
* @property {string} [title] - Translated SEO title
|
|
1636
|
+
* @property {string[]} [breadcrumbs] - List of translated breadcrumbs
|
|
1637
|
+
* @property {string[]} [meta_tags] - List of translated meta tags
|
|
1638
|
+
* @property {string} [canonical_url] - Translated canonical URL
|
|
1639
|
+
* @property {string} [description] - Translated SEO description
|
|
1640
|
+
*/
|
|
1641
|
+
|
|
1642
|
+
/**
|
|
1643
|
+
* @typedef ResourceTranslationList
|
|
1644
|
+
* @property {ResourceTranslationCreate[]} [items]
|
|
1645
|
+
*/
|
|
1646
|
+
|
|
1647
|
+
/**
|
|
1648
|
+
* @typedef ResourceTranslationCreate
|
|
1649
|
+
* @property {string} [type] - Type of content being translated
|
|
1650
|
+
* @property {string} [resource_id] - Identifier of the resource requiring translation
|
|
1651
|
+
* @property {string} [locale] - Target language code for the translation
|
|
1652
|
+
* @property {TranslationValue} [value]
|
|
1653
|
+
*/
|
|
1654
|
+
|
|
1655
|
+
/**
|
|
1656
|
+
* @typedef ResourceTranslationUpdate
|
|
1657
|
+
* @property {TranslationValue} [value]
|
|
1658
|
+
*/
|
|
1659
|
+
|
|
1660
|
+
/**
|
|
1661
|
+
* @typedef TranslatableSection
|
|
1662
|
+
* @property {string} [_id] - Unique identifier for the translatable section
|
|
1663
|
+
* @property {string} [name] - Display name of the section
|
|
1664
|
+
* @property {string} [description] - Detailed explanation of the section's purpose
|
|
1665
|
+
* @property {string} [created_by] - Identifier of the user who created this resource
|
|
1666
|
+
* @property {string} [modified_by] - Identifier of the user who last modified
|
|
1667
|
+
* this resource
|
|
1668
|
+
* @property {string} [created_on] - Timestamp when this resource was initially created
|
|
1669
|
+
* @property {string} [modified_on] - Timestamp when this resource was last modified
|
|
1670
|
+
*/
|
|
1671
|
+
|
|
1672
|
+
/**
|
|
1673
|
+
* @typedef Metrics
|
|
1674
|
+
* @property {number} [total] - Total number of translation operations attempted
|
|
1675
|
+
* @property {number} [success] - Number of successful translation operations
|
|
1676
|
+
* @property {number} [failed] - Number of failed translation operations
|
|
1677
|
+
*/
|
|
1678
|
+
|
|
1679
|
+
/**
|
|
1680
|
+
* @typedef ResourceTranslationUpsertItem
|
|
1681
|
+
* @property {string} [message] - Status message for the translation operation
|
|
1682
|
+
* @property {ResourceTranslationCreate} [data]
|
|
1683
|
+
*/
|
|
1684
|
+
|
|
1685
|
+
/**
|
|
1686
|
+
* @typedef ResourceTranslationBulkUpsert
|
|
1687
|
+
* @property {Metrics} [metrics]
|
|
1688
|
+
* @property {ResourceTranslationUpsertItem[]} [failed_items] - List of failed
|
|
1689
|
+
* translation operations
|
|
1690
|
+
* @property {ResourceTranslationUpsertItem[]} [updated_items] - List of
|
|
1691
|
+
* successful translation operations
|
|
1692
|
+
*/
|
|
1693
|
+
|
|
1694
|
+
/**
|
|
1695
|
+
* @typedef StandardError
|
|
1696
|
+
* @property {string} message - A brief description of the error.
|
|
1697
|
+
*/
|
|
1698
|
+
|
|
1699
|
+
/**
|
|
1700
|
+
* @typedef OperationResponseSchema
|
|
1701
|
+
* @property {boolean} success - Indicates if the operation was successful
|
|
1702
|
+
* @property {string} [message] - Optional message providing additional
|
|
1703
|
+
* information about the operation
|
|
1704
|
+
*/
|
|
1705
|
+
|
|
1706
|
+
/** @typedef {"title" | "description"} GenerationEntityType */
|
|
1707
|
+
|
|
1494
1708
|
/**
|
|
1495
1709
|
* @typedef {| "about-us"
|
|
1496
1710
|
* | "addresses"
|
|
@@ -1543,6 +1757,14 @@ const Joi = require("joi");
|
|
|
1543
1757
|
*/
|
|
1544
1758
|
|
|
1545
1759
|
class ContentPlatformModel {
|
|
1760
|
+
/** @returns {ValidationError} */
|
|
1761
|
+
static ValidationError() {
|
|
1762
|
+
return Joi.object({
|
|
1763
|
+
message: Joi.string().allow("").required(),
|
|
1764
|
+
field: Joi.string().allow("").required(),
|
|
1765
|
+
});
|
|
1766
|
+
}
|
|
1767
|
+
|
|
1546
1768
|
/** @returns {GenerateSEOContent} */
|
|
1547
1769
|
static GenerateSEOContent() {
|
|
1548
1770
|
return Joi.object({
|
|
@@ -1573,7 +1795,6 @@ class ContentPlatformModel {
|
|
|
1573
1795
|
_id: Joi.string().allow(""),
|
|
1574
1796
|
updated_at: Joi.string().allow(""),
|
|
1575
1797
|
created_at: Joi.string().allow(""),
|
|
1576
|
-
__v: Joi.number(),
|
|
1577
1798
|
});
|
|
1578
1799
|
}
|
|
1579
1800
|
|
|
@@ -1594,7 +1815,7 @@ class ContentPlatformModel {
|
|
|
1594
1815
|
redirect_to: Joi.string().allow(""),
|
|
1595
1816
|
updated_at: Joi.string().allow(""),
|
|
1596
1817
|
created_at: Joi.string().allow(""),
|
|
1597
|
-
|
|
1818
|
+
__source: ContentPlatformModel.PathSourceSchema(),
|
|
1598
1819
|
});
|
|
1599
1820
|
}
|
|
1600
1821
|
|
|
@@ -1616,8 +1837,8 @@ class ContentPlatformModel {
|
|
|
1616
1837
|
/** @returns {SeoSchema} */
|
|
1617
1838
|
static SeoSchema() {
|
|
1618
1839
|
return Joi.object({
|
|
1619
|
-
_id: Joi.string().allow(""),
|
|
1620
1840
|
app: Joi.string().allow(""),
|
|
1841
|
+
_id: Joi.string().allow(""),
|
|
1621
1842
|
robots_txt: Joi.string().allow(""),
|
|
1622
1843
|
sitemap_enabled: Joi.boolean(),
|
|
1623
1844
|
additional_sitemap: Joi.string().allow(""),
|
|
@@ -1626,8 +1847,6 @@ class ContentPlatformModel {
|
|
|
1626
1847
|
details: ContentPlatformModel.Detail(),
|
|
1627
1848
|
created_at: Joi.string().allow(""),
|
|
1628
1849
|
updated_at: Joi.string().allow(""),
|
|
1629
|
-
__v: Joi.number(),
|
|
1630
|
-
sitemap: ContentPlatformModel.SEOSitemap(),
|
|
1631
1850
|
});
|
|
1632
1851
|
}
|
|
1633
1852
|
|
|
@@ -1660,17 +1879,16 @@ class ContentPlatformModel {
|
|
|
1660
1879
|
/** @returns {SEOSchemaMarkupTemplate} */
|
|
1661
1880
|
static SEOSchemaMarkupTemplate() {
|
|
1662
1881
|
return Joi.object({
|
|
1663
|
-
|
|
1882
|
+
id: Joi.string().allow(""),
|
|
1664
1883
|
title: Joi.string().allow(""),
|
|
1665
1884
|
page_type: Joi.string().allow(""),
|
|
1666
1885
|
schema: Joi.string().allow(""),
|
|
1667
1886
|
description: Joi.string().allow(""),
|
|
1668
1887
|
active: Joi.boolean(),
|
|
1669
|
-
application: Joi.string().allow(""),
|
|
1670
1888
|
created_at: Joi.string().allow(""),
|
|
1671
1889
|
updated_at: Joi.string().allow(""),
|
|
1890
|
+
application: Joi.string().allow(""),
|
|
1672
1891
|
target_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1673
|
-
__v: Joi.number(),
|
|
1674
1892
|
});
|
|
1675
1893
|
}
|
|
1676
1894
|
|
|
@@ -1679,46 +1897,12 @@ class ContentPlatformModel {
|
|
|
1679
1897
|
return Joi.object({
|
|
1680
1898
|
title: Joi.string().allow(""),
|
|
1681
1899
|
page_type: Joi.string().allow(""),
|
|
1682
|
-
description: Joi.string().allow(""),
|
|
1683
1900
|
schema: Joi.string().allow(""),
|
|
1901
|
+
description: Joi.string().allow(""),
|
|
1684
1902
|
target_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1685
1903
|
active: Joi.boolean(),
|
|
1686
1904
|
created_at: Joi.string().allow(""),
|
|
1687
|
-
|
|
1688
|
-
}
|
|
1689
|
-
|
|
1690
|
-
/** @returns {DeletPathMappingSchema} */
|
|
1691
|
-
static DeletPathMappingSchema() {
|
|
1692
|
-
return Joi.object({
|
|
1693
|
-
message: Joi.string().allow(""),
|
|
1694
|
-
data: ContentPlatformModel.PathMappingSchema(),
|
|
1695
|
-
});
|
|
1696
|
-
}
|
|
1697
|
-
|
|
1698
|
-
/** @returns {CreatePathMappingSchema} */
|
|
1699
|
-
static CreatePathMappingSchema() {
|
|
1700
|
-
return Joi.object({
|
|
1701
|
-
message: Joi.string().allow(""),
|
|
1702
|
-
data: ContentPlatformModel.PathMappingSchema(),
|
|
1703
|
-
});
|
|
1704
|
-
}
|
|
1705
|
-
|
|
1706
|
-
/** @returns {GetAllPathMappingSchema} */
|
|
1707
|
-
static GetAllPathMappingSchema() {
|
|
1708
|
-
return Joi.object({
|
|
1709
|
-
message: Joi.string().allow(""),
|
|
1710
|
-
data: ContentPlatformModel.GetPathSchema(),
|
|
1711
|
-
});
|
|
1712
|
-
}
|
|
1713
|
-
|
|
1714
|
-
/** @returns {GetPathSchema} */
|
|
1715
|
-
static GetPathSchema() {
|
|
1716
|
-
return Joi.object({
|
|
1717
|
-
docs: Joi.array().items(ContentPlatformModel.PathMappingSchema()),
|
|
1718
|
-
page: Joi.number(),
|
|
1719
|
-
limit: Joi.number(),
|
|
1720
|
-
pages: Joi.number(),
|
|
1721
|
-
total: Joi.number(),
|
|
1905
|
+
updated_at: Joi.string().allow(""),
|
|
1722
1906
|
});
|
|
1723
1907
|
}
|
|
1724
1908
|
|
|
@@ -1779,13 +1963,13 @@ class ContentPlatformModel {
|
|
|
1779
1963
|
return Joi.object({
|
|
1780
1964
|
page_type: Joi.string().allow(""),
|
|
1781
1965
|
schema: Joi.string().allow(""),
|
|
1966
|
+
target_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1782
1967
|
});
|
|
1783
1968
|
}
|
|
1784
1969
|
|
|
1785
1970
|
/** @returns {ScheduleSchema} */
|
|
1786
1971
|
static ScheduleSchema() {
|
|
1787
1972
|
return Joi.object({
|
|
1788
|
-
published: Joi.boolean(),
|
|
1789
1973
|
cron: Joi.string().allow(""),
|
|
1790
1974
|
start: Joi.string().allow(""),
|
|
1791
1975
|
end: Joi.string().allow(""),
|
|
@@ -1802,8 +1986,8 @@ class ContentPlatformModel {
|
|
|
1802
1986
|
});
|
|
1803
1987
|
}
|
|
1804
1988
|
|
|
1805
|
-
/** @returns {
|
|
1806
|
-
static
|
|
1989
|
+
/** @returns {BlogGetDetails} */
|
|
1990
|
+
static BlogGetDetails() {
|
|
1807
1991
|
return Joi.object({
|
|
1808
1992
|
items: Joi.array().items(ContentPlatformModel.BlogSchema()),
|
|
1809
1993
|
page: ContentPlatformModel.Page(),
|
|
@@ -1848,7 +2032,7 @@ class ContentPlatformModel {
|
|
|
1848
2032
|
static BlogSchema() {
|
|
1849
2033
|
return Joi.object({
|
|
1850
2034
|
_id: Joi.string().allow(""),
|
|
1851
|
-
_custom_json: Joi.any(),
|
|
2035
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1852
2036
|
application: Joi.string().allow(""),
|
|
1853
2037
|
archived: Joi.boolean(),
|
|
1854
2038
|
author: ContentPlatformModel.Author(),
|
|
@@ -1863,7 +2047,6 @@ class ContentPlatformModel {
|
|
|
1863
2047
|
title: Joi.string().allow(""),
|
|
1864
2048
|
date_meta: ContentPlatformModel.DateMeta(),
|
|
1865
2049
|
summary: Joi.string().allow(""),
|
|
1866
|
-
status: Joi.string().allow(""),
|
|
1867
2050
|
});
|
|
1868
2051
|
}
|
|
1869
2052
|
|
|
@@ -1875,7 +2058,7 @@ class ContentPlatformModel {
|
|
|
1875
2058
|
title: Joi.string().allow(""),
|
|
1876
2059
|
meta_tags: Joi.array().items(ContentPlatformModel.SEOMetaItem()),
|
|
1877
2060
|
sitemap: ContentPlatformModel.SEOSitemap(),
|
|
1878
|
-
|
|
2061
|
+
breadcrumb: Joi.array().items(ContentPlatformModel.SEObreadcrumb()),
|
|
1879
2062
|
canonical_url: Joi.string().allow(""),
|
|
1880
2063
|
});
|
|
1881
2064
|
}
|
|
@@ -1927,11 +2110,11 @@ class ContentPlatformModel {
|
|
|
1927
2110
|
});
|
|
1928
2111
|
}
|
|
1929
2112
|
|
|
1930
|
-
/** @returns {
|
|
1931
|
-
static
|
|
2113
|
+
/** @returns {BlogPayload} */
|
|
2114
|
+
static BlogPayload() {
|
|
1932
2115
|
return Joi.object({
|
|
1933
2116
|
application: Joi.string().allow(""),
|
|
1934
|
-
_custom_json: Joi.any(),
|
|
2117
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1935
2118
|
author: ContentPlatformModel.Author(),
|
|
1936
2119
|
content: Joi.array().items(ContentPlatformModel.ResourceContent()),
|
|
1937
2120
|
feature_image: ContentPlatformModel.Asset(),
|
|
@@ -1940,7 +2123,6 @@ class ContentPlatformModel {
|
|
|
1940
2123
|
slug: Joi.string().allow(""),
|
|
1941
2124
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
1942
2125
|
title: Joi.string().allow(""),
|
|
1943
|
-
publish_date: Joi.string().allow(""),
|
|
1944
2126
|
seo: ContentPlatformModel.SEO(),
|
|
1945
2127
|
summary: Joi.string().allow(""),
|
|
1946
2128
|
});
|
|
@@ -1962,13 +2144,6 @@ class ContentPlatformModel {
|
|
|
1962
2144
|
});
|
|
1963
2145
|
}
|
|
1964
2146
|
|
|
1965
|
-
/** @returns {DataLoaderItemsResponseSchema} */
|
|
1966
|
-
static DataLoaderItemsResponseSchema() {
|
|
1967
|
-
return Joi.object({
|
|
1968
|
-
items: Joi.array().items(ContentPlatformModel.DataLoaderResponseSchema()),
|
|
1969
|
-
});
|
|
1970
|
-
}
|
|
1971
|
-
|
|
1972
2147
|
/** @returns {DataLoaderResponseSchema} */
|
|
1973
2148
|
static DataLoaderResponseSchema() {
|
|
1974
2149
|
return Joi.object({
|
|
@@ -1981,10 +2156,6 @@ class ContentPlatformModel {
|
|
|
1981
2156
|
type: Joi.string().allow(""),
|
|
1982
2157
|
url: Joi.string().allow(""),
|
|
1983
2158
|
content: Joi.string().allow(""),
|
|
1984
|
-
created_at: Joi.string().allow(""),
|
|
1985
|
-
modified_at: Joi.string().allow(""),
|
|
1986
|
-
__v: Joi.number(),
|
|
1987
|
-
is_selected: Joi.boolean(),
|
|
1988
2159
|
__source: ContentPlatformModel.DataLoaderSourceSchema(),
|
|
1989
2160
|
});
|
|
1990
2161
|
}
|
|
@@ -1992,7 +2163,7 @@ class ContentPlatformModel {
|
|
|
1992
2163
|
/** @returns {DataLoaderResetResponseSchema} */
|
|
1993
2164
|
static DataLoaderResetResponseSchema() {
|
|
1994
2165
|
return Joi.object({
|
|
1995
|
-
|
|
2166
|
+
reset: Joi.boolean(),
|
|
1996
2167
|
});
|
|
1997
2168
|
}
|
|
1998
2169
|
|
|
@@ -2029,6 +2200,7 @@ class ContentPlatformModel {
|
|
|
2029
2200
|
_locale_language: ContentPlatformModel.LocaleLanguage(),
|
|
2030
2201
|
image: Joi.string().allow(""),
|
|
2031
2202
|
type: Joi.string().allow(""),
|
|
2203
|
+
action: ContentPlatformModel.Action(),
|
|
2032
2204
|
active: Joi.boolean(),
|
|
2033
2205
|
display: Joi.string().allow(""),
|
|
2034
2206
|
sort_order: Joi.number(),
|
|
@@ -2037,17 +2209,8 @@ class ContentPlatformModel {
|
|
|
2037
2209
|
}).id("NavigationReference");
|
|
2038
2210
|
}
|
|
2039
2211
|
|
|
2040
|
-
/** @returns {
|
|
2041
|
-
static
|
|
2042
|
-
return Joi.object({
|
|
2043
|
-
platform: Joi.string().allow(""),
|
|
2044
|
-
orientation: Joi.string().allow(""),
|
|
2045
|
-
position: Joi.string().allow(""),
|
|
2046
|
-
});
|
|
2047
|
-
}
|
|
2048
|
-
|
|
2049
|
-
/** @returns {CronBasedScheduleSchema} */
|
|
2050
|
-
static CronBasedScheduleSchema() {
|
|
2212
|
+
/** @returns {CronBasedScheduleSchema} */
|
|
2213
|
+
static CronBasedScheduleSchema() {
|
|
2051
2214
|
return Joi.object({
|
|
2052
2215
|
enabled: Joi.boolean(),
|
|
2053
2216
|
cron: Joi.string().allow(""),
|
|
@@ -2067,7 +2230,8 @@ class ContentPlatformModel {
|
|
|
2067
2230
|
static HandpickedTagSchema() {
|
|
2068
2231
|
return Joi.object({
|
|
2069
2232
|
position: Joi.string().allow(""),
|
|
2070
|
-
attributes: Joi.any(),
|
|
2233
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2234
|
+
compatible_engines: Joi.array().items(Joi.string().allow("")),
|
|
2071
2235
|
name: Joi.string().allow(""),
|
|
2072
2236
|
url: Joi.string().allow(""),
|
|
2073
2237
|
type: Joi.string().allow(""),
|
|
@@ -2092,7 +2256,8 @@ class ContentPlatformModel {
|
|
|
2092
2256
|
type: Joi.string().allow(""),
|
|
2093
2257
|
url: Joi.string().allow(""),
|
|
2094
2258
|
position: Joi.string().allow(""),
|
|
2095
|
-
attributes: Joi.any(),
|
|
2259
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2260
|
+
compatible_engines: Joi.array().items(Joi.string().allow("")),
|
|
2096
2261
|
pages: Joi.array().items(Joi.any()),
|
|
2097
2262
|
content: Joi.string().allow(""),
|
|
2098
2263
|
});
|
|
@@ -2108,18 +2273,14 @@ class ContentPlatformModel {
|
|
|
2108
2273
|
/** @returns {DataLoaderSchema} */
|
|
2109
2274
|
static DataLoaderSchema() {
|
|
2110
2275
|
return Joi.object({
|
|
2111
|
-
_id: Joi.string().allow(""),
|
|
2112
|
-
url: Joi.string().allow(""),
|
|
2113
|
-
created_at: Joi.string().allow(""),
|
|
2114
|
-
modified_at: Joi.string().allow(""),
|
|
2115
|
-
application: Joi.string().allow(""),
|
|
2116
|
-
company: Joi.string().allow(""),
|
|
2117
2276
|
name: Joi.string().allow(""),
|
|
2118
2277
|
service: Joi.string().allow(""),
|
|
2119
2278
|
operation_id: Joi.string().allow(""),
|
|
2120
|
-
is_selected: Joi.boolean(),
|
|
2121
2279
|
type: Joi.string().allow(""),
|
|
2280
|
+
url: Joi.string().allow(""),
|
|
2281
|
+
content: Joi.string().allow(""),
|
|
2122
2282
|
__source: ContentPlatformModel.DataLoaderSourceSchema(),
|
|
2283
|
+
_id: Joi.string().allow(""),
|
|
2123
2284
|
});
|
|
2124
2285
|
}
|
|
2125
2286
|
|
|
@@ -2131,32 +2292,6 @@ class ContentPlatformModel {
|
|
|
2131
2292
|
});
|
|
2132
2293
|
}
|
|
2133
2294
|
|
|
2134
|
-
/** @returns {TagSpecSchema} */
|
|
2135
|
-
static TagSpecSchema() {
|
|
2136
|
-
return Joi.object({
|
|
2137
|
-
name: Joi.string().allow(""),
|
|
2138
|
-
description: Joi.string().allow(""),
|
|
2139
|
-
});
|
|
2140
|
-
}
|
|
2141
|
-
|
|
2142
|
-
/** @returns {ServerSchema} */
|
|
2143
|
-
static ServerSchema() {
|
|
2144
|
-
return Joi.object({
|
|
2145
|
-
url: Joi.string().allow(""),
|
|
2146
|
-
});
|
|
2147
|
-
}
|
|
2148
|
-
|
|
2149
|
-
/** @returns {DataLoadersApiSpecSchema} */
|
|
2150
|
-
static DataLoadersApiSpecSchema() {
|
|
2151
|
-
return Joi.object({
|
|
2152
|
-
info: Joi.any(),
|
|
2153
|
-
servers: Joi.array().items(ContentPlatformModel.ServerSchema()),
|
|
2154
|
-
tags: Joi.array().items(ContentPlatformModel.TagSpecSchema()),
|
|
2155
|
-
openapi: Joi.string().allow(""),
|
|
2156
|
-
paths: Joi.object().pattern(/\S/, Joi.any()),
|
|
2157
|
-
});
|
|
2158
|
-
}
|
|
2159
|
-
|
|
2160
2295
|
/** @returns {DataLoadersSchema} */
|
|
2161
2296
|
static DataLoadersSchema() {
|
|
2162
2297
|
return Joi.object({
|
|
@@ -2164,8 +2299,8 @@ class ContentPlatformModel {
|
|
|
2164
2299
|
});
|
|
2165
2300
|
}
|
|
2166
2301
|
|
|
2167
|
-
/** @returns {
|
|
2168
|
-
static
|
|
2302
|
+
/** @returns {TagDeleteSuccessDetails} */
|
|
2303
|
+
static TagDeleteSuccessDetails() {
|
|
2169
2304
|
return Joi.object({
|
|
2170
2305
|
success: Joi.boolean(),
|
|
2171
2306
|
});
|
|
@@ -2178,9 +2313,10 @@ class ContentPlatformModel {
|
|
|
2178
2313
|
status: Joi.number(),
|
|
2179
2314
|
code: Joi.string().allow(""),
|
|
2180
2315
|
exception: Joi.string().allow(""),
|
|
2316
|
+
info: Joi.string().allow(""),
|
|
2181
2317
|
request_id: Joi.string().allow(""),
|
|
2182
2318
|
stack_trace: Joi.string().allow(""),
|
|
2183
|
-
meta: Joi.any(),
|
|
2319
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
2184
2320
|
});
|
|
2185
2321
|
}
|
|
2186
2322
|
|
|
@@ -2202,8 +2338,7 @@ class ContentPlatformModel {
|
|
|
2202
2338
|
slug: Joi.string().allow(""),
|
|
2203
2339
|
application: Joi.string().allow(""),
|
|
2204
2340
|
icon_url: Joi.string().allow(""),
|
|
2205
|
-
_custom_json: Joi.any(),
|
|
2206
|
-
__v: Joi.number(),
|
|
2341
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2207
2342
|
});
|
|
2208
2343
|
}
|
|
2209
2344
|
|
|
@@ -2229,15 +2364,15 @@ class ContentPlatformModel {
|
|
|
2229
2364
|
/** @returns {FAQCategorySchema} */
|
|
2230
2365
|
static FAQCategorySchema() {
|
|
2231
2366
|
return Joi.object({
|
|
2232
|
-
|
|
2233
|
-
application: Joi.string().allow(""),
|
|
2367
|
+
index: Joi.number(),
|
|
2234
2368
|
title: Joi.string().allow(""),
|
|
2235
2369
|
description: Joi.string().allow(""),
|
|
2236
|
-
index: Joi.number(),
|
|
2237
|
-
slug: Joi.string().allow(""),
|
|
2238
2370
|
children: Joi.array().items(ContentPlatformModel.ChildrenSchema()),
|
|
2371
|
+
_id: Joi.string().allow(""),
|
|
2372
|
+
slug: Joi.string().allow(""),
|
|
2373
|
+
application: Joi.string().allow(""),
|
|
2239
2374
|
icon_url: Joi.string().allow(""),
|
|
2240
|
-
|
|
2375
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2241
2376
|
});
|
|
2242
2377
|
}
|
|
2243
2378
|
|
|
@@ -2250,7 +2385,6 @@ class ContentPlatformModel {
|
|
|
2250
2385
|
question: Joi.string().allow(""),
|
|
2251
2386
|
answer: Joi.string().allow(""),
|
|
2252
2387
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
2253
|
-
__v: Joi.number(),
|
|
2254
2388
|
});
|
|
2255
2389
|
}
|
|
2256
2390
|
|
|
@@ -2329,12 +2463,12 @@ class ContentPlatformModel {
|
|
|
2329
2463
|
current: Joi.number(),
|
|
2330
2464
|
type: Joi.string().allow("").required(),
|
|
2331
2465
|
size: Joi.number(),
|
|
2332
|
-
|
|
2466
|
+
page_size: Joi.number(),
|
|
2333
2467
|
});
|
|
2334
2468
|
}
|
|
2335
2469
|
|
|
2336
|
-
/** @returns {
|
|
2337
|
-
static
|
|
2470
|
+
/** @returns {LandingPageGetDetails} */
|
|
2471
|
+
static LandingPageGetDetails() {
|
|
2338
2472
|
return Joi.object({
|
|
2339
2473
|
items: Joi.array().items(ContentPlatformModel.LandingPageSchema()),
|
|
2340
2474
|
page: ContentPlatformModel.Page(),
|
|
@@ -2345,26 +2479,26 @@ class ContentPlatformModel {
|
|
|
2345
2479
|
static LandingPageSchema() {
|
|
2346
2480
|
return Joi.object({
|
|
2347
2481
|
slug: Joi.string().allow(""),
|
|
2482
|
+
action: ContentPlatformModel.Action(),
|
|
2348
2483
|
platform: Joi.array().items(Joi.string().allow("")),
|
|
2349
2484
|
created_by: ContentPlatformModel.CreatedBySchema(),
|
|
2350
2485
|
date_meta: ContentPlatformModel.DateMeta(),
|
|
2351
2486
|
_id: Joi.string().allow(""),
|
|
2352
2487
|
application: Joi.string().allow(""),
|
|
2353
2488
|
archived: Joi.boolean(),
|
|
2354
|
-
_custom_json: Joi.any(),
|
|
2355
|
-
__v: Joi.number(),
|
|
2489
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2356
2490
|
});
|
|
2357
2491
|
}
|
|
2358
2492
|
|
|
2359
|
-
/** @returns {
|
|
2360
|
-
static
|
|
2493
|
+
/** @returns {DefaultNavigationDetails} */
|
|
2494
|
+
static DefaultNavigationDetails() {
|
|
2361
2495
|
return Joi.object({
|
|
2362
2496
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2363
2497
|
});
|
|
2364
2498
|
}
|
|
2365
2499
|
|
|
2366
|
-
/** @returns {
|
|
2367
|
-
static
|
|
2500
|
+
/** @returns {NavigationGetDetails} */
|
|
2501
|
+
static NavigationGetDetails() {
|
|
2368
2502
|
return Joi.object({
|
|
2369
2503
|
items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2370
2504
|
page: ContentPlatformModel.Page(),
|
|
@@ -2393,38 +2527,22 @@ class ContentPlatformModel {
|
|
|
2393
2527
|
orientation: ContentPlatformModel.Orientation(),
|
|
2394
2528
|
version: Joi.number(),
|
|
2395
2529
|
navigation: Joi.array().items(ContentPlatformModel.NavigationReference()),
|
|
2396
|
-
assignments: Joi.array().items(
|
|
2397
|
-
ContentPlatformModel.AssignmentReference()
|
|
2398
|
-
),
|
|
2399
|
-
__v: Joi.number(),
|
|
2400
2530
|
});
|
|
2401
2531
|
}
|
|
2402
2532
|
|
|
2403
|
-
/** @returns {
|
|
2404
|
-
static
|
|
2533
|
+
/** @returns {NavigationPayload} */
|
|
2534
|
+
static NavigationPayload() {
|
|
2405
2535
|
return Joi.object({
|
|
2406
2536
|
name: Joi.string().allow(""),
|
|
2407
2537
|
slug: Joi.string().allow(""),
|
|
2408
2538
|
platform: Joi.array().items(Joi.string().allow("")),
|
|
2409
2539
|
orientation: ContentPlatformModel.Orientation(),
|
|
2410
|
-
assignments: Joi.array().items(
|
|
2411
|
-
ContentPlatformModel.NavigationAssignment()
|
|
2412
|
-
),
|
|
2413
2540
|
navigation: Joi.array().items(ContentPlatformModel.NavigationReference()),
|
|
2414
2541
|
});
|
|
2415
2542
|
}
|
|
2416
2543
|
|
|
2417
|
-
/** @returns {
|
|
2418
|
-
static
|
|
2419
|
-
return Joi.object({
|
|
2420
|
-
platform: Joi.string().allow(""),
|
|
2421
|
-
orientation: Joi.string().allow(""),
|
|
2422
|
-
position: Joi.string().allow(""),
|
|
2423
|
-
});
|
|
2424
|
-
}
|
|
2425
|
-
|
|
2426
|
-
/** @returns {PageGetResponse} */
|
|
2427
|
-
static PageGetResponse() {
|
|
2544
|
+
/** @returns {PageGetDetails} */
|
|
2545
|
+
static PageGetDetails() {
|
|
2428
2546
|
return Joi.object({
|
|
2429
2547
|
items: Joi.array().items(ContentPlatformModel.PageSchema()),
|
|
2430
2548
|
page: ContentPlatformModel.Page(),
|
|
@@ -2456,63 +2574,31 @@ class ContentPlatformModel {
|
|
|
2456
2574
|
});
|
|
2457
2575
|
}
|
|
2458
2576
|
|
|
2459
|
-
/** @returns {PageResponseError} */
|
|
2460
|
-
static PageResponseError() {
|
|
2461
|
-
return Joi.object({
|
|
2462
|
-
errors: Joi.string().allow(""),
|
|
2463
|
-
});
|
|
2464
|
-
}
|
|
2465
|
-
|
|
2466
2577
|
/** @returns {PageSchema} */
|
|
2467
2578
|
static PageSchema() {
|
|
2468
2579
|
return Joi.object({
|
|
2469
2580
|
_id: Joi.string().allow(""),
|
|
2470
2581
|
application: Joi.string().allow(""),
|
|
2471
|
-
|
|
2472
|
-
|
|
2473
|
-
slug: Joi.string().allow(""),
|
|
2474
|
-
type: Joi.string().allow(""),
|
|
2475
|
-
tags: Joi.array().items(Joi.string().allow("")),
|
|
2582
|
+
component_ids: Joi.array().items(Joi.string().allow("")),
|
|
2583
|
+
content: Joi.array().items(Joi.any()),
|
|
2476
2584
|
content_path: Joi.string().allow(""),
|
|
2477
|
-
orientation: Joi.string().allow(""),
|
|
2478
|
-
description: Joi.string().allow(""),
|
|
2479
|
-
published: Joi.boolean(),
|
|
2480
2585
|
created_by: ContentPlatformModel.CreatedBySchema(),
|
|
2481
2586
|
date_meta: ContentPlatformModel.DateMeta(),
|
|
2587
|
+
description: Joi.string().allow(""),
|
|
2482
2588
|
feature_image: ContentPlatformModel.Asset(),
|
|
2589
|
+
page_meta: Joi.array().items(Joi.any()),
|
|
2483
2590
|
_schedule: ContentPlatformModel.ScheduleSchema(),
|
|
2484
|
-
|
|
2591
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2592
|
+
orientation: Joi.string().allow(""),
|
|
2593
|
+
platform: Joi.string().allow(""),
|
|
2594
|
+
published: Joi.boolean(),
|
|
2595
|
+
slug: Joi.string().allow(""),
|
|
2596
|
+
tags: Joi.array().items(Joi.string().allow("")),
|
|
2597
|
+
title: Joi.string().allow(""),
|
|
2598
|
+
type: Joi.string().allow(""),
|
|
2485
2599
|
seo: ContentPlatformModel.SEO(),
|
|
2486
|
-
|
|
2600
|
+
visibility: Joi.object().pattern(/\S/, Joi.any()),
|
|
2487
2601
|
archived: Joi.boolean(),
|
|
2488
|
-
__v: Joi.number(),
|
|
2489
|
-
content: Joi.array().items(ContentPlatformModel.PageContent()),
|
|
2490
|
-
sanitized_content: Joi.array().items(
|
|
2491
|
-
ContentPlatformModel.SanitizedContent()
|
|
2492
|
-
),
|
|
2493
|
-
});
|
|
2494
|
-
}
|
|
2495
|
-
|
|
2496
|
-
/** @returns {SanitizedContent} */
|
|
2497
|
-
static SanitizedContent() {
|
|
2498
|
-
return Joi.object({
|
|
2499
|
-
type: Joi.string().allow(""),
|
|
2500
|
-
value: Joi.string().allow(""),
|
|
2501
|
-
});
|
|
2502
|
-
}
|
|
2503
|
-
|
|
2504
|
-
/** @returns {PageMeta} */
|
|
2505
|
-
static PageMeta() {
|
|
2506
|
-
return Joi.object({
|
|
2507
|
-
key: Joi.string().allow(""),
|
|
2508
|
-
});
|
|
2509
|
-
}
|
|
2510
|
-
|
|
2511
|
-
/** @returns {PageContent} */
|
|
2512
|
-
static PageContent() {
|
|
2513
|
-
return Joi.object({
|
|
2514
|
-
type: Joi.string().allow(""),
|
|
2515
|
-
value: Joi.string().allow(""),
|
|
2516
2602
|
});
|
|
2517
2603
|
}
|
|
2518
2604
|
|
|
@@ -2523,22 +2609,15 @@ class ContentPlatformModel {
|
|
|
2523
2609
|
});
|
|
2524
2610
|
}
|
|
2525
2611
|
|
|
2526
|
-
/** @returns {
|
|
2527
|
-
static
|
|
2528
|
-
return Joi.object({
|
|
2529
|
-
test: Joi.boolean(),
|
|
2530
|
-
});
|
|
2531
|
-
}
|
|
2532
|
-
|
|
2533
|
-
/** @returns {PageRequest} */
|
|
2534
|
-
static PageRequest() {
|
|
2612
|
+
/** @returns {PagePayload} */
|
|
2613
|
+
static PagePayload() {
|
|
2535
2614
|
return Joi.object({
|
|
2536
2615
|
_schedule: ContentPlatformModel.CronSchedule(),
|
|
2537
2616
|
application: Joi.string().allow(""),
|
|
2538
2617
|
author: ContentPlatformModel.Author(),
|
|
2539
|
-
_custom_json: Joi.any(),
|
|
2618
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2540
2619
|
orientation: Joi.string().allow(""),
|
|
2541
|
-
content: Joi.array().items(
|
|
2620
|
+
content: Joi.array().items(Joi.any()),
|
|
2542
2621
|
feature_image: ContentPlatformModel.Asset(),
|
|
2543
2622
|
published: Joi.boolean(),
|
|
2544
2623
|
reading_time: Joi.string().allow(""),
|
|
@@ -2546,10 +2625,6 @@ class ContentPlatformModel {
|
|
|
2546
2625
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
2547
2626
|
seo: ContentPlatformModel.SEO(),
|
|
2548
2627
|
title: Joi.string().allow(""),
|
|
2549
|
-
platform: Joi.string().allow(""),
|
|
2550
|
-
type: Joi.string().allow(""),
|
|
2551
|
-
description: Joi.string().allow(""),
|
|
2552
|
-
visibility: Joi.any(),
|
|
2553
2628
|
});
|
|
2554
2629
|
}
|
|
2555
2630
|
|
|
@@ -2560,12 +2635,11 @@ class ContentPlatformModel {
|
|
|
2560
2635
|
start: Joi.string().allow(""),
|
|
2561
2636
|
end: Joi.string().allow(""),
|
|
2562
2637
|
duration: Joi.number(),
|
|
2563
|
-
next_schedule: Joi.array().items(ContentPlatformModel.NextSchedule()),
|
|
2564
2638
|
});
|
|
2565
2639
|
}
|
|
2566
2640
|
|
|
2567
|
-
/** @returns {
|
|
2568
|
-
static
|
|
2641
|
+
/** @returns {PagePublishPayload} */
|
|
2642
|
+
static PagePublishPayload() {
|
|
2569
2643
|
return Joi.object({
|
|
2570
2644
|
publish: Joi.boolean(),
|
|
2571
2645
|
});
|
|
@@ -2574,44 +2648,12 @@ class ContentPlatformModel {
|
|
|
2574
2648
|
/** @returns {PageMetaSchema} */
|
|
2575
2649
|
static PageMetaSchema() {
|
|
2576
2650
|
return Joi.object({
|
|
2577
|
-
system_pages: Joi.array().items(ContentPlatformModel.
|
|
2578
|
-
custom_pages: Joi.array().items(ContentPlatformModel.
|
|
2651
|
+
system_pages: Joi.array().items(ContentPlatformModel.NavigationSchema()),
|
|
2652
|
+
custom_pages: Joi.array().items(ContentPlatformModel.PageSchema()),
|
|
2579
2653
|
application_id: Joi.string().allow(""),
|
|
2580
2654
|
});
|
|
2581
2655
|
}
|
|
2582
2656
|
|
|
2583
|
-
/** @returns {CustomePages} */
|
|
2584
|
-
static CustomePages() {
|
|
2585
|
-
return Joi.object({
|
|
2586
|
-
display: Joi.string().allow(""),
|
|
2587
|
-
slug: Joi.string().allow(""),
|
|
2588
|
-
});
|
|
2589
|
-
}
|
|
2590
|
-
|
|
2591
|
-
/** @returns {SystemPagesActionPage} */
|
|
2592
|
-
static SystemPagesActionPage() {
|
|
2593
|
-
return Joi.object({
|
|
2594
|
-
type: Joi.string().allow(""),
|
|
2595
|
-
});
|
|
2596
|
-
}
|
|
2597
|
-
|
|
2598
|
-
/** @returns {SystemPagesAction} */
|
|
2599
|
-
static SystemPagesAction() {
|
|
2600
|
-
return Joi.object({
|
|
2601
|
-
page: ContentPlatformModel.SystemPagesActionPage(),
|
|
2602
|
-
type: Joi.string().allow(""),
|
|
2603
|
-
});
|
|
2604
|
-
}
|
|
2605
|
-
|
|
2606
|
-
/** @returns {SystemPages} */
|
|
2607
|
-
static SystemPages() {
|
|
2608
|
-
return Joi.object({
|
|
2609
|
-
display: Joi.string().allow(""),
|
|
2610
|
-
action: ContentPlatformModel.SystemPagesAction(),
|
|
2611
|
-
page_type: Joi.string().allow(""),
|
|
2612
|
-
});
|
|
2613
|
-
}
|
|
2614
|
-
|
|
2615
2657
|
/** @returns {Support} */
|
|
2616
2658
|
static Support() {
|
|
2617
2659
|
return Joi.object({
|
|
@@ -2671,8 +2713,6 @@ class ContentPlatformModel {
|
|
|
2671
2713
|
return Joi.object({
|
|
2672
2714
|
application: Joi.string().allow(""),
|
|
2673
2715
|
_id: Joi.string().allow(""),
|
|
2674
|
-
company: Joi.string().allow(""),
|
|
2675
|
-
__v: Joi.number(),
|
|
2676
2716
|
tags: Joi.array().items(ContentPlatformModel.TagSchema()),
|
|
2677
2717
|
});
|
|
2678
2718
|
}
|
|
@@ -2686,9 +2726,9 @@ class ContentPlatformModel {
|
|
|
2686
2726
|
sub_type: Joi.string().allow(""),
|
|
2687
2727
|
_id: Joi.string().allow(""),
|
|
2688
2728
|
position: Joi.string().allow(""),
|
|
2689
|
-
attributes: Joi.any(),
|
|
2729
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
2690
2730
|
content: Joi.string().allow(""),
|
|
2691
|
-
compatible_engines: Joi.array().items(Joi.
|
|
2731
|
+
compatible_engines: Joi.array().items(Joi.string().allow("")),
|
|
2692
2732
|
pages: Joi.array().items(Joi.any()),
|
|
2693
2733
|
__source: ContentPlatformModel.TagSourceSchema(),
|
|
2694
2734
|
});
|
|
@@ -2723,70 +2763,30 @@ class ContentPlatformModel {
|
|
|
2723
2763
|
return Joi.object({
|
|
2724
2764
|
name: Joi.string().allow(""),
|
|
2725
2765
|
type: Joi.string().allow(""),
|
|
2726
|
-
|
|
2727
|
-
}
|
|
2728
|
-
|
|
2729
|
-
/** @returns {ApplicationFieldDefinitionSchema} */
|
|
2730
|
-
static ApplicationFieldDefinitionSchema() {
|
|
2731
|
-
return Joi.object({
|
|
2732
|
-
_id: Joi.string().allow(""),
|
|
2733
|
-
creator: Joi.string().allow(""),
|
|
2734
|
-
resource: Joi.string().allow(""),
|
|
2735
|
-
name: Joi.string().allow(""),
|
|
2736
|
-
namespace: Joi.string().allow(""),
|
|
2737
|
-
key: Joi.string().allow(""),
|
|
2738
|
-
description: Joi.string().allow(""),
|
|
2739
|
-
type: Joi.string().allow(""),
|
|
2740
|
-
multi_value: Joi.boolean(),
|
|
2741
|
-
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2742
|
-
company_id: Joi.string().allow(""),
|
|
2743
|
-
created_by: Joi.string().allow(""),
|
|
2744
|
-
updated_by: Joi.string().allow(""),
|
|
2745
|
-
required: Joi.boolean(),
|
|
2746
|
-
is_deleted: Joi.boolean(),
|
|
2747
|
-
created_at: Joi.string().allow(""),
|
|
2748
|
-
updated_at: Joi.string().allow(""),
|
|
2749
|
-
type_name: Joi.string().allow(""),
|
|
2750
|
-
invalid_fields_count: Joi.number(),
|
|
2751
|
-
application_id: Joi.string().allow(""),
|
|
2766
|
+
value: Joi.any(),
|
|
2752
2767
|
});
|
|
2753
2768
|
}
|
|
2754
2769
|
|
|
2755
2770
|
/** @returns {FieldDefinitionSchema} */
|
|
2756
2771
|
static FieldDefinitionSchema() {
|
|
2757
2772
|
return Joi.object({
|
|
2758
|
-
|
|
2759
|
-
creator: Joi.string().allow(""),
|
|
2773
|
+
id: Joi.string().allow(""),
|
|
2760
2774
|
resource: Joi.string().allow(""),
|
|
2761
2775
|
name: Joi.string().allow(""),
|
|
2762
2776
|
namespace: Joi.string().allow(""),
|
|
2763
|
-
|
|
2777
|
+
slug: Joi.string().allow(""),
|
|
2764
2778
|
description: Joi.string().allow(""),
|
|
2765
2779
|
type: Joi.string().allow(""),
|
|
2766
2780
|
multi_value: Joi.boolean(),
|
|
2767
2781
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2768
2782
|
company_id: Joi.string().allow(""),
|
|
2769
|
-
created_by: Joi.string().allow(""),
|
|
2770
|
-
updated_by: Joi.string().allow(""),
|
|
2771
2783
|
required: Joi.boolean(),
|
|
2772
2784
|
is_deleted: Joi.boolean(),
|
|
2773
|
-
created_at: Joi.string().allow(""),
|
|
2774
|
-
updated_at: Joi.string().allow(""),
|
|
2775
2785
|
type_name: Joi.string().allow(""),
|
|
2776
2786
|
invalid_fields_count: Joi.number(),
|
|
2777
2787
|
});
|
|
2778
2788
|
}
|
|
2779
2789
|
|
|
2780
|
-
/** @returns {ApplicationCustomFieldDefinitionsSchema} */
|
|
2781
|
-
static ApplicationCustomFieldDefinitionsSchema() {
|
|
2782
|
-
return Joi.object({
|
|
2783
|
-
items: Joi.array().items(
|
|
2784
|
-
ContentPlatformModel.ApplicationFieldDefinitionSchema()
|
|
2785
|
-
),
|
|
2786
|
-
page: ContentPlatformModel.Page(),
|
|
2787
|
-
});
|
|
2788
|
-
}
|
|
2789
|
-
|
|
2790
2790
|
/** @returns {CustomFieldDefinitionsSchema} */
|
|
2791
2791
|
static CustomFieldDefinitionsSchema() {
|
|
2792
2792
|
return Joi.object({
|
|
@@ -2798,14 +2798,12 @@ class ContentPlatformModel {
|
|
|
2798
2798
|
/** @returns {CustomFieldDefinitionRequestSchema} */
|
|
2799
2799
|
static CustomFieldDefinitionRequestSchema() {
|
|
2800
2800
|
return Joi.object({
|
|
2801
|
-
resource: Joi.string().allow(""),
|
|
2802
2801
|
type: Joi.string().allow(""),
|
|
2803
|
-
|
|
2802
|
+
slug: Joi.string().allow(""),
|
|
2804
2803
|
namespace: Joi.string().allow(""),
|
|
2805
2804
|
multi_value: Joi.boolean(),
|
|
2806
2805
|
name: Joi.string().allow(""),
|
|
2807
2806
|
description: Joi.string().allow(""),
|
|
2808
|
-
creator: Joi.string().allow(""),
|
|
2809
2807
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2810
2808
|
});
|
|
2811
2809
|
}
|
|
@@ -2813,13 +2811,13 @@ class ContentPlatformModel {
|
|
|
2813
2811
|
/** @returns {CustomObjectCustomFieldDefinitions} */
|
|
2814
2812
|
static CustomObjectCustomFieldDefinitions() {
|
|
2815
2813
|
return Joi.object({
|
|
2816
|
-
|
|
2817
|
-
type: Joi.string().allow("")
|
|
2814
|
+
id: Joi.string().allow(""),
|
|
2815
|
+
type: Joi.string().allow(""),
|
|
2818
2816
|
description: Joi.string().allow(""),
|
|
2819
2817
|
name: Joi.string().allow(""),
|
|
2820
2818
|
multi_value: Joi.boolean(),
|
|
2821
2819
|
required: Joi.boolean(),
|
|
2822
|
-
|
|
2820
|
+
slug: Joi.string().allow(""),
|
|
2823
2821
|
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2824
2822
|
action: Joi.string().allow(""),
|
|
2825
2823
|
});
|
|
@@ -2828,12 +2826,11 @@ class ContentPlatformModel {
|
|
|
2828
2826
|
/** @returns {CustomObjectDefinitionUpdateRequestSchema} */
|
|
2829
2827
|
static CustomObjectDefinitionUpdateRequestSchema() {
|
|
2830
2828
|
return Joi.object({
|
|
2831
|
-
type: Joi.string().allow(""),
|
|
2832
2829
|
description: Joi.string().allow(""),
|
|
2833
2830
|
name: Joi.string().allow(""),
|
|
2834
2831
|
display_name_key: Joi.string().allow(""),
|
|
2835
2832
|
field_definitions: Joi.array().items(
|
|
2836
|
-
ContentPlatformModel.
|
|
2833
|
+
ContentPlatformModel.CustomObjectCustomFieldDefinitions()
|
|
2837
2834
|
),
|
|
2838
2835
|
});
|
|
2839
2836
|
}
|
|
@@ -2841,21 +2838,39 @@ class ContentPlatformModel {
|
|
|
2841
2838
|
/** @returns {CustomFieldDefinitionDetailResSchema} */
|
|
2842
2839
|
static CustomFieldDefinitionDetailResSchema() {
|
|
2843
2840
|
return Joi.object({
|
|
2844
|
-
creator: Joi.string().allow(""),
|
|
2845
2841
|
resource: Joi.string().allow(""),
|
|
2846
2842
|
name: Joi.string().allow(""),
|
|
2847
2843
|
namespace: Joi.string().allow(""),
|
|
2848
|
-
|
|
2844
|
+
slug: Joi.string().allow(""),
|
|
2849
2845
|
description: Joi.string().allow(""),
|
|
2850
2846
|
type: Joi.string().allow(""),
|
|
2851
2847
|
multi_value: Joi.boolean(),
|
|
2852
2848
|
company_id: Joi.string().allow(""),
|
|
2853
2849
|
application_id: Joi.string().allow(""),
|
|
2854
|
-
created_by: Joi.string().allow(""),
|
|
2855
|
-
updated_by: Joi.string().allow(""),
|
|
2856
2850
|
required: Joi.boolean(),
|
|
2857
2851
|
is_deleted: Joi.boolean(),
|
|
2858
|
-
|
|
2852
|
+
id: Joi.string().allow(""),
|
|
2853
|
+
validations: Joi.array().items(Joi.any()),
|
|
2854
|
+
created_at: Joi.string().allow(""),
|
|
2855
|
+
updated_at: Joi.string().allow(""),
|
|
2856
|
+
});
|
|
2857
|
+
}
|
|
2858
|
+
|
|
2859
|
+
/** @returns {MetaFieldDefinitionDetailResSchema} */
|
|
2860
|
+
static MetaFieldDefinitionDetailResSchema() {
|
|
2861
|
+
return Joi.object({
|
|
2862
|
+
resource: Joi.string().allow(""),
|
|
2863
|
+
name: Joi.string().allow(""),
|
|
2864
|
+
namespace: Joi.string().allow(""),
|
|
2865
|
+
slug: Joi.string().allow(""),
|
|
2866
|
+
description: Joi.string().allow(""),
|
|
2867
|
+
type: Joi.string().allow(""),
|
|
2868
|
+
multi_value: Joi.boolean(),
|
|
2869
|
+
company_id: Joi.string().allow(""),
|
|
2870
|
+
application_id: Joi.string().allow(""),
|
|
2871
|
+
required: Joi.boolean(),
|
|
2872
|
+
is_deleted: Joi.boolean(),
|
|
2873
|
+
id: Joi.string().allow(""),
|
|
2859
2874
|
validations: Joi.array().items(Joi.any()),
|
|
2860
2875
|
created_at: Joi.string().allow(""),
|
|
2861
2876
|
updated_at: Joi.string().allow(""),
|
|
@@ -2870,22 +2885,27 @@ class ContentPlatformModel {
|
|
|
2870
2885
|
});
|
|
2871
2886
|
}
|
|
2872
2887
|
|
|
2888
|
+
/** @returns {CustomFieldValue} */
|
|
2889
|
+
static CustomFieldValue() {
|
|
2890
|
+
return Joi.object({
|
|
2891
|
+
value: Joi.any(),
|
|
2892
|
+
});
|
|
2893
|
+
}
|
|
2894
|
+
|
|
2873
2895
|
/** @returns {CustomFieldSchema} */
|
|
2874
2896
|
static CustomFieldSchema() {
|
|
2875
2897
|
return Joi.object({
|
|
2876
|
-
|
|
2898
|
+
id: Joi.string().allow(""),
|
|
2877
2899
|
namespace: Joi.string().allow(""),
|
|
2878
|
-
|
|
2900
|
+
slug: Joi.string().allow(""),
|
|
2879
2901
|
resource: Joi.string().allow(""),
|
|
2880
|
-
|
|
2881
|
-
|
|
2882
|
-
type: Joi.string().allow("")
|
|
2902
|
+
value: Joi.array().items(ContentPlatformModel.CustomFieldValue()),
|
|
2903
|
+
resource_slug: Joi.string().allow(""),
|
|
2904
|
+
type: Joi.string().allow(""),
|
|
2883
2905
|
multi_value: Joi.boolean(),
|
|
2884
2906
|
company_id: Joi.string().allow(""),
|
|
2885
|
-
definition_id: Joi.string().allow(""),
|
|
2886
2907
|
has_invalid_values: Joi.boolean(),
|
|
2887
2908
|
invalid_value_errors: Joi.array().items(Joi.any()),
|
|
2888
|
-
created_by: Joi.string().allow(""),
|
|
2889
2909
|
is_deleted: Joi.boolean(),
|
|
2890
2910
|
created_at: Joi.string().allow(""),
|
|
2891
2911
|
updated_at: Joi.string().allow(""),
|
|
@@ -2918,7 +2938,9 @@ class ContentPlatformModel {
|
|
|
2918
2938
|
/** @returns {CustomField} */
|
|
2919
2939
|
static CustomField() {
|
|
2920
2940
|
return Joi.object({
|
|
2921
|
-
|
|
2941
|
+
value: Joi.array().items(Joi.any()),
|
|
2942
|
+
namespace: Joi.string().allow(""),
|
|
2943
|
+
slug: Joi.string().allow(""),
|
|
2922
2944
|
});
|
|
2923
2945
|
}
|
|
2924
2946
|
|
|
@@ -2932,20 +2954,13 @@ class ContentPlatformModel {
|
|
|
2932
2954
|
/** @returns {CustomObjectSchema} */
|
|
2933
2955
|
static CustomObjectSchema() {
|
|
2934
2956
|
return Joi.object({
|
|
2935
|
-
|
|
2936
|
-
creator: Joi.string().allow(""),
|
|
2957
|
+
id: Joi.string().allow(""),
|
|
2937
2958
|
company_id: Joi.string().allow(""),
|
|
2938
2959
|
application_id: Joi.string().allow(""),
|
|
2939
|
-
created_by: Joi.string().allow(""),
|
|
2940
|
-
updated_by: Joi.string().allow(""),
|
|
2941
2960
|
status: Joi.string().allow(""),
|
|
2942
|
-
slug: Joi.string().allow(""),
|
|
2943
2961
|
type: Joi.string().allow(""),
|
|
2962
|
+
definition_slug: Joi.string().allow(""),
|
|
2944
2963
|
display_name: Joi.string().allow(""),
|
|
2945
|
-
definition_id: Joi.string().allow(""),
|
|
2946
|
-
is_deleted: Joi.boolean(),
|
|
2947
|
-
created_at: Joi.string().allow(""),
|
|
2948
|
-
updated_at: Joi.string().allow(""),
|
|
2949
2964
|
fields: Joi.array().items(ContentPlatformModel.CustomFieldSchema()),
|
|
2950
2965
|
});
|
|
2951
2966
|
}
|
|
@@ -2954,6 +2969,7 @@ class ContentPlatformModel {
|
|
|
2954
2969
|
static CustomObjectDefinitionRequestSchema() {
|
|
2955
2970
|
return Joi.object({
|
|
2956
2971
|
type: Joi.string().allow(""),
|
|
2972
|
+
definition_slug: Joi.string().allow(""),
|
|
2957
2973
|
description: Joi.string().allow(""),
|
|
2958
2974
|
name: Joi.string().allow(""),
|
|
2959
2975
|
display_name_key: Joi.string().allow(""),
|
|
@@ -2963,47 +2979,17 @@ class ContentPlatformModel {
|
|
|
2963
2979
|
});
|
|
2964
2980
|
}
|
|
2965
2981
|
|
|
2966
|
-
/** @returns {
|
|
2967
|
-
static
|
|
2982
|
+
/** @returns {CustomObjectDefinitionSlugSchema} */
|
|
2983
|
+
static CustomObjectDefinitionSlugSchema() {
|
|
2968
2984
|
return Joi.object({
|
|
2969
|
-
|
|
2970
|
-
resource: Joi.string().allow(""),
|
|
2971
|
-
name: Joi.string().allow(""),
|
|
2972
|
-
namespace: Joi.string().allow(""),
|
|
2973
|
-
key: Joi.string().allow(""),
|
|
2974
|
-
description: Joi.string().allow(""),
|
|
2975
|
-
type: Joi.string().allow("").required(),
|
|
2976
|
-
multi_value: Joi.boolean(),
|
|
2977
|
-
validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
|
|
2978
|
-
company_id: Joi.string().allow(""),
|
|
2979
|
-
created_by: Joi.string().allow(""),
|
|
2980
|
-
metaobject_definition_id: Joi.string().allow(""),
|
|
2981
|
-
required: Joi.boolean(),
|
|
2982
|
-
is_deleted: Joi.boolean(),
|
|
2983
|
-
_id: Joi.string().allow(""),
|
|
2984
|
-
created_at: Joi.string().allow(""),
|
|
2985
|
-
updated_at: Joi.string().allow(""),
|
|
2986
|
-
application_id: Joi.string().allow(""),
|
|
2987
|
-
});
|
|
2988
|
-
}
|
|
2989
|
-
|
|
2990
|
-
/** @returns {CustomObjectDefinitionSchema} */
|
|
2991
|
-
static CustomObjectDefinitionSchema() {
|
|
2992
|
-
return Joi.object({
|
|
2993
|
-
_id: Joi.string().allow(""),
|
|
2985
|
+
id: Joi.string().allow(""),
|
|
2994
2986
|
name: Joi.string().allow(""),
|
|
2995
2987
|
type: Joi.string().allow(""),
|
|
2988
|
+
definition_slug: Joi.string().allow(""),
|
|
2996
2989
|
display_name_key: Joi.string().allow(""),
|
|
2997
2990
|
description: Joi.string().allow(""),
|
|
2998
|
-
creator: Joi.string().allow(""),
|
|
2999
|
-
created_by: Joi.string().allow(""),
|
|
3000
|
-
updated_by: Joi.string().allow(""),
|
|
3001
|
-
application_id: Joi.string().allow(""),
|
|
3002
|
-
company_id: Joi.string().allow(""),
|
|
3003
|
-
created_at: Joi.string().allow(""),
|
|
3004
|
-
updated_at: Joi.string().allow(""),
|
|
3005
2991
|
field_definitions: Joi.array().items(
|
|
3006
|
-
ContentPlatformModel.
|
|
2992
|
+
ContentPlatformModel.CustomFieldDefinitionDetailResSchema()
|
|
3007
2993
|
),
|
|
3008
2994
|
});
|
|
3009
2995
|
}
|
|
@@ -3016,34 +3002,32 @@ class ContentPlatformModel {
|
|
|
3016
3002
|
});
|
|
3017
3003
|
}
|
|
3018
3004
|
|
|
3019
|
-
/** @returns {
|
|
3020
|
-
static
|
|
3005
|
+
/** @returns {CustomObjectEntryBulkUploadDetails} */
|
|
3006
|
+
static CustomObjectEntryBulkUploadDetails() {
|
|
3021
3007
|
return Joi.object({
|
|
3022
|
-
|
|
3023
|
-
|
|
3008
|
+
url: Joi.string().allow(""),
|
|
3009
|
+
total_records: Joi.number(),
|
|
3024
3010
|
});
|
|
3025
3011
|
}
|
|
3026
3012
|
|
|
3027
|
-
/** @returns {
|
|
3028
|
-
static
|
|
3013
|
+
/** @returns {CustomObjectListItemDefinitionModel} */
|
|
3014
|
+
static CustomObjectListItemDefinitionModel() {
|
|
3029
3015
|
return Joi.object({
|
|
3030
|
-
|
|
3016
|
+
id: Joi.string().allow(""),
|
|
3031
3017
|
name: Joi.string().allow(""),
|
|
3032
3018
|
type: Joi.string().allow(""),
|
|
3033
|
-
display_name_key: Joi.string().allow(""),
|
|
3034
3019
|
});
|
|
3035
3020
|
}
|
|
3036
3021
|
|
|
3037
3022
|
/** @returns {CustomObjectListItemSchema} */
|
|
3038
3023
|
static CustomObjectListItemSchema() {
|
|
3039
3024
|
return Joi.object({
|
|
3040
|
-
|
|
3041
|
-
definition_id: Joi.string().allow(""),
|
|
3025
|
+
id: Joi.string().allow(""),
|
|
3042
3026
|
status: Joi.string().allow(""),
|
|
3043
|
-
|
|
3027
|
+
created_at: Joi.string().allow(""),
|
|
3044
3028
|
updated_at: Joi.string().allow(""),
|
|
3045
3029
|
display_name: Joi.string().allow(""),
|
|
3046
|
-
definition: ContentPlatformModel.
|
|
3030
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
3047
3031
|
references: Joi.number(),
|
|
3048
3032
|
});
|
|
3049
3033
|
}
|
|
@@ -3058,33 +3042,30 @@ class ContentPlatformModel {
|
|
|
3058
3042
|
});
|
|
3059
3043
|
}
|
|
3060
3044
|
|
|
3061
|
-
/** @returns {
|
|
3062
|
-
static
|
|
3045
|
+
/** @returns {CustomObjectFieldDefinition} */
|
|
3046
|
+
static CustomObjectFieldDefinition() {
|
|
3063
3047
|
return Joi.object({
|
|
3064
|
-
|
|
3065
|
-
|
|
3048
|
+
id: Joi.string().allow(""),
|
|
3049
|
+
slug: Joi.string().allow(""),
|
|
3050
|
+
namespace: Joi.string().allow(""),
|
|
3051
|
+
value: Joi.array().items(Joi.any()),
|
|
3066
3052
|
type: Joi.string().allow(""),
|
|
3067
|
-
definition_id: Joi.string().allow(""),
|
|
3068
|
-
});
|
|
3069
|
-
}
|
|
3070
|
-
|
|
3071
|
-
/** @returns {MetafieldTypesSchema} */
|
|
3072
|
-
static MetafieldTypesSchema() {
|
|
3073
|
-
return Joi.object({
|
|
3074
|
-
metafield_types: ContentPlatformModel.CustomFieldTypeSchema(),
|
|
3075
3053
|
});
|
|
3076
3054
|
}
|
|
3077
3055
|
|
|
3078
|
-
/** @returns {
|
|
3079
|
-
static
|
|
3056
|
+
/** @returns {CustomObjectBySlugSchema} */
|
|
3057
|
+
static CustomObjectBySlugSchema() {
|
|
3080
3058
|
return Joi.object({
|
|
3081
|
-
|
|
3059
|
+
id: Joi.string().allow(""),
|
|
3082
3060
|
status: Joi.string().allow(""),
|
|
3083
|
-
slug: Joi.string().allow(""),
|
|
3084
3061
|
display_name: Joi.string().allow(""),
|
|
3085
|
-
definition: ContentPlatformModel.
|
|
3062
|
+
definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
|
|
3086
3063
|
references: Joi.array().items(Joi.any()),
|
|
3087
|
-
|
|
3064
|
+
slug: Joi.string().allow(""),
|
|
3065
|
+
definition_slug: Joi.string().allow(""),
|
|
3066
|
+
fields: Joi.array().items(
|
|
3067
|
+
ContentPlatformModel.CustomObjectFieldDefinition()
|
|
3068
|
+
),
|
|
3088
3069
|
});
|
|
3089
3070
|
}
|
|
3090
3071
|
|
|
@@ -3109,13 +3090,12 @@ class ContentPlatformModel {
|
|
|
3109
3090
|
/** @returns {JobSchema} */
|
|
3110
3091
|
static JobSchema() {
|
|
3111
3092
|
return Joi.object({
|
|
3112
|
-
|
|
3093
|
+
id: Joi.string().allow(""),
|
|
3113
3094
|
jobs: Joi.array().items(Joi.string().allow("")),
|
|
3114
3095
|
finished_jobs: Joi.array().items(Joi.string().allow("")),
|
|
3115
3096
|
error_jobs: Joi.array().items(Joi.string().allow("")),
|
|
3116
3097
|
errors_occured: Joi.array().items(Joi.string().allow("")),
|
|
3117
3098
|
company_id: Joi.string().allow(""),
|
|
3118
|
-
creator: Joi.string().allow(""),
|
|
3119
3099
|
status: Joi.string().allow(""),
|
|
3120
3100
|
action_type: Joi.string().allow(""),
|
|
3121
3101
|
entity: Joi.string().allow(""),
|
|
@@ -3148,6 +3128,13 @@ class ContentPlatformModel {
|
|
|
3148
3128
|
});
|
|
3149
3129
|
}
|
|
3150
3130
|
|
|
3131
|
+
/** @returns {MetafieldTypesSchema} */
|
|
3132
|
+
static MetafieldTypesSchema() {
|
|
3133
|
+
return Joi.object({
|
|
3134
|
+
metafield_types: ContentPlatformModel.CustomFieldTypeSchema(),
|
|
3135
|
+
});
|
|
3136
|
+
}
|
|
3137
|
+
|
|
3151
3138
|
/** @returns {CustomFieldTypeSchema} */
|
|
3152
3139
|
static CustomFieldTypeSchema() {
|
|
3153
3140
|
return Joi.object({
|
|
@@ -3169,6 +3156,23 @@ class ContentPlatformModel {
|
|
|
3169
3156
|
});
|
|
3170
3157
|
}
|
|
3171
3158
|
|
|
3159
|
+
/** @returns {SupportedValidationsMetaExampleSchema} */
|
|
3160
|
+
static SupportedValidationsMetaExampleSchema() {
|
|
3161
|
+
return Joi.object({
|
|
3162
|
+
name: Joi.string().allow(""),
|
|
3163
|
+
value: Joi.string().allow(""),
|
|
3164
|
+
});
|
|
3165
|
+
}
|
|
3166
|
+
|
|
3167
|
+
/** @returns {SupportedValidationsMetaSchema} */
|
|
3168
|
+
static SupportedValidationsMetaSchema() {
|
|
3169
|
+
return Joi.object({
|
|
3170
|
+
examples: Joi.array().items(
|
|
3171
|
+
ContentPlatformModel.SupportedValidationsMetaExampleSchema()
|
|
3172
|
+
),
|
|
3173
|
+
});
|
|
3174
|
+
}
|
|
3175
|
+
|
|
3172
3176
|
/** @returns {SupportedValidationsSchema} */
|
|
3173
3177
|
static SupportedValidationsSchema() {
|
|
3174
3178
|
return Joi.object({
|
|
@@ -3176,6 +3180,7 @@ class ContentPlatformModel {
|
|
|
3176
3180
|
type: Joi.string().allow(""),
|
|
3177
3181
|
display: Joi.string().allow(""),
|
|
3178
3182
|
required: Joi.boolean(),
|
|
3183
|
+
meta: ContentPlatformModel.SupportedValidationsMetaSchema(),
|
|
3179
3184
|
});
|
|
3180
3185
|
}
|
|
3181
3186
|
|
|
@@ -3369,14 +3374,13 @@ class ContentPlatformModel {
|
|
|
3369
3374
|
supported_validations: Joi.array().items(
|
|
3370
3375
|
ContentPlatformModel.SupportedValidationsSchema()
|
|
3371
3376
|
),
|
|
3372
|
-
scope: Joi.array().items(Joi.string().allow("")),
|
|
3373
3377
|
});
|
|
3374
3378
|
}
|
|
3375
3379
|
|
|
3376
3380
|
/** @returns {CustomObjectEntry} */
|
|
3377
3381
|
static CustomObjectEntry() {
|
|
3378
3382
|
return Joi.object({
|
|
3379
|
-
|
|
3383
|
+
id: Joi.string().allow(""),
|
|
3380
3384
|
name: Joi.string().allow(""),
|
|
3381
3385
|
type: Joi.string().allow(""),
|
|
3382
3386
|
updated_at: Joi.string().allow(""),
|
|
@@ -3396,7 +3400,16 @@ class ContentPlatformModel {
|
|
|
3396
3400
|
/** @returns {CustomObjectEntryFieldSchema} */
|
|
3397
3401
|
static CustomObjectEntryFieldSchema() {
|
|
3398
3402
|
return Joi.object({
|
|
3399
|
-
|
|
3403
|
+
namespace: Joi.string().allow(""),
|
|
3404
|
+
slug: Joi.string().allow(""),
|
|
3405
|
+
});
|
|
3406
|
+
}
|
|
3407
|
+
|
|
3408
|
+
/** @returns {CustomObjectEntryFieldSchemaWithoutID} */
|
|
3409
|
+
static CustomObjectEntryFieldSchemaWithoutID() {
|
|
3410
|
+
return Joi.object({
|
|
3411
|
+
slug: Joi.string().allow(""),
|
|
3412
|
+
value: Joi.any(),
|
|
3400
3413
|
});
|
|
3401
3414
|
}
|
|
3402
3415
|
|
|
@@ -3405,13 +3418,22 @@ class ContentPlatformModel {
|
|
|
3405
3418
|
return Joi.object({
|
|
3406
3419
|
status: Joi.string().allow(""),
|
|
3407
3420
|
slug: Joi.string().allow(""),
|
|
3408
|
-
definition_id: Joi.string().allow(""),
|
|
3409
3421
|
fields: Joi.array().items(
|
|
3410
3422
|
ContentPlatformModel.CustomObjectEntryFieldSchema()
|
|
3411
3423
|
),
|
|
3412
3424
|
});
|
|
3413
3425
|
}
|
|
3414
3426
|
|
|
3427
|
+
/** @returns {CustomObjectRequestSchemaWithoutId} */
|
|
3428
|
+
static CustomObjectRequestSchemaWithoutId() {
|
|
3429
|
+
return Joi.object({
|
|
3430
|
+
status: Joi.string().allow(""),
|
|
3431
|
+
fields: Joi.array().items(
|
|
3432
|
+
ContentPlatformModel.CustomObjectEntryFieldSchemaWithoutID()
|
|
3433
|
+
),
|
|
3434
|
+
});
|
|
3435
|
+
}
|
|
3436
|
+
|
|
3415
3437
|
/** @returns {CustomObjectBulkSchema} */
|
|
3416
3438
|
static CustomObjectBulkSchema() {
|
|
3417
3439
|
return Joi.object({
|
|
@@ -3436,6 +3458,358 @@ class ContentPlatformModel {
|
|
|
3436
3458
|
});
|
|
3437
3459
|
}
|
|
3438
3460
|
|
|
3461
|
+
/** @returns {TranslateUiLabels} */
|
|
3462
|
+
static TranslateUiLabels() {
|
|
3463
|
+
return Joi.object({
|
|
3464
|
+
_id: Joi.string().allow(""),
|
|
3465
|
+
company_id: Joi.string().allow(""),
|
|
3466
|
+
application_id: Joi.string().allow(""),
|
|
3467
|
+
template_theme_id: Joi.string().allow(""),
|
|
3468
|
+
theme_id: Joi.string().allow(""),
|
|
3469
|
+
locale: Joi.string().allow(""),
|
|
3470
|
+
resource: Joi.object().pattern(/\S/, Joi.any()),
|
|
3471
|
+
type: Joi.string().allow(""),
|
|
3472
|
+
});
|
|
3473
|
+
}
|
|
3474
|
+
|
|
3475
|
+
/** @returns {TranslateUiLabelsCreate} */
|
|
3476
|
+
static TranslateUiLabelsCreate() {
|
|
3477
|
+
return Joi.object({
|
|
3478
|
+
template_theme_id: Joi.string().allow(""),
|
|
3479
|
+
theme_id: Joi.string().allow(""),
|
|
3480
|
+
locale: Joi.string().allow(""),
|
|
3481
|
+
resource: Joi.object().pattern(/\S/, Joi.any()),
|
|
3482
|
+
type: Joi.string().allow(""),
|
|
3483
|
+
});
|
|
3484
|
+
}
|
|
3485
|
+
|
|
3486
|
+
/** @returns {StaticResourceUpdate} */
|
|
3487
|
+
static StaticResourceUpdate() {
|
|
3488
|
+
return Joi.object({
|
|
3489
|
+
template_theme_id: Joi.string().allow(""),
|
|
3490
|
+
theme_id: Joi.string().allow(""),
|
|
3491
|
+
locale: Joi.string().allow(""),
|
|
3492
|
+
resource: Joi.object().pattern(/\S/, Joi.any()),
|
|
3493
|
+
type: Joi.string().allow(""),
|
|
3494
|
+
});
|
|
3495
|
+
}
|
|
3496
|
+
|
|
3497
|
+
/** @returns {TranslateUiLabelsPage} */
|
|
3498
|
+
static TranslateUiLabelsPage() {
|
|
3499
|
+
return Joi.object({
|
|
3500
|
+
items: Joi.array().items(ContentPlatformModel.TranslateUiLabels()),
|
|
3501
|
+
page: ContentPlatformModel.Page(),
|
|
3502
|
+
});
|
|
3503
|
+
}
|
|
3504
|
+
|
|
3505
|
+
/** @returns {Error} */
|
|
3506
|
+
static Error() {
|
|
3507
|
+
return Joi.object({
|
|
3508
|
+
error: Joi.string().allow(""),
|
|
3509
|
+
});
|
|
3510
|
+
}
|
|
3511
|
+
|
|
3512
|
+
/** @returns {Meta} */
|
|
3513
|
+
static Meta() {
|
|
3514
|
+
return Joi.object({
|
|
3515
|
+
created_by: Joi.string().allow(""),
|
|
3516
|
+
modified_by: Joi.string().allow(""),
|
|
3517
|
+
created_on: Joi.string().allow(""),
|
|
3518
|
+
modified_on: Joi.string().allow(""),
|
|
3519
|
+
});
|
|
3520
|
+
}
|
|
3521
|
+
|
|
3522
|
+
/** @returns {CompanyLanguage} */
|
|
3523
|
+
static CompanyLanguage() {
|
|
3524
|
+
return Joi.object({
|
|
3525
|
+
_id: Joi.string().allow(""),
|
|
3526
|
+
company_id: Joi.string().allow("").required(),
|
|
3527
|
+
locale: Joi.string().allow(""),
|
|
3528
|
+
name: Joi.string().allow(""),
|
|
3529
|
+
direction: Joi.string().allow(""),
|
|
3530
|
+
is_default: Joi.boolean(),
|
|
3531
|
+
display_name: Joi.string().allow(""),
|
|
3532
|
+
});
|
|
3533
|
+
}
|
|
3534
|
+
|
|
3535
|
+
/** @returns {CompanyLanguageCreate} */
|
|
3536
|
+
static CompanyLanguageCreate() {
|
|
3537
|
+
return Joi.object({
|
|
3538
|
+
locales: Joi.array().items(Joi.string().allow("")).required(),
|
|
3539
|
+
});
|
|
3540
|
+
}
|
|
3541
|
+
|
|
3542
|
+
/** @returns {CompanyLanguageUpdate} */
|
|
3543
|
+
static CompanyLanguageUpdate() {
|
|
3544
|
+
return Joi.object({
|
|
3545
|
+
is_default: Joi.boolean().required(),
|
|
3546
|
+
});
|
|
3547
|
+
}
|
|
3548
|
+
|
|
3549
|
+
/** @returns {ApplicationLanguage} */
|
|
3550
|
+
static ApplicationLanguage() {
|
|
3551
|
+
return Joi.object({
|
|
3552
|
+
_id: Joi.string().allow(""),
|
|
3553
|
+
company_id: Joi.string().allow("").required(),
|
|
3554
|
+
application_id: Joi.string().allow("").required(),
|
|
3555
|
+
locale: Joi.string().allow("").required(),
|
|
3556
|
+
name: Joi.string().allow("").required(),
|
|
3557
|
+
direction: Joi.string().allow("").required(),
|
|
3558
|
+
is_default: Joi.boolean().required(),
|
|
3559
|
+
published: Joi.boolean().required(),
|
|
3560
|
+
display_name: Joi.string().allow(""),
|
|
3561
|
+
});
|
|
3562
|
+
}
|
|
3563
|
+
|
|
3564
|
+
/** @returns {unPublishApplicationLanguage} */
|
|
3565
|
+
static unPublishApplicationLanguage() {
|
|
3566
|
+
return Joi.object({
|
|
3567
|
+
published: Joi.boolean().required(),
|
|
3568
|
+
});
|
|
3569
|
+
}
|
|
3570
|
+
|
|
3571
|
+
/** @returns {ApplicationLanguageCreate} */
|
|
3572
|
+
static ApplicationLanguageCreate() {
|
|
3573
|
+
return Joi.object({
|
|
3574
|
+
locales: Joi.array().items(Joi.string().allow("")).required(),
|
|
3575
|
+
});
|
|
3576
|
+
}
|
|
3577
|
+
|
|
3578
|
+
/** @returns {ApplicationLanguageUpdate} */
|
|
3579
|
+
static ApplicationLanguageUpdate() {
|
|
3580
|
+
return Joi.object({
|
|
3581
|
+
is_default: Joi.boolean().required(),
|
|
3582
|
+
published: Joi.boolean().required(),
|
|
3583
|
+
});
|
|
3584
|
+
}
|
|
3585
|
+
|
|
3586
|
+
/** @returns {TranslatableResource} */
|
|
3587
|
+
static TranslatableResource() {
|
|
3588
|
+
return Joi.object({
|
|
3589
|
+
_id: Joi.string().allow(""),
|
|
3590
|
+
type: Joi.string().allow("").required(),
|
|
3591
|
+
name: Joi.string().allow("").required(),
|
|
3592
|
+
description: Joi.string().allow("").required(),
|
|
3593
|
+
schema_type: Joi.string().allow("").required(),
|
|
3594
|
+
created_by: Joi.string().allow(""),
|
|
3595
|
+
modified_by: Joi.string().allow(""),
|
|
3596
|
+
created_on: Joi.string().allow(""),
|
|
3597
|
+
modified_on: Joi.string().allow(""),
|
|
3598
|
+
section_id: ContentPlatformModel.TranslatableSection(),
|
|
3599
|
+
});
|
|
3600
|
+
}
|
|
3601
|
+
|
|
3602
|
+
/** @returns {ResourceDefinition} */
|
|
3603
|
+
static ResourceDefinition() {
|
|
3604
|
+
return Joi.object({
|
|
3605
|
+
_id: Joi.string().allow(""),
|
|
3606
|
+
translatable_resource_id: Joi.string().allow("").required(),
|
|
3607
|
+
json_schema: ContentPlatformModel.ResourceJsonSchema(),
|
|
3608
|
+
ui_schema: ContentPlatformModel.ResourceUISchema(),
|
|
3609
|
+
bulk_details: ContentPlatformModel.ResourceBulkDetails(),
|
|
3610
|
+
});
|
|
3611
|
+
}
|
|
3612
|
+
|
|
3613
|
+
/** @returns {ResourceJsonSchema} */
|
|
3614
|
+
static ResourceJsonSchema() {
|
|
3615
|
+
return Joi.object({
|
|
3616
|
+
schema: Joi.string().allow(""),
|
|
3617
|
+
type: ContentPlatformModel.ResourceJsonSchemaType(),
|
|
3618
|
+
}).allow(null);
|
|
3619
|
+
}
|
|
3620
|
+
|
|
3621
|
+
/** @returns {ResourceJsonSchemaType} */
|
|
3622
|
+
static ResourceJsonSchemaType() {
|
|
3623
|
+
return Joi.object({
|
|
3624
|
+
author: ContentPlatformModel.Author(),
|
|
3625
|
+
title: ContentPlatformModel.Title(),
|
|
3626
|
+
feature_image: ContentPlatformModel.FeatureImage(),
|
|
3627
|
+
});
|
|
3628
|
+
}
|
|
3629
|
+
|
|
3630
|
+
/** @returns {ResourceUISchema} */
|
|
3631
|
+
static ResourceUISchema() {
|
|
3632
|
+
return Joi.object({
|
|
3633
|
+
author: ContentPlatformModel.Author(),
|
|
3634
|
+
title: ContentPlatformModel.Title(),
|
|
3635
|
+
feature_image: ContentPlatformModel.FeatureImage(),
|
|
3636
|
+
seo: ContentPlatformModel.Seo(),
|
|
3637
|
+
}).allow(null);
|
|
3638
|
+
}
|
|
3639
|
+
|
|
3640
|
+
/** @returns {ResourceBulkDetails} */
|
|
3641
|
+
static ResourceBulkDetails() {
|
|
3642
|
+
return Joi.object({
|
|
3643
|
+
fields: Joi.array().items(Joi.string().allow("")),
|
|
3644
|
+
}).allow(null);
|
|
3645
|
+
}
|
|
3646
|
+
|
|
3647
|
+
/** @returns {Title} */
|
|
3648
|
+
static Title() {
|
|
3649
|
+
return Joi.object({
|
|
3650
|
+
ui_widget: Joi.string().allow(""),
|
|
3651
|
+
ui_description: Joi.boolean(),
|
|
3652
|
+
});
|
|
3653
|
+
}
|
|
3654
|
+
|
|
3655
|
+
/** @returns {FeatureImage} */
|
|
3656
|
+
static FeatureImage() {
|
|
3657
|
+
return Joi.object({
|
|
3658
|
+
secure_url: Joi.string().allow(""),
|
|
3659
|
+
});
|
|
3660
|
+
}
|
|
3661
|
+
|
|
3662
|
+
/** @returns {Seo} */
|
|
3663
|
+
static Seo() {
|
|
3664
|
+
return Joi.object({
|
|
3665
|
+
title: ContentPlatformModel.Title(),
|
|
3666
|
+
description: Joi.string().allow(""),
|
|
3667
|
+
canonical_url: Joi.string().allow(""),
|
|
3668
|
+
meta_tags: Joi.array().items(ContentPlatformModel.MetaTag()),
|
|
3669
|
+
});
|
|
3670
|
+
}
|
|
3671
|
+
|
|
3672
|
+
/** @returns {MetaTag} */
|
|
3673
|
+
static MetaTag() {
|
|
3674
|
+
return Joi.object({
|
|
3675
|
+
title: Joi.string().allow(""),
|
|
3676
|
+
items: Joi.array().items(ContentPlatformModel.MetaTagItem()),
|
|
3677
|
+
});
|
|
3678
|
+
}
|
|
3679
|
+
|
|
3680
|
+
/** @returns {MetaTagItem} */
|
|
3681
|
+
static MetaTagItem() {
|
|
3682
|
+
return Joi.object({
|
|
3683
|
+
key: Joi.string().allow(""),
|
|
3684
|
+
value: Joi.string().allow(""),
|
|
3685
|
+
});
|
|
3686
|
+
}
|
|
3687
|
+
|
|
3688
|
+
/** @returns {ResourceTranslation} */
|
|
3689
|
+
static ResourceTranslation() {
|
|
3690
|
+
return Joi.object({
|
|
3691
|
+
_id: Joi.string().allow(""),
|
|
3692
|
+
locale: Joi.string().allow(""),
|
|
3693
|
+
value: ContentPlatformModel.TranslationValue(),
|
|
3694
|
+
});
|
|
3695
|
+
}
|
|
3696
|
+
|
|
3697
|
+
/** @returns {TranslationValue} */
|
|
3698
|
+
static TranslationValue() {
|
|
3699
|
+
return Joi.object({
|
|
3700
|
+
name: Joi.string().allow(""),
|
|
3701
|
+
seo: ContentPlatformModel.TranslationSeo(),
|
|
3702
|
+
});
|
|
3703
|
+
}
|
|
3704
|
+
|
|
3705
|
+
/** @returns {TranslationSeo} */
|
|
3706
|
+
static TranslationSeo() {
|
|
3707
|
+
return Joi.object({
|
|
3708
|
+
title: Joi.string().allow(""),
|
|
3709
|
+
breadcrumbs: Joi.array().items(Joi.string().allow("")),
|
|
3710
|
+
meta_tags: Joi.array().items(Joi.string().allow("")),
|
|
3711
|
+
canonical_url: Joi.string().allow(""),
|
|
3712
|
+
description: Joi.string().allow(""),
|
|
3713
|
+
});
|
|
3714
|
+
}
|
|
3715
|
+
|
|
3716
|
+
/** @returns {ResourceTranslationList} */
|
|
3717
|
+
static ResourceTranslationList() {
|
|
3718
|
+
return Joi.object({
|
|
3719
|
+
items: Joi.array().items(
|
|
3720
|
+
ContentPlatformModel.ResourceTranslationCreate()
|
|
3721
|
+
),
|
|
3722
|
+
});
|
|
3723
|
+
}
|
|
3724
|
+
|
|
3725
|
+
/** @returns {ResourceTranslationCreate} */
|
|
3726
|
+
static ResourceTranslationCreate() {
|
|
3727
|
+
return Joi.object({
|
|
3728
|
+
type: Joi.string().allow(""),
|
|
3729
|
+
resource_id: Joi.string().allow(""),
|
|
3730
|
+
locale: Joi.string().allow(""),
|
|
3731
|
+
value: ContentPlatformModel.TranslationValue(),
|
|
3732
|
+
});
|
|
3733
|
+
}
|
|
3734
|
+
|
|
3735
|
+
/** @returns {ResourceTranslationUpdate} */
|
|
3736
|
+
static ResourceTranslationUpdate() {
|
|
3737
|
+
return Joi.object({
|
|
3738
|
+
value: ContentPlatformModel.TranslationValue(),
|
|
3739
|
+
});
|
|
3740
|
+
}
|
|
3741
|
+
|
|
3742
|
+
/** @returns {TranslatableSection} */
|
|
3743
|
+
static TranslatableSection() {
|
|
3744
|
+
return Joi.object({
|
|
3745
|
+
_id: Joi.string().allow(""),
|
|
3746
|
+
name: Joi.string().allow(""),
|
|
3747
|
+
description: Joi.string().allow(""),
|
|
3748
|
+
created_by: Joi.string().allow(""),
|
|
3749
|
+
modified_by: Joi.string().allow(""),
|
|
3750
|
+
created_on: Joi.string().allow(""),
|
|
3751
|
+
modified_on: Joi.string().allow(""),
|
|
3752
|
+
});
|
|
3753
|
+
}
|
|
3754
|
+
|
|
3755
|
+
/** @returns {Metrics} */
|
|
3756
|
+
static Metrics() {
|
|
3757
|
+
return Joi.object({
|
|
3758
|
+
total: Joi.number(),
|
|
3759
|
+
success: Joi.number(),
|
|
3760
|
+
failed: Joi.number(),
|
|
3761
|
+
});
|
|
3762
|
+
}
|
|
3763
|
+
|
|
3764
|
+
/** @returns {ResourceTranslationUpsertItem} */
|
|
3765
|
+
static ResourceTranslationUpsertItem() {
|
|
3766
|
+
return Joi.object({
|
|
3767
|
+
message: Joi.string().allow(""),
|
|
3768
|
+
data: ContentPlatformModel.ResourceTranslationCreate(),
|
|
3769
|
+
});
|
|
3770
|
+
}
|
|
3771
|
+
|
|
3772
|
+
/** @returns {ResourceTranslationBulkUpsert} */
|
|
3773
|
+
static ResourceTranslationBulkUpsert() {
|
|
3774
|
+
return Joi.object({
|
|
3775
|
+
metrics: ContentPlatformModel.Metrics(),
|
|
3776
|
+
failed_items: Joi.array().items(
|
|
3777
|
+
ContentPlatformModel.ResourceTranslationUpsertItem()
|
|
3778
|
+
),
|
|
3779
|
+
updated_items: Joi.array().items(
|
|
3780
|
+
ContentPlatformModel.ResourceTranslationUpsertItem()
|
|
3781
|
+
),
|
|
3782
|
+
});
|
|
3783
|
+
}
|
|
3784
|
+
|
|
3785
|
+
/** @returns {StandardError} */
|
|
3786
|
+
static StandardError() {
|
|
3787
|
+
return Joi.object({
|
|
3788
|
+
message: Joi.string().allow("").required(),
|
|
3789
|
+
});
|
|
3790
|
+
}
|
|
3791
|
+
|
|
3792
|
+
/** @returns {OperationResponseSchema} */
|
|
3793
|
+
static OperationResponseSchema() {
|
|
3794
|
+
return Joi.object({
|
|
3795
|
+
success: Joi.boolean().required(),
|
|
3796
|
+
message: Joi.string().allow(""),
|
|
3797
|
+
});
|
|
3798
|
+
}
|
|
3799
|
+
|
|
3800
|
+
/**
|
|
3801
|
+
* Enum: GenerationEntityType Used By: Content
|
|
3802
|
+
*
|
|
3803
|
+
* @returns {GenerationEntityType}
|
|
3804
|
+
*/
|
|
3805
|
+
static GenerationEntityType() {
|
|
3806
|
+
return Joi.string().valid(
|
|
3807
|
+
"title",
|
|
3808
|
+
|
|
3809
|
+
"description"
|
|
3810
|
+
);
|
|
3811
|
+
}
|
|
3812
|
+
|
|
3439
3813
|
/**
|
|
3440
3814
|
* Enum: PageType Used By: Content
|
|
3441
3815
|
*
|